Annotate of /cvsgraph/README

CvsGraph 1.3.0, 20-Jul-2002
===========================
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.


New in this version
-------------------
- Fix warnings in readconf on some 'older' compiler systems.

- Implement new option to generate proper maps for different levels of HTML.
  The option -x[34x] determines HTML 3.x (default), HTML 4.x or XHTML style
  maps.


Compiling
---------

create directory:
	$ cd /where/ever/you/want
	$ tar xzf cvsgraph-1.3.0.tar.gz
	$ cd cvsgraph-1.3.0
	$ ./configure
	$ make

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

NOTE:	The GD library is required for CvsGraph to function. Get it from
	http://www.boutell.com, compile it and use either --with-gd-lib=DIR
	and --with-gd-inc=DIR to specify its location. You might also have
	to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
	for gd versions 1.6 and higher.
	If you build with static libgd (i.e. libgd.a) and already have
	libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
	try to trick configure into adding these libs to the tests by adding
	commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
	If you have linked libgd with freetype, then you might also need
	either --with-freetype-lib or --with-freetype2-lib.


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. The easiest way is to get the ViewCVS package from their website
at http://viewcvs.sourceforge.net and follow the instructions.

Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
several scripts and patches available from the CvsGraph homepage (see below for
address). However, the scripts are no longer maintained because ViewCVS has
native support now.

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

This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
into 'mygraph.png'. 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".

Just to make it clear:	You cannot make images from a cvs-repository over the
			internet as if you were using cvs. The repository files
			must be on a locally mounted filesystem. However, you
			can use cvsup or rsync to get a repository to your
			local filesystem and make then image from there.

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.

Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
information on execution and configuration.


Todo
----
- do a better job in making a layout (auto moving branches and rubber banding
  revision-connectors to make place). A start is made, but this is not very
  functional yet.

- draw only a part or parts of the tree.


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


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

Greetings Bertho

1	CvsGraph 1.3.0, 20-Jul-2002
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	New in this version
12	-------------------
13	- Fix warnings in readconf on some 'older' compiler systems.
14
15	- Implement new option to generate proper maps for different levels of HTML.
16	The option -x[34x] determines HTML 3.x (default), HTML 4.x or XHTML style
17	maps.
18
19
20
21	Compiling
22	---------
23
24	create directory:
25	$ cd /where/ever/you/want
26	$ tar xzf cvsgraph-1.3.0.tar.gz
27	$ cd cvsgraph-1.3.0
28	$ ./configure
29	$ make
30
31	This should do the trick and you have an executable file 'cvsgraph' in the
32	current directory.
33
34	NOTE: The GD library is required for CvsGraph to function. Get it from
35	http://www.boutell.com, compile it and use either --with-gd-lib=DIR
36	and --with-gd-inc=DIR to specify its location. You might also have
37	to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
38	for gd versions 1.6 and higher.
39	If you build with static libgd (i.e. libgd.a) and already have
40	libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
41	try to trick configure into adding these libs to the tests by adding
42	commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
43	If you have linked libgd with freetype, then you might also need
44	either --with-freetype-lib or --with-freetype2-lib.
45
46
47
48	Installing
49	----------
50	Put the executable file 'cvsgraph' somewhere where you think it should go.
51	Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
52	ought to be put in "/usr/local/etc" or "/etc". The exact position can be
53	overriden on the commandline anyway. Edit the configuration file to your liking
54	and you should be all set.
55
56
57
58	Running CvsGraph
59	----------------
60	Do NOT execute the program directly from a webserver. Direct execution would
61	be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
62	normally use. The easiest way is to get the ViewCVS package from their website
63	at http://viewcvs.sourceforge.net and follow the instructions.
64
65	Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
66	several scripts and patches available from the CvsGraph homepage (see below for
67	address). However, the scripts are no longer maintained because ViewCVS has
68	native support now.
69
70	To generate an image do something like:
71	$ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
72
73	This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
74	into 'mygraph.png'. The '-r' option is the path to the repository *located and
75	accessible* on your filesystem. The '-m' is the module in the repository. Note
76	that the extension of the file ends with ",v".
77
78	Just to make it clear: You cannot make images from a cvs-repository over the
79	internet as if you were using cvs. The repository files
80	must be on a locally mounted filesystem. However, you
81	can use cvsup or rsync to get a repository to your
82	local filesystem and make then image from there.
83
84	Type 'cvsgraph -h' to get a full list of options. If the output is not given
85	(no '-o'), then the output is written to standard output.
86
87	Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
88	information on execution and configuration.
89
90
91
92	Todo
93	----
94	- do a better job in making a layout (auto moving branches and rubber banding
95	revision-connectors to make place). A start is made, but this is not very
96	functional yet.
97
98	- draw only a part or parts of the tree.
99
100
101
102	License
103	-------
104	CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
105
106
107
108	Contact
109	-------
110	HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
111	E-mail: cvsgraph@akhphd.au.dk
112
113	Greetings Bertho
114