/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.40 - (hide annotations)
Sun Aug 21 07:56:53 2005 UTC (12 years, 1 month ago) by bertho
Branch: MAIN
Changes since 1.39: +4 -16 lines
Fix all numeric author ID
1 bertho 1.40 CvsGraph 1.5.3, 14-Jun-2005
2 bertho 1.5 ===========================
3 bertho 1.1 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 bertho 1.5 New in this version
12     -------------------
13 bertho 1.14
14 bertho 1.40 - Fix all numeric author ID
15 bertho 1.38
16 bertho 1.11
17 bertho 1.1
18     Compiling
19     ---------
20 bertho 1.9
21 bertho 1.1 create directory:
22     $ cd /where/ever/you/want
23 bertho 1.40 $ tar xzf cvsgraph-1.5.3.tar.gz
24     $ cd cvsgraph-1.5.3
25 bertho 1.3 $ ./configure
26 bertho 1.1 $ make
27    
28     This should do the trick and you have an executable file 'cvsgraph' in the
29     current directory.
30    
31 bertho 1.9 NOTE: The GD library is required for CvsGraph to function. Get it from
32     http://www.boutell.com, compile it and use either --with-gd-lib=DIR
33     and --with-gd-inc=DIR to specify its location. You might also have
34     to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
35     for gd versions 1.6 and higher.
36     If you build with static libgd (i.e. libgd.a) and already have
37     libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
38     try to trick configure into adding these libs to the tests by adding
39     commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
40 bertho 1.11 If you have linked libgd with freetype, then you might also need
41     either --with-freetype-lib or --with-freetype2-lib.
42 bertho 1.1
43 bertho 1.26 There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
44     (and probably other OSes too). Check your local mirror for details. I also have
45     some links on the homepage for precompiled binaries. Please do not complain to
46     me about these binaries.
47    
48 bertho 1.1
49 bertho 1.12
50 bertho 1.1 Installing
51     ----------
52     Put the executable file 'cvsgraph' somewhere where you think it should go.
53     Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
54     ought to be put in "/usr/local/etc" or "/etc". The exact position can be
55     overriden on the commandline anyway. Edit the configuration file to your liking
56     and you should be all set.
57    
58    
59    
60     Running CvsGraph
61     ----------------
62     Do *NOT* execute the program directly from a webserver. Direct execution would
63     be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
64 bertho 1.25 normally use. There are several web-based viewers with CvsGraph support:
65    
66     - ViewCVS http://viewcvs.sourceforge.net
67     - CVSweb http://www.freebsd.org/projects/cvsweb.html
68     - Chora http://www.horde.org/chora/
69 bertho 1.10
70 bertho 1.1
71 bertho 1.2 To generate an image do something like:
72 bertho 1.5 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
73 bertho 1.1
74     This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
75 bertho 1.5 into 'mygraph.png'. The '-r' option is the path to the repository *located and
76 bertho 1.1 accessible* on your filesystem. The '-m' is the module in the repository. Note
77     that the extension of the file ends with ",v".
78    
79 bertho 1.9 Just to make it clear: You cannot make images from a cvs-repository over the
80     internet as if you were using cvs. The repository files
81     must be on a locally mounted filesystem. However, you
82     can use cvsup or rsync to get a repository to your
83 bertho 1.18 local filesystem and make then images from there.
84 bertho 1.9
85 bertho 1.1 Type 'cvsgraph -h' to get a full list of options. If the output is not given
86     (no '-o'), then the output is written to standard output.
87    
88 bertho 1.5 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
89     information on execution and configuration.
90 bertho 1.34
91    
92    
93     Contributed code
94     ----------------
95     - contrib/automatic_documentation:
96     If you are interested in tag-management with respect to the correct branch
97     information, then I suggest that you take a look at the contribution from
98     Henrik Carlqvist. He submitted some server-side scripts that can manage tags
99     in a better fashion than cvs on its own.
100 bertho 1.5
101 bertho 1.1
102    
103     Todo
104     ----
105     - do a better job in making a layout (auto moving branches and rubber banding
106 bertho 1.12 revision-connectors to make place). A start is made, but this is not very
107     functional yet.
108    
109 bertho 1.1
110    
111     License
112     -------
113 bertho 1.9 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
114 bertho 1.1
115    
116    
117     Contact
118     -------
119     HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
120     E-mail: cvsgraph@akhphd.au.dk
121    
122     Greetings Bertho
123    

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0