home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / prgramer / rcs / rcs.man < prev    next >
Text File  |  1992-02-19  |  10KB  |  230 lines
  1. NAME
  2.      rcs - change RCS file attributes
  3.  
  4. SYNOPSIS
  5.      rcs [ options ] file ...
  6.  
  7. DESCRIPTION
  8.      rcs creates new RCS files or changes attributes of existing
  9.      ones.  An RCS file contains multiple revisions of text, an
  10.      access list, a change log, descriptive text, and some
  11.      control attributes.  For rcs to work, the caller's login
  12.      name must be on the access list, except if the access list
  13.      is empty, the caller is the owner of the file or the
  14.      superuser, or the -i option is present.
  15.  
  16.      Pathnames matching an RCS suffix denote RCS files; all
  17.      others denote working files.  Names are paired as explained
  18.      in ci(1).  Revision numbers use the syntax described in
  19.      ci(1).
  20.  
  21. OPTIONS
  22.      -i   Create and initialize a new RCS file, but do not
  23.           deposit any revision.  If the RCS file has no path
  24.           prefix, try to place it first into the subdirectory
  25.           ./RCS, and then into the current directory.  If the RCS
  26.           file already exists, print an error message.
  27.  
  28.      -alogins
  29.           Append the login names appearing in the comma-separated
  30.           list logins to the access list of the RCS file.
  31.  
  32.      -Aoldfile
  33.           Append the access list of oldfile to the access list of
  34.           the RCS file.
  35.  
  36.      -e[logins]
  37.           Erase the login names appearing in the comma-separated
  38.           list logins from the access list of the RCS file.  If
  39.           logins is omitted, erase the entire access list.
  40.  
  41.      -b[rev]
  42.           Set the default branch to rev.  If rev is omitted, the
  43.           default branch is reset to the (dynamically) highest
  44.           branch on the trunk.
  45.  
  46.      -cstring
  47.           sets the comment leader to string.  The comment leader
  48.           is printed before every log message line generated by
  49.           the keyword $Log$ during checkout (see co(1)).  This is
  50.           useful for programming languages without multi-line
  51.           comments.  An initial ci , or an rcs -i without -c,
  52.           guesses the comment leader from the suffix of the
  53.           working file.
  54.  
  55.      -ksubst
  56.           Set the default keyword substitution to subst.  The
  57.           effect of keyword substitution is described in co(1).
  58.           Giving an explicit -k option to co, rcsdiff, and
  59.           rcsmerge overrides this default.  Beware rcs -kv,
  60.           because -kv is incompatible with co -l.  Use rcs -kkv
  61.           to restore the normal default keyword substitution.
  62.  
  63.      -l[rev]
  64.           Lock the revision with number rev.  If a branch is
  65.           given, lock the latest revision on that branch.  If rev
  66.           is omitted, lock the latest revision on the default
  67.           branch.  Locking prevents overlapping changes.  A lock
  68.           is removed with ci or rcs -u (see below).
  69.  
  70.      -u[rev]
  71.           Unlock the revision with number rev.  If a branch is
  72.           given, unlock the latest revision on that branch.  If
  73.           rev is omitted, remove the latest lock held by the
  74.           caller.  Normally, only the locker of a revision may
  75.           unlock it.  Somebody else unlocking a revision breaks
  76.           the lock.  This causes a mail message to be sent to the
  77.           original locker.  The message contains a commentary
  78.           solicited from the breaker.  The commentary is
  79.           terminated by end-of-file or by a line containing . by
  80.           itself.
  81.  
  82.      -L   Set locking to strict.  Strict locking means that the
  83.           owner of an RCS file is not exempt from locking for
  84.           checkin.  This option should be used for files that are
  85.           shared.
  86.  
  87.      -U   Set locking to non-strict.  Non-strict locking means
  88.           that the owner of a file need not lock a revision for
  89.           checkin.  This option should not be used for files that
  90.           are shared.  Whether default locking is strict is
  91.           determined by your system administrator, but it is
  92.           normally strict.
  93.  
  94.      -mrev:msg
  95.           Replace revision rev's log message with msg.
  96.  
  97.      -M   Do not send mail when breaking somebody else's lock.
  98.           This option is not meant for casual use; it is meant
  99.           for programs that warn users by other means, and invoke
  100.           rcs -u only as a low-level lock-breaking operation.
  101.  
  102.      -nname[:[rev]]
  103.           Associate the symbolic name name with the branch or
  104.           revision rev.  Delete the symbolic name if both : and
  105.           rev are omitted; otherwise, print an error message if
  106.           name is already associated with another number.  If rev
  107.           is symbolic, it is expanded before association.  A rev
  108.           consisting of a branch number followed by a . stands
  109.           for the current latest revision in the branch.  A :
  110.           with an empty rev stands for the current latest
  111.           revision on the default branch, normally the trunk.
  112.           For example, rcs -nname: RCS/* associates name with the
  113.           current latest revision of all the named RCS files;
  114.           this contrasts with rcs -nname:$ RCS/* which associates
  115.           name with the revision numbers extracted from keyword
  116.           strings in the corresponding working files.
  117.  
  118.      -Nname[:[rev]]
  119.           Act like -n, except override any previous assignment of
  120.           name.
  121.  
  122.      -orange
  123.           deletes ("outdates") the revisions given by range.  A
  124.           range consisting of a single revision number means that
  125.           revision.  A range consisting of a branch number means
  126.           the latest revision on that branch.  A range of the
  127.           form rev1:rev2 means revisions rev1 to rev2 on the same
  128.           branch, :rev means from the beginning of the branch
  129.           containing rev up to and including rev, and rev: means
  130.           from revision rev to the end of the branch containing
  131.           rev.  None of the outdated revisions may have branches
  132.           or locks.
  133.  
  134.      -q   Run quietly; do not print diagnostics.
  135.  
  136.      -I   Run interactively, even if the standard input is not a
  137.           terminal.
  138.  
  139.      -sstate[:rev]
  140.           Set the state attribute of the revision rev to state.
  141.           If rev is a branch number, assume the latest revision
  142.           on that branch.  If rev is omitted, assume the latest
  143.           revision on the default branch.  Any identifier is
  144.           acceptable for state.  A useful set of states is Exp
  145.           (for experimental), Stab (for stable), and Rel (for
  146.           released).  By default, ci(1) sets the state of a
  147.           revision to Exp.
  148.  
  149.      -t[file]
  150.           Write descriptive text from the contents of the named
  151.           file into the RCS file, deleting the existing text.
  152.           The file pathname may not begin with -.  If file is
  153.           omitted, obtain the text from standard input,
  154.           terminated by end-of-file or by a line containing . by
  155.           itself.  Prompt for the text if interaction is
  156.           possible; see -I.  With -i, descriptive text is
  157.           obtained even if -t is not given.
  158.  
  159.      -t-string
  160.           Write descriptive text from the string into the RCS
  161.           file, deleting the existing text.
  162.  
  163.      -T   Preserve the modification time on the RCS file unless a
  164.           revision is removed.  This option can suppress
  165.           extensive recompilation caused by a make(1) dependency
  166.           of some copy of the working file on the RCS file.  Use
  167.           this option with care; it can suppress recompilation
  168.           even when it is needed, i.e. when a change to the RCS
  169.           file would mean a change to keyword strings in the
  170.           working file.
  171.  
  172.      -Vn  Emulate RCS version n.  See co(1) for details.
  173.  
  174.      -xsuffixes
  175.           Use suffixes to characterize RCS files.  See ci(1) for
  176.           details.
  177.  
  178. COMPATIBILITY
  179.      The -brev option generates an RCS file that cannot be parsed
  180.      by RCS version 3 or earlier.
  181.  
  182.      The -ksubst options (except -kkv) generate an RCS file that
  183.      cannot be parsed by RCS version 4 or earlier.
  184.  
  185.      Use rcs -Vn to make an RCS file acceptable to RCS version n
  186.      by discarding information that would confuse version n.
  187.  
  188.      RCS version 5.5 and earlier does not support the -x option,
  189.      and requires a ,v suffix on an RCS pathname.
  190.  
  191. FILES
  192.      rcs accesses files much as ci(1) does, except that it uses
  193.      the effective user for all accesses, it does not write the
  194.      working file or its directory, and it does not even read the
  195.      working file unless a revision number of $ is specified.
  196.  
  197. ENVIRONMENT
  198.      RCSINIT
  199.           options prepended to the argument list, separated by
  200.           spaces.  See ci(1) for details.
  201.  
  202. DIAGNOSTICS
  203.      The RCS pathname and the revisions outdated are written to
  204.      the diagnostic output.  The exit status is zero if and only
  205.      if all operations were successful.
  206.  
  207. IDENTIFICATION
  208.      Author: Walter F. Tichy.
  209.      Revision Number: 5.8; Release Date: 1992/02/17.
  210.      Copyright 1982, 1988, 1989 by Walter F. Tichy.
  211.      Copyright 1990, 1991, 1992 by Paul Eggert.
  212.  
  213. SEE ALSO
  214.      co(1), ci(1), ident(1), rcsdiff(1), rcsintro(1),
  215.      rcsmerge(1), rlog(1), rcsfile(5)
  216.      Walter F. Tichy, RCS--A System for Version Control,
  217.      Software--Practice & Experience 15, 7 (July 1985), 637-654.
  218.  
  219. BUGS
  220.      The separator for revision ranges in the -o option used to
  221.      be - instead of :, but this leads to confusion when symbolic
  222.      names contain -.  For backwards compatibility rcs -o still
  223.      supports the old - separator, but it warns about this
  224.      obsolete use.
  225.  
  226.      Symbolic names need not refer to existing revisions or
  227.      branches.  For example, the -o option does not remove
  228.      symbolic names for the outdated revisions; you must use -n
  229.      to remove the names.
  230.