/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.30 - (hide annotations)
Thu Sep 23 20:29:01 2004 UTC (13 years, 1 month ago) by bertho
Branch: MAIN
Changes since 1.29: +6 -9 lines
Change the timezone stuff to fix localtime calculation as suggested by
Henrik Carlqvist <henca {at} users.SourceForge.net>
1 bertho 1.28 CvsGraph 1.5.1, 15-Aug-2004
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.28 - Add patch from Henrik Carlqvist <henca@users.SourceForge.net>
15     * add option rev_hidenumber for disabling revision number display.
16     * add option tag_ignore_merge for disabling merge_from/merge_to display
17     if matched with tag_ignore.
18 bertho 1.29 * add resorting of branches on how many revisions they have. This saves
19     space under circumstances.
20 bertho 1.28
21     - Add option merge_findall so that merge_from/merge_to tags can have multiple
22     matches.
23 bertho 1.26
24 bertho 1.30 - Add the patches supplied by Ville Skytta <ville.skytta@iki.fi>
25     * fix spelling in the manpages and config file
26     * fix & -> &amp; problem in config
27     * fix generics in wrapper example
28 bertho 1.23
29 bertho 1.30 - Add a fix for the zimezone problem as suggested by Henrik Carlqvist
30     <henca@users.SourceForge.net> by using the environment.
31 bertho 1.21
32 bertho 1.11
33 bertho 1.1
34     Compiling
35     ---------
36 bertho 1.9
37 bertho 1.1 create directory:
38     $ cd /where/ever/you/want
39 bertho 1.28 $ tar xzf cvsgraph-1.5.1.tar.gz
40     $ cd cvsgraph-1.5.1
41 bertho 1.3 $ ./configure
42 bertho 1.1 $ make
43    
44     This should do the trick and you have an executable file 'cvsgraph' in the
45     current directory.
46    
47 bertho 1.9 NOTE: The GD library is required for CvsGraph to function. Get it from
48     http://www.boutell.com, compile it and use either --with-gd-lib=DIR
49     and --with-gd-inc=DIR to specify its location. You might also have
50     to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
51     for gd versions 1.6 and higher.
52     If you build with static libgd (i.e. libgd.a) and already have
53     libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
54     try to trick configure into adding these libs to the tests by adding
55     commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
56 bertho 1.11 If you have linked libgd with freetype, then you might also need
57     either --with-freetype-lib or --with-freetype2-lib.
58 bertho 1.1
59 bertho 1.26 There are often precompiled binaries for Linux, FreeBSD, NetBSD and Windows
60     (and probably other OSes too). Check your local mirror for details. I also have
61     some links on the homepage for precompiled binaries. Please do not complain to
62     me about these binaries.
63    
64 bertho 1.1
65 bertho 1.12
66 bertho 1.1 Installing
67     ----------
68     Put the executable file 'cvsgraph' somewhere where you think it should go.
69     Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
70     ought to be put in "/usr/local/etc" or "/etc". The exact position can be
71     overriden on the commandline anyway. Edit the configuration file to your liking
72     and you should be all set.
73    
74    
75    
76     Running CvsGraph
77     ----------------
78     Do *NOT* execute the program directly from a webserver. Direct execution would
79     be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
80 bertho 1.25 normally use. There are several web-based viewers with CvsGraph support:
81    
82     - ViewCVS http://viewcvs.sourceforge.net
83     - CVSweb http://www.freebsd.org/projects/cvsweb.html
84     - Chora http://www.horde.org/chora/
85 bertho 1.10
86 bertho 1.1
87 bertho 1.2 To generate an image do something like:
88 bertho 1.5 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
89 bertho 1.1
90     This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
91 bertho 1.5 into 'mygraph.png'. The '-r' option is the path to the repository *located and
92 bertho 1.1 accessible* on your filesystem. The '-m' is the module in the repository. Note
93     that the extension of the file ends with ",v".
94    
95 bertho 1.9 Just to make it clear: You cannot make images from a cvs-repository over the
96     internet as if you were using cvs. The repository files
97     must be on a locally mounted filesystem. However, you
98     can use cvsup or rsync to get a repository to your
99 bertho 1.18 local filesystem and make then images from there.
100 bertho 1.9
101 bertho 1.1 Type 'cvsgraph -h' to get a full list of options. If the output is not given
102     (no '-o'), then the output is written to standard output.
103    
104 bertho 1.5 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
105     information on execution and configuration.
106    
107 bertho 1.1
108    
109     Todo
110     ----
111     - do a better job in making a layout (auto moving branches and rubber banding
112 bertho 1.12 revision-connectors to make place). A start is made, but this is not very
113     functional yet.
114    
115 bertho 1.1
116    
117     License
118     -------
119 bertho 1.9 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
120 bertho 1.1
121    
122    
123     Contact
124     -------
125     HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
126     E-mail: cvsgraph@akhphd.au.dk
127    
128     Greetings Bertho
129    

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0