/[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.3 - (hide annotations)
Thu Mar 22 21:42:48 2001 UTC (16 years, 7 months ago) by bertho
Branch: MAIN
CVS Tags: REL_1_1_2
Changes since 1.2: +23 -6 lines
- Dead tags (i.e. a tag without a valid revision or branch) does no
  longer print a message in quiet mode.
- Added expansions for cvsroot and cvsmodule without trailing '/'
- Remove core-files in a 'make clean'.
- Fixed default config file to use entities < and >.
1 bertho 1.1 .TH "cvsgraph.conf" "5" "1.1.1" "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.
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     \fBbox_shadow\fR \fInumber\fR
174     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     \fBtag_font\fR \fInumber\fR
181     The font used to draw tags in the revision boxes.
182     .br
183     Default is tiny.
184    
185     .TP
186     \fBtag_color\fR \fIcolor\fR
187     The color used to draw tags in the revision boxes.
188     .br
189     Default is black ("#000000").
190    
191     .TP
192     \fBrev_font\fR \fInumber\fR
193     .br
194     Default is tiny.
195    
196     .TP
197     \fBrev_color\fR \fIcolor\fR
198     The color of revision boxes, including the revision number.
199     .br
200     Default is black ("#000000").
201    
202     .TP
203     \fBrev_bgcolor\fR \fIcolor\fR
204     Revision box background color. This is the interior fill of the
205     box.
206     .br
207     Default is white ("#ffffff").
208    
209     .TP
210     rev_separator number
211     Obsolete. Space between tags in revision boxes.
212     .br
213     Default is 0.
214    
215     .TP
216     \fBrev_minline\fR \fInumber\fR
217     The minimum vertical distance between revision boxes.
218     .br
219     Default is 0.
220    
221     .TP
222     \fBrev_maxline\fR \fInumber\fR
223     The maximum vertical distance between revision boxes.
224     NOTE: This parameter is not yet used. It will become
225     significant when autostretch layout are implemented.
226     .br
227     Default is 0.
228    
229     .TP
230     \fBrev_lspace\fR \fInumber\fR
231     .TP
232     \fBrev_rspace\fR \fInumber\fR
233     .TP
234     \fBrev_tspace\fR \fInumber\fR
235     .TP
236     \fBrev_bspace\fR \fInumber\fR
237     Interior spacing in revision boxes ofleft, right, top and bottom
238     respectively. Note that the left right spacing is not used separately
239     because text is center aligned.
240     .br
241     Default is 0.
242    
243     .TP
244     \fBrev_text\fR \fIstring\fR
245     The additional text in a revision box under the revision number.
246     .br
247     Default is "%d".
248    
249     .TP
250     \fBrev_text_font\fR \fInumber\fR
251     The font of the additional text in a revision box under the revision number.
252     .br
253     Default is tiny.
254    
255     .TP
256     \fBrev_text_color\fR \fIcolor\fR
257     The font color of the additional text in a revision box under the revision number.
258     .br
259     Default is black ("#000000").
260    
261     .TP
262     \fBbranch_font\fR \fInumber\fR
263     The font of the number and tags in a branch box.
264     .br
265     Default is tiny.
266    
267     .TP
268     \fBbranch_color\fR \fIcolor\fR
269     All branch element's color.
270     .br
271     Default is black ("#000000").
272    
273     .TP
274     \fBbranch_lspace\fR \fInumber\fR
275     .TP
276     \fBbranch_rspace\fR \fInumber\fR
277     .TP
278     \fBbranch_tspace\fR \fInumber\fR
279     .TP
280     \fBbranch_bspace\fR \fInumber\fR
281     Interior spacing of branch boxes.
282     .br
283     Default is 0.
284    
285     .TP
286     \fBbranch_margin\fR \fInumber\fR
287     Exterior spacing of branches. Each branch will be spaced
288     with a minimum of this value.
289     .br
290     Default is 0.
291    
292     .TP
293     \fBbranch_connect\fR \fInumber\fR
294     Length of the vertical connector from a revision to the branch box.
295     .br
296     Default is 0.
297    
298     .TP
299     \fBtitle\fR \fIstring\fR
300     The title of the image.
301     .br
302     Default is empty string.
303    
304     .TP
305     \fBtitle_x\fR \fInumber\fR
306     .TP
307     \fBtitle_y\fR \fInumber\fR
308     Postion of title.
309     .br
310     Default is 0.
311    
312     .TP
313     \fBtitle_font\fR \fInumber\fR
314     The font of the title.
315     .br
316     Default is tiny.
317    
318     .TP
319     \fBtitle_align\fR \fInumber\fR
320     Horizontal alignment of the title.
321     .br
322     Default is left.
323    
324     .TP
325     \fBtitle_color\fR \fIcolor\fR
326     The color of the title.
327     .br
328     Default is black ("#000000").
329    
330     .TP
331     \fBmargin_top\fR \fInumber\fR
332     .TP
333     \fBmargin_bottom\fR \fInumber\fR
334     .TP
335     \fBmargin_left\fR \fInumber\fR
336     .TP
337     \fBmargin_right\fR \fInumber\fR
338     Margins of the image. Note: the title position is not affected by
339     the margin.
340     .br
341     Default is 0.
342    
343     .TP
344     \fBimage_type\fR \fInumber\fR
345     Image types are available if they can be found in
346     the gd library. Newer versions of gd do not have
347     gif anymore. CvsGraph will automatically generate
348     png images instead.
349     .br
350     Default is dependent on availability and is prioritized in the order
351     png, gif and jpeg.
352    
353     .TP
354     \fBimage_quality\fR \fInumber\fR
355     The quality of a jpeg image (1..100)
356     .br
357     Default is 100.
358    
359     .TP
360     \fBmap_name\fR \fIstring\fR
361     The name= attribute in <map name="mapname">...</map> in the
362     generated HTML map.
363     .br
364     Default is "CvsGraphImageMap".
365    
366     .TP
367     \fBmap_branch_href\fR \fIstring\fR
368     .TP
369     \fBmap_rev_href\fR \fIstring\fR
370     .TP
371     \fBmap_diff_href\fR \fIstring\fR
372     These are the href= attributes in the <area>
373     tags of html.
374     .br
375     Default is:
376     .br
377     branch: "href=\\"unset: conf.map_branch_href\\""
378     .br
379     revision: "href=\\"unset: conf.map_rev_href\\""
380     .br
381     diff: "href=\\"unset: conf.map_diff_href\\""
382    
383     .TP
384     \fBmap_branch_alt\fR \fIstring\fR
385     .TP
386     \fBmap_rev_alt\fR \fIstring\fR
387     .TP
388     \fBmap_diff_alt\fR \fIstring\fR
389     These are the alt= attributes in the <area>
390     tags of html.
391     .br
392     Default is "alt=\\"%B\\"", "alt=\\"%R\\"" and
393     "alt=\\"%P <\-> %R\\"" respectively.
394    
395     .SH "AUTHOR"
396     \fBCvsGraph\fR is written and maintained by B. Stultiens.
397     .br
398     Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and
399 bertho 1.3 visit the homepage at:
400     .br
401     \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.
402 bertho 1.1 .SH "SEE ALSO"
403     .BR cvsgraph(1)

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0