Annotation of src/usr.bin/rcs/ci.1, Revision 1.29
1.29 ! jmc 1: .\" $OpenBSD: ci.1,v 1.28 2006/04/24 22:06:49 jmc 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.22 niallo 31: .Op Fl k Ns Op Ar rev
1.9 niallo 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.21 xsa 39: .Oo Fl t Ns Ar file Ns \*(Ba
40: .Ar str Oc
1.9 niallo 41: .Op Fl u Ns Op Ar rev
42: .Op Fl w Ns Ar username
1.17 xsa 43: .Op Fl x Ns Ar suffixes
1.26 jmc 44: .Ar
1.1 niallo 45: .Ek
46: .Sh DESCRIPTION
47: The
48: .Nm
1.24 jmc 49: program is used to check in new revisions to RCS files.
1.26 jmc 50: .Pp
51: When a file is checked in,
52: it is stored in the RCS directory with a specific revision number,
53: and the original file itself is deleted.
54: The RCS file is stored with the same name, but with
55: .Sq ,v
56: appended.
57: .Nm
58: will prompt for a check-in message,
59: to be stored with the file,
60: which can be displayed using
61: .Xr rlog 1 .
62: .Pp
63: Revision numbering starts at 1.1
64: and increases logically.
65: Numbering can be altered using the
66: .Fl k
67: option, however.
68: The
69: .Sq ,v
70: suffix can also be altered,
71: using the
72: .Fl x
73: option.
1.28 jmc 74: .Pp
1.26 jmc 75: .Nm
76: also supports
77: keyword substitution \(en
78: see the
1.27 jmc 79: .Xr rcs 1
1.26 jmc 80: man page for more information.
1.1 niallo 81: .Pp
82: The following options are supported:
83: .Bl -tag -width Ds
1.9 niallo 84: .It Fl d Ns Op Ar date
1.1 niallo 85: Uses
86: .Ar date
87: for check-in date and time.
1.7 niallo 88: If
89: .Ar date
90: is not specified, use the working file's last modification time.
1.9 niallo 91: .It Fl f Ns Op Ar rev
1.28 jmc 92: Force check-in
93: \(en even if no changes have been made to the working file.
1.1 niallo 94: .It Fl I
95: Interactive mode.
1.18 niallo 96: .It Fl i Ns Op Ar rev
97: Only do initial check-in.
1.19 jmc 98: Print error and refuse to do check-in if the RCS file already exists.
1.18 niallo 99: .It Fl j Ns Op Ar rev
100: Only do update check-in.
1.19 jmc 101: Print error and refuse to do check-in if the RCS file does not already exist.
1.22 niallo 102: .It Fl k Ns Op Ar rev
103: Search the working file for keywords and set the revision number,
104: creation date, state and author to the values found in these keywords
1.23 jmc 105: instead of computing them.
1.9 niallo 106: .It Fl l Ns Op Ar rev
1.1 niallo 107: The same as
108: .Fl r ,
1.3 jmc 109: but also immediately checks out the deposited revision and locks it.
110: This is useful if you wish to continue to edit the working file after check-in.
1.16 niallo 111: .It Fl M Ns Op Ar rev
1.1 niallo 112: Set the modification time of the file to the date of the
113: retrieved revision.
1.9 niallo 114: .It Fl m Ns Ar msg
1.1 niallo 115: Specify a log message.
116: A line beginning with a hash character
117: .Pq Sq #
118: is considered a comment and ignored.
1.12 jmc 119: .It Fl N Ns Ar symbol
120: The same as
121: .Fl n
122: except it overwrites any previous assignment of
123: .Ar symbol .
1.10 niallo 124: .It Fl n Ns Ar symbol
125: Assign the symbolic name
126: .Ar symbol
127: to the checked in revision.
1.1 niallo 128: .It Fl q
129: Be quiet about reporting.
1.9 niallo 130: .It Fl r Ns Op Ar rev
1.1 niallo 131: Check in revision
132: .Ar rev .
1.4 niallo 133: However, if
134: .Ar rev
135: is not specified the meaning is completely different \- override any
136: .Fl l
137: or
1.5 niallo 138: .Fl u Op Ar rev
1.4 niallo 139: options, ensuring the default behaviour of releasing a lock and removing the
140: working file.
1.9 niallo 141: .It Fl s Ns Ar state
1.1 niallo 142: Sets the state of the deposited revision to the identifier
143: .Ar state .
1.15 niallo 144: The specified value may not contain a space character.
1.21 xsa 145: .Sm off
146: .It Fl t Ar file \*(Ba Ar str
147: .Sm on
148: Change the descriptive text.
149: The descriptive text is taken from the
1.20 niallo 150: .Ar file
1.21 xsa 151: specified as argument or from the string
152: .Ar str
153: given as argument if it is preceded by the
154: .Sq -
155: character.
156: If no argument is used, the descriptive text is taken from standard input
157: terminated by end-of-file or by a line containing the
158: .Sq \&.
159: character by itself.
1.1 niallo 160: .It Fl u
161: The same as
162: .Fl r ,
1.3 jmc 163: but also immediately checks out the deposited revision read-only.
164: Useful if you wish to read the working file after check-in.
1.1 niallo 165: .It Fl V
166: Print RCS's version number.
1.9 niallo 167: .It Fl w Ns Ar user
1.1 niallo 168: Uses
169: .Ar user
170: as the author field of the deposited revision.
1.17 xsa 171: .It Fl x Ns Ar suffixes
172: Specifies the suffixes for RCS files.
173: Suffixes should be separated by the
174: .Sq /
175: character.
1.1 niallo 176: .El
177: .Sh ENVIRONMENT
178: .Bl -tag -width RCSINIT
179: .It Ev RCSINIT
180: If set, this variable should contain a list of space-delimited options that
181: are prepended to the argument list.
1.14 xsa 182: .It Ev TMPDIR
183: When set, this variable specifies the directory where temporary files
184: are to be created.
185: The default is set to
186: .Pa /tmp .
1.1 niallo 187: .El
188: .Sh SEE ALSO
189: .Xr co 1 ,
1.2 niallo 190: .Xr ident 1 ,
1.1 niallo 191: .Xr rcs 1 ,
192: .Xr rcsclean 1 ,
193: .Xr rcsdiff 1 ,
1.13 xsa 194: .Xr rcsmerge 1 ,
1.6 xsa 195: .Xr rlog 1
![[BACK]](/icons/back.gif){kind=icon}
Return to ci.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / rcs