/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.38 - (show annotations)
Mon Jun 13 20:57:27 2005 UTC (12 years, 6 months ago) by bertho
Branch: MAIN
Changes since 1.37: +2 -0 lines
- Fix mergepoint1 syntax used by CVSNT allowing revision numbers as argument
1 CvsGraph 1.5.2, 23-Oct-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 POSIX compliance in timezone handling. Only putenv() is used now.
15
16 - Fix branch-count when branches get folded.
17
18 - Fix configure script to detect gd-2 problems (Thanks to Russell Yanofsky)
19
20 - Work around CVSNT wrong keyword ordering breaking rcsfile(5) ordering
21
22 - Fix complaining about a new CVSNT keyword properties
23
24 - Fix mergepoint1 syntax used by CVSNT allowing revision numbers as argument
25
26
27
28 Compiling
29 ---------
30
31 create directory:
32 $ cd /where/ever/you/want
33 $ tar xzf cvsgraph-1.5.2.tar.gz
34 $ cd cvsgraph-1.5.2
35 $ ./configure
36 $ make
37
38 This should do the trick and you have an executable file 'cvsgraph' in the
39 current directory.
40
41 NOTE: The GD library is required for CvsGraph to function. Get it from
42 http://www.boutell.com, compile it and use either --with-gd-lib=DIR
43 and --with-gd-inc=DIR to specify its location. You might also have
44 to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
45 for gd versions 1.6 and higher.
46 If you build with static libgd (i.e. libgd.a) and already have
47 libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
48 try to trick configure into adding these libs to the tests by adding
49 commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
50 If you have linked libgd with freetype, then you might also need
51 either --with-freetype-lib or --with-freetype2-lib.
52
53 There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
54 (and probably other OSes too). Check your local mirror for details. I also have
55 some links on the homepage for precompiled binaries. Please do not complain to
56 me about these binaries.
57
58
59
60 Installing
61 ----------
62 Put the executable file 'cvsgraph' somewhere where you think it should go.
63 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
64 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
65 overriden on the commandline anyway. Edit the configuration file to your liking
66 and you should be all set.
67
68
69
70 Running CvsGraph
71 ----------------
72 Do *NOT* execute the program directly from a webserver. Direct execution would
73 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
74 normally use. There are several web-based viewers with CvsGraph support:
75
76 - ViewCVS http://viewcvs.sourceforge.net
77 - CVSweb http://www.freebsd.org/projects/cvsweb.html
78 - Chora http://www.horde.org/chora/
79
80
81 To generate an image do something like:
82 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
83
84 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
85 into 'mygraph.png'. The '-r' option is the path to the repository *located and
86 accessible* on your filesystem. The '-m' is the module in the repository. Note
87 that the extension of the file ends with ",v".
88
89 Just to make it clear: You cannot make images from a cvs-repository over the
90 internet as if you were using cvs. The repository files
91 must be on a locally mounted filesystem. However, you
92 can use cvsup or rsync to get a repository to your
93 local filesystem and make then images from there.
94
95 Type 'cvsgraph -h' to get a full list of options. If the output is not given
96 (no '-o'), then the output is written to standard output.
97
98 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
99 information on execution and configuration.
100
101
102
103 Contributed code
104 ----------------
105 - contrib/automatic_documentation:
106 If you are interested in tag-management with respect to the correct branch
107 information, then I suggest that you take a look at the contribution from
108 Henrik Carlqvist. He submitted some server-side scripts that can manage tags
109 in a better fashion than cvs on its own.
110
111
112
113 Todo
114 ----
115 - do a better job in making a layout (auto moving branches and rubber banding
116 revision-connectors to make place). A start is made, but this is not very
117 functional yet.
118
119
120
121 License
122 -------
123 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
124
125
126
127 Contact
128 -------
129 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
130 E-mail: cvsgraph@akhphd.au.dk
131
132 Greetings Bertho
133

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0