/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0