/[CvsGraph]/cvsgraph/README
ViewVC logotype

Diff of /cvsgraph/README

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

revision 1.7, Tue Nov 20 15:25:09 2001 UTC revision 1.48, Sun Jul 30 21:06:02 2006 UTC
# Line 1  Line 1 
1  CvsGraph 1.1.3, 20-Nov-2001  CvsGraph 1.6.2, 08-Jul-2006
2  ===========================  ===========================
3  CvsGraph creates a graphic representation of the revisions and branches in a  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  cvs/rcs repository. CvsGraph is inspired on the 'graph'-option from WinCVS. I
# Line 10  Line 10 
10    
11  New in this version  New in this version
12  -------------------  -------------------
13  This version of CvsGraph includes more control over the graphical presentation  
14  of the boxes drawn to show revisions and branches (notably background colors  - Fix merge line links after redoing part of merge lines
 and shadows). Imagemaps can now generate links to generate diffs. A couple of  
 manual pages has been written for both executable and configuration.  
15    
16    
17    
18  Compiling  Compiling
19  ---------  ---------
20  Go to a directory of your choice, unpack the package and cd into the newly  
21  create directory:  create directory:
22          $ cd /where/ever/you/want          $ cd /where/ever/you/want
23          $ tar xzf cvsgraph-1.1.3.tar.gz          $ tar xzf cvsgraph-1.6.2.tar.gz
24          $ cd cvsgraph-1.1.3          $ cd cvsgraph-1.6.2
25          $ ./configure          $ ./configure
26          $ make          $ make
27    
28  This should do the trick and you have an executable file 'cvsgraph' in the  This should do the trick and you have an executable file 'cvsgraph' in the
29  current directory.  current directory.
30    
31    NOTE:   The GD library is required for CvsGraph to function. Get it from
32            http://www.boutell.com, compile it and use either --with-gd-lib=DIR
33            and --with-gd-inc=DIR to specify its location. You might also have
34            to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
35            for gd versions 1.6 and higher.
36            If you build with static libgd (i.e. libgd.a) and already have
37            libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
38            try to trick configure into adding these libs to the tests by adding
39            commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
40            If you have linked libgd with freetype, then you might also need
41            either --with-freetype-lib or --with-freetype2-lib.
42    
43    There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
44    (and probably other OSes too). Check your local mirror for details. I also have
45    some links on the homepage for precompiled binaries. Please do not complain to
46    me about these binaries.
47    
48    
49    
50  Installing  Installing
# Line 46  Line 61 
61  ----------------  ----------------
62  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
63  be very insecure. Make a wrapper cgi-script in php, perl, or whatever you  be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
64  normally use. A nice way is to hack the 'cvsweb' package to call CvsGraph.  normally use. There are several web-based viewers with CvsGraph support:
65  There are several scripts and patches available from the CvsGraph homepage (see  
66  below for address).  - ViewCVS       http://viewcvs.sourceforge.net
67    - CVSweb        http://www.freebsd.org/projects/cvsweb.html
68    - Chora         http://www.horde.org/chora/
69    
70    
71  To generate an image do something like:  To generate an image do something like:
72          $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v          $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
# Line 58  Line 76 
76  accessible* on your filesystem. The '-m' is the module in the repository. Note  accessible* on your filesystem. The '-m' is the module in the repository. Note
77  that the extension of the file ends with ",v".  that the extension of the file ends with ",v".
78    
79    Just to make it clear:  You cannot make images from a cvs-repository over the
80                            internet as if you were using cvs. The repository files
81                            must be on a locally mounted filesystem. However, you
82                            can use cvsup or rsync to get a repository to your
83                            local filesystem and make then images from there.
84    
85  Type 'cvsgraph -h' to get a full list of options. If the output is not given  Type 'cvsgraph -h' to get a full list of options. If the output is not given
86  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
87    
# Line 66  Line 90 
90    
91    
92    
93    Contributed code
94    ----------------
95    - contrib/automatic_documentation:
96      If you are interested in tag-management with respect to the correct branch
97      information, then I suggest that you take a look at the contribution from
98      Henrik Carlqvist. He submitted some server-side scripts that can manage tags
99      in a better fashion than cvs on its own.
100    
101    
102    
103  Todo  Todo
104  ----  ----
 - use ImageMagick for better control over what is generated (also multiple  
   output formats would be possible)  
105  - do a better job in making a layout (auto moving branches and rubber banding  - do a better job in making a layout (auto moving branches and rubber banding
106    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
107      functional yet.
108    
109    
110    
111  License  License
112  -------  -------
113  CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.  CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
114    
115    
116    
# Line 86  Line 119 
119  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
120  E-mail: cvsgraph@akhphd.au.dk  E-mail: cvsgraph@akhphd.au.dk
121    
122    
123    
124    Mailnote
125    --------
126    As of 20 August 2005, if you send me an email with a contained or attached
127    disclaimer that includes one or more of the following items:
128    
129        * legal notice or threat(s)
130        * disclosure restriction(s)
131        * forward restriction(s)
132        * "intended recipient" nonsense
133    
134    Then you automatically agree to pay me a license fee of DKK 1000,- for using my
135    email address and a DKK 250,- fee for wasting my time on reading it.
136    
137  Greetings Bertho  Greetings Bertho
138    

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.48

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0