Annotation of src/usr.bin/rcs/ci.1, Revision 1.36
1.36 ! jmc 1: .\" $OpenBSD: ci.1,v 1.35 2007/08/26 21:35:43 sobrado 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.
1.35 sobrado 17: .Dd $Mdocdate: May 31 2007 $
1.1 niallo 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.35 sobrado 44: .Op Fl z Ns Ar tz
1.26 jmc 45: .Ar
1.1 niallo 46: .Ek
47: .Sh DESCRIPTION
48: The
49: .Nm
1.24 jmc 50: program is used to check in new revisions to RCS files.
1.26 jmc 51: .Pp
52: When a file is checked in,
53: it is stored in the RCS directory with a specific revision number,
54: and the original file itself is deleted.
55: The RCS file is stored with the same name, but with
56: .Sq ,v
57: appended.
58: .Nm
59: will prompt for a check-in message,
60: to be stored with the file,
61: which can be displayed using
62: .Xr rlog 1 .
63: .Pp
64: Revision numbering starts at 1.1
65: and increases logically.
66: Numbering can be altered using the
67: .Fl k
68: option, however.
69: The
70: .Sq ,v
71: suffix can also be altered,
72: using the
73: .Fl x
74: option.
1.28 jmc 75: .Pp
1.26 jmc 76: .Nm
77: also supports
78: keyword substitution \(en
79: see the
1.27 jmc 80: .Xr rcs 1
1.26 jmc 81: man page for more information.
1.1 niallo 82: .Pp
83: The following options are supported:
84: .Bl -tag -width Ds
1.9 niallo 85: .It Fl d Ns Op Ar date
1.1 niallo 86: Uses
87: .Ar date
88: for check-in date and time.
1.7 niallo 89: If
90: .Ar date
91: is not specified, use the working file's last modification time.
1.9 niallo 92: .It Fl f Ns Op Ar rev
1.28 jmc 93: Force check-in
94: \(en even if no changes have been made to the working file.
1.33 niallo 95: .It Fl I Ns Op Ar rev
1.1 niallo 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
1.32 ray 121: Assign the symbolic name
122: .Ar symbol
123: to the checked in revision, overwriting any previous assignment of
1.12 jmc 124: .Ar symbol .
1.10 niallo 125: .It Fl n Ns Ar symbol
1.32 ray 126: The same as
127: .Fl N
128: except it does not overwrite previous symbols.
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.33 niallo 139: .Fl u
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.30 ray 146: .It Fl t Ns Ar str
1.21 xsa 147: Change the descriptive text.
1.30 ray 148: The argument
1.21 xsa 149: .Ar str
1.30 ray 150: is interpreted as the name of a file containing
151: the descriptive text or,
152: if prefixed with a
153: .Sq - ,
154: the actual descriptive text itself.
155: If no argument is given,
156: this option is ignored
157: (for compatibility reasons).
1.33 niallo 158: .It Fl u Ns Op Ar rev
1.1 niallo 159: The same as
160: .Fl r ,
1.3 jmc 161: but also immediately checks out the deposited revision read-only.
162: Useful if you wish to read the working file after check-in.
1.1 niallo 163: .It Fl V
164: Print RCS's version number.
1.33 niallo 165: .It Fl w Ns Ar username
1.1 niallo 166: Uses
1.33 niallo 167: .Ar username
1.1 niallo 168: as the author field of the deposited revision.
1.17 xsa 169: .It Fl x Ns Ar suffixes
170: Specifies the suffixes for RCS files.
171: Suffixes should be separated by the
172: .Sq /
173: character.
1.35 sobrado 174: .It Fl z Ns Ar tz
175: Specify the date output format in keyword substitution, and the
176: default time zone for
177: .Ar date
178: used in the
179: .Fl d
180: option.
1.1 niallo 181: .El
182: .Sh ENVIRONMENT
183: .Bl -tag -width RCSINIT
184: .It Ev RCSINIT
185: If set, this variable should contain a list of space-delimited options that
186: are prepended to the argument list.
1.14 xsa 187: .It Ev TMPDIR
188: When set, this variable specifies the directory where temporary files
189: are to be created.
190: The default is set to
191: .Pa /tmp .
1.1 niallo 192: .El
1.36 ! jmc 193: .Sh EXIT STATUS
! 194: .Ex -std ci
1.1 niallo 195: .Sh SEE ALSO
196: .Xr co 1 ,
1.2 niallo 197: .Xr ident 1 ,
1.1 niallo 198: .Xr rcs 1 ,
199: .Xr rcsclean 1 ,
200: .Xr rcsdiff 1 ,
1.13 xsa 201: .Xr rcsmerge 1 ,
1.6 xsa 202: .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