/[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.1, Tue Feb 20 12:07:03 2001 UTC revision 1.46, Sun Dec 18 01:57:57 2005 UTC
# Line 1  Line 1 
1  CvsGraph 1.0.0  CvsGraph 1.6.0, 18-Dec-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] with 2.2.16.  - 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 (!)  
18    and have (yet) no clue wheter other systems will like my writing.  - Fix incomplete parsing of access keyword in rcsfile
19  - CvsGraph only generates (sort of) gifs at the moment because of an old  
20    version of libgd. You are welcome to change this (shouldn't be too hard).  - 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    - Added dynamic colors and strings for more flexibility in visual
28      representations of the tree.
29    
30    - Added keyword rev_idtext to define the revision ID in a revision
31      box. Normally this would show the revision number, but can now be
32      changed dynamically.
33    
34    - Fix dashed lines when stripped revisions have mergepoints attatched
35    
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.0.tar.gz          $ tar xzf cvsgraph-1.6.0.tar.gz
44          $ cd cvsgraph-1.0.0          $ cd cvsgraph-1.6.0
45            $ ./configure
 Edit the Makefile to suit your needs and run:  
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            If you have linked libgd with freetype, then you might also need
61            either --with-freetype-lib or --with-freetype2-lib.
62    
63    There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
64    (and probably other OSes too). Check your local mirror for details. I also have
65    some links on the homepage for precompiled binaries. Please do not complain to
66    me about these binaries.
67    
68    
69    
70  Installing  Installing
# Line 51  Line 81 
81  ----------------  ----------------
82  Do *NOT* execute the program directly from a webserver. Direct execution would  Do *NOT* execute the program directly from a webserver. Direct execution would
83  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
84  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:
85    
86  To generate am image do something like:  - ViewCVS       http://viewcvs.sourceforge.net
87          $ cvsgraph -r /home/to/repository -m module -o mygraph.gif myfile.c,v  - CVSweb        http://www.freebsd.org/projects/cvsweb.html
88    - Chora         http://www.horde.org/chora/
89    
90    
91    To generate an image do something like:
92            $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
93    
94  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
95  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
96  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
97  that the extension of the file ends with ",v".  that the extension of the file ends with ",v".
98    
99    Just to make it clear:  You cannot make images from a cvs-repository over the
100                            internet as if you were using cvs. The repository files
101                            must be on a locally mounted filesystem. However, you
102                            can use cvsup or rsync to get a repository to your
103                            local filesystem and make then images from there.
104    
105  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
106  (no '-o'), then the output is written to standard output.  (no '-o'), then the output is written to standard output.
107    
108    Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
109    information on execution and configuration.
110    
111    
112    
113    Contributed code
114    ----------------
115    - contrib/automatic_documentation:
116      If you are interested in tag-management with respect to the correct branch
117      information, then I suggest that you take a look at the contribution from
118      Henrik Carlqvist. He submitted some server-side scripts that can manage tags
119      in a better fashion than cvs on its own.
120    
121    
122    
123  Todo  Todo
124  ----  ----
 - use autoconf  
 - use a newer version of libgd, or better, 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  
125  - 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
126    revision-connectors to make place)    revision-connectors to make place). A start is made, but this is not very
127  - 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...  
128    
129    
130    
131  License  License
132  -------  -------
133  CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.  CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
134    
135    
136    
# Line 94  Line 139 
139  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph  HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
140  E-mail: cvsgraph@akhphd.au.dk  E-mail: cvsgraph@akhphd.au.dk
141    
142    
143    
144    Mailnote
145    --------
146    As of 20 August 2005, if you send me an email with a contained or attached
147    disclaimer that includes one or more of the following items:
148    
149        * legal notice or threat(s)
150        * disclosure restriction(s)
151        * forward restriction(s)
152        * "intended recipient" nonsense
153    
154    Then you automatically agree to pay me a license fee of DKK 1000,- for using my
155    email address and a DKK 250,- fee for wasting my time on reading it.
156    
157  Greetings Bertho  Greetings Bertho
158    

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.46

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0