--- trunk/doc/Search.pm	2005/08/31 20:33:45	105
+++ trunk/doc/Search.pod	2006/01/28 16:45:46	303
@@ -23,7 +23,7 @@
 
 =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 @@
   # 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 @@
 
 =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 @@
   $ make
   $ sudo make install
 
-=head3 HyperEstraier
+=head3 Hyper Estraier
 
 Also quite simple.
 
@@ -62,44 +62,15 @@
   $ 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
-
-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'
- );
+  $ sudo cpan Search::Estraier
 
-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
 
@@ -108,12 +79,26 @@
 =over 4
 
 =item File::Pid
+=item File::Which
+=item File::Path
+=item File::Slurp
+=item Search::Estraier
+
+=item Spreadsheet::WriteExcel
+
+=item Term::Menus
+=item XML::Writer
+=item Algorithm::Diff
+=item Archive::Tar::Stream
 
 =back
 
+Last module, C<Spreadsheet::WriteExcel> is needed only if you want to use
+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
+  $ sudo cpan File::Pid Spreadsheet::WriteExcel ...
 
 =head1 Creation of initial database
 
@@ -150,6 +135,55 @@
 Now that you finished installation, you can select new options from
 menu on the left and example search and archival.
 
+=head1 Reporting in Excel
+
+Often, it is useful to be able to present report about your BackupPC hosts, number
+of snapshots, total size and other useful info. While all those information can
+be accessed using web browser, for analysis it's useful to have them in spreadsheet
+form. With this data, you can monitor changes on your backup cycle, effects of changes
+on your server or network to your BackupPC installation and so on.
+
+You can create Excel spreadsheet (which works perfectly with Gnumeric also) using
+following command:
+
+  $ sudo -u backuppc /data/backuppc/bin/BackupPC_xls_report
+
+=head1 Additional requirements
+
+You will also need several other command-line utilities to make
+C<BackupPC_burnArchiveCLI> run. Those include:
+
+=over 4
+
+=item mkisofs
+
+=item cdrecord
+
+Or equivavalent utility, on Debian you might want to use C<dvdrecord>.
+
+=item eject
+
+Please make a symlink from C</dev/cdrom> to you CD/DVD burner.
+
+=item split
+
+=back
+
+=head1 Troubleshoting
+
+=head2 md5sum problems on Debian
+
+If you are running Debian stable and expiriencing error message like
+
+ -: No such file or directory
+
+your C<md5sum> comes from C<coreutils> (which doesn't know how to handle C<->
+as input) as opposed to C<md5sum> which comes with C<textutils> (which does).
+
+Fix is simple, correct md5sum is allready installed, you just have to do:
+
+ sudo cp /usr/bin/md5sum.textutils /usr/bin/md5sum
+
 =head1 Related projects
 
 BackupPC allready has archival host which might suit your needs better (and