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

Annotate of /cvsgraph/cvsgraph.conf.5

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


Revision 1.33 - (hide annotations)
Thu Sep 8 22:14:22 2005 UTC (12 years, 1 month ago) by bertho
Branch: MAIN
Changes since 1.32: +1 -1 lines
From Mark Brown <broonie {at} sirena.org.uk>: The enclosed typo fix was filed with
the Debian bug tracking system - seems straightfoward and valid.
1 bertho 1.31 .TH "cvsgraph.conf" "5" "1.5.2" "B. Stultiens" "CVS/RCS Utilities"
2 bertho 1.1 .SH "NAME"
3     cvsgraph.conf \- CVS/RCS repository grapher configuration
4     .SH "OVERVIEW"
5     The configuration file is a context free grammar where
6     empty lines and whitespace are ignored. Comments start
7     with '#' and everything until end of line is ignored.
8     .br
9     A configuration parameter is written as:
10     .br
11     <keyword> = <argument> ;
12     .br
13     .LP
14     Keywords are defined in \fBPARAMETERS\fR. The argument
15     can be either numerical or string typed.
16    
17     .LP
18     Numbers may be entered as octal, decimal or hex as in 0117,
19 bertho 1.7 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 bertho 1.1
23     .LP
24     Strings are C\-style strings, enclosed in double quotes
25     in which characters may be escaped with '\\' and written
26     in octal and hex escapes. Note that '\\' must be escaped
27 bertho 1.6 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 bertho 1.1 .br
30     Some strings are expanded with printf like conversions
31     which start with '%'. Not all are applicable at all times,
32     in which case they will expand to nothing.
33 bertho 1.3 .br
34     Note that expansions of paths are available with and without
35     trailing '/'. The distinction is required for path construction
36     to ensure that empty expansions will not redirect the path to
37     root and no double '/' in a path is generated.
38 bertho 1.1 .TP
39     %c
40 bertho 1.27 CVS root including a trailing '/' if non\-empty
41 bertho 1.3 .TP
42     %C
43 bertho 1.27 CVS root without trailing '/', regardless of how it was entered
44     on the command line
45 bertho 1.1 .TP
46     %m
47 bertho 1.27 CVS module including trailing '/' if non\-empty
48 bertho 1.3 .TP
49     %M
50 bertho 1.27 CVS module without trailing '/', regardless of how it was entered
51     on the command line
52 bertho 1.1 .TP
53     %f
54 bertho 1.3 filename without path (\fIbasename <name>\fR functionality)
55 bertho 1.1 .TP
56     %F
57 bertho 1.3 filename without path and with ",v" stripped (\fIbasename <name> ,v\fR
58     functionality)
59 bertho 1.1 .TP
60     %p
61 bertho 1.3 path part of filename. This includes a trailing '/' if the
62     path is non\-empty
63 bertho 1.1 .TP
64     %r
65     number of revisions
66     .TP
67     %b
68     number of branches
69     .TP
70     %%
71 bertho 1.6 literal '%'
72 bertho 1.1 .TP
73     %R
74     the revision number (e.g. '1.2.4.4')
75     .TP
76     %P
77     previous revision number
78     .TP
79     %B
80     the branch number (e.g. '1.2.4')
81     .TP
82     %d
83     date of revision
84     .TP
85     %a
86     author of revision
87     .TP
88     %s
89     state of revision
90     .TP
91 bertho 1.9 %l
92 bertho 1.27 The log entry of the revision. You need to enable \fBparse_logs\fR for this to
93 bertho 1.9 work. You may append an optional truncate length by writing '[num]' (with num
94 bertho 1.27 the maximum length) directly after %l. If no truncation is specified, then all
95 bertho 1.9 will be expanded. Specifying a negative truncation length means that newlines
96     should be replaced by spaces. If truncation occurs, then "..." will be
97 bertho 1.27 appended. The expansion is scanned for possible HTML entities and are replaced
98 bertho 1.9 by &#...; equivalents.
99     .br
100     For example: "%l[25]" will expand up to 25 characters of the log.
101 bertho 1.14 .br
102     Note: This expansion is obsolete. Please use "%(%L%)"; see comment below.
103 bertho 1.9 .TP
104     %L
105 bertho 1.27 Same as %l, but no HTML entity translations are performed.
106 bertho 1.9 .TP
107 bertho 1.1 %t
108     current tag of branch or revision
109     .TP
110     %0..%9
111     command\-line argument \-0 .. \-9
112 bertho 1.14 .TP
113     %(...%)
114 bertho 1.27 HTMLize the string withing the parenthesis. This is useful to prevent a
115     possible cross site scripting bug when expanding tags into the map generation.
116     For an exploit, you need to have an attack on your CVS server, or you need to
117 bertho 1.14 be a complete idiot to enter a tag with '<', '>' or '"' characters.
118     .br
119     Example: a string "%(%t%)", with tag \fB><script xxx="..."><\fR will expand to
120     \fB&gt;&lt;script xxx=&#34;...&#34;&gt;&lt;\fR and not into the execution of
121     a script.
122     .br
123     Note: This method is preferred to the %l expansion, because it is more
124     generic solution (i.e. use "%(%L%)" for log expansions).
125 bertho 1.1
126     .LP
127 bertho 1.6 Fonts are numbered 0..4 (as defined in libgd) where
128 bertho 1.1 0 = tiny, 1 = small, 2 = medium (bold), 3 = large and
129     4 = giant.
130    
131     .LP
132 bertho 1.27 Colors are strings, similar to HTML type colors in the form
133     "#rrggbb" with parts written in hex, where rr = red (00\-ff),
134 bertho 1.1 gg = green (00\-ff) and bb = blue (00\-ff).
135    
136     .LP
137 bertho 1.8 Booleans have three possible arguments: true, false and not. `Not' means
138     inverse of what it was (logical negation) and is represented by the value -1.
139     For the configuration file that means that the default value is negated.
140 bertho 1.27 However, the not possibility is a very handy tool for command line overrides
141     generated from (CGI) scripts.
142 bertho 1.8
143     .LP
144 bertho 1.1 There are several reserved words besides of the keywords.
145     These additional reserved words expand to numerical values:
146     .br
147     Booleans:
148     .br
149     false = 0
150     .br
151     true = 1
152     .br
153 bertho 1.8 not = -1
154     .br
155 bertho 1.1 Alignment specifiers:
156     .br
157     left = 0
158     .br
159     center = 1
160     .br
161     right = 2
162     .br
163     Image specifiers:
164     .br
165     gif = 0
166     .br
167     png = 1
168     .br
169     jpeg = 2
170     .br
171     Font specifiers:
172     .br
173     tiny = 0
174     .br
175     small = 1
176     .br
177     medium = 2
178     .br
179     large = 3
180     .br
181     giant = 4
182     .br
183 bertho 1.13 HTML level specifiers:
184     .br
185     HTML3 = 1
186     .br
187     HTML4 = 2
188     .br
189     XHTML = 3
190     .br
191 bertho 1.1
192     .SH "PARAMETERS"
193     .TP
194     \fBcvsroot\fR \fIstring\fR
195 bertho 1.27 The absolute base directory where the CVS/RCS repository can be found.
196 bertho 1.1 A '/' will be appended to the string if it is not empty and does not
197     contain a trailing '/'.
198     .br
199     Default is an empty string.
200    
201     .TP
202     \fBcvsmodule\fR \fIstring\fR
203 bertho 1.27 The module name in the CVS/RCS repository. This is converted into a
204 bertho 1.1 subdirectory name with a trailing '/'.
205     .br
206     Default is an empty string.
207    
208     .TP
209     \fBcolor_bg\fR \fIcolor\fR
210     The background color of the image.
211     .br
212     Default is white ("#ffffff").
213    
214     .TP
215 bertho 1.7 \fBtransparent_bg\fR \fIboolean\fR
216     The background color of the image is to be the transparent color. This is
217 bertho 1.27 only useful for PNG images. Be sure to set \fBcolor_bg\fR to something
218 bertho 1.7 reasonable to make sure that the image is viewable with programs that do not
219     support transparency.
220     .br
221     Default is false.
222    
223     .TP
224 bertho 1.1 \fBdate_format\fR \fIstring\fR
225     The \fBstrftime(3)\fR format string for date and time representation in
226     the '%d' expansion.
227     .br
228     Default is "%d\-%b\-%Y %H:%M:%S".
229    
230     .TP
231 bertho 1.5 \fBbox_shadow\fR \fIboolean\fR
232 bertho 1.1 A boolean whether or not to draw a shadow for the boxes of
233     revisions and branches.
234     .br
235     Default is false.
236    
237     .TP
238 bertho 1.5 \fBupside_down\fR \fIboolean\fR
239     Draw the entire tree upside down if set. I.e. highest revisions are
240 bertho 1.14 at the top of the image. See also \fBcvsgraph(1)\fR option '\fB-u\fR'.
241 bertho 1.5 .br
242     Default is false.
243    
244     .TP
245 bertho 1.10 \fBleft_right\fR \fIboolean\fR
246     Draw the entire tree from left to right instead of top down if set.
247     I.e. highest revisions are at the right of the image. You can also
248     draw the tree right to left when \fBupside_down\fR is set too.
249     .br
250     Default is false.
251    
252     .TP
253 bertho 1.5 \fBstrip_untagged\fR \fIboolean\fR
254 bertho 1.27 Omit all revisions that do not have tags and are not a branch point. This
255 bertho 1.6 reduces the image-size, but can be confusing when looking for a specific
256 bertho 1.14 revision. See also \fBcvsgraph(1)\fR option '\fB-s\fR'.
257 bertho 1.6 .br
258     Default is false.
259    
260     .TP
261     \fBstrip_first_rev\fR \fIboolean\fR
262 bertho 1.27 Also omit the first revision in a branch if it does not have tags and is not a
263     branch point. This has only effect if \fBstrip_untagged\fR is set. See also
264 bertho 1.14 \fBcvsgraph(1)\fR option '\fB-S\fR'.
265 bertho 1.6 .br
266     Default is false.
267    
268     .TP
269 bertho 1.7 \fBauto_stretch\fR \fIboolean\fR
270 bertho 1.6 Try to stretch the inter\-revision spacing to move the trunks more to the left,
271 bertho 1.14 effectively reducing the image's size. See also \fBcvsgraph(1)\fR option '\fB-k\fR'.
272 bertho 1.5 .br
273     Default is false.
274    
275     .TP
276 bertho 1.7 \fBuse_ttf\fR \fIboolean\fR
277 bertho 1.27 Enable TrueType rendering of strings using the FreeType interface of libgd.
278 bertho 1.7 Note that ttf rendering is significantly slower than libgd's bitmap fonts.
279     .br
280     Default is false.
281    
282     .TP
283     \fBanti_alias\fR \fIboolean\fR
284 bertho 1.27 Enable antialias rendering of TrueType fonts. This has only effect if
285 bertho 1.7 \fBuse_ttf\fR is set. Enabling anti_alias gives very nice results.
286     However, that is at the expense of 8-bit vs. 4-bit colormap images,
287     which can be a major drawback because the size of 8-bit images is 3..4
288     times that of 4-bit images (with compressed PNG as output).
289     .br
290     Default is true.
291 bertho 1.8
292     .TP
293     \fBthick_lines\fR \fInumber\fR
294     Set the thickness of connector lines between boxes. Normally, lines
295     are drawn one pixel wide, but can look somewhat thin. Setting the thickness
296 bertho 1.27 to anything over 5 would be plain ugly (but hey, who is to debate taste :-).
297 bertho 1.8 Values less than 1 and over 11 are clipped.
298     .br
299     Default is 1.
300 bertho 1.9
301     .TP
302     \fBparse_logs\fR \fIboolean\fR
303     Enable the parsing of the \fIentire\fR ,v file to read the log-entries between
304     revisions. This is necessary for the %l expansion to work, but slows down
305     parsing by a very large factor. You've been warned.
306     .br
307     Default is false.
308 bertho 1.13
309     .TP
310     \fBhtml_level\fR \fInumber\fR
311     Set the compliance to different types of HTML. The generated image map is
312     slightly different for version 3.x, 4.x and XHTML. You can use the predefined
313 bertho 1.27 identifiers (HTML3, HTML4 and XHTML) to set this value. Command line option
314 bertho 1.33 \&'\fB-x\fR' overrides the setting.
315 bertho 1.13 .br
316     Default is HTML3 (3.x compatibility).
317 bertho 1.7
318     .TP
319     \fBbranch_ttfont\fR \fIstring\fR
320     .TP
321     \fBbranch_tag_ttfont\fR \fIstring\fR
322     .TP
323     \fBrev_ttfont\fR \fIstring\fR
324     .TP
325     \fBrev_text_ttfont\fR \fIstring\fR
326     .TP
327     \fBtag_ttfont\fR \fIstring\fR
328     .TP
329     \fBtitle_ttfont\fR \fIstring\fR
330 bertho 1.24 .TP
331     \fBmsg_ttfont\fR \fIstring\fR
332 bertho 1.27 Set the TrueType font face or filename for the individual elements. Gd's bitmap
333 bertho 1.7 fonts are used as a fallback if the font cannot be found or contains errors.
334     .br
335     Default none.
336    
337     .TP
338     \fBbranch_ttsize\fR \fIfloat\fR
339     .TP
340     \fBbranch_tag_ttsize\fR \fIfloat\fR
341     .TP
342     \fBrev_ttsize\fR \fIfloat\fR
343     .TP
344     \fBrev_text_ttsize\fR \fIfloat\fR
345     .TP
346     \fBtag_ttsize\fR \fIfloat\fR
347     .TP
348     \fBtitle_ttsize\fR \fIfloat\fR
349 bertho 1.24 .TP
350     \fBmsg_ttsize\fR \fIfloat\fR
351 bertho 1.27 Set the TrueType font size for the individual elements. See also *_ttfont.
352 bertho 1.7 .br
353     Default 0.0.
354    
355     .TP
356 bertho 1.1 \fBtag_font\fR \fInumber\fR
357     The font used to draw tags in the revision boxes.
358     .br
359     Default is tiny.
360    
361     .TP
362     \fBtag_color\fR \fIcolor\fR
363     The color used to draw tags in the revision boxes.
364     .br
365     Default is black ("#000000").
366    
367     .TP
368 bertho 1.20 \fBtag_ignore\fR \fIstring\fR
369     An extended regular expression as described in \fBregex(7)\fR to match all tags
370     that should not be displayed in the graph. Note that a tag will always be
371     displayed if it matches the \fBmerge_from\fR/\fBmerge_to\fR expressions
372     regardless to it being set to ignore here.
373     .br
374     Example: tag_ignore = "(test|alpha)_release.*";
375     .br
376     Default is empty (no matching occurs).
377    
378     .TP
379     \fBtag_nocase\fR \fIboolean\fR
380     Ignore the case in regex matching in \fBtag_ignore\fR.
381     .br
382     Default is false.
383    
384     .TP
385 bertho 1.23 \fBtag_negate\fR \fIboolean\fR
386     Negate the matching criteria of the \fBtag_ignore\fR setting. If set, tags that
387     match the \fBtag_ignore\fR will be shown, instead of matches being ignored. In
388     any case, tags that match \fBmerge_from\fR/\fBmerge_to\fR expressions will
389     never be suppressed.
390     .br
391     Default is false.
392    
393     .TP
394 bertho 1.25 \fBtag_ignore_merge\fR \fIboolean\fR
395     If set, then tags matched with \fBtag_ignore\fR will no longer be considered
396     for matching by \fBmerge_from\fR and \fBmerge_to\fR.
397     .br
398     Default is false.
399    
400     .TP
401 bertho 1.1 \fBrev_font\fR \fInumber\fR
402     .br
403     Default is tiny.
404    
405     .TP
406     \fBrev_color\fR \fIcolor\fR
407     The color of revision boxes, including the revision number.
408     .br
409     Default is black ("#000000").
410    
411     .TP
412     \fBrev_bgcolor\fR \fIcolor\fR
413     Revision box background color. This is the interior fill of the
414     box.
415     .br
416     Default is white ("#ffffff").
417    
418     .TP
419 bertho 1.7 \fBrev_separator\fR \fInumber\fR
420     Space between tags in revision boxes.
421 bertho 1.1 .br
422     Default is 0.
423    
424     .TP
425     \fBrev_minline\fR \fInumber\fR
426     The minimum vertical distance between revision boxes.
427     .br
428     Default is 0.
429    
430     .TP
431     \fBrev_maxline\fR \fInumber\fR
432     The maximum vertical distance between revision boxes.
433 bertho 1.7 This has only effect if \fBauto_stretch\fR is set to true (or option '\fB-k\fR'
434 bertho 1.6 is specified).
435 bertho 1.1 .br
436 bertho 1.6 Default is 5 times \fBrev_minline\fR.
437 bertho 1.1
438     .TP
439     \fBrev_lspace\fR \fInumber\fR
440     .TP
441     \fBrev_rspace\fR \fInumber\fR
442     .TP
443     \fBrev_tspace\fR \fInumber\fR
444     .TP
445     \fBrev_bspace\fR \fInumber\fR
446 bertho 1.6 Interior spacing in revision boxes of left, right, top and bottom
447 bertho 1.1 respectively. Note that the left right spacing is not used separately
448     because text is center aligned.
449     .br
450     Default is 0.
451    
452     .TP
453     \fBrev_text\fR \fIstring\fR
454     The additional text in a revision box under the revision number.
455     .br
456     Default is "%d".
457    
458     .TP
459     \fBrev_text_font\fR \fInumber\fR
460     The font of the additional text in a revision box under the revision number.
461     .br
462     Default is tiny.
463    
464     .TP
465     \fBrev_text_color\fR \fIcolor\fR
466 bertho 1.12 The font color of the additional text in a revision box under the revision
467     number.
468 bertho 1.1 .br
469     Default is black ("#000000").
470 bertho 1.12
471     .TP
472     \fBrev_maxtags\fR \fInumber\fR
473     Limit the number of tags in a revision box. Old trees tend to have some
474     revisions with extremely many tags attached, which would generate a huge
475     revision box when drawn. Limiting the number is a fair solution. Note that tag
476 bertho 1.14 sorting is not specified in the \fBrcsfile(7)\fR, but \fBcvs(1)\fR will
477     normally have the newest tags located before older ones. Therefore, limiting
478     the number of tags would most likely only affect older tags to be stripped.
479     However, no guarantees are given that a specific tag is present when the limit
480 bertho 1.21 is imposed. An ellipsis (...) is shown in the revision box when the number of
481 bertho 1.14 tags got truncated.
482 bertho 1.12 .br
483     Default is 0, meaning all tags shown.
484 bertho 1.14
485     .TP
486 bertho 1.25 \fBrev_hidenumber\fR \fIboolean\fR
487     If set, then no revision number is displayed in the revisionboxes. This reduces
488     size for those graphs where the actual revision-number is irrelevant.
489     .br
490     Default is false.
491    
492     .TP
493 bertho 1.24 \fBmsg_font\fR \fInumber\fR
494     The font used to draw error and warning messages at the bottom of the graph.
495     .br
496     Default is tiny.
497    
498     .TP
499     \fBmsg_color\fR \fIcolor\fR
500     The color used to draw error and warning messages.
501     .br
502     Default is black ("#000000").
503    
504     .TP
505 bertho 1.14 \fBmerge_color\fR \fIcolor\fR
506     The color of the lines to show merges.
507     .br
508     Default is black ("#000000").
509    
510     .TP
511     \fBmerge_front\fR \fIboolean\fR
512 bertho 1.27 The merge lines are drawn on top of the image if true. Otherwise, merge lines
513 bertho 1.14 are drawn underneath.
514     .br
515     Default is false.
516    
517     .TP
518     \fBmerge_nocase\fR \fIboolean\fR
519 bertho 1.20 Ignore the case in regex matching in \fBmerge_from\fR and \fBmerge_to\fR.
520 bertho 1.14 .br
521     Default is false.
522    
523     .TP
524     \fBmerge_from\fR \fIstring\fR
525     The \fBmerge_from\fR is an extended regular expression as described in
526     \fBregex(7)\fR and POSIX 1003.2 (see also Single Unix Specification at
527     http://www.opengroup.com ). The matching tags describe source revisions of
528     merges. Each match is subsequently used in a search for the destination tag as
529     described by the \fBmerge_to\fR parameter.
530     .br
531     Note: normal string rules apply. Therefore, all backslashes '\\' must be
532     escaped, e.g. "\\." must be written as "\\\\.".
533     .br
534     Example: merge_from = "^from_(.*)";
535     .br
536     Default is empty (no matching occurs).
537    
538     .TP
539     \fBmerge_to\fR \fIstring\fR
540     .br
541     The \fBmerge_to\fR is an extended regular expression with a twist. All
542     subexpressions from the \fBmerge_from\fR are expanded into \fBmerge_to\fR using
543     %[1-9] (in contrast to \\[1-9] for backreferences). Care is taken to escape
544     the constructed expression. A '$' at the end of the \fBmerge_to\fR expression
545     can be important to prevent 'near match' references. Normally, you want the
546     destination to be a good representation of the source. However, this depends
547     on how well you defined the tags in the first place.
548     .br
549     Example: merge_to = "^merge_%1$";
550     .br
551     Above example, combined with the merge_from example would match a tag
552     "from_BugFix_2002" to the merge-destination with tag "merge_BugFix_2002".
553     .br
554     Default is empty (no matching occurs).
555 bertho 1.25
556     .TP
557     \fBmerge_findall\fR \fIboolean\fR
558     Normally, \fBmerge_from\fR/m\fBerge_to\fR will only find the first matching
559     tag-combination and draw a line between them, If \fBmerge_findall\fR is set,
560     then all matching \fBmerge_to\fRs will result in lines from the from-tag to the
561     to-tag.
562     .br
563     Default is false.
564 bertho 1.1
565     .TP
566 bertho 1.18 \fBmerge_arrows\fR \fIboolean\fR
567     .br
568     Enable the use of arrows pointing to the merge destination.
569     .br
570     Default is true.
571    
572     .TP
573 bertho 1.28 \fBmerge_cvsnt\fR \fIboolean\fR
574     .br
575     Enable drawing of mergepoints as used by CVSNT.
576     .br
577     Default is true.
578    
579     .TP
580     \fBmerge_cvsnt_color\fR \fIcolor\fR
581     The color of the lines to show merges from mergepoints.
582     .br
583     Default is black ("#000000").
584    
585     .TP
586 bertho 1.18 \fBarrow_width\fR \fInumber\fR
587     .TP
588     \fBarrow_length\fR \fInumber\fR
589     .br
590     Specifies the size of the arrow pointing to the merge destination.
591     .br
592     Default is arrow_width=3, arrow_length=12.
593    
594     .TP
595 bertho 1.1 \fBbranch_font\fR \fInumber\fR
596 bertho 1.7 The font of the number in a branch box.
597     .br
598     Default is tiny.
599    
600     .TP
601     \fBbranch_tag_font\fR \fInumber\fR
602     The font of the tags in a branch box.
603 bertho 1.1 .br
604     Default is tiny.
605    
606     .TP
607     \fBbranch_color\fR \fIcolor\fR
608 bertho 1.7 All branch element's color excluding tags.
609     .br
610     Default is black ("#000000").
611    
612     .TP
613     \fBbranch_tag_color\fR \fIcolor\fR
614     All branch tags' color.
615 bertho 1.1 .br
616     Default is black ("#000000").
617    
618     .TP
619     \fBbranch_lspace\fR \fInumber\fR
620     .TP
621     \fBbranch_rspace\fR \fInumber\fR
622     .TP
623     \fBbranch_tspace\fR \fInumber\fR
624     .TP
625     \fBbranch_bspace\fR \fInumber\fR
626     Interior spacing of branch boxes.
627     .br
628     Default is 0.
629    
630     .TP
631     \fBbranch_margin\fR \fInumber\fR
632     Exterior spacing of branches. Each branch will be spaced
633     with a minimum of this value.
634     .br
635     Default is 0.
636    
637     .TP
638     \fBbranch_connect\fR \fInumber\fR
639     Length of the vertical connector from a revision to the branch box.
640     .br
641     Default is 0.
642 bertho 1.5
643     .TP
644 bertho 1.6 \fBbranch_dupbox\fR \fIboolean\fR
645     Add an extra branch box at the end of the trunk. Useful for upside down drawn
646 bertho 1.15 trees. If there are no commits on a branch, then no extra box is added,
647     regardless of the setting of this option.
648 bertho 1.5 .br
649     Default is false.
650 bertho 1.15
651     .TP
652     \fBbranch_fold\fR \fIboolean\fR
653     Fold branches that have no commits into one branch-box. This helps to reduce
654     the size of the overall image by a huge factor (5..10 in most cases). Many
655     applications of CVS use many branches, but not all files in the repository
656     change for each branch. Especially stable files line .cvsignore or older code
657     tend to accumulate many empty branches at one and the same revision. Folding
658     these branches into one box reduces the width of these images considerably.
659     .br
660     Default is true.
661 bertho 1.1
662     .TP
663 bertho 1.16 \fBbranch_foldall\fR \fIboolean\fR
664     Fold all empty branches that sprout from the save revision in one box. If
665     this option is not set, then multiple boxes will be created if the empty
666     branches are interspaced with ones that have revisions attached. When this
667     option is set, then all empty branches will be collected and put into the
668 bertho 1.27 box of the first occurring empty branch on the revision's branch point.
669     Setting this option will reduce image size with interspaced commits to the
670 bertho 1.16 a maximum.
671     .br
672     Default is false.
673    
674     .TP
675 bertho 1.26 \fBbranch_resort\fR \fIboolean\fR
676     Resort the branches according to the number of revisions they have, where less
677     revisions will stick closer to the sprouting trunk. This will reduce image size
678     under circumstances where many branches have significant different number of
679     revisions.
680     .br
681     Default is false.
682    
683     .TP
684 bertho 1.24 \fBbranch_subtree\fR \fIstring\fR
685     Reduce the tree only to include the subtree from the branch-number given in the
686     argument. If the argument is a revision which is the root of branches, then all
687     those branches will be shown. The argument can also be a symbolic tag (either a
688     branch- or revision-tag). You normally would set this option from the
689 bertho 1.27 command line with the -O option for interactive flexibility.
690 bertho 1.24 .br
691     Example: branch_subtree = "1.2.4";
692     .br
693     Default is empty (all branches shown).
694    
695     .TP
696 bertho 1.1 \fBtitle\fR \fIstring\fR
697     The title of the image.
698     .br
699     Default is empty string.
700    
701     .TP
702     \fBtitle_x\fR \fInumber\fR
703     .TP
704     \fBtitle_y\fR \fInumber\fR
705 bertho 1.27 Position of title.
706 bertho 1.1 .br
707     Default is 0.
708    
709     .TP
710     \fBtitle_font\fR \fInumber\fR
711     The font of the title.
712     .br
713     Default is tiny.
714    
715     .TP
716     \fBtitle_align\fR \fInumber\fR
717     Horizontal alignment of the title.
718     .br
719     Default is left.
720    
721     .TP
722     \fBtitle_color\fR \fIcolor\fR
723     The color of the title.
724     .br
725     Default is black ("#000000").
726    
727     .TP
728     \fBmargin_top\fR \fInumber\fR
729     .TP
730     \fBmargin_bottom\fR \fInumber\fR
731     .TP
732     \fBmargin_left\fR \fInumber\fR
733     .TP
734     \fBmargin_right\fR \fInumber\fR
735     Margins of the image. Note: the title position is not affected by
736     the margin.
737     .br
738     Default is 0.
739    
740     .TP
741     \fBimage_type\fR \fInumber\fR
742     Image types are available if they can be found in
743     the gd library. Newer versions of gd do not have
744     gif anymore. CvsGraph will automatically generate
745     png images instead.
746     .br
747     Default is dependent on availability and is prioritized in the order
748     png, gif and jpeg.
749    
750     .TP
751     \fBimage_quality\fR \fInumber\fR
752     The quality of a jpeg image (1..100)
753     .br
754     Default is 100.
755    
756     .TP
757 bertho 1.29 \fBimage_compress\fR \fInumber\fR
758     Set the compression level of png images (-1..9). Zero means no compression. A
759     higher number means higher compression. Minus one selects the default library
760     setting.
761     .br
762     Default is -1.
763    
764     .TP
765     \fBimage_interlace\fR \fIboolean\fR
766     Write png and jpeg images in interlaced format. This enables progressive
767     loading in your browser (if supported).
768     .br
769     Default is false.
770    
771     .TP
772 bertho 1.1 \fBmap_name\fR \fIstring\fR
773     The name= attribute in <map name="mapname">...</map> in the
774     generated HTML map.
775     .br
776     Default is "CvsGraphImageMap".
777    
778     .TP
779     \fBmap_branch_href\fR \fIstring\fR
780     .TP
781     \fBmap_rev_href\fR \fIstring\fR
782     .TP
783     \fBmap_diff_href\fR \fIstring\fR
784 bertho 1.24 .TP
785     \fBmap_merge_href\fR \fIstring\fR
786 bertho 1.1 These are the href= attributes in the <area>
787 bertho 1.27 tags of HTML.
788 bertho 1.1 .br
789 bertho 1.6 Default are:
790 bertho 1.1 .br
791     branch: "href=\\"unset: conf.map_branch_href\\""
792     .br
793     revision: "href=\\"unset: conf.map_rev_href\\""
794     .br
795     diff: "href=\\"unset: conf.map_diff_href\\""
796 bertho 1.24 .br
797     merge: "href=\\"unset: conf.map_merge_href\\""
798 bertho 1.1
799     .TP
800     \fBmap_branch_alt\fR \fIstring\fR
801     .TP
802     \fBmap_rev_alt\fR \fIstring\fR
803     .TP
804     \fBmap_diff_alt\fR \fIstring\fR
805 bertho 1.24 .TP
806     \fBmap_merge_alt\fR \fIstring\fR
807 bertho 1.1 These are the alt= attributes in the <area>
808 bertho 1.27 tags of HTML.
809 bertho 1.1 .br
810 bertho 1.24 Default are "alt=\\"%B\\"", "alt=\\"%R\\"",
811     "alt=\\"%P &lt;\-&gt; %R\\"" and "alt=\\"%P &lt;\-&gt; %R\\"" respectively.
812 bertho 1.1
813     .SH "AUTHOR"
814     \fBCvsGraph\fR is written and maintained by B. Stultiens.
815     .br
816 bertho 1.32 Send comments and bug reports to \fIcvsgraph@akhphd.au.dk\fR (read the mailnote
817     in the README file first) and visit the homepage at:
818 bertho 1.3 .br
819 bertho 1.27 \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph/\fR.
820 bertho 1.1 .SH "SEE ALSO"
821     .BR cvsgraph(1)

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0