Sync usage with man page.
[netbsd-mini2440.git] / gnu / usr.bin / rcs / rcsfreeze / rcsfreeze.1
blob532bc95b5e5e8b4ee1ad4331f5dfb333d4b0704f
1 .\"     $NetBSD: rcsfreeze.1,v 1.1.1.2 1996/10/13 21:57:46 veego Exp $
2 .\"
3 .de Id
4 .ds Rv \\$3
5 .ds Dt \\$4
6 ..
7 .\" Id: rcsfreeze.1,v 4.4 1990/11/13 15:43:42 hammer Exp
8 .ds r \s-1RCS\s0
9 .TH RCSFREEZE 1 \*(Dt GNU
10 .SH NAME
11 rcsfreeze \- freeze a configuration of sources checked in under RCS
12 .SH SYNOPSIS
13 .B rcsfreeze
14 .RI [ "name" ]
15 .SH DESCRIPTION
16 .B rcsfreeze
17 assigns a symbolic revision
18 number to a set of \*r files that form a valid configuration.
19 .PP
20 The idea is to run
21 .B rcsfreeze
22 each time a new version is checked
23 in.  A unique symbolic name (\c
24 .BI C_ number,
25 where
26 .I number
27 is increased each time
28 .B rcsfreeze
29 is run) is then assigned to the most
30 recent revision of each \*r file of the main trunk.
31 .PP
32 An optional
33 .I name
34 argument to
35 .B rcsfreeze
36 gives a symbolic name to the configuration.
37 The unique identifier is still generated
38 and is listed in the log file but it will not appear as
39 part of the symbolic revision name in the actual \*r files.
40 .PP
41 A log message is requested from the user for future reference.
42 .PP
43 The shell script works only on all \*r files at one time.
44 All changed files must be checked in already.
45 Run
46 .IR rcsclean (1)
47 first and see whether any sources remain in the current directory.
48 .SH FILES
49 .TP
50 .B RCS/.rcsfreeze.ver
51 version number
52 .TP
53 .B RCS/.rcsfreeze.log
54 log messages, most recent first
55 .SH AUTHOR
56 Stephan v. Bechtolsheim
57 .SH "SEE ALSO"
58 co(1), rcs(1), rcsclean(1), rlog(1)
59 .SH BUGS
60 .B rcsfreeze
61 does not check whether any sources are checked out and modified.
62 .PP
63 Although both source file names and RCS file names are accepted,
64 they are not paired as usual with RCS commands.
65 .PP
66 Error checking is rudimentary.
67 .PP
68 .B rcsfreeze
69 is just an optional example shell script, and should not be taken too seriously.
70 See \s-1CVS\s0 for a more complete solution.