|
a/src/INSTALL |
|
b/src/INSTALL |
|
... |
|
... |
| 9 |
Recoll user manual
|
9 |
Recoll user manual
|
| 10 |
Prev Next
|
10 |
Prev Next
|
| 11 |
|
11 |
|
| 12 |
--------------------------------------------------------------------------
|
12 |
--------------------------------------------------------------------------
|
| 13 |
|
13 |
|
| 14 |
Chapter 5. Installation
|
14 |
Chapter 7. Installation
|
| 15 |
|
15 |
|
| 16 |
Table of Contents
|
16 |
Table of Contents
|
| 17 |
|
17 |
|
| 18 |
5.1. Installing a prebuilt copy
|
18 |
7.1. Installing a prebuilt copy
|
| 19 |
|
19 |
|
| 20 |
5.2. Supporting packages
|
20 |
7.2. Supporting packages
|
| 21 |
|
21 |
|
| 22 |
5.3. Building from source
|
22 |
7.3. Building from source
|
| 23 |
|
23 |
|
| 24 |
5.4. Configuration overview
|
24 |
7.4. Configuration overview
|
| 25 |
|
25 |
|
| 26 |
5.5. The KDE Kicker Recoll applet
|
26 |
7.5. The KDE Kicker Recoll applet
|
| 27 |
|
27 |
|
| 28 |
5.1. Installing a prebuilt copy
|
28 |
7.1. Installing a prebuilt copy
|
| 29 |
|
29 |
|
| 30 |
Recoll binary packages from the Recoll web site are always linked
|
30 |
Recoll binary packages from the Recoll web site are always linked
|
| 31 |
statically to the Xapian libraries, and have no other dependencies. You
|
31 |
statically to the Xapian libraries, and have no other dependencies. You
|
| 32 |
will only have to check or install supporting applications for the file
|
32 |
will only have to check or install supporting applications for the file
|
| 33 |
types that you want to index beyond text, HTML and mail files, and maybe
|
33 |
types that you want to index beyond text, HTML and mail files, and maybe
|
| 34 |
have a look at the configuration section (but this may not be necessary
|
34 |
have a look at the configuration section (but this may not be necessary
|
| 35 |
for a quick test with default parameters).
|
35 |
for a quick test with default parameters).
|
| 36 |
|
36 |
|
| 37 |
5.1.1. Installing through a package system
|
37 |
7.1.1. Installing through a package system
|
| 38 |
|
38 |
|
| 39 |
If you use a BSD-type port system or a prebuilt package (RPM or other),
|
39 |
If you use a BSD-type port system or a prebuilt package (RPM or other),
|
| 40 |
just follow the usual procedure for your system.
|
40 |
just follow the usual procedure for your system.
|
| 41 |
|
41 |
|
| 42 |
5.1.2. Installing a prebuilt Recoll
|
42 |
7.1.2. Installing a prebuilt Recoll
|
| 43 |
|
43 |
|
| 44 |
The unpackaged binary versions on the Recoll web site are just compressed
|
44 |
The unpackaged binary versions on the Recoll web site are just compressed
|
| 45 |
tar files of a build tree, where only the useful parts were kept
|
45 |
tar files of a build tree, where only the useful parts were kept
|
| 46 |
(executables and sample configuration).
|
46 |
(executables and sample configuration).
|
| 47 |
|
47 |
|
|
... |
|
... |
| 60 |
Link: UP
|
60 |
Link: UP
|
| 61 |
Link: PREVIOUS
|
61 |
Link: PREVIOUS
|
| 62 |
Link: NEXT
|
62 |
Link: NEXT
|
| 63 |
|
63 |
|
| 64 |
Recoll user manual
|
64 |
Recoll user manual
|
| 65 |
Prev Chapter 5. Installation Next
|
65 |
Prev Chapter 7. Installation Next
|
| 66 |
|
66 |
|
| 67 |
--------------------------------------------------------------------------
|
67 |
--------------------------------------------------------------------------
|
| 68 |
|
68 |
|
| 69 |
5.2. Supporting packages
|
69 |
7.2. Supporting packages
|
| 70 |
|
70 |
|
| 71 |
Recoll uses external applications to index some file types. You need to
|
71 |
Recoll uses external applications to index some file types. You need to
|
| 72 |
install them for the file types that you wish to have indexed (these are
|
72 |
install them for the file types that you wish to have indexed (these are
|
| 73 |
run-time dependencies. None is needed for building Recoll).
|
73 |
run-time dependencies. None is needed for building Recoll).
|
| 74 |
|
74 |
|
|
... |
|
... |
| 120 |
Link: UP
|
120 |
Link: UP
|
| 121 |
Link: PREVIOUS
|
121 |
Link: PREVIOUS
|
| 122 |
Link: NEXT
|
122 |
Link: NEXT
|
| 123 |
|
123 |
|
| 124 |
Recoll user manual
|
124 |
Recoll user manual
|
| 125 |
Prev Chapter 5. Installation Next
|
125 |
Prev Chapter 7. Installation Next
|
| 126 |
|
126 |
|
| 127 |
--------------------------------------------------------------------------
|
127 |
--------------------------------------------------------------------------
|
| 128 |
|
128 |
|
| 129 |
5.3. Building from source
|
129 |
7.3. Building from source
|
| 130 |
|
130 |
|
| 131 |
5.3.1. Prerequisites
|
131 |
7.3.1. Prerequisites
|
| 132 |
|
132 |
|
| 133 |
At the very least, you will need to download and install the xapian core
|
133 |
At the very least, you will need to download and install the xapian core
|
| 134 |
package (Recoll 1.9 normally uses version 1.0.2, but any 0.9 or 1.0.x
|
134 |
package (Recoll 1.9 normally uses version 1.0.2, but any 0.9 or 1.0.x
|
| 135 |
version will work too), and the qt run-time and development packages
|
135 |
version will work too), and the qt run-time and development packages
|
| 136 |
(Recoll development currently uses version 3.3.5, but any 3.3 version is
|
136 |
(Recoll development currently uses version 3.3.5, but any 3.3 version is
|
|
... |
|
... |
| 142 |
|
142 |
|
| 143 |
You may also need libiconv. Recoll currently uses version 1.9 (this should
|
143 |
You may also need libiconv. Recoll currently uses version 1.9 (this should
|
| 144 |
not be critical). On Linux systems, the iconv interface is part of libc
|
144 |
not be critical). On Linux systems, the iconv interface is part of libc
|
| 145 |
and you should not need to do anything special.
|
145 |
and you should not need to do anything special.
|
| 146 |
|
146 |
|
| 147 |
5.3.2. Building
|
147 |
7.3.2. Building
|
| 148 |
|
148 |
|
| 149 |
Recoll has been built on Linux (redhat7.3, mandriva 2005/6, Fedora Core
|
149 |
Recoll has been built on Linux (redhat7.3, mandriva 2005/6, Fedora Core
|
| 150 |
3/4/5/6), FreeBSD 5/6, macosx, and Solaris 8. If you build on another
|
150 |
3/4/5/6), FreeBSD 5/6, macosx, and Solaris 8. If you build on another
|
| 151 |
system, and need to modify things, I would very much welcome patches.
|
151 |
system, and need to modify things, I would very much welcome patches.
|
| 152 |
|
152 |
|
|
... |
|
... |
| 180 |
of the system-specific files in the mk directory to mk/sysconf. If your
|
180 |
of the system-specific files in the mk directory to mk/sysconf. If your
|
| 181 |
system is not known yet, it will tell you as much, and you may want to
|
181 |
system is not known yet, it will tell you as much, and you may want to
|
| 182 |
manually copy and modify one of the existing files (the new file name
|
182 |
manually copy and modify one of the existing files (the new file name
|
| 183 |
should be the output of uname -s).
|
183 |
should be the output of uname -s).
|
| 184 |
|
184 |
|
| 185 |
5.3.3. Installation
|
185 |
7.3.3. Installation
|
| 186 |
|
186 |
|
| 187 |
Either type make install or execute recollinstall prefix, in the root of
|
187 |
Either type make install or execute recollinstall prefix, in the root of
|
| 188 |
the source tree. This will copy the commands to prefix/bin and the sample
|
188 |
the source tree. This will copy the commands to prefix/bin and the sample
|
| 189 |
configuration files, scripts and other shared data to prefix/share/recoll.
|
189 |
configuration files, scripts and other shared data to prefix/share/recoll.
|
| 190 |
|
190 |
|
|
... |
|
... |
| 203 |
Link: UP
|
203 |
Link: UP
|
| 204 |
Link: PREVIOUS
|
204 |
Link: PREVIOUS
|
| 205 |
Link: NEXT
|
205 |
Link: NEXT
|
| 206 |
|
206 |
|
| 207 |
Recoll user manual
|
207 |
Recoll user manual
|
| 208 |
Prev Chapter 5. Installation Next
|
208 |
Prev Chapter 7. Installation Next
|
| 209 |
|
209 |
|
| 210 |
--------------------------------------------------------------------------
|
210 |
--------------------------------------------------------------------------
|
| 211 |
|
211 |
|
| 212 |
5.4. Configuration overview
|
212 |
7.4. Configuration overview
|
| 213 |
|
213 |
|
| 214 |
Most of the parameters specific to the recoll GUI are set through the
|
214 |
Most of the parameters specific to the recoll GUI are set through the
|
| 215 |
Preferences menu and stored in the standard QT place ($HOME/.qt/recollrc).
|
215 |
Preferences menu and stored in the standard QT place ($HOME/.qt/recollrc).
|
| 216 |
You probably do not want to edit this by hand.
|
216 |
You probably do not want to edit this by hand.
|
| 217 |
|
217 |
|
| 218 |
For other options, Recoll uses text configuration files. You will have to
|
218 |
Recoll indexing options are set inside text configuration files located in
|
| 219 |
edit them by hand for now (there is still some hope for a GUI
|
219 |
a configuration directory. There can be several such directories, each of
|
| 220 |
configuration tool in the future). The most accurate documentation for the
|
220 |
which define the parameters for one index.
|
| 221 |
configuration parameters is given by comments inside the default files,
|
|
|
| 222 |
and we will just give a general overview here.
|
|
|
| 223 |
|
221 |
|
| 224 |
There are two sets of configuration files. The system-wide files are kept
|
222 |
The configuration files can be edited by hand or through the Indexing
|
| 225 |
in a directory named like /usr/[local/]share/recoll/examples, they define
|
223 |
configuration dialog (Preferences menu). The GUI tool will try to respect
|
| 226 |
default values for the system. A parallel set of files exists by default
|
224 |
your formatting and comments as much as possible, so it is quite possible
|
| 227 |
in the .recoll directory in your home. This directory can be changed with
|
225 |
to use both ways.
|
|
|
226 |
|
|
|
227 |
The most accurate documentation for the configuration parameters is given
|
|
|
228 |
by comments inside the default files, and we will just give a general
|
|
|
229 |
overview here.
|
|
|
230 |
|
|
|
231 |
For each index, there are two sets of configuration files. System-wide
|
|
|
232 |
configuration files are kept in a directory named like
|
|
|
233 |
/usr/[local/]share/recoll/examples, and define default values, shared by
|
|
|
234 |
all indexes. For each index, a parallel set of files defines the
|
|
|
235 |
customized parameters.
|
|
|
236 |
|
|
|
237 |
The default location of the configuration is the .recoll directory in your
|
|
|
238 |
home. Most people will only use this directory.
|
|
|
239 |
|
|
|
240 |
This location can be changed, or others can be added with the
|
| 228 |
the RECOLL_CONFDIR environment variable or the -c option parameter to
|
241 |
RECOLL_CONFDIR environment variable or the -c option parameter to recoll
|
| 229 |
recoll and recollindex.
|
242 |
and recollindex.
|
| 230 |
|
243 |
|
| 231 |
If the .recoll directory does not exist when recoll or recollindex are
|
244 |
If the .recoll directory does not exist when recoll or recollindex are
|
| 232 |
started, it will be created with a set of empty configuration files.
|
245 |
started, it will be created with a set of empty configuration files.
|
| 233 |
recoll will give you a chance to edit the configuration file before
|
246 |
recoll will give you a chance to edit the configuration file before
|
| 234 |
starting indexing. recollindex will proceed immediately. To avoid
|
247 |
starting indexing. recollindex will proceed immediately. To avoid
|
|
... |
|
... |
| 265 |
expanded to the name of the user's home directory, as a shell would do.
|
278 |
expanded to the name of the user's home directory, as a shell would do.
|
| 266 |
|
279 |
|
| 267 |
White space is used for separation inside lists. List elements with
|
280 |
White space is used for separation inside lists. List elements with
|
| 268 |
embedded spaces can be quoted using double-quotes.
|
281 |
embedded spaces can be quoted using double-quotes.
|
| 269 |
|
282 |
|
| 270 |
5.4.1. Main configuration file
|
283 |
7.4.1. Main configuration file
|
| 271 |
|
284 |
|
| 272 |
recoll.conf is the main configuration file. It defines things like what to
|
285 |
recoll.conf is the main configuration file. It defines things like what to
|
| 273 |
index (top directories and things to ignore), and the default character
|
286 |
index (top directories and things to ignore), and the default character
|
| 274 |
set to use for document types which do not specify it internally.
|
287 |
set to use for document types which do not specify it internally.
|
| 275 |
|
288 |
|
|
... |
|
... |
| 421 |
|
434 |
|
| 422 |
Recoll normally indexes any file which it knows how to read. This
|
435 |
Recoll normally indexes any file which it knows how to read. This
|
| 423 |
list lets you restrict the indexed mime types to what you specify.
|
436 |
list lets you restrict the indexed mime types to what you specify.
|
| 424 |
If the variable is unspecified or the list empty (the default),
|
437 |
If the variable is unspecified or the list empty (the default),
|
| 425 |
all supported types are processed.
|
438 |
all supported types are processed.
|
|
|
439 |
|
|
|
440 |
compressedfilemaxkbs
|
|
|
441 |
|
|
|
442 |
Size limit for compressed (.gz or .bz2) files. These need to be
|
|
|
443 |
decompressed in a temporary directory for identification, which
|
|
|
444 |
can be very wasteful if 'uninteresting' big compressed files are
|
|
|
445 |
present. Negative means no limit, 0 means no processing of any
|
|
|
446 |
compressed file. Defaults to -1.
|
| 426 |
|
447 |
|
| 427 |
indexallfilenames
|
448 |
indexallfilenames
|
| 428 |
|
449 |
|
| 429 |
Recoll indexes file names in a special section of the database to
|
450 |
Recoll indexes file names in a special section of the database to
|
| 430 |
allow specific file names searches using wild cards. This
|
451 |
allow specific file names searches using wild cards. This
|
|
... |
|
... |
| 473 |
This lets you adjust the size of n-grams used for indexing CJK
|
494 |
This lets you adjust the size of n-grams used for indexing CJK
|
| 474 |
text. The default value of 2 is probably appropriate in most
|
495 |
text. The default value of 2 is probably appropriate in most
|
| 475 |
cases. A value of 3 would allow more precision and efficiency on
|
496 |
cases. A value of 3 would allow more precision and efficiency on
|
| 476 |
longer words, but the index will be approximately twice as large.
|
497 |
longer words, but the index will be approximately twice as large.
|
| 477 |
|
498 |
|
| 478 |
5.4.2. The mimemap file
|
499 |
7.4.2. The mimemap file
|
| 479 |
|
500 |
|
| 480 |
mimemap specifies the file name extension to mime type mappings.
|
501 |
mimemap specifies the file name extension to mime type mappings.
|
| 481 |
|
502 |
|
| 482 |
For file names without an extension, or with an unknown one, the system's
|
503 |
For file names without an extension, or with an unknown one, the system's
|
| 483 |
file -i command will be executed to determine the mime type (this can be
|
504 |
file -i command will be executed to determine the mime type (this can be
|
|
... |
|
... |
| 497 |
indexed (not even the file names are indexed for patterns in skippedNames.
|
518 |
indexed (not even the file names are indexed for patterns in skippedNames.
|
| 498 |
recoll_noindex is used mostly for things known to be unindexable by a
|
519 |
recoll_noindex is used mostly for things known to be unindexable by a
|
| 499 |
given Recoll version. Having it there avoids cluttering the more
|
520 |
given Recoll version. Having it there avoids cluttering the more
|
| 500 |
user-oriented and locally customized skippedNames.
|
521 |
user-oriented and locally customized skippedNames.
|
| 501 |
|
522 |
|
| 502 |
5.4.3. The mimeconf file
|
523 |
7.4.3. The mimeconf file
|
| 503 |
|
524 |
|
| 504 |
mimeconf specifies how the different mime types are handled for indexing,
|
525 |
mimeconf specifies how the different mime types are handled for indexing,
|
| 505 |
and which icons are displayed in the recoll result lists.
|
526 |
and which icons are displayed in the recoll result lists.
|
| 506 |
|
527 |
|
| 507 |
Changing the parameters in the [index] section is probably not a good idea
|
528 |
Changing the parameters in the [index] section is probably not a good idea
|
|
... |
|
... |
| 509 |
|
530 |
|
| 510 |
The [icons] section allows you to change the icons which are displayed by
|
531 |
The [icons] section allows you to change the icons which are displayed by
|
| 511 |
recoll in the result lists (the values are the basenames of the png images
|
532 |
recoll in the result lists (the values are the basenames of the png images
|
| 512 |
inside the iconsdir directory (specified in recoll.conf).
|
533 |
inside the iconsdir directory (specified in recoll.conf).
|
| 513 |
|
534 |
|
| 514 |
5.4.4. The mimeview file
|
535 |
7.4.4. The mimeview file
|
| 515 |
|
536 |
|
| 516 |
mimeview specifies which programs are started when you click on an Edit
|
537 |
mimeview specifies which programs are started when you click on an Edit
|
| 517 |
link in a result list. Ie: HTML is normally displayed using firefox, but
|
538 |
link in a result list. Ie: HTML is normally displayed using firefox, but
|
| 518 |
you may prefer Konqueror, your openoffice.org program might be named
|
539 |
you may prefer Konqueror, your openoffice.org program might be named
|
| 519 |
oofice instead of openoffice etc.
|
540 |
oofice instead of openoffice etc.
|
|
... |
|
... |
| 530 |
|
551 |
|
| 531 |
If Use desktop preferences to choose document editor is checked in the
|
552 |
If Use desktop preferences to choose document editor is checked in the
|
| 532 |
user preferences, all mimeview entries will be ignored except the one
|
553 |
user preferences, all mimeview entries will be ignored except the one
|
| 533 |
labelled application/x-all (which is set to use xdg-open by default).
|
554 |
labelled application/x-all (which is set to use xdg-open by default).
|
| 534 |
|
555 |
|
| 535 |
5.4.5. Examples of configuration adjustments
|
556 |
7.4.5. Examples of configuration adjustments
|
| 536 |
|
557 |
|
| 537 |
5.4.5.1. Adding an external viewer for an non-indexed type
|
558 |
7.4.5.1. Adding an external viewer for an non-indexed type
|
| 538 |
|
559 |
|
| 539 |
Imagine that you have some kind of file which does not have indexable
|
560 |
Imagine that you have some kind of file which does not have indexable
|
| 540 |
content, but for which you would like to have a functional Edit link in
|
561 |
content, but for which you would like to have a functional Edit link in
|
| 541 |
the result list (when found by file name). The file names end in .blob and
|
562 |
the result list (when found by file name). The file names end in .blob and
|
| 542 |
can be displayed by application blobviewer.
|
563 |
can be displayed by application blobviewer.
|
|
... |
|
... |
| 563 |
If you just wanted to change the application used by Recoll to display a
|
584 |
If you just wanted to change the application used by Recoll to display a
|
| 564 |
mime type which it already knows, you would just need to edit mimeview.
|
585 |
mime type which it already knows, you would just need to edit mimeview.
|
| 565 |
The entries you add in your personal file override those in the central
|
586 |
The entries you add in your personal file override those in the central
|
| 566 |
configuration, which you do not need to alter
|
587 |
configuration, which you do not need to alter
|
| 567 |
|
588 |
|
| 568 |
5.4.5.2. Adding indexing support for a new file type
|
589 |
7.4.5.2. Adding indexing support for a new file type
|
| 569 |
|
590 |
|
| 570 |
Let us now imagine that the above .blob files actually contain indexable
|
591 |
Let us now imagine that the above .blob files actually contain indexable
|
| 571 |
text and that you know how to extract it with a command line program.
|
592 |
text and that you know how to extract it with a command line program.
|
| 572 |
Getting Recoll to index the files is easy. You need to perform the above
|
593 |
Getting Recoll to index the files is easy. You need to perform the above
|
| 573 |
alteration, and also to add data to the mimeconf file (typically in
|
594 |
alteration, and also to add data to the mimeconf file (typically in
|