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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0