/[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.9, Wed Dec 19 18:10:58 2001 UTC
# Line 1  Line 1 
1  CvsGraph 1.0.1  CvsGraph 1.1.4, 19-Dec-2001
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:  - The entire tree can now be drawn upside-down. This is usefull if you have
14          * RedHat Linux 6.[12] and 7.0    many revisions in a trunk and want to see the latest first. The configuration
15          * cvs-1.10    includes an option 'upside_down' with a boolean argument. You can override the
16          * rcs-5.7    default value on the command-line with the '-u' switch, which will negate the
17          * gd-1.3 and gd-1.8    configured value.
18  - CvsGraph generates only gifs for old versions of gd and only png and jpeg for    The imagemap generation also supports this, so you will still be able to point
19    newer version of gd.    and shoot on and between the revisions.
20    
21    - You can now instruct CvsGraph to ommit all revisions that are not tagged. This
22      is highly usefull for very large trees/trunks to reduce the produced image
23      size. Note that the first and the last revision in a trunk never are hidden.
24      A new configuration option 'strip_untagged' with boolean argument enables this
25      feature. Alternatively, the command-line provides option '-s' wich negates the
26      value set in the configuration file.
27    
28    - The boxes to identify the branches can now be drawn on both sides of the trunk.
29      Configuration option 'branch_dupbox' with boolean argument activates this
30      feature, which is usefull when the tree is drawn upside-down.The command-line
31      option '-b' negated the configured value.
32    
33    - ViewCVS (http://viewcvs.sourceforge.net) is now officially supporting the use
34      of CvsGraph in their code as of version 0.8. So, no bad hacks needed anymore
35      to get it working, and it always looks nice :-)
36    
37    
38  Compiling  Compiling
39  ---------  ---------
40  Go to a directory of your choice, unpack the package and cd into the newly  
41  create directory:  create directory:
42          $ cd /where/ever/you/want          $ cd /where/ever/you/want
43          $ tar xzf cvsgraph-1.0.1.tar.gz          $ tar xzf cvsgraph-1.1.4.tar.gz
44          $ cd cvsgraph-1.0.1          $ cd cvsgraph-1.1.4
   
 Edit the Makefile to suit your needs and run:  
45          $ ./configure          $ ./configure
46          $ make          $ make
47    
48  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
49  current directory.  current directory.
50    
51    NOTE:   The GD library is required for CvsGraph to function. Get it from
52            http://www.boutell.com, compile it and use either --with-gd-lib=DIR
53            and --with-gd-inc=DIR to specify its location. You might also have
54            to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
55            for gd versions 1.6 and higher.
56            If you build with static libgd (i.e. libgd.a) and already have
57            libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
58            try to trick configure into adding these libs to the tests by adding
59            commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
60    
61    
62  Installing  Installing
# Line 52  Line 74 
74  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
75  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
76  normally use. A nice way is to hack the 'cvsweb' package to call CvsGraph.  normally use. A nice way is to hack the 'cvsweb' package to call CvsGraph.
77    There are several scripts and patches available from the CvsGraph homepage (see
78    below for address).
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.gif myfile.c,v          $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
82    
83  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
84  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
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 image 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    
97    Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
98    information on execution and configuration.
99    
100    
101    
102  Todo  Todo
103  ----  ----
 - 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  
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)
 - redo the entire code :-) All good programs are written twice (at least). The  
   structure is a real mess, but that is the price for hacking away without a  
   real programming strategy...  
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.9

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0