/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0