/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.9 - (show annotations)
Wed Dec 19 18:10:58 2001 UTC (15 years, 11 months ago) by bertho
Branch: MAIN
Changes since 1.8: +41 -10 lines
- Updated the docu a bit
- Renamed the branch_mirror to branch_dupbox which is more appropriate
- strip_untagged displays now draw dashed connector lines to indicate a jump
1 CvsGraph 1.1.4, 19-Dec-2001
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 - The entire tree can now be drawn upside-down. This is usefull if you have
14 many revisions in a trunk and want to see the latest first. The configuration
15 includes an option 'upside_down' with a boolean argument. You can override the
16 default value on the command-line with the '-u' switch, which will negate the
17 configured value.
18 The imagemap generation also supports this, so you will still be able to point
19 and shoot on and between the revisions.
20
21 - You can now instruct CvsGraph to ommit all revisions that are not tagged. This
22 is highly usefull for very large trees/trunks to reduce the produced image
23 size. Note that the first and the last revision in a trunk never are hidden.
24 A new configuration option 'strip_untagged' with boolean argument enables this
25 feature. Alternatively, the command-line provides option '-s' wich negates the
26 value set in the configuration file.
27
28 - The boxes to identify the branches can now be drawn on both sides of the trunk.
29 Configuration option 'branch_dupbox' with boolean argument activates this
30 feature, which is usefull when the tree is drawn upside-down.The command-line
31 option '-b' negated the configured value.
32
33 - ViewCVS (http://viewcvs.sourceforge.net) is now officially supporting the use
34 of CvsGraph in their code as of version 0.8. So, no bad hacks needed anymore
35 to get it working, and it always looks nice :-)
36
37
38 Compiling
39 ---------
40
41 create directory:
42 $ cd /where/ever/you/want
43 $ tar xzf cvsgraph-1.1.4.tar.gz
44 $ cd cvsgraph-1.1.4
45 $ ./configure
46 $ make
47
48 This should do the trick and you have an executable file 'cvsgraph' in the
49 current directory.
50
51 NOTE: The GD library is required for CvsGraph to function. Get it from
52 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
53 and --with-gd-inc=DIR to specify its location. You might also have
54 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
55 for gd versions 1.6 and higher.
56 If you build with static libgd (i.e. libgd.a) and already have
57 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
58 try to trick configure into adding these libs to the tests by adding
59 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
60
61
62 Installing
63 ----------
64 Put the executable file 'cvsgraph' somewhere where you think it should go.
65 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
66 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
67 overriden on the commandline anyway. Edit the configuration file to your liking
68 and you should be all set.
69
70
71
72 Running CvsGraph
73 ----------------
74 Do *NOT* execute the program directly from a webserver. Direct execution would
75 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
76 normally use. A nice way is to hack the 'cvsweb' package to call CvsGraph.
77 There are several scripts and patches available from the CvsGraph homepage (see
78 below for address).
79
80 To generate an image do something like:
81 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
82
83 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
84 into 'mygraph.png'. The '-r' option is the path to the repository *located and
85 accessible* on your filesystem. The '-m' is the module in the repository. Note
86 that the extension of the file ends with ",v".
87
88 Just to make it clear: You cannot make images from a cvs-repository over the
89 internet as if you were using cvs. The repository files
90 must be on a locally mounted filesystem. However, you
91 can use cvsup or rsync to get a repository to your
92 local filesystem and make then image from there.
93
94 Type 'cvsgraph -h' to get a full list of options. If the output is not given
95 (no '-o'), then the output is written to standard output.
96
97 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
98 information on execution and configuration.
99
100
101
102 Todo
103 ----
104 - do a better job in making a layout (auto moving branches and rubber banding
105 revision-connectors to make place)
106
107
108
109 License
110 -------
111 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
112
113
114
115 Contact
116 -------
117 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
118 E-mail: cvsgraph@akhphd.au.dk
119
120 Greetings Bertho
121

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0