version 4.1, 2019/03/20 20:52:07 |
version 4.9, 2019/11/26 12:14:38 |
|
|
$FreeBSD$ |
$Id$ |
|
$knu: INSTALL,v 1.36 2005/01/22 12:43:55 scop |
|
|
For notes on upgrading between FreeBSD-CVSweb releases, see the bottom |
For notes on upgrading between CVSweb releases, see the bottom |
of this document. |
of this document. |
|
|
1) To get cvsweb.cgi to work, make sure that you have Perl 5.6.0 or |
1) To get cvsweb.cgi to work, make sure that you have Perl 5.6.0 or |
Line 22 of this document. |
|
Line 23 of this document. |
|
File::Temp 5.8.0 required |
File::Temp 5.8.0 required |
IPC::Run N/A required |
IPC::Run N/A required |
MIME::Types N/A optional |
MIME::Types N/A optional |
String::Ediff N/A optional |
|
URI N/A required |
URI N/A required |
|
|
Surprisingly enough, you need to have cvs installed. The recommended |
Surprisingly enough, you need to have cvs installed. The recommended |
version of cvs is 1.11 or newer. Older cvs versions may work with |
version of cvs is 1.11 or newer. Older cvs versions may work with |
more or less quirks, YMMV. |
more or less quirks, YMMV. |
|
|
Currently, you'll also need to have the GNU RCS utilities 'rlog', |
Currently, you'll also need to have the RCS utilities rlog(1) and |
'rcsdiff' installed (current version is 5.7). |
rcsdiff(1) installed. |
|
|
This may change if cvs will be able to serve these functions without |
This may change if cvs will be able to serve these functions without |
having a working directory [see TODO]. |
having a working directory [see TODO]. |
Line 39 of this document. |
|
Line 39 of this document. |
|
repository (or a copy of it) therefore; rsh, ssh or pserver access |
repository (or a copy of it) therefore; rsh, ssh or pserver access |
doesn't work yet. |
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.3 or newer. |
|
|
|
Install CVSHistory if you want to use it with CVSweb, and see (8) for |
|
configuration notes. You'll need version 2.0 or newer. |
|
|
|
2) Copy cvsweb.conf to a configuration directory, typically |
2) Copy cvsweb.conf to a configuration directory, typically |
/usr/local/etc/cvsweb/cvsweb.conf. |
/usr/local/etc/cvsweb/cvsweb.conf. |
Edit cvsweb.conf to fit your needs, you'll probably need to tweak the |
Edit cvsweb.conf to fit your needs, you'll probably need to tweak the |
Line 78 of this document. |
|
Line 69 of this document. |
|
5) Copy cvsweb.css from the css/ directory to a web server directory, and |
5) Copy cvsweb.css from the css/ directory to a web server directory, and |
point the $cssurl variable in cvsweb.conf to it. |
point the $cssurl variable in cvsweb.conf to it. |
|
|
6) CvsGraph <http://www.akhphd.au.dk/~bertho/cvsgraph/> can be used with |
|
this version of CVSweb. See the $allow_cvsgraph and $cvsgraph_config |
|
configuration variables in cvsweb.conf. Note (and install) also the |
|
cvsgraph.png icon in the icons/ directory. |
|
|
|
7) GNU Enscript <http://www.iki.fi/~mtr/genscript/> can be used for syntax |
|
highlighting. To enable it, copy lang_cvsweb.st and lang_cvsweb_diff.st |
|
from the enscript/ dir to your Enscript "hl" directory (often eg. |
|
/usr/share/enscript/hl/) and enable $allow_enscript in cvsweb.conf. |
|
lang_cvsweb.st is used for generic colorization, and lang_cvsweb_diff.st |
|
for diffs. |
|
|
|
8) CVSHistory <http://www.jamwt.com/CVSHistory/> can be used with this |
|
version of CVSweb. See the $cvshistory_url configuration variable in |
|
cvsweb.conf. For best results, configure CVSweb and CVSHistory to use |
|
the same "logical names" for CVS roots. |
|
|
|
9) If you like you can add descriptions to be shown next to each directory |
9) If you like you can add descriptions to be shown next to each directory |
or module name. These are read from CVSROOT/descriptions. |
or module name. These are read from CVSROOT/descriptions. |
|
|
Line 150 o View the entries in the web server's error.log. Se |
|
Line 124 o View the entries in the web server's error.log. Se |
|
Upgrade instructions |
Upgrade instructions |
-------------------- |
-------------------- |
|
|
List of things to pay attention to when upgrading FreeBSD-CVSweb from |
List of things to pay attention to when upgrading CVSweb from |
earlier versions follows. Lack of instructions for a particular |
earlier versions follows. Lack of instructions for a particular |
version means that there are no special things to pay attention to. |
version means that there are no special things to pay attention to. |
|
|
Line 168 The following configuration variables in cvsweb.conf h |
|
Line 142 The following configuration variables in cvsweb.conf h |
|
|
|
$DEBUG is new, and optional. See comments in cvsweb.conf. |
$DEBUG is new, and optional. See comments in cvsweb.conf. |
|
|
Upgrading to 3.0.1 |
|
------------------ |
|
|
|
The following configuration variables in cvsweb.conf have changed: |
|
|
|
$cvshistory_url is new, and optional. See comments in cvsweb.conf. |
|
|
|
Upgrading to 3.0.0 |
Upgrading to 3.0.0 |
------------------ |
------------------ |
|
|
Line 188 The following configuration variables in cvsweb.conf h |
|
Line 155 The following configuration variables in cvsweb.conf h |
|
modules in CVS terminology, and the implementation was broken. |
modules in CVS terminology, and the implementation was broken. |
@ForbiddenFiles has been enhanced to affect directories as well. |
@ForbiddenFiles has been enhanced to affect directories as well. |
|
|
$cvstreedefault is now optional. If unset, the first one in |
|
@CVSrepositories is used. |
|
|
|
%DEFAULTVALUE for "f" (default diff format) now understands the values |
|
"uc", "cc" and "sc" for enscript-colored diffs (unified, context and |
|
side-by-side respectively). |
|
|
|
%DEFAULTVALUE for "ln" can now be set to a boolean indicating whether |
%DEFAULTVALUE for "ln" can now be set to a boolean indicating whether |
line numbers in markup views should be shown or not. The default is off. |
line numbers in markup views should be shown or not. The default is off. |
|
|
Line 209 The following configuration variables in cvsweb.conf h |
|
Line 169 The following configuration variables in cvsweb.conf h |
|
$open_extern_window, $extern_window_height, $extern_window_width, |
$open_extern_window, $extern_window_height, $extern_window_width, |
$checkout_magic. |
$checkout_magic. |
|
|
$allow_enscript, @enscript_options and %enscript_types control the use |
|
and behavior of enscript(1). |
|
|
|
$allow_cvsgraph and $cvsgraph_config control the use and behavior of |
|
cvsgraph(1). |
|
|
|
$file_list_len can be set to work around problems with rlog(1) and dirs |
$file_list_len can be set to work around problems with rlog(1) and dirs |
with lots of files. |
with lots of files. |
|
|
$cssurl contains the absolute URI to the CSS file to use. |
$cssurl contains the absolute URI to the CSS file to use. |
|
|
%ICONS has two new entries: binfile for binary files (-kb keyword |
%ICONS has a new entry: binfile for binary files (-kb keyword |
substitution) and graph for the cvsgraph icon. |
substitution). |
|
|
%DIFF_COMMANDS is new, it is used to configure external per file type |
%DIFF_COMMANDS is new, it is used to configure external per file type |
diff commands. |
diff commands. |