CvsGraph/cvsgraph/cvsgraph.conf

# CvsGraph configuration
#
# - Empty lines and whitespace are ignored.
#
# - Comments start with '#' and everything until
#   end of line is ignored.
#
# - Strings are C-style strings 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.
#
# - 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.
#	%c = cvsroot (with trailing '/')
#	%C = cvsroot (*without* trailing '/')
#	%m = module (with trailing '/')
#	%M = module (*without* trailing '/')
#	%f = filename without path
#	%F = filename without path and with ",v" stripped
#	%p = path part of filename (with trailing '/')
#	%r = number of revisions
#	%b = number of branches
#	%% = '%'
#	%R = the revision number (e.g. '1.2.4.4')
#	%P = previous revision number
#	%B = the branch number (e.g. '1.2.4')
#	%d = date of revision
#	%a = author of revision
#	%s = state of revision
#	%t = current tag of branch or revision
#	%0..%9 = command-line argument -0 .. -9
#	%l = htmlized logentry of the revision
#		NOTE: %l is obsolete. See %(%) and cvsgraph.conf(5) for
#		more details.
#	%L = logentry of revision
#		The logentry expansion take an optional argument to
#		specify max length of the expansion like %L[25].
#	%(...%) = HTMLize the string withing the parenthesis.
#
# - Numbers may be entered as octal, decimal or
#   hex as in 0117, 79 and 0x4f respectively.
#
# - Fonts are numbered 0..4 (defined as in libgd)
#	0 = tiny
#	1 = small
#	2 = medium (bold)
#	3 = large
#	4 = giant
#
# - Colors are a string like html-type colors in
#   the form "#rrggbb" with parts written in hex
#	rr = red (00..ff)
#	gg = green (00-ff)
#	bb = blue (00-ff)
#
# - There are several reserved words besides of the
#   feature-keywords. These additional reserved words
#   expand to numerical values:
#	* false	 = 0
#	* true	 = 1
#	* not	 = -1
#	* left	 = 0
#	* center = 1
#	* right	 = 2
#	* gif	 = 0
#	* png	 = 1
#	* jpeg	 = 2
#	* tiny	 = 0
#	* small	 = 1
#	* medium = 2
#	* large	 = 3
#	* giant	 = 4
#
# - Booleans have three possible arguments: true, false
#   and not. `Not' means inverse of what it was (logical
#   negation) and is represented by the value -1.
#   For the configuration file that means that the default
#   value is negated.
#

# cvsroot <string>
#	The *absolute* base directory where the
#	CSV/RCS repository can be found
# cvsmodule <string>
#
cvsroot		= "/home/bertho/tmp/cvstest";
cvsmodule	= "ttt";

# color_bg <color>
#	The background color of the image
# transparent_bg <boolean>
#	Make color_bg the transparent color (only usefull with PNG)
color_bg	= "#ffffff";
transparent_bg	= false;

# date_format <string>
#	The strftime(3) format string for date and time
date_format	= "%d-%b-%Y %H:%M:%S";

# box_shadow <boolean>
#	Add a shadow around the boxes
# upside_down <boolean>
#	Reverse the order of the revisions
# left_right <boolean>
#	Draw the image left to right instead of top down,
#	or right to left is upside_down is set simulatiously.
# strip_untagged <boolean>
#	Remove all untagged revisions except the first, last and tagged ones
# strip_first_rev <boolean>
#	Also remove the first revision if untagged
# auto_stretch <boolean>
#	Try to reformat the tree to minimize image size
# use_ttf <boolean>
#	Use TrueType fonts for text
# anti_alias <boolean>
#	Enable pretty TrueType anti-alias drawing
# thick_lines <number>
#	Draw all connector lines thicker (range: 1..11)
box_shadow	= true;
upside_down	= false;
left_right	= false;
strip_untagged	= false;
strip_first_rev	= false;
#auto_stretch	= true;		# not yet stable.
use_ttf		= false;
anti_alias	= true;
thick_lines	= 1;

