/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.3 - (show annotations)
Sat Feb 24 21:52:28 2001 UTC (16 years, 7 months ago) by bertho
Branch: MAIN
CVS Tags: REL_1_0_1
Changes since 1.2: +1 -0 lines
Mention to run configure before make
1 CvsGraph 1.0.1
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] and 7.0
15 * cvs-1.10
16 * rcs-5.7
17 * 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
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 $ tar xzf cvsgraph-1.0.1.tar.gz
29 $ cd cvsgraph-1.0.1
30
31 Edit the Makefile to suit your needs and run:
32 $ ./configure
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 an 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 ImageMagick for better control over what is generated (also multiple
72 output formats would be possible)
73 - 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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0