|
a/src/INSTALL |
|
b/src/INSTALL |
| 1 |
Installation instructions:
|
1 |
* Home
|
| 2 |
=========================
|
2 |
* Screenshots
|
|
|
3 |
* Downloads
|
|
|
4 |
* Credits
|
|
|
5 |
* User manual
|
|
|
6 |
* Installation
|
|
|
7 |
[IMG]
|
| 3 |
|
8 |
|
| 4 |
Recoll is a very young package, and installation will probably more painful
|
9 |
Installing Recoll
|
| 5 |
than necessary, please excuse me for this until I have time to work on
|
|
|
| 6 |
it. I should probably not release this at all, except that I would like
|
|
|
| 7 |
feedback.
|
|
|
| 8 |
|
10 |
|
| 9 |
If you have problems, please don't renounce, ask me instead
|
11 |
There are currently no binary packages, so you will need to build Recoll
|
| 10 |
(jean-francois.dockes@wanadoo.fr)
|
12 |
from source before installing it.
|
| 11 |
|
13 |
|
| 12 |
Building from source
|
14 |
Prerequisites
|
| 13 |
===================
|
|
|
| 14 |
|
15 |
|
| 15 |
Prerequisites:
|
16 |
At the very least, you will need to download and install the xapian core
|
| 16 |
|
17 |
package (I am currently using xapian version 0.8.5), and the qt runtime
|
| 17 |
To build from source, you need the following packages. Except if you're
|
18 |
and development packages (I am currently using qt 3.3.3).
|
| 18 |
using a really strange system, you can probably easily find, or already
|
|
|
| 19 |
have, a precompiled version of iconv, and maybe qt.
|
|
|
| 20 |
|
19 |
|
| 21 |
- qt and qt-devel (www.trolltech.com). Currently using 3.3.3
|
20 |
You will most probably be able to find a binary package for qt for your
|
| 22 |
- xapian-core (www.xapian.org). Currently using 0.8.5
|
21 |
system. You may have to compile Xapian, but this is not difficult.
|
| 23 |
- libiconv (http://www.gnu.org/software/libiconv/). Currently using
|
|
|
| 24 |
1.9. On Linux it's part of the libc, you should have nothing special
|
|
|
| 25 |
to install.
|
|
|
| 26 |
|
22 |
|
| 27 |
Building:
|
23 |
You also need libiconv. I am currently using version 1.9. The iconv
|
| 28 |
|
24 |
interface is part of libc on Linux systems, you shouldn't need to do
|
|
|
25 |
anything there.
|
| 29 |
|
26 |
|
| 30 |
I have only built on Linux (redhat7.3, mandriva 2005), FreeBSD and Solaris8
|
27 |
External file types: recoll uses external applications to index some file
|
| 31 |
for now, if you build on another system, I would very much welcome
|
28 |
types. You need to install them for the file types that you wish to have
|
| 32 |
comments and patches (jean-francois.dockes@wanadoo.fr).
|
29 |
indexed:
|
| 33 |
|
|
|
| 34 |
There is no autoconf for now. You need to chose a file in the mk directory,
|
|
|
| 35 |
and link it into a file named 'sysconf' there. If your system is not
|
|
|
| 36 |
supported by the supplied files, it should be easy enough to build a new
|
|
|
| 37 |
one from the examples (then send it to me please).
|
|
|
| 38 |
|
30 |
|
| 39 |
You also need to adjust the recoll.pro file inside the qtgui directory to
|
31 |
* MS Word documents: antiword.
|
| 40 |
fix the "-L/usr/local/lib -lxapian -liconv" piece, depending on where your
|
32 |
* PDF files: pdftotext is part of the Xpdf package.
|
| 41 |
libs are installed. Then run 'qmake recoll.pro' in there.
|
33 |
* Postscript files: pstotext.
|
| 42 |
|
34 |
|
| 43 |
Then cd to the top directory, type make, and practise your usual
|
35 |
Building
|
| 44 |
hardship-repelling invocations.
|
|
|
| 45 |
|
36 |
|
| 46 |
Installation:
|
37 |
Recoll has been built on Linux (redhat7.3, mandriva 2005), FreeBSD and
|
| 47 |
|
38 |
Solaris 8. If you build on another system, I would very much welcome
|
| 48 |
- Copy all files from sampleconf/* to ~/.recoll
|
39 |
comments and patches.
|
| 49 |
- Copy all files from filters/* to ~/.recoll.
|
|
|
| 50 |
- Copy qtgui/recoll to a place in your PATH (if you want. You can also
|
|
|
| 51 |
execute it from its build directory).
|
|
|
| 52 |
|
40 |
|
| 53 |
Configuration
|
41 |
Normal procedure:
|
| 54 |
=============
|
|
|
| 55 |
|
42 |
|
| 56 |
Recoll uses a text configuration file. There will be dialogs to build it
|
43 |
* cd recoll-xxx
|
| 57 |
from the GUI in the future, but you'll have to edit it by hand for now.
|
44 |
* configure
|
|
|
45 |
* make
|
|
|
46 |
* (practise your usual hardship-repelling invocations).
|
| 58 |
|
47 |
|
| 59 |
By default, the configuration file should be named ~/.recoll/recoll.conf
|
48 |
There is no real autoconfiguration. The configure script will just link
|
|
|
49 |
one of the system-specific files in the mk directory to mk/sysconf. If
|
|
|
50 |
your system is known yet, it will tell you as much, and you may want to
|
|
|
51 |
manually copy and modify one of the existing files (the new file name
|
|
|
52 |
should be the output of uname -s).
|
| 60 |
|
53 |
|
| 61 |
There is a sample in the 'sampleconf' src/ subdirectory, you copied it to
|
54 |
You may also need to adjust the recoll.pro file inside the qtgui directory
|
| 62 |
~/.recoll at the step before, take a look and possibly edit it.
|
55 |
to fix the "-L/usr/local/lib -lxapian -liconv" piece, depending on where
|
|
|
56 |
your libs are installed. Then run 'qmake recoll.pro' in there.
|
| 63 |
|
57 |
|
| 64 |
Then start 'recoll', and select the "file->start indexing" menu
|
58 |
Installation
|
| 65 |
entry. When it's done, you can play with the search
|
|
|
| 66 |
|
59 |
|
| 67 |
Usage
|
60 |
Execute installrecoll targetdir, in the root of the source tree. This
|
| 68 |
=====
|
61 |
will:
|
| 69 |
The very simple Gui should be easy enough to use. Clicking on a search
|
|
|
| 70 |
result entry in the left column will display it in the left
|
|
|
| 71 |
part. Double-clicking will start an external viewer (look at the
|
|
|
| 72 |
~/.recoll/mimeconf file to see how these are configured).
|
|
|
| 73 |
|
62 |
|
|
|
63 |
* Copy qtgui/recoll and index/recollindex to targetdir/bin (but you
|
|
|
64 |
could also execute them from their build directories).
|
|
|
65 |
* Check if ~/.recoll exists, and if it does not:
|
|
|
66 |
* Copy all files from sampleconf/* to ~/.recoll
|
|
|
67 |
* Copy all files from filters/* to ~/.recoll.
|
| 74 |
|
68 |
|
|
|
69 |
Configuration
|
| 75 |
|
70 |
|
| 76 |
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
71 |
Recoll uses text configuration files. You will have to edit them by hand
|
| 77 |
Future from here on, there are currently no binary packages ...
|
72 |
for now (all hope is not lost that there will be dialogs to build them
|
| 78 |
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
|
73 |
from the GUI in the future).
|
| 79 |
Installing a binary package:
|
|
|
| 80 |
|
|
|
| 81 |
|
74 |
|
| 82 |
There are no rpm or other managed packages for now.
|
75 |
The main configuration file is named ~/.recoll/recoll.conf.
|
| 83 |
|
76 |
|
| 84 |
- Unpack the tar file. Will create a recoll-x.y directory
|
77 |
There is a commented sample in the sampleconf subdirectory, it was copied
|
| 85 |
- Arrange to have the recoll-x.y/bin directory in your PATH, or copy/link the
|
78 |
to ~/.recoll at the previous step, take a look and possibly edit it. By
|
| 86 |
'recoll' executable where it will be found.
|
79 |
default, it will index your home directory.
|
| 87 |
|
80 |
|
| 88 |
- Copy the files from the sampleconf directory somewhere. The default
|
81 |
Then start recollindex, and wait for indexing to complete (this may take
|
| 89 |
location is $HOME/.recoll/ If you choose another location, you will have
|
82 |
some time). When it's done, you can start recoll and try a search
|
| 90 |
to set the RECOLL_CONFDIR environment variable.
|
|
|
| 91 |
|
83 |
|
| 92 |
- Possibly adjust the recoll.conf file. The default should be fine for
|
84 |
Depending on what is installed on your system, you may also want to adjust
|
| 93 |
trying in most cases.
|
85 |
the external viewers defined in ~/.recoll/mimeconf (ie: html is either
|
| 94 |
- Possibly adjust the mimeconf file, especially the external viewer
|
86 |
previewed internally or displayed using firefox, but you may prefer
|
| 95 |
section, depending on what you are using (ie acrobat vs xpdf, etc...)
|
87 |
mozilla...). Look for the [view] section.
|
| 96 |
|
88 |
|
| 97 |
- Start the 'recoll' program. After displaying a dialog, it will normally
|
89 |
jean-francois.dockes@wanadoo.fr
|
| 98 |
begin to index the directories specified in recoll.conf.
|
|
|
| 99 |
|
|
|
| 100 |
|
|
|
| 101 |
|
|
|