Annotation of src/usr.bin/rcs/ci.1, Revision 1.22
1.22 ! niallo 1: .\" $OpenBSD: ci.1,v 1.21 2005/12/12 09:38:22 xsa 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.1 niallo 44: .Ar file ...
45: .Ek
46: .Sh DESCRIPTION
47: The
48: .Nm
49: program is used to check new revisions into RCS files.
50: .Pp
51: The following options are supported:
52: .Bl -tag -width Ds
1.9 niallo 53: .It Fl d Ns Op Ar date
1.1 niallo 54: Uses
55: .Ar date
56: for check-in date and time.
1.7 niallo 57: If
58: .Ar date
59: is not specified, use the working file's last modification time.
1.9 niallo 60: .It Fl f Ns Op Ar rev
1.8 niallo 61: Force check in - optionally to
62: .Ar rev
63: - even if no changes have been made to the working file.
1.1 niallo 64: .It Fl I
65: Interactive mode.
1.18 niallo 66: .It Fl i Ns Op Ar rev
67: Only do initial check-in.
1.19 jmc 68: Print error and refuse to do check-in if the RCS file already exists.
1.18 niallo 69: .It Fl j Ns Op Ar rev
70: Only do update check-in.
1.19 jmc 71: Print error and refuse to do check-in if the RCS file does not already exist.
1.22 ! niallo 72: .It Fl k Ns Op Ar rev
! 73: Search the working file for keywords and set the revision number,
! 74: creation date, state and author to the values found in these keywords
! 75: instead of computing them.
1.9 niallo 76: .It Fl l Ns Op Ar rev
1.1 niallo 77: The same as
78: .Fl r ,
1.3 jmc 79: but also immediately checks out the deposited revision and locks it.
80: This is useful if you wish to continue to edit the working file after check-in.
1.16 niallo 81: .It Fl M Ns Op Ar rev
1.1 niallo 82: Set the modification time of the file to the date of the
83: retrieved revision.
1.9 niallo 84: .It Fl m Ns Ar msg
1.1 niallo 85: Specify a log message.
86: A line beginning with a hash character
87: .Pq Sq #
88: is considered a comment and ignored.
1.12 jmc 89: .It Fl N Ns Ar symbol
90: The same as
91: .Fl n
92: except it overwrites any previous assignment of
93: .Ar symbol .
1.10 niallo 94: .It Fl n Ns Ar symbol
95: Assign the symbolic name
96: .Ar symbol
97: to the checked in revision.
1.1 niallo 98: .It Fl q
99: Be quiet about reporting.
1.9 niallo 100: .It Fl r Ns Op Ar rev
1.1 niallo 101: Check in revision
102: .Ar rev .
1.4 niallo 103: However, if
104: .Ar rev
105: is not specified the meaning is completely different \- override any
106: .Fl l
107: or
1.5 niallo 108: .Fl u Op Ar rev
1.4 niallo 109: options, ensuring the default behaviour of releasing a lock and removing the
110: working file.
1.9 niallo 111: .It Fl s Ns Ar state
1.1 niallo 112: Sets the state of the deposited revision to the identifier
113: .Ar state .
1.15 niallo 114: The specified value may not contain a space character.
1.21 xsa 115: .Sm off
116: .It Fl t Ar file \*(Ba Ar str
117: .Sm on
118: Change the descriptive text.
119: The descriptive text is taken from the
1.20 niallo 120: .Ar file
1.21 xsa 121: specified as argument or from the string
122: .Ar str
123: given as argument if it is preceded by the
124: .Sq -
125: character.
126: If no argument is used, the descriptive text is taken from standard input
127: terminated by end-of-file or by a line containing the
128: .Sq \&.
129: character by itself.
1.1 niallo 130: .It Fl u
131: The same as
132: .Fl r ,
1.3 jmc 133: but also immediately checks out the deposited revision read-only.
134: Useful if you wish to read the working file after check-in.
1.1 niallo 135: .It Fl V
136: Print RCS's version number.
1.9 niallo 137: .It Fl w Ns Ar user
1.1 niallo 138: Uses
139: .Ar user
140: as the author field of the deposited revision.
1.17 xsa 141: .It Fl x Ns Ar suffixes
142: Specifies the suffixes for RCS files.
143: Suffixes should be separated by the
144: .Sq /
145: character.
1.1 niallo 146: .El
147: .Sh ENVIRONMENT
148: .Bl -tag -width RCSINIT
149: .It Ev RCSINIT
150: If set, this variable should contain a list of space-delimited options that
151: are prepended to the argument list.
1.14 xsa 152: .It Ev TMPDIR
153: When set, this variable specifies the directory where temporary files
154: are to be created.
155: The default is set to
156: .Pa /tmp .
1.1 niallo 157: .El
158: .Sh SEE ALSO
159: .Xr co 1 ,
1.2 niallo 160: .Xr ident 1 ,
1.1 niallo 161: .Xr rcs 1 ,
162: .Xr rcsclean 1 ,
163: .Xr rcsdiff 1 ,
1.13 xsa 164: .Xr rcsmerge 1 ,
1.6 xsa 165: .Xr rlog 1