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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0