/[CvsGraph]/cvsgraph/cvsgraph.conf.5
ViewVC logotype

Diff of /cvsgraph/cvsgraph.conf.5

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

revision 1.4, Tue Nov 20 15:25:09 2001 UTC revision 1.8, Thu Feb 14 23:18:10 2002 UTC
# Line 1  Line 1 
1  .TH "cvsgraph.conf" "5" "1.1.3" "B. Stultiens" "CVS/RCS Utilties"  .TH "cvsgraph.conf" "5" "1.2.0" "B. Stultiens" "CVS/RCS Utilties"
2  .SH "NAME"  .SH "NAME"
3  cvsgraph.conf \- CVS/RCS repository grapher configuration  cvsgraph.conf \- CVS/RCS repository grapher configuration
4  .SH "OVERVIEW"  .SH "OVERVIEW"
# Line 16  Line 16 
16    
17  .LP  .LP
18  Numbers may be entered as octal, decimal or hex as in 0117,  Numbers may be entered as octal, decimal or hex as in 0117,
19  79 and 0x4f respectively.  79 and 0x4f respectively. Floating point numbers contain a
20    single '.', but must start with a digit. Integer numbers are
21    automagically converted to floats if required.
22    
23  .LP  .LP
24  Strings are C\-style strings, enclosed in double quotes  Strings are C\-style strings, enclosed in double quotes
25  in which characters may be escaped with '\\' and written  in which characters may be escaped with '\\' and written
26  in octal and hex escapes. Note that '\\' must be escaped  in octal and hex escapes. Note that '\\' must be escaped
27  if it is to be entered as a character.  if it is to be entered as a character. Escapes recognized
28    are '\\[abfnrtv]', '\\[xX][0-9a-fA-F]{2}' and '\\[012][0-7]{0,2}'.
29  .br  .br
30  Some strings are expanded with printf like conversions  Some strings are expanded with printf like conversions
31  which start with '%'. Not all are applicable at all times,  which start with '%'. Not all are applicable at all times,
# Line 65  Line 68 
68  number of branches  number of branches
69  .TP  .TP
70  %%  %%
71  \'%\'  literal '%'
72  .TP  .TP
73  %R  %R
74  the revision number (e.g. '1.2.4.4')  the revision number (e.g. '1.2.4.4')
# Line 92  Line 95 
95  command\-line argument \-0 .. \-9  command\-line argument \-0 .. \-9
96    
97  .LP  .LP
98  Fonts are numbered 0..4 (defined as in libgd) where  Fonts are numbered 0..4 (as defined in libgd) where
99  0 = tiny, 1 = small, 2 = medium (bold), 3 = large and  0 = tiny, 1 = small, 2 = medium (bold), 3 = large and
100  4 = giant.  4 = giant.
101    
# Line 102  Line 105 
105  gg = green (00\-ff) and bb = blue (00\-ff).  gg = green (00\-ff) and bb = blue (00\-ff).
106    
107  .LP  .LP
108    Booleans have three possible arguments: true, false and not. `Not' means
109    inverse of what it was (logical negation) and is represented by the value -1.
110    For the configuration file that means that the default value is negated.
111    However, the not possibility is a very handy tool for commandline overrides
112    generated from (CGI-)scripts.
113    
114    .LP
115  There are several reserved words besides of the keywords.  There are several reserved words besides of the keywords.
116  These additional reserved words expand to numerical values:  These additional reserved words expand to numerical values:
117  .br  .br
# Line 111  Line 121 
121  .br  .br
122          true   = 1          true   = 1
123  .br  .br
124            not    = -1
125    .br
126  Alignment specifiers:  Alignment specifiers:
127  .br  .br
128          left   = 0          left   = 0
# Line 163  Line 175 
175  Default is white ("#ffffff").  Default is white ("#ffffff").
176    
177  .TP  .TP
178    \fBtransparent_bg\fR \fIboolean\fR
179    The background color of the image is to be the transparent color. This is
180    only usefull for PNG images. Be sure to set \fBcolor_bg\fR to something
181    reasonable to make sure that the image is viewable with programs that do not
182    support transparency.
183    .br
184    Default is false.
185    
186    .TP
187  \fBdate_format\fR \fIstring\fR  \fBdate_format\fR \fIstring\fR
188  The \fBstrftime(3)\fR format string for date and time representation in  The \fBstrftime(3)\fR format string for date and time representation in
189  the '%d' expansion.  the '%d' expansion.
# Line 170  Line 191 
191  Default is "%d\-%b\-%Y %H:%M:%S".  Default is "%d\-%b\-%Y %H:%M:%S".
192    
193  .TP  .TP
194  \fBbox_shadow\fR \fInumber\fR  \fBbox_shadow\fR \fIboolean\fR
195  A boolean whether or not to draw a shadow for the boxes of  A boolean whether or not to draw a shadow for the boxes of
196  revisions and branches.  revisions and branches.
197  .br  .br
198  Default is false.  Default is false.
199    
200  .TP  .TP
201    \fBupside_down\fR \fIboolean\fR
202    Draw the entire tree upside down if set. I.e. highest revisions are
203    at the top of the image. See also cvsgraph(1) option '\fB-u\fR'.
204    .br
205    Default is false.
206    
207    .TP
208    \fBstrip_untagged\fR \fIboolean\fR
209    Ommit all revisions that do not have tags and are not a branchpoint. This
210    reduces the image-size, but can be confusing when looking for a specific
211    revision. See also cvsgraph(1) option '\fB-s\fR'.
212    .br
213    Default is false.
214    
215    .TP
216    \fBstrip_first_rev\fR \fIboolean\fR
217    Also ommit the first revision in a branch if it does not have tags and is not a
218    branchpoint. This has only effect if \fBstrip_untagged\fR is set. See also
219    cvsgraph(1) option '\fB-S\fR'.
220    .br
221    Default is false.
222    
223    .TP
224    \fBauto_stretch\fR \fIboolean\fR
225    Try to stretch the inter\-revision spacing to move the trunks more to the left,
226    effectively reducing the image's size. See also cvsgraph(1) option '\fB-k\fR'.
227    .br
228    Default is false.
229    
230    .TP
231    \fBuse_ttf\fR \fIboolean\fR
232    Enable truetype rendering of strings using the FreeType interface of libgd.
233    Note that ttf rendering is significantly slower than libgd's bitmap fonts.
234    .br
235    Default is false.
236    
237    .TP
238    \fBanti_alias\fR \fIboolean\fR
239    Enable antialias rendering of truetype fonts. This has only effect if
240    \fBuse_ttf\fR is set. Enabling anti_alias gives very nice results.
241    However, that is at the expense of 8-bit vs. 4-bit colormap images,
242    which can be a major drawback because the size of 8-bit images is 3..4
243    times that of 4-bit images (with compressed PNG as output).
244    .br
245    Default is true.
246    
247    .TP
248    \fBthick_lines\fR \fInumber\fR
249    Set the thickness of connector lines between boxes. Normally, lines
250    are drawn one pixel wide, but can look somewhat thin. Setting the thickness
251    to anything over 5 would be plain ugly (but hey, who is to debate tast:-).
252    Values less than 1 and over 11 are clipped.
253    .br
254    Default is 1.
255    
256    .TP
257    \fBbranch_ttfont\fR \fIstring\fR
258    .TP
259    \fBbranch_tag_ttfont\fR \fIstring\fR
260    .TP
261    \fBrev_ttfont\fR \fIstring\fR
262    .TP
263    \fBrev_text_ttfont\fR \fIstring\fR
264    .TP
265    \fBtag_ttfont\fR \fIstring\fR
266    .TP
267    \fBtitle_ttfont\fR \fIstring\fR
268    Set the truetype font face or filename for the individual elements. Gd's bitmap
269    fonts are used as a fallback if the font cannot be found or contains errors.
270    .br
271    Default none.
272    
273    .TP
274    \fBbranch_ttsize\fR \fIfloat\fR
275    .TP
276    \fBbranch_tag_ttsize\fR \fIfloat\fR
277    .TP
278    \fBrev_ttsize\fR \fIfloat\fR
279    .TP
280    \fBrev_text_ttsize\fR \fIfloat\fR
281    .TP
282    \fBtag_ttsize\fR \fIfloat\fR
283    .TP
284    \fBtitle_ttsize\fR \fIfloat\fR
285    Set the truetype font size for the individual elements. See also *_ttfont.
286    .br
287    Default 0.0.
288    
289    .TP
290  \fBtag_font\fR \fInumber\fR  \fBtag_font\fR \fInumber\fR
291  The font used to draw tags in the revision boxes.  The font used to draw tags in the revision boxes.
292  .br  .br
# Line 207  Line 317 
317  Default is white ("#ffffff").  Default is white ("#ffffff").
318    
319  .TP  .TP
320  rev_separator number  \fBrev_separator\fR \fInumber\fR
321  Obsolete. Space between tags in revision boxes.  Space between tags in revision boxes.
322  .br  .br
323  Default is 0.  Default is 0.
324    
# Line 221  Line 331 
331  .TP  .TP
332  \fBrev_maxline\fR \fInumber\fR  \fBrev_maxline\fR \fInumber\fR
333  The maximum vertical distance between revision boxes.  The maximum vertical distance between revision boxes.
334  NOTE: This parameter is not yet used. It will become  This has only effect if \fBauto_stretch\fR is set to true (or option '\fB-k\fR'
335  significant when autostretch layout are implemented.  is specified).
336  .br  .br
337  Default is 0.  Default is 5 times \fBrev_minline\fR.
338    
339  .TP  .TP
340  \fBrev_lspace\fR \fInumber\fR  \fBrev_lspace\fR \fInumber\fR
# Line 234  Line 344 
344  \fBrev_tspace\fR \fInumber\fR  \fBrev_tspace\fR \fInumber\fR
345  .TP  .TP
346  \fBrev_bspace\fR \fInumber\fR  \fBrev_bspace\fR \fInumber\fR
347  Interior spacing in revision boxes ofleft, right, top and bottom  Interior spacing in revision boxes of left, right, top and bottom
348  respectively. Note that the left right spacing is not used separately  respectively. Note that the left right spacing is not used separately
349  because text is center aligned.  because text is center aligned.
350  .br  .br
# Line 260  Line 370 
370    
371  .TP  .TP
372  \fBbranch_font\fR \fInumber\fR  \fBbranch_font\fR \fInumber\fR
373  The font of the number and tags in a branch box.  The font of the number in a branch box.
374    .br
375    Default is tiny.
376    
377    .TP
378    \fBbranch_tag_font\fR \fInumber\fR
379    The font of the tags in a branch box.
380  .br  .br
381  Default is tiny.  Default is tiny.
382    
383  .TP  .TP
384  \fBbranch_color\fR \fIcolor\fR  \fBbranch_color\fR \fIcolor\fR
385  All branch element's color.  All branch element's color excluding tags.
386    .br
387    Default is black ("#000000").
388    
389    .TP
390    \fBbranch_tag_color\fR \fIcolor\fR
391    All branch tags' color.
392  .br  .br
393  Default is black ("#000000").  Default is black ("#000000").
394    
# Line 296  Line 418 
418  Default is 0.  Default is 0.
419    
420  .TP  .TP
421    \fBbranch_dupbox\fR \fIboolean\fR
422    Add an extra branch box at the end of the trunk. Useful for upside down drawn
423    trees.
424    .br
425    Default is false.
426    
427    .TP
428  \fBtitle\fR \fIstring\fR  \fBtitle\fR \fIstring\fR
429  The title of the image.  The title of the image.
430  .br  .br
# Line 372  Line 501 
501  These are the href= attributes in the <area>  These are the href= attributes in the <area>
502  tags of html.  tags of html.
503  .br  .br
504  Default is:  Default are:
505  .br  .br
506  branch: "href=\\"unset: conf.map_branch_href\\""  branch: "href=\\"unset: conf.map_branch_href\\""
507  .br  .br
# Line 389  Line 518 
518  These are the alt= attributes in the <area>  These are the alt= attributes in the <area>
519  tags of html.  tags of html.
520  .br  .br
521  Default is "alt=\\"%B\\"", "alt=\\"%R\\"" and  Default are "alt=\\"%B\\"", "alt=\\"%R\\"" and
522  "alt=\\"%P <\-> %R\\"" respectively.  "alt=\\"%P &lt;\-&gt; %R\\"" respectively.
523    
524  .SH "AUTHOR"  .SH "AUTHOR"
525  \fBCvsGraph\fR is written and maintained by B. Stultiens.  \fBCvsGraph\fR is written and maintained by B. Stultiens.

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.8

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0