/[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.22 - (show annotations)
Thu Aug 5 09:23:07 2004 UTC (13 years, 2 months ago) by bertho
Branch: MAIN
Changes since 1.21: +1 -1 lines
Up the version number now so I don't forget it like last time...
1 .TH "cvsgraph.conf" "5" "1.4.2" "B. Stultiens" "CVS/RCS Utilties"
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 cvsroot including a trailing '/' if non\-empty
41 .TP
42 %C
43 cvsroot without trailing '/', regardless of how it was entered
44 on the commandline
45 .TP
46 %m
47 cvsmodule including trailing '/' if non\-empty
48 .TP
49 %M
50 cvsmodule without trailing '/', regardless of how it was entered
51 on the commandline
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 logentry 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 trunction 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 usefull to prevent a
115 possible cross site scripting big 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 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 However, the not possibility is a very handy tool for commandline overrides
141 generated from (CGI-)scripts.
142
143 .LP
144 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 not = -1
154 .br
155 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 HTML level specifiers:
184 .br
185 HTML3 = 1
186 .br
187 HTML4 = 2
188 .br
189 XHTML = 3
190 .br
191
192 .SH "PARAMETERS"
193 .TP
194 \fBcvsroot\fR \fIstring\fR
195 The absolute base directory where the CSV/RCS repository can be found.
196 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 The modulename of the CVS/RCS repository. This is converted into a
204 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 \fBtransparent_bg\fR \fIboolean\fR
216 The background color of the image is to be the transparent color. This is
217 only usefull for PNG images. Be sure to set \fBcolor_bg\fR to something
218 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 \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 \fBbox_shadow\fR \fIboolean\fR
232 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 \fBupside_down\fR \fIboolean\fR
239 Draw the entire tree upside down if set. I.e. highest revisions are
240 at the top of the image. See also \fBcvsgraph(1)\fR option '\fB-u\fR'.
241 .br
242 Default is false.
243
244 .TP
245 \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 \fBstrip_untagged\fR \fIboolean\fR
254 Ommit all revisions that do not have tags and are not a branchpoint. This
255 reduces the image-size, but can be confusing when looking for a specific
256 revision. See also \fBcvsgraph(1)\fR option '\fB-s\fR'.
257 .br
258 Default is false.
259
260 .TP
261 \fBstrip_first_rev\fR \fIboolean\fR
262 Also ommit the first revision in a branch if it does not have tags and is not a
263 branchpoint. This has only effect if \fBstrip_untagged\fR is set. See also
264 \fBcvsgraph(1)\fR option '\fB-S\fR'.
265 .br
266 Default is false.
267
268 .TP
269 \fBauto_stretch\fR \fIboolean\fR
270 Try to stretch the inter\-revision spacing to move the trunks more to the left,
271 effectively reducing the image's size. See also \fBcvsgraph(1)\fR option '\fB-k\fR'.
272 .br
273 Default is false.
274
275 .TP
276 \fBuse_ttf\fR \fIboolean\fR
277 Enable truetype rendering of strings using the FreeType interface of libgd.
278 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 Enable antialias rendering of truetype fonts. This has only effect if
285 \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
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 to anything over 5 would be plain ugly (but hey, who is to debate tast:-).
297 Values less than 1 and over 11 are clipped.
298 .br
299 Default is 1.
300
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
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 identifiers (HTML3, HTML4 and XHTML) to set this value. Commandline option '\fB-x\fR'
314 overrides the setting.
315 .br
316 Default is HTML3 (3.x compatibility).
317
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 Set the truetype font face or filename for the individual elements. Gd's bitmap
331 fonts are used as a fallback if the font cannot be found or contains errors.
332 .br
333 Default none.
334
335 .TP
336 \fBbranch_ttsize\fR \fIfloat\fR
337 .TP
338 \fBbranch_tag_ttsize\fR \fIfloat\fR
339 .TP
340 \fBrev_ttsize\fR \fIfloat\fR
341 .TP
342 \fBrev_text_ttsize\fR \fIfloat\fR
343 .TP
344 \fBtag_ttsize\fR \fIfloat\fR
345 .TP
346 \fBtitle_ttsize\fR \fIfloat\fR
347 Set the truetype font size for the individual elements. See also *_ttfont.
348 .br
349 Default 0.0.
350
351 .TP
352 \fBtag_font\fR \fInumber\fR
353 The font used to draw tags in the revision boxes.
354 .br
355 Default is tiny.
356
357 .TP
358 \fBtag_color\fR \fIcolor\fR
359 The color used to draw tags in the revision boxes.
360 .br
361 Default is black ("#000000").
362
363 .TP
364 \fBtag_ignore\fR \fIstring\fR
365 An extended regular expression as described in \fBregex(7)\fR to match all tags
366 that should not be displayed in the graph. Note that a tag will always be
367 displayed if it matches the \fBmerge_from\fR/\fBmerge_to\fR expressions
368 regardless to it being set to ignore here.
369 .br
370 Example: tag_ignore = "(test|alpha)_release.*";
371 .br
372 Default is empty (no matching occurs).
373
374 .TP
375 \fBtag_nocase\fR \fIboolean\fR
376 Ignore the case in regex matching in \fBtag_ignore\fR.
377 .br
378 Default is false.
379
380 .TP
381 \fBrev_font\fR \fInumber\fR
382 .br
383 Default is tiny.
384
385 .TP
386 \fBrev_color\fR \fIcolor\fR
387 The color of revision boxes, including the revision number.
388 .br
389 Default is black ("#000000").
390
391 .TP
392 \fBrev_bgcolor\fR \fIcolor\fR
393 Revision box background color. This is the interior fill of the
394 box.
395 .br
396 Default is white ("#ffffff").
397
398 .TP
399 \fBrev_separator\fR \fInumber\fR
400 Space between tags in revision boxes.
401 .br
402 Default is 0.
403
404 .TP
405 \fBrev_minline\fR \fInumber\fR
406 The minimum vertical distance between revision boxes.
407 .br
408 Default is 0.
409
410 .TP
411 \fBrev_maxline\fR \fInumber\fR
412 The maximum vertical distance between revision boxes.
413 This has only effect if \fBauto_stretch\fR is set to true (or option '\fB-k\fR'
414 is specified).
415 .br
416 Default is 5 times \fBrev_minline\fR.
417
418 .TP
419 \fBrev_lspace\fR \fInumber\fR
420 .TP
421 \fBrev_rspace\fR \fInumber\fR
422 .TP
423 \fBrev_tspace\fR \fInumber\fR
424 .TP
425 \fBrev_bspace\fR \fInumber\fR
426 Interior spacing in revision boxes of left, right, top and bottom
427 respectively. Note that the left right spacing is not used separately
428 because text is center aligned.
429 .br
430 Default is 0.
431
432 .TP
433 \fBrev_text\fR \fIstring\fR
434 The additional text in a revision box under the revision number.
435 .br
436 Default is "%d".
437
438 .TP
439 \fBrev_text_font\fR \fInumber\fR
440 The font of the additional text in a revision box under the revision number.
441 .br
442 Default is tiny.
443
444 .TP
445 \fBrev_text_color\fR \fIcolor\fR
446 The font color of the additional text in a revision box under the revision
447 number.
448 .br
449 Default is black ("#000000").
450
451 .TP
452 \fBrev_maxtags\fR \fInumber\fR
453 Limit the number of tags in a revision box. Old trees tend to have some
454 revisions with extremely many tags attached, which would generate a huge
455 revision box when drawn. Limiting the number is a fair solution. Note that tag
456 sorting is not specified in the \fBrcsfile(7)\fR, but \fBcvs(1)\fR will
457 normally have the newest tags located before older ones. Therefore, limiting
458 the number of tags would most likely only affect older tags to be stripped.
459 However, no guarantees are given that a specific tag is present when the limit
460 is imposed. An ellipsis (...) is shown in the revision box when the number of
461 tags got truncated.
462 .br
463 Default is 0, meaning all tags shown.
464
465 .TP
466 \fBmerge_color\fR \fIcolor\fR
467 The color of the lines to show merges.
468 .br
469 Default is black ("#000000").
470
471 .TP
472 \fBmerge_front\fR \fIboolean\fR
473 The mergelines are drawn on top of the image if true. Otherwise, mergelines
474 are drawn underneath.
475 .br
476 Default is false.
477
478 .TP
479 \fBmerge_nocase\fR \fIboolean\fR
480 Ignore the case in regex matching in \fBmerge_from\fR and \fBmerge_to\fR.
481 .br
482 Default is false.
483
484 .TP
485 \fBmerge_from\fR \fIstring\fR
486 The \fBmerge_from\fR is an extended regular expression as described in
487 \fBregex(7)\fR and POSIX 1003.2 (see also Single Unix Specification at
488 http://www.opengroup.com ). The matching tags describe source revisions of
489 merges. Each match is subsequently used in a search for the destination tag as
490 described by the \fBmerge_to\fR parameter.
491 .br
492 Note: normal string rules apply. Therefore, all backslashes '\\' must be
493 escaped, e.g. "\\." must be written as "\\\\.".
494 .br
495 Example: merge_from = "^from_(.*)";
496 .br
497 Default is empty (no matching occurs).
498
499 .TP
500 \fBmerge_to\fR \fIstring\fR
501 .br
502 The \fBmerge_to\fR is an extended regular expression with a twist. All
503 subexpressions from the \fBmerge_from\fR are expanded into \fBmerge_to\fR using
504 %[1-9] (in contrast to \\[1-9] for backreferences). Care is taken to escape
505 the constructed expression. A '$' at the end of the \fBmerge_to\fR expression
506 can be important to prevent 'near match' references. Normally, you want the
507 destination to be a good representation of the source. However, this depends
508 on how well you defined the tags in the first place.
509 .br
510 Example: merge_to = "^merge_%1$";
511 .br
512 Above example, combined with the merge_from example would match a tag
513 "from_BugFix_2002" to the merge-destination with tag "merge_BugFix_2002".
514 .br
515 Default is empty (no matching occurs).
516
517 .TP
518 \fBmerge_arrows\fR \fIboolean\fR
519 .br
520 Enable the use of arrows pointing to the merge destination.
521 .br
522 Default is true.
523
524 .TP
525 \fBarrow_width\fR \fInumber\fR
526 .TP
527 \fBarrow_length\fR \fInumber\fR
528 .br
529 Specifies the size of the arrow pointing to the merge destination.
530 .br
531 Default is arrow_width=3, arrow_length=12.
532
533 .TP
534 \fBbranch_font\fR \fInumber\fR
535 The font of the number in a branch box.
536 .br
537 Default is tiny.
538
539 .TP
540 \fBbranch_tag_font\fR \fInumber\fR
541 The font of the tags in a branch box.
542 .br
543 Default is tiny.
544
545 .TP
546 \fBbranch_color\fR \fIcolor\fR
547 All branch element's color excluding tags.
548 .br
549 Default is black ("#000000").
550
551 .TP
552 \fBbranch_tag_color\fR \fIcolor\fR
553 All branch tags' color.
554 .br
555 Default is black ("#000000").
556
557 .TP
558 \fBbranch_lspace\fR \fInumber\fR
559 .TP
560 \fBbranch_rspace\fR \fInumber\fR
561 .TP
562 \fBbranch_tspace\fR \fInumber\fR
563 .TP
564 \fBbranch_bspace\fR \fInumber\fR
565 Interior spacing of branch boxes.
566 .br
567 Default is 0.
568
569 .TP
570 \fBbranch_margin\fR \fInumber\fR
571 Exterior spacing of branches. Each branch will be spaced
572 with a minimum of this value.
573 .br
574 Default is 0.
575
576 .TP
577 \fBbranch_connect\fR \fInumber\fR
578 Length of the vertical connector from a revision to the branch box.
579 .br
580 Default is 0.
581
582 .TP
583 \fBbranch_dupbox\fR \fIboolean\fR
584 Add an extra branch box at the end of the trunk. Useful for upside down drawn
585 trees. If there are no commits on a branch, then no extra box is added,
586 regardless of the setting of this option.
587 .br
588 Default is false.
589
590 .TP
591 \fBbranch_fold\fR \fIboolean\fR
592 Fold branches that have no commits into one branch-box. This helps to reduce
593 the size of the overall image by a huge factor (5..10 in most cases). Many
594 applications of CVS use many branches, but not all files in the repository
595 change for each branch. Especially stable files line .cvsignore or older code
596 tend to accumulate many empty branches at one and the same revision. Folding
597 these branches into one box reduces the width of these images considerably.
598 .br
599 Default is true.
600
601 .TP
602 \fBbranch_foldall\fR \fIboolean\fR
603 Fold all empty branches that sprout from the save revision in one box. If
604 this option is not set, then multiple boxes will be created if the empty
605 branches are interspaced with ones that have revisions attached. When this
606 option is set, then all empty branches will be collected and put into the
607 box of the firts occuring empty branch on the revision's branchpoint.
608 Setting this option will reduce imagesize with interspaced commits to the
609 a maximum.
610 .br
611 Default is false.
612
613 .TP
614 \fBtitle\fR \fIstring\fR
615 The title of the image.
616 .br
617 Default is empty string.
618
619 .TP
620 \fBtitle_x\fR \fInumber\fR
621 .TP
622 \fBtitle_y\fR \fInumber\fR
623 Postion of title.
624 .br
625 Default is 0.
626
627 .TP
628 \fBtitle_font\fR \fInumber\fR
629 The font of the title.
630 .br
631 Default is tiny.
632
633 .TP
634 \fBtitle_align\fR \fInumber\fR
635 Horizontal alignment of the title.
636 .br
637 Default is left.
638
639 .TP
640 \fBtitle_color\fR \fIcolor\fR
641 The color of the title.
642 .br
643 Default is black ("#000000").
644
645 .TP
646 \fBmargin_top\fR \fInumber\fR
647 .TP
648 \fBmargin_bottom\fR \fInumber\fR
649 .TP
650 \fBmargin_left\fR \fInumber\fR
651 .TP
652 \fBmargin_right\fR \fInumber\fR
653 Margins of the image. Note: the title position is not affected by
654 the margin.
655 .br
656 Default is 0.
657
658 .TP
659 \fBimage_type\fR \fInumber\fR
660 Image types are available if they can be found in
661 the gd library. Newer versions of gd do not have
662 gif anymore. CvsGraph will automatically generate
663 png images instead.
664 .br
665 Default is dependent on availability and is prioritized in the order
666 png, gif and jpeg.
667
668 .TP
669 \fBimage_quality\fR \fInumber\fR
670 The quality of a jpeg image (1..100)
671 .br
672 Default is 100.
673
674 .TP
675 \fBmap_name\fR \fIstring\fR
676 The name= attribute in <map name="mapname">...</map> in the
677 generated HTML map.
678 .br
679 Default is "CvsGraphImageMap".
680
681 .TP
682 \fBmap_branch_href\fR \fIstring\fR
683 .TP
684 \fBmap_rev_href\fR \fIstring\fR
685 .TP
686 \fBmap_diff_href\fR \fIstring\fR
687 These are the href= attributes in the <area>
688 tags of html.
689 .br
690 Default are:
691 .br
692 branch: "href=\\"unset: conf.map_branch_href\\""
693 .br
694 revision: "href=\\"unset: conf.map_rev_href\\""
695 .br
696 diff: "href=\\"unset: conf.map_diff_href\\""
697
698 .TP
699 \fBmap_branch_alt\fR \fIstring\fR
700 .TP
701 \fBmap_rev_alt\fR \fIstring\fR
702 .TP
703 \fBmap_diff_alt\fR \fIstring\fR
704 These are the alt= attributes in the <area>
705 tags of html.
706 .br
707 Default are "alt=\\"%B\\"", "alt=\\"%R\\"" and
708 "alt=\\"%P &lt;\-&gt; %R\\"" respectively.
709
710 .SH "AUTHOR"
711 \fBCvsGraph\fR is written and maintained by B. Stultiens.
712 .br
713 Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and
714 visit the homepage at:
715 .br
716 \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.
717 .SH "SEE ALSO"
718 .BR cvsgraph(1)

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0