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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0