home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / rcstxi11.zip / rcstexi.110 / rlog.tex < prev    next >
Text File  |  1997-03-30  |  18KB  |  483 lines

  1. @c
  2. @c ================================================================================
  3. @c                               Edition 1.1
  4. @c                      of the Texinfo-manuals for the
  5. @c                      (R)evision (C)ontrol (S)ystem
  6. @c                               Version 5.7
  7. @c
  8. @c                  (c) 1982, 1988, 1989 Walter F. Tichy.
  9. @c           (c) 1990, 1991, 1992, 1993, 1994, 1995 Paul Eggert.
  10. @c        (c) 1996, 1997 Karl Heinz Marbaise (doing converting job)
  11. @c ================================================================================
  12. @c
  13. @c Discription:
  14. @c    information about an RCS archive.
  15. @c
  16. @c Authors:
  17. @c    Walter Tichy,
  18. @c    Paul Eggert,
  19. @c    Karl Heinz Marbaise (doing converting job)
  20. @c
  21. @c e-mail:
  22. @c    Internet: KHMarbaise@p69.ks.fido.de
  23. @c    Fido-net: 2:2452/117.69
  24. @c
  25. @c Bugs, question:
  26. @c    to above e-mail adress.
  27. @c
  28. @c License:
  29. @c    The "Texinfo Edition of the RCS V5.7 manuals" are free
  30. @c    software; you can redistribute it and/or modify it under
  31. @c    the terms of the GNU General Public License as published
  32. @c    by the Free Software Foundation; either version 2, or (at
  33. @c    your option) any later version.
  34. @c
  35. @c    The "Texinfo Edition of the RCS V5.7 manuals" are distributed
  36. @c    in the hope that they will be useful, but WITHOUT ANY WARRANTY;
  37. @c    without even the implied warranty of MERCHANTABILITY or
  38. @c    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
  39. @c    License for more details.
  40. @c
  41. @c    You should have received a copy of the GNU General Public License
  42. @c    along with the "Texinfo Edition of the RCS V5.7 manuals"; see the
  43. @c    file COPYING. If not, write to the:
  44. @c    Free Software Foundation,
  45. @c    59 Temple Place - Suite 330,
  46. @c    Boston, MA 02111-1307, USA.
  47. @c
  48. @c    See \rcstxi.110\COPYING for details.
  49. @c
  50. @c ================================================================================
  51. @c
  52. @c
  53. @c $Id: RLOG.TEX 1.2 1997/03/30 22:53:21 KHM Exp $
  54. @c
  55. @c =============================================================================
  56. @c rlog -- print log messages and other information about RCS files
  57. @c -----------------------------------------------------------------------------
  58. @node rlog,merge,rcsmerge,Top
  59. @chapter rlog -- print log messages
  60. @cindex rlog
  61. @cindex log messages
  62. @cindex Information
  63. @menu
  64. * rlogIntro::        Introduction to @code{rlog}.
  65.  
  66. * rlogOptions::      command line options of @code{rlog}.
  67. * rlogExamples::     Examples.
  68. * rlogEnv::          The Environment which can change the
  69.                      behaviour of much of the RCS commands.
  70. * rlogDiag::         Diagnostic output of @code{rlog}.
  71. * rlogBugs::         Bugs.
  72.  
  73. @end menu
  74. @c =============================================================================
  75. @c rlog -- print log messages and other information about RCS files
  76. @c     Description
  77. @c -----------------------------------------------------------------------------
  78. @node rlogIntro, rlogOptions,,rlog
  79. @section Description
  80. @code{rlog} prints information about RCS files.
  81.  
  82. Pathnames matching an RCS suffix  denote  RCS  files;  all
  83. others   denote   working  files.   Names  are  paired  as
  84. explained in @ref{ciFiles}.
  85.  
  86. @code{rlog} prints the following information for each  RCS  file:
  87. RCS  pathname, working pathname, head (i.e., the number of
  88. the latest revision on the trunk), default branch,  access
  89. list, locks, symbolic names, suffix, total number of revisions,
  90. number of  revisions  selected  for  printing,  and
  91. descriptive  text.   This  is  followed by entries for the
  92. selected revisions in reverse chronological order for each
  93. branch.   For  each revision, rlog prints revision number,
  94. author, date/time, state, number  of  lines  added/deleted
  95. (with  respect  to  the  previous revision), locker of the
  96. revision (if any), and log message.  All  times  are  displayed
  97. in  Coordinated  Universal  Time (UTC) by default;
  98. this can be overridden with  @code{-z}.   Without  options,
  99. @code{rlog} prints  complete  information.
  100. The options below restrict this output.
  101.  
  102.  
  103. @c =============================================================================
  104. @c rlog -- print log messages and other information about RCS files
  105. @c     Options
  106. @c -----------------------------------------------------------------------------
  107. @node rlogOptions,rlogExamples,rlogIntro,rlog
  108. @section Command line options of rlog
  109. @cindex Command line options
  110. @ifinfo
  111. Overview off all options which can be given to @code{rlog}
  112.  
  113. @code{Synopsis}: rlog [options] file @dots{}
  114. @end ifinfo
  115. @menu
  116. * rlogOptLu::      -L Ignore RCS files.
  117. * rlogOptRu::      -R Only names of RCS files.
  118. * rlogOpth::       -h Only path names.
  119. * rlogOptt::       -t Path and discriptive text.
  120. * rlogOptN::       -N Do not print symbolic names..
  121. * rlogOptb::       -b Information about revisions on default branch.
  122. * rlogOptd::       -d Info about revisions with ci-date.
  123. * rlogOptl::       -l Print locked revisions only.
  124. * rlogOptr::       -r Informations about specified revisions.
  125. * rlogOpts::       -s Informations about revisions with state.
  126. * rlogOptw::       -w Informations about revisions with user.
  127. * rlogOptTu::      -T no effect.
  128. * rlogOptV::       -V Version; Emulation of RCS version.
  129. * rlogOptx::       -x Suffixes.
  130. * rlogOptz::       -z Time zone.
  131. @end menu
  132. @c =============================================================================
  133. @c rlog -- print log messages and other information about RCS files
  134. @c     Options
  135. @c         option -L
  136. @c -----------------------------------------------------------------------------
  137. @node rlogOptLu,rlogOptRu,,rlogOptions
  138. @subsection Ignore RCS files without locks
  139. @cindex -L
  140. @cindex no lock
  141. @cindex Ignore
  142. @table @code
  143. @item -L
  144.  
  145. Ignore RCS files that have no locks set.  This is convenient
  146. in combination with @code{-h}, @code{-l}, and @code{-R}.
  147. @end table
  148. @c =============================================================================
  149. @c rlog -- print log messages and other information about RCS files
  150. @c     Options
  151. @c         option -R
  152. @c -----------------------------------------------------------------------------
  153. @node rlogOptRu,rlogOpth,rlogOptLu,rlogOptions
  154. @subsection Only names of RCS files
  155. @cindex -R
  156. @cindex Names
  157. @table @code
  158. @item -R
  159.  
  160. Print  only  the name of the RCS file.  This is convenient
  161. for translating a working pathname into  an  RCS
  162. pathname.
  163. @end table
  164. @c =============================================================================
  165. @c rlog -- print log messages and other information about RCS files
  166. @c     Options
  167. @c         option -h
  168. @c -----------------------------------------------------------------------------
  169. @node rlogOpth,rlogOptt,rlogOptRu,rlogOptions
  170. @subsection Only pathname
  171. @cindex -h
  172. @cindex pathname
  173. @table @code
  174. @item -h
  175.  
  176. Print  only  the RCS pathname, working pathname, head,
  177. default branch, access list,  locks,  symbolic  names,
  178. and suffix.
  179. @end table
  180. @c =============================================================================
  181. @c rlog -- print log messages and other information about RCS files
  182. @c     Options
  183. @c         option -t
  184. @c -----------------------------------------------------------------------------
  185. @node rlogOptt,rlogOptN,rlogOpth,rlogOptions
  186. @subsection Descriptive text
  187. @cindex -t
  188. @cindex Descriptive text
  189. @table @code
  190. @item -t
  191.  
  192. Print the same as @code{-h}, plus the descriptive text.
  193. @end table
  194. @c =============================================================================
  195. @c rlog -- print log messages and other information about RCS files
  196. @c     Options
  197. @c         option -N
  198. @c -----------------------------------------------------------------------------
  199. @node rlogOptN,rlogOptb,rlogOptt,rlogOptions
  200. @subsection No symbolic name
  201. @cindex -N
  202. @cindex no Symbolic name
  203. @table @code
  204. @item -N
  205.  
  206. Do not print the symbolic names.
  207. @end table
  208. @c =============================================================================
  209. @c rlog -- print log messages and other information about RCS files
  210. @c     Options
  211. @c         option -b
  212. @c -----------------------------------------------------------------------------
  213. @node rlogOptb,rlogOptd,rlogOptN,rlogOptions
  214. @subsection Default branch
  215. @cindex -b
  216. @cindex Default branch
  217. @table @code
  218. @item -b
  219.  
  220. Print  information  about the revisions on the default
  221. branch, normally the highest branch on the trunk.
  222. @end table
  223. @c =============================================================================
  224. @c rlog -- print log messages and other information about RCS files
  225. @c     Options
  226. @c         option -d
  227. @c -----------------------------------------------------------------------------
  228. @node rlogOptd,rlogOptl,rlogOptb,rlogOptions
  229. @subsection Checkin date/time
  230. @cindex -d
  231. @cindex Checkin date/time
  232. @table @code
  233. @item -d@file{dates}
  234.  
  235. Print  information  about  revisions  with  a  checkin date/time
  236. in  the  ranges  given  by  the  semicolon-separated list of
  237. @file{dates}.  A range of the form @file{d1}<@file{d2} or
  238. @file{d2}>@file{d1} selects  the  revisions  that  were
  239. deposited between @file{d1} and @file{d2} exclusive.  A range of
  240. the  form <@file{d} or  @file{d}>  selects all revisions earlier
  241. than @file{d}. A range of the form @file{d}< or >@file{d} selects
  242. all revisions dated later than  @file{d}.   If  @code{<} or
  243. @code{>} is followed by @code{=} then the ranges are inclusive,
  244. not exclusive.  A range of the  form  @file{d} selects  the
  245. single,  latest revision dated @file{d} or earlier.  The date/time
  246. strings @file{d}, @file{d1}, and @file{d2} are in  the free
  247. format  explained in @ref{coOptd}. Quoting is normally necessary,
  248. especially for @code{<} and @code{>}. Note that the separator is
  249. a semicolon.
  250.  
  251. @end table
  252. @c =============================================================================
  253. @c rlog -- print log messages and other information about RCS files
  254. @c     Options
  255. @c         option -l
  256. @c -----------------------------------------------------------------------------
  257. @node rlogOptl,rlogOptr,rlogOptd,rlogOptions
  258. @subsection Locked revisions
  259. @cindex -l
  260. @cindex Locked revisions
  261. @table @code
  262. @item -l@file{lockers}
  263.  
  264. Print  information  about  locked  revisions only.  In
  265. addition, if the comma-separated list @file{lockers} of login
  266. names is given, ignore all locks other than those held
  267. by the @file{lockers}.  For  example,
  268.  
  269. @example
  270. rlog -L -R -lwft RCS/*
  271. @end example
  272.  
  273. prints the name of RCS files locked by the user @code{wft}.
  274.  
  275. @end table
  276. @c =============================================================================
  277. @c rlog -- print log messages and other information about RCS files
  278. @c     Options
  279. @c         option -r
  280. @c -----------------------------------------------------------------------------
  281. @node rlogOptr,rlogOpts,rlogOptl,rlogOptions
  282. @subsection Informations about revisions
  283. @cindex -r
  284. @cindex Information about Revisions
  285. @table @code
  286. @item -r@file{revisions}
  287.  
  288. prints information about revisions given in the commaseparated
  289. list @code{revisions} of revisions and  ranges. A range
  290. @code{@file{rev1}:@file{rev2}} means  revisions @file{rev1} to
  291. @file{rev2} on the same branch, @code{:@file{rev}} means
  292. revisions from  the  beginning of  the branch up to and including
  293. @file{rev} , and @code{@file{rev}:}  means revisions starting
  294. with @file{rev} to the end of  the  branch containing @file{rev}.
  295. An  argument that is a branch means all revisions on that branch.
  296. A  range  of  branches means  all revisions on the branches in
  297. that range.  A branch followed by a . means the  latest  revision
  298. in that  branch. A  bare @code{-r} with no @file{revisions} means
  299. the latest revision on the default  branch,  normally  the trunk.
  300.  
  301. @end table
  302. @c =============================================================================
  303. @c rlog -- print log messages and other information about RCS files
  304. @c     Options
  305. @c         option -s
  306. @c -----------------------------------------------------------------------------
  307. @node rlogOpts,rlogOptw,rlogOptr,rlogOptions
  308. @subsection Information about Rev. with given state
  309. @cindex -s
  310. @cindex Information Rev. given state
  311. @table @code
  312. @item -s@file{states}
  313.  
  314. prints   information   about   revisions  whose  state
  315. attributes match one of the states given in the commaseparated
  316. list @file{states}.
  317.  
  318. @end table
  319. @c =============================================================================
  320. @c rlog -- print log messages and other information about RCS files
  321. @c     Options
  322. @c         option -w
  323. @c -----------------------------------------------------------------------------
  324. @node rlogOptw,rlogOptTu,rlogOpts,rlogOptions
  325. @subsection Revisons checked in by user
  326. @cindex -w
  327. @cindex Checked in by user
  328. @table @code
  329. @item -w@file{logins}
  330.  
  331. prints information about revisions checked in by users
  332. with login names appearing in the comma-separated list
  333. @file{logins}.   If  @file{logins} is  omitted, the user's login is
  334. assumed.
  335. @end table
  336. @c =============================================================================
  337. @c rlog -- print log messages and other information about RCS files
  338. @c     Options
  339. @c         option -T
  340. @c -----------------------------------------------------------------------------
  341. @node rlogOptTu,rlogOptV,rlogOptw,rlogOptions
  342. @subsection Modification Time
  343. @cindex -T
  344. @cindex Modification time
  345. @table @code
  346. @item -T
  347.  
  348. This option has no effect; it is present for  compatibility
  349. with other RCS commands.
  350. @end table
  351. @c =============================================================================
  352. @c rlog -- print log messages and other information about RCS files
  353. @c     Options
  354. @c         option -V
  355. @c -----------------------------------------------------------------------------
  356. @node rlogOptV,rlogOptx,rlogOptTu,rlogOptions
  357. @subsection Version and Emulation
  358. @cindex -V
  359. @cindex Version
  360. @cindex Emulation
  361. @table @code
  362. @item -V
  363.  
  364. Print RCS's version number.
  365.  
  366.  
  367. @item -V@file{n}
  368.  
  369. Emulate RCS version @file{n} when generating logs.  See
  370. @ref{coOptV} for more.
  371. @end table
  372. @c =============================================================================
  373. @c rlog -- print log messages and other information about RCS files
  374. @c     Options
  375. @c         option -x
  376. @c -----------------------------------------------------------------------------
  377. @node rlogOptx,rlogOptz,rlogOptV,rlogOptions
  378. @subsection Suffixes
  379. @cindex -x
  380. @cindex Suffixes
  381. @table @code
  382. @item -x@file{suffixes}
  383.  
  384. Use @file{suffixes} to characterize RCS files.  See @ref{ciOptx} for
  385. details.
  386.  
  387. @end table
  388. @c =============================================================================
  389. @c rlog -- print log messages and other information about RCS files
  390. @c     Options
  391. @c         option -z
  392. @c -----------------------------------------------------------------------------
  393. @node rlogOptz,,rlogOptx,rlogOptions
  394. @subsection Time zone
  395. @cindex -z
  396. @cindex Time zone
  397. Rlog  prints  the  intersection  of the revisions selected
  398. with the options @code{-d}, @code{-l}, @code{-s}, and @code{-w},
  399. intersected with  the union of the revisions selected by
  400. @code{-b} and @code{-r}.
  401.  
  402. @table @code
  403. @item -z@file{zone}
  404. specifies the date output format, and specifies the
  405. default time zone for @file{date} in the  @code{-d@file{dates}} option.
  406. The  @file{zone} should be empty, a numeric UTC offset, or
  407. the special string @code{LT} for local time.  The  default
  408. is  an  empty  @file{zone} , which uses the traditional RCS
  409. format of UTC without any time zone indication  and
  410. with slashes separating the parts of the date; oth-
  411. erwise, times are output in ISO  8601  format  with
  412. time  zone  indication.  For example, if local time
  413. is January 11, 1990,  8pm  Pacific  Standard  Time,
  414. eight hours west of UTC, then the time is output as
  415. follows:
  416.  
  417. @example
  418. @group
  419. option    time output
  420. -z        1990/01/12 04:00:00       (default)
  421. -zLT      1990-01-11 20:00:00-08
  422. -z+05:30  1990-01-12 09:30:00+05:30
  423. @end group
  424. @end example
  425.  
  426. @end table
  427. @c =============================================================================
  428. @c rlog -- print log messages and other information about RCS files
  429. @c     Examples
  430. @c -----------------------------------------------------------------------------
  431. @node rlogExamples,rlogEnv,rlogOptions,rlog
  432. @subsection Examples
  433. @cindex Examples
  434. @example
  435. @group
  436. rlog  -L  -R  RCS/*
  437. rlog  -L  -h  RCS/*
  438. rlog  -L  -l  RCS/*
  439. rlog  RCS/*
  440. @end group
  441. @end example
  442.  
  443. The first command prints the names of all RCS files in the
  444. subdirectory  RCS  that  have  locks.   The second command
  445. prints the headers of those files, and  the  third  prints
  446. the headers plus the log messages of the locked revisions.
  447. The last command prints complete information.
  448.  
  449. @c =============================================================================
  450. @c rlog -- print log messages and other information about RCS files
  451. @c     Environment
  452. @c -----------------------------------------------------------------------------
  453. @node rlogEnv,rlogDiag,rlogExamples,rlog
  454. @subsection Environment
  455. @cindex Environment
  456. @table @code
  457. @item RCSINIT
  458.  
  459. options prepended to the argument  list,  separated
  460. by spaces.  See @ref{ciEnv} for details.
  461. @end table
  462. @c =============================================================================
  463. @c rlog -- print log messages and other information about RCS files
  464. @c     Diagnostics
  465. @c -----------------------------------------------------------------------------
  466. @node rlogDiag,rlogBugs,rlogEnv,rlog
  467. @section Diagnostics
  468. The exit status is zero if and only if all operations were
  469. successful.
  470. @c =============================================================================
  471. @c rlog -- print log messages and other information about RCS files
  472. @c     Bugs
  473. @c -----------------------------------------------------------------------------
  474. @node rlogBugs,,rlogDiag,rlog
  475. @section Bugs
  476. @cindex Bugs
  477. The separator for revision ranges in the @code{-r} option used to
  478. be  @code{-}  instead of @code{:}, but this leads to confusion when symbolic
  479. names contain @code{-}.  For backwards  compatibility
  480. @code{rlog -r}  still supports the old @code{-} separator, but it warns about
  481. this obsolete use.
  482.  
  483.