trunk/doc/Search.pm

=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.

1	=head1 BackupPC search and archival extension
2
3	BackupPC search and archival extension is used to:
4
5	=over 4
6
7	=item *
8
9	find files in C<pool> by substring of filename
10
11	=item *
12
13	see state of one or all of your shares in some particular point in time
14	(file creation date on clients or backup date is supported as filter)
15
16	=item *
17
18	archive selected backups (per host, share and increment) to archival
19	medium (CD, DVD, tape etc.)
20
21	=back
22
23	=head2 Requirements
24
25	This extension is based on PostgreSQL RDBMS and HyperEstraier full-text
26	search engine (and it's perl bindings).
27
28	So, you will need to install additional packages which is described in
29	following procedure.
30
31	=over 4
32
33	=item PostgreSQL installation
34
35	You can use packages provided by your distribution or follow installation
36	instructions on PostgreSQL site.
37
38	=item QDBM installation
39
40	First, you need qdbm on which HyperEstraier depends. Installation is simple.
41
42	$ tar xvfz qdbm-1.8.31.tar.gz
43	$ cd qdbm-1.8.31
44	$ ./configure --enable-zlib
45	$ make
46	$ sudo make install
47
48	=item HyperEstraier installation
49
50	Also quite simple.
51
52	$ tar xvfz hyperestraier-0.5.4.tar.gz
53	$ cd hyperestraier-0.5.4
54	$ ./configure
55	$ make
56	$ sudo make install
57
58	Then you will have to install perl bindings for HyperEstraier. This might take
59	a bit more work. You will need to have C<swig> installed beforehand.
60
61	$ tar xvfz hyper_estraier_wrappers-0.0.10.tar.gz
62	$ cd swig_hest/perl/
63	$ swig -c++ -perl5 -o HyperEstraier_wrap.cpp ../HyperEstraier.i
64	$ cp ../HyperEstraierWrapper.cpp ./
65	$ perl Makefile.PL
66
67	You might need to remove C<estconfig --mtlibs> from C<Makefile.PL> if it
68	fails to run with following message:
69
70	Unrecognized argument in LIBS ignored: 'configuration'
71	Unrecognized argument in LIBS ignored: 'helper'
72	Unrecognized argument in LIBS ignored: 'for'
73	Unrecognized argument in LIBS ignored: 'Hyper'
74	Unrecognized argument in LIBS ignored: 'Estraier'
75	Writing Makefile for HyperEstraier
76
77	Working C<Makefile.PL> for my particular installation is:
78
79	# File : Makefile.PL
80	use ExtUtils::MakeMaker;
81	WriteMakefile(
82	NAME => 'HyperEstraier',
83	LIBS => [sprintf('-lstdc++ %s %s' , `estconfig --libs`)],
84	OBJECT => 'HyperEstraierWrapper.o HyperEstraier_wrap.o'
85	);
86
87	After succesfull C<perl Makefile.pl>, you can compile and install it.
88
89	$ make
90	$ sudo make install
91
92	=back
93
94	=head1 Creation of initial data
95
96	Once you have all components installed, you should initially create data
97	about increments in RDBMS and full-text search engine index.
98
99	$ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb
100
101	You can also force full-text reindex by C<-i> flag.
102
103	B<Documentation is incomplete>.
104
105	Now that you finished installation, you can select new options from
106	menu on the left and example search and archival.
107
108	=head1 Related projects
109
110	BackupPC allready has archival host which might suit your needs better (and
111	it's quite easier to install).
112
113	=over 4
114
115	=item PostgreSQL
116
117	L<http://www.postgresql.org/>
118
119	=item HyperEstraier
120
121	L<http://hyperestraier.sourceforge.net/>
122
123	=back
124
125	=head1 Authors
126
127	Ivan Klaric C<< <iklaric@gmail.com> >>
128
129	Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>
130
131	=head1 Licence
132
133	This extension is released under GPL licence, same as BackupPC.
134