# parse_logs <boolean>
#	Enable the parsing of the *entire* ,v file to read the
#	log-entries between revisions. This is necessary for
#	the %L expansion to work, but slows down parsing by
#	a very large factor. You're warned.
parse_logs	= false;

tag_font	= medium;
tag_ttfont	= "/dos/windows/fonts/ariali.ttf";
tag_ttsize	= 11.0;
tag_color	= "#007000";

rev_font	= giant;
rev_ttfont	= "/dos/windows/fonts/arial.ttf";
rev_ttsize	= 12.0;
rev_color	= "#000000";
rev_bgcolor	= "#f0f0f0";
rev_separator	= 1;
rev_minline	= 15;
rev_maxline	= 75;
rev_lspace	= 5;
rev_rspace	= 5;
rev_tspace	= 3;
rev_bspace	= 3;
rev_text	= "%d";	# or "%d\n%a, %s" for author and state too
rev_text_font	= tiny;
rev_text_ttfont	= "/dos/windows/fonts/times.ttf";
rev_text_ttsize	= 9.0;
rev_text_color	= "#500020";
rev_maxtags	= 25;

# merge_color <color>
#	The color of the line connecting merges
# merge_front <boolean>
#	If true, draw the merge-lines on top if the image
# merge_nocase <boolean>
#	Ignore case in regular expressions
# merge_from <string>
#	A regex describing a tag that is used as the merge source
# merge_to <string>
#	A regex describing a tag that is the target of the merge
# merge_arrows <boolean>
#	Use arrows to point to the merge destination. Default is true.
# arrow_width <number>
# arrow_length <number>
#	Specify the size of the arrows. Default is 3 wide and 12 long.
#
# NOTE:
# - The merge_from is an extended regular expression as described in
#   regex(7) and POSIX 1003.2 (see also Single Unix Specification at
#   http://www.opengroup.com).
# - The merge_to is an extended regular expression with a twist. All
#   subexpressions from the merge_from are expanded into merge_to
#   using %[1-9] (in contrast to \[1-9] for backreferences). Care is
#   taken to escape the constructed expression.
# - A '$' at the end of the merge_to expression can be important to
#   prevent 'near match' references. Normally, you want the destination
#   to be a good representation of the source. However, this depends
#   on how well you defined the tags in the first place.
#
# Example:
#	merge_from = "^f_(.*)";
#	merge_to = "^t_%1$";
#	tags: f_foo, f_bar, f_foobar, t_foo, t_bar
#	result:
#		f_foo	-> "^t_foo$"	-> t_foo
#		f_bar	-> "^t_bar$"	-> t_bar
#		f_foobar-> "^t_foobar$"	-> <no match>
#
merge_color	= "#a000a0";
merge_front	= false;
merge_nocase	= false;
merge_from	= "^f_(.*)";
merge_to	= "^t_%1$";

#merge_arrows	= true;
#arrow_width	= 3;
#arrow_length	= 12;


# branch_font <number>
#	The font of the number and tags
# branch_color <color>
#	All branch element's color
# branch_[lrtb]space <number>
#	Interior spacing (margin)
# branch_margin <number>
#	Exterior spacing
# branch_connect <number>
#	Length of the vertical connector
# branch_dupbox <boolean>
#	Add the branch-tag also at the bottom/top of the trunk
# branch_fold <boolean>
#	Fold empty branches in one box to save space
# branch_foldall <boolean>
#	Put all empty branches in one box, even if they
#       were interspaced with branches with revisions.
branch_font	= medium;
branch_ttfont	= "/dos/windows/fonts/arialbd.ttf";
branch_ttsize	= 18.0;
branch_tag_color= "#000080";
branch_tag_font	= medium;
branch_tag_ttfont = "/dos/windows/fonts/arialbi.ttf";
branch_tag_ttsize = 14.0;
branch_color	= "#0000c0";
branch_bgcolor	= "#ffffc0";
branch_lspace	= 5;
branch_rspace	= 5;
branch_tspace	= 3;
branch_bspace	= 3;
branch_margin	= 15;
branch_connect	= 8;
branch_dupbox	= false;
branch_fold	= true;
branch_foldall	= false;

