home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / rcs57pc1.zip / doc / rcs.man < prev    next >
Text File  |  1996-02-13  |  13KB  |  331 lines
  1.  
  2.  
  3.  
  4. RCS(1)                                                     RCS(1)
  5.  
  6.  
  7. NAME
  8.        rcs - change RCS file attributes
  9.  
  10. SYNOPSIS
  11.        rcs options file ...
  12.  
  13. DESCRIPTION
  14.        rcs  creates new RCS files or changes attributes of exist-
  15.        ing ones.  An RCS  file  contains  multiple  revisions  of
  16.        text,  an access list, a change log, descriptive text, and
  17.        some control attributes.  For rcs to  work,  the  caller's
  18.        login  name  must  be  on  the  access list, except if the
  19.        access list is empty, the caller is the owner of the  file
  20.        or the superuser, or the -i option is present.
  21.  
  22.        Pathnames  matching  an  RCS  suffix denote RCS files; all
  23.        others  denote  working  files.   Names  are   paired   as
  24.        explained  in  ci(1).   Revision  numbers  use  the syntax
  25.        described in ci(1).
  26.  
  27. OPTIONS
  28.        -i     Create and initialize a new RCS file,  but  do  not
  29.               deposit  any revision.  If the RCS file has no path
  30.               prefix, try to place it first into the subdirectory
  31.               ./RCS, and then into the current directory.  If the
  32.               RCS file already exists, print an error message.
  33.  
  34.        -alogins
  35.               Append the login  names  appearing  in  the  comma-
  36.               separated list logins to the access list of the RCS
  37.               file.
  38.  
  39.        -Aoldfile
  40.               Append the access list of  oldfile  to  the  access
  41.               list of the RCS file.
  42.  
  43.        -e[logins]
  44.               Erase  the  login  names  appearing  in  the comma-
  45.               separated list logins from the access list  of  the
  46.               RCS  file.   If logins is omitted, erase the entire
  47.               access list.
  48.  
  49.        -b[rev]
  50.               Set the default branch to rev.  If rev is  omitted,
  51.               the  default  branch  is reset to the (dynamically)
  52.               highest branch on the trunk.
  53.  
  54.        -cstring
  55.               Set the comment leader to string.  An  initial  ci,
  56.               or an rcs -i without -c, guesses the comment leader
  57.               from the suffix of the working filename.
  58.  
  59.               This option is obsolescent, since RCS normally uses
  60.               the  preceding  $Log$  line's prefix when inserting
  61.  
  62.  
  63.  
  64. GNU                         1995/06/05                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RCS(1)                                                     RCS(1)
  71.  
  72.  
  73.               log lines during checkout  (see  co(1)).   However,
  74.               older  versions  of  RCS  use  the  comment  leader
  75.               instead of the $Log$ line's prefix, so if you  plan
  76.               to  access a file with both old and new versions of
  77.               RCS, make sure its comment leader matches its $Log$
  78.               line prefix.
  79.  
  80.        -ksubst
  81.               Set the default keyword substitution to subst.  The
  82.               effect of  keyword  substitution  is  described  in
  83.               co(1).   Giving  an explicit -k option to co, rcsd-
  84.               iff, and rcsmerge overrides this  default.   Beware
  85.               rcs -kv,  because  -kv  is incompatible with co -l.
  86.               Use rcs -kkv to restore the normal default  keyword
  87.               substitution.
  88.  
  89.        -l[rev]
  90.               Lock  the revision with number rev.  If a branch is
  91.               given, lock the latest revision on that branch.  If
  92.               rev  is  omitted,  lock  the latest revision on the
  93.               default  branch.   Locking   prevents   overlapping
  94.               changes.   If  someone else already holds the lock,
  95.               the lock is broken as with rcs -u (see below).
  96.  
  97.        -u[rev]
  98.               Unlock the revision with number rev.  If  a  branch
  99.               is  given,  unlock  the  latest  revision  on  that
  100.               branch.  If rev is omitted, remove the latest  lock
  101.               held by the caller.  Normally, only the locker of a
  102.               revision can unlock it.  Somebody else unlocking  a
  103.               revision  breaks the lock.  This causes a mail mes-
  104.               sage to be sent to the original locker.   The  mes-
  105.               sage  contains  a  commentary  solicited  from  the
  106.               breaker.  The commentary is terminated  by  end-of-
  107.               file or by a line containing . by itself.
  108.  
  109.        -L     Set  locking  to strict.  Strict locking means that
  110.               the owner of an RCS file is not exempt from locking
  111.               for  checkin.  This option should be used for files
  112.               that are shared.
  113.  
  114.        -U     Set  locking  to  non-strict.   Non-strict  locking
  115.               means  that  the  owner  of  a file need not lock a
  116.               revision for checkin.  This option  should  not  be
  117.               used  for  files  that are shared.  Whether default
  118.               locking is strict  is  determined  by  your  system
  119.               administrator, but it is normally strict.
  120.  
  121.        -mrev:msg
  122.               Replace revision rev's log message with msg.
  123.  
  124.        -M     Do  not  send  mail  when  breaking somebody else's
  125.               lock.  This option is not meant for casual use;  it
  126.               is  meant  for  programs  that  warn users by other
  127.  
  128.  
  129.  
  130. GNU                         1995/06/05                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RCS(1)                                                     RCS(1)
  137.  
  138.  
  139.               means, and invoke rcs -u only as a low-level  lock-
  140.               breaking operation.
  141.  
  142.        -nname[:[rev]]
  143.               Associate the symbolic name name with the branch or
  144.               revision rev.  Delete the symbolic name if  both  :
  145.               and rev are omitted; otherwise, print an error mes-
  146.               sage if name is  already  associated  with  another
  147.               number.   If rev is symbolic, it is expanded before
  148.               association.  A rev consisting of a  branch  number
  149.               followed by a . stands for the current latest revi-
  150.               sion in the branch.  A : with an empty  rev  stands
  151.               for  the  current  latest  revision  on the default
  152.               branch,   normally   the   trunk.    For   example,
  153.               rcs -nname: RCS/*  associates name with the current
  154.               latest revision of all the named  RCS  files;  this
  155.               contrasts  with rcs -nname:$ RCS/* which associates
  156.               name with the revision numbers extracted from  key-
  157.               word strings in the corresponding working files.
  158.  
  159.        -Nname[:[rev]]
  160.               Act  like  -n, except override any previous assign-
  161.               ment of name.
  162.  
  163.        -orange
  164.               deletes ("outdates") the revisions given by  range.
  165.               A  range  consisting  of  a  single revision number
  166.               means that  revision.   A  range  consisting  of  a
  167.               branch  number  means  the  latest revision on that
  168.               branch.  A range of the form rev1:rev2 means  revi-
  169.               sions  rev1  to rev2 on the same branch, :rev means
  170.               from the beginning of the branch containing rev  up
  171.               to  and including rev, and rev: means from revision
  172.               rev to the end of the branch containing rev.   None
  173.               of  the  outdated  revisions  can  have branches or
  174.               locks.
  175.  
  176.        -q     Run quietly; do not print diagnostics.
  177.  
  178.        -I     Run interactively, even if the  standard  input  is
  179.               not a terminal.
  180.  
  181.        -sstate[:rev]
  182.               Set  the  state  attribute  of  the revision rev to
  183.               state.  If rev is a branch number, assume the  lat-
  184.               est  revision  on  that branch.  If rev is omitted,
  185.               assume the latest revision on the  default  branch.
  186.               Any  identifier  is acceptable for state.  A useful
  187.               set of states is Exp (for experimental), Stab  (for
  188.               stable), and Rel (for released).  By default, ci(1)
  189.               sets the state of a revision to Exp.
  190.  
  191.        -t[file]
  192.               Write descriptive text from  the  contents  of  the
  193.  
  194.  
  195.  
  196. GNU                         1995/06/05                          3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. RCS(1)                                                     RCS(1)
  203.  
  204.  
  205.               named file into the RCS file, deleting the existing
  206.               text.  The file pathname cannot begin with  -.   If
  207.               file  is  omitted,  obtain  the  text from standard
  208.               input, terminated by end-of-file or by a line  con-
  209.               taining . by itself.  Prompt for the text if inter-
  210.               action is possible; see -I.  With  -i,  descriptive
  211.               text is obtained even if -t is not given.
  212.  
  213.        -t-string
  214.               Write descriptive text from the string into the RCS
  215.               file, deleting the existing text.
  216.  
  217.        -T     Preserve the modification  time  on  the  RCS  file
  218.               unless a revision is removed.  This option can sup-
  219.               press extensive recompilation caused by  a  make(1)
  220.               dependency  of some copy of the working file on the
  221.               RCS file.  Use this option with care; it  can  sup-
  222.               press  recompilation  even  when it is needed, i.e.
  223.               when a change to the RCS file would mean  a  change
  224.               to keyword strings in the working file.
  225.  
  226.        -V     Print RCS's version number.
  227.  
  228.        -Vn    Emulate RCS version n.  See co(1) for details.
  229.  
  230.        -xsuffixes
  231.               Use  suffixes to characterize RCS files.  See ci(1)
  232.               for details.
  233.  
  234.        -zzone Use zone as the default time zone.  This option has
  235.               no  effect;  it  is  present for compatibility with
  236.               other RCS commands.
  237.  
  238.        At least one explicit option must be given, to ensure com-
  239.        patibility  with future planned extensions to the rcs com-
  240.        mand.
  241.  
  242. COMPATIBILITY
  243.        The -brev option generates an  RCS  file  that  cannot  be
  244.        parsed by RCS version 3 or earlier.
  245.  
  246.        The  -ksubst  options  (except  -kkv) generate an RCS file
  247.        that cannot be parsed by RCS version 4 or earlier.
  248.  
  249.        Use rcs -Vn to make an RCS file acceptable to RCS  version
  250.        n  by discarding information that would confuse version n.
  251.  
  252.        RCS version 5.5  and  earlier  does  not  support  the  -x
  253.        option, and requires a ,v suffix on an RCS pathname.
  254.  
  255. FILES
  256.        rcs accesses files much as ci(1) does, except that it uses
  257.        the effective user for all accesses, it does not write the
  258.        working  file  or its directory, and it does not even read
  259.  
  260.  
  261.  
  262. GNU                         1995/06/05                          4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. RCS(1)                                                     RCS(1)
  269.  
  270.  
  271.        the working file unless a revision number of $  is  speci-
  272.        fied.
  273.  
  274. ENVIRONMENT
  275.        RCSINIT
  276.               options  prepended  to the argument list, separated
  277.               by spaces.  See ci(1) for details.
  278.  
  279. DIAGNOSTICS
  280.        The RCS pathname and the revisions outdated are written to
  281.        the  diagnostic  output.   The  exit status is zero if and
  282.        only if all operations were successful.
  283.  
  284. IDENTIFICATION
  285.        Author: Walter F. Tichy.
  286.        Manual Page Revision: 5.13; Release Date: 1995/06/05.
  287.        Copyright (C) 1982, 1988, 1989 Walter F. Tichy.
  288.        Copyright (C) 1990, 1991,  1992,  1993,  1994,  1995  Paul
  289.        Eggert.
  290.  
  291. SEE ALSO
  292.        rcsintro(1),  co(1),  ci(1),  ident(1), rcsclean(1), rcsd-
  293.        iff(1), rcsmerge(1), rlog(1), rcsfile(5)
  294.        Walter  F.  Tichy,  RCS--A  System  for  Version  Control,
  295.        Software--Practice   &   Experience  15,  7  (July  1985),
  296.        637-654.
  297.  
  298. BUGS
  299.        A catastrophe (e.g. a system crash) can cause RCS to leave
  300.        behind  a  semaphore file that causes later invocations of
  301.        RCS to claim that the RCS file is in use.   To  fix  this,
  302.        remove  the semaphore file.  A semaphore file's name typi-
  303.        cally begins with , or ends with _.
  304.  
  305.        The separator for revision ranges in the -o option used to
  306.        be  -  instead of :, but this leads to confusion when sym-
  307.        bolic names contain -.  For backwards compatibility rcs -o
  308.        still  supports  the  old  - separator, but it warns about
  309.        this obsolete use.
  310.  
  311.        Symbolic names need not refer  to  existing  revisions  or
  312.        branches.  For example, the -o option does not remove sym-
  313.        bolic names for the outdated revisions; you must use -n to
  314.        remove the names.
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328. GNU                         1995/06/05                          5
  329.  
  330.  
  331.