Annotate of /cvsgraph/README

CvsGraph 1.0.1
==============
CvsGraph creates a graphic representation of the revisions and branches in a
cvs/rcs repository. CvsGraph is inspired on the 'graph'-option from WinCVS. I
could not find something right away on the web and decided that it was time to
write a stand-alone version. I might have been doing some double work, but hey,
I like a hack.


Notes
-----
- I only tested it with:
	* RedHat Linux 6.[12] and 7.0
	* cvs-1.10
	* rcs-5.7
	* gd-1.3 and gd-1.8
- CvsGraph generates only gifs for old versions of gd and only png and jpeg for
  newer version of gd.


Compiling
---------
Go to a directory of your choice, unpack the package and cd into the newly
create directory:
	$ cd /where/ever/you/want
	$ tar xzf cvsgraph-1.0.1.tar.gz
	$ cd cvsgraph-1.0.1

Edit the Makefile to suit your needs and run:
	$ ./configure
	$ make

This should do the trick and you have an executable file 'cvsgraph' in the
current directory.


Installing
----------
Put the executable file 'cvsgraph' somewhere where you think it should go.
Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
ought to be put in "/usr/local/etc" or "/etc". The exact position can be
overriden on the commandline anyway. Edit the configuration file to your liking
and you should be all set.


Running CvsGraph
----------------
Do *NOT* execute the program directly from a webserver. Direct execution would
be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
normally use. A nice way is to hack the 'cvsweb' package to call CvsGraph.

To generate an image do something like:
	$ cvsgraph -r /home/to/repository -m module -o mygraph.gif myfile.c,v

This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
into 'mygraph.gif'. The '-r' option is the path to the repository *located and
accessible* on your filesystem. The '-m' is the module in the repository. Note
that the extension of the file ends with ",v".

Type 'cvsgraph -h' to get a full list of options. If the output is not given
(no '-o'), then the output is written to standard output.


Todo
----
- 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
- do a better job in making a layout (auto moving branches and rubber banding
  revision-connectors to make place)
- redo the entire code :-) All good programs are written twice (at least). The
  structure is a real mess, but that is the price for hacking away without a
  real programming strategy...


License
-------
CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.


Contact
-------
HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
E-mail: cvsgraph@akhphd.au.dk

Greetings Bertho

1	bertho	1.2	CvsGraph 1.0.1
2	bertho	1.1	==============
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	bertho	1.2	* RedHat Linux 6.[12] and 7.0
15	bertho	1.1	* cvs-1.10
16			* rcs-5.7
17	bertho	1.2	* gd-1.3 and gd-1.8
18			- CvsGraph generates only gifs for old versions of gd and only png and jpeg for
19			newer version of gd.
20	bertho	1.1
21
22
23			Compiling
24			---------
25			Go to a directory of your choice, unpack the package and cd into the newly
26			create directory:
27			$ cd /where/ever/you/want
28	bertho	1.2	$ tar xzf cvsgraph-1.0.1.tar.gz
29			$ cd cvsgraph-1.0.1
30	bertho	1.1
31			Edit the Makefile to suit your needs and run:
32	bertho	1.3	$ ./configure
33	bertho	1.1	$ 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	bertho	1.2	To generate an image do something like:
57	bertho	1.1	$ 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	bertho	1.2	- use ImageMagick for better control over what is generated (also multiple
72			output formats would be possible)
73	bertho	1.1	- find a way to use cvs directly instead of rcs (rlog) without the need for a
74			full checkout of the repository/module
75			- clean up the mess of finding revisions, tags and branches. The main branch
76			does not nessecarily start with revision 1.1
77			- do a better job in making a layout (auto moving branches and rubber banding
78			revision-connectors to make place)
79			- redo the entire code :-) All good programs are written twice (at least). The
80			structure is a real mess, but that is the price for hacking away without a
81			real programming strategy...
82
83
84
85			License
86			-------
87			CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.
88
89
90
91			Contact
92			-------
93			HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
94			E-mail: cvsgraph@akhphd.au.dk
95
96			Greetings Bertho
97