xref: /386bsd/usr/share/man/cat1/rcs.0 (revision a2142627)
1
2
3
4RCS(1L)                                                   RCS(1L)
5
6
7NNAAMMEE
8       rcs - change RCS file attributes
9
10SSYYNNOOPPSSIISS
11       rrccss [ options ] file ...
12
13DDEESSCCRRIIPPTTIIOONN
14       _R_c_s  creates  new  RCS  files  or  changes  attributes  of
15       existing ones.  An RCS file contains multiple revisions of
16       text,  an access list, a change log, descriptive text, and
17       some control attributes.  For _r_c_s 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       Files ending in `,v' are RCS files, all others are working
23       files. If a working file is given, _r_c_s tries to  find  the
24       corresponding  RCS  file first in directory ./RCS and then
25       in the current directory, as explained in _c_o(1L).
26
27       --ii         creates and initializes a  new  RCS  file,  but
28                  does not deposit any revision.  If the RCS file
29                  has no path prefix, _r_c_s tries to place it first
30                  into  the subdirectory ./RCS, and then into the
31                  current directory.  If  the  RCS  file  already
32                  exists, an error message is printed.
33
34       --aa_l_o_g_i_n_s   appends the login names appearing in the comma-
35                  separated list _l_o_g_i_n_s to the access list of the
36                  RCS file.
37
38       --AA_o_l_d_f_i_l_e  appends  the  access  list  of  _o_l_d_f_i_l_e  to the
39                  access list of the RCS file.
40
41       --ee[_l_o_g_i_n_s] erases the login names appearing in the  comma-
42                  separated  list  _l_o_g_i_n_s from the access list of
43                  the RCS file.  If _l_o_g_i_n_s is omitted, the entire
44                  access list is erased.
45
46       --bb[_r_e_v]    sets  the  default  branch  to  _r_e_v.  If _r_e_v is
47                  omitted, the default branch  is  reset  to  the
48                  (dynamically) highest branch on the trunk.
49
50       --cc_s_t_r_i_n_g   sets  the comment leader to _s_t_r_i_n_g. The comment
51                  leader is printed before every log message line
52                  generated by the keyword $Log$  during checkout
53                  (see _c_o(1L)).  This is useful  for  programming
54                  languages  without  multi-line comments. During
55                  rrccss --ii or initial ccii,  the  comment  leader  is
56                  guessed from the suffix of the working file.
57
58       --ll[_r_e_v]    locks  the  revision  with  number  _r_e_v.   If a
59                  branch is given, the latest  revision  on  that
60                  branch  is  locked.   If  _r_e_v  is  omitted, the
61
62
63
64University                    Purdue                            1
65
66
67
68
69
70RCS(1L)                                                   RCS(1L)
71
72
73                  latest  revision  on  the  default  branch   is
74                  locked.   Locking prevents overlapping changes.
75                  A lock is  removed  with  ccii  or  rrccss  --uu  (see
76                  below).
77
78       --uu[_r_e_v]    unlocks  the  revision  with  number _r_e_v.  If a
79                  branch is given, the latest  revision  on  that
80                  branch  is  unlocked.   If  _r_e_v is omitted, the
81                  latest lock held  by  the  caller  is  removed.
82                  Normally,  only  the  locker  of a revision may
83                  unlock it.  Somebody else unlocking a  revision
84                  breaks the lock.  This causes a mail message to
85                  be sent to the original  locker.   The  message
86                  contains   a   commentary  solicited  from  the
87                  breaker.  The commentary is terminated  with  a
88                  line containing a single `.' or control-D.
89
90       --LL         sets  locking  to  _s_t_r_i_c_t. Strict locking means
91                  that the owner of an RCS  file  is  not  exempt
92                  from  locking  for checkin.  This option should
93                  be used for files that are shared.
94
95       --UU         sets locking to non-strict. Non-strict  locking
96                  means  that the owner of a file need not lock a
97                  revision for checkin.  This option  should  NOT
98                  be used for files that are shared.  The default
99                  (--LL  or  --UU)  is  determined  by  your   system
100                  administrator.
101
102       --nn_n_a_m_e[:_r_e_v]
103                  associates  the  symbolic  name  _n_a_m_e  with the
104                  branch or revision _r_e_v.  _R_c_s  prints  an  error
105                  message  if  _n_a_m_e  is  already  associated with
106                  another  number.   If  _r_e_v  is   omitted,   the
107                  symbolic name is deleted.
108
109       --NN_n_a_m_e[:_r_e_v]
110                  same as --nn, except that it overrides a previous
111                  assignment of _n_a_m_e.
112
113       --oo_r_a_n_g_e    deletes ("outdates")  the  revisions  given  by
114                  _r_a_n_g_e.  A range consisting of a single revision
115                  number means that revision.  A range consisting
116                  of a branch number means the latest revision on
117                  that branch.  A range  of  the  form  _r_e_v_1-_r_e_v_2
118                  means  revisions  _r_e_v_1  to  _r_e_v_2  on  the  same
119                  branch, -_r_e_v means from the  beginning  of  the
120                  branch  containing _r_e_v up to and including _r_e_v,
121                  and _r_e_v- means from revision _r_e_v to the end  of
122                  the   branch   containing  _r_e_v.   None  of  the
123                  outdated revisions may have branches or  locks.
124
125       --qq         quiet mode; diagnostics are not printed.
126
127
128
129
130University                    Purdue                            2
131
132
133
134
135
136RCS(1L)                                                   RCS(1L)
137
138
139       --ss_s_t_a_t_e[:_r_e_v]
140                  sets the state attribute of the revision _r_e_v to
141                  _s_t_a_t_e.  If _r_e_v is a branch number,  the  latest
142                  revision  on that branch is assumed.  If _r_e_v is
143                  omitted, the latest  revision  on  the  default
144                  branch   is   assumed.    Any   identifier   is
145                  acceptable for _s_t_a_t_e.  A useful set  of  states
146                  is  _E_x_p  (for experimental), _S_t_a_b (for stable),
147                  and _R_e_l (for  released).   By  default,  _c_i(1L)
148                  sets the state of a revision to _E_x_p.
149
150       --tt[_t_x_t_f_i_l_e]
151                  writes  descriptive  text  into  the  RCS  file
152                  (deletes the existing  text).   If  _t_x_t_f_i_l_e  is
153                  omitted, _r_c_s prompts the user for text supplied
154                  from the standard input, terminated with a line
155                  containing   a   single   `.'   or   control-D.
156                  Otherwise, the descriptive text is copied  from
157                  the file _t_x_t_f_i_l_e.  If the --ii option is present,
158                  descriptive text is requested even if --tt is not
159                  given.    The   prompt  is  suppressed  if  the
160                  standard input is not a terminal.
161
162DDIIAAGGNNOOSSTTIICCSS
163       The RCS file name and the revisions outdated  are  written
164       to  the  diagnostic output.  The exit status always refers
165       to the last RCS file  operated  upon,  and  is  0  if  the
166       operation was successful, 1 otherwise.
167
168FFIILLEESS
169       The  caller of the command must have read/write permission
170       for  the  directory  containing  the  RCS  file  and  read
171       permission  for  the  RCS  file  itself.   _R_c_s  creates  a
172       semaphore file in the same directory as the  RCS  file  to
173       prevent  simultaneous  update.   For  changes,  _r_c_s always
174       creates a new file. On successful completion, _r_c_s  deletes
175       the  old one and renames the new one.  This strategy makes
176       links to RCS files useless.
177
178IIDDEENNTTIIFFIICCAATTIIOONN
179       Author:  Walter  F.   Tichy,   Purdue   University,   West
180       Lafayette, IN, 47907.
181       Revision Number: 1.3 ; Release Date: 89/05/02 .
182       Copyright (C) 1982, 1988, 1989 by Walter F. Tichy.
183
184SSEEEE AALLSSOO
185       co(1L),   ci(1L),  ident(1L),  rcsdiff(1L),  rcsintro(1L),
186       rcsmerge(1L), rlog(1L), rcsfile(5L)
187       Walter F. Tichy, "Design, Implementation,  and  Evaluation
188       of  a  Revision Control System," in _P_r_o_c_e_e_d_i_n_g_s _o_f _t_h_e _6_t_h
189       _I_n_t_e_r_n_a_t_i_o_n_a_l _C_o_n_f_e_r_e_n_c_e _o_n  _S_o_f_t_w_a_r_e  _E_n_g_i_n_e_e_r_i_n_g,  IEEE,
190       Tokyo, Sept. 1982.
191
192
193
194
195
196University                    Purdue                            3
197
198
199