1CvsGraph(1) CVS/RCS Utilities CvsGraph(1)
2
6 cvsgraph - A CVS/RCS repository grapher
7
9 cvsgraph [options] [file]
10
12 CvsGraph generates images and image maps from CVS/RCS repository files.
13
15 -b Deprecated, use -O'branch_dupbox=-1' for same functionality.
16 -c file
18 Read alternate config from file.
19 -d level
21 Enable debug mode at level. The amount of information is deter‐
22 mined by a bitwise or of the following: 1=config lexer, 2=config
23 parser, 4=rcsfile lexer, 8=rcsfile parser, 16=rcsfile structure.
24 The level argument may be in decimal, octal or hexadecimal for‐
25 mat.
26 -h A brief description of possible options.
28 -i Generate an image map instead of an image.
30 -I file
32 Also write an image map to file. This can be useful if you want
33 to generate both image and image map simultaneously. This halves
34 the total time spent on accessing the repository file because it
35 is parsed only once.
36 However, keeping track of auto-generated files can be a bit of a
37 hack if used in HTTP requests (unless you pass both image and
38 HTML file in one HTTP stream).
39 Note 1: most time is used for the image-drawing routines (actu‐
40 ally libgd), so you might want to think twice in CGI apps.
41 Note 2: you can still use '-o' to specify an output file for the
42 image. And, if you also specify '-i', then you'll get two image
43 maps, for whatever purpose that might be.
44 -k Deprecated, use -O'auto_stretch=-1' for same functionality.
46 This function is not stable.
47 -M name
49 Deprecated, use -O'map_name="AMapName"' for same functionality.
50 -m mod Use mod as the CVS module. This option overrides cvsmodule in
52 the configuration file.
53 -O cfg_option=value[;opt=val[...]]
55 Set cfg_option to value. Multiple -O are allowed as well as mul‐
56 tiple options can be set simultaneously by separating them with
57 ';'. See cvsgraph.conf(5) for a detailed list of options. See
58 also CONFIGURATION below.
59 -o file
61 Output to file. Otherwise, output is written to standard output.
62 -q Be quiet (i.e. no warnings)
64 -r path
66 Use path as the CVS root. This option overrides cvsroot in the
67 configuration file.
68 -s Deprecated, use -O'strip_untagged=-1' for same functionality.
70 -S Deprecated, use -O'strip_first_rev=-1' for same functionality.
72 -u Deprecated, use -O'upside_down=-1' for same functionality.
74 -V Print version and exit.
76 -x {3,4,x}
78 Set the HTML level of compliance for image maps. Use 3 for HTML
79 3.x, 4 for HTML 4.x and x for XHTML. Default is HTML 3.x compat‐
80 ibility.
81 -[0-9] txt
83 Use txt for expansion
84
86 CvsGraph starts with reading a configuration file. If the '-c' option
87 is given on the command line, then it is read. Otherwise, cvsgraph
88 first looks for a configuration file in the current directory using
89 ./cvsgraph.conf and, if not found, tries to open /etc/cvsgraph.conf.
90 Defaults and command line overrides will be used if no configuration
91 file can be opened. The format of the configuration file is described
92 in cvsgraph.conf(5). Configuration parameters entered on the command
93 line have always precedence over the configuration file. Configuration
94 options are processed in the following order:
95 - configuration file
96 - '-O' command line options
97 - other command line overrides (-bkMmrSsu)
98 If you do not want to process any configuration file, then you can set
99 option ´-c /dev/null', which will read an empty configuration file.
100 The location of a repository file is determined by the configuration
102 parameters cvsroot and cvsmodule and the respective command line
103 options '-r' and '-m'. The cvsroot, cvsmodule and file are concate‐
104 nated with separating '/' path-separators forming the final location:
105 <cvsroot>/<cvsmodule>/file
106 No path-separator is appended if cvsroot and cvsmodule are empty
107 strings. An error message is issued if the resulting path cannot be
108 opened. Note that cvsgraph does not attempt to check any validity of
109 the path components. This enables a user to open any file on the
110 file-system by setting cvsroot and cvsmodule to empty strings.
111 For example, cvsgraph -r '' -m '' ../myfile,v would try to open the
112 file ../myfile,v. Note that a variety of possibilities yield the same
113 file and all have their advantages and drawbacks, which are mostly
114 related to the possible use of the parameters in text expansions.
115 If no file is given on the command line, then input is read from stan‐
117 dard input. This can make expansion strings somewhat strange looking,
118 but they are composed with the information available. If no input file
119 was given, then the input filename for expansion is set to <stdin>.
120
123 The output generated by cvsgraph can be either an image (default) or
124 and HTML image map ('-i' and '-I' options).
125 Images can have several formats, depending on the capabilities of the
126 gd library on which the drawing is built. The configuration allows for
127 GIF, PNG or JPEG type images. Some recent versions of gd do no longer
128 support GIF and PNG will be used instead. GIF support in gd was added
129 again after the lzw patent expired.
130 Generation of image maps conforms to the HTML standard and maps rectan‐
131 gular regions of the image where revisions and branches are drawn.
132 Additionally, an extra rectangular region is generated between revi‐
133 sions to support diff generation.
134
136 /etc/cvsgraph.conf
137 Configuration file read for default layout parameters.
138
140 CvsGraph is written and maintained by B. Stultiens.
141 Send comments and bug reports to cvsgraph@akhphd.au.dk (read the mail‐
142 note in the README file first) and visit the homepage at:
143 http://www.akhphd.au.dk/~bertho/cvsgraph/.
144
146 cvsgraph.conf(5)
147B. Stultiens 1.6.1 CvsGraph(1)