gnu/usr.bin/rcs/rlog/rlog.1

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