File: cvsgraph.conf.5

package info (click to toggle)
cvsgraph 1.1.2-4
  • links: PTS
  • area: main
  • in suites: woody
  • size: 264 kB
  • ctags: 325
  • sloc: ansic: 1,616; yacc: 596; lex: 338; makefile: 84; php: 42
file content (403 lines) | stat: -rw-r--r-- 8,038 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
.TH "cvsgraph.conf" "5" "1.1.1" "B. Stultiens" "CVS/RCS Utilties"
.SH "NAME"
cvsgraph.conf \- CVS/RCS repository grapher configuration
.SH "OVERVIEW"
The configuration file is a context free grammar where
empty lines and whitespace are ignored. Comments start
with '#' and everything until end of line is ignored.
.br
A configuration parameter is written as:
.br
	<keyword> = <argument> ;
.br
.LP
Keywords are defined in \fBPARAMETERS\fR. The argument
can be either numerical or string typed.

.LP
Numbers may be entered as octal, decimal or hex as in 0117,
79 and 0x4f respectively.

.LP
Strings are C\-style strings, enclosed in double quotes
in which characters may be escaped with '\\' and written
in octal and hex escapes. Note that '\\' must be escaped
if it is to be entered as a character.
.br
Some strings are expanded with printf like conversions
which start with '%'. Not all are applicable at all times,
in which case they will expand to nothing.
.br
Note that expansions of paths are available with and without
trailing '/'. The distinction is required for path construction
to ensure that empty expansions will not redirect the path to
root and no double '/' in a path is generated.
.TP
%c
cvsroot including a trailing '/' if non\-empty
.TP
%C
cvsroot without trailing '/', regardless of how it was entered
on the commandline
.TP
%m
cvsmodule including trailing '/' if non\-empty
.TP
%M
cvsmodule without trailing '/', regardless of how it was entered
on the commandline
.TP
%f
filename without path (\fIbasename <name>\fR functionality)
.TP
%F
filename without path and with ",v" stripped (\fIbasename <name> ,v\fR
functionality)
.TP
%p
path part of filename. This includes a trailing '/' if the
path is non\-empty
.TP
%r
number of revisions
.TP
%b
number of branches
.TP
%%
\'%\'
.TP
%R
the revision number (e.g. '1.2.4.4')
.TP
%P
previous revision number
.TP
%B
the branch number (e.g. '1.2.4')
.TP
%d
date of revision
.TP
%a
author of revision
.TP
%s
state of revision
.TP
%t
current tag of branch or revision
.TP
%0..%9
command\-line argument \-0 .. \-9

.LP
Fonts are numbered 0..4 (defined as in libgd) where
0 = tiny, 1 = small, 2 = medium (bold), 3 = large and
4 = giant.

.LP
Colors are a strings, similar to html\-type colors in the form
"#rrggbb" with parts written in hex, where rr = red (00..ff),
gg = green (00\-ff) and bb = blue (00\-ff).

.LP
There are several reserved words besides of the keywords.
These additional reserved words expand to numerical values:
.br
Booleans:
.br
	false  = 0
.br
	true   = 1
.br
Alignment specifiers:
.br
	left   = 0
.br
	center = 1
.br
	right  = 2
.br
Image specifiers:
.br
	gif    = 0
.br
	png    = 1
.br
	jpeg   = 2
.br
Font specifiers:
.br
	tiny   = 0
.br
	small  = 1
.br
	medium = 2
.br
	large  = 3
.br
	giant  = 4
.br

.SH "PARAMETERS"
.TP
\fBcvsroot\fR \fIstring\fR
The absolute base directory where the CSV/RCS repository can be found.
A '/' will be appended to the string if it is not empty and does not
contain a trailing '/'.
.br
Default is an empty string.

.TP
\fBcvsmodule\fR \fIstring\fR
The modulename of the CVS/RCS repository. This is converted into a
subdirectory name with a trailing '/'.
.br
Default is an empty string.

.TP
\fBcolor_bg\fR \fIcolor\fR
The background color of the image.
.br
Default is white ("#ffffff").

.TP
\fBdate_format\fR \fIstring\fR
The \fBstrftime(3)\fR format string for date and time representation in
the '%d' expansion.
.br
Default is "%d\-%b\-%Y %H:%M:%S".

.TP
\fBbox_shadow\fR \fInumber\fR
A boolean whether or not to draw a shadow for the boxes of
revisions and branches.
.br
Default is false.

.TP
\fBtag_font\fR \fInumber\fR
The font used to draw tags in the revision boxes.
.br
Default is tiny.

.TP
\fBtag_color\fR \fIcolor\fR
The color used to draw tags in the revision boxes.
.br
Default is black ("#000000").

.TP
\fBrev_font\fR \fInumber\fR
.br
Default is tiny.

.TP
\fBrev_color\fR \fIcolor\fR
The color of revision boxes, including the revision number.
.br
Default is black ("#000000").

