• merge latest version of rannotate code from corecode
[alioth/cvs.git] / contrib / rcs2log.1
1 .\"
2 .\" Copyright 1992, 93, 94, 95, 96, 97, 1998 Free Software Foundation, Inc.
3 .\"
4 .\" This program is free software; you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation; either version 2, or (at your option)
7 .\" any later version.
8 .\"
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 .\" GNU General Public License for more details.
13 .\"
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program; see the file COPYING.  If not, write to the
16 .\" Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 .\" Boston, MA 02111-1307, USA.
18 .\"
19 .Dd February 15, 2003
20 .Dt RCS2LOG 1
21 .Os
22 .Sh NAME
23 .Nm rcs2log
24 .Nd RCS to ChangeLog generator
25 .Sh SYNOPSIS
26 .Nm rcs2log
27 .Bk -words
28 .Op Fl nRv
29 .Op Fl c Ar changelog
30 .Op Fl h Ar hostname
31 .Op Fl i Ar indent
32 .Op Fl l Ar length
33 .Op Fl L Ar file
34 .Op Fl r Ar option
35 .Op Fl t Ar tabwidth
36 .Op Fl u Ar login<TAB>fullname<TAB>mailaddr
37 .Op Fl \-help
38 .Op Fl \-version
39 .Op Ar file ...
40 .Ek
41 .Sh DESCRIPTION
42 The
43 .Nm
44 utility generates a change log prefix from RCS files (perhaps in the CVS
45 repository) and the ChangeLog (if any).
46 .Pp
47 The options are as follows:
48 .Bl -tag -width Ds
49 .It Fl c Ar changelog
50 Output a change log prefix to
51 .Ar changelog
52 (default ChangeLog).
53 .It Fl h Ar hostname
54 Use
55 .Ar hostname
56 in change log entries (default current host).
57 .It Fl i Ar indent
58 Indent change log lines by
59 .Ar indent
60 spaces (default 8).
61 .It Fl l Ar length
62 Try to limit log lines to
63 .Ar length
64 characters (default 79).
65 .It Fl L Ar file
66 Use rlog-format
67 .Ar file
68 for source of logs.
69 .It Fl n
70 Obsolete, use
71 .Fl u
72 instead (whose syntax differs).
73 .It Fl R
74 If no
75 .Ar file Ns Li (s)
76 are given and RCS is used, recurse through working directory.
77 .It Fl r Ar option
78 Pass
79 .Ar option
80 to subsidiary log command.
81 .It Fl t Ar tabwidth
82 Tab stops are every
83 .Ar tabwidth
84 characters (default 8).
85 .It Fl u Ar "login<TAB>fullname<TAB>mailaddr"
86 Assume
87 .Ar login
88 has
89 .Ar fullname
90 and
91 .Ar mailaddr .
92 .It Fl v
93 Append RCS revision to file names in log lines.
94 .It Fl \-help
95 Output help.
96 .It Fl \-version
97 Output version number.
98 .El
99 .Sh SEE ALSO
100 .Xr rcs 1 ,
101 .Xr rcsintro 1 ,
102 .Xr rlog 1 ,
103 .Xr rcsfile 5
104 .Sh AUTHORS
105 Paul Eggert <eggert@twinsun.com>
106 .Sh BUGS
107 Report bugs to <bug-gnu-emacs@gnu.org>.