File: cvsgraph.1.in

package info (click to toggle)
cvsgraph 1.7.0-5
  • links: PTS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,332 kB
  • sloc: ansic: 5,248; sh: 950; yacc: 440; lex: 212; makefile: 68
file content (163 lines) | stat: -rw-r--r-- 6,291 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
.TH "CvsGraph" "1" "@VERSION@" "B. Stultiens" "CVS/RCS Utilities"
.SH "NAME"
cvsgraph \- A CVS/RCS repository grapher
.SH "SYNOPSIS"
\fBcvsgraph\fR [\fIoptions\fR] [\fIfile\fR]
.SH "DESCRIPTION"
\fBCvsGraph\fR generates images and image maps from CVS/RCS repository files.
.SH "OPTIONS"
.TP
\fB\-b\fR
Deprecated, use -O'branch_dupbox=-1' for same functionality.
.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 image map instead of an image.
.TP
\fB\-I\fR \fIfile\fR
Also write an image map to \fIfile\fR. This can be useful if you want to
generate both image and image map simultaneously. This halves the total time
spent on accessing the repository file because it is parsed only once.
.br
However, keeping track of auto-generated files can be a bit of a hack if
used in HTTP requests (unless you pass both image and HTML file in one
HTTP stream).
.br
Note 1: most time is used for the image-drawing routines (actually libgd),
so you might want to think twice in CGI apps.
.br
Note 2: you can still use '\fB-o\fR' to specify an output file for the image.
And, if you also specify '\fB-i\fR', then you'll get two image maps, for
whatever purpose that might be.
.TP
\fB\-k\fR
Deprecated, use -O'auto_stretch=-1' for same functionality.
.br
This function is \fBnot\fR stable.
.TP
\fB\-M\fR \fIname\fR
Deprecated, use -O'map_name="AMapName"' for same functionality.
.TP
\fB\-m\fR \fImod\fR
Use \fImod\fR as the CVS module.
This option overrides \fBcvsmodule\fR in the configuration file.
.TP
\fB\-O\fR \fIcfg_option=value[;opt=val[...]]\fR
Set \fIcfg_option\fR to \fIvalue\fR. Multiple \fB-O\fR are allowed as well
as multiple options can be set simultaneously by separating them with ';'.
See \fBcvsgraph.conf(5)\fR for a detailed list of options.
See also \fBCONFIGURATION\fR below.
.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 the CVS root.
This option overrides \fBcvsroot\fR in the configuration file.
.TP
\fB\-s\fR
Deprecated, use -O'strip_untagged=-1' for same functionality.
.TP
\fB\-S\fR
Deprecated, use -O'strip_first_rev=-1' for same functionality.
.TP
\fB\-u\fR
Deprecated, use -O'upside_down=-1' for same functionality.
.TP
\fB\-V\fR
Print version and exit.
.TP
\fB\-x\fR \fI{3,4,x}\fR
Set the HTML level of compliance for image maps. Use \fI3\fR for HTML 3.x,
\fI4\fR for HTML 4.x and \fIx\fR for XHTML. Default is HTML 3.x compatibility.
.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 command line, 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@sysconfdir@/cvsgraph.conf\fR. Defaults and command line overrides
will be used if no configuration file can be opened. The format of the
configuration file is described in \fBcvsgraph.conf(5)\fR. Configuration
parameters entered on the command line have always precedence over the
configuration file. Configuration options are processed in the following
order:
.br
- configuration file
.br
- '\fB-O\fR' command line options
.br
- other command line overrides (\fB-bkMmrSsu\fR)
.br
If you do not want to process any configuration file, then you can set option
\'\fB-c /dev/null\fR', which will read an empty configuration file.
.PP
The location of a repository file is determined by the configuration parameters
\fBcvsroot\fR and \fBcvsmodule\fR and the respective command line options
\&'\fB\-r\fR' and '\fB\-m\fR'.  The \fBcvsroot\fR, \fBcvsmodule\fR 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 \fBcvsroot\fR and \fBcvsmodule\fR are empty
strings. An error message is issued if the resulting path cannot be opened.
Note that \fBcvsgraph\fR does not attempt to check any validity of the path
components. This enables a user to open any file on the file\-system by setting
\fBcvsroot\fR and \fBcvsmodule\fR 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.
.PP
If no \fIfile\fR is given on the command line, then input is read from standard
input. This can make expansion strings somewhat strange looking, but they are
composed with the information available. If no input file was given, then the
input filename for expansion is set to \fB<stdin>\fR.

.SH "OUTPUT"
The output generated by \fBcvsgraph\fR can be either an image (default) or and
HTML image map ('\fB\-i\fR' and '\fB-I\fR' options).
.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. Some recent versions of gd do no longer support GIF and PNG
will be used instead. GIF support in gd was added again after the lzw patent
expired.
.br
Generation of image maps 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@sysconfdir@/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 bug reports to \fIcvsgraph@akhphd.au.dk\fR (read the mailnote
in the README file first) and visit the homepage at:
.br
\fIhttp://www.akhphd.au.dk/~bertho/cvsgraph/\fR.
.SH "SEE ALSO"
.BR cvsgraph.conf(5)