Annotation of src/usr.bin/rcs/rcs.1, Revision 1.20
1.20 ! xsa 1: .\" $OpenBSD: rcs.1,v 1.19 2005/12/02 14:49:06 xsa Exp $
1.1 deraadt 2: .\"
3: .\" Copyright (c) 2005 Jean-Francois Brousseau <jfb@openbsd.org>
4: .\" All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\"
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. The name of the author may not be used to endorse or promote products
13: .\" derived from this software without specific prior written permission.
14: .\"
15: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
16: .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
17: .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
18: .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19: .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20: .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
21: .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
22: .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23: .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24: .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25: .\"
26: .Dd May 16, 2004
27: .Dt RCS 1
28: .Os
29: .Sh NAME
30: .Nm rcs
31: .Nd RCS file management program
32: .Sh SYNOPSIS
33: .Nm
1.20 ! xsa 34: .Op Fl ehIiLMqTUV
1.14 xsa 35: .Op Fl A Ns Ar oldfile
1.7 niallo 36: .Op Fl a Ns Ar users
37: .Op Fl b Ns Op Ar rev
1.12 xsa 38: .Op Fl c Ns Ar string
1.7 niallo 39: .Op Fl e Ns Op Ar users
1.9 xsa 40: .Op Fl k Ns Ar mode
1.20 ! xsa 41: .Oo Fl m Ns Ar rev Ns :
! 42: .Ar msg Oc
1.19 xsa 43: .Op Fl o Ns Ar rev
1.20 ! xsa 44: .Oo Fl s Ns Ar state Ns
! 45: .Op : Ns Ar rev Oc
1.14 xsa 46: .Oo Fl t Ns Ar file Ns \*(Ba
47: .Ar str Oc
1.15 xsa 48: .Op Fl x Ns Ar suffixes
1.18 xsa 49: .Op Fl z Ns Ar tz
1.14 xsa 50: .Ar file ...
1.1 deraadt 51: .Sh DESCRIPTION
52: The
53: .Nm
54: program is used to create RCS files or manipulate the contents of existing
55: files.
56: .Pp
57: The following options are supported:
58: .Bl -tag -width "-e usersXX"
1.14 xsa 59: .It Fl A Ns Ar oldfile
60: Append the access list of
61: .Ar oldfile
62: to the access list of the RCS files.
1.7 niallo 63: .It Fl a Ns Ar users
1.1 deraadt 64: Add the usernames specified in the comma-separated list
65: .Ar users
66: to the access list of the RCS files.
1.7 niallo 67: .It Fl b Ns Op Ar rev
1.14 xsa 68: Set the default branch to
69: .Ar rev .
1.12 xsa 70: .It Fl c Ns Ar string
71: Set comment leader to
72: .Ar string .
1.7 niallo 73: .It Fl e Ns Op Ar users
1.1 deraadt 74: Remove the usernames specified in the comma-separated list
75: .Ar users
76: from the access list of the RCS files.
77: If
78: .Ar users
79: is not specified, all users are removed from the access list.
80: .It Fl h
81: Display the program's usage and exit.
1.20 ! xsa 82: .It Fl I
! 83: Interactive mode.
1.1 deraadt 84: .It Fl i
1.10 xsa 85: Create and initialize a new RCS file.
1.11 jmc 86: If the RCS file has no path prefix, try to first create it in the
1.10 xsa 87: .Pa ./RCS
1.11 jmc 88: subdirectory or, if that fails, in the current directory.
1.1 deraadt 89: Files created this way contain no revision.
1.9 xsa 90: .It Fl k Ns Ar mode
91: Specify the keyword substitution mode.
1.1 deraadt 92: .It Fl L
93: Enable strict locking on the RCS files.
94: See
95: .Xr rcsfile 5
96: for more details on locking.
97: .It Fl M
98: Disable mail warnings when breaking a user's lock.
99: Normally,
100: .Nm
101: will send a mail to the lock owner when his lock is removed by a call
102: to
103: .Nm
104: .Fl u .
105: This option is currently ignored.
1.7 niallo 106: .It Fl m Ns Ar rev : Ns Ar msg
1.5 jmc 107: Replace revision
108: .Ar rev Ns 's
109: log message with
110: .Ar msg .
1.19 xsa 111: .It Fl o Ns Ar rev
112: Delete one or more revisions.
113: The specifications of the values or revisions are as follows:
114: .Bl -tag -width Ds
115: .It rev
116: Specific revision.
117: .It rev1:rev2
118: Delete all revisions of a branch between
119: .Ar rev1
120: and
121: .Ar rev2 .
122: .It rev1::rev2
123: Delete all revisions of a branch between
124: .Ar rev1
125: and
126: .Ar rev2
127: without deleting revisions
128: .Ar rev1
129: and
130: .Ar rev2 .
131: .It :rev
132: Delete all revisions of the branch until revision
133: .Ar rev .
134: .It rev:
135: Delete all revisions of the branch from revision
136: .Ar rev
137: until the last revision of the branch.
138: .El
1.13 xsa 139: .It Fl q
140: Be quiet about reporting.
1.14 xsa 141: .Sm off
1.20 ! xsa 142: .It Fl s Ar state Op : Ar rev
! 143: .Sm on
! 144: Sets the state of revision
! 145: .Ar rev
! 146: to the identifier
! 147: .Ar state .
! 148: The specified value may not contain a space character.
! 149: If
! 150: .Ar rev
! 151: is not specified, the latest revision of the default branch
! 152: is assumed.
1.16 xsa 153: .It Fl T
1.17 jmc 154: Preserve the modification time of RCS files.
1.20 ! xsa 155: .Sm off
1.14 xsa 156: .It Fl t Ar file \*(Ba Ar str
157: .Sm on
158: Change the descriptive text.
159: The descriptive text is taken from the
160: .Ar file
161: specified as argument or from the string
162: .Ar str
163: given as argument if it is preceded by the
164: .Sq -
165: character.
166: If no argument is used, the descriptive text is taken from standard input
167: terminated by end-of-file or by a line containing the
168: .Sq \&.
169: character by itself.
1.1 deraadt 170: .It Fl U
171: Disable strict locking on the RCS files.
172: See
173: .Xr rcsfile 5
174: for more details on locking.
175: .It Fl V
176: Print the program's version string and exit.
1.15 xsa 177: .It Fl x Ns Ar suffixes
178: Specifies the suffixes for RCS files.
179: Suffixes should be separated by the
180: .Sq /
181: character.
1.18 xsa 182: .It Fl z Ns Ar tz
183: No effect.
184: For compatibility.
1.1 deraadt 185: .El
186: .Sh ENVIRONMENT
187: .Bl -tag -width RCSINIT
188: .It Ev RCSINIT
189: If set, this variable should contain a list of space-delimited options that
190: are prepended to the argument list.
191: .El
192: .Sh SEE ALSO
193: .Xr ci 1 ,
194: .Xr co 1 ,
1.3 jmc 195: .Xr ident 1 ,
1.1 deraadt 196: .Xr rcsclean 1 ,
197: .Xr rcsdiff 1 ,
1.8 xsa 198: .Xr rcsmerge 1 ,
1.6 xsa 199: .Xr rlog 1