/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0