cvsgraph.conf(5)

NAME
cvsgraph.conf - CVS/RCS repository grapher configuration

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.
A configuration parameter is written as:
    <keyword> = <argument> ;

Keywords are defined in PARAMETERS. The argument can be either numerical or string typed.

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

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.
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.
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.

%c  cvsroot including a trailing '/' if non-empty

%C  cvsroot without trailing '/', regardless of how it was entered on the commandline

%m  cvsmodule including trailing '/' if non-empty

%M  cvsmodule without trailing '/', regardless of how it was entered on the commandline

%f  filename without path (basename <name> functionality)

%F  filename without path and with ",v" stripped (basename <name> ,v functionality)

%p  path part of filename. This includes a trailing '/' if the path is non-empty

%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

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

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).

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

PARAMETERS

cvsroot string
    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 '/'.
    Default is an empty string.

cvsmodule string
    The modulename of the CVS/RCS repository. This is converted into a subdirectory name with a trailing '/'.
    Default is an empty string.

color_bg color
    The background color of the image.
    Default is white ("#ffffff").

date_format string
    The strftime(3) format string for date and time representation in the '%d' expansion.
    Default is "%d-%b-%Y %H:%M:%S".

box_shadow number
    A boolean whether or not to draw a shadow for the boxes of revisions and branches.
    Default is false.

tag_font number
    The font used to draw tags in the revision boxes.
    Default is tiny.

tag_color color
    The color used to draw tags in the revision boxes.
    Default is black ("#000000").

rev_font number
    Default is tiny.

rev_color color
    The color of revision boxes, including the revision number.
    Default is black ("#000000").

rev_bgcolor color
    Revision box background color. This is the interior fill of the box.
    Default is white ("#ffffff").

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

rev_minline number
    The minimum vertical distance between revision boxes.
    Default is 0.

rev_maxline number
    The maximum vertical distance between revision boxes. NOTE: This parameter is not yet used. It will become significant when autostretch layout are implemented.
    Default is 0.

rev_lspace number

rev_rspace number

rev_tspace number

rev_bspace number
    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.
    Default is 0.

rev_text string
    The additional text in a revision box under the revision number.
    Default is "%d".

rev_text_font number
    The font of the additional text in a revision box under the revision number.
    Default is tiny.

rev_text_color color
    The font color of the additional text in a revision box under the revision number.
    Default is black ("#000000").

branch_font number
    The font of the number and tags in a branch box.
    Default is tiny.

branch_color color
    All branch element's color.
    Default is black ("#000000").

branch_lspace number

branch_rspace number

branch_tspace number

branch_bspace number
    Interior spacing of branch boxes.
    Default is 0.

branch_margin number
    Exterior spacing of branches. Each branch will be spaced with a minimum of this value.
    Default is 0.

branch_connect number
    Length of the vertical connector from a revision to the branch box.
    Default is 0.

title string
    The title of the image.
    Default is empty string.

title_x number

title_y number
    Postion of title.
    Default is 0.

title_font number
    The font of the title.
    Default is tiny.

title_align number
    Horizontal alignment of the title.
    Default is left.

title_color color
    The color of the title.
    Default is black ("#000000").

margin_top number

margin_bottom number

margin_left number

margin_right number
    Margins of the image. Note: the title position is not affected by the margin.
    Default is 0.

image_type number
    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.
    Default is dependent on availability and is prioritized in the order png, gif and jpeg.

image_quality number
    The quality of a jpeg image (1..100)
    Default is 100.

map_name string
    The name= attribute in <map name="mapname">...</map> in the generated HTML map.
    Default is "CvsGraphImageMap".

map_branch_href string

map_rev_href string

map_diff_href string
    These are the href= attributes in the <area> tags of html.
    Default is:
    branch: "href=\"unset: conf.map_branch_href\""
    revision: "href=\"unset: conf.map_rev_href\""
    diff: "href=\"unset: conf.map_diff_href\""

map_branch_alt string

map_rev_alt string

map_diff_alt string
    These are the alt= attributes in the <area> tags of html.
    Default is "alt=\"%B\"", "alt=\"%R\"" and "alt=\"%P <-> %R\"" respectively.

AUTHOR
CvsGraph is written and maintained by B. Stultiens.
Send comments and bugreports to cvsgraph@akhphd.au.dk and visit the homepage at:
http://www.akhphd.au.dk/~bertho/cvsgraph.

SEE ALSO
cvsgraph(1)