Annotation of src/usr.bin/rcs/ci.1, Revision 1.19
1.19 ! jmc 1: .\" $OpenBSD: ci.1,v 1.18 2005/11/24 00:51:36 niallo Exp $
1.1 niallo 2: .\"
3: .\" Copyright (c) 2005 Niall O'Higgins <niallo@openbsd.org>
4: .\" All rights reserved.
5: .\"
6: .\" Permission to use, copy, modify, and distribute this software for any
7: .\" purpose with or without fee is hereby granted, provided that the above
8: .\" copyright notice and this permission notice appear in all copies.
9: .\"
10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: .Dd October 08, 2005
18: .Dt CI 1
19: .Os
20: .Sh NAME
21: .Nm ci
22: .Nd check in RCS revisions
23: .Sh SYNOPSIS
24: .Nm
25: .Bk -words
1.5 niallo 26: .Op Fl jMNqV
1.9 niallo 27: .Op Fl d Ns Op Ar date
28: .Op Fl f Ns Op Ar rev
1.18 niallo 29: .Op Fl i Ns Op Ar rev
30: .Op Fl j Ns Op Ar rev
1.9 niallo 31: .Op Fl k Ns Ar mode
32: .Op Fl l Ns Op Ar rev
1.16 niallo 33: .Op Fl M Ns Op Ar rev
1.9 niallo 34: .Op Fl m Ns Ar msg
1.11 niallo 35: .Op Fl N Ns Ar symbol
1.10 niallo 36: .Op Fl n Ns Ar symbol
1.9 niallo 37: .Op Fl r Ns Op Ar rev
1.15 niallo 38: .Op Fl s Ns Ar state
1.9 niallo 39: .Op Fl u Ns Op Ar rev
40: .Op Fl w Ns Ar username
1.17 xsa 41: .Op Fl x Ns Ar suffixes
1.1 niallo 42: .Ar file ...
43: .Ek
44: .Sh DESCRIPTION
45: The
46: .Nm
47: program is used to check new revisions into RCS files.
48: .Pp
49: The following options are supported:
50: .Bl -tag -width Ds
1.9 niallo 51: .It Fl d Ns Op Ar date
1.1 niallo 52: Uses
53: .Ar date
54: for check-in date and time.
1.7 niallo 55: If
56: .Ar date
57: is not specified, use the working file's last modification time.
1.9 niallo 58: .It Fl f Ns Op Ar rev
1.8 niallo 59: Force check in - optionally to
60: .Ar rev
61: - even if no changes have been made to the working file.
1.1 niallo 62: .It Fl I
63: Interactive mode.
1.18 niallo 64: .It Fl i Ns Op Ar rev
65: Only do initial check-in.
1.19 ! jmc 66: Print error and refuse to do check-in if the RCS file already exists.
1.18 niallo 67: .It Fl j Ns Op Ar rev
68: Only do update check-in.
1.19 ! jmc 69: Print error and refuse to do check-in if the RCS file does not already exist.
1.9 niallo 70: .It Fl k Ns Ar mode
1.1 niallo 71: Specify the keyword substitution mode.
1.9 niallo 72: .It Fl l Ns Op Ar rev
1.1 niallo 73: The same as
74: .Fl r ,
1.3 jmc 75: but also immediately checks out the deposited revision and locks it.
76: This is useful if you wish to continue to edit the working file after check-in.
1.16 niallo 77: .It Fl M Ns Op Ar rev
1.1 niallo 78: Set the modification time of the file to the date of the
79: retrieved revision.
1.9 niallo 80: .It Fl m Ns Ar msg
1.1 niallo 81: Specify a log message.
82: A line beginning with a hash character
83: .Pq Sq #
84: is considered a comment and ignored.
1.12 jmc 85: .It Fl N Ns Ar symbol
86: The same as
87: .Fl n
88: except it overwrites any previous assignment of
89: .Ar symbol .
1.10 niallo 90: .It Fl n Ns Ar symbol
91: Assign the symbolic name
92: .Ar symbol
93: to the checked in revision.
1.1 niallo 94: .It Fl q
95: Be quiet about reporting.
1.9 niallo 96: .It Fl r Ns Op Ar rev
1.1 niallo 97: Check in revision
98: .Ar rev .
1.4 niallo 99: However, if
100: .Ar rev
101: is not specified the meaning is completely different \- override any
102: .Fl l
103: or
1.5 niallo 104: .Fl u Op Ar rev
1.4 niallo 105: options, ensuring the default behaviour of releasing a lock and removing the
106: working file.
1.9 niallo 107: .It Fl s Ns Ar state
1.1 niallo 108: Sets the state of the deposited revision to the identifier
109: .Ar state .
1.15 niallo 110: The specified value may not contain a space character.
1.1 niallo 111: .It Fl u
112: The same as
113: .Fl r ,
1.3 jmc 114: but also immediately checks out the deposited revision read-only.
115: Useful if you wish to read the working file after check-in.
1.1 niallo 116: .It Fl V
117: Print RCS's version number.
1.9 niallo 118: .It Fl w Ns Ar user
1.1 niallo 119: Uses
120: .Ar user
121: as the author field of the deposited revision.
1.17 xsa 122: .It Fl x Ns Ar suffixes
123: Specifies the suffixes for RCS files.
124: Suffixes should be separated by the
125: .Sq /
126: character.
1.1 niallo 127: .El
128: .Sh ENVIRONMENT
129: .Bl -tag -width RCSINIT
130: .It Ev RCSINIT
131: If set, this variable should contain a list of space-delimited options that
132: are prepended to the argument list.
1.14 xsa 133: .It Ev TMPDIR
134: When set, this variable specifies the directory where temporary files
135: are to be created.
136: The default is set to
137: .Pa /tmp .
1.1 niallo 138: .El
139: .Sh SEE ALSO
140: .Xr co 1 ,
1.2 niallo 141: .Xr ident 1 ,
1.1 niallo 142: .Xr rcs 1 ,
143: .Xr rcsclean 1 ,
144: .Xr rcsdiff 1 ,
1.13 xsa 145: .Xr rcsmerge 1 ,
1.6 xsa 146: .Xr rlog 1