/[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.6, Thu Mar 22 21:42:48 2001 UTC revision 1.25, Sat Aug 14 14:56:18 2004 UTC
# Line 1  Line 1 
1  CvsGraph 1.1.2, 22-Mar-2001  CvsGraph 1.4.2, 16-Jul-2004
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  - Add regex method for ignoring tags in the generation of the graph. Old trees
15  and shadows). Imagemaps can now generate links to generate diffs. A couple of    are overpolulated and this is a way to reduce it even further. New config
16  manual pages has been written for both executable and configuration.    options tag_ignore, tag_nocase and tag_negate.
17    
18    
19    
20    Known BUGS
21    ----------
22    
23    - The timezone variable does not seem to exist on Mac OSX. I have no clue how
24      to patch this yet.
25      Anyhow, the timezone problem is much worse, because it needs to be calculated
26      from the revision's commit-time and not the current timezone (Daylight saving
27      must be accounted for at commit's time, not current).
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.2.tar.gz          $ tar xzf cvsgraph-1.4.2.tar.gz
37          $ cd cvsgraph-1.1.2          $ cd cvsgraph-1.4.2
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. There are several web-based viewers with CvsGraph support:
73  There are several scripts and patches available from the CvsGraph homepage (see  
74  below for address).  - 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:  To generate an image do something like:
80          $ 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 84 
84  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
85  that the extension of the file ends with ",v".  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  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.  (no '-o'), then the output is written to standard output.
95    
# Line 68  Line 100 
100    
101  Todo  Todo
102  ----  ----
 - use ImageMagick for better control over what is generated (also multiple  
   output formats would be possible)  
103  - 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
104    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
105      functional yet.
106    
107    - draw only a part or parts of the tree.
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    

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.25

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0