/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.25 - (hide annotations)
Sat Aug 14 14:56:18 2004 UTC (13 years, 3 months ago) by bertho
Branch: MAIN
Changes since 1.24: +15 -32 lines
- Add comments on latest changes on tag_ignore
- Mention that there are at least 3 viewers with support for CvsGraph
1 bertho 1.24 CvsGraph 1.4.2, 16-Jul-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.25 - Add regex method for ignoring tags in the generation of the graph. Old trees
15     are overpolulated and this is a way to reduce it even further. New config
16     options tag_ignore, tag_nocase and tag_negate.
17 bertho 1.23
18    
19    
20 bertho 1.25 Known BUGS
21     ----------
22 bertho 1.23
23 bertho 1.25 - The timezone variable does not seem to exist on Mac OSX. I have no clue how
24     to patch this yet.
25     Anyhow, the timezone problem is much worse, because it needs to be calculated
26     from the revision's commit-time and not the current timezone (Daylight saving
27     must be accounted for at commit's time, not current).
28 bertho 1.21
29 bertho 1.11
30 bertho 1.1
31     Compiling
32     ---------
33 bertho 1.9
34 bertho 1.1 create directory:
35     $ cd /where/ever/you/want
36 bertho 1.24 $ tar xzf cvsgraph-1.4.2.tar.gz
37     $ cd cvsgraph-1.4.2
38 bertho 1.3 $ ./configure
39 bertho 1.1 $ make
40    
41     This should do the trick and you have an executable file 'cvsgraph' in the
42     current directory.
43    
44 bertho 1.9 NOTE: The GD library is required for CvsGraph to function. Get it from
45     http://www.boutell.com, compile it and use either --with-gd-lib=DIR
46     and --with-gd-inc=DIR to specify its location. You might also have
47     to use --with-z-inc, --with-z-lib and --with-png-inc, --with-png-lib
48     for gd versions 1.6 and higher.
49     If you build with static libgd (i.e. libgd.a) and already have
50     libpng.so and/or libjpeg6b.so (i.e. dynamic), then you might want to
51     try to trick configure into adding these libs to the tests by adding
52     commandline options '--with-png-lib=.' and '--with-jpeg-lib=.'.
53 bertho 1.11 If you have linked libgd with freetype, then you might also need
54     either --with-freetype-lib or --with-freetype2-lib.
55 bertho 1.1
56    
57 bertho 1.12
58 bertho 1.1 Installing
59     ----------
60     Put the executable file 'cvsgraph' somewhere where you think it should go.
61     Normally this would be "/usr/local/bin" or "/usr/bin". The configuration file
62     ought to be put in "/usr/local/etc" or "/etc". The exact position can be
63     overriden on the commandline anyway. Edit the configuration file to your liking
64     and you should be all set.
65    
66    
67    
68     Running CvsGraph
69     ----------------
70     Do *NOT* execute the program directly from a webserver. Direct execution would
71     be very insecure. Make a wrapper cgi-script in php, perl, or whatever you
72 bertho 1.25 normally use. There are several web-based viewers with CvsGraph support:
73    
74     - ViewCVS http://viewcvs.sourceforge.net
75     - CVSweb http://www.freebsd.org/projects/cvsweb.html
76     - Chora http://www.horde.org/chora/
77 bertho 1.10
78 bertho 1.1
79 bertho 1.2 To generate an image do something like:
80 bertho 1.5 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
81 bertho 1.1
82     This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
83 bertho 1.5 into 'mygraph.png'. The '-r' option is the path to the repository *located and
84 bertho 1.1 accessible* on your filesystem. The '-m' is the module in the repository. Note
85     that the extension of the file ends with ",v".
86    
87 bertho 1.9 Just to make it clear: You cannot make images from a cvs-repository over the
88     internet as if you were using cvs. The repository files
89     must be on a locally mounted filesystem. However, you
90     can use cvsup or rsync to get a repository to your
91 bertho 1.18 local filesystem and make then images from there.
92 bertho 1.9
93 bertho 1.1 Type 'cvsgraph -h' to get a full list of options. If the output is not given
94     (no '-o'), then the output is written to standard output.
95    
96 bertho 1.5 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
97     information on execution and configuration.
98    
99 bertho 1.1
100    
101     Todo
102     ----
103     - do a better job in making a layout (auto moving branches and rubber banding
104 bertho 1.12 revision-connectors to make place). A start is made, but this is not very
105     functional yet.
106 bertho 1.1
107 bertho 1.11 - draw only a part or parts of the tree.
108 bertho 1.12
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