/[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.6 - (hide annotations)
Tue Jan 1 21:03:23 2002 UTC (15 years, 9 months ago) by bertho
Branch: MAIN
Changes since 1.5: +34 -17 lines
Major code update to enable some more features. The new formatting scheme is
not yet 100%. This should be close to version 1.2.0.
1 bertho 1.6 .TH "cvsgraph.conf" "5" "1.2.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     79 and 0x4f respectively.
20    
21     .LP
22     Strings are C\-style strings, enclosed in double quotes
23     in which characters may be escaped with '\\' and written
24     in octal and hex escapes. Note that '\\' must be escaped
25 bertho 1.6 if it is to be entered as a character. Escapes recognized
26     are '\\[abfnrtv]', '\\[xX][0-9a-fA-F]{2}' and '\\[012][0-7]{0,2}'.
27 bertho 1.1 .br
28     Some strings are expanded with printf like conversions
29     which start with '%'. Not all are applicable at all times,
30     in which case they will expand to nothing.
31 bertho 1.3 .br
32     Note that expansions of paths are available with and without
33     trailing '/'. The distinction is required for path construction
34     to ensure that empty expansions will not redirect the path to
35     root and no double '/' in a path is generated.
36 bertho 1.1 .TP
37     %c
38 bertho 1.3 cvsroot including a trailing '/' if non\-empty
39     .TP
40     %C
41     cvsroot without trailing '/', regardless of how it was entered
42     on the commandline
43 bertho 1.1 .TP
44     %m
45 bertho 1.3 cvsmodule including trailing '/' if non\-empty
46     .TP
47     %M
48     cvsmodule without trailing '/', regardless of how it was entered
49     on the commandline
50 bertho 1.1 .TP
51     %f
52 bertho 1.3 filename without path (\fIbasename <name>\fR functionality)
53 bertho 1.1 .TP
54     %F
55 bertho 1.3 filename without path and with ",v" stripped (\fIbasename <name> ,v\fR
56     functionality)
57 bertho 1.1 .TP
58     %p
59 bertho 1.3 path part of filename. This includes a trailing '/' if the
60     path is non\-empty
61 bertho 1.1 .TP
62     %r
63     number of revisions
64     .TP
65     %b
66     number of branches
67     .TP
68     %%
69 bertho 1.6 literal '%'
70 bertho 1.1 .TP
71     %R
72     the revision number (e.g. '1.2.4.4')
73     .TP
74     %P
75     previous revision number
76     .TP
77     %B
78     the branch number (e.g. '1.2.4')
79     .TP
80     %d
81     date of revision
82     .TP
83     %a
84     author of revision
85     .TP
86     %s
87     state of revision
88     .TP
89     %t
90     current tag of branch or revision
91     .TP
92     %0..%9
93     command\-line argument \-0 .. \-9
94    
95     .LP
96 bertho 1.6 Fonts are numbered 0..4 (as defined in libgd) where
97 bertho 1.1 0 = tiny, 1 = small, 2 = medium (bold), 3 = large and
98     4 = giant.
99    
100     .LP
101     Colors are a strings, similar to html\-type colors in the form
102     "#rrggbb" with parts written in hex, where rr = red (00..ff),
103     gg = green (00\-ff) and bb = blue (00\-ff).
104    
105     .LP
106     There are several reserved words besides of the keywords.
107     These additional reserved words expand to numerical values:
108     .br
109     Booleans:
110     .br
111     false = 0
112     .br
113     true = 1
114     .br
115     Alignment specifiers:
116     .br
117     left = 0
118     .br
119     center = 1
120     .br
121     right = 2
122     .br
123     Image specifiers:
124     .br
125     gif = 0
126     .br
127     png = 1
128     .br
129     jpeg = 2
130     .br
131     Font specifiers:
132     .br
133     tiny = 0
134     .br
135     small = 1
136     .br
137     medium = 2
138     .br
139     large = 3
140     .br
141     giant = 4
142     .br
143    
144     .SH "PARAMETERS"
145     .TP
146     \fBcvsroot\fR \fIstring\fR
147     The absolute base directory where the CSV/RCS repository can be found.
148     A '/' will be appended to the string if it is not empty and does not
149     contain a trailing '/'.
150     .br
151     Default is an empty string.
152    
153     .TP
154     \fBcvsmodule\fR \fIstring\fR
155     The modulename of the CVS/RCS repository. This is converted into a
156     subdirectory name with a trailing '/'.
157     .br
158     Default is an empty string.
159    
160     .TP
161     \fBcolor_bg\fR \fIcolor\fR
162     The background color of the image.
163     .br
164     Default is white ("#ffffff").
165    
166     .TP
167     \fBdate_format\fR \fIstring\fR
168     The \fBstrftime(3)\fR format string for date and time representation in
169     the '%d' expansion.
170     .br
171     Default is "%d\-%b\-%Y %H:%M:%S".
172    
173     .TP
174 bertho 1.5 \fBbox_shadow\fR \fIboolean\fR
175 bertho 1.1 A boolean whether or not to draw a shadow for the boxes of
176     revisions and branches.
177     .br
178     Default is false.
179    
180     .TP
181 bertho 1.5 \fBupside_down\fR \fIboolean\fR
182     Draw the entire tree upside down if set. I.e. highest revisions are
183 bertho 1.6 at the top of the image. See also cvsgraph(1) option '\fB-u\fR'.
184 bertho 1.5 .br
185     Default is false.
186    
187     .TP
188     \fBstrip_untagged\fR \fIboolean\fR
189 bertho 1.6 Ommit all revisions that do not have tags and are not a branchpoint. This
190     reduces the image-size, but can be confusing when looking for a specific
191     revision. See also cvsgraph(1) option '\fB-s\fR'.
192     .br
193     Default is false.
194    
195     .TP
196     \fBstrip_first_rev\fR \fIboolean\fR
197     Also ommit the first revision in a branch if it does not have tags and is not a
198     branchpoint. This has only effect if \fBstrip_untagged\fR is set. See also
199     cvsgraph(1) option '\fB-S\fR'.
200     .br
201     Default is false.
202    
203     .TP
204     \fBauto_kern\fR \fIboolean\fR
205     Try to stretch the inter\-revision spacing to move the trunks more to the left,
206     effectively reducing the image's size. See also cvsgraph(1) option '\fB-k\fR'.
207 bertho 1.5 .br
208     Default is false.
209    
210     .TP
211 bertho 1.1 \fBtag_font\fR \fInumber\fR
212     The font used to draw tags in the revision boxes.
213     .br
214     Default is tiny.
215    
216     .TP
217     \fBtag_color\fR \fIcolor\fR
218     The color used to draw tags in the revision boxes.
219     .br
220     Default is black ("#000000").
221    
222     .TP
223     \fBrev_font\fR \fInumber\fR
224     .br
225     Default is tiny.
226    
227     .TP
228     \fBrev_color\fR \fIcolor\fR
229     The color of revision boxes, including the revision number.
230     .br
231     Default is black ("#000000").
232    
233     .TP
234     \fBrev_bgcolor\fR \fIcolor\fR
235     Revision box background color. This is the interior fill of the
236     box.
237     .br
238     Default is white ("#ffffff").
239    
240     .TP
241     rev_separator number
242     Obsolete. Space between tags in revision boxes.
243     .br
244     Default is 0.
245    
246     .TP
247     \fBrev_minline\fR \fInumber\fR
248     The minimum vertical distance between revision boxes.
249     .br
250     Default is 0.
251    
252     .TP
253     \fBrev_maxline\fR \fInumber\fR
254     The maximum vertical distance between revision boxes.
255 bertho 1.6 This has only effect if \fBauto_kern\fR is set to true (or option '\fB-k\fR'
256     is specified).
257 bertho 1.1 .br
258 bertho 1.6 Default is 5 times \fBrev_minline\fR.
259 bertho 1.1
260     .TP
261     \fBrev_lspace\fR \fInumber\fR
262     .TP
263     \fBrev_rspace\fR \fInumber\fR
264     .TP
265     \fBrev_tspace\fR \fInumber\fR
266     .TP
267     \fBrev_bspace\fR \fInumber\fR
268 bertho 1.6 Interior spacing in revision boxes of left, right, top and bottom
269 bertho 1.1 respectively. Note that the left right spacing is not used separately
270     because text is center aligned.
271     .br
272     Default is 0.
273    
274     .TP
275     \fBrev_text\fR \fIstring\fR
276     The additional text in a revision box under the revision number.
277     .br
278     Default is "%d".
279    
280     .TP
281     \fBrev_text_font\fR \fInumber\fR
282     The font of the additional text in a revision box under the revision number.
283     .br
284     Default is tiny.
285    
286     .TP
287     \fBrev_text_color\fR \fIcolor\fR
288     The font color of the additional text in a revision box under the revision number.
289     .br
290     Default is black ("#000000").
291    
292     .TP
293     \fBbranch_font\fR \fInumber\fR
294     The font of the number and tags in a branch box.
295     .br
296     Default is tiny.
297    
298     .TP
299     \fBbranch_color\fR \fIcolor\fR
300     All branch element's color.
301     .br
302     Default is black ("#000000").
303    
304     .TP
305     \fBbranch_lspace\fR \fInumber\fR
306     .TP
307     \fBbranch_rspace\fR \fInumber\fR
308     .TP
309     \fBbranch_tspace\fR \fInumber\fR
310     .TP
311     \fBbranch_bspace\fR \fInumber\fR
312     Interior spacing of branch boxes.
313     .br
314     Default is 0.
315    
316     .TP
317     \fBbranch_margin\fR \fInumber\fR
318     Exterior spacing of branches. Each branch will be spaced
319     with a minimum of this value.
320     .br
321     Default is 0.
322    
323     .TP
324     \fBbranch_connect\fR \fInumber\fR
325     Length of the vertical connector from a revision to the branch box.
326     .br
327     Default is 0.
328 bertho 1.5
329     .TP
330 bertho 1.6 \fBbranch_dupbox\fR \fIboolean\fR
331     Add an extra branch box at the end of the trunk. Useful for upside down drawn
332     trees.
333 bertho 1.5 .br
334     Default is false.
335 bertho 1.1
336     .TP
337     \fBtitle\fR \fIstring\fR
338     The title of the image.
339     .br
340     Default is empty string.
341    
342     .TP
343     \fBtitle_x\fR \fInumber\fR
344     .TP
345     \fBtitle_y\fR \fInumber\fR
346     Postion of title.
347     .br
348     Default is 0.
349    
350     .TP
351     \fBtitle_font\fR \fInumber\fR
352     The font of the title.
353     .br
354     Default is tiny.
355    
356     .TP
357     \fBtitle_align\fR \fInumber\fR
358     Horizontal alignment of the title.
359     .br
360     Default is left.
361    
362     .TP
363     \fBtitle_color\fR \fIcolor\fR
364     The color of the title.
365     .br
366     Default is black ("#000000").
367    
368     .TP
369     \fBmargin_top\fR \fInumber\fR
370     .TP
371     \fBmargin_bottom\fR \fInumber\fR
372     .TP
373     \fBmargin_left\fR \fInumber\fR
374     .TP
375     \fBmargin_right\fR \fInumber\fR
376     Margins of the image. Note: the title position is not affected by
377     the margin.
378     .br
379     Default is 0.
380    
381     .TP
382     \fBimage_type\fR \fInumber\fR
383     Image types are available if they can be found in
384     the gd library. Newer versions of gd do not have
385     gif anymore. CvsGraph will automatically generate
386     png images instead.
387     .br
388     Default is dependent on availability and is prioritized in the order
389     png, gif and jpeg.
390    
391     .TP
392     \fBimage_quality\fR \fInumber\fR
393     The quality of a jpeg image (1..100)
394     .br
395     Default is 100.
396    
397     .TP
398     \fBmap_name\fR \fIstring\fR
399     The name= attribute in <map name="mapname">...</map> in the
400     generated HTML map.
401     .br
402     Default is "CvsGraphImageMap".
403    
404     .TP
405     \fBmap_branch_href\fR \fIstring\fR
406     .TP
407     \fBmap_rev_href\fR \fIstring\fR
408     .TP
409     \fBmap_diff_href\fR \fIstring\fR
410     These are the href= attributes in the <area>
411     tags of html.
412     .br
413 bertho 1.6 Default are:
414 bertho 1.1 .br
415     branch: "href=\\"unset: conf.map_branch_href\\""
416     .br
417     revision: "href=\\"unset: conf.map_rev_href\\""
418     .br
419     diff: "href=\\"unset: conf.map_diff_href\\""
420    
421     .TP
422     \fBmap_branch_alt\fR \fIstring\fR
423     .TP
424     \fBmap_rev_alt\fR \fIstring\fR
425     .TP
426     \fBmap_diff_alt\fR \fIstring\fR
427     These are the alt= attributes in the <area>
428     tags of html.
429     .br
430 bertho 1.6 Default are "alt=\\"%B\\"", "alt=\\"%R\\"" and
431     "alt=\\"%P &lt;\-&gt; %R\\"" respectively.
432 bertho 1.1
433     .SH "AUTHOR"
434     \fBCvsGraph\fR is written and maintained by B. Stultiens.
435     .br
436     Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and
437 bertho 1.3 visit the homepage at:
438     .br
439     \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.
440 bertho 1.1 .SH "SEE ALSO"
441     .BR cvsgraph(1)

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0