Debian Codegraph @

upstream/debian-unstable/man1/rlog.1

raw
1 .ds Rv 5.10.1
2 .ds Dt 2025-12-02
3 .ds i \&\s-1ISO\s0
4 .ds r \&\s-1RCS\s0
5 .ds u \&\s-1UTC\s0
6 .ds o \*r file
7 .if n .ds - \%--
8 .if t .ds - \(em
9 .TH RLOG 1 "\*(Dt" "GNU RCS \*(Rv"
10 .SH NAME
11 rlog \- print log messages and other information about \*os
12 .SH SYNOPSIS
13 .B rlog
14 .RI [ " options " ] " file " .\|.\|.
15 .SH DESCRIPTION
16 .B rlog
17 prints information about \*os.
18 .PP
19 Filenames matching an \*r suffix denote \*os;
20 all others denote working files.
21 Names are paired as explained in
22 .BR ci (1).
23 .PP
24 .B rlog
25 prints the following information for each
26 \*o: \*o name, working file name, head (i.e., the number
27 of the latest revision on the trunk), default branch, access list, locks,
28 symbolic names, suffix, total number of revisions,
29 number of revisions selected for printing, and
30 descriptive text. This is followed by entries for the selected revisions in
31 reverse chronological order for each branch. For each revision,
32 .B rlog
33 prints revision number, author, date/time, state, number of
34 lines added/deleted (with respect to the previous revision),
35 locker of the revision (if any), and log message.
36 All times are displayed in Coordinated Universal Time (\*u) by default;
37 this can be overridden with
38 .BR \-z .
39 Without options,
40 .B rlog
41 prints complete information.
42 The options below restrict this output.
43 .nr n \w'\f3\-V\fP\f2n\fP'+2n-1/1n
44 .ds n \nn
45 .if \n(.g .if r an-tag-sep .ds n \w'\f3\-V\fP\f2n\fP'u+\n[an-tag-sep]u
46 .TP \*n
47 .B \-L
48 Ignore \*os that have no locks set.
49 This is convenient in combination with
50 .BR \-h ,
51 .BR \-l ,
52 and
53 .BR \-R .
54 .TP
55 .B \-R
56 Print only the name of the \*o.
57 This is convenient for translating a
58 working file name into an \*o name.
59 .TP
60 .B \-h
61 Print only the \*o name, working file name, head,
62 default branch, access list, locks,
63 symbolic names, and suffix.
64 .TP
65 .B \-t
66 Print the same as
67 .BR \-h ,
68 plus the descriptive text.
69 .TP
70 .B \-N
71 Do not print the symbolic names.
72 .TP
73 .B \-b
74 Print information about the revisions on the default branch, normally
75 the highest branch on the trunk.
76 .TP
77 .BI \-d "dates"
78 Print information about revisions with a checkin date/time in the ranges given by
79 the semicolon-separated list of
80 .IR dates .
81 A range of the form
82 .IB d1 < d2
83 or
84 .IB d2 > d1
85 selects the revisions that were deposited between
86 .I d1
87 and
88 .I d2
89 exclusive.
90 A range of the form
91 .BI < d
92 or
93 .IB d >
94 selects
95 all revisions earlier than
96 .IR d .
97 A range of the form
98 .IB d <
99 or
100 .BI > d
101 selects
102 all revisions dated later than
103 .IR d .
104 If
105 .B <
106 or
107 .B >
108 is followed by
109 .B =
110 then the ranges are inclusive, not exclusive.
111 A range of the form
112 .I d
113 selects the single, latest revision dated
114 .I d
115 or earlier.
116 The date/time strings
117 .IR d ,
118 .IR d1 ,
119 and
120 .I d2
121 are in the free format explained in
122 .BR co (1).
123 Quoting is normally necessary, especially for
124 .B <
125 and
126 .BR > .
127 Note that the separator is
128 a semicolon.
129 .TP
130 .BR \-l [\f2lockers\fP]
131 Print information about locked revisions only.
132 In addition, if the comma-separated list
133 .I lockers
134 of login names is given,
135 ignore all locks other than those held by the
136 .IR lockers .
137 For example,
138 .B "rlog\ \-L\ \-R\ \-lwft\ RCS/*"
139 prints the name of \*os locked by the user
140 .BR wft .
141 .TP
142 .BR \-r [\f2revisions\fP]
143 prints information about revisions given in the comma-separated list
144 .I revisions
145 of revisions and ranges.
146 A range
147 .IB rev1 : rev2
148 means revisions
149 .I rev1
150 to
151 .I rev2
152 on the same branch,
153 .BI : rev
154 means revisions from the beginning of the branch up to and including
155 .IR rev ,
156 and
157 .IB rev :
158 means revisions starting with
159 .I rev
160 to the end of the branch containing
161 .IR rev .
162 An argument that is a branch means all
163 revisions on that branch.
164 A range of branches means all revisions
165 on the branches in that range.
166 A branch followed by a
167 .B .\&
168 means the latest revision in that branch.
169 A bare
170 .B \-r
171 with no
172 .I revisions
173 means the latest revision on the default branch, normally the trunk.
174 .TP
175 .BI \-s states
176 prints information about revisions whose state attributes match one of the
177 states given in the comma-separated list
178 .IR states .
179 .TP
180 .BR \-w [\f2logins\fP]
181 prints information about revisions checked in by users with
182 login names appearing in the comma-separated list
183 .IR logins .
184 If
185 .I logins
186 is omitted, the user's login is assumed.
187 .TP
188 .B \-q
189 This option has no effect;
190 it is provided for consistency with other commands.
191 .TP
192 .B \-T
193 This option has no effect;
194 it is present for compatibility with other \*r commands.
195 .TP
196 .BI \-V
197 Print \*r's version number.
198 .TP
199 .BI \-V n
200 Emulate \*r version
201 .I n
202 when generating logs.
203 See
204 .BR co (1)
205 for more.
206 .TP
207 .BI \-x "suffixes"
208 Use
209 .I suffixes
210 to characterize \*os.
211 See
212 .BR ci (1)
213 for details.
214 .PP
215 .B rlog
216 prints the intersection of the revisions selected with
217 the options
218 .BR \-d ,
219 .BR \-l ,
220 .BR \-s ,
221 and
222 .BR \-w ,
223 intersected
224 with the union of the revisions selected by
225 .B \-b
226 and
227 .BR \-r .
228 .TP
229 .BI \-z zone
230 specifies the date output format,
231 and specifies the default time zone for
232 .I date
233 in the
234 .BI \-d dates
235 option.
236 The
237 .I zone
238 should be empty, a numeric \*u offset, or the special string
239 .B LT
240 for local time.
241 The default is an empty
242 .IR zone ,
243 which uses the traditional \*r format of \*u without any time zone indication
244 and with slashes separating the parts of the date;
245 otherwise, times are output in \*i 8601 format with time zone indication.
246 For example, if local time is January 11, 1990, 8pm Pacific Standard Time,
247 eight hours west of \*u,
248 then the time is output as follows:
249 .RS
250 .LP
251 .RS
252 .nf
253 .ta \w'\f3\-z+05:30\fP 'u +\w'\f31990-01-11 09:30:00+05:30\fP 'u
254 .ne 4
255 \f2option\fP \f2time output\fP
256 \f3\-z\fP \f31990/01/12 04:00:00\fP \f2(default)\fP
257 \f3\-zLT\fP \f31990-01-11 20:00:00\-08\fP
258 \f3\-z+05:30\fP \f31990-01-12 09:30:00+05:30\fP
259 .ta 4n +4n +4n +4n
260 .fi
261 .RE
262 .SH EXAMPLES
263 .LP
264 .nf
265 .B " rlog \-L \-R RCS/*"
266 .B " rlog \-L \-h RCS/*"
267 .B " rlog \-L \-l RCS/*"
268 .B " rlog RCS/*"
269 .fi
270 .LP
271 The first command prints the names of all \*os in the subdirectory
272 .B RCS
273 that have locks. The second command prints the headers of those files,
274 and the third prints the headers plus the log messages of the locked revisions.
275 The last command prints complete information.
276 .SH ENVIRONMENT
277 .TP
278 .B \s-1RCSINIT\s0
279 Options prepended to the argument list, separated by spaces.
280 A backslash escapes spaces within an option.
281 The
282 .B \s-1RCSINIT\s0
283 options are prepended to the argument lists of most \*r commands.
284 Useful
285 .B \s-1RCSINIT\s0
286 options include
287 .BR \-q ,
288 .BR \-V ,
289 .BR \-x ,
290 and
291 .BR \-z .
292 .TP
293 .B \s-1RCS_MEM_LIMIT\s0
294 Normally, for speed, commands either memory map or copy into memory
295 the \*o if its size is less than the
296 .IR memory-limit ,
297 currently defaulting to ``unlimited''.
298 Otherwise (or if the initially-tried speedy ways fail),
299 the commands fall back to using
300 standard i/o routines.
301 You can adjust the memory limit by setting
302 .B \s-1RCS_MEM_LIMIT\s0
303 to a numeric value
304 .IR lim
305 (measured in kilobytes).
306 An empty value is silently ignored.
307 As a side effect, specifying
308 .B \s-1RCS_MEM_LIMIT\s0
309 inhibits fall-back to slower routines.
310 .TP
311 .B \s-1TMPDIR\s0
312 Name of the temporary directory.
313 If not set, the environment variables
314 .B \s-1TMP\s0
315 and
316 .B \s-1TEMP\s0
317 are inspected instead and the first value found is taken;
318 if none of them are set,
319 a host-dependent default is used, typically
320 .BR /tmp .
321 .SH DIAGNOSTICS
322 The exit status is zero if and only if all operations were successful.
323 .ds EY 1990, 1991, 1992, 1993, 1994, 1995
324 .SH IDENTIFICATION
325 Author: Walter F. Tichy.
326 .br
327 Manual Page Revision: \*(Rv; Release Date: \*(Dt.
328 .br
329 Copyright \(co 2010-2022 Thien-Thi Nguyen.
330 .br
331 Copyright \(co \*(EY Paul Eggert.
332 .br
333 Copyright \(co 1982, 1988, 1989 Walter F. Tichy.
334 .br
335 .SH "SEE ALSO"
336 .BR ci (1),
337 .BR co (1),
338 .BR ident (1),
339 .BR rcs (1),
340 .BR rcsdiff (1),
341 .BR rcsmerge (1),
342 .BR rcsfile (5).
343 .PP
344 Walter F. Tichy,
345 \*r\*-A System for Version Control,
346 .I "Software\*-Practice & Experience"
347 .BR 15 ,
348 7 (July 1985), 637-654.
349 .PP
350 The full documentation for \*r is maintained as a Texinfo manual.
351 If the
352 .BR info (1)
353 and \*r programs are properly installed at your site, the command
354 .IP
355 .B info rcs
356 .PP
357 should give you access to the complete manual.
358 Additionally, the \*r homepage:
359 .IP
360 .B http://www.gnu.org/software/rcs/
361 .PP
362 has news and links to the latest release, development site, etc.
363 .SH BUGS
364 The separator for revision ranges in the
365 .B \-r
366 option used to be
367 .B \-
368 instead of
369 .BR : ,
370 but this leads to confusion when symbolic names contain
371 .BR \- .
372 For backwards compatibility
373 .B "rlog \-r"
374 still supports the old
375 .B \-
376 separator, but it warns about this obsolete use.
377 .br