File: cvsgraph.1

package info (click to toggle)
cvsgraph 1.1.2-4
  • links: PTS
  • area: main
  • in suites: woody
  • size: 264 kB
  • ctags: 325
  • sloc: ansic: 1,616; yacc: 596; lex: 338; makefile: 84; php: 42
file content (99 lines) | stat: -rw-r--r-- 3,744 bytes parent folder | download
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
.TH "CvsGraph" "1" "1.1.1" "B. Stultiens" "CVS/RCS Utilties"
.SH "NAME"
cvsgraph \- A CVS/RCS repository grapher
.SH "SYNOPSIS"
\fBcvsgraph\fR [\fIoptions\fR] \fIfile\fR
.SH "DESCRIPTION"
\fBCvsGraph\fR generates images and imagemaps from CVS/RCS repository files.
.SH "OPTIONS"
.TP
\fB\-c\fR \fIfile\fR
Read alternate config from \fIfile\fR.
.TP
\fB\-d\fR \fIlevel\fR
Enable debug mode at \fIlevel\fR. The amount of information is determined by a
bitwise or of the following: 1=config lexer, 2=config parser, 4=rcsfile lexer,
8=rcsfile parser, 16=rcsfile structure. The \fIlevel\fR argument may be in decimal,
octal or hexadecimal format.
.TP
\fB\-h\fR
A brief description of possible options.
.TP
\fB\-i\fR
Generate an imagemap instead of an image.
.TP
\fB\-M\fR \fIname\fR
Use \fIname\fR as imagemap name (has only effect in combination with \fB\-i\fR).
.TP
\fB\-m\fR \fImod\fR
Use \fImod\fR as cvsmodule.
.TP
\fB\-o\fR \fIfile\fR
Output to \fIfile\fR. Otherwise, output is written to standard output.
.TP
\fB\-q\fR
Be quiet (i.e. no warnings)
.TP
\fB\-r\fR \fIpath\fR
Use \fIpath\fR as cvsroot.
.TP
\fB\-V\fR
Print version and exit.
.TP
\fB\-[0\-9]\fR \fItxt\fR
Use \fItxt\fR for expansion
.SH "CONFIGURATION"
\fBCvsGraph\fR starts with reading a configuration file. If the \fB\-c\fR option
is given on the commandline, then it is read. Otherwise, \fBcvsgraph\fR first
looks for a configuration file in the current directory using \fI./cvsgraph.conf\fR
and, if not found, tries to open \fI/usr/local/etc/cvsgraph.conf\fR.
If still no configuration file is read an error message is issued and
\fBcvsgraph\fR terminates. The format of the configuration file is
described in \fBcvsgraph.conf(5)\fR. Configuration parameters entered on
the commandline have always precedent over the configuration file.
.br
The location of a repository file is determined by the configuration parameters
cvsroot and cvsmodule and the respective commandline options \fB\-r\fR and \fB\-m\fR.
The cvsroot, cvsmodule and \fIfile\fR are concatenated with separating
\'/\' path\-separators forming the final location:
.br
<cvsroot>/<cvsmodule>/\fIfile\fR
.br
No path\-separator is appended if cvsroot and cvsmodule are empty strings.
An error message is issued if the resulting path cannot be opend.
Note that \fBcvsgraph\fR does not atempt to check any validity any of
the path components. This enables a user to open any file on the file\-system
by setting cvsroot and cvsmodule to empty strings.
.br
For example, \fIcvsgraph \-r '' \-m '' ../myfile,v\fR would try to open the
file \fI../myfile,v\fR. Note that a variety of possibilities yield the same file
and all have their advantages and drawbacks, which are mostly related to the
possible use of the parameters in text expansions.
.SH "OUTPUT"
The output generated by \fBcvsgraph\fR can be either an image
(default) or and HTML imagemap (\fB\-i\fR option).
.br
Images can have several formats, depending on the capabilities
of the gd library on which the drawing is built. The configuration
allows for GIF, PNG or JPEG type images. Newer versions of gd do no
longer support GIF and PNG will be used instead.
.br
Generation of imagemaps conforms to the HTML standard and maps
rectangular regions of the image where revisions and branches are
drawn. Additionally, an extra rectangular region is generated between
revisions to support diff generation.
.SH "FILES"
.LP
.TP
\fI/usr/local/etc/cvsgraph.conf\fR
Configuration file read for default layout parameters.
.SH "AUTHOR"
\fBCvsGraph\fR is written and maintained by B. Stultiens.
.br
Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and
visit the homepage at:
.br
\fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.
.SH "SEE ALSO"
.BR cvsgraph.conf(5)