/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.6 - (show annotations)
Thu Mar 22 21:42:48 2001 UTC (16 years, 7 months ago) by bertho
Branch: MAIN
CVS Tags: REL_1_1_2
Changes since 1.5: +3 -3 lines
- Dead tags (i.e. a tag without a valid revision or branch) does no
  longer print a message in quiet mode.
- Added expansions for cvsroot and cvsmodule without trailing '/'
- Remove core-files in a 'make clean'.
- Fixed default config file to use entities < and >.
1 CvsGraph 1.1.2, 22-Mar-2001
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 This version of CvsGraph includes more control over the graphical presentation
14 of the boxes drawn to show revisions and branches (notably background colors
15 and shadows). Imagemaps can now generate links to generate diffs. A couple of
16 manual pages has been written for both executable and configuration.
17
18
19
20 Compiling
21 ---------
22 Go to a directory of your choice, unpack the package and cd into the newly
23 create directory:
24 $ cd /where/ever/you/want
25 $ tar xzf cvsgraph-1.1.2.tar.gz
26 $ cd cvsgraph-1.1.2
27 $ ./configure
28 $ make
29
30 This should do the trick and you have an executable file 'cvsgraph' in the
31 current directory.
32
33
34
35 Installing
36 ----------
37 Put the executable file 'cvsgraph' somewhere where you think it should go.
38 Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
39 ought to be put in "/usr/local/etc" or "/etc". The exact position can be
40 overriden on the commandline anyway. Edit the configuration file to your liking
41 and you should be all set.
42
43
44
45 Running CvsGraph
46 ----------------
47 Do *NOT* execute the program directly from a webserver. Direct execution would
48 be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
49 normally use. A nice way is to hack the 'cvsweb' package to call CvsGraph.
50 There are several scripts and patches available from the CvsGraph homepage (see
51 below for address).
52
53 To generate an image do something like:
54 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
55
56 This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
57 into 'mygraph.png'. The '-r' option is the path to the repository *located and
58 accessible* on your filesystem. The '-m' is the module in the repository. Note
59 that the extension of the file ends with ",v".
60
61 Type 'cvsgraph -h' to get a full list of options. If the output is not given
62 (no '-o'), then the output is written to standard output.
63
64 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
65 information on execution and configuration.
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 - do a better job in making a layout (auto moving branches and rubber banding
74 revision-connectors to make place)
75
76
77
78 License
79 -------
80 CvsGraph is distributed under GNU GPL v2. See 'LICENCE' for more information.
81
82
83
84 Contact
85 -------
86 HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
87 E-mail: cvsgraph@akhphd.au.dk
88
89 Greetings Bertho
90

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0