Annotation of src/usr.bin/rcs/ci.1, Revision 1.33
1.33 ! niallo 1: .\" $OpenBSD: ci.1,v 1.32 2006/08/04 06:26:39 ray 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.33 ! niallo 26: .Op Fl qV
1.9 niallo 27: .Op Fl d Ns Op Ar date
28: .Op Fl f Ns Op Ar rev
1.33 ! niallo 29: .Op Fl I Ns Op Ar rev
1.18 niallo 30: .Op Fl i Ns Op Ar rev
31: .Op Fl j Ns Op Ar rev
1.22 niallo 32: .Op Fl k Ns Op Ar rev
1.9 niallo 33: .Op Fl l Ns Op Ar rev
1.16 niallo 34: .Op Fl M Ns Op Ar rev
1.9 niallo 35: .Op Fl m Ns Ar msg
1.11 niallo 36: .Op Fl N Ns Ar symbol
1.10 niallo 37: .Op Fl n Ns Ar symbol
1.9 niallo 38: .Op Fl r Ns Op Ar rev
1.15 niallo 39: .Op Fl s Ns Ar state
1.30 ray 40: .Op Fl t Ns Ar str
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.33 ! niallo 94: .It Fl I Ns Op Ar rev
1.1 niallo 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
1.32 ray 120: Assign the symbolic name
121: .Ar symbol
122: to the checked in revision, overwriting any previous assignment of
1.12 jmc 123: .Ar symbol .
1.10 niallo 124: .It Fl n Ns Ar symbol
1.32 ray 125: The same as
126: .Fl N
127: except it does not overwrite previous symbols.
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.33 ! niallo 138: .Fl u
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.30 ray 145: .It Fl t Ns Ar str
1.21 xsa 146: Change the descriptive text.
1.30 ray 147: The argument
1.21 xsa 148: .Ar str
1.30 ray 149: is interpreted as the name of a file containing
150: the descriptive text or,
151: if prefixed with a
152: .Sq - ,
153: the actual descriptive text itself.
154: If no argument is given,
155: this option is ignored
156: (for compatibility reasons).
1.33 ! niallo 157: .It Fl u Ns Op Ar rev
1.1 niallo 158: The same as
159: .Fl r ,
1.3 jmc 160: but also immediately checks out the deposited revision read-only.
161: Useful if you wish to read the working file after check-in.
1.1 niallo 162: .It Fl V
163: Print RCS's version number.
1.33 ! niallo 164: .It Fl w Ns Ar username
1.1 niallo 165: Uses
1.33 ! niallo 166: .Ar username
1.1 niallo 167: as the author field of the deposited revision.
1.17 xsa 168: .It Fl x Ns Ar suffixes
169: Specifies the suffixes for RCS files.
170: Suffixes should be separated by the
171: .Sq /
172: character.
1.1 niallo 173: .El
1.31 xsa 174: .Pp
175: .Ex -std ci
1.1 niallo 176: .Sh ENVIRONMENT
177: .Bl -tag -width RCSINIT
178: .It Ev RCSINIT
179: If set, this variable should contain a list of space-delimited options that
180: are prepended to the argument list.
1.14 xsa 181: .It Ev TMPDIR
182: When set, this variable specifies the directory where temporary files
183: are to be created.
184: The default is set to
185: .Pa /tmp .
1.1 niallo 186: .El
187: .Sh SEE ALSO
188: .Xr co 1 ,
1.2 niallo 189: .Xr ident 1 ,
1.1 niallo 190: .Xr rcs 1 ,
191: .Xr rcsclean 1 ,
192: .Xr rcsdiff 1 ,
1.13 xsa 193: .Xr rcsmerge 1 ,
1.6 xsa 194: .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