Expand PMF_FN_* macros.
[netbsd-mini2440.git] / usr.bin / rcs / man / rcsfreeze.1
blob98a6ae2fa16f92e2c5aa49aa5e49fb096371fc82
1 .TH RCSFREEZE 1L "" "Purdue University"
2 .SH NAME
3 rcsfreeze \- freeze a configuration of sources checked in under RCS
4 .SH SYNOPSIS
5 .B rcsfreeze
6 [symbolic revision name]
7 .SH DESCRIPTION
8 The
9 .I rcsfreeze
10 command has the purpose of assigning a symbolic revision
11 number to a set of RCS files, which form a valid configuration.
12 .PP
13 The idea is to run
14 .I rcsfreeze
15 each time a new version is checked
16 in. A unique symbolic revision number (\c
17 .BI C_ number,
18 where
19 .I number
20 is increased each time rcsfreeze is run) is then assigned to the most
21 recent revision of each RCS file of the main trunk.
22 .PP
23 If the command is invoked with an argument, then this
24 argument is used as the symbolic name to freeze a configuration.
25 The unique identifier is still generated
26 and is listed in the log file but it will not appear as
27 part of the symbolic revision name in the actual RCS files.
28 .PP
29 A log message is requested from the user which is saved for future
30 references.
31 .PP
32 The shell script works only on all RCS files at one time.
33 It is important that all changed files are checked in (there are
34 no precautions against any error in this respect). Run
35 .IR rcsclean (1L)
36 first and see whether any sources remain in the current directory.
37 .SH FILES
38 .TP 2.5i
39 [RCS/]rcsfreeze.version
40 for the version number
41 .TP
42 [RCS/]rscfreeze.log
43 for the log messages, most recent log message first.
44 .SH AUTHOR
45 Stephan v. Bechtolsheim
46 .SH "SEE ALSO"
47 rcs(1L), rlog(1L), rcsclean(1L)
48 .SH BUGS
49 The program does not check whether there are any sources checked out
50 and modified.