/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0