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

If you are using Debian, you are in luck. All required packages are
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.

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

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',
        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

=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	If you are using Debian, you are in luck. All required packages are
29	allready part of C<unstable> distribution and can be installed with:
30
31	# apt-get install postgresql
32	# apt-get install hyperestraier libestraier-dev libqdbm-dev
33
34	Now you can skip to installation of HyperEstraier perl bindings below.
35
36	If you don't have pre-packaged binaries for your installation, you will
37	need to install additional packages by hand.
38
39	=over 4
40
41	=item PostgreSQL installation
42
43	You can use packages provided by your distribution or follow installation
44	instructions on PostgreSQL site.
45
46	=item QDBM installation
47
48	First, you need qdbm on which HyperEstraier depends. Installation is simple.
49
50	$ tar xvfz qdbm-1.8.31.tar.gz
51	$ cd qdbm-1.8.31
52	$ ./configure --enable-zlib
53	$ make
54	$ sudo make install
55
56	=item HyperEstraier installation
57
58	Also quite simple.
59
60	$ tar xvfz hyperestraier-0.5.4.tar.gz
61	$ cd hyperestraier-0.5.4
62	$ ./configure
63	$ make
64	$ sudo make install
65
66	Then you will have to install perl bindings for HyperEstraier. This might take
67	a bit more work. You will need to have C<swig> installed beforehand.
68
69	$ tar xvfz hyper_estraier_wrappers-0.0.10.tar.gz
70	$ cd swig_hest/perl/
71	$ swig -c++ -perl5 -o HyperEstraier_wrap.cpp ../HyperEstraier.i
72	$ cp ../HyperEstraierWrapper.cpp ./
73	$ perl Makefile.PL
74
75	You might need to remove C<estconfig --mtlibs> from C<Makefile.PL> if it
76	fails to run with following message:
77
78	Unrecognized argument in LIBS ignored: 'configuration'
79	Unrecognized argument in LIBS ignored: 'helper'
80	Unrecognized argument in LIBS ignored: 'for'
81	Unrecognized argument in LIBS ignored: 'Hyper'
82	Unrecognized argument in LIBS ignored: 'Estraier'
83	Writing Makefile for HyperEstraier
84
85	Working C<Makefile.PL> for my particular installation is:
86
87	# File : Makefile.PL
88	use ExtUtils::MakeMaker;
89	WriteMakefile(
90	NAME => 'HyperEstraier',
91	INC => sprintf('%s', `pkg-config --cflags hyperestraier`),
92	LIBS => [sprintf('-lstdc++ %s %s' , `pkg-config --libs hyperestraier`)],
93	OBJECT => 'HyperEstraierWrapper.o HyperEstraier_wrap.o'
94	);
95
96	After succesfull C<perl Makefile.pl>, you can compile and install it.
97
98	$ make
99	$ sudo make install
100
101	=back
102
103	=head1 Creation of initial data
104
105	Once you have all components installed, you should initially create data
106	about increments in RDBMS and full-text search engine index.
107
108	$ sudo -u backuppc /data/backuppc/bin/BackupPC_updatedb
109
110	You can also force full-text reindex by C<-i> flag.
111
112	B<Documentation is incomplete>.
113
114	Now that you finished installation, you can select new options from
115	menu on the left and example search and archival.
116
117	=head1 Related projects
118
119	BackupPC allready has archival host which might suit your needs better (and
120	it's quite easier to install).
121
122	=over 4
123
124	=item PostgreSQL
125
126	L<http://www.postgresql.org/>
127
128	=item HyperEstraier
129
130	L<http://hyperestraier.sourceforge.net/>
131
132	=back
133
134	=head1 Authors
135
136	Ivan Klaric C<< <iklaric@gmail.com> >>
137
138	Dobrica Pavlinusic C<< <dpavlin@rot13.org> >>
139
140	=head1 Licence
141
142	This extension is released under GPL licence, same as BackupPC.
143