r10297@llin: dpavlin | 2006-03-01 14:40:39 +0100
[BackupPC.git] / doc / Search.pod
index 5c38f4d..2e72e40 100644 (file)
@@ -23,7 +23,7 @@ multiple copies and so on.
 
 =head2 Requirements
 
-This extension is based on PostgreSQL RDBMS and HyperEstraier full-text
+This extension is based on PostgreSQL RDBMS and Hyper Estraier full-text
 search engine (and it's perl bindings).
 
 If you are using Debian, you are in luck. All required packages are
@@ -32,7 +32,7 @@ allready part of C<unstable> distribution and can be installed with:
   # apt-get install postgresql
   # apt-get install hyperestraier libestraier-dev libqdbm-dev
 
-Now you can skip to installation of L<HyperEstraier perl bindings> below.
+Now you can skip to installation of L<Hyper Estraier perl bindings> below.
 
 If you don't have pre-packaged binaries for your installation, you will
 need to install additional packages by hand.
@@ -44,7 +44,7 @@ instructions on PostgreSQL site.
 
 =head3 QDBM
 
-First, you need qdbm on which HyperEstraier depends. Installation is simple.
+First, you need qdbm on which Hyper Estraier depends. Installation is simple.
 
   $ tar xvfz qdbm-1.8.31.tar.gz 
   $ cd qdbm-1.8.31
@@ -52,7 +52,7 @@ First, you need qdbm on which HyperEstraier depends. Installation is simple.
   $ make
   $ sudo make install
 
-=head3 HyperEstraier
+=head3 Hyper Estraier
 
 Also quite simple.
 
@@ -62,44 +62,15 @@ Also quite simple.
   $ make
   $ sudo make install
 
-Then you will have to install perl bindings for HyperEstraier.
+Then you will have to install perl bindings for Hyper Estraier.
 
-=head3 HyperEstraier perl bindings
+=head3 Hyper Estraier perl bindings
 
-This might take a bit more work. You will need to have C<swig> and C<g++> installed
-before you can install perl bindings.
+Just use C<cpan> shell to install C<Search::Estraier> module
 
-  $ tar xvfz hyper_estraier_wrappers-0.0.10.tar.gz 
-  $ cd swig_hest/perl/
-  $ swig -c++ -perl5 -o HyperEstraier_wrap.cpp  ../HyperEstraier.i
-  $ cp ../HyperEstraierWrapper.cpp ./
-  $ perl Makefile.PL
+  $ sudo cpan Search::Estraier
 
-You might need to remove C<estconfig --mtlibs> from C<Makefile.PL> if it
-fails to run with following message:
-
- Unrecognized argument in LIBS ignored: 'configuration'
- Unrecognized argument in LIBS ignored: 'helper'
- Unrecognized argument in LIBS ignored: 'for'
- Unrecognized argument in LIBS ignored: 'Hyper'
- Unrecognized argument in LIBS ignored: 'Estraier'
- Writing Makefile for HyperEstraier
-
-Working C<Makefile.PL> for my particular installation is:
-
- # File : Makefile.PL
- use ExtUtils::MakeMaker;
- WriteMakefile(
-       NAME    => 'HyperEstraier',
-       INC     => sprintf('%s', `pkg-config --cflags hyperestraier`),
-       LIBS    => [sprintf('-lstdc++ %s %s' , `pkg-config --libs hyperestraier`)],
-       OBJECT  => 'HyperEstraierWrapper.o HyperEstraier_wrap.o'
- );
-
-After succesfull C<perl Makefile.pl>, you can compile and install it.
-
-  $ make
-  $ sudo make install
+There was awaful long procedure about installing perl C bindings, but it's all gone now.
 
 =head3 CPAN modules
 
@@ -111,6 +82,7 @@ You will also need a few additional cpan modules
 =item File::Which
 =item File::Path
 =item File::Slurp
+=item Search::Estraier
 
 =item Spreadsheet::WriteExcel
 
@@ -118,6 +90,7 @@ You will also need a few additional cpan modules
 =item XML::Writer
 =item Algorithm::Diff
 =item Archive::Tar::Stream
+=item Filesys::Df
 
 =back
 
@@ -126,7 +99,7 @@ C<BackupPC_xls_report> to generate Excel reports from your backup data.
 
 Easiest way to install them is using C<cpan> shell.
 
-  $ sudo cpan File::Pid Spreadsheet::WriteExcel
+  $ sudo cpan File::Pid Spreadsheet::WriteExcel ...
 
 =head1 Creation of initial database