Annotation of src/usr.bin/rcs/rcs.1, Revision 1.19
1.19 ! xsa 1: .\" $OpenBSD: rcs.1,v 1.18 2005/11/30 09:36:48 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.16 xsa 34: .Op Fl ehiLMqTUV
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.7 niallo 41: .Op Fl m Ns Ar rev : Ns Ar log
1.19 ! xsa 42: .Op Fl o Ns Ar rev
1.14 xsa 43: .Oo Fl t Ns Ar file Ns \*(Ba
44: .Ar str Oc
1.15 xsa 45: .Op Fl x Ns Ar suffixes
1.18 xsa 46: .Op Fl z Ns Ar tz
1.14 xsa 47: .Ar file ...
1.1 deraadt 48: .Sh DESCRIPTION
49: The
50: .Nm
51: program is used to create RCS files or manipulate the contents of existing
52: files.
53: .Pp
54: The following options are supported:
55: .Bl -tag -width "-e usersXX"
1.14 xsa 56: .It Fl A Ns Ar oldfile
57: Append the access list of
58: .Ar oldfile
59: to the access list of the RCS files.
1.7 niallo 60: .It Fl a Ns Ar users
1.1 deraadt 61: Add the usernames specified in the comma-separated list
62: .Ar users
63: to the access list of the RCS files.
1.7 niallo 64: .It Fl b Ns Op Ar rev
1.14 xsa 65: Set the default branch to
66: .Ar rev .
1.12 xsa 67: .It Fl c Ns Ar string
68: Set comment leader to
69: .Ar string .
1.7 niallo 70: .It Fl e Ns Op Ar users
1.1 deraadt 71: Remove the usernames specified in the comma-separated list
72: .Ar users
73: from the access list of the RCS files.
74: If
75: .Ar users
76: is not specified, all users are removed from the access list.
77: .It Fl h
78: Display the program's usage and exit.
79: .It Fl i
1.10 xsa 80: Create and initialize a new RCS file.
1.11 jmc 81: If the RCS file has no path prefix, try to first create it in the
1.10 xsa 82: .Pa ./RCS
1.11 jmc 83: subdirectory or, if that fails, in the current directory.
1.1 deraadt 84: Files created this way contain no revision.
1.9 xsa 85: .It Fl k Ns Ar mode
86: Specify the keyword substitution mode.
1.1 deraadt 87: .It Fl L
88: Enable strict locking on the RCS files.
89: See
90: .Xr rcsfile 5
91: for more details on locking.
92: .It Fl M
93: Disable mail warnings when breaking a user's lock.
94: Normally,
95: .Nm
96: will send a mail to the lock owner when his lock is removed by a call
97: to
98: .Nm
99: .Fl u .
100: This option is currently ignored.
1.7 niallo 101: .It Fl m Ns Ar rev : Ns Ar msg
1.5 jmc 102: Replace revision
103: .Ar rev Ns 's
104: log message with
105: .Ar msg .
1.19 ! xsa 106: .It Fl o Ns Ar rev
! 107: Delete one or more revisions.
! 108: The specifications of the values or revisions are as follows:
! 109: .Bl -tag -width Ds
! 110: .It rev
! 111: Specific revision.
! 112: .It rev1:rev2
! 113: Delete all revisions of a branch between
! 114: .Ar rev1
! 115: and
! 116: .Ar rev2 .
! 117: .It rev1::rev2
! 118: Delete all revisions of a branch between
! 119: .Ar rev1
! 120: and
! 121: .Ar rev2
! 122: without deleting revisions
! 123: .Ar rev1
! 124: and
! 125: .Ar rev2 .
! 126: .It :rev
! 127: Delete all revisions of the branch until revision
! 128: .Ar rev .
! 129: .It rev:
! 130: Delete all revisions of the branch from revision
! 131: .Ar rev
! 132: until the last revision of the branch.
! 133: .El
1.13 xsa 134: .It Fl q
135: Be quiet about reporting.
1.14 xsa 136: .Sm off
1.16 xsa 137: .It Fl T
1.17 jmc 138: Preserve the modification time of RCS files.
1.14 xsa 139: .It Fl t Ar file \*(Ba Ar str
140: .Sm on
141: Change the descriptive text.
142: The descriptive text is taken from the
143: .Ar file
144: specified as argument or from the string
145: .Ar str
146: given as argument if it is preceded by the
147: .Sq -
148: character.
149: If no argument is used, the descriptive text is taken from standard input
150: terminated by end-of-file or by a line containing the
151: .Sq \&.
152: character by itself.
1.1 deraadt 153: .It Fl U
154: Disable strict locking on the RCS files.
155: See
156: .Xr rcsfile 5
157: for more details on locking.
158: .It Fl V
159: Print the program's version string and exit.
1.15 xsa 160: .It Fl x Ns Ar suffixes
161: Specifies the suffixes for RCS files.
162: Suffixes should be separated by the
163: .Sq /
164: character.
1.18 xsa 165: .It Fl z Ns Ar tz
166: No effect.
167: For compatibility.
1.1 deraadt 168: .El
169: .Sh ENVIRONMENT
170: .Bl -tag -width RCSINIT
171: .It Ev RCSINIT
172: If set, this variable should contain a list of space-delimited options that
173: are prepended to the argument list.
174: .El
175: .Sh SEE ALSO
176: .Xr ci 1 ,
177: .Xr co 1 ,
1.3 jmc 178: .Xr ident 1 ,
1.1 deraadt 179: .Xr rcsclean 1 ,
180: .Xr rcsdiff 1 ,
1.8 xsa 181: .Xr rcsmerge 1 ,
1.6 xsa 182: .Xr rlog 1