Annotation of src/usr.bin/rcs/rcs.1, Revision 1.13
1.13 ! xsa 1: .\" $OpenBSD: rcs.1,v 1.12 2005/11/04 15:06:22 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.13 ! xsa 34: .Op Fl ehiLMqUV
1.7 niallo 35: .Op Fl a Ns Ar users
36: .Op Fl b Ns Op Ar rev
1.12 xsa 37: .Op Fl c Ns Ar string
1.7 niallo 38: .Op Fl e Ns Op Ar users
1.9 xsa 39: .Op Fl k Ns Ar mode
1.7 niallo 40: .Op Fl m Ns Ar rev : Ns Ar log
1.1 deraadt 41: .Ar file Op Ar ...
42: .Sh DESCRIPTION
43: The
44: .Nm
45: program is used to create RCS files or manipulate the contents of existing
46: files.
47: .Pp
48: The following options are supported:
49: .Bl -tag -width "-e usersXX"
1.7 niallo 50: .It Fl a Ns Ar users
1.1 deraadt 51: Add the usernames specified in the comma-separated list
52: .Ar users
53: to the access list of the RCS files.
1.7 niallo 54: .It Fl b Ns Op Ar rev
1.12 xsa 55: .It Fl c Ns Ar string
56: Set comment leader to
57: .Ar string .
1.7 niallo 58: .It Fl e Ns Op Ar users
1.1 deraadt 59: Remove the usernames specified in the comma-separated list
60: .Ar users
61: from the access list of the RCS files.
62: If
63: .Ar users
64: is not specified, all users are removed from the access list.
65: .It Fl h
66: Display the program's usage and exit.
67: .It Fl i
1.10 xsa 68: Create and initialize a new RCS file.
1.11 jmc 69: If the RCS file has no path prefix, try to first create it in the
1.10 xsa 70: .Pa ./RCS
1.11 jmc 71: subdirectory or, if that fails, in the current directory.
1.1 deraadt 72: Files created this way contain no revision.
1.9 xsa 73: .It Fl k Ns Ar mode
74: Specify the keyword substitution mode.
1.1 deraadt 75: .It Fl L
76: Enable strict locking on the RCS files.
77: See
78: .Xr rcsfile 5
79: for more details on locking.
80: .It Fl M
81: Disable mail warnings when breaking a user's lock.
82: Normally,
83: .Nm
84: will send a mail to the lock owner when his lock is removed by a call
85: to
86: .Nm
87: .Fl u .
88: This option is currently ignored.
1.7 niallo 89: .It Fl m Ns Ar rev : Ns Ar msg
1.5 jmc 90: Replace revision
91: .Ar rev Ns 's
92: log message with
93: .Ar msg .
1.13 ! xsa 94: .It Fl q
! 95: Be quiet about reporting.
1.1 deraadt 96: .It Fl U
97: Disable strict locking on the RCS files.
98: See
99: .Xr rcsfile 5
100: for more details on locking.
101: .It Fl V
102: Print the program's version string and exit.
103: .El
104: .Sh ENVIRONMENT
105: .Bl -tag -width RCSINIT
106: .It Ev RCSINIT
107: If set, this variable should contain a list of space-delimited options that
108: are prepended to the argument list.
109: .El
110: .Sh SEE ALSO
111: .Xr ci 1 ,
112: .Xr co 1 ,
1.3 jmc 113: .Xr ident 1 ,
1.1 deraadt 114: .Xr rcsclean 1 ,
115: .Xr rcsdiff 1 ,
1.8 xsa 116: .Xr rcsmerge 1 ,
1.6 xsa 117: .Xr rlog 1