home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / rcs567x.zip / doc / rcs.man < prev    next >
Text File  |  1994-03-22  |  14KB  |  331 lines
  1.  
  2.  
  3.  
  4. RCS(1)                                                     RCS(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        rcs - change RCS file attributes
  9.  
  10. SSYYNNOOPPSSIISS
  11.        rrccss [ _o_p_t_i_o_n_s ] _f_i_l_e ...
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.        rrccss  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 rrccss 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 --ii 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  ccii(1).   Revision  numbers  use  the syntax
  25.        described in ccii(1).
  26.  
  27. OOPPTTIIOONNSS
  28.        --ii     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.               ..//RRCCSS, and then into the current directory.  If the
  32.               RCS file already exists, print an error message.
  33.  
  34.        --aa_l_o_g_i_n_s
  35.               Append the login  names  appearing  in  the  comma-
  36.               separated list _l_o_g_i_n_s to the access list of the RCS
  37.               file.
  38.  
  39.        --AA_o_l_d_f_i_l_e
  40.               Append the access list of  _o_l_d_f_i_l_e  to  the  access
  41.               list of the RCS file.
  42.  
  43.        --ee[_l_o_g_i_n_s]
  44.               Erase  the  login  names  appearing  in  the comma-
  45.               separated list _l_o_g_i_n_s from the access list  of  the
  46.               RCS  file.   If _l_o_g_i_n_s is omitted, erase the entire
  47.               access list.
  48.  
  49.        --bb[_r_e_v]
  50.               Set the default branch to _r_e_v.  If _r_e_v is  omitted,
  51.               the  default  branch  is reset to the (dynamically)
  52.               highest branch on the trunk.
  53.  
  54.        --cc_s_t_r_i_n_g
  55.               sets the comment leader to _s_t_r_i_n_g.  This option  is
  56.               obsolescent,  since RCS normally uses the preceding
  57.               $$LLoogg$$ line's prefix when inserting log lines during
  58.               checkout  (see  ccoo(1)).  However, older versions of
  59.               RCS use the comment leader  instead  of  the  $$LLoogg$$
  60.               line's prefix.  An initial ccii, or an rrccss --ii without
  61.  
  62.  
  63.  
  64. GNU                         1994/03/17                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RCS(1)                                                     RCS(1)
  71.  
  72.  
  73.               --cc, guesses the comment leader from the  suffix  of
  74.               the working filename.
  75.  
  76.        --kk_s_u_b_s_t
  77.               Set the default keyword substitution to _s_u_b_s_t.  The
  78.               effect of  keyword  substitution  is  described  in
  79.               ccoo(1).   Giving  an explicit --kk option to ccoo, rrccssdd--
  80.               iiffff, and rrccssmmeerrggee overrides this  default.   Beware
  81.               rrccss --kkvv,  because  --kkvv  is incompatible with ccoo --ll.
  82.               Use rrccss --kkkkvv to restore the normal default  keyword
  83.               substitution.
  84.  
  85.        --ll[_r_e_v]
  86.               Lock  the revision with number _r_e_v.  If a branch is
  87.               given, lock the latest revision on that branch.  If
  88.               _r_e_v  is  omitted,  lock  the latest revision on the
  89.               default  branch.   Locking   prevents   overlapping
  90.               changes.   If  someone else already holds the lock,
  91.               the lock is broken as with rrccss --uu (see below).
  92.  
  93.        --uu[_r_e_v]
  94.               Unlock the revision with number _r_e_v.  If  a  branch
  95.               is  given,  unlock  the  latest  revision  on  that
  96.               branch.  If _r_e_v is omitted, remove the latest  lock
  97.               held by the caller.  Normally, only the locker of a
  98.               revision can unlock it.  Somebody else unlocking  a
  99.               revision  breaks the lock.  This causes a mail mes-
  100.               sage to be sent to the original locker.   The  mes-
  101.               sage  contains  a  commentary  solicited  from  the
  102.               breaker.  The commentary is terminated  by  end-of-
  103.               file or by a line containing .. by itself.
  104.  
  105.        --LL     Set  locking  to _s_t_r_i_c_t.  Strict locking means that
  106.               the owner of an RCS file is not exempt from locking
  107.               for  checkin.  This option should be used for files
  108.               that are shared.
  109.  
  110.        --UU     Set  locking  to  non-strict.   Non-strict  locking
  111.               means  that  the  owner  of  a file need not lock a
  112.               revision for checkin.  This option  should  _n_o_t  be
  113.               used  for  files  that are shared.  Whether default
  114.               locking is strict  is  determined  by  your  system
  115.               administrator, but it is normally strict.
  116.  
  117.        --mm_r_e_v::_m_s_g
  118.               Replace revision _r_e_v's log message with _m_s_g.
  119.  
  120.        --MM     Do  not  send  mail  when  breaking somebody else's
  121.               lock.  This option is not meant for casual use;  it
  122.               is  meant  for  programs  that  warn users by other
  123.               means, and invoke rrccss --uu only as a low-level  lock-
  124.               breaking operation.
  125.  
  126.  
  127.  
  128.  
  129.  
  130. GNU                         1994/03/17                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RCS(1)                                                     RCS(1)
  137.  
  138.  
  139.        --nn_n_a_m_e[::[_r_e_v]]
  140.               Associate the symbolic name _n_a_m_e with the branch or
  141.               revision _r_e_v.  Delete the symbolic name if  both  ::
  142.               and _r_e_v are omitted; otherwise, print an error mes-
  143.               sage if _n_a_m_e is  already  associated  with  another
  144.               number.   If _r_e_v is symbolic, it is expanded before
  145.               association.  A _r_e_v consisting of a  branch  number
  146.               followed by a .. stands for the current latest revi-
  147.               sion in the branch.  A :: with an empty  _r_e_v  stands
  148.               for  the  current  latest  revision  on the default
  149.               branch,   normally   the   trunk.    For   example,
  150.               rrccss --nn_n_a_m_e:: RRCCSS//**  associates _n_a_m_e with the current
  151.               latest revision of all the named  RCS  files;  this
  152.               contrasts  with rrccss --nn_n_a_m_e::$$ RRCCSS//** which associates
  153.               _n_a_m_e with the revision numbers extracted from  key-
  154.               word strings in the corresponding working files.
  155.  
  156.        --NN_n_a_m_e[::[_r_e_v]]
  157.               Act  like  --nn, except override any previous assign-
  158.               ment of _n_a_m_e.
  159.  
  160.        --oo_r_a_n_g_e
  161.               deletes ("outdates") the revisions given by  _r_a_n_g_e.
  162.               A  range  consisting  of  a  single revision number
  163.               means that  revision.   A  range  consisting  of  a
  164.               branch  number  means  the  latest revision on that
  165.               branch.  A range of the form _r_e_v_1::_r_e_v_2 means  revi-
  166.               sions  _r_e_v_1  to _r_e_v_2 on the same branch, ::_r_e_v means
  167.               from the beginning of the branch containing _r_e_v  up
  168.               to  and including _r_e_v, and _r_e_v:: means from revision
  169.               _r_e_v to the end of the branch containing _r_e_v.   None
  170.               of  the  outdated  revisions  can  have branches or
  171.               locks.
  172.  
  173.        --qq     Run quietly; do not print diagnostics.
  174.  
  175.        --II     Run interactively, even if the  standard  input  is
  176.               not a terminal.
  177.  
  178.        --ss_s_t_a_t_e[::_r_e_v]
  179.               Set  the  state  attribute  of  the revision _r_e_v to
  180.               _s_t_a_t_e.  If _r_e_v is a branch number, assume the  lat-
  181.               est  revision  on  that branch.  If _r_e_v is omitted,
  182.               assume the latest revision on the  default  branch.
  183.               Any  identifier  is acceptable for _s_t_a_t_e.  A useful
  184.               set of states is EExxpp (for experimental), SSttaabb  (for
  185.               stable), and RReell (for released).  By default, ccii(1)
  186.               sets the state of a revision to EExxpp.
  187.  
  188.        --tt[_f_i_l_e]
  189.               Write descriptive text from  the  contents  of  the
  190.               named _f_i_l_e into the RCS file, deleting the existing
  191.               text.  The _f_i_l_e pathname cannot begin with  --.   If
  192.               _f_i_l_e  is  omitted,  obtain  the  text from standard
  193.  
  194.  
  195.  
  196. GNU                         1994/03/17                          3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. RCS(1)                                                     RCS(1)
  203.  
  204.  
  205.               input, terminated by end-of-file or by a line  con-
  206.               taining .. by itself.  Prompt for the text if inter-
  207.               action is possible; see --II.  With  --ii,  descriptive
  208.               text is obtained even if --tt is not given.
  209.  
  210.        --tt--_s_t_r_i_n_g
  211.               Write descriptive text from the _s_t_r_i_n_g into the RCS
  212.               file, deleting the existing text.
  213.  
  214.        --TT     Preserve the modification  time  on  the  RCS  file
  215.               unless a revision is removed.  This option can sup-
  216.               press extensive recompilation caused by  a  mmaakkee(1)
  217.               dependency  of some copy of the working file on the
  218.               RCS file.  Use this option with care; it  can  sup-
  219.               press  recompilation  even  when it is needed, i.e.
  220.               when a change to the RCS file would mean  a  change
  221.               to keyword strings in the working file.
  222.  
  223.        --VV     Print RCS's version number.
  224.  
  225.        --VV_n    Emulate RCS version _n.  See ccoo(1) for details.
  226.  
  227.        --xx_s_u_f_f_i_x_e_s
  228.               Use  _s_u_f_f_i_x_e_s to characterize RCS files.  See ccii(1)
  229.               for details.
  230.  
  231.        --zz_z_o_n_e Use _z_o_n_e as the default time zone.  This option has
  232.               no  effect;  it  is  present for compatibility with
  233.               other RCS commands.
  234.  
  235. CCOOMMPPAATTIIBBIILLIITTYY
  236.        The --bb_r_e_v option generates an  RCS  file  that  cannot  be
  237.        parsed by RCS version 3 or earlier.
  238.  
  239.        The  --kk_s_u_b_s_t  options  (except  --kkkkvv) generate an RCS file
  240.        that cannot be parsed by RCS version 4 or earlier.
  241.  
  242.        Use rrccss --VV_n to make an RCS file acceptable to RCS  version
  243.        _n  by discarding information that would confuse version _n.
  244.  
  245.        RCS version 5.5  and  earlier  does  not  support  the  --xx
  246.        option, and requires a ,,vv suffix on an RCS pathname.
  247.  
  248. FFIILLEESS
  249.        rrccss accesses files much as ccii(1) does, except that it uses
  250.        the effective user for all accesses, it does not write the
  251.        working  file  or its directory, and it does not even read
  252.        the working file unless a revision number of $$  is  speci-
  253.        fied.
  254.  
  255. EENNVVIIRROONNMMEENNTT
  256.        RRCCSSIINNIITT
  257.               options  prepended  to the argument list, separated
  258.               by spaces.  See ccii(1) for details.
  259.  
  260.  
  261.  
  262. GNU                         1994/03/17                          4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. RCS(1)                                                     RCS(1)
  269.  
  270.  
  271. DDIIAAGGNNOOSSTTIICCSS
  272.        The RCS pathname and the revisions outdated are written to
  273.        the  diagnostic  output.   The  exit status is zero if and
  274.        only if all operations were successful.
  275.  
  276. IIDDEENNTTIIFFIICCAATTIIOONN
  277.        Author: Walter F. Tichy.
  278.        Manual Page Revision: 5.11; Release Date: 1994/03/17.
  279.        Copyright (C) 1982, 1988, 1989 Walter F. Tichy.
  280.        Copyright (C) 1990, 1991, 1992, 1993, 1994 Paul Eggert.
  281.  
  282. SSEEEE AALLSSOO
  283.        rcsintro(1), co(1), ci(1),  ident(1),  rcsclean(1),  rcsd-
  284.        iff(1), rcsmerge(1), rlog(1), rcsfile(5)
  285.        Walter  F.  Tichy,  RCS--A  System  for  Version  Control,
  286.        _S_o_f_t_w_a_r_e_-_-_P_r_a_c_t_i_c_e  _&  _E_x_p_e_r_i_e_n_c_e  1155,  7   (July   1985),
  287.        637-654.
  288.  
  289. BBUUGGSS
  290.        A catastrophe (e.g. a system crash) can cause RCS to leave
  291.        behind a semaphore file that causes later  invocations  of
  292.        RCS  to  claim  that the RCS file is in use.  To fix this,
  293.        remove the semaphore file.  A semaphore file's name  typi-
  294.        cally begins with ,, or ends with __.
  295.  
  296.        The separator for revision ranges in the --oo option used to
  297.        be -- instead of ::, but this leads to confusion  when  sym-
  298.        bolic names contain --.  For backwards compatibility rrccss --oo
  299.        still supports the old -- separator,  but  it  warns  about
  300.        this obsolete use.
  301.  
  302.        Symbolic  names  need  not  refer to existing revisions or
  303.        branches.  For example, the --oo option does not remove sym-
  304.        bolic names for the outdated revisions; you must use --nn to
  305.        remove the names.
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328. GNU                         1994/03/17                          5
  329.  
  330.  
  331.