/[CvsGraph]/cvsgraph/README
ViewVC logotype

Annotate of /cvsgraph/README

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


Revision 1.18 - (hide annotations)
Sun Mar 9 22:36:50 2003 UTC (14 years, 8 months ago) by bertho
Branch: MAIN
Changes since 1.17: +11 -1 lines
- add merge visualization
- Provide solution for possible XSS bug in tag expansions
1 bertho 1.15 CvsGraph 1.3.0, 20-Jul-2002
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.17 - Fix warnings in readconf on some 'older' compiler systems.
14 bertho 1.14
15 bertho 1.17 - Implement new option to generate proper maps for different levels of HTML.
16     The option -x[34x] determines HTML 3.x (default), HTML 4.x or XHTML style
17     maps.
18 bertho 1.15
19 bertho 1.18 - Implement a scheme to visualize merges based on tag names. If tages are
20     consistently named at the mergepoint and the destination, then these points
21     can be detected using regular expressions. Several new configuration
22     options, merge_*, describe the tags.
23    
24     - Implemented HTMLizing of expansion with %(...%). This prevents a possible
25     cross site scripting exploit when you use '<', '>' or '"' in tagnames.
26     This is a remote chance (you must be stupid to use these characters in a
27     tagname) but anyway, your system can be under attack.
28    
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.15 $ tar xzf cvsgraph-1.3.0.tar.gz
37     $ cd cvsgraph-1.3.0
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.10 normally use. The easiest way is to get the ViewCVS package from their website
73     at http://viewcvs.sourceforge.net and follow the instructions.
74    
75     Alternately, you can hack the 'cvsweb' package to call CvsGraph. There are
76     several scripts and patches available from the CvsGraph homepage (see below for
77     address). However, the scripts are no longer maintained because ViewCVS has
78     native support now.
79 bertho 1.1
80 bertho 1.2 To generate an image do something like:
81 bertho 1.5 $ cvsgraph -r /home/to/repository -m module -o mygraph.png myfile.c,v
82 bertho 1.1
83     This generates a revison/branch image of the rcs file 'myfile.c,v' and puts it
84 bertho 1.5 into 'mygraph.png'. The '-r' option is the path to the repository *located and
85 bertho 1.1 accessible* on your filesystem. The '-m' is the module in the repository. Note
86     that the extension of the file ends with ",v".
87    
88 bertho 1.9 Just to make it clear: You cannot make images from a cvs-repository over the
89     internet as if you were using cvs. The repository files
90     must be on a locally mounted filesystem. However, you
91     can use cvsup or rsync to get a repository to your
92 bertho 1.18 local filesystem and make then images from there.
93 bertho 1.9
94 bertho 1.1 Type 'cvsgraph -h' to get a full list of options. If the output is not given
95     (no '-o'), then the output is written to standard output.
96    
97 bertho 1.5 Please read the manual pages cvsgraph(1) and cvsgraph.conf(5) for more
98     information on execution and configuration.
99    
100 bertho 1.1
101    
102     Todo
103     ----
104     - do a better job in making a layout (auto moving branches and rubber banding
105 bertho 1.12 revision-connectors to make place). A start is made, but this is not very
106     functional yet.
107 bertho 1.1
108 bertho 1.11 - draw only a part or parts of the tree.
109 bertho 1.12
110 bertho 1.1
111    
112     License
113     -------
114 bertho 1.9 CvsGraph is distributed under GNU GPL v2. See 'LICENSE' for more information.
115 bertho 1.1
116    
117    
118     Contact
119     -------
120     HomePage: http://www.akhphd.au.dk/~bertho/cvsgraph
121     E-mail: cvsgraph@akhphd.au.dk
122    
123     Greetings Bertho
124    

  ViewVC Help
Powered by ViewVC 1.1.0 with CvsGraph 1.7.0