trunk/doc/INSTALL.pod

=head1 Mail::Box Web Search installation

This document describes how to install Mail::Box Web Search. Since it's a
project written in perl, it depends on some (hm?) CPAN modules.

=head1 Installation using source code (the perl way to do it)

CPAN modules needed:

C<Mail::Box>,
C<Carp>,
C<Config::IniFiles>,
C<Date::Parse>,
C<POSIX>,
C<Getopt::Long>,
C<HTTP::Daemon>,
C<HTTP::Status>,
C<IO::String>,
C<MIME::Base64>,
C<CGI::Lite>,
C<Template>,
C<Template::Plugin::Calendar::Simple>
C<Text::Autoformat>,
C<Text::Context::EitherSide>,
C<Text::Iconv>,
C<Text::Unaccent>,
C<URI::Escape>

Depending on type of index that you want to use, you will also need
C<SWISH::API> or C<Plucene::Simple>.

If you want speedup using C<Mail::Box>, try installing C<Mail::Box::Parser::C>
module. However, this module is memory pig, and it often just hangs on my
Maildir folders. YMMV.

=head1 Installation using PAR archive

B<This currently does not work, and it's included here just for completeness.>

=head2 Debian

It should work out-of-par. It's development platform, but you should need
perl 5.8.

=head2 RedHat/Fedora

This is tested on slightly out-of-date Fedora, but instructions should apply
to newer versions (with possible changes in paths due to different versions).

If starting mbox2index produces following error:

 # ./mbox2index
 ./mbox2index: error while loading shared libraries: libperl.so.5.8: cannot open shared object file: No such file or directory

You will have to create following symlink:

 # ln -s /usr/lib/perl5/5.8.1/i386-linux-thread-multi/CORE/libperl.so /usr/lib/libperl.so.5.8

and re-run ldconfig:

 # /sbin/ldconfig

This still wouldn't make MWS work. However, I suspect that it's PAR problem
which will be solved in near future. If that happens, you will be able to
download PAR packaged files.

1	=head1 Mail::Box Web Search installation
2
3	This document describes how to install Mail::Box Web Search. Since it's a
4	project written in perl, it depends on some (hm?) CPAN modules.
5
6	=head1 Installation using source code (the perl way to do it)
7
8	CPAN modules needed:
9
10	C<Mail::Box>,
11	C<Carp>,
12	C<Config::IniFiles>,
13	C<Date::Parse>,
14	C<POSIX>,
15	C<Getopt::Long>,
16	C<HTTP::Daemon>,
17	C<HTTP::Status>,
18	C<IO::String>,
19	C<MIME::Base64>,
20	C<CGI::Lite>,
21	C<Template>,
22	C<Template::Plugin::Calendar::Simple>
23	C<Text::Autoformat>,
24	C<Text::Context::EitherSide>,
25	C<Text::Iconv>,
26	C<Text::Unaccent>,
27	C<URI::Escape>
28
29	Depending on type of index that you want to use, you will also need
30	C<SWISH::API> or C<Plucene::Simple>.
31
32	If you want speedup using C<Mail::Box>, try installing C<Mail::Box::Parser::C>
33	module. However, this module is memory pig, and it often just hangs on my
34	Maildir folders. YMMV.
35
36	=head1 Installation using PAR archive
37
38	B<This currently does not work, and it's included here just for completeness.>
39
40	=head2 Debian
41
42	It should work out-of-par. It's development platform, but you should need
43	perl 5.8.
44
45	=head2 RedHat/Fedora
46
47	This is tested on slightly out-of-date Fedora, but instructions should apply
48	to newer versions (with possible changes in paths due to different versions).
49
50	If starting mbox2index produces following error:
51
52	# ./mbox2index
53	./mbox2index: error while loading shared libraries: libperl.so.5.8: cannot open shared object file: No such file or directory
54
55	You will have to create following symlink:
56
57	# ln -s /usr/lib/perl5/5.8.1/i386-linux-thread-multi/CORE/libperl.so /usr/lib/libperl.so.5.8
58
59	and re-run ldconfig:
60
61	# /sbin/ldconfig
62
63	This still wouldn't make MWS work. However, I suspect that it's PAR problem
64	which will be solved in near future. If that happens, you will be able to
65	download PAR packaged files.
66