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

Diff of /cvsgraph/cvsgraph.conf.5.in

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

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

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.1.2.2

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0