/[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.48.2.1, Mon Nov 13 21:12:19 2006 UTC
# Line 1  Line 1 
1  CvsGraph 1.0.1  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
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 merge line links after redoing part of merge lines
15          * cvs-1.10  
16          * rcs-5.7  - Use automake
17          * gd-1.3 and gd-1.8  
18  - CvsGraph generates only gifs for old versions of gd and only png and jpeg for  - Streamline the package with patches from the Fedora RPMS
   newer version of gd.  
19    
20    
21    
22  Compiling  Compiling
23  ---------  ---------
24  Go to a directory of your choice, unpack the package and cd into the newly  
25  create directory:  create directory:
26          $ cd /where/ever/you/want          $ cd /where/ever/you/want
27          $ tar xzf cvsgraph-1.0.1.tar.gz          $ tar xzf cvsgraph-1.7.0.tar.gz
28          $ cd cvsgraph-1.0.1          $ cd cvsgraph-1.7.0
   
 Edit the Makefile to suit your needs and run:  
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    There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
36    (and probably other OSes too). Check your local mirror for details. I also have
37    some links on the homepage for precompiled binaries. Please do not complain to
38    me about these binaries.
39    
40    
41    
42  Installing  Installing
# Line 51  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. A nice way is to hack the 'cvsweb' package to call CvsGraph.  normally use. There are several web-based viewers with CvsGraph support:
57    
58    - ViewCVS       http://viewcvs.sourceforge.net
59    - CVSweb        http://www.freebsd.org/projects/cvsweb.html
60    - Chora         http://www.horde.org/chora/
61    
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.gif myfile.c,v          $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
65    
66  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
67  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
68  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
69  that the extension of the file ends with ",v".  that the extension of the file ends with ",v".
70    
71    Just to make it clear:  You cannot make images from a cvs-repository over the
72                            internet as if you were using cvs. The repository files
73                            must be on a locally mounted filesystem. However, you
74                            can use cvsup or rsync to get a repository to your
75                            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.
79    
80    Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
81    information on execution and configuration.
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  ----  ----
 - 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  
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  - 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...  
100    
101    
102    
103  License  License
104  -------  -------
105  CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.  CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
106    
107    
108    
# Line 93  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.3  
changed lines
  Added in v.1.48.2.1

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0