gnu/usr.bin/rcs/rcsfreeze/rcsfreeze.1

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