/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.10 - (show annotations)
Tue Jan 1 21:03:23 2002 UTC (15 years, 11 months ago) by bertho
Branch: MAIN
Changes since 1.9: +21 -8 lines
Major code update to enable some more features. The new formatting scheme is
not yet 100%. This should be close to version 1.2.0.
1 CvsGraph 1.2.0, 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 are not 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. You can also strip the first revision if
27 it is untagged using '-S' and/or strip_first_rev.
28
29 - The boxes to identify the branches can now be drawn on both sides of the trunk.
30 Configuration option 'branch_dupbox' with boolean argument activates this
31 feature, which is usefull when the tree is drawn upside-down.The command-line
32 option '-b' negated the configured value.
33
34 - Configuration no longer requires a configuration file. All options can now be
35 entered on the commandline using '-O'. CvsGraph will still read the
36 configuration file if one is avaliable, but it is no longer an error if none
37 is found.
38
39 - If no file is entered on the command-line, then the input is taken from
40 standard input, like all decent *nix programs.
41
42 - ViewCVS (http://viewcvs.sourceforge.net) is now officially supporting the use
43 of CvsGraph in their code as of version 0.8. So, no bad hacks needed anymore
44 to get it working, and it always looks nice :-)
45
46
47 Compiling
48 ---------
49
50 create directory:
51 $ cd /where/ever/you/want
52 $ tar xzf cvsgraph-1.2.0.tar.gz
53 $ cd cvsgraph-1.2.0
54 $ ./configure
55 $ make
56
57 This should do the trick and you have an executable file 'cvsgraph' in the
58 current directory.
59
60 NOTE: The GD library is required for CvsGraph to function. Get it from
61 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
62 and --with-gd-inc=DIR to specify its location. You might also have
63 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
64 for gd versions 1.6 and higher.
65 If you build with static libgd (i.e. libgd.a) and already have
66 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
67 try to trick configure into adding these libs to the tests by adding
68 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
69
70
71 Installing
72 ----------
73 Put the executable file 'cvsgraph' somewhere where you think it should go.
74 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
75 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
76 overriden on the commandline anyway. Edit the configuration file to your liking
77 and you should be all set.
78
79
80
81 Running CvsGraph
82 ----------------
83 Do *NOT* execute the program directly from a webserver. Direct execution would
84 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
85 normally use. The easiest way is to get the ViewCVS package from their website
86 at http://viewcvs.sourceforge.net and follow the instructions.
87
88 Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
89 several scripts and patches available from the CvsGraph homepage (see below for
90 address). However, the scripts are no longer maintained because ViewCVS has
91 native support now.
92
93 To generate an image do something like:
94 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
95
96 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
97 into 'mygraph.png'. The '-r' option is the path to the repository *located and
98 accessible* on your filesystem. The '-m' is the module in the repository. Note
99 that the extension of the file ends with ",v".
100
101 Just to make it clear: You cannot make images from a cvs-repository over the
102 internet as if you were using cvs. The repository files
103 must be on a locally mounted filesystem. However, you
104 can use cvsup or rsync to get a repository to your
105 local filesystem and make then image from there.
106
107 Type 'cvsgraph -h' to get a full list of options. If the output is not given
108 (no '-o'), then the output is written to standard output.
109
110 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
111 information on execution and configuration.
112
113
114
115 Todo
116 ----
117 - do a better job in making a layout (auto moving branches and rubber banding
118 revision-connectors to make place)
119
120
121
122 License
123 -------
124 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
125
126
127
128 Contact
129 -------
130 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
131 E-mail: cvsgraph@akhphd.au.dk
132
133 Greetings Bertho
134

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0