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