# title <string>
#	The title string is expanded (see above for details)
# title_[xy] <number>
#	Postion of title
# title_font <number>
#	The font
# title_align <number>
#	0 = left
#	1 = center
#	2 = right
# title_color <color>
title		= "%c%m%f\nRevisions: %r, Branches: %b";
title_x		= 10;
title_y		= 5;
title_font	= small;
title_ttfont	= "/dos/windows/fonts/times.ttf";
title_ttsize	= 10.0;
title_align	= left;
title_color	= "#800000";

# Margins of the image
# Note: the title is outside the margin
margin_top	= 35;
margin_bottom	= 10;
margin_left	= 10;
margin_right	= 10;

# Image format(s)
# image_type <number|{gif,jpeg,png}>
#	gif  (0) = Create gif image
#	png  (1) = Create png image
#	jpeg (2) = Create jpeg image
#	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.
# image_quality <number>
#	The quality of a jpeg image (1..100)
image_type	= png;
image_quality	= 75;

# HTML ImageMap generation
# map_name <string>
#	The name= attribute in <map name="mapname">...</map>
# map_branch_href <string>
# map_branch_alt <string>
# map_rev_href <string>
# map_rev_alt <string>
# map_diff_href <string>
# map_diff_alt <string>
#	These are the href= and alt= attributes in the <area>
#	tags of html. The strings are expanded (see above).
map_name	= "MyMapName";
map_branch_href	= "href=\"%9cvsweb_graph.cgi/%m%p?only_with_tag=%(%t%)%8\"";
map_branch_alt	= "alt=\"%0 %(%t%) (%B)\"";
map_rev_href	= "href=\"%9cvsweb_graph.cgi/%m%p%F?rev=%R&content-type=text/x-cvsweb-markup%8\"";
map_rev_alt	= "alt=\"%1 %(%t%) (%R)\"";
map_diff_href	= "href=\"%9cvsweb_graph.cgi/%m%p%F.diff?r1=%P&r2=%R%8\"";
map_diff_alt	= "alt=\"%2 %P &lt;-&gt; %R\"";

