/[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.9 - (hide annotations)
Tue Apr 23 23:02:54 2002 UTC (15 years, 7 months ago) by bertho
Branch: MAIN
Changes since 1.8: +23 -1 lines
- Fix browserbug ordering y-coordinates
- Speed up parsing by bypassing deltatext parse
- Add logentry expansion
1 bertho 1.9 .TH "cvsgraph.conf" "5" "1.2.1" "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     \fBstrip_untagged\fR \fIboolean\fR
223 bertho 1.6 Ommit all revisions that do not have tags and are not a branchpoint. This
224     reduces the image-size, but can be confusing when looking for a specific
225     revision. See also cvsgraph(1) option '\fB-s\fR'.
226     .br
227     Default is false.
228    
229     .TP
230     \fBstrip_first_rev\fR \fIboolean\fR
231     Also ommit the first revision in a branch if it does not have tags and is not a
232     branchpoint. This has only effect if \fBstrip_untagged\fR is set. See also
233     cvsgraph(1) option '\fB-S\fR'.
234     .br
235     Default is false.
236    
237     .TP
238 bertho 1.7 \fBauto_stretch\fR \fIboolean\fR
239 bertho 1.6 Try to stretch the inter\-revision spacing to move the trunks more to the left,
240     effectively reducing the image's size. See also cvsgraph(1) option '\fB-k\fR'.
241 bertho 1.5 .br
242     Default is false.
243    
244     .TP
245 bertho 1.7 \fBuse_ttf\fR \fIboolean\fR
246     Enable truetype rendering of strings using the FreeType interface of libgd.
247     Note that ttf rendering is significantly slower than libgd's bitmap fonts.
248     .br
249     Default is false.
250    
251     .TP
252     \fBanti_alias\fR \fIboolean\fR
253     Enable antialias rendering of truetype fonts. This has only effect if
254     \fBuse_ttf\fR is set. Enabling anti_alias gives very nice results.
255     However, that is at the expense of 8-bit vs. 4-bit colormap images,
256     which can be a major drawback because the size of 8-bit images is 3..4
257     times that of 4-bit images (with compressed PNG as output).
258     .br
259     Default is true.
260 bertho 1.8
261     .TP
262     \fBthick_lines\fR \fInumber\fR
263     Set the thickness of connector lines between boxes. Normally, lines
264     are drawn one pixel wide, but can look somewhat thin. Setting the thickness
265     to anything over 5 would be plain ugly (but hey, who is to debate tast:-).
266     Values less than 1 and over 11 are clipped.
267     .br
268     Default is 1.
269 bertho 1.9
270     .TP
271     \fBparse_logs\fR \fIboolean\fR
272     Enable the parsing of the \fIentire\fR ,v file to read the log-entries between
273     revisions. This is necessary for the %l expansion to work, but slows down
274     parsing by a very large factor. You've been warned.
275     .br
276     Default is false.
277 bertho 1.7
278     .TP
279     \fBbranch_ttfont\fR \fIstring\fR
280     .TP
281     \fBbranch_tag_ttfont\fR \fIstring\fR
282     .TP
283     \fBrev_ttfont\fR \fIstring\fR
284     .TP
285     \fBrev_text_ttfont\fR \fIstring\fR
286     .TP
287     \fBtag_ttfont\fR \fIstring\fR
288     .TP
289     \fBtitle_ttfont\fR \fIstring\fR
290     Set the truetype font face or filename for the individual elements. Gd's bitmap
291     fonts are used as a fallback if the font cannot be found or contains errors.
292     .br
293     Default none.
294    
295     .TP
296     \fBbranch_ttsize\fR \fIfloat\fR
297     .TP
298     \fBbranch_tag_ttsize\fR \fIfloat\fR
299     .TP
300     \fBrev_ttsize\fR \fIfloat\fR
301     .TP
302     \fBrev_text_ttsize\fR \fIfloat\fR
303     .TP
304     \fBtag_ttsize\fR \fIfloat\fR
305     .TP
306     \fBtitle_ttsize\fR \fIfloat\fR
307     Set the truetype font size for the individual elements. See also *_ttfont.
308     .br
309     Default 0.0.
310    
311     .TP
312 bertho 1.1 \fBtag_font\fR \fInumber\fR
313     The font used to draw tags in the revision boxes.
314     .br
315     Default is tiny.
316    
317     .TP
318     \fBtag_color\fR \fIcolor\fR
319     The color used to draw tags in the revision boxes.
320     .br
321     Default is black ("#000000").
322    
323     .TP
324     \fBrev_font\fR \fInumber\fR
325     .br
326     Default is tiny.
327    
328     .TP
329     \fBrev_color\fR \fIcolor\fR
330     The color of revision boxes, including the revision number.
331     .br
332     Default is black ("#000000").
333    
334     .TP
335     \fBrev_bgcolor\fR \fIcolor\fR
336     Revision box background color. This is the interior fill of the
337     box.
338     .br
339     Default is white ("#ffffff").
340    
341     .TP
342 bertho 1.7 \fBrev_separator\fR \fInumber\fR
343     Space between tags in revision boxes.
344 bertho 1.1 .br
345     Default is 0.
346    
347     .TP
348     \fBrev_minline\fR \fInumber\fR
349     The minimum vertical distance between revision boxes.
350     .br
351     Default is 0.
352    
353     .TP
354     \fBrev_maxline\fR \fInumber\fR
355     The maximum vertical distance between revision boxes.
356 bertho 1.7 This has only effect if \fBauto_stretch\fR is set to true (or option '\fB-k\fR'
357 bertho 1.6 is specified).
358 bertho 1.1 .br
359 bertho 1.6 Default is 5 times \fBrev_minline\fR.
360 bertho 1.1
361     .TP
362     \fBrev_lspace\fR \fInumber\fR
363     .TP
364     \fBrev_rspace\fR \fInumber\fR
365     .TP
366     \fBrev_tspace\fR \fInumber\fR
367     .TP
368     \fBrev_bspace\fR \fInumber\fR
369 bertho 1.6 Interior spacing in revision boxes of left, right, top and bottom
370 bertho 1.1 respectively. Note that the left right spacing is not used separately
371     because text is center aligned.
372     .br
373     Default is 0.
374    
375     .TP
376     \fBrev_text\fR \fIstring\fR
377     The additional text in a revision box under the revision number.
378     .br
379     Default is "%d".
380    
381     .TP
382     \fBrev_text_font\fR \fInumber\fR
383     The font of the additional text in a revision box under the revision number.
384     .br
385     Default is tiny.
386    
387     .TP
388     \fBrev_text_color\fR \fIcolor\fR
389     The font color of the additional text in a revision box under the revision number.
390     .br
391     Default is black ("#000000").
392    
393     .TP
394     \fBbranch_font\fR \fInumber\fR
395 bertho 1.7 The font of the number in a branch box.
396     .br
397     Default is tiny.
398    
399     .TP
400     \fBbranch_tag_font\fR \fInumber\fR
401     The font of the tags in a branch box.
402 bertho 1.1 .br
403     Default is tiny.
404    
405     .TP
406     \fBbranch_color\fR \fIcolor\fR
407 bertho 1.7 All branch element's color excluding tags.
408     .br
409     Default is black ("#000000").
410    
411     .TP
412     \fBbranch_tag_color\fR \fIcolor\fR
413     All branch tags' color.
414 bertho 1.1 .br
415     Default is black ("#000000").
416    
417     .TP
418     \fBbranch_lspace\fR \fInumber\fR
419     .TP
420     \fBbranch_rspace\fR \fInumber\fR
421     .TP
422     \fBbranch_tspace\fR \fInumber\fR
423     .TP
424     \fBbranch_bspace\fR \fInumber\fR
425     Interior spacing of branch boxes.
426     .br
427     Default is 0.
428    
429     .TP
430     \fBbranch_margin\fR \fInumber\fR
431     Exterior spacing of branches. Each branch will be spaced
432     with a minimum of this value.
433     .br
434     Default is 0.
435    
436     .TP
437     \fBbranch_connect\fR \fInumber\fR
438     Length of the vertical connector from a revision to the branch box.
439     .br
440     Default is 0.
441 bertho 1.5
442     .TP
443 bertho 1.6 \fBbranch_dupbox\fR \fIboolean\fR
444     Add an extra branch box at the end of the trunk. Useful for upside down drawn
445     trees.
446 bertho 1.5 .br
447     Default is false.
448 bertho 1.1
449     .TP
450     \fBtitle\fR \fIstring\fR
451     The title of the image.
452     .br
453     Default is empty string.
454    
455     .TP
456     \fBtitle_x\fR \fInumber\fR
457     .TP
458     \fBtitle_y\fR \fInumber\fR
459     Postion of title.
460     .br
461     Default is 0.
462    
463     .TP
464     \fBtitle_font\fR \fInumber\fR
465     The font of the title.
466     .br
467     Default is tiny.
468    
469     .TP
470     \fBtitle_align\fR \fInumber\fR
471     Horizontal alignment of the title.
472     .br
473     Default is left.
474    
475     .TP
476     \fBtitle_color\fR \fIcolor\fR
477     The color of the title.
478     .br
479     Default is black ("#000000").
480    
481     .TP
482     \fBmargin_top\fR \fInumber\fR
483     .TP
484     \fBmargin_bottom\fR \fInumber\fR
485     .TP
486     \fBmargin_left\fR \fInumber\fR
487     .TP
488     \fBmargin_right\fR \fInumber\fR
489     Margins of the image. Note: the title position is not affected by
490     the margin.
491     .br
492     Default is 0.
493    
494     .TP
495     \fBimage_type\fR \fInumber\fR
496     Image types are available if they can be found in
497     the gd library. Newer versions of gd do not have
498     gif anymore. CvsGraph will automatically generate
499     png images instead.
500     .br
501     Default is dependent on availability and is prioritized in the order
502     png, gif and jpeg.
503    
504     .TP
505     \fBimage_quality\fR \fInumber\fR
506     The quality of a jpeg image (1..100)
507     .br
508     Default is 100.
509    
510     .TP
511     \fBmap_name\fR \fIstring\fR
512     The name= attribute in <map name="mapname">...</map> in the
513     generated HTML map.
514     .br
515     Default is "CvsGraphImageMap".
516    
517     .TP
518     \fBmap_branch_href\fR \fIstring\fR
519     .TP
520     \fBmap_rev_href\fR \fIstring\fR
521     .TP
522     \fBmap_diff_href\fR \fIstring\fR
523     These are the href= attributes in the <area>
524     tags of html.
525     .br
526 bertho 1.6 Default are:
527 bertho 1.1 .br
528     branch: "href=\\"unset: conf.map_branch_href\\""
529     .br
530     revision: "href=\\"unset: conf.map_rev_href\\""
531     .br
532     diff: "href=\\"unset: conf.map_diff_href\\""
533    
534     .TP
535     \fBmap_branch_alt\fR \fIstring\fR
536     .TP
537     \fBmap_rev_alt\fR \fIstring\fR
538     .TP
539     \fBmap_diff_alt\fR \fIstring\fR
540     These are the alt= attributes in the <area>
541     tags of html.
542     .br
543 bertho 1.6 Default are "alt=\\"%B\\"", "alt=\\"%R\\"" and
544     "alt=\\"%P &lt;\-&gt; %R\\"" respectively.
545 bertho 1.1
546     .SH "AUTHOR"
547     \fBCvsGraph\fR is written and maintained by B. Stultiens.
548     .br
549     Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and
550 bertho 1.3 visit the homepage at:
551     .br
552     \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.
553 bertho 1.1 .SH "SEE ALSO"
554     .BR cvsgraph(1)

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0