/[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.2, Sat Feb 24 21:49:17 2001 UTC revision 1.37, Mon Jun 13 19:57:10 2005 UTC
# Line 1  Line 1 
1  CvsGraph 1.0.1  CvsGraph 1.5.2, 23-Oct-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
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:  
14          * RedHat Linux 6.[12] and 7.0  - Fix POSIX compliance in timezone handling. Only putenv() is used now.
15          * cvs-1.10  
16          * rcs-5.7  - Fix branch-count when branches get folded.
17          * gd-1.3 and gd-1.8  
18  - CvsGraph generates only gifs for old versions of gd and only png and jpeg for  - Fix configure script to detect gd-2 problems (Thanks to Russell Yanofsky)
19    newer version of gd.  
20    - Work around CVSNT wrong keyword ordering breaking rcsfile(5) ordering
21    
22    - Fix complaining about a new CVSNT keyword properties
23    
24    
25    
26  Compiling  Compiling
27  ---------  ---------
28  Go to a directory of your choice, unpack the package and cd into the newly  
29  create directory:  create directory:
30          $ cd /where/ever/you/want          $ cd /where/ever/you/want
31          $ tar xzf cvsgraph-1.0.1.tar.gz          $ tar xzf cvsgraph-1.5.2.tar.gz
32          $ cd cvsgraph-1.0.1          $ cd cvsgraph-1.5.2
33            $ ./configure
 Edit the Makefile to suit your needs and run:  
34          $ make          $ make
35    
36  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
37  current directory.  current directory.
38    
39    NOTE:   The GD library is required for CvsGraph to function. Get it from
40            http://www.boutell.com, compile it and use either --with-gd-lib=DIR
41            and --with-gd-inc=DIR to specify its location. You might also have
42            to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
43            for gd versions 1.6 and higher.
44            If you build with static libgd (i.e. libgd.a) and already have
45            libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
46            try to trick configure into adding these libs to the tests by adding
47            commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
48            If you have linked libgd with freetype, then you might also need
49            either --with-freetype-lib or --with-freetype2-lib.
50    
51    There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
52    (and probably other OSes too). Check your local mirror for details. I also have
53    some links on the homepage for precompiled binaries. Please do not complain to
54    me about these binaries.
55    
56    
57    
58  Installing  Installing
# Line 50  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    
74    - 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.gif myfile.c,v          $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
81    
82  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
83  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
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    
96    Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
97    information on execution and configuration.
98    
99    
100    
101    Contributed code
102    ----------------
103    - contrib/automatic_documentation:
104      If you are interested in tag-management with respect to the correct branch
105      information, then I suggest that you take a look at the contribution from
106      Henrik Carlqvist. He submitted some server-side scripts that can manage tags
107      in a better fashion than cvs on its own.
108    
109    
110    
111  Todo  Todo
112  ----  ----
 - 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  
113  - 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
114    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
115  - redo the entire code :-) All good programs are written twice (at least). The    functional yet.
   structure is a real mess, but that is the price for hacking away without a  
   real programming strategy...  
116    
117    
118    
119  License  License
120  -------  -------
121  CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.  CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
122    
123    
124    

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.37

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0