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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0