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