Annotation of src/usr.bin/rcs/ci.1, Revision 1.27
1.27 ! jmc 1: .\" $OpenBSD: ci.1,v 1.26 2006/04/19 10:49:41 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.
74: .Pp
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.24 jmc 92: Force check-in - optionally to
1.8 niallo 93: .Ar rev
94: - even if no changes have been made to the working file.
1.1 niallo 95: .It Fl I
96: Interactive mode.
1.18 niallo 97: .It Fl i Ns Op Ar rev
98: Only do initial check-in.
1.19 jmc 99: Print error and refuse to do check-in if the RCS file already exists.
1.18 niallo 100: .It Fl j Ns Op Ar rev
101: Only do update check-in.
1.19 jmc 102: Print error and refuse to do check-in if the RCS file does not already exist.
1.22 niallo 103: .It Fl k Ns Op Ar rev
104: Search the working file for keywords and set the revision number,
105: creation date, state and author to the values found in these keywords
1.23 jmc 106: instead of computing them.
1.9 niallo 107: .It Fl l Ns Op Ar rev
1.1 niallo 108: The same as
109: .Fl r ,
1.3 jmc 110: but also immediately checks out the deposited revision and locks it.
111: This is useful if you wish to continue to edit the working file after check-in.
1.16 niallo 112: .It Fl M Ns Op Ar rev
1.1 niallo 113: Set the modification time of the file to the date of the
114: retrieved revision.
1.9 niallo 115: .It Fl m Ns Ar msg
1.1 niallo 116: Specify a log message.
117: A line beginning with a hash character
118: .Pq Sq #
119: is considered a comment and ignored.
1.12 jmc 120: .It Fl N Ns Ar symbol
121: The same as
122: .Fl n
123: except it overwrites any previous assignment of
124: .Ar symbol .
1.10 niallo 125: .It Fl n Ns Ar symbol
126: Assign the symbolic name
127: .Ar symbol
128: to the checked in revision.
1.1 niallo 129: .It Fl q
130: Be quiet about reporting.
1.9 niallo 131: .It Fl r Ns Op Ar rev
1.1 niallo 132: Check in revision
133: .Ar rev .
1.4 niallo 134: However, if
135: .Ar rev
136: is not specified the meaning is completely different \- override any
137: .Fl l
138: or
1.5 niallo 139: .Fl u Op Ar rev
1.4 niallo 140: options, ensuring the default behaviour of releasing a lock and removing the
141: working file.
1.9 niallo 142: .It Fl s Ns Ar state
1.1 niallo 143: Sets the state of the deposited revision to the identifier
144: .Ar state .
1.15 niallo 145: The specified value may not contain a space character.
1.21 xsa 146: .Sm off
147: .It Fl t Ar file \*(Ba Ar str
148: .Sm on
149: Change the descriptive text.
150: The descriptive text is taken from the
1.20 niallo 151: .Ar file
1.21 xsa 152: specified as argument or from the string
153: .Ar str
154: given as argument if it is preceded by the
155: .Sq -
156: character.
157: If no argument is used, the descriptive text is taken from standard input
158: terminated by end-of-file or by a line containing the
159: .Sq \&.
160: character by itself.
1.1 niallo 161: .It Fl u
162: The same as
163: .Fl r ,
1.3 jmc 164: but also immediately checks out the deposited revision read-only.
165: Useful if you wish to read the working file after check-in.
1.1 niallo 166: .It Fl V
167: Print RCS's version number.
1.9 niallo 168: .It Fl w Ns Ar user
1.1 niallo 169: Uses
170: .Ar user
171: as the author field of the deposited revision.
1.17 xsa 172: .It Fl x Ns Ar suffixes
173: Specifies the suffixes for RCS files.
174: Suffixes should be separated by the
175: .Sq /
176: character.
1.1 niallo 177: .El
178: .Sh ENVIRONMENT
179: .Bl -tag -width RCSINIT
180: .It Ev RCSINIT
181: If set, this variable should contain a list of space-delimited options that
182: are prepended to the argument list.
1.14 xsa 183: .It Ev TMPDIR
184: When set, this variable specifies the directory where temporary files
185: are to be created.
186: The default is set to
187: .Pa /tmp .
1.1 niallo 188: .El
189: .Sh SEE ALSO
190: .Xr co 1 ,
1.2 niallo 191: .Xr ident 1 ,
1.1 niallo 192: .Xr rcs 1 ,
193: .Xr rcsclean 1 ,
194: .Xr rcsdiff 1 ,
1.13 xsa 195: .Xr rcsmerge 1 ,
1.6 xsa 196: .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