first try at documentation for this extension

git-svn-id: svn+ssh://llin/home/dpavlin/private/svn/BackupPC/trunk@94 8392b6e1-25fa-0310-8288-cc32f8e212ea

diff --git a/doc/Search.pm b/doc/Search.pm
new file mode 100644 (file)
index 0000000..63ea788
--- /dev/null
+++ b/doc/Search.pm
@@ -0,0 +1,134 @@
+=head1 BackupPC search and archival extension
+
+BackupPC search and archival extension is used to:
+
+=over 4
+
+=item *
+
+find files in C<pool> by substring of filename
+
+=item *
+
+see state of one or all of your shares in some particular point in time
+(file creation date on clients or backup date is supported as filter)
+
+=item *
+
+archive selected backups (per host, share and increment) to archival
+medium (CD, DVD, tape etc.)
+
+=back
+
+=head2 Requirements
+
+This extension is based on PostgreSQL RDBMS and HyperEstraier full-text
+search engine (and it's perl bindings).
+
+So, you will need to install additional packages which is described in
+following procedure.
+
+=over 4
+
+=item PostgreSQL installation
+
+You can use packages provided by your distribution or follow installation
+instructions on PostgreSQL site.
+
+=item QDBM installation
+
+First, you need qdbm on which HyperEstraier depends. Installation is simple.
+
+  $ tar xvfz qdbm-1.8.31.tar.gz 
+  $ cd qdbm-1.8.31
+  $ ./configure --enable-zlib
+  $ make
+  $ sudo make install
+
+=item HyperEstraier installation
+
+Also quite simple.
+
+  $ tar xvfz hyperestraier-0.5.4.tar.gz
+  $ cd hyperestraier-0.5.4
+  $ ./configure
+  $ make
+  $ sudo make install
+
+Then you will have to install perl bindings for HyperEstraier. This might take
+a bit more work. You will need to have C<swig> installed beforehand.
+
+  $ 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',
+       LIBS    => [sprintf('-lstdc++ %s %s' , `estconfig --libs`)],
+       OBJECT  => 'HyperEstraierWrapper.o HyperEstraier_wrap.o'
+ );
+
+After succesfull C<perl Makefile.pl>, you can compile and install it.
+
+  $ make
+  $ sudo make install
+
+=back
+
+=head1 Creation of initial data
+
+Once you have all components installed, you should initially create data
+about increments in RDBMS and full-text search engine index.
+
+  $ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb
+
+You can also force full-text reindex by C<-i> flag.
+
+B<Documentation is incomplete>.
+
+Now that you finished installation, you can select new options from
+menu on the left and example search and archival.
+
+=head1 Related projects
+
+BackupPC allready has archival host which might suit your needs better (and
+it's quite easier to install).
+
+=over 4
+
+=item PostgreSQL
+
+L<http://www.postgresql.org/>
+
+=item HyperEstraier
+
+L<http://hyperestraier.sourceforge.net/>
+
+=back
+
+=head1 Authors
+
+Ivan Klaric C<< <iklaric@gmail.com> >>
+
+Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>
+
+=head1 Licence
+
+This extension is released under GPL licence, same as BackupPC.
+