/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.17 - (show annotations)
Tue Feb 11 10:43:44 2003 UTC (14 years, 9 months ago) by bertho
Branch: MAIN
Changes since 1.16: +4 -30 lines
- Implement different HTML levels for imagemaps.
- Add new commandline option for HTML level
- Update docs
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
20
21 Compiling
22 ---------
23
24 create directory:
25 $ cd /where/ever/you/want
26 $ tar xzf cvsgraph-1.3.0.tar.gz
27 $ cd cvsgraph-1.3.0
28 $ ./configure
29 $ make
30
31 This should do the trick and you have an executable file 'cvsgraph' in the
32 current directory.
33
34 NOTE: The GD library is required for CvsGraph to function. Get it from
35 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
36 and --with-gd-inc=DIR to specify its location. You might also have
37 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
38 for gd versions 1.6 and higher.
39 If you build with static libgd (i.e. libgd.a) and already have
40 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
41 try to trick configure into adding these libs to the tests by adding
42 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
43 If you have linked libgd with freetype, then you might also need
44 either --with-freetype-lib or --with-freetype2-lib.
45
46
47
48 Installing
49 ----------
50 Put the executable file 'cvsgraph' somewhere where you think it should go.
51 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
52 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
53 overriden on the commandline anyway. Edit the configuration file to your liking
54 and you should be all set.
55
56
57
58 Running CvsGraph
59 ----------------
60 Do *NOT* execute the program directly from a webserver. Direct execution would
61 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
62 normally use. The easiest way is to get the ViewCVS package from their website
63 at http://viewcvs.sourceforge.net and follow the instructions.
64
65 Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
66 several scripts and patches available from the CvsGraph homepage (see below for
67 address). However, the scripts are no longer maintained because ViewCVS has
68 native support now.
69
70 To generate an image do something like:
71 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
72
73 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
74 into 'mygraph.png'. The '-r' option is the path to the repository *located and
75 accessible* on your filesystem. The '-m' is the module in the repository. Note
76 that the extension of the file ends with ",v".
77
78 Just to make it clear: You cannot make images from a cvs-repository over the
79 internet as if you were using cvs. The repository files
80 must be on a locally mounted filesystem. However, you
81 can use cvsup or rsync to get a repository to your
82 local filesystem and make then image from there.
83
84 Type 'cvsgraph -h' to get a full list of options. If the output is not given
85 (no '-o'), then the output is written to standard output.
86
87 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
88 information on execution and configuration.
89
90
91
92 Todo
93 ----
94 - do a better job in making a layout (auto moving branches and rubber banding
95 revision-connectors to make place). A start is made, but this is not very
96 functional yet.
97
98 - draw only a part or parts of the tree.
99
100
101
102 License
103 -------
104 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
105
106
107
108 Contact
109 -------
110 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
111 E-mail: cvsgraph@akhphd.au.dk
112
113 Greetings Bertho
114

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0