/[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.16, Fri Jul 16 13:49:42 2004 UTC revision 1.27, Wed May 21 13:33:35 2008 UTC
# Line 1  Line 1 
1  .TH "CvsGraph" "1" "1.4.1" "B. Stultiens" "CVS/RCS Utilties"  .TH "CvsGraph" "1" "1.7.0" "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
11  Add a branch box at the end of the trunk too. This option negates the  Deprecated, use -O'branch_dupbox=-1' for same functionality.
 \fBbranch_dupbox\fR setting from the configuration file.  
12  .TP  .TP
13  \fB\-c\fR \fIfile\fR  \fB\-c\fR \fIfile\fR
14  Read alternate config from \fIfile\fR.  Read alternate config from \fIfile\fR.
# Line 24  Line 23 
23  A brief description of possible options.  A brief description of possible options.
24  .TP  .TP
25  \fB\-i\fR  \fB\-i\fR
26  Generate an imagemap instead of an image.  Generate an image map instead of an image.
27  .TP  .TP
28  \fB\-I\fR \fIfile\fR  \fB\-I\fR \fIfile\fR
29  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
30  generate both image and imagemap simultaneously. This halves the total time  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.  spent on accessing the repository file because it is parsed only once.
32  .br  .br
33  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
34  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
35  http-stream).  HTTP stream).
36  .br  .br
37  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),
38  so you might want to think twice in CGI apps.  so you might want to think twice in CGI apps.
39  .br  .br
40  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.
41  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
42  whatever purpose that might be.  whatever purpose that might be.
43  .TP  .TP
44  \fB\-k\fR  \fB\-k\fR
45  Try to reduce the image size by adjusting inter\-revision spacing and moving  Deprecated, use -O'auto_stretch=-1' for same functionality.
46  trunks more left. This options negates the \fBauto_stretch\fR setting from the  .br
47  configuration file.  This function is \fBnot\fR stable.
48  .TP  .TP
49  \fB\-M\fR \fIname\fR  \fB\-M\fR \fIname\fR
50  Use \fIname\fR as imagemap name (has only effect in combination with  Deprecated, use -O'map_name="AMapName"' for same functionality.
 \&'\fB\-i\fR').  This option overrides \fBmap_name\fR in the configuration file.  
51  .TP  .TP
52  \fB\-m\fR \fImod\fR  \fB\-m\fR \fImod\fR
53  Use \fImod\fR as cvsmodule.  Use \fImod\fR as the CVS module.
54  This option overrides \fBcvsmodule\fR in the configuration file.  This option overrides \fBcvsmodule\fR in the configuration file.
55  .TP  .TP
56  \fB\-O\fR \fIcfg_option=value[;opt=val[...]]\fR  \fB\-O\fR \fIcfg_option=value[;opt=val[...]]\fR
# Line 68  Line 66 
66  Be quiet (i.e. no warnings)  Be quiet (i.e. no warnings)
67  .TP  .TP
68  \fB\-r\fR \fIpath\fR  \fB\-r\fR \fIpath\fR
69  Use \fIpath\fR as cvsroot.  Use \fIpath\fR as the CVS root.
70  This option overrides \fBcvsroot\fR in the configuration file.  This option overrides \fBcvsroot\fR in the configuration file.
71  .TP  .TP
72  \fB\-s\fR  \fB\-s\fR
73  Strip all untagged revisions from the tree. Only the first, last and each  Deprecated, use -O'strip_untagged=-1' for same functionality.
 tagged revision of each trunk will be shown. This will greatly reduce the size  
 of the generated image if you didn't tag everything (and are not interested in  
 all revisions). This option negates the \fBstrip_untagged\fR setting from the  
 configuration file.  
74  .TP  .TP
75  \fB\-S\fR  \fB\-S\fR
76  Also strip the first revision in a branch if untagged and not a branchpoint.  Deprecated, use -O'strip_first_rev=-1' for same functionality.
 This has only effect if \fBstrip_untagged\fR or option '\fB\-s\fR' is set.  
 The '\fB\-S\fR' option negates the \fBstrip_first_rev\fR from the configuration  
 file.  
77  .TP  .TP
78  \fB\-u\fR  \fB\-u\fR
79  Draw the tree upside down (newest revision at the top). This option negates the  Deprecated, use -O'upside_down=-1' for same functionality.
 \fBupside_down\fR setting from the configuration file.  
