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