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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0