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

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