home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / dev / RevisionControl / HWGRCS / hwgrcs / man / rcs.man < prev    next >
Text File  |  1993-01-19  |  11KB  |  331 lines
  1.  
  2.  
  3.  
  4. RCS(1)                   USER COMMANDS                     RCS(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      rcs - change RCS file attributes
  10.  
  11. SYNOPSIS
  12.      rcs [ _o_p_t_i_o_n_s ] _f_i_l_e ...
  13.  
  14. DESCRIPTION
  15.      rcs creates new RCS files or changes attributes of  existing
  16.      ones.   An  RCS file contains multiple revisions of text, an
  17.      access list, a change log, descriptive text, and  some  con-
  18.      trol  attributes.   For rcs to work, the caller's login name
  19.      must be on the access list, except if  the  access  list  is
  20.      empty, the caller is the owner of the file or the superuser,
  21.      or the -i option is present.
  22.  
  23.      Pathnames matching an RCS suffix denote RCS files; all  oth-
  24.      ers  denote working files.  Names are paired as explained in
  25.      ci(1).  Revision numbers use the syntax described in ci(1).
  26.  
  27. OPTIONS
  28.      -i   Create and initialize a new RCS file, but do not  depo-
  29.           sit  any revision.  If the RCS file has no path prefix,
  30.           try to place it first into the subdirectory ./RCS,  and
  31.           then  into  the  current  directory.   If  the RCS file
  32.           already exists, print an error message.
  33.  
  34.      -a_l_o_g_i_n_s
  35.           Append the login names appearing in the comma-separated
  36.           list _l_o_g_i_n_s to the access list of the RCS file.
  37.  
  38.      -A_o_l_d_f_i_l_e
  39.           Append the access list of _o_l_d_f_i_l_e to the access list of
  40.           the RCS file.
  41.  
  42.      -e[_l_o_g_i_n_s]
  43.           Erase the login names appearing in the  comma-separated
  44.           list  _l_o_g_i_n_s  from the access list of the RCS file.  If
  45.           _l_o_g_i_n_s is omitted, erase the entire access list.
  46.  
  47.      -b[_r_e_v]
  48.           Set the default branch to _r_e_v.  If _r_e_v is omitted,  the
  49.           default  branch  is  reset to the (dynamically) highest
  50.           branch on the trunk.
  51.  
  52.      -c_s_t_r_i_n_g
  53.           sets the comment leader to _s_t_r_i_n_g.  The comment  leader
  54.           is  printed  before every log message line generated by
  55.           the keyword $Log$ during checkout (see co(1)).  This is
  56.           useful  for  programming  languages  without multi-line
  57.           comments.  An initial ci , or  an  rcs -i  without  -c,
  58.           guesses the comment leader from the suffix of the work-
  59.           ing file.
  60.  
  61.  
  62.  
  63. GNU                  Last change: 1991/09/26                    1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RCS(1)                   USER COMMANDS                     RCS(1)
  71.  
  72.  
  73.  
  74.      -k_s_u_b_s_t
  75.           Set the default keyword  substitution  to  _s_u_b_s_t.   The
  76.           effect  of  keyword substitution is described in co(1).
  77.           Giving an  explicit  -k  option  to  co,  rcsdiff,  and
  78.           rcsmerge   overrides  this  default.   Beware  rcs -kv,
  79.           because -kv is incompatible with co -l.   Use  rcs -kkv
  80.           to restore the normal default keyword substitution.
  81.  
  82.      -l[_r_e_v]
  83.           Lock the revision with number  _r_e_v.   If  a  branch  is
  84.           given, lock the latest revision on that branch.  If _r_e_v
  85.           is omitted, lock the latest  revision  on  the  default
  86.           branch.   Locking prevents overlapping changes.  A lock
  87.           is removed with ci or rcs -u (see below).
  88.  
  89.      -u[_r_e_v]
  90.           Unlock the revision with number _r_e_v.  If  a  branch  is
  91.           given,  unlock  the latest revision on that branch.  If
  92.           _r_e_v is omitted, remove the  latest  lock  held  by  the
  93.           caller.   Normally,  only  the locker of a revision may
  94.           unlock it.  Somebody else unlocking a  revision  breaks
  95.           the lock.  This causes a mail message to be sent to the
  96.           original locker.  The  message  contains  a  commentary
  97.           solicited  from  the  breaker.   The commentary is ter-
  98.           minated by end-of-file or by  a  line  containing  . by
  99.           itself.
  100.  
  101.      -L   Set locking to _s_t_r_i_c_t.  Strict locking means  that  the
  102.           owner  of  an  RCS  file is not exempt from locking for
  103.           checkin.  This option should be used for files that are
  104.           shared.
  105.  
  106.      -U   Set locking to non-strict.   Non-strict  locking  means
  107.           that  the  owner of a file need not lock a revision for
  108.           checkin.  This option should _n_o_t be used for files that
  109.           are  shared.   Whether  default  locking  is  strict is
  110.           determined by your system administrator, but it is nor-
  111.           mally strict.
  112.  
  113.      -m_r_e_v:_m_s_g
  114.           Replace revision _r_e_v's log message with _m_s_g.
  115.  
  116.      -n_n_a_m_e[:[_r_e_v]]
  117.           Associate the symbolic name _n_a_m_e  with  the  branch  or
  118.           revision  _r_e_v.   Delete the symbolic name if both : and
  119.           _r_e_v are omitted; otherwise, print an error  message  if
  120.           _n_a_m_e is already associated with another number.  If _r_e_v
  121.           is symbolic, it is expanded before association.  A  _r_e_v
  122.           consisting  of  a  branch number followed by a . stands
  123.           for the current latest revision in  the  branch.   A  :
  124.           with  an  empty _r_e_v stands for the current latest revi-
  125.           sion on the default branch, normally  the  trunk.   For
  126.  
  127.  
  128.  
  129. GNU                  Last change: 1991/09/26                    2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RCS(1)                   USER COMMANDS                     RCS(1)
  137.  
  138.  
  139.  
  140.           example,  rcs -n_n_a_m_e: RCS/#?   associates _n_a_m_e with the
  141.           current latest revision of all  the  named  RCS  files;
  142.           this  contrasts with rcs -n_n_a_m_e:$ RCS/#?  which associ-
  143.           ates _n_a_m_e with the revision numbers extracted from key-
  144.           word strings in the corresponding working files.
  145.  
  146.      -N_n_a_m_e[:[_r_e_v]]
  147.           Act like -n, except override any previous assignment of
  148.           _n_a_m_e.
  149.  
  150.      -o_r_a_n_g_e
  151.           deletes ("outdates") the revisions given by  _r_a_n_g_e.   A
  152.           range consisting of a single revision number means that
  153.           revision.  A range consisting of a branch number  means
  154.           the  latest  revision  on  that branch.  A range of the
  155.           form _r_e_v_1:_r_e_v_2 means revisions _r_e_v_1 to _r_e_v_2 on the same
  156.           branch,  :_r_e_v  means  from  the beginning of the branch
  157.           containing _r_e_v up to and including _r_e_v, and _r_e_v:  means
  158.           from  revision  _r_e_v to the end of the branch containing
  159.           _r_e_v.  None of the outdated revisions may have  branches
  160.           or locks.
  161.  
  162.      -q   Run quietly; do not print diagnostics.
  163.  
  164.      -I   Run interactively, even if the standard input is not  a
  165.           terminal.
  166.  
  167.      -s_s_t_a_t_e[:_r_e_v]
  168.           Set the state attribute of the revision _r_e_v to _s_t_a_t_e  .
  169.           If  _r_e_v  is a branch number, assume the latest revision
  170.           on that branch.  If _r_e_v is omitted, assume  the  latest
  171.           revision  on  the  default  branch.   Any identifier is
  172.           acceptable for _s_t_a_t_e.  A useful set of  states  is  Exp
  173.           (for  experimental),  Stab  (for  stable), and Rel (for
  174.           released).  By default, ci(1) sets the state of a revi-
  175.           sion to Exp.
  176.  
  177.      -t[_f_i_l_e]
  178.           Write descriptive text from the contents of  the  named
  179.           _f_i_l_e  into  the  RCS  file, deleting the existing text.
  180.           The _f_i_l_e pathname may not begin with  -.   If  _f_i_l_e  is
  181.           omitted,  obtain  the  text  from  standard input, ter-
  182.           minated by end-of-file or by  a  line  containing  . by
  183.           itself.   Prompt  for the text if interaction is possi-
  184.           ble; see -I.  With -i,  descriptive  text  is  obtained
  185.           even if -t is not given.
  186.  
  187.      -t-_s_t_r_i_n_g
  188.           Write descriptive text from the  _s_t_r_i_n_g  into  the  RCS
  189.           file, deleting the existing text.
  190.  
  191.      -V_n  Emulate RCS version _n.  See co(1) for details.
  192.  
  193.  
  194.  
  195. GNU                  Last change: 1991/09/26                    3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. RCS(1)                   USER COMMANDS                     RCS(1)
  203.  
  204.  
  205.  
  206.      -x_s_u_f_f_i_x_e_s
  207.           Use _s_u_f_f_i_x_e_s to characterize RCS files.  See ci(1)  for
  208.           details.
  209.  
  210. COMPATIBILITY
  211.      The -b_r_e_v option generates an RCS file that cannot be parsed
  212.      by RCS version 3 or earlier.
  213.  
  214.      The -k_s_u_b_s_t options (except -kkv) generate an RCS file  that
  215.      cannot be parsed by RCS version 4 or earlier.
  216.  
  217.      Use rcs -V_n to make an RCS file acceptable to RCS version  _n
  218.      by discarding information that would confuse version _n.
  219.  
  220.      RCS version 5.5 and earlier does not support the -x  option,
  221.      and requires a ,v suffix on an RCS pathname.
  222.  
  223. FILES
  224.      rcs accesses files much as ci(1) does, except that  it  uses
  225.      the  effective  user for all accesses, it does not write the
  226.      working file or its directory, and it does not even read the
  227.      working file unless a revision number of $ is specified.
  228.  
  229. ENVIRONMENT
  230.      RCSINIT
  231.           options prepended to the argument  list,  separated  by
  232.           spaces.  See ci(1) for details.
  233.  
  234. DIAGNOSTICS
  235.      The RCS pathname and the revisions outdated are  written  to
  236.      the  diagnostic output.  The exit status is zero if and only
  237.      if all operations were successful.
  238.  
  239. IDENTIFICATION
  240.      Author: Walter F. Tichy.
  241.      Revision Number: 5.6; Release Date: 1991/09/26.
  242.      Copyright c 1982, 1988, 1989 by Walter F. Tichy.
  243.      Copyright c 1990, 1991 by Paul Eggert.
  244.  
  245. SEE ALSO
  246.      co(1),    ci(1),    ident(1),    rcsdiff(1),    rcsintro(1),
  247.      rcsmerge(1), rlog(1), rcsfile(5)
  248.      Walter  F.  Tichy,  RCS--A  System  for   Version   Control,
  249.      _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 15, 7 (July 1985), 637-654.
  250.  
  251. BUGS
  252.      The separator for revision ranges in the -o option  used  to
  253.      be - instead of :, but this leads to confusion when symbolic
  254.      names contain -.  For backwards compatibility rcs  -o  still
  255.      supports  the  old  -  separator,  but  it  warns about this
  256.      obsolete use.
  257.  
  258.  
  259.  
  260.  
  261. GNU                  Last change: 1991/09/26                    4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. RCS(1)                   USER COMMANDS                     RCS(1)
  269.  
  270.  
  271.  
  272.      Symbolic names need  not  refer  to  existing  revisions  or
  273.      branches.   For  example, the -o option does not remove sym-
  274.      bolic names for the outdated revisions; you must use  -n  to
  275.      remove the names.
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327. GNU                  Last change: 1991/09/26                    5
  328.  
  329.  
  330.  
  331.