|
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 4. Installation
|
14 |
Chapter 5. Installation
|
| 15 |
|
15 |
|
| 16 |
Table of Contents
|
16 |
Table of Contents
|
| 17 |
|
17 |
|
| 18 |
4.1. Installing a prebuilt copy
|
18 |
5.1. Installing a prebuilt copy
|
| 19 |
|
19 |
|
| 20 |
4.2. Supporting packages
|
20 |
5.2. Supporting packages
|
| 21 |
|
21 |
|
| 22 |
4.3. Building from source
|
22 |
5.3. Building from source
|
| 23 |
|
23 |
|
| 24 |
4.4. Configuration overview
|
24 |
5.4. Configuration overview
|
| 25 |
|
25 |
|
| 26 |
4.5. The KDE Kicker Recoll applet
|
26 |
5.5. The KDE Kicker Recoll applet
|
| 27 |
|
27 |
|
| 28 |
4.6. Extending Recoll
|
|
|
| 29 |
|
|
|
| 30 |
4.1. Installing a prebuilt copy
|
28 |
5.1. Installing a prebuilt copy
|
| 31 |
|
29 |
|
| 32 |
Recoll binary packages from the Recoll web site are always linked
|
30 |
Recoll binary packages from the Recoll web site are always linked
|
| 33 |
statically to the Xapian libraries, and have no other dependencies. You
|
31 |
statically to the Xapian libraries, and have no other dependencies. You
|
| 34 |
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
|
| 35 |
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
|
| 36 |
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
|
| 37 |
for a quick test with default parameters).
|
35 |
for a quick test with default parameters).
|
| 38 |
|
36 |
|
| 39 |
4.1.1. Installing through a package system
|
37 |
5.1.1. Installing through a package system
|
| 40 |
|
38 |
|
| 41 |
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),
|
| 42 |
just follow the usual procedure for your system.
|
40 |
just follow the usual procedure for your system.
|
| 43 |
|
41 |
|
| 44 |
4.1.2. Installing a prebuilt Recoll
|
42 |
5.1.2. Installing a prebuilt Recoll
|
| 45 |
|
43 |
|
| 46 |
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
|
| 47 |
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
|
| 48 |
(executables and sample configuration).
|
46 |
(executables and sample configuration).
|
| 49 |
|
47 |
|
|
... |
|
... |
| 54 |
had built the package from source (that is, just type make install). The
|
52 |
had built the package from source (that is, just type make install). The
|
| 55 |
binary trees are built for installation to /usr/local.
|
53 |
binary trees are built for installation to /usr/local.
|
| 56 |
|
54 |
|
| 57 |
--------------------------------------------------------------------------
|
55 |
--------------------------------------------------------------------------
|
| 58 |
|
56 |
|
| 59 |
Prev Home Next
|
57 |
Prev Home Next
|
| 60 |
Customizing the search interface Supporting packages
|
58 |
API Supporting packages
|
| 61 |
Link: HOME
|
59 |
Link: HOME
|
| 62 |
Link: UP
|
60 |
Link: UP
|
| 63 |
Link: PREVIOUS
|
61 |
Link: PREVIOUS
|
| 64 |
Link: NEXT
|
62 |
Link: NEXT
|
| 65 |
|
63 |
|
| 66 |
Recoll user manual
|
64 |
Recoll user manual
|
| 67 |
Prev Chapter 4. Installation Next
|
65 |
Prev Chapter 5. Installation Next
|
| 68 |
|
66 |
|
| 69 |
--------------------------------------------------------------------------
|
67 |
--------------------------------------------------------------------------
|
| 70 |
|
68 |
|
| 71 |
4.2. Supporting packages
|
69 |
5.2. Supporting packages
|
| 72 |
|
70 |
|
| 73 |
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
|
| 74 |
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
|
| 75 |
run-time dependencies. None is needed for building Recoll):
|
73 |
run-time dependencies. None is needed for building Recoll).
|
|
|
74 |
|
|
|
75 |
After an indexing pass, the commands that were found missing can be
|
|
|
76 |
displayed from the recoll File menu. The list is stored in the missing
|
|
|
77 |
text file inside the configuration directory.
|
|
|
78 |
|
|
|
79 |
A list of common file types which need external commands:
|
| 76 |
|
80 |
|
| 77 |
* Openoffice: supported natively, but needs the unzip command to be
|
81 |
* Openoffice: supported natively, but needs the unzip command to be
|
| 78 |
installed.
|
82 |
installed.
|
| 79 |
|
83 |
|
| 80 |
* PDF: pdftotext is part of the Xpdf package.
|
84 |
* PDF: pdftotext is part of the Xpdf package.
|
|
... |
|
... |
| 116 |
Link: UP
|
120 |
Link: UP
|
| 117 |
Link: PREVIOUS
|
121 |
Link: PREVIOUS
|
| 118 |
Link: NEXT
|
122 |
Link: NEXT
|
| 119 |
|
123 |
|
| 120 |
Recoll user manual
|
124 |
Recoll user manual
|
| 121 |
Prev Chapter 4. Installation Next
|
125 |
Prev Chapter 5. Installation Next
|
| 122 |
|
126 |
|
| 123 |
--------------------------------------------------------------------------
|
127 |
--------------------------------------------------------------------------
|
| 124 |
|
128 |
|
| 125 |
4.3. Building from source
|
129 |
5.3. Building from source
|
| 126 |
|
130 |
|
| 127 |
4.3.1. Prerequisites
|
131 |
5.3.1. Prerequisites
|
| 128 |
|
132 |
|
| 129 |
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
|
| 130 |
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
|
| 131 |
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
|
| 132 |
(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
|
|
... |
|
... |
| 138 |
|
142 |
|
| 139 |
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
|
| 140 |
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
|
| 141 |
and you should not need to do anything special.
|
145 |
and you should not need to do anything special.
|
| 142 |
|
146 |
|
| 143 |
4.3.2. Building
|
147 |
5.3.2. Building
|
| 144 |
|
148 |
|
| 145 |
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
|
| 146 |
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
|
| 147 |
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.
|
| 148 |
|
152 |
|
|
... |
|
... |
| 176 |
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
|
| 177 |
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
|
| 178 |
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
|
| 179 |
should be the output of uname -s).
|
183 |
should be the output of uname -s).
|
| 180 |
|
184 |
|
| 181 |
4.3.3. Installation
|
185 |
5.3.3. Installation
|
| 182 |
|
186 |
|
| 183 |
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
|
| 184 |
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
|
| 185 |
configuration files, scripts and other shared data to prefix/share/recoll.
|
189 |
configuration files, scripts and other shared data to prefix/share/recoll.
|
| 186 |
|
190 |
|
|
... |
|
... |
| 199 |
Link: UP
|
203 |
Link: UP
|
| 200 |
Link: PREVIOUS
|
204 |
Link: PREVIOUS
|
| 201 |
Link: NEXT
|
205 |
Link: NEXT
|
| 202 |
|
206 |
|
| 203 |
Recoll user manual
|
207 |
Recoll user manual
|
| 204 |
Prev Chapter 4. Installation Next
|
208 |
Prev Chapter 5. Installation Next
|
| 205 |
|
209 |
|
| 206 |
--------------------------------------------------------------------------
|
210 |
--------------------------------------------------------------------------
|
| 207 |
|
211 |
|
| 208 |
4.4. Configuration overview
|
212 |
5.4. Configuration overview
|
| 209 |
|
213 |
|
| 210 |
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
|
| 211 |
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).
|
| 212 |
You probably do not want to edit this by hand.
|
216 |
You probably do not want to edit this by hand.
|
| 213 |
|
217 |
|
|
... |
|
... |
| 261 |
expanded to the name of the user's home directory, as a shell would do.
|
265 |
expanded to the name of the user's home directory, as a shell would do.
|
| 262 |
|
266 |
|
| 263 |
White space is used for separation inside lists. List elements with
|
267 |
White space is used for separation inside lists. List elements with
|
| 264 |
embedded spaces can be quoted using double-quotes.
|
268 |
embedded spaces can be quoted using double-quotes.
|
| 265 |
|
269 |
|
| 266 |
4.4.1. Main configuration file
|
270 |
5.4.1. Main configuration file
|
| 267 |
|
271 |
|
| 268 |
recoll.conf is the main configuration file. It defines things like what to
|
272 |
recoll.conf is the main configuration file. It defines things like what to
|
| 269 |
index (top directories and things to ignore), and the default character
|
273 |
index (top directories and things to ignore), and the default character
|
| 270 |
set to use for document types which do not specify it internally.
|
274 |
set to use for document types which do not specify it internally.
|
| 271 |
|
275 |
|
|
... |
|
... |
| 465 |
This lets you adjust the size of n-grams used for indexing CJK
|
469 |
This lets you adjust the size of n-grams used for indexing CJK
|
| 466 |
text. The default value of 2 is probably appropriate in most
|
470 |
text. The default value of 2 is probably appropriate in most
|
| 467 |
cases. A value of 3 would allow more precision and efficiency on
|
471 |
cases. A value of 3 would allow more precision and efficiency on
|
| 468 |
longer words, but the index will be approximately twice as large.
|
472 |
longer words, but the index will be approximately twice as large.
|
| 469 |
|
473 |
|
| 470 |
4.4.2. The mimemap file
|
474 |
5.4.2. The mimemap file
|
| 471 |
|
475 |
|
| 472 |
mimemap specifies the file name extension to mime type mappings.
|
476 |
mimemap specifies the file name extension to mime type mappings.
|
| 473 |
|
477 |
|
| 474 |
For file names without an extension, or with an unknown one, the system's
|
478 |
For file names without an extension, or with an unknown one, the system's
|
| 475 |
file -i command will be executed to determine the mime type (this can be
|
479 |
file -i command will be executed to determine the mime type (this can be
|
|
... |
|
... |
| 489 |
skippedNames anything that recoll_noindex does. The latter is used mostly
|
493 |
skippedNames anything that recoll_noindex does. The latter is used mostly
|
| 490 |
for things known to be unindexable by a given Recoll version. Having it
|
494 |
for things known to be unindexable by a given Recoll version. Having it
|
| 491 |
there avoids cluttering the more user-oriented and locally customized
|
495 |
there avoids cluttering the more user-oriented and locally customized
|
| 492 |
skippedNames.
|
496 |
skippedNames.
|
| 493 |
|
497 |
|
| 494 |
4.4.3. The mimeconf file
|
498 |
5.4.3. The mimeconf file
|
| 495 |
|
499 |
|
| 496 |
mimeconf specifies how the different mime types are handled for indexing,
|
500 |
mimeconf specifies how the different mime types are handled for indexing,
|
| 497 |
and which icons are displayed in the recoll result lists.
|
501 |
and which icons are displayed in the recoll result lists.
|
| 498 |
|
502 |
|
| 499 |
Changing the parameters in the [index] section is probably not a good idea
|
503 |
Changing the parameters in the [index] section is probably not a good idea
|
|
... |
|
... |
| 501 |
|
505 |
|
| 502 |
The [icons] section allows you to change the icons which are displayed by
|
506 |
The [icons] section allows you to change the icons which are displayed by
|
| 503 |
recoll in the result lists (the values are the basenames of the png images
|
507 |
recoll in the result lists (the values are the basenames of the png images
|
| 504 |
inside the iconsdir directory (specified in recoll.conf).
|
508 |
inside the iconsdir directory (specified in recoll.conf).
|
| 505 |
|
509 |
|
| 506 |
4.4.4. The mimeview file
|
510 |
5.4.4. The mimeview file
|
| 507 |
|
511 |
|
| 508 |
mimeview specifies which programs are started when you click on an Edit
|
512 |
mimeview specifies which programs are started when you click on an Edit
|
| 509 |
link in a result list. Ie: HTML is normally displayed using firefox, but
|
513 |
link in a result list. Ie: HTML is normally displayed using firefox, but
|
| 510 |
you may prefer Konqueror, your openoffice.org program might be named
|
514 |
you may prefer Konqueror, your openoffice.org program might be named
|
| 511 |
oofice instead of openoffice etc.
|
515 |
oofice instead of openoffice etc.
|
|
... |
|
... |
| 522 |
|
526 |
|
| 523 |
If Use desktop preferences to choose document editor is checked in the
|
527 |
If Use desktop preferences to choose document editor is checked in the
|
| 524 |
user preferences, all mimeview entries will be ignored except the one
|
528 |
user preferences, all mimeview entries will be ignored except the one
|
| 525 |
labelled application/x-all (which is set to use xdg-open by default).
|
529 |
labelled application/x-all (which is set to use xdg-open by default).
|
| 526 |
|
530 |
|
| 527 |
4.4.5. Examples of configuration adjustments
|
531 |
5.4.5. Examples of configuration adjustments
|
| 528 |
|
532 |
|
| 529 |
4.4.5.1. Adding an external viewer for an non-indexed type
|
533 |
5.4.5.1. Adding an external viewer for an non-indexed type
|
| 530 |
|
534 |
|
| 531 |
Imagine that you have some kind of file which does not have indexable
|
535 |
Imagine that you have some kind of file which does not have indexable
|
| 532 |
content, but for which you would like to have a functional Edit link in
|
536 |
content, but for which you would like to have a functional Edit link in
|
| 533 |
the result list (when found by file name). The file names end in .blob and
|
537 |
the result list (when found by file name). The file names end in .blob and
|
| 534 |
can be displayed by application blobviewer.
|
538 |
can be displayed by application blobviewer.
|
|
... |
|
... |
| 555 |
If you just wanted to change the application used by Recoll to display a
|
559 |
If you just wanted to change the application used by Recoll to display a
|
| 556 |
mime type which it already knows, you would just need to edit mimeview.
|
560 |
mime type which it already knows, you would just need to edit mimeview.
|
| 557 |
The entries you add in your personal file override those in the central
|
561 |
The entries you add in your personal file override those in the central
|
| 558 |
configuration, which you do not need to alter
|
562 |
configuration, which you do not need to alter
|
| 559 |
|
563 |
|
| 560 |
4.4.5.2. Adding indexing support for a new file type
|
564 |
5.4.5.2. Adding indexing support for a new file type
|
| 561 |
|
565 |
|
| 562 |
Let us now imagine that the above .blob files actually contain indexable
|
566 |
Let us now imagine that the above .blob files actually contain indexable
|
| 563 |
text and that you know how to extract it with a command line program.
|
567 |
text and that you know how to extract it with a command line program.
|
| 564 |
Getting Recoll to index the files is easy. You need to perform the above
|
568 |
Getting Recoll to index the files is easy. You need to perform the above
|
| 565 |
alteration, and also to add data to the mimeconf file (typically in
|
569 |
alteration, and also to add data to the mimeconf file (typically in
|
|
... |
|
... |
| 579 |
makes sense (you can also create a category). Categories may be used
|
583 |
makes sense (you can also create a category). Categories may be used
|
| 580 |
for filtering in advanced search.
|
584 |
for filtering in advanced search.
|
| 581 |
|
585 |
|
| 582 |
The rclblob filter should be an executable program or script which exists
|
586 |
The rclblob filter should be an executable program or script which exists
|
| 583 |
inside /usr/[local/]share/recoll/filters. It will be given a file name as
|
587 |
inside /usr/[local/]share/recoll/filters. It will be given a file name as
|
| 584 |
argument and should output the text contents in html format on the
|
588 |
argument and should output the text contents on the standard output.
|
| 585 |
standard output.
|
|
|
| 586 |
|
589 |
|
| 587 |
You can find more details about writing a Recoll filter in the section
|
590 |
The filter programming section describes in more detail how to write a
|
| 588 |
about writing filters
|
591 |
filter.
|
| 589 |
|
592 |
|
| 590 |
--------------------------------------------------------------------------
|
593 |
--------------------------------------------------------------------------
|
| 591 |
|
594 |
|
| 592 |
Prev Home Next
|
595 |
Prev Home Next
|
| 593 |
Building from source Up The KDE Kicker Recoll applet
|
596 |
Building from source Up The KDE Kicker Recoll applet
|