File: cvs2html.1

package info (click to toggle)
cvs2html 1.96-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, sarge
  • size: 84 kB
  • ctags: 28
  • sloc: perl: 1,249; makefile: 57; sh: 5
file content (121 lines) | stat: -rw-r--r-- 4,036 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.TH CVS2HTML 1 1999-12-10 "Debian Project" "Debian user's manual"
\" This manual page was written by Antti-Juhani Kaijanaho.
\" Modified by Pascal Hakim 10/01/02
\" You may treat it as if it were in the public domain.
.SH NAME
cvs2html - render a CVS commit log in HTML
.SH SYNOPSIS
\&\fBcvs2html\fR [\-a[-b][-k]] [\-n \fInumdif\fR] [\-l/-L \fIhome\fR]
[\-e] [\-f] [\-d \fIMMM DD [YYYY]\fR] [\-D \fIDD\fR] [\-i \fIimage\fR]] [\-h]
[\-v] [\-w \fIframewidth\fR] [\-s \fIpercentage\fR] [\-N \fImaxchrono\fR]
[\-r\fIrev1\fR:\fIrev2\fR] [\-c|-C \fIcfilename\fR] -O | -o \fIhtmlname\fR
[\-p \fIcvspath\fR] [\-v \fIverbosity\fR]

.SH DESCRIPTION
The \fBcvs2html\fR script fetches the commit log for a CVS module and
renders it in HTML.
.TP
\fB-a\fR
Generate additional fields and files containing differences between
versions in an xdiff-like side by side manner.
.TP
\fB-b\fR
Use spaces as breakpoints to wrap the text, if \fI-a\fR is
specified. This is used to stop the two columns from exceeding the
total width.
.TP
\fB-c | -C \fIfilename\fR\fR
Save a chronologically sorted list of all log entries in html format
in \fIfilename\fR. Use -C to reverse-sort the file.
.TP
\fB-d \fIMMM DD [YYYY]\fR\fR
Omit all log messages prior to the given date. The first three letters
of the month should be used (eg Jun 5). The year is optional.
.TP
\fB-D \fIDD\fR\fR
Omit all log messages older than \fIDD\fR days.
.TP
\fB-e\fR
Print log messages in courier (non-proportional) font.
.TP
\fB-f\fR
Generate individual log files for each file when using \fI-o\fR.
.TP
\fB-h\fR
Show help
.TP
\fB-i \fIimage\fR\fR
Make \fIimage\fR the background image.
.TP
\fB-k\fR
Ignore changes in lines caused by CVS-keyword substitutions when
\fI-a\fR is specified.
.TP
\fB-l \fIhome\fR\fR
Make links relative to \fIhome\fR.
.TP
\fB-L \fIhome\fR\fR
Make links relative to \fIhome\fR, but substitute file
extensions with .html.
.TP
\fB-n \fInumdiff\fR\fR
Output only the latest \fInumdiff\fR diffs in the log. Older commits
will only have the log data displayed.
.TP
\fB-N \fImaxchrono\fR\fR
Show only the latest \fImaxchrono\fR file changes in the chronological
list of changes.
.TP
\fB-o \fIoutput\fR\Fr
If \fIoutput\fR is a directory, all html files produced are stored
there, using the name of the repository as the base
filename. Otherwise, \fIoutput\fR is used as the base name. Generate
frames for easier browsing.
.TP
\fB-O \fIoutput\fR\fR
If \fIoutput\fR is a directory, all html files produced are stored
there, using the name of the repository as the base
filename. Otherwise, \fIoutput\fR is used as the base name.
.TP
\fB-P \fIcvspath\fR\fR
Set the cvs path to \fIcvspath\fR.
.TP
\fB-r\fIrev1\fR:\fIrev2\fR\fR
Show only the log messages between \fIrev1\fR, and \fIrev2\fR. If a
file isn't tagged, then the whole revision story of the file is shown.
.TP
\fB-s \fIpercentage\fR\fR
Make the width of the left frame, \fIpercentage\fR of the window.
.TP
\fB-v\fR
Insert CVSROOT information in the index.
.TP
\fB-V \fIverbosity\fR\fR
Set the verbosity. The higher \fIverbosity\fR is, the more output is
printed out.
.TP
\fB-w \fIframewidth\fR\fR
Make the width of the left frame, \fIframewidth\fR pixels.

.SH EXAMPLE
\fIcvs2html\fR -l http://cvs.sslug.dk/linuxbog -f -p \\\\ -o
cvs2html/index.html -v -a -b -n 6 -C chrono.html
.PP
Will create a directory called cvs2html directory. This directory will
contain a log data file, for every file in the repository. The last 6
commits to every file will have a diff available. All links will be
relative to http://cvs.sslug.dk/linuxbog. It will also create a file
with all the log data in it, in chronological order.   

.SH AUTHORS
The \fBcvs2html\fR script was written by Peter Toft and others (see
the comments in \fI/usr/bin/cvs2html\fR for an exhaustive list).  This
manual page was written by Antti-Juhani Kaijanaho for Debian GNU, and
modified by Pascal Hakim.
.SH "SEE ALSO"
The file \fI/usr/share/doc/cvs2html/help.txt\fR.
.PP
The source code to \fBcvs2html\fR, in \fI/usr/bin/cvs2html\fR.
.PP
\fBcvs\fR(1)