1	bertho	1.1	# CvsGraph configuration
2			#
3	bertho	1.4	# - Empty lines and whitespace are ignored.
4			#
5	bertho	1.1	# - Comments start with '#' and everything until
6			# end of line is ignored.
7	bertho	1.4	#
8	bertho	1.1	# - Strings are C-style strings in which characters
9			# may be escaped with '\' and written in octal
10			# and hex escapes. Note that '\' must be escaped
11			# if it is to be entered as a character.
12	bertho	1.4	#
13	bertho	1.5	# - Some strings are expanded with printf like
14			# conversions which start with '%'. Not all
15			# are applicable at all times, in which case they
16	bertho	1.16	# will expand to nothing.
17	bertho	1.6	# %c = cvsroot (with trailing '/')
18	bertho	1.9	# %C = cvsroot (without trailing '/')
19	bertho	1.6	# %m = module (with trailing '/')
20	bertho	1.9	# %M = module (without trailing '/')
21	bertho	1.5	# %f = filename without path
22			# %F = filename without path and with ",v" stripped
23			# %p = path part of filename (with trailing '/')
24			# %r = number of revisions
25			# %b = number of branches
26			# %% = '%'
27			# %R = the revision number (e.g. '1.2.4.4')
28	bertho	1.6	# %P = previous revision number
29	bertho	1.5	# %B = the branch number (e.g. '1.2.4')
30	bertho	1.6	# %d = date of revision
31			# %a = author of revision
32			# %s = state of revision
33	bertho	1.5	# %t = current tag of branch or revision
34			# %0..%9 = command-line argument -0 .. -9
35	bertho	1.16	# %l = htmlized logentry of the revision
36	bertho	1.19	# NOTE: %l is obsolete. See %(%) and cvsgraph.conf(5) for
37			# more details.
38	bertho	1.16	# %L = logentry of revision
39	bertho	1.19	# The logentry expansion take an optional argument to
40			# specify max length of the expansion like %L[25].
41			# %(...%) = HTMLize the string withing the parenthesis.
42	bertho	1.5	#
43	bertho	1.1	# - Numbers may be entered as octal, decimal or
44	bertho	1.4	# hex as in 0117, 79 and 0x4f respectively.
45			#
46	bertho	1.1	# - Fonts are numbered 0..4 (defined as in libgd)
47	bertho	1.4	# 0 = tiny
48			# 1 = small
49			# 2 = medium (bold)
50			# 3 = large
51			# 4 = giant
52	bertho	1.1	#
53			# - Colors are a string like html-type colors in
54			# the form "#rrggbb" with parts written in hex
55			# rr = red (00..ff)
56			# gg = green (00-ff)
57			# bb = blue (00-ff)
58			#
59	bertho	1.4	# - There are several reserved words besides of the
60			# feature-keywords. These additional reserved words
61			# expand to numerical values:
62			# * false = 0
63			# * true = 1
64	bertho	1.15	# * not = -1
65	bertho	1.4	# * left = 0
66			# * center = 1
67			# * right = 2
68			# * gif = 0
69			# * png = 1
70			# * jpeg = 2
71			# * tiny = 0
72			# * small = 1
73			# * medium = 2
74			# * large = 3
75			# * giant = 4
76	bertho	1.15	#
77			# - Booleans have three possible arguments: true, false
78			# and not. `Not' means inverse of what it was (logical
79			# negation) and is represented by the value -1.
80			# For the configuration file that means that the default
81			# value is negated.
82			#
83	bertho	1.1
84			# cvsroot <string>
85			# The absolute base directory where the
86			# CSV/RCS repository can be found
87			# cvsmodule <string>
88			#
89			cvsroot = "/home/bertho/tmp/cvstest";
90			cvsmodule = "ttt";
91
92	bertho	1.6	# color_bg <color>
93			# The background color of the image
94	bertho	1.14	# transparent_bg <boolean>
95			# Make color_bg the transparent color (only usefull with PNG)
96	bertho	1.1	color_bg = "#ffffff";
97	bertho	1.14	transparent_bg = false;
98	bertho	1.1
99	bertho	1.6	# date_format <string>
100			# The strftime(3) format string for date and time
101			date_format = "%d-%b-%Y %H:%M:%S";
102
103	bertho	1.13	# box_shadow <boolean>
104	bertho	1.11	# Add a shadow around the boxes
105			# upside_down <boolean>
106			# Reverse the order of the revisions
107	bertho	1.17	# left_right <boolean>
108			# Draw the image left to right instead of top down,
109			# or right to left is upside_down is set simulatiously.
110	bertho	1.13	# strip_untagged <boolean>
111	bertho	1.17	# Remove all untagged revisions except the first, last and tagged ones
112	bertho	1.13	# strip_first_rev <boolean>
113			# Also remove the first revision if untagged
114	bertho	1.14	# auto_stretch <boolean>
115	bertho	1.13	# Try to reformat the tree to minimize image size
116	bertho	1.15	# use_ttf <boolean>
117			# Use TrueType fonts for text
118			# anti_alias <boolean>
119			# Enable pretty TrueType anti-alias drawing
120			# thick_lines <number>
121			# Draw all connector lines thicker (range: 1..11)
122	bertho	1.6	box_shadow = true;
123	bertho	1.11	upside_down = false;
124	bertho	1.17	left_right = false;
125	bertho	1.13	strip_untagged = false;
126			strip_first_rev = false;
127	bertho	1.15	#auto_stretch = true; # not yet stable.
128	bertho	1.14	use_ttf = false;
129			anti_alias = true;
130	bertho	1.15	thick_lines = 1;
131	bertho	1.16
132			# parse_logs <boolean>
133			# Enable the parsing of the entire ,v file to read the
134			# log-entries between revisions. This is necessary for
135	bertho	1.19	# the %L expansion to work, but slows down parsing by
136	bertho	1.16	# a very large factor. You're warned.
137			parse_logs = false;
138	bertho	1.6
139	bertho	1.4	tag_font = medium;
140	bertho	1.14	tag_ttfont = "/dos/windows/fonts/ariali.ttf";
141			tag_ttsize = 11.0;
142	bertho	1.6	tag_color = "#007000";
143	bertho	1.1
144	bertho	1.4	rev_font = giant;
145	bertho	1.14	rev_ttfont = "/dos/windows/fonts/arial.ttf";
146			rev_ttsize = 12.0;
147	bertho	1.1	rev_color = "#000000";
148	bertho	1.6	rev_bgcolor = "#f0f0f0";
149	bertho	1.1	rev_separator = 1;
150			rev_minline = 15;
151	bertho	1.14	rev_maxline = 75;
152	bertho	1.1	rev_lspace = 5;
153			rev_rspace = 5;
154			rev_tspace = 3;
155			rev_bspace = 3;
156	bertho	1.14	rev_text = "%d"; # or "%d\n%a, %s" for author and state too
157	bertho	1.6	rev_text_font = tiny;
158	bertho	1.14	rev_text_ttfont = "/dos/windows/fonts/times.ttf";
159			rev_text_ttsize = 9.0;
160	bertho	1.6	rev_text_color = "#500020";
161	bertho	1.18	rev_maxtags = 25;
162	bertho	1.1
163	bertho	1.19	# merge_color <color>
164			# The color of the line connecting merges
165			# merge_front <boolean>
166			# If true, draw the merge-lines on top if the image
167			# merge_nocase <boolean>
168			# Ignore case in regular expressions
169			# merge_from <string>
170			# A regex describing a tag that is used as the merge source
171			# merge_to <string>
172			# A regex describing a tag that is the target of the merge
173	bertho	1.22	# merge_arrows <boolean>
174			# Use arrows to point to the merge destination. Default is true.
175			# arrow_width <number>
176			# arrow_length <number>
177			# Specify the size of the arrows. Default is 3 wide and 12 long.
178	bertho	1.19	#
179			# NOTE:
180			# - The merge_from is an extended regular expression as described in
181			# regex(7) and POSIX 1003.2 (see also Single Unix Specification at
182			# http://www.opengroup.com).
183			# - The merge_to is an extended regular expression with a twist. All
184			# subexpressions from the merge_from are expanded into merge_to
185			# using %[1-9] (in contrast to \[1-9] for backreferences). Care is
186			# taken to escape the constructed expression.
187			# - A '$' at the end of the merge_to expression can be important to
188			# prevent 'near match' references. Normally, you want the destination
189			# to be a good representation of the source. However, this depends
190			# on how well you defined the tags in the first place.
191			#
192			# Example:
193			# merge_from = "^f_(.*)";
194			# merge_to = "^t_%1$";
195			# tags: f_foo, f_bar, f_foobar, t_foo, t_bar
196			# result:
197			# f_foo -> "^t_foo$" -> t_foo
198			# f_bar -> "^t_bar$" -> t_bar
199			# f_foobar-> "^t_foobar$" -> <no match>
200			#
201			merge_color = "#a000a0";
202			merge_front = false;
203			merge_nocase = false;
204			merge_from = "^f_(.*)";
205			merge_to = "^t_%1$";
206	bertho	1.22
207			#merge_arrows = true;
208			#arrow_width = 3;
209			#arrow_length = 12;
210
211	bertho	1.19
212	bertho	1.4	# branch_font <number>
213			# The font of the number and tags
214			# branch_color <color>
215			# All branch element's color
216			# branch_[lrtb]space <number>
217			# Interior spacing (margin)
218			# branch_margin <number>
219			# Exterior spacing
220			# branch_connect <number>
221			# Length of the vertical connector
222	bertho	1.12	# branch_dupbox <boolean>
223	bertho	1.11	# Add the branch-tag also at the bottom/top of the trunk
224	bertho	1.20	# branch_fold <boolean>
225			# Fold empty branches in one box to save space
226	bertho	1.21	# branch_foldall <boolean>
227			# Put all empty branches in one box, even if they
228			# were interspaced with branches with revisions.
229	bertho	1.4	branch_font = medium;
230	bertho	1.14	branch_ttfont = "/dos/windows/fonts/arialbd.ttf";
231			branch_ttsize = 18.0;
232			branch_tag_color= "#000080";
233			branch_tag_font = medium;
234			branch_tag_ttfont = "/dos/windows/fonts/arialbi.ttf";
235			branch_tag_ttsize = 14.0;
236	bertho	1.1	branch_color = "#0000c0";
237	bertho	1.6	branch_bgcolor = "#ffffc0";
238	bertho	1.1	branch_lspace = 5;
239			branch_rspace = 5;
240			branch_tspace = 3;
241			branch_bspace = 3;
242	bertho	1.4	branch_margin = 15;
243			branch_connect = 8;
244	bertho	1.12	branch_dupbox = false;
245	bertho	1.20	branch_fold = true;
246	bertho	1.21	branch_foldall = false;
247	bertho	1.1
248			# title <string>
249	bertho	1.5	# The title string is expanded (see above for details)
250	bertho	1.1	# title_[xy] <number>
251			# Postion of title
252			# title_font <number>
253			# The font
254			# title_align <number>
255			# 0 = left
256			# 1 = center
257			# 2 = right
258	bertho	1.4	# title_color <color>
259	bertho	1.6	title = "%c%m%f\nRevisions: %r, Branches: %b";
260	bertho	1.1	title_x = 10;
261			title_y = 5;
262	bertho	1.6	title_font = small;
263	bertho	1.14	title_ttfont = "/dos/windows/fonts/times.ttf";
264			title_ttsize = 10.0;
265	bertho	1.4	title_align = left;
266	bertho	1.1	title_color = "#800000";
267
268			# Margins of the image
269			# Note: the title is outside the margin
270	bertho	1.6	margin_top = 35;
271	bertho	1.1	margin_bottom = 10;
272			margin_left = 10;
273			margin_right = 10;
274
275	bertho	1.2	# Image format(s)
276			# image_type <number\|{gif,jpeg,png}>
277			# gif (0) = Create gif image
278			# png (1) = Create png image
279			# jpeg (2) = Create jpeg image
280			# Image types are available if they can be found in
281			# the gd library. Newer versions of gd do not have
282			# gif anymore. CvsGraph will automatically generate
283			# png images instead.
284			# image_quality <number>
285			# The quality of a jpeg image (1..100)
286	bertho	1.6	image_type = png;
287	bertho	1.2	image_quality = 75;
288
289	bertho	1.3	# HTML ImageMap generation
290	bertho	1.5	# map_name <string>
291	bertho	1.7	# The name= attribute in <map name="mapname">...</map>
292	bertho	1.5	# map_branch_href <string>
293			# map_branch_alt <string>
294			# map_rev_href <string>
295			# map_rev_alt <string>
296	bertho	1.6	# map_diff_href <string>
297			# map_diff_alt <string>
298	bertho	1.5	# These are the href= and alt= attributes in the <area>
299			# tags of html. The strings are expanded (see above).
300	bertho	1.3	map_name = "MyMapName";
301	bertho	1.19	map_branch_href = "href=\"%9cvsweb_graph.cgi/%m%p?only_with_tag=%(%t%)%8\"";
302			map_branch_alt = "alt=\"%0 %(%t%) (%B)\"";
303	bertho	1.10	map_rev_href = "href=\"%9cvsweb_graph.cgi/%m%p%F?rev=%R&content-type=text/x-cvsweb-markup%8\"";
304	bertho	1.19	map_rev_alt = "alt=\"%1 %(%t%) (%R)\"";
305	bertho	1.10	map_diff_href = "href=\"%9cvsweb_graph.cgi/%m%p%F.diff?r1=%P&r2=%R%8\"";
306	bertho	1.8	map_diff_alt = "alt=\"%2 %P <-> %R\"";
307	bertho	1.3