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