|
a/src/INSTALL |
|
b/src/INSTALL |
| 1 |
|
1 |
|
| 2 |
A more complete version of this document can be found at http://www.recoll.org
|
2 |
A more complete version of this document can be found at http://www.recoll.org
|
| 3 |
|
3 |
|
| 4 |
|
4 |
|
| 5 |
* Home
|
5 |
Link: HOME
|
| 6 |
* Screenshots
|
6 |
Link: PREVIOUS
|
| 7 |
* Credits
|
7 |
Link: NEXT
|
| 8 |
* Downloads
|
|
|
| 9 |
* Installation
|
|
|
| 10 |
* User manual
|
|
|
| 11 |
|
8 |
|
| 12 |
Installing Recoll
|
9 |
Recoll user manual
|
|
|
10 |
Prev Next
|
| 13 |
|
11 |
|
| 14 |
Building from source
|
12 |
--------------------------------------------------------------------------
|
| 15 |
|
13 |
|
|
|
14 |
Chapter 4. Installation
|
|
|
15 |
|
|
|
16 |
Table of Contents
|
|
|
17 |
|
|
|
18 |
4.1. Building from source
|
|
|
19 |
|
|
|
20 |
4.2. Installing a prebuilt copy
|
|
|
21 |
|
|
|
22 |
4.3. Configuration overview
|
|
|
23 |
|
|
|
24 |
4.1. Building from source
|
|
|
25 |
|
| 16 |
Prerequisites
|
26 |
4.1.1. Prerequisites
|
| 17 |
|
27 |
|
| 18 |
At the very least, you will need to download and install the xapian core
|
28 |
At the very least, you will need to download and install the xapian core
|
| 19 |
package (I am currently using xapian version 0.9.2), and the qt runtime
|
29 |
package (Recoll currently uses version 0.9.2), and the qt runtime and
|
| 20 |
and development packages (I am currently using qt 3.3.3).
|
30 |
development packages (Recoll currently uses version 3.3.3).
|
| 21 |
|
31 |
|
| 22 |
You will most probably be able to find a binary package for qt for your
|
32 |
You will most probably be able to find a binary package for qt for your
|
| 23 |
system. You may have to compile Xapian, but this is not difficult.
|
33 |
system. You may have to compile Xapian, but this is not difficult (if you
|
|
|
34 |
are using FreeBSD, there is a port).
|
| 24 |
|
35 |
|
| 25 |
You also need libiconv. I am currently using version 1.9. The iconv
|
36 |
You may also need libiconv. Recoll currently uses version 1.9 (this should
|
| 26 |
interface is part of libc on Linux systems, you shouldn't need to do
|
37 |
not be critical). On Linux systems, the iconv interface is part of libc
|
| 27 |
anything there.
|
38 |
and you should not need to do anything special.
|
| 28 |
|
39 |
|
| 29 |
External file types: recoll uses external applications to index some file
|
40 |
External file types. Recoll uses external applications to index some file
|
| 30 |
types. You need to install them for the file types that you wish to have
|
41 |
types. You need to install them for the file types that you wish to have
|
| 31 |
indexed:
|
42 |
indexed:
|
| 32 |
|
43 |
|
| 33 |
* MS Word documents: antiword.
|
44 |
* MS Word: antiword.
|
| 34 |
* PDF files: pdftotext is part of the Xpdf package.
|
|
|
| 35 |
* Postscript files: pstotext.
|
|
|
| 36 |
* RTF files: the filter uses unrtf
|
|
|
| 37 |
|
45 |
|
| 38 |
Building
|
46 |
* PDF: pdftotext is part of the Xpdf package.
|
|
|
47 |
|
|
|
48 |
* Postscript: pstotext.
|
|
|
49 |
|
|
|
50 |
* RTF: unrtf
|
|
|
51 |
|
|
|
52 |
4.1.2. Building
|
| 39 |
|
53 |
|
| 40 |
Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and
|
54 |
Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and
|
| 41 |
Solaris 8. If you build on another system, I would very much welcome
|
55 |
Solaris 8. If you build on another system, I would very much welcome
|
| 42 |
patches.
|
56 |
patches.
|
| 43 |
|
57 |
|
| 44 |
Normal procedure:
|
58 |
Normal procedure:
|
| 45 |
|
59 |
|
| 46 |
* cd recoll-xxx
|
60 |
cd recoll-xxx
|
| 47 |
* configure
|
61 |
configure
|
| 48 |
* make
|
62 |
make
|
| 49 |
* (practise your usual hardship-repelling invocations).
|
63 |
(practises usual hardship-repelling invocations)
|
|
|
64 |
|
| 50 |
|
65 |
|
| 51 |
There little autoconfiguration. The configure script will mainly link one
|
66 |
There little autoconfiguration. The configure script will mainly link one
|
| 52 |
of the system-specific files in the mk directory to mk/sysconf. If your
|
67 |
of the system-specific files in the mk directory to mk/sysconf. If your
|
| 53 |
system is not known yet, it will tell you as much, and you may want to
|
68 |
system is not known yet, it will tell you as much, and you may want to
|
| 54 |
manually copy and modify one of the existing files (the new file name
|
69 |
manually copy and modify one of the existing files (the new file name
|
| 55 |
should be the output of uname -s).
|
70 |
should be the output of uname -s).
|
| 56 |
|
71 |
|
| 57 |
Using binary packages
|
|
|
| 58 |
|
|
|
| 59 |
The binary versions are just compressed tar files of a build tree, where
|
|
|
| 60 |
only the useful parts were kept (executables and sample configuration).
|
|
|
| 61 |
|
|
|
| 62 |
The executable binary files are built with a static link to libxapian and
|
|
|
| 63 |
libiconv, to make installation easier (no dependencies). However, this
|
|
|
| 64 |
also means that you can't change the versions of xapian and iconv which
|
|
|
| 65 |
are used.
|
|
|
| 66 |
|
|
|
| 67 |
After extracting the tar file, you can proceed with installation as if you
|
|
|
| 68 |
had built the package from source.
|
|
|
| 69 |
|
|
|
| 70 |
Installation
|
72 |
4.1.3. Installation
|
| 71 |
|
|
|
| 72 |
Commands and common files
|
|
|
| 73 |
|
73 |
|
| 74 |
Either type make install or execute recollinstall targetdir, in the root
|
74 |
Either type make install or execute recollinstall targetdir, in the root
|
| 75 |
of the source tree. This will copy the commands to $targetdir/bin and the
|
75 |
of the source tree. This will copy the commands to $targetdir/bin and the
|
| 76 |
sample configuration files, scripts and other shared data to
|
76 |
sample configuration files, scripts and other shared data to
|
| 77 |
$targetdir/share/recoll
|
77 |
$targetdir/share/recoll.
|
| 78 |
|
78 |
|
| 79 |
Personal configuration
|
79 |
--------------------------------------------------------------------------
|
| 80 |
|
80 |
|
| 81 |
The personal configuration files and the database are kept in the .recoll
|
81 |
Prev Home Next
|
| 82 |
directory in your home. If this directory does not exist when recoll or
|
82 |
Search tips, shortcuts Installing a prebuilt copy
|
| 83 |
recollindex are started, the directory will be created and the sample
|
|
|
| 84 |
configuration files will be copied. recoll will give you a chance to edit
|
|
|
| 85 |
the configuration file before starting indexation. recollindex will
|
|
|
| 86 |
proceed immediately.
|
|
|
| 87 |
|
|
|
| 88 |
Configuration
|
|
|
| 89 |
|
|
|
| 90 |
Recoll uses text configuration files. You will have to edit them by hand
|
|
|
| 91 |
for now (there is still some hope for a GUI configuration tool in the
|
|
|
| 92 |
future).
|
|
|
| 93 |
|
|
|
| 94 |
The main configuration file is named ~/.recoll/recoll.conf.
|
|
|
| 95 |
|
|
|
| 96 |
The default configuration will index your home directory. If this is not
|
|
|
| 97 |
appropriate, use recoll to copy the sample configuration, click Cancel,
|
|
|
| 98 |
and edit the configuration file before restarting the command. This will
|
|
|
| 99 |
start the initial indexation, which may take some time.
|
|
|
| 100 |
|
|
|
| 101 |
You are then ready to try a query, see the user manual for more detail.
|
|
|
| 102 |
|
|
|
| 103 |
Depending on what is installed on your system, you may also want to adjust
|
|
|
| 104 |
the external viewers defined in ~/.recoll/mimeconf (ie: html is either
|
|
|
| 105 |
previewed internally or displayed using firefox, but you may prefer
|
|
|
| 106 |
mozilla...). Look for the [view] section.
|
|
|