/[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.45, Thu Dec 15 13:06:09 2005 UTC
# Line 1  Line 1 
1  CvsGraph 1.0.1  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
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 all numeric author ID
15          * cvs-1.10  
16          * rcs-5.7  - Changed acceptable mail policy. See below in this file
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 incomplete parsing of access keyword in rcsfile
19    newer version of gd.  
20    - Fix missing branch_bgcolor in manpage
21    
22    - Fix author names with spaces but not in @ encapsulation
23    
24    - Added multiple merge_{from,to,color} matching. Now several regex
25      combinations are allowed to run concurrently.
26    
27    
28    
29  Compiling  Compiling
30  ---------  ---------
31  Go to a directory of your choice, unpack the package and cd into the newly  
32  create directory:  create directory:
33          $ cd /where/ever/you/want          $ cd /where/ever/you/want
34          $ tar xzf cvsgraph-1.0.1.tar.gz          $ tar xzf cvsgraph-1.5.3.tar.gz
35          $ cd cvsgraph-1.0.1          $ cd cvsgraph-1.5.3
   
 Edit the Makefile to suit your needs and run:  
36          $ ./configure          $ ./configure
37          $ make          $ make
38    
39  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
40  current directory.  current directory.
41    
42    NOTE:   The GD library is required for CvsGraph to function. Get it from
43            http://www.boutell.com, compile it and use either --with-gd-lib=DIR
44            and --with-gd-inc=DIR to specify its location. You might also have
45            to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
46            for gd versions 1.6 and higher.
47            If you build with static libgd (i.e. libgd.a) and already have
48            libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
49            try to trick configure into adding these libs to the tests by adding
50            commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
51            If you have linked libgd with freetype, then you might also need
52            either --with-freetype-lib or --with-freetype2-lib.
53    
54    There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
55    (and probably other OSes too). Check your local mirror for details. I also have
56    some links on the homepage for precompiled binaries. Please do not complain to
57    me about these binaries.
58    
59    
60    
61  Installing  Installing
# Line 51  Line 72 
72  ----------------  ----------------
73  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
74  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
75  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:
76    
77    - ViewCVS       http://viewcvs.sourceforge.net
78    - CVSweb        http://www.freebsd.org/projects/cvsweb.html
79    - Chora         http://www.horde.org/chora/
80    
81    
82  To generate an image do something like:  To generate an image do something like:
83          $ 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
84    
85  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
86  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
87  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
88  that the extension of the file ends with ",v".  that the extension of the file ends with ",v".
89    
90    Just to make it clear:  You cannot make images from a cvs-repository over the
91                            internet as if you were using cvs. The repository files
92                            must be on a locally mounted filesystem. However, you
93                            can use cvsup or rsync to get a repository to your
94                            local filesystem and make then images from there.
95    
96  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
97  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
98    
99    Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
100    information on execution and configuration.
101    
102    
103    
104    Contributed code
105    ----------------
106    - contrib/automatic_documentation:
107      If you are interested in tag-management with respect to the correct branch
108      information, then I suggest that you take a look at the contribution from
109      Henrik Carlqvist. He submitted some server-side scripts that can manage tags
110      in a better fashion than cvs on its own.
111    
112    
113    
114  Todo  Todo
115  ----  ----
 - 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  
116  - 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
117    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
118  - 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...  
119    
120    
121    
122  License  License
123  -------  -------
124  CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.  CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
125    
126    
127    
# Line 93  Line 130 
130  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
131  E-mail: cvsgraph@akhphd.au.dk  E-mail: cvsgraph@akhphd.au.dk
132    
133    
134    
135    Mailnote
136    --------
137    As of 20 August 2005, if you send me an email with a contained or attached
138    disclaimer that includes one or more of the following items:
139    
140        * legal notice or threat(s)
141        * disclosure restriction(s)
142        * forward restriction(s)
143        * "intended recipient" nonsense
144    
145    Then you automatically agree to pay me a license fee of DKK 1000,- for using my
146    email address and a DKK 250,- fee for wasting my time on reading it.
147    
148  Greetings Bertho  Greetings Bertho
149    

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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0