/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.19 - (show annotations)
Mon Mar 10 22:57:21 2003 UTC (14 years, 8 months ago) by bertho
Branch: MAIN
Changes since 1.18: +4 -1 lines
*** empty log message ***
1 CvsGraph 1.3.0, 20-Jul-2002
2 ===========================
3 CvsGraph creates a graphic representation of the revisions and branches in a
4 cvs/rcs repository. CvsGraph is inspired on the 'graph'-option from WinCVS. I
5 could not find something right away on the web and decided that it was time to
6 write a stand-alone version. I might have been doing some double work, but hey,
7 I like a hack.
8
9
10
11 New in this version
12 -------------------
13 - Fix warnings in readconf on some 'older' compiler systems.
14
15 - Implement new option to generate proper maps for different levels of HTML.
16 The option -x[34x] determines HTML 3.x (default), HTML 4.x or XHTML style
17 maps.
18
19 - Implement a scheme to visualize merges based on tag names. If tags are
20 consistently named at the mergepoint and the destination, then these points
21 can be detected using regular expressions. Several new configuration
22 options, merge_*, describe the tags.
23
24 - Implemented HTMLizing of expansion with %(...%). This prevents a possible
25 cross site scripting exploit when you use '<', '>' or '"' in tagnames.
26 This is a remote chance (you must be stupid to use these characters in a
27 tagname) but anyway, your system can be under attack.
28
29 - Fixed backing up in the lexer. This improves speed slightly because no
30 rule requires lookahead over one character anymore.
31
32
33
34 Compiling
35 ---------
36
37 create directory:
38 $ cd /where/ever/you/want
39 $ tar xzf cvsgraph-1.3.0.tar.gz
40 $ cd cvsgraph-1.3.0
41 $ ./configure
42 $ make
43
44 This should do the trick and you have an executable file 'cvsgraph' in the
45 current directory.
46
47 NOTE: The GD library is required for CvsGraph to function. Get it from
48 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
49 and --with-gd-inc=DIR to specify its location. You might also have
50 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
51 for gd versions 1.6 and higher.
52 If you build with static libgd (i.e. libgd.a) and already have
53 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
54 try to trick configure into adding these libs to the tests by adding
55 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
56 If you have linked libgd with freetype, then you might also need
57 either --with-freetype-lib or --with-freetype2-lib.
58
59
60
61 Installing
62 ----------
63 Put the executable file 'cvsgraph' somewhere where you think it should go.
64 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
65 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
66 overriden on the commandline anyway. Edit the configuration file to your liking
67 and you should be all set.
68
69
70
71 Running CvsGraph
72 ----------------
73 Do *NOT* execute the program directly from a webserver. Direct execution would
74 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
75 normally use. The easiest way is to get the ViewCVS package from their website
76 at http://viewcvs.sourceforge.net and follow the instructions.
77
78 Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
79 several scripts and patches available from the CvsGraph homepage (see below for
80 address). However, the scripts are no longer maintained because ViewCVS has
81 native support now.
82
83 To generate an image do something like:
84 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
85
86 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
87 into 'mygraph.png'. The '-r' option is the path to the repository *located and
88 accessible* on your filesystem. The '-m' is the module in the repository. Note
89 that the extension of the file ends with ",v".
90
91 Just to make it clear: You cannot make images from a cvs-repository over the
92 internet as if you were using cvs. The repository files
93 must be on a locally mounted filesystem. However, you
94 can use cvsup or rsync to get a repository to your
95 local filesystem and make then images from there.
96
97 Type 'cvsgraph -h' to get a full list of options. If the output is not given
98 (no '-o'), then the output is written to standard output.
99
100 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
101 information on execution and configuration.
102
103
104
105 Todo
106 ----
107 - do a better job in making a layout (auto moving branches and rubber banding
108 revision-connectors to make place). A start is made, but this is not very
109 functional yet.
110
111 - draw only a part or parts of the tree.
112
113
114
115 License
116 -------
117 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
118
119
120
121 Contact
122 -------
123 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
124 E-mail: cvsgraph@akhphd.au.dk
125
126 Greetings Bertho
127

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0