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

Diff of /cvsgraph/cvsgraph.1.in

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

revision 1.1, Mon Nov 13 20:42:23 2006 UTC revision 1.1.2.2, Mon Nov 13 21:12:19 2006 UTC
# Line 0  Line 1 
1    .TH "CvsGraph" "1" "@VERSION@" "B. Stultiens" "CVS/RCS Utilities"
2    .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 image maps from CVS/RCS repository files.
8    .SH "OPTIONS"
9    .TP
10    \fB\-b\fR
11    Deprecated, use -O'branch_dupbox=-1' for same functionality.
12    .TP
13    \fB\-c\fR \fIfile\fR
14    Read alternate config from \fIfile\fR.
15    .TP
16    \fB\-d\fR \fIlevel\fR
17    Enable debug mode at \fIlevel\fR. The amount of information is determined by a
18    bitwise or of the following: 1=config lexer, 2=config parser, 4=rcsfile lexer,
19    8=rcsfile parser, 16=rcsfile structure. The \fIlevel\fR argument may be in
20    decimal, octal or hexadecimal format.
21    .TP
22    \fB\-h\fR
23    A brief description of possible options.
24    .TP
25    \fB\-i\fR
26    Generate an image map instead of an image.
27    .TP
28    \fB\-I\fR \fIfile\fR
29    Also write an image map to \fIfile\fR. This can be useful if you want to
30    generate both image and image map simultaneously. This halves the total time
31    spent on accessing the repository file because it is parsed only once.
32    .br
33    However, keeping track of auto-generated files can be a bit of a hack if
34    used in HTTP requests (unless you pass both image and HTML file in one
35    HTTP stream).
36    .br
37    Note 1: most time is used for the image-drawing routines (actually libgd),
38    so you might want to think twice in CGI apps.
39    .br
40    Note 2: you can still use '\fB-o\fR' to specify an output file for the image.
41    And, if you also specify '\fB-i\fR', then you'll get two image maps, for
42    whatever purpose that might be.
43    .TP
44    \fB\-k\fR
45    Deprecated, use -O'auto_stretch=-1' for same functionality.
46    .br
47    This function is \fBnot\fR stable.
48    .TP
49    \fB\-M\fR \fIname\fR
50    Deprecated, use -O'map_name="AMapName"' for same functionality.
51    .TP
52    \fB\-m\fR \fImod\fR
53    Use \fImod\fR as the CVS module.
54    This option overrides \fBcvsmodule\fR in the configuration file.
55    .TP
56    \fB\-O\fR \fIcfg_option=value[;opt=val[...]]\fR
57    Set \fIcfg_option\fR to \fIvalue\fR. Multiple \fB-O\fR are allowed as well
58    as multiple options can be set simultaneously by separating them with ';'.
59    See \fBcvsgraph.conf(5)\fR for a detailed list of options.
60    See also \fBCONFIGURATION\fR below.
61    .TP
62    \fB\-o\fR \fIfile\fR
63    Output to \fIfile\fR. Otherwise, output is written to standard output.
64    .TP
65    \fB\-q\fR
66    Be quiet (i.e. no warnings)
67    .TP
68    \fB\-r\fR \fIpath\fR
69    Use \fIpath\fR as the CVS root.
70    This option overrides \fBcvsroot\fR in the configuration file.
71    .TP
72    \fB\-s\fR
73    Deprecated, use -O'strip_untagged=-1' for same functionality.
74    .TP
75    \fB\-S\fR
76    Deprecated, use -O'strip_first_rev=-1' for same functionality.
77    .TP
78    \fB\-u\fR
79    Deprecated, use -O'upside_down=-1' for same functionality.
80    .TP
81    \fB\-V\fR
82    Print version and exit.
83    .TP
84    \fB\-x\fR \fI{3,4,x}\fR
85    Set the HTML level of compliance for image maps. Use \fI3\fR for HTML 3.x,
86    \fI4\fR for HTML 4.x and \fIx\fR for XHTML. Default is HTML 3.x compatibility.
87    .TP
88    \fB\-[0\-9]\fR \fItxt\fR
89    Use \fItxt\fR for expansion
90    .SH "CONFIGURATION"
91    \fBCvsGraph\fR starts with reading a configuration file. If the '\fB\-c\fR'
92    option is given on the command line, then it is read. Otherwise, \fBcvsgraph\fR
93    first looks for a configuration file in the current directory using
94    \fI./cvsgraph.conf\fR and, if not found, tries to open
95    \fI@sysconfdir@/cvsgraph.conf\fR. Defaults and command line overrides
96    will be used if no configuration file can be opened. The format of the
97    configuration file is described in \fBcvsgraph.conf(5)\fR. Configuration
98    parameters entered on the command line have always precedence over the
99    configuration file. Configuration options are processed in the following
100    order:
101    .br
102    - configuration file
103    .br
104    - '\fB-O\fR' command line options
105    .br
106    - other command line overrides (\fB-bkMmrSsu\fR)
107    .br
108    If you do not want to process any configuration file, then you can set option
109    \'\fB-c /dev/null\fR', which will read an empty configuration file.
110    .PP
111    The location of a repository file is determined by the configuration parameters
112    \fBcvsroot\fR and \fBcvsmodule\fR and the respective command line options
113    \&'\fB\-r\fR' and '\fB\-m\fR'.  The \fBcvsroot\fR, \fBcvsmodule\fR and \fIfile\fR
114    are concatenated with separating '/' path\-separators forming the final
115    location:
116    .br
117    <cvsroot>/<cvsmodule>/\fIfile\fR
118    .br
119    No path\-separator is appended if \fBcvsroot\fR and \fBcvsmodule\fR are empty
120    strings. An error message is issued if the resulting path cannot be opened.
121    Note that \fBcvsgraph\fR does not attempt to check any validity of the path
122    components. This enables a user to open any file on the file\-system by setting
123    \fBcvsroot\fR and \fBcvsmodule\fR to empty strings.
124    .br
125    For example, \fIcvsgraph \-r '' \-m '' ../myfile,v\fR would try to open the
126    file \fI../myfile,v\fR. Note that a variety of possibilities yield the same
127    file and all have their advantages and drawbacks, which are mostly related to
128    the possible use of the parameters in text expansions.
129    .PP
130    If no \fIfile\fR is given on the command line, then input is read from standard
131    input. This can make expansion strings somewhat strange looking, but they are
132    composed with the information available. If no input file was given, then the
133    input filename for expansion is set to \fB<stdin>\fR.
134    
135    .SH "OUTPUT"
136    The output generated by \fBcvsgraph\fR can be either an image (default) or and
137    HTML image map ('\fB\-i\fR' and '\fB-I\fR' options).
138    .br
139    Images can have several formats, depending on the capabilities of the gd
140    library on which the drawing is built. The configuration allows for GIF, PNG or
141    JPEG type images. Some recent versions of gd do no longer support GIF and PNG
142    will be used instead. GIF support in gd was added again after the lzw patent
143    expired.
144    .br
145    Generation of image maps conforms to the HTML standard and maps rectangular
146    regions of the image where revisions and branches are drawn. Additionally, an
147    extra rectangular region is generated between revisions to support diff
148    generation.
149    .SH "FILES"
150    .LP
151    .TP
152    \fI@sysconfdir@/cvsgraph.conf\fR
153    Configuration file read for default layout parameters.
154    .SH "AUTHOR"
155    \fBCvsGraph\fR is written and maintained by B. Stultiens.
156    .br
157    Send comments and bug reports to \fIcvsgraph@akhphd.au.dk\fR (read the mailnote
158    in the README file first) and visit the homepage at:
159    .br
160    \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph/\fR.
161    .SH "SEE ALSO"
162    .BR cvsgraph.conf(5)
163    

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.1.2.2

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0