.TP
\fBrev_bgcolor\fR \fIcolor\fR
Revision box background color. This is the interior fill of the
box.
.br
Default is white ("#ffffff").

.TP
rev_separator number
Obsolete. Space between tags in revision boxes.
.br
Default is 0.

.TP
\fBrev_minline\fR \fInumber\fR
The minimum vertical distance between revision boxes.
.br
Default is 0.

.TP
\fBrev_maxline\fR \fInumber\fR
The maximum vertical distance between revision boxes.
NOTE: This parameter is not yet used. It will become
significant when autostretch layout are implemented.
.br
Default is 0.

.TP
\fBrev_lspace\fR \fInumber\fR
.TP
\fBrev_rspace\fR \fInumber\fR
.TP
\fBrev_tspace\fR \fInumber\fR
.TP
\fBrev_bspace\fR \fInumber\fR
Interior spacing in revision boxes ofleft, right, top and bottom
respectively. Note that the left right spacing is not used separately
because text is center aligned.
.br
Default is 0.

.TP
\fBrev_text\fR \fIstring\fR
The additional text in a revision box under the revision number.
.br
Default is "%d".

.TP
\fBrev_text_font\fR \fInumber\fR
The font of the additional text in a revision box under the revision number.
.br
Default is tiny.

.TP
\fBrev_text_color\fR \fIcolor\fR
The font color of the additional text in a revision box under the revision number.
.br
Default is black ("#000000").

.TP
\fBbranch_font\fR \fInumber\fR
The font of the number and tags in a branch box.
.br
Default is tiny.

.TP
\fBbranch_color\fR \fIcolor\fR
All branch element's color.
.br
Default is black ("#000000").

.TP
\fBbranch_lspace\fR \fInumber\fR
.TP
\fBbranch_rspace\fR \fInumber\fR
.TP
\fBbranch_tspace\fR \fInumber\fR
.TP
\fBbranch_bspace\fR \fInumber\fR
Interior spacing of branch boxes.
.br
Default is 0.

.TP
\fBbranch_margin\fR \fInumber\fR
Exterior spacing of branches. Each branch will be spaced
with a minimum of this value.
.br
Default is 0.

.TP
\fBbranch_connect\fR \fInumber\fR
Length of the vertical connector from a revision to the branch box.
.br
Default is 0.

.TP
\fBtitle\fR \fIstring\fR
The title of the image.
.br
Default is empty string.

.TP
\fBtitle_x\fR \fInumber\fR
.TP
\fBtitle_y\fR \fInumber\fR
Postion of title.
.br
Default is 0.

.TP
\fBtitle_font\fR \fInumber\fR
The font of the title.
.br
Default is tiny.

.TP
\fBtitle_align\fR \fInumber\fR
Horizontal alignment of the title.
.br
Default is left.

.TP
\fBtitle_color\fR \fIcolor\fR
The color of the title.
.br
Default is black ("#000000").

.TP
\fBmargin_top\fR \fInumber\fR
.TP
\fBmargin_bottom\fR \fInumber\fR
.TP
\fBmargin_left\fR \fInumber\fR
.TP
\fBmargin_right\fR \fInumber\fR
Margins of the image. Note: the title position is not affected by
the margin.
.br
Default is 0.

.TP
\fBimage_type\fR \fInumber\fR
Image types are available if they can be found in
the gd library. Newer versions of gd do not have
gif anymore. CvsGraph will automatically generate
png images instead.
.br
Default is dependent on availability and is prioritized in the order
png, gif and jpeg.

.TP
\fBimage_quality\fR \fInumber\fR
The quality of a jpeg image (1..100)
.br
Default is 100.

.TP
\fBmap_name\fR \fIstring\fR
The name= attribute in <map name="mapname">...</map> in the
generated HTML map.
.br
Default is "CvsGraphImageMap".

.TP
\fBmap_branch_href\fR \fIstring\fR
.TP
\fBmap_rev_href\fR \fIstring\fR
.TP
\fBmap_diff_href\fR \fIstring\fR
These are the href= attributes in the <area>
tags of html.
.br
Default is:
.br
branch: "href=\\"unset: conf.map_branch_href\\""
.br
revision: "href=\\"unset: conf.map_rev_href\\""
.br
diff: "href=\\"unset: conf.map_diff_href\\""

.TP
\fBmap_branch_alt\fR \fIstring\fR
.TP
\fBmap_rev_alt\fR \fIstring\fR
.TP
\fBmap_diff_alt\fR \fIstring\fR
These are the alt= attributes in the <area>
tags of html.
.br
Default is "alt=\\"%B\\"", "alt=\\"%R\\"" and
"alt=\\"%P <\-> %R\\"" respectively.

.SH "AUTHOR"
\fBCvsGraph\fR is written and maintained by B. Stultiens.
.br
Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and
visit the homepage at:
.br
\fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.
.SH "SEE ALSO"
.BR cvsgraph(1)