Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / gnu / usr.bin / rcs / rlog / rlog.1
1 .de Id
2 .ds Rv \\$3
3 .ds Dt \\$4
4 ..
5 .Id $FreeBSD: src/gnu/usr.bin/rcs/rlog/rlog.1,v 1.8 1999/08/27 23:36:59 peter Exp $
6 .Id $DragonFly: src/gnu/usr.bin/rcs/rlog/rlog.1,v 1.2 2003/06/17 04:25:48 dillon Exp $
7 .ds i \&\s-1ISO\s0
8 .ds r \&\s-1RCS\s0
9 .ds u \&\s-1UTC\s0
10 .if n .ds - \%--
11 .if t .ds - \(em
12 .TH RLOG 1 \*(Dt GNU
13 .SH NAME
14 rlog \- print log messages and other information about RCS files
15 .SH SYNOPSIS
16 .B rlog
17 .RI [ " options " ] " file " .\|.\|.
18 .SH DESCRIPTION
19 .B rlog
20 prints information about \*r files.
21 .PP
22 Pathnames matching an \*r suffix denote \*r files;
23 all others denote working files.
24 Names are paired as explained in
25 .BR ci (1).
26 .PP
27 .B rlog
28 prints the following information for each
29 \*r file: \*r pathname, working pathname, head (i.e., the number
30 of the latest revision on the trunk), default branch, access list, locks,
31 symbolic names, suffix, total number of revisions,
32 number of revisions selected for printing, and
33 descriptive text.  This is followed by entries for the selected revisions in
34 reverse chronological order for each branch.  For each revision,
35 .B rlog
36 prints revision number, author, date/time, state, number of
37 lines added/deleted (with respect to the previous revision),
38 locker of the revision (if any), and log message.
39 All times are displayed in Coordinated Universal Time (\*u) by default;
40 this can be overridden with
41 .BR \-z .
42 Without options,
43 .B rlog
44 prints complete information.
45 The options below restrict this output.
46 .nr n \w'\f3\-V\fP\f2n\fP'+2n-1/1n
47 .ds n \nn
48 .if \n(.g .if r an-tag-sep .ds n \w'\f3\-V\fP\f2n\fP'u+\n[an-tag-sep]u
49 .TP \*n
50 .B \-L
51 Ignore \*r files that have no locks set.
52 This is convenient in combination with
53 .BR \-h ,
54 .BR \-l ,
55 and
56 .BR \-R .
57 .TP
58 .B \-R
59 Print only the name of the \*r file.
60 This is convenient for translating a
61 working pathname into an \*r pathname.
62 .TP
63 .BI \-v "[string]"
64 Print only the working pathname and tip-revision.
65 The optional string is prepended to the outputline.
66 .TP
67 .B \-h
68 Print only the \*r pathname, working pathname, head,
69 default branch, access list, locks,
70 symbolic names, and suffix.
71 .TP
72 .B \-t
73 Print the same as
74 .BR \-h ,
75 plus the descriptive text.
76 .TP
77 .B \-N
78 Do not print the symbolic names.
79 .TP
80 .B \-b
81 Print information about the revisions on the default branch, normally
82 the highest branch on the trunk.
83 .TP
84 .BI \-d "dates"
85 Print information about revisions with a checkin date/time in the ranges given by
86 the semicolon-separated list of
87 .IR dates .
88 A range of the form
89 .IB d1 < d2
90 or
91 .IB d2 > d1
92 selects the revisions that were deposited between
93 .I d1
94 and
95 .I d2
96 exclusive.
97 A range of the form
98 .BI < d
99 or
100 .IB d >
101 selects
102 all revisions earlier than
103 .IR d .
104 A range of the form
105 .IB d <
106 or
107 .BI > d
108 selects
109 all revisions dated later than
110 .IR d .
111 If
112 .B <
113 or
114 .B >
115 is followed by
116 .B =
117 then the ranges are inclusive, not exclusive.
118 A range of the form
119 .I d
120 selects the single, latest revision dated
121 .I d
122 or earlier.
123 The date/time strings
124 .IR d ,
125 .IR d1 ,
126 and
127 .I d2
128 are in the free format explained in
129 .BR co (1).
130 Quoting is normally necessary, especially for
131 .B <
132 and
133 .BR > .
134 Note that the separator is
135 a semicolon.
136 .TP
137 .BR \-l [\f2lockers\fP]
138 Print information about locked revisions only.
139 In addition, if the comma-separated list
140 .I lockers
141 of login names is given,
142 ignore all locks other than those held by the
143 .IR lockers .
144 For example,
145 .B "rlog\ \-L\ \-R\ \-lwft\ RCS/*"
146 prints the name of \*r files locked by the user
147 .BR wft .
148 .TP
149 .BR \-r [\f2revisions\fP]
150 prints information about revisions given in the comma-separated list
151 .I revisions
152 of revisions and ranges.
153 A range
154 .IB rev1 : rev2
155 means revisions
156 .I rev1
157 to
158 .I rev2
159 on the same branch,
160 .BI : rev
161 means revisions from the beginning of the branch up to and including
162 .IR rev ,
163 and
164 .IB rev :
165 means revisions starting with
166 .I rev
167 to the end of the branch containing
168 .IR rev .
169 An argument that is a branch means all
170 revisions on that branch.
171 A range of branches means all revisions
172 on the branches in that range.
173 A branch followed by a
174 .B .\&
175 means the latest revision in that branch.
176 A bare
177 .B \-r
178 with no
179 .I revisions
180 means the latest revision on the default branch, normally the trunk.
181 .TP
182 .BI \-s states
183 prints information about revisions whose state attributes match one of the
184 states given in the comma-separated list
185 .IR states .
186 .TP
187 .BR \-w [\f2logins\fP]
188 prints information about revisions checked in by users with
189 login names appearing in the comma-separated list
190 .IR logins .
191 If
192 .I logins
193 is omitted, the user's login is assumed.
194 .TP
195 .B \-T
196 This option has no effect;
197 it is present for compatibility with other \*r commands.
198 .TP
199 .BI \-V
200 Print \*r's version number.
201 .TP
202 .BI \-V n
203 Emulate \*r version
204 .I n
205 when generating logs.
206 See
207 .BR co (1)
208 for more.
209 .TP
210 .BI \-x "suffixes"
211 Use
212 .I suffixes
213 to characterize \*r files.
214 See
215 .BR ci (1)
216 for details.
217 .PP
218 .B rlog
219 prints the intersection of the revisions selected with
220 the options
221 .BR \-d ,
222 .BR \-l ,
223 .BR \-s ,
224 and
225 .BR \-w ,
226 intersected
227 with the union of the revisions selected by
228 .B \-b
229 and
230 .BR \-r .
231 .TP
232 .BI \-z zone
233 specifies the date output format,
234 and specifies the default time zone for
235 .I date
236 in the
237 .BI \-d dates
238 option.
239 The
240 .I zone
241 should be empty, a numeric \*u offset, or the special string
242 .B LT
243 for local time.
244 The default is an empty
245 .IR zone ,
246 which uses the traditional \*r format of \*u without any time zone indication
247 and with slashes separating the parts of the date;
248 otherwise, times are output in \*i 8601 format with time zone indication.
249 For example, if local time is January 11, 1990, 8pm Pacific Standard Time,
250 eight hours west of \*u,
251 then the time is output as follows:
252 .RS
253 .LP
254 .RS
255 .nf
256 .ta \w'\f3\-z+05:30\fP  'u +\w'\f31990-01-11 09:30:00+05:30\fP  'u
257 .ne 4
258 \f2option\fP    \f2time output\fP
259 \f3\-z\fP       \f31990/01/12 04:00:00\fP       \f2(default)\fP
260 \f3\-zLT\fP     \f31990-01-11 20:00:00\-08\fP
261 \f3\-z+05:30\fP \f31990-01-12 09:30:00+05:30\fP
262 .ta 4n +4n +4n +4n
263 .fi
264 .RE
265 .SH EXAMPLES
266 .LP
267 .nf
268 .B "    rlog  \-L  \-R  RCS/*"
269 .B "    rlog  \-L  \-h  RCS/*"
270 .B "    rlog  \-L  \-l  RCS/*"
271 .B "    rlog  RCS/*"
272 .fi
273 .LP
274 The first command prints the names of all \*r files in the subdirectory
275 .B RCS
276 that have locks.  The second command prints the headers of those files,
277 and the third prints the headers plus the log messages of the locked revisions.
278 The last command prints complete information.
279 .SH ENVIRONMENT
280 .TP
281 .B \s-1RCSINIT\s0
282 options prepended to the argument list, separated by spaces.
283 See
284 .BR ci (1)
285 for details.
286 .SH DIAGNOSTICS
287 The exit status is zero if and only if all operations were successful.
288 .SH IDENTIFICATION
289 Author: Walter F. Tichy.
290 .br
291 Manual Page Revision: \*(Rv; Release Date: \*(Dt.
292 .br
293 Copyright \(co 1982, 1988, 1989 Walter F. Tichy.
294 .br
295 Copyright \(co 1990, 1991, 1992, 1993, 1994, 1995 Paul Eggert.
296 .SH "SEE ALSO"
297 ci(1), co(1), ident(1), rcs(1), rcsdiff(1), rcsintro(1), rcsmerge(1),
298 rcsfile(5)
299 .br
300 Walter F. Tichy,
301 \*r\*-A System for Version Control,
302 .I "Software\*-Practice & Experience"
303 .BR 15 ,
304 7 (July 1985), 637-654.
305 .SH BUGS
306 The separator for revision ranges in the
307 .B \-r
308 option used to be
309 .B \-
310 instead of
311 .BR : ,
312 but this leads to confusion when symbolic names contain
313 .BR \- .
314 For backwards compatibility
315 .B "rlog \-r"
316 still supports the old
317 .B \-
318 separator, but it warns about this obsolete use.
319 .br