|
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
|
|
|
| 6 |
* Screenshots
|
|
|
| 7 |
* Credits
|
|
|
| 8 |
* Downloads
|
|
|
| 9 |
* Installation
|
|
|
| 10 |
* User manual
|
|
|
| 11 |
|
|
|
| 12 |
Installing Recoll
|
|
|
| 13 |
|
|
|
| 14 |
Building from source
|
|
|
| 15 |
|
|
|
| 16 |
Prerequisites
|
|
|
| 17 |
|
|
|
| 18 |
At the very least, you will need to download and install the xapian core
|
|
|
| 19 |
package (I am currently using xapian version 0.8.5), and the qt runtime
|
|
|
| 20 |
and development packages (I am currently using qt 3.3.3).
|
|
|
| 21 |
|
|
|
| 22 |
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.
|
|
|
| 24 |
|
|
|
| 25 |
You also need libiconv. I am currently using version 1.9. The iconv
|
|
|
| 26 |
interface is part of libc on Linux systems, you shouldn't need to do
|
|
|
| 27 |
anything there.
|
|
|
| 28 |
|
|
|
| 29 |
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
|
|
|
| 31 |
indexed:
|
|
|
| 32 |
|
|
|
| 33 |
* MS Word documents: antiword.
|
|
|
| 34 |
* PDF files: pdftotext is part of the Xpdf package.
|
|
|
| 35 |
* Postscript files: pstotext.
|
|
|
| 36 |
|
|
|
| 37 |
Building
|
|
|
| 38 |
|
|
|
| 39 |
Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and
|
|
|
| 40 |
Solaris 8. If you build on another system, I would very much welcome
|
|
|
| 41 |
comments and patches.
|
|
|
| 42 |
|
|
|
| 43 |
Normal procedure:
|
|
|
| 44 |
|
|
|
| 45 |
* cd recoll-xxx
|
|
|
| 46 |
* configure
|
|
|
| 47 |
* make
|
|
|
| 48 |
* (practise your usual hardship-repelling invocations).
|
|
|
| 49 |
|
|
|
| 50 |
There is no real autoconfiguration. The configure script will just link
|
|
|
| 51 |
one of the system-specific files in the mk directory to mk/sysconf. If
|
|
|
| 52 |
your system is known yet, it will tell you as much, and you may want to
|
|
|
| 53 |
manually copy and modify one of the existing files (the new file name
|
|
|
| 54 |
should be the output of uname -s).
|
|
|
| 55 |
|
|
|
| 56 |
You may also need to adjust the recoll.pro file inside the qtgui directory
|
|
|
| 57 |
to fix the "-L/usr/local/lib -lxapian -liconv" piece, depending on where
|
|
|
| 58 |
your libs are installed. Then run 'qmake recoll.pro' in there.
|
|
|
| 59 |
|
|
|
| 60 |
Using binary packages
|
|
|
| 61 |
|
|
|
| 62 |
The binary versions are just compressed tar files of a build tree, where
|
|
|
| 63 |
only the useful parts were kept (executables and sample configuration).
|
|
|
| 64 |
|
|
|
| 65 |
The executable binary files are built with a static link to libxapian and
|
|
|
| 66 |
libiconv, to make installation easier (no dependencies). However, this
|
|
|
| 67 |
also means that you can't change the versions of xapian and iconv which
|
|
|
| 68 |
are used.
|
|
|
| 69 |
|
|
|
| 70 |
After extracting the tar file, you can proceed with installation as if you
|
|
|
| 71 |
had built the package from source.
|
|
|
| 72 |
|
|
|
| 73 |
Installation
|
|
|
| 74 |
|
|
|
| 75 |
Execute installrecoll targetdir, in the root of the source tree. This
|
|
|
| 76 |
will:
|
|
|
| 77 |
|
|
|
| 78 |
* Only if you have write access on targetdir/bin, copy qtgui/recoll and
|
|
|
| 79 |
index/recollindex to targetdir/bin (but you could also execute them
|
|
|
| 80 |
from their build directories).
|
|
|
| 81 |
* Only if you are not root check if ~/.recoll exists, and if it does
|
|
|
| 82 |
not:
|
|
|
| 83 |
* Copy all files from sampleconf/* to ~/.recoll
|
|
|
| 84 |
* Copy all files from filters/* to ~/.recoll.
|
|
|
| 85 |
|
|
|
| 86 |
Typically, you would execute the script once as root to install the
|
|
|
| 87 |
programs to /usr/local, and once as yourself to create the configuration.
|
|
|
| 88 |
|
|
|
| 89 |
Configuration
|
|
|
| 90 |
|
|
|
| 91 |
Recoll uses text configuration files. You will have to edit them by hand
|
|
|
| 92 |
for now (all hope is not lost that there will be dialogs to build them
|
|
|
| 93 |
from the GUI in the future).
|
|
|
| 94 |
|
|
|
| 95 |
The main configuration file is named ~/.recoll/recoll.conf.
|
|
|
| 96 |
|
|
|
| 97 |
There is a commented sample in the sampleconf subdirectory, it was copied
|
|
|
| 98 |
to ~/.recoll at the previous step, take a look and possibly edit it. By
|
|
|
| 99 |
default, it will index your home directory.
|
|
|
| 100 |
|
|
|
| 101 |
Then start recollindex, and wait for indexing to complete (this may take
|
|
|
| 102 |
some time). When it's done, you can start recoll and try a search.
|
|
|
| 103 |
|
|
|
| 104 |
Depending on what is installed on your system, you may also want to adjust
|
|
|
| 105 |
the external viewers defined in ~/.recoll/mimeconf (ie: html is either
|
|
|
| 106 |
previewed internally or displayed using firefox, but you may prefer
|
|
|
| 107 |
mozilla...). Look for the [view] section.
|
|
|