documentation improvements

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

diff --git a/doc/Search.pm b/doc/Search.pm
index d9392e7..697c7d5 100644 (file)
--- a/doc/Search.pm
+++ b/doc/Search.pm
@@ -16,7 +16,8 @@ see state of one or all of your shares in some particular point in time
 =item *
 
 archive selected backups (per host, share and increment) to archival
-medium (CD, DVD, tape etc.)
+medium (CD, DVD, tape etc.) with rich descriptions, archival locations,
+multiple copies and so on.
 
 =back
 
@@ -31,19 +32,17 @@ 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 HyperEstraier perl bindings below.
+Now you can skip to installation of L<HyperEstraier perl bindings> below.
 
 If you don't have pre-packaged binaries for your installation, you will
 need to install additional packages by hand.
 
-=over 4
-
-=item PostgreSQL installation
+=head3 PostgreSQL
 
 You can use packages provided by your distribution or follow installation
 instructions on PostgreSQL site.
 
-=item QDBM installation
+=head3 QDBM
 
 First, you need qdbm on which HyperEstraier depends. Installation is simple.
 
@@ -53,7 +52,7 @@ First, you need qdbm on which HyperEstraier depends. Installation is simple.
   $ make
   $ sudo make install
 
-=item HyperEstraier installation
+=head3 HyperEstraier
 
 Also quite simple.
 
@@ -63,8 +62,12 @@ Also quite simple.
   $ 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.
+Then you will have to install perl bindings for HyperEstraier.
+
+=head3 HyperEstraier 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.
 
   $ tar xvfz hyper_estraier_wrappers-0.0.10.tar.gz 
   $ cd swig_hest/perl/
@@ -98,18 +101,51 @@ After succesfull C<perl Makefile.pl>, you can compile and install it.
   $ make
   $ sudo make install
 
+=head3 CPAN modules
+
+You will also need a few additional cpan modules
+
+=over 4
+
+=item File::Pid
+
 =back
 
-=head1 Creation of initial data
+Easiest way to install them is using C<cpan> shell.
+
+  $ sudo cpan File::Pid
+
+=head1 Creation of initial database
 
 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
+First, edit C<config.pl> and setup C<SearchDSN> to valid perl DSN (for example,
+C<dbi:Pg:dbname=backuppc> and C<SearchUser> to database user which has priviledges
+over that database. You might need to add additional directives in PostgreSQL's
+C<pg_hba.conf> so that selected user can be connected without password (I know, it's not
+perfect, but I trust local users on backuppc machine).
+
+Then, create new database for backuppc.
+
+  $ createdb backuppc
+
+Then invoke C<BackupPC_updatedb> for the first time with argument to create database
+schema:
+
+  $ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb -c
+
+You can also force full-text reindex by C<-i> flag. This will add all files which are in
+database but for some reason are missing in full-text index.
+
+Now, you can setup cron job which will daily check your backups and update database
+and full-text index. This is as simple as invoking
+
+  /data/backuppc/bin/BackupPC_updatedb
 
-You can also force full-text reindex by C<-i> flag.
+As C<backuppc> user and redirecting output to log file.
 
-B<Documentation is incomplete>.
+B<Documentation is still incomplete>.
 
 Now that you finished installation, you can select new options from
 menu on the left and example search and archival.