."
." Copyright (c) 1998 by Sun Microsystems, Inc.
."
." @(#)freezept.1	1.29	00/03/28 SMI
."
.TH FREEZEPT 1 "00/03/28  Sun WorkShop 6"
.ds ]W
.SH NAME
freezept \- generate or translate SCCS Mergeable delta IDs for
lists of files
.SH SYNOPSIS
.B freezept
.I command
.I args
\&.\|.\|.
.LP
.SH DESCRIPTION
.LP
The
.B freezept
command reads 
.SM SCCS 
files and computes 
.SM SCCS 
Mergeable IDs 
.SM (SMIDs) 
for
the deltas in each file using the Xerox Secure Hash Function.  A 
.SM SMID
consists of four eight-digit hexadecimal numbers.  At any point in time, there
is a one-to-one correspondence between the 
.SM SMIDs 
and 
.SM SIDs 
for all
the deltas in a given
source file.  Source files that are manipulated by the Code Manager
commands 
.BR bringover "(1)" 
and 
.BR resolve "(1)" 
may have their 
.SM SIDs 
renumbered
over time, but the 
.SM SMIDs 
for the deltas do not change.
.LP
The 
.B freezept 
command defines a source file to be a file 
.I filename 
with a corresponding
.SM SCCS 
file found in 
.BI ./SCCS/s. filename.
.SH USAGE
.LP
\fBcreate \fR[ \fB-w \fIworkspace \fR] [ \fB-k \fIfreezepoint\fR-\fIfile \fR] 
.if n .br
.if n \0\0\0\0\0\0
[ \fB-c \fIcomment \fR] [ \fB-n \fR]  [ \fB-q \fR]
.if n .br
.if n \0\0\0\0\0\0
[ \fB-t \fIYYYY/MM/DD[/hh/mm/ss] \fR] [ \fB-z \fR] \fIfiles \fRor \fIdirs\fR
.IP
Create the freezepoint file for the specified
.I files
and
.I directories
from within
.I workspace
and write the freezepoint to
.IR freezepoint-file .
Given a directory name,
.B "freezept create"
recursively looks for 
.SM SCCS 
subdirectories and processes the 
.SM SCCS 
history files found within them.
.IP
.I Workspace
is written into
.I freezepoint-file
for possible use by
.BR extract .
.IP
The 
.I workspace
argument is expected to specify a TeamWare workspace. TeamWare was formerly known as CodeManager.
If it names a directory that is not a TeamWare workspace, then
a warning is issued.
If the
.B \-w
option is not specified, then the value of the shell environment
variable
.SM CODEMGR_WS
is used.
If
.SM CODEMGR_WS
is not set and the current directory is contained within a
workspace, the containing workspace is used.
.IP
If the
.B \-k
option is not specified, the freezepoint is written to the file
.BR freezepoint.out .
If
.I freezepoint-file
is specified as
.BR \- ,
then the freezepoint is written to the standard output and the 
.B \-q
option is implied (to avoid mingling with the normal output).
.IP
The
.B \-c
option specifies a
.I comment
to be included in the freezepoint file.
If the
.B \-c 
option is not specified,
.B freezept
prompts for a comment from the standard input.
.IP
The
.B \-n
option shows what would be done without actually writing
.IR freezepoint-file .
.LP
.IP
As each file is processed, a line is written to the standard output 
naming the file and the SID of the delta being freezepointed.
The
.B \-q
option suppresses these messages.
.LP
.IP
The
.B \-t
option allows you to create a freezepoint file
based on a date. The date format is YYYY/MM/DD[/hh/mm/ss].
For example,
.IP
\fBexample% freezept -w myws -t 1999/05/24/23/45/00
\fP
.LP
.IP
creates a freezepoint file that represents the state 
of workspace on 24th of May 1999 at 23:45:00. 
.LP
.IP
If the -z option is specified, the freezepoint file is compressed
with the /bin/compress command. A compressed file has a .Z extension.
.IP
.LP
\fBdiff \fIfile1 \fIfile2\fR
.IP
Displays the differences between two freezepoint files.
.LP
\fBextract \fR[ \fB-w \fIworkspace \fR] [ \fB-k \fIfreezepoint\fR-\fIfile \fR] 
.if n .br
.if n \0\0\0\0\0\0\0
[ \fB-d \fIdestination\fR-\fIdir\fR] [ \fB\-f \fIfilelist \fR] [ \fB-n\fR ] 
.if n .br
.if n \0\0\0\0\0\0\0
[ \fB-q\fR ] [ \fB-o\fR ] [ \fB-x\fR ]
.IP
Using
.BR "sccs get" ,
extract the appropriate deltas from the files listed in 
.I freezepoint-file
and create a new hierarchy under
.IR destination-dir .
The
.I workspace
argument specifies a TeamWare workspace that contains the SCCS history
files from which to extract.  If
.I workspace
is not specified, the workspace stored in
.I freezepoint-file
is used.
.IP
If the
.B \-k
option is not specified, the file
.B freezepoint.out
is read.
If
.I freezepoint-file
is specified as
.BR \- ,
then the freezepoint is read from the standard input.
.IP
If the
.B \-d
option is not specified, the current directory ("dot") is used.
The directory specified by
.I destination-dir
must either not exist or be empty.
.IP
By default, freezept extracts all files whose names appear in the freezepoint file. The 
.B \-f 
option extracts a subset of the list of files that appears in the freezepoint file. 
.I filelist
is a file that contains the relative path names of the files to be extracted. These names must be listed exactly as they appear in the freezepoint file.
.IP
As each file is processed, a line is written to the standard output
naming the file and the SID of the delta being extracted.
The
.B \-q
option suppresses these messages.
.IP
The
.B \-n
option shows what would be done without actually extracting any files.
.IP
By default, freezept only writes to an empty directory. Specifying the
.B \-o
option authorizes freezept to overwrite the contents of the destination directory.
.IP
The
.B \-x
option directs freezept to create a workspace in the destination directory and reconstruct the SCCS history of each file up to and including the version named in the freezepoint file.
.IP
If some of the required 
.SM SCCS 
files are found but others
are missing, the missing files are noted in warnings.  
Rename support is not implemented.
.LP
\fBsmid \fR[ \fB-w \fIworkspace \fR] [ \fB-r \fISID\fR ] [ \fB-a\fR ] \fIfile
.IP
Translate 
.SM \fISID\fR
to a 
.SM SMID 
for the specified file.
If 
.SM \fISID\fR 
is
specified, just print the translation for that 
.SM SID.  
If the 
.B \-a 
option
is present, display the entire 
.SM SMID = SID 
translation for the file;
for example, each 
.SM SMID 
and 
.SM SID 
for each delta in the file.
.LP
\fBsid \fR[ \fB-w\fR \fIworkspace \fR] [ \fB-m\fR "\fISMID\fR" ] [ \fB-a\fR]\fI file
.IP
Translate 
.SM \fISMID\fR
to its equivalent 
.SM \fISID\fR
for the specified file.
If
.SM \fISMID\fR 
is
specified, just print the translation for that 
.SM SMID.  
If the 
.B \-a
option
is present, display the entire 
.SM SID = SMID 
translation for the file.
For example; each 
.SM SID 
and 
.SM SMID 
for each delta in the file.
.IP 
Note that because a 
.SM SMID 
contains three blank spaces between the
four hex digits, it is necessary to enclose the 
.SM SMID 
argument in quotation marks on the
command line so that it is parsed as a single argument.
.LP
\fBupdate \fR[ \fB-w \fIworkspace \fR] [ \fB-k \fIfreezepoint\fR-\fIfile \fR] 
.if n .br
.if n \0\0\0\0\0\0
[ \fB-c \fIcomment \fR] [ \fB-n \fR] [ \fB-q \fR] \fIfiles \fRor \fIdirs\fR
.IP
Performs the same function as the 
.B
create 
subcommand except that 
.IR freezepoint-file 
is updated rather than created from scratch.
.SH "SEE ALSO"
.IR "Sun WorkShop TeamWare User's Guide"
.LP
.sp 
.nf
bringover(1), codemgr(1), def.dir.flp(1), dmake(1), putback(1), 
rcs2ws(1), resolve(1), teamware(1), twbuild(1), twfreeze(1), 
twmerge(1), twversion(1), workspace(1), ws_undo(1), 
access_control(4), args(4), children(4), conflicts(4), 
description(4), freezepointfile(4), history(4), locks(4), 
nametable(4), notification(4), parent(4), putback.cmt(4)
.LP