/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.23 - (show annotations)
Fri Jul 16 13:49:42 2004 UTC (13 years, 4 months ago) by bertho
Branch: MAIN
CVS Tags: REL_1_4_1
Changes since 1.22: +33 -44 lines
- Prepare for release 1.4.1
1 CvsGraph 1.4.1, 16-Jul-2004
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
14 - Fix a longstanding date-bug in showing local time. Now timezone is accounted
15 for.
16
17 - Fix the CVSNT habbit of adding info to the tag in symbols. The trailing data
18 is skipped for now. I might use it later on; it contains a date and comments
19 on tags.
20
21 - Fix the author recognition for CVSNT with broken rcsfile(5) format. This
22 might not be a total remedy, but should fix some.
23
24 - Fix XHTML <br> to be <br /> and add HTML-izing '&' to &amp; and '"' to &quot;
25
26 - Fix execution flags of regexec().
27
28 - Fix the sizeof(void *) vs sizeof(int) problem. Now look for int, long and
29 long long in configure.
30
31 - Add the arrow patch and adapted to be more configurable.
32
33 - Fix manual page typo. Documentation and other aesthetic related fixes.
34
35
36 Many thanks for patches to (in no particular order and sorry if I missed your
37 name in the list):
38 Haroon Rafique <haroon.rafique@utoronto.ca>
39 Jason Corley <jason.corley@borland.com>
40 Mark Brown <broonie@sirena.org.uk>
41 Morten Sylvest Olsen <mso@medical-insight.com>
42
43 And, of course, thanks to all others who send me feedback!
44
45
46
47 Compiling
48 ---------
49
50 create directory:
51 $ cd /where/ever/you/want
52 $ tar xzf cvsgraph-1.4.1.tar.gz
53 $ cd cvsgraph-1.4.1
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 If you have linked libgd with freetype, then you might also need
70 either --with-freetype-lib or --with-freetype2-lib.
71
72
73
74 Installing
75 ----------
76 Put the executable file 'cvsgraph' somewhere where you think it should go.
77 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
78 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
79 overriden on the commandline anyway. Edit the configuration file to your liking
80 and you should be all set.
81
82
83
84 Running CvsGraph
85 ----------------
86 Do *NOT* execute the program directly from a webserver. Direct execution would
87 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
88 normally use. The easiest way is to get the ViewCVS package from their website
89 at http://viewcvs.sourceforge.net and follow the instructions.
90
91 Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
92 several scripts and patches available from the CvsGraph homepage (see below for
93 address). However, the scripts are no longer maintained because ViewCVS has
94 native support now.
95
96 To generate an image do something like:
97 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
98
99 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
100 into 'mygraph.png'. The '-r' option is the path to the repository *located and
101 accessible* on your filesystem. The '-m' is the module in the repository. Note
102 that the extension of the file ends with ",v".
103
104 Just to make it clear: You cannot make images from a cvs-repository over the
105 internet as if you were using cvs. The repository files
106 must be on a locally mounted filesystem. However, you
107 can use cvsup or rsync to get a repository to your
108 local filesystem and make then images from there.
109
110 Type 'cvsgraph -h' to get a full list of options. If the output is not given
111 (no '-o'), then the output is written to standard output.
112
113 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
114 information on execution and configuration.
115
116
117
118 Todo
119 ----
120 - do a better job in making a layout (auto moving branches and rubber banding
121 revision-connectors to make place). A start is made, but this is not very
122 functional yet.
123
124 - draw only a part or parts of the tree.
125
126
127
128 License
129 -------
130 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
131
132
133
134 Contact
135 -------
136 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
137 E-mail: cvsgraph@akhphd.au.dk
138
139 Greetings Bertho
140

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0