/[BackupPC]/trunk/doc/Search.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Annotation of /trunk/doc/Search.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 94 - (hide annotations)
Sun Aug 28 18:29:44 2005 UTC (18 years, 9 months ago) by dpavlin
File size: 3205 byte(s)
first try at documentation for this extension

1 dpavlin 94 =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    

  ViewVC Help
Powered by ViewVC 1.1.26