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