=head1 NAME

Wais - access to freeWAIS-sf libraries


=head1 DESCRIPTION

This document briefly describes the installation process.
 

=head1 REQUIREMENTS

Thw Wais.pm extension version 2.315 and above requires Perl 5.6.0. If
you have an earlier Perl version either upgrade ;-) or read the
I<Notes on Perl 5.005> below.


=head2 waisindex, waisserver

To perform the regression tests, the module will need C<waisindex> to
create a test database and B<waisserver> to test I<remote>
connections. These binaries will be searched by means of the PATH
environment variable. So be sure that the correct versions of these
programs are covered by an early entry in your PATH variable; for bash
users the following will do:

     $ PATH=$fwsfprefix/bin:$PATH 

If you do not have a working C<waisserver>, you need to edit
Makefile.PL in order to disable checking for the binaries. Furthermore
failure report within the regresseion tests will approximately look
like this:

  t/a_preop.t          3    1  33.33%  3        <-  server start failed
  t/basic.t            4    2  50.00%  3-4      <-  'remote' searches
  t/parallel.t         6    4  66.67%  3-6      <-  'remote' searches
  t/z_postop.t         2    1  50.00%  1        <-  server stop


=head2 wais.h and libwais.a

To compile these modules Makefile.PL needs to find C<wais.h> in it's
include path and libwais.a in its library path. If they are found by
include and library paths known to Perl by its configuration (i. e.
F</usr/{lib,include}/...> you're done. In addition Makefile.PL
dynamically tries to detect them in the filesystem. The location of
include and library files is inferred from the location of the
waisindex and waisserver binaries: If the latter ones have been found
in F</foo/bar/bin> path in F</foo/bar/lib> is checked for the
existence of include and library files. Recent versions of freeWAIS-sf
install them accordingly (see
ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/freeWAIS-sf/ or the
distributions and
ftp://ls6-ftp.cs.uni-dortmund.de/pub/src/freeWAIS-sf/README for
additional installation instructions).


=head1 BUILDING THE WAIS EXTENSION

Make sure that you met the requirements above.
Building and installation is done as follows:

        perl Makefile.PL
        make
        make test
        make install
        make clean

If something goes wrong during C<make test>, try

    make test TEST_VERBOSE=1


=head1 NOTES ON PERL 5.005

At least Wais.pm 2.315 and later versions require Perl version 5.6.0
or higher. If you want to use Wais.pm with Perl 5.005 please apply the
patch in F<5.005/patch1> included in the distribution:

        patch -p0 < 5.005/patch1

If in addition you didn't embed perl into your freeWAIS-sf
installation apply the patch in F<5.005/patch2> also:

        patch -p0 < 5.005/patch2

