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