/[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.10, Tue Jan 1 21:03:23 2002 UTC revision 1.40, Sun Aug 21 07:56:53 2005 UTC
# Line 1  Line 1 
1  CvsGraph 1.2.0, 19-Dec-2001  CvsGraph 1.5.3, 14-Jun-2005
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  - The entire tree can now be drawn upside-down. This is usefull if you have  
14    many revisions in a trunk and want to see the latest first. The configuration  - Fix all numeric author ID
15    includes an option 'upside_down' with a boolean argument. You can override the  
   default value on the command-line with the '-u' switch, which will negate the  
   configured value.  
   The imagemap generation also supports this, so you will still be able to point  
   and shoot on and between the revisions.  
   
 - You can now instruct CvsGraph to ommit all revisions that are not tagged. This  
   is highly usefull for very large trees/trunks to reduce the produced image  
   size. Note that the first and the last revision in a trunk are not hidden.  
   A new configuration option 'strip_untagged' with boolean argument enables this  
   feature. Alternatively, the command-line provides option '-s' wich negates the  
   value set in the configuration file. You can also strip the first revision if  
   it is untagged using '-S' and/or strip_first_rev.  
   
 - The boxes to identify the branches can now be drawn on both sides of the trunk.  
   Configuration option 'branch_dupbox' with boolean argument activates this  
   feature, which is usefull when the tree is drawn upside-down.The command-line  
   option '-b' negated the configured value.  
   
 - Configuration no longer requires a configuration file. All options can now be  
   entered on the commandline using '-O'. CvsGraph will still read the  
   configuration file if one is avaliable, but it is no longer an error if none  
   is found.  
   
 - If no file is entered on the command-line, then the input is taken from  
   standard input, like all decent *nix programs.  
   
 - ViewCVS (http://viewcvs.sourceforge.net) is now officially supporting the use  
   of CvsGraph in their code as of version 0.8. So, no bad hacks needed anymore  
   to get it working, and it always looks nice :-)  
16    
17    
18  Compiling  Compiling
# Line 49  Line 20 
20    
21  create directory:  create directory:
22          $ cd /where/ever/you/want          $ cd /where/ever/you/want
23          $ tar xzf cvsgraph-1.2.0.tar.gz          $ tar xzf cvsgraph-1.5.3.tar.gz
24          $ cd cvsgraph-1.2.0          $ cd cvsgraph-1.5.3
25          $ ./configure          $ ./configure
26          $ make          $ make
27    
# Line 66  Line 37 
37          libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to          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          try to trick configure into adding these libs to the tests by adding
39          commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.          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 82  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. The easiest way is to get the ViewCVS package from their website  normally use. There are several web-based viewers with CvsGraph support:
65  at http://viewcvs.sourceforge.net and follow the instructions.  
66    - ViewCVS       http://viewcvs.sourceforge.net
67    - CVSweb        http://www.freebsd.org/projects/cvsweb.html
68    - Chora         http://www.horde.org/chora/
69    
 Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are  
 several scripts and patches available from the CvsGraph homepage (see below for  
 address). However, the scripts are no longer maintained because ViewCVS has  
 native support now.  
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 102  Line 80 
80                          internet as if you were using cvs. The repository files                          internet as if you were using cvs. The repository files
81                          must be on a locally mounted filesystem. However, you                          must be on a locally mounted filesystem. However, you
82                          can use cvsup or rsync to get a repository to your                          can use cvsup or rsync to get a repository to your
83                          local filesystem and make then image from there.                          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.
# Line 112  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  ----  ----
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    

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.40

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0