/[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.36 - (show annotations)
Sat Apr 15 22:07:36 2006 UTC (11 years, 8 months ago) by bertho
Branch: MAIN
Branch point for: svn-integration
Changes since 1.35: +1 -1 lines
- Fix small man type
1 .TH "cvsgraph.conf" "5" "1.6.0" "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 The 'key' can be one of:
180 .TP
181 state
182 State of the revision
183 .TP
184 author
185 The auther of a revision
186 .TP
187 tag
188 both revision- and branch-tags
189 .TP
190 date
191 date of the revision
192 .TP
193 rev
194 numeric revision- or branch-number
195 .LP
196 Both 'truecase' and 'falsecase' can be either a (color-)string,
197 as described above, or a new conditional expression.
198 Examples:
199 .br
200 rev_bgcolor = [ "state" =~ "dead" "#e08080" "#f0f0f0" ];
201 .br
202 branch_color= [ "rev" < "2.1.2" "#000000" [ "tag" =~ "XyZ.*" "#123456" "#654321" ] ];
203 .br
204 rev_idtext = [ "state" == "dead" "Dead %R" "%R" ]
205 .br
206 Note that not all colors can be changed on the fly. For example,
207 branch_color cannot be be changed based on revision identification
208 (i.e. author, date or state). The color_bg is always unique and
209 fixed (all expressions will evaluate to the false case).
210 Also, only string rev_text and rev_idtext can be conditional expressions
211 as other do not make much sense to be dynamic.
212
213 .LP
214 Booleans have three possible arguments: true, false and not. `Not' means
215 inverse of what it was (logical negation) and is represented by the value -1.
216 For the configuration file that means that the default value is negated.
217 However, the not possibility is a very handy tool for command line overrides
218 generated from (CGI) scripts.
219
220 .LP
221 There are several reserved words besides of the keywords.
222 These additional reserved words expand to numerical values:
223 .br
224 Booleans:
225 .br
226 false = 0
227 .br
228 true = 1
229 .br
230 not = -1
231 .br
232 Alignment specifiers:
233 .br
234 left = 0
235 .br
236 center = 1
237 .br
238 right = 2
239 .br
240 Image specifiers:
241 .br
242 gif = 0
243 .br
244 png = 1
245 .br
246 jpeg = 2
247 .br
248 Font specifiers:
249 .br
250 tiny = 0
251 .br
252 small = 1
253 .br
254 medium = 2
255 .br
256 large = 3
257 .br
258 giant = 4
259 .br
260 HTML level specifiers:
261 .br
262 HTML3 = 1
263 .br
264 HTML4 = 2
265 .br
266 XHTML = 3
267 .br
268
269 .SH "PARAMETERS"
270 .TP
271 \fBcvsroot\fR \fIstring\fR
272 The absolute base directory where the CVS/RCS repository can be found.
273 A '/' will be appended to the string if it is not empty and does not
274 contain a trailing '/'.
275 .br
276 Default is an empty string.
277
278 .TP
279 \fBcvsmodule\fR \fIstring\fR
280 The module name in the CVS/RCS repository. This is converted into a
281 subdirectory name with a trailing '/'.
282 .br
283 Default is an empty string.
284
285 .TP
286 \fBcolor_bg\fR \fIcolor\fR
287 The background color of the image.
288 .br
289 Default is white ("#ffffff").
290
291 .TP
292 \fBtransparent_bg\fR \fIboolean\fR
293 The background color of the image is to be the transparent color. This is
294 only useful for PNG images. Be sure to set \fBcolor_bg\fR to something
295 reasonable to make sure that the image is viewable with programs that do not
296 support transparency.
297 .br
298 Default is false.
299
300 .TP
301 \fBdate_format\fR \fIstring\fR
302 The \fBstrftime(3)\fR format string for date and time representation in
303 the '%d' expansion.
304 .br
305 Default is "%d\-%b\-%Y %H:%M:%S".
306
307 .TP
308 \fBbox_shadow\fR \fIboolean\fR
309 A boolean whether or not to draw a shadow for the boxes of
310 revisions and branches.
311 .br
312 Default is false.
313
314 .TP
315 \fBupside_down\fR \fIboolean\fR
316 Draw the entire tree upside down if set. I.e. highest revisions are
317 at the top of the image. See also \fBcvsgraph(1)\fR option '\fB-u\fR'.
318 .br
319 Default is false.
320
321 .TP
322 \fBleft_right\fR \fIboolean\fR
323 Draw the entire tree from left to right instead of top down if set.
324 I.e. highest revisions are at the right of the image. You can also
325 draw the tree right to left when \fBupside_down\fR is set too.
326 .br
327 Default is false.
328
329 .TP
330 \fBstrip_untagged\fR \fIboolean\fR
331 Omit all revisions that do not have tags and are not a branch point. This
332 reduces the image-size, but can be confusing when looking for a specific
333 revision. See also \fBcvsgraph(1)\fR option '\fB-s\fR'.
334 .br
335 Default is false.
336
337 .TP
338 \fBstrip_first_rev\fR \fIboolean\fR
339 Also omit the first revision in a branch if it does not have tags and is not a
340 branch point. This has only effect if \fBstrip_untagged\fR is set. See also
341 \fBcvsgraph(1)\fR option '\fB-S\fR'.
342 .br
343 Default is false.
344
345 .TP
346 \fBauto_stretch\fR \fIboolean\fR
347 Try to stretch the inter\-revision spacing to move the trunks more to the left,
348 effectively reducing the image's size. See also \fBcvsgraph(1)\fR option '\fB-k\fR'.
349 .br
350 Default is false.
351
352 .TP
353 \fBuse_ttf\fR \fIboolean\fR
354 Enable TrueType rendering of strings using the FreeType interface of libgd.
355 Note that ttf rendering is significantly slower than libgd's bitmap fonts.
356 .br
357 Default is false.
358
359 .TP
360 \fBanti_alias\fR \fIboolean\fR
361 Enable antialias rendering of TrueType fonts. This has only effect if
362 \fBuse_ttf\fR is set. Enabling anti_alias gives very nice results.
363 However, that is at the expense of 8-bit vs. 4-bit colormap images,
364 which can be a major drawback because the size of 8-bit images is 3..4
365 times that of 4-bit images (with compressed PNG as output).
366 .br
367 Default is true.
368
369 .TP
370 \fBthick_lines\fR \fInumber\fR
371 Set the thickness of connector lines between boxes. Normally, lines
372 are drawn one pixel wide, but can look somewhat thin. Setting the thickness
373 to anything over 5 would be plain ugly (but hey, who is to debate taste :-).
374 Values less than 1 and over 11 are clipped.
375 .br
376 Default is 1.
377
378 .TP
379 \fBparse_logs\fR \fIboolean\fR
380 Enable the parsing of the \fIentire\fR ,v file to read the log-entries between
381 revisions. This is necessary for the %l expansion to work, but slows down
382 parsing by a very large factor. You've been warned.
383 .br
384 Default is false.
385
386 .TP
387 \fBhtml_level\fR \fInumber\fR
388 Set the compliance to different types of HTML. The generated image map is
389 slightly different for version 3.x, 4.x and XHTML. You can use the predefined
390 identifiers (HTML3, HTML4 and XHTML) to set this value. Command line option
391 \&'\fB-x\fR' overrides the setting.
392 .br
393 Default is HTML3 (3.x compatibility).
394
395 .TP
396 \fBbranch_ttfont\fR \fIstring\fR
397 .TP
398 \fBbranch_tag_ttfont\fR \fIstring\fR
399 .TP
400 \fBrev_ttfont\fR \fIstring\fR
401 .TP
402 \fBrev_text_ttfont\fR \fIstring\fR
403 .TP
404 \fBtag_ttfont\fR \fIstring\fR
405 .TP
406 \fBtitle_ttfont\fR \fIstring\fR
407 .TP
408 \fBmsg_ttfont\fR \fIstring\fR
409 Set the TrueType font face or filename for the individual elements. Gd's bitmap
410 fonts are used as a fallback if the font cannot be found or contains errors.
411 .br
412 Default none.
413
414 .TP
415 \fBbranch_ttsize\fR \fIfloat\fR
416 .TP
417 \fBbranch_tag_ttsize\fR \fIfloat\fR
418 .TP
419 \fBrev_ttsize\fR \fIfloat\fR
420 .TP
421 \fBrev_text_ttsize\fR \fIfloat\fR
422 .TP
423 \fBtag_ttsize\fR \fIfloat\fR
424 .TP
425 \fBtitle_ttsize\fR \fIfloat\fR
426 .TP
427 \fBmsg_ttsize\fR \fIfloat\fR
428 Set the TrueType font size for the individual elements. See also *_ttfont.
429 .br
430 Default 0.0.
431
432 .TP
433 \fBtag_font\fR \fInumber\fR
434 The font used to draw tags in the revision boxes.
435 .br
436 Default is tiny.
437
438 .TP
439 \fBtag_color\fR \fIcolor\fR
440 The color used to draw tags in the revision boxes.
441 .br
442 Default is black ("#000000").
443
444 .TP
445 \fBtag_ignore\fR \fIstring\fR
446 An extended regular expression as described in \fBregex(7)\fR to match all tags
447 that should not be displayed in the graph. Note that a tag will always be
448 displayed if it matches the \fBmerge_from\fR/\fBmerge_to\fR expressions
449 regardless to it being set to ignore here.
450 .br
451 Example: tag_ignore = "(test|alpha)_release.*";
452 .br
453 Default is empty (no matching occurs).
454
455 .TP
456 \fBtag_nocase\fR \fIboolean\fR
457 Ignore the case in regex matching in \fBtag_ignore\fR.
458 .br
459 Default is false.
460
461 .TP
462 \fBtag_negate\fR \fIboolean\fR
463 Negate the matching criteria of the \fBtag_ignore\fR setting. If set, tags that
464 match the \fBtag_ignore\fR will be shown, instead of matches being ignored. In
465 any case, tags that match \fBmerge_from\fR/\fBmerge_to\fR expressions will
466 never be suppressed.
467 .br
468 Default is false.
469
470 .TP
471 \fBtag_ignore_merge\fR \fIboolean\fR
472 If set, then tags matched with \fBtag_ignore\fR will no longer be considered
473 for matching by \fBmerge_from\fR and \fBmerge_to\fR.
474 .br
475 Default is false.
476
477 .TP
478 \fBrev_font\fR \fInumber\fR
479 .br
480 Default is tiny.
481
482 .TP
483 \fBrev_color\fR \fIcolor\fR
484 The color of revision boxes, including the revision number.
485 .br
486 Default is black ("#000000").
487
488 .TP
489 \fBrev_bgcolor\fR \fIcolor\fR
490 Revision box background color. This is the interior fill of the
491 box.
492 .br
493 Default is white ("#ffffff").
494
495 .TP
496 \fBrev_separator\fR \fInumber\fR
497 Space between tags in revision boxes.
498 .br
499 Default is 0.
500
501 .TP
502 \fBrev_minline\fR \fInumber\fR
503 The minimum vertical distance between revision boxes.
504 .br
505 Default is 0.
506
507 .TP
508 \fBrev_maxline\fR \fInumber\fR
509 The maximum vertical distance between revision boxes.
510 This has only effect if \fBauto_stretch\fR is set to true (or option '\fB-k\fR'
511 is specified).
512 .br
513 Default is 5 times \fBrev_minline\fR.
514
515 .TP
516 \fBrev_lspace\fR \fInumber\fR
517 .TP
518 \fBrev_rspace\fR \fInumber\fR
519 .TP
520 \fBrev_tspace\fR \fInumber\fR
521 .TP
522 \fBrev_bspace\fR \fInumber\fR
523 Interior spacing in revision boxes of left, right, top and bottom
524 respectively. Note that the left right spacing is not used separately
525 because text is center aligned.
526 .br
527 Default is 0.
528
529 .TP
530 \fBrev_idtext\fR \fIconditional string\fR
531 The revision ID or revision number in a revision box.
532 .br
533 Default is "%R".
534
535 .TP
536 \fBrev_text\fR \fIconditional string\fR
537 The additional text in a revision box under the revision number.
538 .br
539 Default is "%d".
540
541 .TP
542 \fBrev_text_font\fR \fInumber\fR
543 The font of the additional text in a revision box under the revision number.
544 .br
545 Default is tiny.
546
547 .TP
548 \fBrev_text_color\fR \fIcolor\fR
549 The font color of the additional text in a revision box under the revision
550 number.
551 .br
552 Default is black ("#000000").
553
554 .TP
555 \fBrev_maxtags\fR \fInumber\fR
556 Limit the number of tags in a revision box. Old trees tend to have some
557 revisions with extremely many tags attached, which would generate a huge
558 revision box when drawn. Limiting the number is a fair solution. Note that tag
559 sorting is not specified in the \fBrcsfile(7)\fR, but \fBcvs(1)\fR will
560 normally have the newest tags located before older ones. Therefore, limiting
561 the number of tags would most likely only affect older tags to be stripped.
562 However, no guarantees are given that a specific tag is present when the limit
563 is imposed. An ellipsis (...) is shown in the revision box when the number of
564 tags got truncated.
565 .br
566 Default is 0, meaning all tags shown.
567
568 .TP
569 \fBrev_hidenumber\fR \fIboolean\fR
570 If set, then no revision number is displayed in the revisionboxes. This reduces
571 size for those graphs where the actual revision-number is irrelevant.
572 .br
573 Default is false.
574
575 .TP
576 \fBmsg_font\fR \fInumber\fR
577 The font used to draw error and warning messages at the bottom of the graph.
578 .br
579 Default is tiny.
580
581 .TP
582 \fBmsg_color\fR \fIcolor\fR
583 The color used to draw error and warning messages.
584 .br
585 Default is black ("#000000").
586
587 .TP
588 \fBmerge_color\fR \fIcolor\fR
589 The color of the lines to show merges.
590 .br
591 Default is black ("#000000").
592
593 .TP
594 \fBmerge_front\fR \fIboolean\fR
595 The merge lines are drawn on top of the image if true. Otherwise, merge lines
596 are drawn underneath.
597 .br
598 Default is false.
599
600 .TP
601 \fBmerge_nocase\fR \fIboolean\fR
602 Ignore the case in regex matching in \fBmerge_from\fR and \fBmerge_to\fR.
603 .br
604 Default is false.
605
606 .TP
607 \fBmerge_from\fR \fIstring\fR
608 The \fBmerge_from\fR is an extended regular expression as described in
609 \fBregex(7)\fR and POSIX 1003.2 (see also Single Unix Specification at
610 http://www.opengroup.com ). The matching tags describe source revisions of
611 merges. Each match is subsequently used in a search for the destination tag as
612 described by the \fBmerge_to\fR parameter.
613 .br
614 Note: normal string rules apply. Therefore, all backslashes '\\' must be
615 escaped, e.g. "\\." must be written as "\\\\.".
616 .br
617 Example: merge_from = "^from_(.*)";
618 .br
619 Default is empty (no matching occurs).
620
621 .TP
622 \fBmerge_to\fR \fIstring\fR
623 .br
624 The \fBmerge_to\fR is an extended regular expression with a twist. All
625 subexpressions from the \fBmerge_from\fR are expanded into \fBmerge_to\fR using
626 %[1-9] (in contrast to \\[1-9] for backreferences). Care is taken to escape
627 the constructed expression. A '$' at the end of the \fBmerge_to\fR expression
628 can be important to prevent 'near match' references. Normally, you want the
629 destination to be a good representation of the source. However, this depends
630 on how well you defined the tags in the first place.
631 .br
632 Example: merge_to = "^merge_%1$";
633 .br
634 Above example, combined with the merge_from example would match a tag
635 "from_BugFix_2002" to the merge-destination with tag "merge_BugFix_2002".
636 .br
637 Default is empty (no matching occurs).
638
639 .TP
640 \fBmerge_findall\fR \fIboolean\fR
641 Normally, \fBmerge_from\fR/m\fBerge_to\fR will only find the first matching
642 tag-combination and draw a line between them, If \fBmerge_findall\fR is set,
643 then all matching \fBmerge_to\fRs will result in lines from the from-tag to the
644 to-tag.
645 .br
646 Default is false.
647
648 .TP
649 \fBmerge_arrows\fR \fIboolean\fR
650 .br
651 Enable the use of arrows pointing to the merge destination.
652 .br
653 Default is true.
654
655 .TP
656 \fBmerge_cvsnt\fR \fIboolean\fR
657 .br
658 Enable drawing of mergepoints as used by CVSNT.
659 .br
660 Default is true.
661
662 .TP
663 \fBmerge_cvsnt_color\fR \fIcolor\fR
664 The color of the lines to show merges from mergepoints.
665 .br
666 Default is black ("#000000").
667
668 .TP
669 \fBarrow_width\fR \fInumber\fR
670 .TP
671 \fBarrow_length\fR \fInumber\fR
672 .br
673 Specifies the size of the arrow pointing to the merge destination.
674 .br
675 Default is arrow_width=3, arrow_length=12.
676
677 .TP
678 \fBbranch_font\fR \fInumber\fR
679 The font of the number in a branch box.
680 .br
681 Default is tiny.
682
683 .TP
684 \fBbranch_tag_font\fR \fInumber\fR
685 The font of the tags in a branch box.
686 .br
687 Default is tiny.
688
689 .TP
690 \fBbranch_color\fR \fIcolor\fR
691 All branch element's color excluding tags.
692 .br
693 Default is black ("#000000").
694
695 .TP
696 \fBbranch_bgcolor\fR \fIcolor\fR
697 Branch box background color. This is the interior fill of the
698 box.
699 .br
700 Default is white ("#ffffff").
701
702 .TP
703 \fBbranch_tag_color\fR \fIcolor\fR
704 All branch tags' color.
705 .br
706 Default is black ("#000000").
707
708 .TP
709 \fBbranch_lspace\fR \fInumber\fR
710 .TP
711 \fBbranch_rspace\fR \fInumber\fR
712 .TP
713 \fBbranch_tspace\fR \fInumber\fR
714 .TP
715 \fBbranch_bspace\fR \fInumber\fR
716 Interior spacing of branch boxes.
717 .br
718 Default is 0.
719
720 .TP
721 \fBbranch_margin\fR \fInumber\fR
722 Exterior spacing of branches. Each branch will be spaced
723 with a minimum of this value.
724 .br
725 Default is 0.
726
727 .TP
728 \fBbranch_connect\fR \fInumber\fR
729 Length of the vertical connector from a revision to the branch box.
730 .br
731 Default is 0.
732
733 .TP
734 \fBbranch_dupbox\fR \fIboolean\fR
735 Add an extra branch box at the end of the trunk. Useful for upside down drawn
736 trees. If there are no commits on a branch, then no extra box is added,
737 regardless of the setting of this option.
738 .br
739 Default is false.
740
741 .TP
742 \fBbranch_fold\fR \fIboolean\fR
743 Fold branches that have no commits into one branch-box. This helps to reduce
744 the size of the overall image by a huge factor (5..10 in most cases). Many
745 applications of CVS use many branches, but not all files in the repository
746 change for each branch. Especially stable files line .cvsignore or older code
747 tend to accumulate many empty branches at one and the same revision. Folding
748 these branches into one box reduces the width of these images considerably.
749 .br
750 Default is true.
751
752 .TP
753 \fBbranch_foldall\fR \fIboolean\fR
754 Fold all empty branches that sprout from the save revision in one box. If
755 this option is not set, then multiple boxes will be created if the empty
756 branches are interspaced with ones that have revisions attached. When this
757 option is set, then all empty branches will be collected and put into the
758 box of the first occurring empty branch on the revision's branch point.
759 Setting this option will reduce image size with interspaced commits to the
760 a maximum.
761 .br
762 Default is false.
763
764 .TP
765 \fBbranch_resort\fR \fIboolean\fR
766 Resort the branches according to the number of revisions they have, where less
767 revisions will stick closer to the sprouting trunk. This will reduce image size
768 under circumstances where many branches have significant different number of
769 revisions.
770 .br
771 Default is false.
772
773 .TP
774 \fBbranch_subtree\fR \fIstring\fR
775 Reduce the tree only to include the subtree from the branch-number given in the
776 argument. If the argument is a revision which is the root of branches, then all
777 those branches will be shown. The argument can also be a symbolic tag (either a
778 branch- or revision-tag). You normally would set this option from the
779 command line with the -O option for interactive flexibility.
780 .br
781 Example: branch_subtree = "1.2.4";
782 .br
783 Default is empty (all branches shown).
784
785 .TP
786 \fBtitle\fR \fIstring\fR
787 The title of the image.
788 .br
789 Default is empty string.
790
791 .TP
792 \fBtitle_x\fR \fInumber\fR
793 .TP
794 \fBtitle_y\fR \fInumber\fR
795 Position of title.
796 .br
797 Default is 0.
798
799 .TP
800 \fBtitle_font\fR \fInumber\fR
801 The font of the title.
802 .br
803 Default is tiny.
804
805 .TP
806 \fBtitle_align\fR \fInumber\fR
807 Horizontal alignment of the title.
808 .br
809 Default is left.
810
811 .TP
812 \fBtitle_color\fR \fIcolor\fR
813 The color of the title.
814 .br
815 Default is black ("#000000").
816
817 .TP
818 \fBmargin_top\fR \fInumber\fR
819 .TP
820 \fBmargin_bottom\fR \fInumber\fR
821 .TP
822 \fBmargin_left\fR \fInumber\fR
823 .TP
824 \fBmargin_right\fR \fInumber\fR
825 Margins of the image. Note: the title position is not affected by
826 the margin.
827 .br
828 Default is 0.
829
830 .TP
831 \fBimage_type\fR \fInumber\fR
832 Image types are available if they can be found in
833 the gd library. Newer versions of gd do not have
834 gif anymore. CvsGraph will automatically generate
835 png images instead.
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)

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0