/[CvsGraph]/cvsgraph/cvsgraph.conf.5
ViewVC logotype

Diff of /cvsgraph/cvsgraph.conf.5

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.24, Sun Aug 15 16:58:22 2004 UTC revision 1.30, Sat Oct 23 00:25:32 2004 UTC
# Line 1  Line 1 
1  .TH "cvsgraph.conf" "5" "1.5.0" "B. Stultiens" "CVS/RCS Utilties"  .TH "cvsgraph.conf" "5" "1.5.1" "B. Stultiens" "CVS/RCS Utilities"
2  .SH "NAME"  .SH "NAME"
3  cvsgraph.conf \- CVS/RCS repository grapher configuration  cvsgraph.conf \- CVS/RCS repository grapher configuration
4  .SH "OVERVIEW"  .SH "OVERVIEW"
# Line 37  Line 37 
37  root and no double '/' in a path is generated.  root and no double '/' in a path is generated.
38  .TP  .TP
39  %c  %c
40  cvsroot including a trailing '/' if non\-empty  CVS root including a trailing '/' if non\-empty
41  .TP  .TP
42  %C  %C
43  cvsroot without trailing '/', regardless of how it was entered  CVS root without trailing '/', regardless of how it was entered
44  on the commandline  on the command line
45  .TP  .TP
46  %m  %m
47  cvsmodule including trailing '/' if non\-empty  CVS module including trailing '/' if non\-empty
48  .TP  .TP
49  %M  %M
50  cvsmodule without trailing '/', regardless of how it was entered  CVS module without trailing '/', regardless of how it was entered
51  on the commandline  on the command line
52  .TP  .TP
53  %f  %f
54  filename without path (\fIbasename <name>\fR functionality)  filename without path (\fIbasename <name>\fR functionality)
# Line 89  Line 89 
89  state of revision  state of revision
90  .TP  .TP
91  %l  %l
92  The logentry of the revision. You need to enable \fBparse_logs\fR for this to  The log entry of the revision. You need to enable \fBparse_logs\fR for this to
93  work. You may append an optional truncate length by writing '[num]' (with num  work. You may append an optional truncate length by writing '[num]' (with num
94  the maximum length) directly after %l. If no trunction is specified, then all  the maximum length) directly after %l. If no truncation is specified, then all
95  will be expanded. Specifying a negative truncation length means that newlines  will be expanded. Specifying a negative truncation length means that newlines
96  should be replaced by spaces. If truncation occurs, then "..." will be  should be replaced by spaces. If truncation occurs, then "..." will be
97  appended. The expansion is scanned for possible html-entities and are replaced  appended. The expansion is scanned for possible HTML entities and are replaced
98  by &#...; equivalents.  by &#...; equivalents.
99  .br  .br
100  For example: "%l[25]" will expand up to 25 characters of the log.  For example: "%l[25]" will expand up to 25 characters of the log.
# Line 102  Line 102 
102  Note: This expansion is obsolete. Please use "%(%L%)"; see comment below.  Note: This expansion is obsolete. Please use "%(%L%)"; see comment below.
103  .TP  .TP
104  %L  %L
105  Same as %l, but no html-entity translations are performed.  Same as %l, but no HTML entity translations are performed.
106  .TP  .TP
107  %t  %t
108  current tag of branch or revision  current tag of branch or revision
# Line 111  Line 111 
111  command\-line argument \-0 .. \-9  command\-line argument \-0 .. \-9
112  .TP  .TP
113  %(...%)  %(...%)
114  HTMLize the string withing the parenthesis. This is usefull to prevent a  HTMLize the string withing the parenthesis. This is useful to prevent a
115  possible cross site scripting big when expanding tags into the map generation.  possible cross site scripting bug when expanding tags into the map generation.
116  For an exploit, you need to have an attack on your cvs-server, or you need to  For an exploit, you need to have an attack on your CVS server, or you need to
117  be a complete idiot to enter a tag with '<', '>' or '"' characters.  be a complete idiot to enter a tag with '<', '>' or '"' characters.
118  .br  .br
119  Example: a string "%(%t%)", with tag \fB><script xxx="..."><\fR will expand to  Example: a string "%(%t%)", with tag \fB><script xxx="..."><\fR will expand to
# Line 129  Line 129 
129  4 = giant.  4 = giant.
130    
131  .LP  .LP
132  Colors are strings, similar to html\-type colors in the form  Colors are strings, similar to HTML type colors in the form
133  "#rrggbb" with parts written in hex, where rr = red (00..ff),  "#rrggbb" with parts written in hex, where rr = red (00\-ff),
134  gg = green (00\-ff) and bb = blue (00\-ff).  gg = green (00\-ff) and bb = blue (00\-ff).
135    
136  .LP  .LP
137  Booleans have three possible arguments: true, false and not. `Not' means  Booleans have three possible arguments: true, false and not. `Not' means
138  inverse of what it was (logical negation) and is represented by the value -1.  inverse of what it was (logical negation) and is represented by the value -1.
139  For the configuration file that means that the default value is negated.  For the configuration file that means that the default value is negated.
140  However, the not possibility is a very handy tool for commandline overrides  However, the not possibility is a very handy tool for command line overrides
141  generated from (CGI-)scripts.  generated from (CGI) scripts.
142    
143  .LP  .LP
144  There are several reserved words besides of the keywords.  There are several reserved words besides of the keywords.
# Line 192  Line 192 
192  .SH "PARAMETERS"  .SH "PARAMETERS"
193  .TP  .TP
194  \fBcvsroot\fR \fIstring\fR  \fBcvsroot\fR \fIstring\fR
195  The absolute base directory where the CSV/RCS repository can be found.  The absolute base directory where the CVS/RCS repository can be found.
196  A '/' will be appended to the string if it is not empty and does not  A '/' will be appended to the string if it is not empty and does not
197  contain a trailing '/'.  contain a trailing '/'.
198  .br  .br
# Line 200  Line 200 
200    
201  .TP  .TP
202  \fBcvsmodule\fR \fIstring\fR  \fBcvsmodule\fR \fIstring\fR
203  The modulename of the CVS/RCS repository. This is converted into a  The module name in the CVS/RCS repository. This is converted into a
204  subdirectory name with a trailing '/'.  subdirectory name with a trailing '/'.
205  .br  .br
206  Default is an empty string.  Default is an empty string.
# Line 214  Line 214 
214  .TP  .TP
215  \fBtransparent_bg\fR \fIboolean\fR  \fBtransparent_bg\fR \fIboolean\fR
216  The background color of the image is to be the transparent color. This is  The background color of the image is to be the transparent color. This is
217  only usefull for PNG images. Be sure to set \fBcolor_bg\fR to something  only useful for PNG images. Be sure to set \fBcolor_bg\fR to something
218  reasonable to make sure that the image is viewable with programs that do not  reasonable to make sure that the image is viewable with programs that do not
219  support transparency.  support transparency.
220  .br  .br
# Line 251  Line 251 
251    
252  .TP  .TP
253  \fBstrip_untagged\fR \fIboolean\fR  \fBstrip_untagged\fR \fIboolean\fR
254  Ommit all revisions that do not have tags and are not a branchpoint. This  Omit all revisions that do not have tags and are not a branch point. This
255  reduces the image-size, but can be confusing when looking for a specific  reduces the image-size, but can be confusing when looking for a specific
256  revision. See also \fBcvsgraph(1)\fR option '\fB-s\fR'.  revision. See also \fBcvsgraph(1)\fR option '\fB-s\fR'.
257  .br  .br
# Line 259  Line 259 
259    
260  .TP  .TP
261  \fBstrip_first_rev\fR \fIboolean\fR  \fBstrip_first_rev\fR \fIboolean\fR
262  Also ommit the first revision in a branch if it does not have tags and is not a  Also omit the first revision in a branch if it does not have tags and is not a
263  branchpoint. This has only effect if \fBstrip_untagged\fR is set. See also  branch point. This has only effect if \fBstrip_untagged\fR is set. See also
264  \fBcvsgraph(1)\fR option '\fB-S\fR'.  \fBcvsgraph(1)\fR option '\fB-S\fR'.
265  .br  .br
266  Default is false.  Default is false.
# Line 274  Line 274 
274    
275  .TP  .TP
276  \fBuse_ttf\fR \fIboolean\fR  \fBuse_ttf\fR \fIboolean\fR
277  Enable truetype rendering of strings using the FreeType interface of libgd.  Enable TrueType rendering of strings using the FreeType interface of libgd.
278  Note that ttf rendering is significantly slower than libgd's bitmap fonts.  Note that ttf rendering is significantly slower than libgd's bitmap fonts.
279  .br  .br
280  Default is false.  Default is false.
281    
282  .TP  .TP
283  \fBanti_alias\fR \fIboolean\fR  \fBanti_alias\fR \fIboolean\fR
284  Enable antialias rendering of truetype fonts. This has only effect if  Enable antialias rendering of TrueType fonts. This has only effect if
285  \fBuse_ttf\fR is set. Enabling anti_alias gives very nice results.  \fBuse_ttf\fR is set. Enabling anti_alias gives very nice results.
286  However, that is at the expense of 8-bit vs. 4-bit colormap images,  However, that is at the expense of 8-bit vs. 4-bit colormap images,
287  which can be a major drawback because the size of 8-bit images is 3..4  which can be a major drawback because the size of 8-bit images is 3..4
# Line 293  Line 293 
293  \fBthick_lines\fR \fInumber\fR  \fBthick_lines\fR \fInumber\fR
294  Set the thickness of connector lines between boxes. Normally, lines  Set the thickness of connector lines between boxes. Normally, lines
295  are drawn one pixel wide, but can look somewhat thin. Setting the thickness  are drawn one pixel wide, but can look somewhat thin. Setting the thickness
296  to anything over 5 would be plain ugly (but hey, who is to debate tast:-).  to anything over 5 would be plain ugly (but hey, who is to debate taste :-).
297  Values less than 1 and over 11 are clipped.  Values less than 1 and over 11 are clipped.
298  .br  .br
299  Default is 1.  Default is 1.
# Line 310  Line 310 
310  \fBhtml_level\fR \fInumber\fR  \fBhtml_level\fR \fInumber\fR
311  Set the compliance to different types of HTML. The generated image map is  Set the compliance to different types of HTML. The generated image map is
312  slightly different for version 3.x, 4.x and XHTML. You can use the predefined  slightly different for version 3.x, 4.x and XHTML. You can use the predefined
313  identifiers (HTML3, HTML4 and XHTML) to set this value. Commandline option '\fB-x\fR'  identifiers (HTML3, HTML4 and XHTML) to set this value. Command line option
314  overrides the setting.  '\fB-x\fR' overrides the setting.
315  .br  .br
316  Default is HTML3 (3.x compatibility).  Default is HTML3 (3.x compatibility).
317    
# Line 329  Line 329 
329  \fBtitle_ttfont\fR \fIstring\fR  \fBtitle_ttfont\fR \fIstring\fR
330  .TP  .TP
331  \fBmsg_ttfont\fR \fIstring\fR  \fBmsg_ttfont\fR \fIstring\fR
332  Set the truetype font face or filename for the individual elements. Gd's bitmap  Set the TrueType font face or filename for the individual elements. Gd's bitmap
333  fonts are used as a fallback if the font cannot be found or contains errors.  fonts are used as a fallback if the font cannot be found or contains errors.
334  .br  .br
335  Default none.  Default none.
# Line 348  Line 348 
348  \fBtitle_ttsize\fR \fIfloat\fR  \fBtitle_ttsize\fR \fIfloat\fR
349  .TP  .TP
350  \fBmsg_ttsize\fR \fIfloat\fR  \fBmsg_ttsize\fR \fIfloat\fR
351  Set the truetype font size for the individual elements. See also *_ttfont.  Set the TrueType font size for the individual elements. See also *_ttfont.
352  .br  .br
353  Default 0.0.  Default 0.0.
354    
# Line 391  Line 391 
391  Default is false.  Default is false.
392    
393  .TP  .TP
394    \fBtag_ignore_merge\fR \fIboolean\fR
395    If set, then tags matched with \fBtag_ignore\fR will no longer be considered
396    for matching by \fBmerge_from\fR and \fBmerge_to\fR.
397    .br
398    Default is false.
399    
400    .TP
401  \fBrev_font\fR \fInumber\fR  \fBrev_font\fR \fInumber\fR
402  .br  .br
403  Default is tiny.  Default is tiny.
# Line 476  Line 483 
483  Default is 0, meaning all tags shown.  Default is 0, meaning all tags shown.
484    
485  .TP  .TP
486    \fBrev_hidenumber\fR \fIboolean\fR
487    If set, then no revision number is displayed in the revisionboxes. This reduces
488    size for those graphs where the actual revision-number is irrelevant.
489    .br
490    Default is false.
491    
492    .TP
493  \fBmsg_font\fR \fInumber\fR  \fBmsg_font\fR \fInumber\fR
494  The font used to draw error and warning messages at the bottom of the graph.  The font used to draw error and warning messages at the bottom of the graph.
495  .br  .br
# Line 495  Line 509 
509    
510  .TP  .TP
511  \fBmerge_front\fR \fIboolean\fR  \fBmerge_front\fR \fIboolean\fR
512  The mergelines are drawn on top of the image if true. Otherwise, mergelines  The merge lines are drawn on top of the image if true. Otherwise, merge lines
513  are drawn underneath.  are drawn underneath.
514  .br  .br
515  Default is false.  Default is false.
# Line 540  Line 554 
554  Default is empty (no matching occurs).  Default is empty (no matching occurs).
555    
556  .TP  .TP
557    \fBmerge_findall\fR \fIboolean\fR
558    Normally, \fBmerge_from\fR/m\fBerge_to\fR will only find the first matching
559    tag-combination and draw a line between them, If \fBmerge_findall\fR is set,
560    then all matching \fBmerge_to\fRs will result in lines from the from-tag to the
561    to-tag.
562    .br
563    Default is false.
564    
565    .TP
566  \fBmerge_arrows\fR \fIboolean\fR  \fBmerge_arrows\fR \fIboolean\fR
567  .br  .br
568  Enable the use of arrows pointing to the merge destination.  Enable the use of arrows pointing to the merge destination.
# Line 547  Line 570 
570  Default is true.  Default is true.
571    
572  .TP  .TP
573    \fBmerge_cvsnt\fR \fIboolean\fR
574    .br
575    Enable drawing of mergepoints as used by CVSNT.
576    .br
577    Default is true.
578    
579    .TP
580    \fBmerge_cvsnt_color\fR \fIcolor\fR
581    The color of the lines to show merges from mergepoints.
582    .br
583    Default is black ("#000000").
584    
585    .TP
586  \fBarrow_width\fR \fInumber\fR  \fBarrow_width\fR \fInumber\fR
587  .TP  .TP
588  \fBarrow_length\fR \fInumber\fR  \fBarrow_length\fR \fInumber\fR
# Line 629  Line 665 
665  this option is not set, then multiple boxes will be created if the empty  this option is not set, then multiple boxes will be created if the empty
666  branches are interspaced with ones that have revisions attached. When this  branches are interspaced with ones that have revisions attached. When this
667  option is set, then all empty branches will be collected and put into the  option is set, then all empty branches will be collected and put into the
668  box of the firts occuring empty branch on the revision's branchpoint.  box of the first occurring empty branch on the revision's branch point.
669  Setting this option will reduce imagesize with interspaced commits to the  Setting this option will reduce image size with interspaced commits to the
670  a maximum.  a maximum.
671  .br  .br
672  Default is false.  Default is false.
673    
674  .TP  .TP
675    \fBbranch_resort\fR \fIboolean\fR
676    Resort the branches according to the number of revisions they have, where less
677    revisions will stick closer to the sprouting trunk. This will reduce image size
678    under circumstances where many branches have significant different number of
679    revisions.
680    .br
681    Default is false.
682    
683    .TP
684  \fBbranch_subtree\fR \fIstring\fR  \fBbranch_subtree\fR \fIstring\fR
685  Reduce the tree only to include the subtree from the branch-number given in the  Reduce the tree only to include the subtree from the branch-number given in the
686  argument. If the argument is a revision which is the root of branches, then all  argument. If the argument is a revision which is the root of branches, then all
687  those branches will be shown. The argument can also be a symbolic tag (either a  those branches will be shown. The argument can also be a symbolic tag (either a
688  branch- or revision-tag). You normally would set this option from the  branch- or revision-tag). You normally would set this option from the
689  commandline with the -O option for interactive flexibility.  command line with the -O option for interactive flexibility.
690  .br  .br
691  Example: branch_subtree = "1.2.4";  Example: branch_subtree = "1.2.4";
692  .br  .br
# Line 657  Line 702 
702  \fBtitle_x\fR \fInumber\fR  \fBtitle_x\fR \fInumber\fR
703  .TP  .TP
704  \fBtitle_y\fR \fInumber\fR  \fBtitle_y\fR \fInumber\fR
705  Postion of title.  Position of title.
706  .br  .br
707  Default is 0.  Default is 0.
708    
# Line 709  Line 754 
754  Default is 100.  Default is 100.
755    
756  .TP  .TP
757    \fBimage_compress\fR \fInumber\fR
758    Set the compression level of png images (-1..9). Zero means no compression. A
759    higher number means higher compression. Minus one selects the default library
760    setting.
761    .br
762    Default is -1.
763    
764    .TP
765    \fBimage_interlace\fR \fIboolean\fR
766    Write png and jpeg images in interlaced format. This enables progressive
767    loading in your browser (if supported).
768    .br
769    Default is false.
770    
771    .TP
772  \fBmap_name\fR \fIstring\fR  \fBmap_name\fR \fIstring\fR
773  The name= attribute in <map name="mapname">...</map> in the  The name= attribute in <map name="mapname">...</map> in the
774  generated HTML map.  generated HTML map.
# Line 724  Line 784 
784  .TP  .TP
785  \fBmap_merge_href\fR \fIstring\fR  \fBmap_merge_href\fR \fIstring\fR
786  These are the href= attributes in the <area>  These are the href= attributes in the <area>
787  tags of html.  tags of HTML.
788  .br  .br
789  Default are:  Default are:
790  .br  .br
# Line 745  Line 805 
805  .TP  .TP
806  \fBmap_merge_alt\fR \fIstring\fR  \fBmap_merge_alt\fR \fIstring\fR
807  These are the alt= attributes in the <area>  These are the alt= attributes in the <area>
808  tags of html.  tags of HTML.
809  .br  .br
810  Default are "alt=\\"%B\\"", "alt=\\"%R\\"",  Default are "alt=\\"%B\\"", "alt=\\"%R\\"",
811  "alt=\\"%P &lt;\-&gt; %R\\"" and "alt=\\"%P &lt;\-&gt; %R\\"" respectively.  "alt=\\"%P &lt;\-&gt; %R\\"" and "alt=\\"%P &lt;\-&gt; %R\\"" respectively.
# Line 753  Line 813 
813  .SH "AUTHOR"  .SH "AUTHOR"
814  \fBCvsGraph\fR is written and maintained by B. Stultiens.  \fBCvsGraph\fR is written and maintained by B. Stultiens.
815  .br  .br
816  Send comments and bugreports to \fIcvsgraph@akhphd.au.dk\fR and  Send comments and bug reports to \fIcvsgraph@akhphd.au.dk\fR and
817  visit the homepage at:  visit the homepage at:
818  .br  .br
819  \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph\fR.  \fIhttp://www.akhphd.au.dk/~bertho/cvsgraph/\fR.
820  .SH "SEE ALSO"  .SH "SEE ALSO"
821  .BR cvsgraph(1)  .BR cvsgraph(1)

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.30

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0