=================================================================== RCS file: /cvs/cvsweb/INSTALL,v retrieving revision 3.4 retrieving revision 3.9 diff -u -p -r3.4 -r3.9 --- cvsweb/INSTALL 2002/07/30 19:42:26 3.4 +++ cvsweb/INSTALL 2003/05/01 15:47:32 3.9 @@ -1,9 +1,23 @@ $FreeBSD$ -1) To get cvsweb.cgi to work, make sure that you - have Perl 5 installed and a web server which is capable - of executing cgi-scripts. +1) To get cvsweb.cgi to work, make sure that you have Perl 5.005_03 or + newer installed and a web server which is capable of executing CGI + scripts. + The following Perl modules are required. Chances are that some of + these are already installed with your Perl distribution. The oldest + Perl distributions, if any, that already ship with these modules have + been marked below. If your Perl doesn't have some of the modules, + you can get them from CPAN, . Be sure to + install also the prerequisites these modules may have. Note that + this list contains only modules that aren't already part of Perl + 5.005_03 and newer. + + + Module name Ships with Perl version + ------------------------------------------- + File::Temp 5.8.0 + Surprisingly enough, you need to have cvs installed. The recommended version of cvs is 1.11 or newer. Older cvs versions may work with more or less quirks, YMMV. @@ -11,13 +25,19 @@ $FreeBSD$ Currently, you'll also need to have the GNU RCS utilities 'rlog', 'rcsdiff' installed (current version is 5.7). - This will change if cvs will be able - to serve these functions without having a working directory - [see TODO] - Note that the cvsweb.cgi script needs to have physical - access to the repository (or a copy of it) therefore; - rsh/ssh or pserver access doesn't work yet. + This may change if cvs will be able to serve these functions without + having a working directory [see TODO]. + Note that the cvsweb.cgi script needs to have physical access to the + repository (or a copy of it) therefore; rsh, ssh or pserver access + doesn't work yet. + + Install CvsGraph if you want to use it with CVSWeb, and see (6) for + configuration notes. CvsGraph 1.4.0 or newer is required. + + Install GNU Enscript if you want syntax highlighting, and see (7) for + more info. You'll need version 1.6.2 or newer. + 2) Copy cvsweb.conf to your configuration directory. If you've installed Apache, $ServerRoot/conf (or $ServerRoot/etc with versions >= 1.3.0) makes sense. @@ -31,7 +51,7 @@ $FreeBSD$ point to your configuration file. If your perl binary isn't located in /usr/bin you'll have to edit the first line of the script as well. - If you want to run cvsweb.cgi on Windows NT, see (6). + If you want to run cvsweb.cgi on Windows NT, see (9). 4) If you do not have the dir.gif, text.gif and back.gif icons, copy them somewhere in your $DocumentRoot and edit the %ICONS hash @@ -42,9 +62,25 @@ $FreeBSD$ mini icons in the icons/ directory and change the %ICONS hash in cvsweb.conf. -5) Have fun! +5) Copy cvsweb.css from the css/ directory to a web server directory, and + point the $cssurl variable in cvsweb.conf to it. -6) If you've Windows NT running, calling of external programs with parameters +6) CvsGraph can be used with + this version of CVSWeb. See the $allow_cvsgraph and $cvsgraph_config + configuration variables in cvsweb.conf. cvsweb.cgi will override some + of the settings in the cvsgraph configuration file with command line + options; the following in particular: map_branch_href, map_rev_href and + map_diff_href so you won't have to tweak them for CVSWeb. Note (and + install) also the cvsgraph.png icon in the icons/ directory. + +7) GNU Enscript can be used for syntax + highlighting. To enable it, copy lang_cvsweb.st from the enscript/ dir + to your Enscript "hl" directory (eg. /usr/share/enscript/hl/) and enable + $allow_enscript in cvsweb.conf. + +8) Have fun! + +9) If you've Windows NT running, calling of external programs with parameters single quoted doesn't work (search for rcsdiff, rlog in cvsweb.cgi), you've to replace it with double quotes. Thanks to Nick Brachet for pointing this out. @@ -57,7 +93,7 @@ $FreeBSD$ > will fail on NT because the ' are not recognized. Using " will work > though. -7) If you like you can add descriptions to be shown next to each directory +10) If you like you can add descriptions to be shown next to each directory or module name. These are read from CVSROOT/descriptions. - Check out a copy of your CVSROOT