/[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.3, Sat Feb 24 21:52:28 2001 UTC revision 1.14, Tue Apr 23 23:02:54 2002 UTC
# Line 1  Line 1 
1  CvsGraph 1.0.1  CvsGraph 1.2.1, 24-Apr-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
5  could not find something right away on the web and decided that it was time to  could not find something right away on the web and decided that it was time to
# Line 8  Line 8 
8    
9    
10    
11  Notes  New in this version
12  -----  -------------------
13  - I only tested it with:  - Implement a workaround for browsers that do not understand unordered
14          * RedHat Linux 6.[12] and 7.0    y-coordinates in the imagemap when generated upside down.
15          * cvs-1.10  
16          * rcs-5.7  - Fix the slowness of CvsGraph when parsing very large (typically -kb files)
17          * gd-1.3 and gd-1.8    by bypassing the parsing of the actual deltatext. On my machine (K6-2/500/256M
18  - CvsGraph generates only gifs for old versions of gd and only png and jpeg for    it makes a difference of 7.5s vs 0.04s on a 93MByte file, without counting
19    newer version of gd.    disk-overhead; with disk-overhead it takes 12.5s).
20      Downside is that the logentry cannot be expanded if the file is not parsed in
21      full (see below). Use option parse_logs to enable log-expansions.
22    
23    - Implemented logentry expansions using %l and %L. You must enable full parsing
24      (option parse_logs) for this to work.
25    
26    
27    
28  Compiling  Compiling
29  ---------  ---------
30  Go to a directory of your choice, unpack the package and cd into the newly  
31  create directory:  create directory:
32          $ cd /where/ever/you/want          $ cd /where/ever/you/want
33          $ tar xzf cvsgraph-1.0.1.tar.gz          $ tar xzf cvsgraph-1.2.1.tar.gz
34          $ cd cvsgraph-1.0.1          $ cd cvsgraph-1.2.1
   
 Edit the Makefile to suit your needs and run:  
35          $ ./configure          $ ./configure
36          $ make          $ make
37    
38  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
39  current directory.  current directory.
40    
41    NOTE:   The GD library is required for CvsGraph to function. Get it from
42            http://www.boutell.com, compile it and use either --with-gd-lib=DIR
43            and --with-gd-inc=DIR to specify its location. You might also have
44            to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
45            for gd versions 1.6 and higher.
46            If you build with static libgd (i.e. libgd.a) and already have
47            libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
48            try to trick configure into adding these libs to the tests by adding
49            commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
50            If you have linked libgd with freetype, then you might also need
51            either --with-freetype-lib or --with-freetype2-lib.
52    
53    
54    
55  Installing  Installing
# Line 51  Line 66 
66  ----------------  ----------------
67  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
68  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
69  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
70    at http://viewcvs.sourceforge.net and follow the instructions.
71    
72    Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
73    several scripts and patches available from the CvsGraph homepage (see below for
74    address). However, the scripts are no longer maintained because ViewCVS has
75    native support now.
76    
77  To generate an image do something like:  To generate an image do something like:
78          $ cvsgraph -r /home/to/repository -m module -o mygraph.gif myfile.c,v          $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
79    
80  This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it  This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
81  into 'mygraph.gif'. The '-r' option is the path to the repository *located and  into 'mygraph.png'. The '-r' option is the path to the repository *located and
82  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
83  that the extension of the file ends with ",v".  that the extension of the file ends with ",v".
84    
85    Just to make it clear:  You cannot make images from a cvs-repository over the
86                            internet as if you were using cvs. The repository files
87                            must be on a locally mounted filesystem. However, you
88                            can use cvsup or rsync to get a repository to your
89                            local filesystem and make then image from there.
90    
91  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
92  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
93    
94    Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
95    information on execution and configuration.
96    
97    
98    
99  Todo  Todo
100  ----  ----
 - use ImageMagick for better control over what is generated (also multiple  
   output formats would be possible)  
 - find a way to use cvs directly instead of rcs (rlog) without the need for a  
   full checkout of the repository/module  
 - clean up the mess of finding revisions, tags and branches. The main branch  
   does not nessecarily start with revision 1.1  
101  - 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
102    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
103  - redo the entire code :-) All good programs are written twice (at least). The    functional yet.
104    structure is a real mess, but that is the price for hacking away without a  
105    real programming strategy...  - draw only a part or parts of the tree.
106    
107    
108    
109  License  License
110  -------  -------
111  CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.  CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
112    
113    
114    

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.14

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0