home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / RCS43X.ZIP / RCS.MAN < prev    next >
Text File  |  1990-11-19  |  8KB  |  159 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 con-
  11.      trol attributes.  For rcs to work, the caller's login name
  12.      must be on the access list, except if the access list is
  13.      empty, the caller is the owner of the file or the superuser,
  14.      or the -i option is present.
  15.  
  16.      Files ending in `,v' are RCS files, all others are working
  17.      files. If a working file is given, rcs tries to find the
  18.      corresponding RCS file first in directory ./RCS and then in
  19.      the current directory, as explained in co(L).
  20.  
  21.      -i         creates and initializes a new RCS file, but does
  22.                 not deposit any revision.  If the RCS file has no
  23.                 path prefix, rcs tries to place it first into the
  24.                 subdirectory ./RCS, and then into the current
  25.                 directory.  If the RCS file already exists, an
  26.                 error message is printed.
  27.  
  28.      -alogins   appends the login names appearing in the comma-
  29.                 separated list logins to the access list of the
  30.                 RCS file.
  31.  
  32.      -Aoldfile  appends the access list of oldfile to the access
  33.                 list of the RCS file.
  34.  
  35.      -e[logins] erases the login names appearing in the comma-
  36.                 separated list logins from the access list of the
  37.                 RCS file.  If logins is omitted, the entire
  38.                 access list is erased.
  39.  
  40.      -b[rev]    sets the default branch to rev. If rev is omit-
  41.                 ted, the default branch is reset to the (dynami-
  42.                 cally) highest branch on the trunk.
  43.  
  44.      -cstring   sets the comment leader to string. The comment
  45.                 leader is printed before every log message line
  46.                 generated by the keyword $Log$  during checkout
  47.                 (see co(L)).  This is useful for programming
  48.                 languages without multi-line comments. During rcs
  49.                 -i or initial ci, the comment leader is guessed
  50.                 from the suffix of the working file.
  51.  
  52.      -l[rev]    locks the revision with number rev.  If a branch
  53.                 is given, the latest revision on that branch is
  54.                 locked.  If rev is omitted, the latest revision
  55.                 on the default branch is locked.  Locking
  56.                 prevents overlapping changes.  A lock is removed
  57.                 with ci or rcs -u (see below).
  58.  
  59.      -u[rev]    unlocks the revision with number rev.  If a
  60.                 branch is given, the latest revision on that
  61.                 branch is unlocked.  If rev is omitted, the
  62.                 latest lock held by the caller is removed.  Nor-
  63.                 mally, only the locker of a revision may unlock
  64.                 it.  Somebody else unlocking a revision breaks
  65.                 the lock. This causes a mail message to be sent
  66.                 to the original locker.  The message contains a
  67.                 commentary solicited from the breaker.  The com-
  68.                 mentary is terminated with a line containing a
  69.                 single `.' or control-D.
  70.  
  71.      -L         sets locking to strict. Strict locking means that
  72.                 the owner of an RCS file is not exempt from lock-
  73.                 ing for checkin.  This option should be used for
  74.                 files that are shared.
  75.  
  76.      -U         sets locking to non-strict. Non-strict locking
  77.                 means that the owner of a file need not lock a
  78.                 revision for checkin. This option should NOT be
  79.                 used for files that are shared.  The default (-L
  80.                 or -U) is determined by your system administra-
  81.                 tor.
  82.  
  83.      -nname[:rev]
  84.                 associates the symbolic name name with the branch
  85.                 or revision rev. Rcs prints an error message if
  86.                 name is already associated with another number.
  87.                 If rev is omitted, the symbolic name is deleted.
  88.  
  89.      -Nname[:rev]
  90.                 same as -n, except that it overrides a previous
  91.                 assignment of name.
  92.  
  93.      -orange    deletes ("outdates") the revisions given by
  94.                 range.  A range consisting of a single revision
  95.                 number means that revision.  A range consisting
  96.                 of a branch number means the latest revision on
  97.                 that branch.  A range of the form rev1-rev2 means
  98.                 revisions rev1 to rev2 on the same branch, -rev
  99.                 means from the beginning of the branch containing
  100.                 rev up to and including rev, and rev- means from
  101.                 revision rev to the end of the branch containing
  102.                 rev.  None of the outdated revisions may have
  103.                 branches or locks.
  104.  
  105.      -q         quiet mode; diagnostics are not printed.
  106.  
  107.      -sstate[:rev]
  108.                 sets the state attribute of the revision rev to
  109.                 state. If rev is a branch number, the latest
  110.                 revision on that branch is assumed.  If rev is
  111.                 omitted, the latest revision on the default
  112.                 branch is assumed.  Any identifier is acceptable
  113.                 for state.  A useful set of states is Exp (for
  114.                 experimental), Stab (for stable), and Rel (for
  115.                 released).  By default, ci(L) sets the state of a
  116.                 revision to Exp.
  117.  
  118.      -t[txtfile]
  119.                 writes descriptive text into the RCS file
  120.                 (deletes the existing text).  If txtfile is omit-
  121.                 ted, rcs prompts the user for text supplied from
  122.                 the standard input, terminated with a line con-
  123.                 taining a single `.' or control-D.  Otherwise,
  124.                 the descriptive text is copied from the file
  125.                 txtfile.  If the -i option is present, descrip-
  126.                 tive text is requested even if -t is not given.
  127.                 The prompt is suppressed if the standard input is
  128.                 not a terminal.
  129.  
  130. DIAGNOSTICS
  131.      The RCS file name and the revisions outdated are written to
  132.      the diagnostic output.  The exit status always refers to the
  133.      last RCS file operated upon, and is 0 if the operation was
  134.      successful, 1 otherwise.
  135.  
  136. FILES
  137.      The caller of the command must have read/write permission
  138.      for the directory containing the RCS file and read permis-
  139.      sion for the RCS file itself.  Rcs creates a semaphore file
  140.      in the same directory as the RCS file to prevent simultane-
  141.      ous update.  For changes, rcs always creates a new file. On
  142.      successful completion, rcs deletes the old one and renames
  143.      the new one.  This strategy makes links to RCS files use-
  144.      less.
  145.  
  146. IDENTIFICATION
  147.      Author: Walter F. Tichy, Purdue University, West Lafayette,
  148.      IN, 47907.
  149.      Revision Number: 1.4 ; Release Date: 89/10/30 .
  150.      Copyright c 1982, 1988, 1989 by Walter F. Tichy.
  151.  
  152. SEE ALSO
  153.      co(L), ci(L), ident(L), rcsdiff(L), rcsintro(L),
  154.      rcsmerge(L), rlog(L), rcsfile(L)
  155.      Walter F. Tichy, "Design, Implementation, and Evaluation of
  156.      a Revision Control System," in Proceedings of the 6th Inter-
  157.      national Conference on Software Engineering, IEEE, Tokyo,
  158.      Sept. 1982.
  159.