/[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.13 - (hide annotations)
Tue Feb 11 10:43:44 2003 UTC (14 years, 10 months ago) by bertho
Branch: MAIN
Changes since 1.12: +17 -0 lines
- Implement different HTML levels for imagemaps.
- Add new commandline option for HTML level
- Update docs
1 bertho 1.11 .TH "cvsgraph.conf" "5" "1.3.0" "B. Stultiens" "CVS/RCS Utilties"
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.3 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 bertho 1.1 .TP
46     %m
47 bertho 1.3 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 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     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     .TP
102     %L
103     Same as %l, but no html-entity translations are performed.
104     .TP
105 bertho 1.1 %t
106     current tag of branch or revision
107     .TP
108     %0..%9
109     command\-line argument \-0 .. \-9
110    
111     .LP
112 bertho 1.6 Fonts are numbered 0..4 (as defined in libgd) where
113 bertho 1.1 0 = tiny, 1 = small, 2 = medium (bold), 3 = large and
114     4 = giant.
115    
116     .LP
117     Colors are a strings, similar to html\-type colors in the form
118     "#rrggbb" with parts written in hex, where rr = red (00..ff),
119     gg = green (00\-ff) and bb = blue (00\-ff).
120    
121     .LP
122 bertho 1.8 Booleans have three possible arguments: true, false and not. `Not' means
123     inverse of what it was (logical negation) and is represented by the value -1.
124     For the configuration file that means that the default value is negated.
125     However, the not possibility is a very handy tool for commandline overrides
126     generated from (CGI-)scripts.
127    
128     .LP
129 bertho 1.1 There are several reserved words besides of the keywords.
130     These additional reserved words expand to numerical values:
131     .br
132     Booleans:
133     .br
134     false = 0
135     .br
136     true = 1
137     .br
138 bertho 1.8 not = -1
139     .br
140 bertho 1.1 Alignment specifiers:
141     .br
142     left = 0
143     .br
144     center = 1
145     .br
146     right = 2
147     .br
148     Image specifiers:
149     .br
150     gif = 0
151     .br
152     png = 1
153     .br
154     jpeg = 2
155     .br
156     Font specifiers:
157     .br
158     tiny = 0
159     .br
160     small = 1
161     .br
162     medium = 2
163     .br
164     large = 3
165     .br
166     giant = 4
167     .br
168 bertho 1.13 HTML level specifiers:
169     .br
170     HTML3 = 1
171     .br
172     HTML4 = 2
173     .br
174     XHTML = 3
175     .br
176 bertho 1.1
177     .SH "PARAMETERS"
178     .TP
179     \fBcvsroot\fR \fIstring\fR
180     The absolute base directory where the CSV/RCS repository can be found.
181     A '/' will be appended to the string if it is not empty and does not
182     contain a trailing '/'.
183     .br
184     Default is an empty string.
185    
186     .TP
187     \fBcvsmodule\fR \fIstring\fR
188     The modulename of the CVS/RCS repository. This is converted into a
189     subdirectory name with a trailing '/'.
190     .br
191     Default is an empty string.
192    
193     .TP
194     \fBcolor_bg\fR \fIcolor\fR
195     The background color of the image.
196     .br
197     Default is white ("#ffffff").
198    
199     .TP
200 bertho 1.7 \fBtransparent_bg\fR \fIboolean\fR
201     The background color of the image is to be the transparent color. This is
202     only usefull for PNG images. Be sure to set \fBcolor_bg\fR to something
203     reasonable to make sure that the image is viewable with programs that do not
204     support transparency.
205     .br
206     Default is false.
207    
208     .TP
209 bertho 1.1 \fBdate_format\fR \fIstring\fR
210     The \fBstrftime(3)\fR format string for date and time representation in
211     the '%d' expansion.
212     .br
213     Default is "%d\-%b\-%Y %H:%M:%S".
214    
215     .TP
216 bertho 1.5 \fBbox_shadow\fR \fIboolean\fR
217 bertho 1.1 A boolean whether or not to draw a shadow for the boxes of
218     revisions and branches.
219     .br
220     Default is false.
221    
222     .TP
223 bertho 1.5 \fBupside_down\fR \fIboolean\fR
224     Draw the entire tree upside down if set. I.e. highest revisions are
225 bertho 1.6 at the top of the image. See also cvsgraph(1) option '\fB-u\fR'.
226 bertho 1.5 .br
227     Default is false.
228    
229     .TP
230 bertho 1.10 \fBleft_right\fR \fIboolean\fR
231     Draw the entire tree from left to right instead of top down if set.
232     I.e. highest revisions are at the right of the image. You can also
233     draw the tree right to left when \fBupside_down\fR is set too.
234     .br
235     Default is false.
236    
237     .TP
238 bertho 1.5 \fBstrip_untagged\fR \fIboolean\fR
239 bertho 1.6 Ommit all revisions that do not have tags and are not a branchpoint. This
240     reduces the image-size, but can be confusing when looking for a specific
241     revision. See also cvsgraph(1) option '\fB-s\fR'.
242     .br
243     Default is false.
244    
245     .TP
246     \fBstrip_first_rev\fR \fIboolean\fR
247     Also ommit the first revision in a branch if it does not have tags and is not a
248     branchpoint. This has only effect if \fBstrip_untagged\fR is set. See also
249     cvsgraph(1) option '\fB-S\fR'.
250     .br
251     Default is false.
252    
253     .TP
254 bertho 1.7 \fBauto_stretch\fR \fIboolean\fR
255 bertho 1.6 Try to stretch the inter\-revision spacing to move the trunks more to the left,
256     effectively reducing the image's size. See also cvsgraph(1) option '\fB-k\fR'.
257 bertho 1.5 .br
258     Default is false.
259    
260     .TP
261 bertho 1.7 \fBuse_ttf\fR \fIboolean\fR
262     Enable truetype rendering of strings using the FreeType interface of libgd.
263     Note that ttf rendering is significantly slower than libgd's bitmap fonts.
264     .br
265     Default is false.
266    
267     .TP
268     \fBanti_alias\fR \fIboolean\fR
269     Enable antialias rendering of truetype fonts. This has only effect if
270     \fBuse_ttf\fR is set. Enabling anti_alias gives very nice results.
271     However, that is at the expense of 8-bit vs. 4-bit colormap images,
272     which can be a major drawback because the size of 8-bit images is 3..4
273     times that of 4-bit images (with compressed PNG as output).
274     .br
275     Default is true.
276 bertho 1.8
277     .TP
278     \fBthick_lines\fR \fInumber\fR
279     Set the thickness of connector lines between boxes. Normally, lines
280     are drawn one pixel wide, but can look somewhat thin. Setting the thickness
281     to anything over 5 would be plain ugly (but hey, who is to debate tast:-).
282     Values less than 1 and over 11 are clipped.
283     .br
284     Default is 1.
285 bertho 1.9
286     .TP
287     \fBparse_logs\fR \fIboolean\fR
288     Enable the parsing of the \fIentire\fR ,v file to read the log-entries between
289     revisions. This is necessary for the %l expansion to work, but slows down
290     parsing by a very large factor. You've been warned.
291     .br
292     Default is false.
293 bertho 1.13
294     .TP
295     \fBhtml_level\fR \fInumber\fR
296     Set the compliance to different types of HTML. The generated image map is
297     slightly different for version 3.x, 4.x and XHTML. You can use the predefined
298     identifiers (HTML3, HTML4 and XHTML) to set this value. Commandline option '\fB-x\fR'
299     overrides the setting.
300     .br
301     Default is HTML3 (3.x compatibility).
302 bertho 1.7
303     .TP
304     \fBbranch_ttfont\fR \fIstring\fR
305     .TP
306     \fBbranch_tag_ttfont\fR \fIstring\fR
307     .TP
308     \fBrev_ttfont\fR \fIstring\fR
309     .TP
310     \fBrev_text_ttfont\fR \fIstring\fR
311     .TP
312     \fBtag_ttfont\fR \fIstring\fR
313     .TP
314     \fBtitle_ttfont\fR \fIstring\fR
315     Set the truetype font face or filename for the individual elements. Gd's bitmap
316     fonts are used as a fallback if the font cannot be found or contains errors.
317     .br
318     Default none.
319    
320     .TP
321     \fBbranch_ttsize\fR \fIfloat\fR
322     .TP
323     \fBbranch_tag_ttsize\fR \fIfloat\fR
324     .TP
325     \fBrev_ttsize\fR \fIfloat\fR
326     .TP
327     \fBrev_text_ttsize\fR \fIfloat\fR
328     .TP
329     \fBtag_ttsize\fR \fIfloat\fR
330     .TP
331     \fBtitle_ttsize\fR \fIfloat\fR
332     Set the truetype font size for the individual elements. See also *_ttfont.
333     .br
334     Default 0.0.
335    
336     .TP
337 bertho 1.1 \fBtag_font\fR \fInumber\fR
338     The font used to draw tags in the revision boxes.
339     .br
340     Default is tiny.
341    
342     .TP
343     \fBtag_color\fR \fIcolor\fR
344     The color used to draw tags in the revision boxes.
345     .br
346     Default is black ("#000000").
347    
348     .TP
349     \fBrev_font\fR \fInumber\fR
350     .br
351     Default is tiny.
352    
353     .TP
354     \fBrev_color\fR \fIcolor\fR
355     The color of revision boxes, including the revision number.
356     .br
357     Default is black ("#000000").
358    
359     .TP
360     \fBrev_bgcolor\fR \fIcolor\fR
361     Revision box background color. This is the interior fill of the
362     box.
363     .br
364     Default is white ("#ffffff").
365    
366     .TP
367 bertho 1.7 \fBrev_separator\fR \fInumber\fR
368     Space between tags in revision boxes.
369 bertho 1.1 .br
370     Default is 0.
371    
372     .TP
373     \fBrev_minline\fR \fInumber\fR
374     The minimum vertical distance between revision boxes.
375     .br
376     Default is 0.
377    
378     .TP
379     \fBrev_maxline\fR \fInumber\fR
380     The maximum vertical distance between revision boxes.
381 bertho 1.7 This has only effect if \fBauto_stretch\fR is set to true (or option '\fB-k\fR'
382 bertho 1.6 is specified).
383 bertho 1.1 .br
384 bertho 1.6 Default is 5 times \fBrev_minline\fR.
385 bertho 1.1
386     .TP
387     \fBrev_lspace\fR \fInumber\fR
388     .TP
389     \fBrev_rspace\fR \fInumber\fR
390     .TP
391     \fBrev_tspace\fR \fInumber\fR
392     .TP
393     \fBrev_bspace\fR \fInumber\fR
394 bertho 1.6 Interior spacing in revision boxes of left, right, top and bottom
395 bertho 1.1 respectively. Note that the left right spacing is not used separately
396     because text is center aligned.
397     .br
398     Default is 0.
399    
400     .TP
401     \fBrev_text\fR \fIstring\fR
402     The additional text in a revision box under the revision number.
403     .br
404     Default is "%d".
405    
406     .TP
407     \fBrev_text_font\fR \fInumber\fR
408     The font of the additional text in a revision box under the revision number.
409     .br
410     Default is tiny.
411    
412     .TP
413     \fBrev_text_color\fR \fIcolor\fR
414 bertho 1.12 The font color of the additional text in a revision box under the revision
415     number.
416 bertho 1.1 .br
417     Default is black ("#000000").
418 bertho 1.12
419     .TP
420     \fBrev_maxtags\fR \fInumber\fR
421     Limit the number of tags in a revision box. Old trees tend to have some
422     revisions with extremely many tags attached, which would generate a huge
423     revision box when drawn. Limiting the number is a fair solution. Note that tag
424     sorting is not specified in the rcsfile(7), but cvs(1) will normally have the
425     newest tags located before older ones. Therefore, limiting the number of tags
426     would most likely only affect older tags to be stripped. However, no
427     guarantees are given that a specific tag is present when the limit is imposed.
428     An ellispsis (...) is shown in the revision box when the number of tags got
429     truncated.
430     .br
431     Default is 0, meaning all tags shown.
432 bertho 1.1
433     .TP
434     \fBbranch_font\fR \fInumber\fR
435 bertho 1.7 The font of the number in a branch box.
436     .br
437     Default is tiny.
438    
439     .TP
440     \fBbranch_tag_font\fR \fInumber\fR
441     The font of the tags in a branch box.
442 bertho 1.1 .br
443     Default is tiny.
444    
445     .TP
446     \fBbranch_color\fR \fIcolor\fR
447 bertho 1.7 All branch element's color excluding tags.
448     .br
449     Default is black ("#000000").
450    
451     .TP
452     \fBbranch_tag_color\fR \fIcolor\fR
453     All branch tags' color.
454 bertho 1.1 .br
455     Default is black ("#000000").
456    
457     .TP
458     \fBbranch_lspace\fR \fInumber\fR
459     .TP
460     \fBbranch_rspace\fR \fInumber\fR
461     .TP
462     \fBbranch_tspace\fR \fInumber\fR
463     .TP
464     \fBbranch_bspace\fR \fInumber\fR
465     Interior spacing of branch boxes.
466     .br
467     Default is 0.
468    
469     .TP
470     \fBbranch_margin\fR \fInumber\fR
471     Exterior spacing of branches. Each branch will be spaced
472     with a minimum of this value.
473     .br
474     Default is 0.
475    
476     .TP
477     \fBbranch_connect\fR \fInumber\fR
478     Length of the vertical connector from a revision to the branch box.
479     .br
480     Default is 0.
481 bertho 1.5
482     .TP
483 bertho 1.6 \fBbranch_dupbox\fR \fIboolean\fR
484     Add an extra branch box at the end of the trunk. Useful for upside down drawn
485     trees.
486 bertho 1.5 .br
487     Default is false.
488 bertho 1.1
489     .TP
490     \fBtitle\fR \fIstring\fR
491     The title of the image.
492     .br
493     Default is empty string.
494    
495     .TP
496     \fBtitle_x\fR \fInumber\fR
497     .TP
498     \fBtitle_y\fR \fInumber\fR
499     Postion of title.
500     .br
501     Default is 0.
502    
503     .TP
504     \fBtitle_font\fR \fInumber\fR
505     The font of the title.
506     .br
507     Default is tiny.
508    
509     .TP
510     \fBtitle_align\fR \fInumber\fR
511     Horizontal alignment of the title.
512     .br
513     Default is left.
514    
515     .TP
516     \fBtitle_color\fR \fIcolor\fR
517     The color of the title.
518     .br
519     Default is black ("#000000").
520    
521     .TP
522     \fBmargin_top\fR \fInumber\fR
523     .TP
524     \fBmargin_bottom\fR \fInumber\fR
525     .TP
526     \fBmargin_left\fR \fInumber\fR
527     .TP
528     \fBmargin_right\fR \fInumber\fR
529     Margins of the image. Note: the title position is not affected by
530     the margin.
531     .br
532     Default is 0.
533    
534     .TP
535     \fBimage_type\fR \fInumber\fR
536     Image types are available if they can be found in
537     the gd library. Newer versions of gd do not have
538     gif anymore. CvsGraph will automatically generate
539     png images instead.
540     .br
541     Default is dependent on availability and is prioritized in the order
542     png, gif and jpeg.
543    
544     .TP
545     \fBimage_quality\fR \fInumber\fR
546     The quality of a jpeg image (1..100)
547     .br
548     Default is 100.
549    
550     .TP
551     \fBmap_name\fR \fIstring\fR
552     The name= attribute in <map name="mapname">...</map> in the
553     generated HTML map.
554     .br
555     Default is "CvsGraphImageMap".
556    
557     .TP
558     \fBmap_branch_href\fR \fIstring\fR
559     .TP
560     \fBmap_rev_href\fR \fIstring\fR
561     .TP
562     \fBmap_diff_href\fR \fIstring\fR
563     These are the href= attributes in the <area>
564     tags of html.
565     .br
566 bertho 1.6 Default are:
567 bertho 1.1 .br
568     branch: "href=\\"unset: conf.map_branch_href\\""
569     .br
570     revision: "href=\\"unset: conf.map_rev_href\\""
571     .br
572     diff: "href=\\"unset: conf.map_diff_href\\""
573    
574     .TP
575     \fBmap_branch_alt\fR \fIstring\fR
576     .TP
577     \fBmap_rev_alt\fR \fIstring\fR
578     .TP
579     \fBmap_diff_alt\fR \fIstring\fR
580     These are the alt= attributes in the <area>
581     tags of html.
582     .br
583 bertho 1.6 Default are "alt=\\"%B\\"", "alt=\\"%R\\"" and
584     "alt=\\"%P &lt;\-&gt; %R\\"" respectively.
585 bertho 1.1
586     .SH "AUTHOR"
587     \fBCvsGraph\fR is written and maintained by B. Stultiens.
588     .br
589     Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and
590 bertho 1.3 visit the homepage at:
591     .br
592     \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.
593 bertho 1.1 .SH "SEE ALSO"
594     .BR cvsgraph(1)

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0