/[CvsGraph]/cvsgraph/cvsgraph.1
ViewVC logotype

Annotate of /cvsgraph/cvsgraph.1

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.5 - (hide annotations)
Tue Dec 18 22:50:12 2001 UTC (16 years ago) by bertho
Branch: MAIN
Changes since 1.4: +9 -1 lines
- Added upside-down imaging of the tree
- Added extra branch-box at the bottom/top of the trunk
- Added stripping of untagged revisions
1 bertho 1.5 .TH "CvsGraph" "1" "1.1.4" "B. Stultiens" "CVS/RCS Utilties"
2 bertho 1.1 .SH "NAME"
3     cvsgraph \- A CVS/RCS repository grapher
4     .SH "SYNOPSIS"
5     \fBcvsgraph\fR [\fIoptions\fR] \fIfile\fR
6     .SH "DESCRIPTION"
7     \fBCvsGraph\fR generates images and imagemaps from CVS/RCS repository files.
8     .SH "OPTIONS"
9     .TP
10 bertho 1.5 \fB\-b\fR
11     Add a branch box at the end of the trunk too. This option negates the branch_mirror
12     setting from the configuration file.
13     .TP
14 bertho 1.1 \fB\-c\fR \fIfile\fR
15     Read alternate config from \fIfile\fR.
16     .TP
17     \fB\-d\fR \fIlevel\fR
18     Enable debug mode at \fIlevel\fR. The amount of information is determined by a
19     bitwise or of the following: 1=config lexer, 2=config parser, 4=rcsfile lexer,
20     8=rcsfile parser, 16=rcsfile structure. The \fIlevel\fR argument may be in decimal,
21     octal or hexadecimal format.
22     .TP
23     \fB\-h\fR
24     A brief description of possible options.
25     .TP
26     \fB\-i\fR
27     Generate an imagemap instead of an image.
28     .TP
29     \fB\-M\fR \fIname\fR
30     Use \fIname\fR as imagemap name (has only effect in combination with \fB\-i\fR).
31     .TP
32     \fB\-m\fR \fImod\fR
33     Use \fImod\fR as cvsmodule.
34     .TP
35     \fB\-o\fR \fIfile\fR
36     Output to \fIfile\fR. Otherwise, output is written to standard output.
37     .TP
38     \fB\-q\fR
39     Be quiet (i.e. no warnings)
40     .TP
41     \fB\-r\fR \fIpath\fR
42     Use \fIpath\fR as cvsroot.
43 bertho 1.5 .TP
44     \fB\-u\fR
45     Draw the tree upside down (newest revision at the top). This option negates the upside_down
46     setting from the configuration file.
47 bertho 1.1 .TP
48     \fB\-V\fR
49     Print version and exit.
50     .TP
51     \fB\-[0\-9]\fR \fItxt\fR
52     Use \fItxt\fR for expansion
53     .SH "CONFIGURATION"
54     \fBCvsGraph\fR starts with reading a configuration file. If the \fB\-c\fR option
55     is given on the commandline, then it is read. Otherwise, \fBcvsgraph\fR first
56     looks for a configuration file in the current directory using \fI./cvsgraph.conf\fR
57     and, if not found, tries to open \fI/usr/local/etc/cvsgraph.conf\fR.
58     If still no configuration file is read an error message is issued and
59     \fBcvsgraph\fR terminates. The format of the configuration file is
60     described in \fBcvsgraph.conf(5)\fR. Configuration parameters entered on
61     the commandline have always precedent over the configuration file.
62     .br
63     The location of a repository file is determined by the configuration parameters
64     cvsroot and cvsmodule and the respective commandline options \fB\-r\fR and \fB\-m\fR.
65     The cvsroot, cvsmodule and \fIfile\fR are concatenated with separating
66     \'/\' path\-separators forming the final location:
67     .br
68     <cvsroot>/<cvsmodule>/\fIfile\fR
69     .br
70     No path\-separator is appended if cvsroot and cvsmodule are empty strings.
71     An error message is issued if the resulting path cannot be opend.
72     Note that \fBcvsgraph\fR does not atempt to check any validity any of
73     the path components. This enables a user to open any file on the file\-system
74     by setting cvsroot and cvsmodule to empty strings.
75     .br
76     For example, \fIcvsgraph \-r '' \-m '' ../myfile,v\fR would try to open the
77     file \fI../myfile,v\fR. Note that a variety of possibilities yield the same file
78 bertho 1.3 and all have their advantages and drawbacks, which are mostly related to the
79     possible use of the parameters in text expansions.
80 bertho 1.1 .SH "OUTPUT"
81     The output generated by \fBcvsgraph\fR can be either an image
82     (default) or and HTML imagemap (\fB\-i\fR option).
83     .br
84     Images can have several formats, depending on the capabilities
85     of the gd library on which the drawing is built. The configuration
86     allows for GIF, PNG or JPEG type images. Newer versions of gd do no
87     longer support GIF and PNG will be used instead.
88     .br
89     Generation of imagemaps conforms to the HTML standard and maps
90     rectangular regions of the image where revisions and branches are
91     drawn. Additionally, an extra rectangular region is generated between
92     revisions to support diff generation.
93     .SH "FILES"
94     .LP
95     .TP
96     \fI/usr/local/etc/cvsgraph.conf\fR
97     Configuration file read for default layout parameters.
98     .SH "AUTHOR"
99     \fBCvsGraph\fR is written and maintained by B. Stultiens.
100     .br
101     Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and
102 bertho 1.3 visit the homepage at:
103     .br
104     \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.
105 bertho 1.1 .SH "SEE ALSO"
106     .BR cvsgraph.conf(5)
107    

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0