/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.1 - (hide annotations)
Tue Feb 20 12:07:03 2001 UTC (16 years, 8 months ago) by bertho
Branch: MAIN
Branch point for: CvsGraph
Initial revision
1 bertho 1.1 CvsGraph 1.0.0
2     ==============
3     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
5     could not find something right away on the web and decided that it was time to
6     write a stand-alone version. I might have been doing some double work, but hey,
7     I like a hack.
8    
9    
10    
11     Notes
12     -----
13     - I only tested it with:
14     * RedHat Linux 6.[12] with 2.2.16.
15     * cvs-1.10
16     * rcs-5.7
17     * gd-1.3 (!)
18     and have (yet) no clue wheter other systems will like my writing.
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).
21    
22    
23    
24     Compiling
25     ---------
26     Go to a directory of your choice, unpack the package and cd into the newly
27     create directory:
28     $ cd /where/ever/you/want
29     $ tar xzf cvsgraph-1.0.0.tar.gz
30     $ cd cvsgraph-1.0.0
31    
32     Edit the Makefile to suit your needs and run:
33     $ make
34    
35     This should do the trick and you have an executable file 'cvsgraph' in the
36     current directory.
37    
38    
39    
40     Installing
41     ----------
42     Put the executable file 'cvsgraph' somewhere where you think it should go.
43     Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
44     ought to be put in "/usr/local/etc" or "/etc". The exact position can be
45     overriden on the commandline anyway. Edit the configuration file to your liking
46     and you should be all set.
47    
48    
49    
50     Running CvsGraph
51     ----------------
52     Do *NOT* execute the program directly from a webserver. Direct execution would
53     be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
54     normally use. A nice way is to hack the 'cvsweb' package to call CvsGraph.
55    
56     To generate am image do something like:
57     $ cvsgraph -r /home/to/repository -m module -o mygraph.gif myfile.c,v
58    
59     This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
60     into 'mygraph.gif'. The '-r' option is the path to the repository *located and
61     accessible* on your filesystem. The '-m' is the module in the repository. Note
62     that the extension of the file ends with ",v".
63    
64     Type 'cvsgraph -h' to get a full list of options. If the output is not given
65     (no '-o'), then the output is written to standard output.
66    
67    
68    
69     Todo
70     ----
71     - use autoconf
72     - use a newer version of libgd, or better, use ImageMagick for better control
73     over what is generated (also multiple output formats would be possible)
74     - find a way to use cvs directly instead of rcs (rlog) without the need for a
75     full checkout of the repository/module
76     - clean up the mess of finding revisions, tags and branches. The main branch
77     does not nessecarily start with revision 1.1
78     - do a better job in making a layout (auto moving branches and rubber banding
79     revision-connectors to make place)
80     - redo the entire code :-) All good programs are written twice (at least). The
81     structure is a real mess, but that is the price for hacking away without a
82     real programming strategy...
83    
84    
85    
86     License
87     -------
88     CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.
89    
90    
91    
92     Contact
93     -------
94     HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
95     E-mail: cvsgraph@akhphd.au.dk
96    
97     Greetings Bertho
98    

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0