/[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.48.2.1, Mon Nov 13 21:12:19 2006 UTC
# Line 1  Line 1 
1  CvsGraph 1.2.0, 19-Dec-2001  CvsGraph 1.7.0, 13-Nov-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  - 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 merge line links after redoing part of merge lines
15    includes an option 'upside_down' with a boolean argument. You can override the  
16    default value on the command-line with the '-u' switch, which will negate the  - Use automake
17    configured value.  
18    The imagemap generation also supports this, so you will still be able to point  - Streamline the package with patches from the Fedora RPMS
19    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 :-)  
20    
21    
22  Compiling  Compiling
# Line 49  Line 24 
24    
25  create directory:  create directory:
26          $ cd /where/ever/you/want          $ cd /where/ever/you/want
27          $ tar xzf cvsgraph-1.2.0.tar.gz          $ tar xzf cvsgraph-1.7.0.tar.gz
28          $ cd cvsgraph-1.2.0          $ cd cvsgraph-1.7.0
29          $ ./configure          $ ./configure
30          $ make          $ make
31    
32  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
33  current directory.  current directory.
34    
35  NOTE:   The GD library is required for CvsGraph to function. Get it from  There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
36          http://www.boutell.com, compile it and use either --with-gd-lib=DIR  (and probably other OSes too). Check your local mirror for details. I also have
37          and --with-gd-inc=DIR to specify its location. You might also have  some links on the homepage for precompiled binaries. Please do not complain to
38          to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib  me about these binaries.
39          for gd versions 1.6 and higher.  
         If you build with static libgd (i.e. libgd.a) and already have  
         libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to  
         try to trick configure into adding these libs to the tests by adding  
         commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.  
40    
41    
42  Installing  Installing
# Line 82  Line 53 
53  ----------------  ----------------
54  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
55  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
56  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:
57  at http://viewcvs.sourceforge.net and follow the instructions.  
58    - ViewCVS       http://viewcvs.sourceforge.net
59    - CVSweb        http://www.freebsd.org/projects/cvsweb.html
60    - Chora         http://www.horde.org/chora/
61    
 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.  
62    
63  To generate an image do something like:  To generate an image do something like:
64          $ 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 72 
72                          internet as if you were using cvs. The repository files                          internet as if you were using cvs. The repository files
73                          must be on a locally mounted filesystem. However, you                          must be on a locally mounted filesystem. However, you
74                          can use cvsup or rsync to get a repository to your                          can use cvsup or rsync to get a repository to your
75                          local filesystem and make then image from there.                          local filesystem and make then images from there.
76    
77  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
78  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
# Line 112  Line 82 
82    
83    
84    
85    Contributed code
86    ----------------
87    - contrib/automatic_documentation:
88      If you are interested in tag-management with respect to the correct branch
89      information, then I suggest that you take a look at the contribution from
90      Henrik Carlqvist. He submitted some server-side scripts that can manage tags
91      in a better fashion than cvs on its own.
92    
93    
94    
95  Todo  Todo
96  ----  ----
97  - 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
98    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
99      functional yet.
100    
101    
102    
# Line 130  Line 111 
111  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
112  E-mail: cvsgraph@akhphd.au.dk  E-mail: cvsgraph@akhphd.au.dk
113    
114    
115    
116    Mailnote
117    --------
118    As of 20 August 2005, if you send me an email with a contained or attached
119    disclaimer that includes one or more of the following items:
120    
121        * legal notice or threat(s)
122        * disclosure restriction(s)
123        * forward restriction(s)
124        * "intended recipient" nonsense
125    
126    Then you automatically agree to pay me a license fee of DKK 1000,- for using my
127    email address and a DKK 250,- fee for wasting my time on reading it.
128    
129  Greetings Bertho  Greetings Bertho
130    

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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0