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