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

Diff of /cvsgraph/cvsgraph.1

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

revision 1.18, Sun Aug 15 16:58:22 2004 UTC revision 1.20, Sat Oct 23 00:25:32 2004 UTC
# Line 1  Line 1 
1  .TH "CvsGraph" "1" "1.5.0" "B. Stultiens" "CVS/RCS Utilties"  .TH "CvsGraph" "1" "1.5.1" "B. Stultiens" "CVS/RCS Utilities"
2  .SH "NAME"  .SH "NAME"
3  cvsgraph \- A CVS/RCS repository grapher  cvsgraph \- A CVS/RCS repository grapher
4  .SH "SYNOPSIS"  .SH "SYNOPSIS"
5  \fBcvsgraph\fR [\fIoptions\fR] [\fIfile\fR]  \fBcvsgraph\fR [\fIoptions\fR] [\fIfile\fR]
6  .SH "DESCRIPTION"  .SH "DESCRIPTION"
7  \fBCvsGraph\fR generates images and imagemaps from CVS/RCS repository files.  \fBCvsGraph\fR generates images and image maps from CVS/RCS repository files.
8  .SH "OPTIONS"  .SH "OPTIONS"
9  .TP  .TP
10  \fB\-b\fR  \fB\-b\fR
# Line 24  Line 24 
24  A brief description of possible options.  A brief description of possible options.
25  .TP  .TP
26  \fB\-i\fR  \fB\-i\fR
27  Generate an imagemap instead of an image.  Generate an image map instead of an image.
28  .TP  .TP
29  \fB\-I\fR \fIfile\fR  \fB\-I\fR \fIfile\fR
30  Also write an imagemap to \fIfile\fR. This can be usefull if you want to  Also write an image map to \fIfile\fR. This can be useful if you want to
31  generate both image and imagemap simultaneously. This halves the total time  generate both image and image map simultaneously. This halves the total time
32  spent on accessing the repository file because it is parsed only once.  spent on accessing the repository file because it is parsed only once.
33  .br  .br
34  However, keeping track of auto-generated files can be a bit of a hack if  However, keeping track of auto-generated files can be a bit of a hack if
35  used in http requests (unless you pass both image and html-file in one  used in HTTP requests (unless you pass both image and HTML file in one
36  http-stream).  HTTP stream).
37  .br  .br
38  Note 1: most time is used for the image-drawing routines (actually libgd),  Note 1: most time is used for the image-drawing routines (actually libgd),
39  so you might want to think twice in CGI apps.  so you might want to think twice in CGI apps.
40  .br  .br
41  Note 2: you can still use '\fB-o\fR' to specify an output file for the image.  Note 2: you can still use '\fB-o\fR' to specify an output file for the image.
42  And, if you also specify '\fB-i\fR', then you'll get two imagemaps, for  And, if you also specify '\fB-i\fR', then you'll get two image maps, for
43  whatever purpose that might be.  whatever purpose that might be.
44  .TP  .TP
45  \fB\-k\fR  \fB\-k\fR
# Line 48  Line 48 
48  configuration file.  configuration file.
49  .TP  .TP
50  \fB\-M\fR \fIname\fR  \fB\-M\fR \fIname\fR
51  Use \fIname\fR as imagemap name (has only effect in combination with  Use \fIname\fR as image map name (has only effect in combination with
52  \&'\fB\-i\fR').  This option overrides \fBmap_name\fR in the configuration file.  \&'\fB\-i\fR').  This option overrides \fBmap_name\fR in the configuration file.
53  .TP  .TP
54  \fB\-m\fR \fImod\fR  \fB\-m\fR \fImod\fR
55  Use \fImod\fR as cvsmodule.  Use \fImod\fR as the CVS module.
56  This option overrides \fBcvsmodule\fR in the configuration file.  This option overrides \fBcvsmodule\fR in the configuration file.
57  .TP  .TP
58  \fB\-O\fR \fIcfg_option=value[;opt=val[...]]\fR  \fB\-O\fR \fIcfg_option=value[;opt=val[...]]\fR
# Line 68  Line 68 
68  Be quiet (i.e. no warnings)  Be quiet (i.e. no warnings)
69  .TP  .TP
70  \fB\-r\fR \fIpath\fR  \fB\-r\fR \fIpath\fR
71  Use \fIpath\fR as cvsroot.  Use \fIpath\fR as the CVS root.
72  This option overrides \fBcvsroot\fR in the configuration file.  This option overrides \fBcvsroot\fR in the configuration file.
73  .TP  .TP
74  \fB\-s\fR  \fB\-s\fR
# Line 79  Line 79 
79  configuration file.  configuration file.
80  .TP  .TP
81  \fB\-S\fR  \fB\-S\fR
82  Also strip the first revision in a branch if untagged and not a branchpoint.  Also strip the first revision in a branch if untagged and not a branch point.
83  This has only effect if \fBstrip_untagged\fR or option '\fB\-s\fR' is set.  This has only effect if \fBstrip_untagged\fR or option '\fB\-s\fR' is set.
84  The '\fB\-S\fR' option negates the \fBstrip_first_rev\fR from the configuration  The '\fB\-S\fR' option negates the \fBstrip_first_rev\fR from the configuration
85  file.  file.
# Line 99  Line 99 
99  Use \fItxt\fR for expansion  Use \fItxt\fR for expansion
100  .SH "CONFIGURATION"  .SH "CONFIGURATION"
101  \fBCvsGraph\fR starts with reading a configuration file. If the '\fB\-c\fR'  \fBCvsGraph\fR starts with reading a configuration file. If the '\fB\-c\fR'
102  option is given on the commandline, then it is read. Otherwise, \fBcvsgraph\fR  option is given on the command line, then it is read. Otherwise, \fBcvsgraph\fR
103  first looks for a configuration file in the current directory using  first looks for a configuration file in the current directory using
104  \fI./cvsgraph.conf\fR and, if not found, tries to open  \fI./cvsgraph.conf\fR and, if not found, tries to open
105  \fI/usr/local/etc/cvsgraph.conf\fR. Defaults and commandline overrides  \fI/usr/local/etc/cvsgraph.conf\fR. Defaults and command line overrides
106  will be used if no configuration file can be opened. The format of the  will be used if no configuration file can be opened. The format of the
107  configuration file is described in \fBcvsgraph.conf(5)\fR. Configuration  configuration file is described in \fBcvsgraph.conf(5)\fR. Configuration
108  parameters entered on the commandline have always precedence over the  parameters entered on the command line have always precedence over the
109  configuration file. Configuration options are processed in the following  configuration file. Configuration options are processed in the following
110  order:  order:
111  .br  .br
112  - configuration file  - configuration file
113  .br  .br
114  - '\fB-O\fR' commandline options  - '\fB-O\fR' command line options
115  .br  .br
116  - other commandline overrides (\fB-bkMmrSsu\fR)  - other command line overrides (\fB-bkMmrSsu\fR)
117  .br  .br
118  If you do not want to process any configurationfile, then you can set option  If you do not want to process any configuration file, then you can set option
119  \'\fB-c /dev/null\fR', which will read an empty configuration file.  \'\fB-c /dev/null\fR', which will read an empty configuration file.
120  .PP  .PP
121  The location of a repository file is determined by the configuration parameters  The location of a repository file is determined by the configuration parameters
122  \fBcvsroot\fR and \fBcvsmodule\fR and the respective commandline options  \fBcvsroot\fR and \fBcvsmodule\fR and the respective command line options
123  \&'\fB\-r\fR' and '\fB\-m\fR'.  The \fBcvsroot\fR, \fBcvsmodule\fR and \fIfile\fR  \&'\fB\-r\fR' and '\fB\-m\fR'.  The \fBcvsroot\fR, \fBcvsmodule\fR and \fIfile\fR
124  are concatenated with separating '/' path\-separators forming the final  are concatenated with separating '/' path\-separators forming the final
125  location:  location:
# Line 127  Line 127 
127  <cvsroot>/<cvsmodule>/\fIfile\fR  <cvsroot>/<cvsmodule>/\fIfile\fR
128  .br  .br
129  No path\-separator is appended if \fBcvsroot\fR and \fBcvsmodule\fR are empty  No path\-separator is appended if \fBcvsroot\fR and \fBcvsmodule\fR are empty
130  strings. An error message is issued if the resulting path cannot be opend.  strings. An error message is issued if the resulting path cannot be opened.
131  Note that \fBcvsgraph\fR does not atempt to check any validity of the path  Note that \fBcvsgraph\fR does not attempt to check any validity of the path
132  components. This enables a user to open any file on the file\-system by setting  components. This enables a user to open any file on the file\-system by setting
133  \fBcvsroot\fR and \fBcvsmodule\fR to empty strings.  \fBcvsroot\fR and \fBcvsmodule\fR to empty strings.
134  .br  .br
# Line 137  Line 137 
137  file and all have their advantages and drawbacks, which are mostly related to  file and all have their advantages and drawbacks, which are mostly related to
138  the possible use of the parameters in text expansions.  the possible use of the parameters in text expansions.
139  .PP  .PP
140  If no \fIfile\fR is given on the commandline, then input is read from standard  If no \fIfile\fR is given on the command line, then input is read from standard
141  input. This can make expansion strings somewhat strange looking, but they are  input. This can make expansion strings somewhat strange looking, but they are
142  composed with the information available. If no input file was given, then the  composed with the information available. If no input file was given, then the
143  input filename for expansion is set to \fB<stdin>\fR.  input filename for expansion is set to \fB<stdin>\fR.
144    
145  .SH "OUTPUT"  .SH "OUTPUT"
146  The output generated by \fBcvsgraph\fR can be either an image (default) or and  The output generated by \fBcvsgraph\fR can be either an image (default) or and
147  HTML imagemap ('\fB\-i\fR' and '\fB-I\fR' options).  HTML image map ('\fB\-i\fR' and '\fB-I\fR' options).
148  .br  .br
149  Images can have several formats, depending on the capabilities of the gd  Images can have several formats, depending on the capabilities of the gd
150  library on which the drawing is built. The configuration allows for GIF, PNG or  library on which the drawing is built. The configuration allows for GIF, PNG or
151  JPEG type images. Newer versions of gd do no longer support GIF and PNG will be  JPEG type images. Newer versions of gd do no longer support GIF and PNG will be
152  used instead.  used instead.
153  .br  .br
154  Generation of imagemaps conforms to the HTML standard and maps rectangular  Generation of image maps conforms to the HTML standard and maps rectangular
155  regions of the image where revisions and branches are drawn. Additionally, an  regions of the image where revisions and branches are drawn. Additionally, an
156  extra rectangular region is generated between revisions to support diff  extra rectangular region is generated between revisions to support diff
157  generation.  generation.
# Line 163  Line 163 
163  .SH "AUTHOR"  .SH "AUTHOR"
164  \fBCvsGraph\fR is written and maintained by B. Stultiens.  \fBCvsGraph\fR is written and maintained by B. Stultiens.
165  .br  .br
166  Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and  Send comments and bug reports to \fIcvsgraph@akhphd.au.dk\fR and
167  visit the homepage at:  visit the homepage at:
168  .br  .br
169  \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.  \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph/\fR.
170  .SH "SEE ALSO"  .SH "SEE ALSO"
171  .BR cvsgraph.conf(5)  .BR cvsgraph.conf(5)
172    

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.20

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0