/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.47 - (hide annotations)
Sat Jul 8 13:56:54 2006 UTC (11 years, 3 months ago) by bertho
Branch: MAIN
CVS Tags: REL_1_6_1
Changes since 1.46: +5 -23 lines
Prepare release 1.6.1
1 bertho 1.47 CvsGraph 1.6.1, 08-Jul-2006
2 bertho 1.5 ===========================
3 bertho 1.1 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 bertho 1.5 New in this version
12     -------------------
13 bertho 1.14
14 bertho 1.47 - Minor textual fixes in the config manual page
15 bertho 1.38
16 bertho 1.47 - Do a better job at drawing merge lines
17 bertho 1.46
18 bertho 1.11
19 bertho 1.1
20     Compiling
21     ---------
22 bertho 1.9
23 bertho 1.1 create directory:
24     $ cd /where/ever/you/want
25 bertho 1.47 $ tar xzf cvsgraph-1.6.1.tar.gz
26     $ cd cvsgraph-1.6.1
27 bertho 1.3 $ ./configure
28 bertho 1.1 $ make
29    
30     This should do the trick and you have an executable file 'cvsgraph' in the
31     current directory.
32    
33 bertho 1.9 NOTE: The GD library is required for CvsGraph to function. Get it from
34     http://www.boutell.com, compile it and use either --with-gd-lib=DIR
35     and --with-gd-inc=DIR to specify its location. You might also have
36     to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
37     for gd versions 1.6 and higher.
38     If you build with static libgd (i.e. libgd.a) and already have
39     libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
40     try to trick configure into adding these libs to the tests by adding
41     commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
42 bertho 1.11 If you have linked libgd with freetype, then you might also need
43     either --with-freetype-lib or --with-freetype2-lib.
44 bertho 1.1
45 bertho 1.26 There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
46     (and probably other OSes too). Check your local mirror for details. I also have
47     some links on the homepage for precompiled binaries. Please do not complain to
48     me about these binaries.
49    
50 bertho 1.1
51 bertho 1.12
52 bertho 1.1 Installing
53     ----------
54     Put the executable file 'cvsgraph' somewhere where you think it should go.
55     Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
56     ought to be put in "/usr/local/etc" or "/etc". The exact position can be
57     overriden on the commandline anyway. Edit the configuration file to your liking
58     and you should be all set.
59    
60    
61    
62     Running CvsGraph
63     ----------------
64     Do *NOT* execute the program directly from a webserver. Direct execution would
65     be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
66 bertho 1.25 normally use. There are several web-based viewers with CvsGraph support:
67    
68     - ViewCVS http://viewcvs.sourceforge.net
69     - CVSweb http://www.freebsd.org/projects/cvsweb.html
70     - Chora http://www.horde.org/chora/
71 bertho 1.10
72 bertho 1.1
73 bertho 1.2 To generate an image do something like:
74 bertho 1.5 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
75 bertho 1.1
76     This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
77 bertho 1.5 into 'mygraph.png'. The '-r' option is the path to the repository *located and
78 bertho 1.1 accessible* on your filesystem. The '-m' is the module in the repository. Note
79     that the extension of the file ends with ",v".
80    
81 bertho 1.9 Just to make it clear: You cannot make images from a cvs-repository over the
82     internet as if you were using cvs. The repository files
83     must be on a locally mounted filesystem. However, you
84     can use cvsup or rsync to get a repository to your
85 bertho 1.18 local filesystem and make then images from there.
86 bertho 1.9
87 bertho 1.1 Type 'cvsgraph -h' to get a full list of options. If the output is not given
88     (no '-o'), then the output is written to standard output.
89    
90 bertho 1.5 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
91     information on execution and configuration.
92 bertho 1.34
93    
94    
95     Contributed code
96     ----------------
97     - contrib/automatic_documentation:
98     If you are interested in tag-management with respect to the correct branch
99     information, then I suggest that you take a look at the contribution from
100     Henrik Carlqvist. He submitted some server-side scripts that can manage tags
101     in a better fashion than cvs on its own.
102 bertho 1.5
103 bertho 1.1
104    
105     Todo
106     ----
107     - do a better job in making a layout (auto moving branches and rubber banding
108 bertho 1.12 revision-connectors to make place). A start is made, but this is not very
109     functional yet.
110    
111 bertho 1.1
112    
113     License
114     -------
115 bertho 1.9 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
116 bertho 1.1
117    
118    
119     Contact
120     -------
121     HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
122     E-mail: cvsgraph@akhphd.au.dk
123 bertho 1.41
124    
125    
126     Mailnote
127     --------
128     As of 20 August 2005, if you send me an email with a contained or attached
129 bertho 1.42 disclaimer that includes one or more of the following items:
130 bertho 1.41
131     * legal notice or threat(s)
132     * disclosure restriction(s)
133     * forward restriction(s)
134     * "intended recipient" nonsense
135    
136     Then you automatically agree to pay me a license fee of DKK 1000,- for using my
137     email address and a DKK 250,- fee for wasting my time on reading it.
138 bertho 1.1
139     Greetings Bertho
140    

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0