80  .TP  .TP
81  \fB\-V\fR  \fB\-V\fR
82  Print version and exit.  Print version and exit.
# Line 99  Line 89 
89  Use \fItxt\fR for expansion  Use \fItxt\fR for expansion
90  .SH "CONFIGURATION"  .SH "CONFIGURATION"
91  \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'
92  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
93  first looks for a configuration file in the current directory using  first looks for a configuration file in the current directory using
94  \fI./cvsgraph.conf\fR and, if not found, tries to open  \fI./cvsgraph.conf\fR and, if not found, tries to open
95  \fI/usr/local/etc/cvsgraph.conf\fR. Defaults and commandline overrides  \fI${prefix}/etc/cvsgraph.conf\fR. Defaults and command line overrides
96  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
97  configuration file is described in \fBcvsgraph.conf(5)\fR. Configuration  configuration file is described in \fBcvsgraph.conf(5)\fR. Configuration
98  parameters entered on the commandline have always precedence over the  parameters entered on the command line have always precedence over the
99  configuration file. Configuration options are processed in the following  configuration file. Configuration options are processed in the following
100  order:  order:
101  .br  .br
102  - configuration file  - configuration file
103  .br  .br
104  - '\fB-O\fR' commandline options  - '\fB-O\fR' command line options
105  .br  .br
106  - other commandline overrides (\fB-bkMmrSsu\fR)  - other command line overrides (\fB-bkMmrSsu\fR)
107  .br  .br
108  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
109  \'\fB-c /dev/null\fR', which will read an empty configuration file.  \'\fB-c /dev/null\fR', which will read an empty configuration file.
110  .PP  .PP
111  The location of a repository file is determined by the configuration parameters  The location of a repository file is determined by the configuration parameters
112  \fBcvsroot\fR and \fBcvsmodule\fR and the respective commandline options  \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  \&'\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  are concatenated with separating '/' path\-separators forming the final
115  location:  location:
# Line 127  Line 117 
117  <cvsroot>/<cvsmodule>/\fIfile\fR  <cvsroot>/<cvsmodule>/\fIfile\fR
118  .br  .br
119  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
120  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.
121  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
122  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
123  \fBcvsroot\fR and \fBcvsmodule\fR to empty strings.  \fBcvsroot\fR and \fBcvsmodule\fR to empty strings.
124  .br  .br
# Line 137  Line 127 
127  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
128  the possible use of the parameters in text expansions.  the possible use of the parameters in text expansions.
129  .PP  .PP
130  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
131  input. This can make expansion strings somewhat strange looking, but they are  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  composed with the information available. If no input file was given, then the
133  input filename for expansion is set to \fB<stdin>\fR.  input filename for expansion is set to \fB<stdin>\fR.
134    
135  .SH "OUTPUT"  .SH "OUTPUT"
136  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
137  HTML imagemap ('\fB\-i\fR' and '\fB-I\fR' options).  HTML image map ('\fB\-i\fR' and '\fB-I\fR' options).
138  .br  .br
139  Images can have several formats, depending on the capabilities of the gd  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  library on which the drawing is built. The configuration allows for GIF, PNG or
141  JPEG type images. Newer versions of gd do no longer support GIF and PNG will be  JPEG type images. Some recent versions of gd do no longer support GIF and PNG
142  used instead.  will be used instead. GIF support in gd was added again after the lzw patent
143    expired.
144  .br  .br
145  Generation of imagemaps conforms to the HTML standard and maps rectangular  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  regions of the image where revisions and branches are drawn. Additionally, an
147  extra rectangular region is generated between revisions to support diff  extra rectangular region is generated between revisions to support diff
148  generation.  generation.
149  .SH "FILES"  .SH "FILES"
150  .LP  .LP
151  .TP  .TP
152  \fI/usr/local/etc/cvsgraph.conf\fR  \fI${prefix}/etc/cvsgraph.conf\fR
153  Configuration file read for default layout parameters.  Configuration file read for default layout parameters.
154  .SH "AUTHOR"  .SH "AUTHOR"
155  \fBCvsGraph\fR is written and maintained by B. Stultiens.  \fBCvsGraph\fR is written and maintained by B. Stultiens.
156  .br  .br
157  Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and  Send comments and bug reports to \fIcvsgraph@akhphd.au.dk\fR (read the mailnote
158  visit the homepage at:  in the README file first) and visit the homepage at:
159  .br  .br
160  \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.  \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph/\fR.
161  .SH "SEE ALSO"  .SH "SEE ALSO"
162  .BR cvsgraph.conf(5)  .BR cvsgraph.conf(5)
163    

Legend:
Removed from v.1.16  
changed lines
  Added in v.1.27

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0