/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


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

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0