Annotation of src/usr.bin/rcs/rlog.1, Revision 1.25
1.25 ! jcs 1: .\" $OpenBSD: rlog.1,v 1.24 2010/09/03 11:09:29 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.25 ! jcs 17: .Dd $Mdocdate: September 3 2010 $
1.1 xsa 18: .Dt RLOG 1
19: .Os
20: .Sh NAME
21: .Nm rlog
22: .Nd display information about RCS files
23: .Sh SYNOPSIS
24: .Nm
1.22 ray 25: .Op Fl bhLNRtV
1.7 xsa 26: .Op Fl d Ns Ar dates
1.25 ! jcs 27: .Op Fl E Ns Ar endsep
1.7 xsa 28: .Op Fl l Ns Op Ar lockers
1.11 xsa 29: .Op Fl r Ns Op Ar revs
1.25 ! jcs 30: .Op Fl S Ns Ar revsep
1.7 xsa 31: .Op Fl s Ns Ar states
32: .Op Fl w Ns Op Ar logins
1.6 xsa 33: .Op Fl x Ns Ar suffixes
1.9 xsa 34: .Op Fl z Ns Ar tz
1.16 jmc 35: .Ar
1.1 xsa 36: .Sh DESCRIPTION
37: The
38: .Nm
39: program displays information about RCS files.
1.16 jmc 40: .Pp
41: A file's complete RCS history can be displayed
42: (the default if no options are specified)
43: or a subset of its history log can be requested,
44: depending on which options are specified.
45: RCS keywords are displayed using the
46: .Xr ident 1
47: utility.
1.1 xsa 48: .Pp
49: The following options are supported:
50: .Bl -tag -width Ds
1.8 xsa 51: .It Fl b
52: Print information about revisions of the default branch only.
1.7 xsa 53: .It Fl d Ns Ar dates
54: Specify revisions with dates matching the specification.
55: The specification might be as follows:
56: .Bl -tag -width Ds
1.19 sobrado 57: .It date1<date2 or date2>date1
1.7 xsa 58: Select all revisions between
1.19 sobrado 59: .Ar date1
1.7 xsa 60: and
1.19 sobrado 61: .Ar date2 .
62: .It <date or date>
1.7 xsa 63: Select all revisions before
1.19 sobrado 64: .Ar date .
65: .It >date or date<
1.7 xsa 66: Select all revisions after
1.19 sobrado 67: .Ar date .
68: .It date
1.7 xsa 69: Select the latest revision before or equal to
1.19 sobrado 70: .Ar date .
1.7 xsa 71: .El
72: .Pp
73: The
74: .Sq \*(Gt
75: and
76: .Sq \*(Lt
77: characters can be followed by the
78: .Sq =
79: character to imply an inclusive specification.
80: Several specifications can be used by separating them with the
81: .Sq \&;
82: character.
1.14 jmc 83: .Pp
84: See also the
85: .Fl z
86: option, below.
1.25 ! jcs 87: .It Fl E Ns Ar endsep
! 88: Print
! 89: .Ar endsep
! 90: at the end of each RCS file, instead of the default string of
! 91: 77 equal signs.
1.1 xsa 92: .It Fl h
1.17 jmc 93: Print the RCS header,
94: describing a file's branch, lock details, symbolic names, etc.
1.4 xsa 95: .It Fl L
96: Ignore RCS files with no locks set.
1.7 xsa 97: .It Fl l Ns Op Ar lockers
98: Print information about locked revisions only.
99: If a comma-separated list of login names is specified,
100: ignore all locks other than those held in the list.
1.1 xsa 101: .It Fl N
102: Do not print symbolic names.
103: .It Fl R
104: Print name of RCS file only.
1.11 xsa 105: .It Fl r Ns Op Ar revs
106: Specify revision(s) to list:
107: .Bl -tag -width Ds
1.20 sobrado 108: .It rev1,rev2,...
1.11 xsa 109: A list of revisions is specified by separating names or numbers
110: of revisions by the
111: .Sq \&,
112: character.
1.20 sobrado 113: .It rev1:rev2
1.11 xsa 114: List all revisions between
1.20 sobrado 115: .Ar rev1
1.11 xsa 116: and
1.20 sobrado 117: .Ar rev2
1.11 xsa 118: (they must be on the same branch).
1.20 sobrado 119: .It :rev
1.11 xsa 120: List all revisions since the beginning of the branch until
1.20 sobrado 121: .Ar rev
1.11 xsa 122: included.
1.20 sobrado 123: .It rev:
1.11 xsa 124: List all revisions of the branch beginning with
1.20 sobrado 125: .Ar rev .
126: .It branch
1.11 xsa 127: List all revisions of a branch.
1.20 sobrado 128: .It branch.
1.11 xsa 129: List the latest revision of the branch
1.20 sobrado 130: .Ar branch .
131: .It branch1:branch2
1.11 xsa 132: List all revisions of branches between
1.20 sobrado 133: .Ar branch1
1.11 xsa 134: and
1.20 sobrado 135: .Ar branch2 .
1.11 xsa 136: .El
137: .Pp
138: Without argument, the
139: .Fl r
140: option means the latest revision of the default branch.
1.25 ! jcs 141: .It Fl S Ns Ar revsep
! 142: Print
! 143: .Ar revsep
! 144: at the end of each RCS revision, instead of the default string of
! 145: 28 dash signs.
1.7 xsa 146: .It Fl s Ns Ar states
147: Print information about revisions whose state matches one of the
148: specified
149: .Ar states .
150: Multiple states may be specified as a comma-separated list.
1.1 xsa 151: .It Fl t
152: Print header and description only.
153: .It Fl V
154: Print RCS's version number.
1.7 xsa 155: .It Fl w Ns Op Ar logins
156: Print information about revisions checked in by users specified
157: in a comma-separated list.
158: If
159: .Ar logins
160: is omitted, the user's login is assumed.
1.6 xsa 161: .It Fl x Ns Ar suffixes
162: Specifies the suffixes for RCS files.
163: Suffixes should be separated by the
164: .Sq /
165: character.
1.9 xsa 166: .It Fl z Ns Ar tz
1.14 jmc 167: Specify the date output format.
168: The
169: .Ar tz
170: argument should be a numeric UTC offset
1.15 jmc 171: (e.g. +02:45 would specify an offset of 2 hours 45 minutes).
1.14 jmc 172: .Sq LT
173: may instead be used to specify local time.
174: If no argument is given, a default format is used.
175: This option is also used to set the default time zone for
176: dates used in the
1.9 xsa 177: .Fl d
178: option.
1.1 xsa 179: .El
180: .Sh ENVIRONMENT
181: .Bl -tag -width RCSINIT
182: .It Ev RCSINIT
183: If set, this variable should contain a list of space-delimited options that
184: are prepended to the argument list.
185: .El
1.24 jmc 186: .Sh EXIT STATUS
187: .Ex -std rlog
1.5 xsa 188: .Sh EXAMPLES
189: Print complete information about files:
190: .Pp
191: .Dl $ rlog RCS/*
192: .Pp
193: Print the names of RCS files with locks set:
194: .Pp
195: .Dl $ rlog -L -R RCS/*
1.1 xsa 196: .Sh SEE ALSO
197: .Xr ci 1 ,
198: .Xr co 1 ,
199: .Xr ident 1 ,
200: .Xr rcs 1 ,
201: .Xr rcsclean 1 ,
1.2 xsa 202: .Xr rcsdiff 1 ,
203: .Xr rcsmerge 1
1.13 jmc 204: .Sh STANDARDS
1.23 ray 205: The flags
206: .Op Fl qT
207: have no effect and are provided
1.13 jmc 208: for compatibility only.