Annotation of src/usr.bin/rcs/co.1, Revision 1.29
1.29 ! jmc 1: .\" $OpenBSD: co.1,v 1.28 2007/05/31 19:20:14 jmc Exp $
1.1 xsa 2: .\"
3: .\" Copyright (c) 2005 Xavier Santolaria <xsa@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.
1.29 ! jmc 17: .Dd $Mdocdate: May 31 2007 $
1.1 xsa 18: .Dt CO 1
19: .Os
20: .Sh NAME
21: .Nm co
22: .Nd check out RCS revisions
23: .Sh SYNOPSIS
24: .Nm
25: .Bk -words
1.15 xsa 26: .Op Fl TV
1.7 niallo 27: .Op Fl d Ns Ar date
1.13 xsa 28: .Op Fl f Ns Op Ar rev
29: .Op Fl I Ns Op Ar rev
1.7 niallo 30: .Op Fl k Ns Ar mode
31: .Op Fl l Ns Op Ar rev
1.10 niallo 32: .Op Fl M Ns Op Ar rev
1.9 niallo 33: .Op Fl p Ns Op Ar rev
1.13 xsa 34: .Op Fl q Ns Op Ar rev
1.7 niallo 35: .Op Fl r Ns Op Ar rev
36: .Op Fl s Ns Ar state
37: .Op Fl u Ns Op Ar rev
1.17 xsa 38: .Op Fl w Ns Op Ar user
1.7 niallo 39: .Op Fl x Ns Ar suffixes
40: .Op Fl z Ns Ar tz
1.23 jmc 41: .Ar
1.1 xsa 42: .Ek
43: .Sh DESCRIPTION
1.21 jmc 44: The
1.1 xsa 45: .Nm
1.21 jmc 46: program is used to check out revisions from RCS files.
1.23 jmc 47: .Pp
48: When a file is checked out,
49: a copy is taken from the RCS repository,
50: minus its RCS information,
51: and placed in the current working directory.
52: Files may be checked out as the most recent revision
53: or according to a specific revision,
54: using the
55: .Fl r
56: option.
57: .Pp
58: Files are checked out in one of two possible modes:
59: unlocked (the default) or locked (using the
60: .Fl l
61: option).
62: In unlocked mode, any user may check out the file for reading.
63: If changes are to be made to a file though,
64: it will have to be locked using the
65: .Fl l
66: option.
67: During this time,
68: no other users may check out the file whilst it is locked.
1.25 jmc 69: .Pp
1.23 jmc 70: .Nm
71: also supports
72: keyword substitution \(en
73: see the
1.24 jmc 74: .Xr rcs 1
1.23 jmc 75: man page for more information.
1.1 xsa 76: .Pp
77: The following options are supported:
78: .Bl -tag -width Ds
1.7 niallo 79: .It Fl d Ns Ar date
1.1 xsa 80: Retrieve revision as of the latest revision no later than
81: .Ar date .
1.13 xsa 82: .It Fl f Ns Op Ar rev
1.1 xsa 83: Force the overwriting of the working file.
1.13 xsa 84: .It Fl I Ns Op Ar rev
1.1 xsa 85: Interactive mode.
1.7 niallo 86: .It Fl k Ns Ar mode
1.1 xsa 87: Specify the keyword substitution mode.
1.7 niallo 88: .It Fl l Ns Op Ar rev
1.1 xsa 89: The same as
90: .Fl r ,
1.2 jmc 91: but also locks the revision.
1.10 niallo 92: .It Fl M Ns Op Ar rev
1.2 jmc 93: Set the modification time of the file to the date of the
1.1 xsa 94: retrieved revision.
1.9 niallo 95: .It Fl p Ns Op Ar rev
96: Print the latest revision no later than
97: .Ar rev
98: to standard output.
1.14 jmc 99: .It Fl q Ns Op Ar rev
1.1 xsa 100: Be quiet about reporting.
1.7 niallo 101: .It Fl r Ns Op Ar rev
1.1 xsa 102: Retrieve the latest revision no later than
103: .Ar rev .
1.7 niallo 104: .It Fl s Ns Ar state
1.1 xsa 105: Retrieve revision of the specified
106: .Ar state
107: only.
1.19 xsa 108: .It Fl T
109: Preserve the modification time of RCS files.
1.7 niallo 110: .It Fl u Ns Op Ar rev
1.1 xsa 111: The same as
112: .Fl r ,
1.2 jmc 113: but also unlocks the retrieved revision if it was locked.
1.1 xsa 114: .It Fl V
115: Print RCS's version number.
1.17 xsa 116: .It Fl w Ns Op Ar user
1.1 xsa 117: Retrieve the latest revision which was checked in by the specified
118: .Ar user .
119: If the
120: .Ar user
1.2 jmc 121: argument is omitted, the login of the user issuing the command
1.1 xsa 122: is assumed.
1.7 niallo 123: .It Fl x Ns Ar suffixes
1.1 xsa 124: Specifies the suffixes for RCS files.
125: Suffixes should be separated by the
126: .Sq /
127: character.
1.7 niallo 128: .It Fl z Ns Ar tz
1.1 xsa 129: Specify the date output format in keyword substitution, and the
1.18 xsa 130: default time zone for
1.1 xsa 131: .Ar date
132: used in the
133: .Fl d
134: option.
135: .El
136: .Sh ENVIRONMENT
137: .Bl -tag -width RCSINIT
138: .It Ev RCSINIT
139: If set, this variable should contain a list of space-delimited options that
140: are prepended to the argument list.
141: .El
1.29 ! jmc 142: .Sh EXIT STATUS
! 143: .Ex -std co
1.11 xsa 144: .Sh EXAMPLES
145: Retrieve the latest revision of file
146: .Pa foo.c
147: and lock it for further editing:
148: .Pp
149: .Dl $ co -l foo.c
150: .Pp
151: Retrieve revision 1.5 of file
152: .Pa foo.c :
153: .Pp
154: .Dl $ co -r1.5 foo.c
1.1 xsa 155: .Sh SEE ALSO
156: .Xr ci 1 ,
1.4 jmc 157: .Xr ident 1 ,
1.1 xsa 158: .Xr rcs 1 ,
159: .Xr rcsclean 1 ,
160: .Xr rcsdiff 1 ,
1.8 xsa 161: .Xr rcsmerge 1 ,
1.6 xsa 162: .Xr rlog 1