Update of /cvsroot/lxr/lxr
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv9548
Modified Files:
INSTALL
Log Message:
update, mostly for swish-e and cgi
Index: INSTALL
===================================================================
RCS file: /cvsroot/lxr/lxr/INSTALL,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -d -r1.11 -r1.12
--- INSTALL 12 Jul 2004 13:15:22 -0000 1.11
+++ INSTALL 15 Jul 2004 14:12:39 -0000 1.12
@@ -10,11 +10,11 @@
You will also need the right Perl DBI drivers for your particular database,
usually available from CPAN.
-3) Apache with mod_perl - http://www.apache.org
+3) A webserver - Apache httpd (http://httpd.apache.org/) with mod_perl
+ (http://perl.apache.org/) is recommended
4) For freetext searching, either Glimpse (http://glimpse.cs.arizona.edu) or
- Swish-e (http://swish-e.org). You need the development version of
- swish-e (i.e. 2.1.x or later).
+ Swish-e (http://swish-e.org) version 2.1 or later.
Swish-e is fully GPL'ed, while Glimpse is only free for
non-commercial use.
@@ -24,7 +24,7 @@
6) The Perl MMagic module, available from CPAN
-7) If using the CVS support, you will need cvs and rcs installed as well.
+7) If using the CVS support, you will need rcs installed as well.
Installing the database
-----------------------
@@ -82,12 +82,23 @@
If you have glimpse installed, you should set
'glimpsebin' => '/path/to/your/glimpse/executable'
+
+If you have swish-e installed, you should set
-Now remember you copied the perl modules for Glimpse to a directory
+ 'swishindex' => '/path/to/your/swishe-e/executable'
+ 'swishsearch' => '/path/to/your/swishe-e/executable'
+
+Comment out the variables for the indexer you are not using.
+Set 'htmlsearch' to either 'html-search-swish.html' or
+'html-search-glimpse.html' depending on which indexer
+you are using.
+
+Now remember you copied the perl modules to a directory
in your perl module search path ? The example path I used was
/usr/lib/perl5/site_perl which is also needed in lxr.conf
'genericconf' => '/usr/lib/perl5/site_perl/LXR/Lang/generic.conf'
+ 'ectagsconf' => '/usr/lib/perl5/site_perl/Lang/ectags.conf',
Next set your base URL and virtual root for LXR by setting
@@ -136,22 +147,10 @@
Using Swish-e with LXR
----------------------
-This is simple:
-
-1) Put the paths to swish-e and swish-search in the 'swishindex' and
- 'swishsearch' variables in lxr.conf. If there is no swish-search
- executable on your system, use the path to swish-e as the
- 'swishsearch' value.
-
-2) Create a directory for the swish index files to go in, and put the
- path of this directory in the 'swishdir' variable.
-
-3) Comment out the 'glimpsebin' variable
-
-Now re-run genxref and it should build the swish indexes for you and
-you're done.
+Create a directory for the swish index files to go in, and put the
+path of this directory in the 'swishdir' variable.
-Getting Glimpse to work with LXR
+Using Glimpse with LXR
--------------------------------
Create a directory in your LXR directory called glimpse
@@ -195,9 +194,8 @@
configurations. Which config block to use is selected according to the
url argument.
-If you are setting up LXR to use files in a CVS repository, genxref
-will most likely run without printing out any error messages. This is
-*not* what you want. You have to explicitly state a version to use.
+If you are setting up LXR to use files in a CVS repository, you
+probably want to use the 'head' version (default).
genxref --url=/path/to/lxr --version=head
@@ -211,10 +209,8 @@
Set up webserver
----------------
-The browsing scripts currently supplied depend on mod_perl to execute
-properly, although it should be easy to modify them to work as plain
-CGI scripts. Since mod_perl is an Apache add-on, this means using
-Apache at the moment.
+The browsing scripts supplied can run with Apache mod_perl or as cgi
+scripts.
You may need to edit httpd.conf to point to the lxr files, for example
if you have installed the lxr files in /usr/local/lxr and you want to
|
