/[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.18, Sun Mar 9 22:36:50 2003 UTC
# Line 1  Line 1 
1  CvsGraph 1.1.3, 20-Nov-2001  CvsGraph 1.3.0, 20-Jul-2002
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  - Fix warnings in readconf on some 'older' compiler systems.
14  of the boxes drawn to show revisions and branches (notably background colors  
15  and shadows). Imagemaps can now generate links to generate diffs. A couple of  - Implement new option to generate proper maps for different levels of HTML.
16  manual pages has been written for both executable and configuration.    The option -x[34x] determines HTML 3.x (default), HTML 4.x or XHTML style
17      maps.
18    
19    - Implement a scheme to visualize merges based on tag names. If tages are
20      consistently named at the mergepoint and the destination, then these points
21      can be detected using regular expressions. Several new configuration
22      options, merge_*, describe the tags.
23    
24    - Implemented HTMLizing of expansion with %(...%). This prevents a possible
25      cross site scripting exploit when you use '<', '>' or '"' in tagnames.
26      This is a remote chance (you must be stupid to use these characters in a
27      tagname) but anyway, your system can be under attack.
28    
29    
30    
31  Compiling  Compiling
32  ---------  ---------
33  Go to a directory of your choice, unpack the package and cd into the newly  
34  create directory:  create directory:
35          $ cd /where/ever/you/want          $ cd /where/ever/you/want
36          $ tar xzf cvsgraph-1.1.3.tar.gz          $ tar xzf cvsgraph-1.3.0.tar.gz
37          $ cd cvsgraph-1.1.3          $ cd cvsgraph-1.3.0
38          $ ./configure          $ ./configure
39          $ make          $ make
40    
41  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
42  current directory.  current directory.
43    
44    NOTE:   The GD library is required for CvsGraph to function. Get it from
45            http://www.boutell.com, compile it and use either --with-gd-lib=DIR
46            and --with-gd-inc=DIR to specify its location. You might also have
47            to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
48            for gd versions 1.6 and higher.
49            If you build with static libgd (i.e. libgd.a) and already have
50            libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
51            try to trick configure into adding these libs to the tests by adding
52            commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
53            If you have linked libgd with freetype, then you might also need
54            either --with-freetype-lib or --with-freetype2-lib.
55    
56    
57    
58  Installing  Installing
# Line 46  Line 69 
69  ----------------  ----------------
70  Do *NOT* execute the program directly from a webserver. Direct execution would  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  be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
72  normally use. A nice way is to hack the 'cvsweb' package to call CvsGraph.  normally use. The easiest way is to get the ViewCVS package from their website
73  There are several scripts and patches available from the CvsGraph homepage (see  at http://viewcvs.sourceforge.net and follow the instructions.
74  below for address).  
75    Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
76    several scripts and patches available from the CvsGraph homepage (see below for
77    address). However, the scripts are no longer maintained because ViewCVS has
78    native support now.
79    
80  To generate an image do something like:  To generate an image do something like:
81          $ 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 85 
85  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
86  that the extension of the file ends with ",v".  that the extension of the file ends with ",v".
87    
88    Just to make it clear:  You cannot make images from a cvs-repository over the
89                            internet as if you were using cvs. The repository files
90                            must be on a locally mounted filesystem. However, you
91                            can use cvsup or rsync to get a repository to your
92                            local filesystem and make then images from there.
93    
94  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
95  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
96    
# Line 68  Line 101 
101    
102  Todo  Todo
103  ----  ----
 - use ImageMagick for better control over what is generated (also multiple  
   output formats would be possible)  
104  - 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
105    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
106      functional yet.
107    
108    - draw only a part or parts of the tree.
109    
110    
111    
112  License  License
113  -------  -------
114  CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.  CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
115    
116    
117    

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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0