/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0