|
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 7. Installation
|
14 |
Chapter 5. Installation and configuration
|
| 15 |
|
15 |
|
| 16 |
Table of Contents
|
16 |
Table of Contents
|
| 17 |
|
17 |
|
| 18 |
7.1. Installing a binary copy
|
18 |
5.1. Installing a binary copy
|
| 19 |
|
19 |
|
| 20 |
7.2. Supporting packages
|
20 |
5.2. Supporting packages
|
| 21 |
|
21 |
|
| 22 |
7.3. Building from source
|
22 |
5.3. Building from source
|
| 23 |
|
23 |
|
| 24 |
7.4. Configuration overview
|
24 |
5.4. Configuration overview
|
| 25 |
|
25 |
|
| 26 |
7.5. The KDE Kicker Recoll applet
|
|
|
| 27 |
|
|
|
| 28 |
7.1. Installing a binary copy
|
26 |
5.1. Installing a binary copy
|
| 29 |
|
27 |
|
| 30 |
There are three types of binary Recoll installations:
|
28 |
There are three types of binary Recoll installations:
|
| 31 |
|
29 |
|
| 32 |
* Through your system normal software distribution framework (ie,
|
30 |
* Through your system normal software distribution framework (ie,
|
| 33 |
Debian/Ubuntu apt, FreeBSD ports, etc.).
|
31 |
Debian/Ubuntu apt, FreeBSD ports, etc.).
|
|
... |
|
... |
| 45 |
|
43 |
|
| 46 |
You should also maybe have a look at the configuration section (but this
|
44 |
You should also maybe have a look at the configuration section (but this
|
| 47 |
may not be necessary for a quick test with default parameters). Most
|
45 |
may not be necessary for a quick test with default parameters). Most
|
| 48 |
parameters can be more conveniently set from the GUI interface.
|
46 |
parameters can be more conveniently set from the GUI interface.
|
| 49 |
|
47 |
|
| 50 |
7.1.1. Installing through a package system
|
48 |
5.1.1. Installing through a package system
|
| 51 |
|
49 |
|
| 52 |
If you use a BSD-type port system or a prebuilt package (DEB, RPM,
|
50 |
If you use a BSD-type port system or a prebuilt package (DEB, RPM,
|
| 53 |
manually or through the system software configuration utility), just
|
51 |
manually or through the system software configuration utility), just
|
| 54 |
follow the usual procedure for your system.
|
52 |
follow the usual procedure for your system.
|
| 55 |
|
53 |
|
| 56 |
7.1.2. Installing a prebuilt Recoll
|
54 |
5.1.2. Installing a prebuilt Recoll
|
| 57 |
|
55 |
|
| 58 |
The unpackaged binary versions on the Recoll web site are just compressed
|
56 |
The unpackaged binary versions on the Recoll web site are just compressed
|
| 59 |
tar files of a build tree, where only the useful parts were kept
|
57 |
tar files of a build tree, where only the useful parts were kept
|
| 60 |
(executables and sample configuration).
|
58 |
(executables and sample configuration).
|
| 61 |
|
59 |
|
|
... |
|
... |
| 74 |
Link: UP
|
72 |
Link: UP
|
| 75 |
Link: PREVIOUS
|
73 |
Link: PREVIOUS
|
| 76 |
Link: NEXT
|
74 |
Link: NEXT
|
| 77 |
|
75 |
|
| 78 |
Recoll user manual
|
76 |
Recoll user manual
|
| 79 |
Prev Chapter 7. Installation Next
|
77 |
Prev Chapter 5. Installation and configuration Next
|
| 80 |
|
78 |
|
| 81 |
--------------------------------------------------------------------------
|
79 |
--------------------------------------------------------------------------
|
| 82 |
|
80 |
|
| 83 |
7.2. Supporting packages
|
81 |
5.2. Supporting packages
|
| 84 |
|
82 |
|
| 85 |
Recoll uses external applications to index some file types. You need to
|
83 |
Recoll uses external applications to index some file types. You need to
|
| 86 |
install them for the file types that you wish to have indexed (these are
|
84 |
install them for the file types that you wish to have indexed (these are
|
| 87 |
run-time optional dependencies. None is needed for building or running
|
85 |
run-time optional dependencies. None is needed for building or running
|
| 88 |
Recoll except for indexing their specific file type).
|
86 |
Recoll except for indexing their specific file type).
|
|
... |
|
... |
| 93 |
|
91 |
|
| 94 |
A list of common file types which need external commands follows. Many of
|
92 |
A list of common file types which need external commands follows. Many of
|
| 95 |
the filters need the iconv command, which is not always listed as a
|
93 |
the filters need the iconv command, which is not always listed as a
|
| 96 |
dependancy.
|
94 |
dependancy.
|
| 97 |
|
95 |
|
|
|
96 |
Please note that, due to the relatively dynamic nature of this
|
|
|
97 |
information, the most up to date version is now kept on the Recoll helper
|
|
|
98 |
applications page along with links to the home pages or best
|
|
|
99 |
source/patches download links. The list below is not updated often and may
|
|
|
100 |
be quite stale.
|
|
|
101 |
|
|
|
102 |
For many Linux distributions, most of the commands listed can be installed
|
|
|
103 |
from the package repositories. However, the packages are sometimes
|
|
|
104 |
outdated, or not the best version for Recoll, so you should take a look at
|
|
|
105 |
the Recoll helper applications page if a file type is important to you.
|
|
|
106 |
|
| 98 |
As of Recoll release 1.14, a number of XML-based formats that were handled
|
107 |
As of Recoll release 1.14, a number of XML-based formats that were handled
|
| 99 |
by ad hoc filter code now use xsltproc, which usually comes with libxslt.
|
108 |
by ad hoc filter code now use the xsltproc command, which usually comes
|
| 100 |
These are: abiword, fb2 (ebooks), kword, openoffice, svg.
|
109 |
with libxslt. These are: abiword, fb2 (ebooks), kword, openoffice, svg.
|
| 101 |
|
110 |
|
| 102 |
* Openoffice: supported natively, but needs the unzip command to be
|
111 |
Now for the list:
|
| 103 |
installed.
|
|
|
| 104 |
|
112 |
|
|
|
113 |
* Openoffice files need unzip and xsltproc.
|
|
|
114 |
|
| 105 |
* PDF: pdftotext is part of the Xpdf or Poppler packages.
|
115 |
* PDF files need pdftotext which is part of the Xpdf or Poppler
|
|
|
116 |
packages.
|
| 106 |
|
117 |
|
| 107 |
* Postscript: pstotext.
|
118 |
* Postscript files need pstotext. The original version has an issue with
|
|
|
119 |
shell character in file names, which is corrected in recent packages.
|
|
|
120 |
See the the Recoll helper applications page for more detail.
|
| 108 |
|
121 |
|
| 109 |
* MS Word: antiword.
|
122 |
* MS Word needs antiword. It is also useful to have wvWare installed as
|
|
|
123 |
it may be be used as a fallback for some files which antiword does not
|
|
|
124 |
handle.
|
| 110 |
|
125 |
|
| 111 |
* MS Excel and PowerPoint: catdoc.
|
126 |
* MS Excel and PowerPoint need catdoc.
|
| 112 |
|
127 |
|
| 113 |
* MS Open XML (docx): needs xsltproc.
|
128 |
* MS Open XML (docx) needs xsltproc.
|
| 114 |
|
129 |
|
| 115 |
* Wordperfect files: libwpd.
|
130 |
* Wordperfect files need wpd2html from the libwpd package.
|
| 116 |
|
131 |
|
| 117 |
* RTF: unrtf
|
132 |
* RTF files need unrtf, which, in its standard version, has much trouble
|
|
|
133 |
with non-western character sets. Check the Recoll helper applications
|
|
|
134 |
page.
|
| 118 |
|
135 |
|
| 119 |
* TeX: Recoll uses the untex program. Your distribution may have a
|
136 |
* TeX files need untex or detex. Check the Recoll helper applications
|
| 120 |
package for it. If it doesn't, there is a copy of the source on the
|
137 |
page for sources if it's not packaged for your distribution.
|
| 121 |
Recoll web site, because the program has no obvious home. The filter
|
|
|
| 122 |
can also work with detex and will use it if it is installed.
|
|
|
| 123 |
|
138 |
|
| 124 |
* dvi: dvips
|
139 |
* dvi files need dvips.
|
| 125 |
|
140 |
|
| 126 |
* djvu: DjVuLibre
|
141 |
* djvu files need djvutxt and djvused from the DjVuLibre package.
|
| 127 |
|
142 |
|
| 128 |
* mp3, flac, ogg vorbis: Recoll releases before 1.13 use the id3info
|
143 |
* Audio files: Recoll releases before 1.13 used the id3info command from
|
| 129 |
command from the id3lib package to extract mp3 tag information. (Some
|
144 |
the id3lib package to extract mp3 tag information, metaflac (standard
|
| 130 |
gcc versions after 4.4 may have trouble compiling id3lib. You can find
|
145 |
flac tools) for flac files, and ogginfo (vorbis tools) for ogg files.
|
| 131 |
a workaround here), metaflac (standard flac tools) for flac files, and
|
146 |
Releases 1.14 and later use a single Python filter based on mutagen
|
| 132 |
ogginfo (vorbis tools) for ogg files. Releases 1.14 and later use a
|
147 |
for all audio file types.
|
| 133 |
single Python filter based on mutagen for all audio file types.
|
|
|
| 134 |
|
148 |
|
| 135 |
* Pictures: Recoll uses the Exiftool Perl package to extract tag
|
149 |
* Pictures: Recoll uses the Exiftool Perl package to extract tag
|
| 136 |
information. Most image file formats are supported. Note that there
|
150 |
information. Most image file formats are supported. Note that there
|
| 137 |
may not be much interest in indexing the technical tags (image size,
|
151 |
may not be much interest in indexing the technical tags (image size,
|
| 138 |
aperture, etc.). This is only of interest if you store personal tags
|
152 |
aperture, etc.). This is only of interest if you store personal tags
|
| 139 |
or textual descriptions inside the image files.
|
153 |
or textual descriptions inside the image files.
|
| 140 |
|
154 |
|
| 141 |
* chm: files in microsoft help format need Python and the pychm module
|
155 |
* chm: files in microsoft help format need Python and the pychm module
|
| 142 |
(which needs chmlib).
|
156 |
(which needs chmlib).
|
| 143 |
|
157 |
|
| 144 |
* ics: up to Recoll 1.13, iCalendar files need Python and the icalendar
|
158 |
* ICS: up to Recoll 1.13, iCalendar files need Python and the icalendar
|
| 145 |
module. For newer versions, icalendar is not needed
|
159 |
module. icalendar is not needed for newer versions, which use internal
|
|
|
160 |
code.
|
| 146 |
|
161 |
|
| 147 |
* zip: Zip archives need Python (and the standard zipfile module).
|
162 |
* Zip archives need Python (and the standard zipfile module).
|
| 148 |
|
163 |
|
| 149 |
Text, HTML, mail folders, Openoffice and Scribus files are processed
|
164 |
Text, HTML, mail folders, and Scribus files are processed internally. Lyx
|
| 150 |
internally. Lyx is used to index Lyx files. Many filters need iconv and
|
165 |
is used to index Lyx files. Many filters need iconv and the standard sed
|
| 151 |
the standard sed and awk.
|
166 |
and awk.
|
| 152 |
|
167 |
|
| 153 |
--------------------------------------------------------------------------
|
168 |
--------------------------------------------------------------------------
|
| 154 |
|
169 |
|
| 155 |
Prev Home Next
|
170 |
Prev Home Next
|
| 156 |
Installation Up Building from source
|
171 |
Installation and configuration Up Building from source
|
| 157 |
Link: HOME
|
172 |
Link: HOME
|
| 158 |
Link: UP
|
173 |
Link: UP
|
| 159 |
Link: PREVIOUS
|
174 |
Link: PREVIOUS
|
| 160 |
Link: NEXT
|
175 |
Link: NEXT
|
| 161 |
|
176 |
|
| 162 |
Recoll user manual
|
177 |
Recoll user manual
|
| 163 |
Prev Chapter 7. Installation Next
|
178 |
Prev Chapter 5. Installation and configuration Next
|
| 164 |
|
179 |
|
| 165 |
--------------------------------------------------------------------------
|
180 |
--------------------------------------------------------------------------
|
| 166 |
|
181 |
|
| 167 |
7.3. Building from source
|
182 |
5.3. Building from source
|
| 168 |
|
183 |
|
| 169 |
7.3.1. Prerequisites
|
184 |
5.3.1. Prerequisites
|
| 170 |
|
185 |
|
| 171 |
C++ compiler. Up to Recoll version 1.13.04, its absence can manifest
|
186 |
C++ compiler. Up to Recoll version 1.13.04, its absence can manifest
|
| 172 |
itself by strange messages about a missing iconv_open.
|
187 |
itself by strange messages about a missing iconv_open.
|
| 173 |
|
188 |
|
| 174 |
Development files for Xapian core
|
189 |
Development files for Xapian core.
|
|
|
190 |
|
|
|
191 |
Important: If you are building Xapian for an older CPU (before Pentium 4
|
|
|
192 |
or Athlon 64), you need to add the --disable-sse flag to the configure
|
|
|
193 |
command. Else all Xapian application will crash with an illegal
|
|
|
194 |
instruction error.
|
| 175 |
|
195 |
|
| 176 |
Development files for Qt .
|
196 |
Development files for Qt .
|
| 177 |
|
197 |
|
| 178 |
Development files for X11 and zlib.
|
198 |
Development files for X11 and zlib.
|
| 179 |
|
199 |
|
|
... |
|
... |
| 185 |
|
205 |
|
| 186 |
You may also need libiconv. Recoll currently uses version 1.9 (this should
|
206 |
You may also need libiconv. Recoll currently uses version 1.9 (this should
|
| 187 |
not be critical). On Linux systems, the iconv interface is part of libc
|
207 |
not be critical). On Linux systems, the iconv interface is part of libc
|
| 188 |
and you should not need to do anything special.
|
208 |
and you should not need to do anything special.
|
| 189 |
|
209 |
|
| 190 |
7.3.2. Building
|
210 |
5.3.2. Building
|
| 191 |
|
211 |
|
| 192 |
Recoll has been built on Linux, FreeBSD, Mac OS X, and Solaris, most
|
212 |
Recoll has been built on Linux, FreeBSD, Mac OS X, and Solaris, most
|
| 193 |
versions after 2005 should be ok, maybe some older ones too (Solaris 8 is
|
213 |
versions after 2005 should be ok, maybe some older ones too (Solaris 8 is
|
| 194 |
ok). If you build on another system, and need to modify things, I would
|
214 |
ok). If you build on another system, and need to modify things, I would
|
| 195 |
very much welcome patches.
|
215 |
very much welcome patches.
|
|
... |
|
... |
| 252 |
one of the system-specific files in the mk directory to mk/sysconf. If
|
272 |
one of the system-specific files in the mk directory to mk/sysconf. If
|
| 253 |
your system is not known yet, it will tell you as much, and you may want
|
273 |
your system is not known yet, it will tell you as much, and you may want
|
| 254 |
to manually copy and modify one of the existing files (the new file name
|
274 |
to manually copy and modify one of the existing files (the new file name
|
| 255 |
should be the output of uname -s).
|
275 |
should be the output of uname -s).
|
| 256 |
|
276 |
|
| 257 |
7.3.3. Installation
|
277 |
5.3.3. Installation
|
| 258 |
|
278 |
|
| 259 |
Either type make install or execute recollinstall prefix, in the root of
|
279 |
Either type make install or execute recollinstall prefix, in the root of
|
| 260 |
the source tree. This will copy the commands to prefix/bin and the sample
|
280 |
the source tree. This will copy the commands to prefix/bin and the sample
|
| 261 |
configuration files, scripts and other shared data to prefix/share/recoll.
|
281 |
configuration files, scripts and other shared data to prefix/share/recoll.
|
| 262 |
|
282 |
|
|
... |
|
... |
| 274 |
Prev Home Next
|
294 |
Prev Home Next
|
| 275 |
Supporting packages Up Configuration overview
|
295 |
Supporting packages Up Configuration overview
|
| 276 |
Link: HOME
|
296 |
Link: HOME
|
| 277 |
Link: UP
|
297 |
Link: UP
|
| 278 |
Link: PREVIOUS
|
298 |
Link: PREVIOUS
|
| 279 |
Link: NEXT
|
|
|
| 280 |
|
299 |
|
| 281 |
Recoll user manual
|
300 |
Recoll user manual
|
| 282 |
Prev Chapter 7. Installation Next
|
301 |
Prev Chapter 5. Installation and configuration
|
| 283 |
|
302 |
|
| 284 |
--------------------------------------------------------------------------
|
303 |
--------------------------------------------------------------------------
|
| 285 |
|
304 |
|
| 286 |
7.4. Configuration overview
|
305 |
5.4. Configuration overview
|
| 287 |
|
306 |
|
| 288 |
Most of the parameters specific to the recoll GUI are set through the
|
307 |
Most of the parameters specific to the recoll GUI are set through the
|
| 289 |
Preferences menu and stored in the standard Qt place ($HOME/.qt/recollrc).
|
308 |
Preferences menu and stored in the standard Qt place ($HOME/.qt/recollrc).
|
| 290 |
You probably do not want to edit this by hand.
|
309 |
You probably do not want to edit this by hand.
|
| 291 |
|
310 |
|
|
... |
|
... |
| 353 |
expanded to the name of the user's home directory, as a shell would do.
|
372 |
expanded to the name of the user's home directory, as a shell would do.
|
| 354 |
|
373 |
|
| 355 |
White space is used for separation inside lists. List elements with
|
374 |
White space is used for separation inside lists. List elements with
|
| 356 |
embedded spaces can be quoted using double-quotes.
|
375 |
embedded spaces can be quoted using double-quotes.
|
| 357 |
|
376 |
|
| 358 |
7.4.1. Main configuration file
|
377 |
5.4.1. Main configuration file
|
| 359 |
|
378 |
|
| 360 |
recoll.conf is the main configuration file. It defines things like what to
|
379 |
recoll.conf is the main configuration file. It defines things like what to
|
| 361 |
index (top directories and things to ignore), and the default character
|
380 |
index (top directories and things to ignore), and the default character
|
| 362 |
set to use for document types which do not specify it internally.
|
381 |
set to use for document types which do not specify it internally.
|
| 363 |
|
382 |
|
|
... |
|
... |
| 368 |
|
387 |
|
| 369 |
Most of the following parameters can be changed from the Index
|
388 |
Most of the following parameters can be changed from the Index
|
| 370 |
Configuration menu in the recoll interface. Some can only be set by
|
389 |
Configuration menu in the recoll interface. Some can only be set by
|
| 371 |
editing the configuration file.
|
390 |
editing the configuration file.
|
| 372 |
|
391 |
|
| 373 |
7.4.1.1. Parameters affecting what documents we index:
|
392 |
5.4.1.1. Parameters affecting what documents we index:
|
| 374 |
|
393 |
|
| 375 |
topdirs
|
394 |
topdirs
|
| 376 |
|
395 |
|
| 377 |
Specifies the list of directories or files to index (recursively
|
396 |
Specifies the list of directories or files to index (recursively
|
| 378 |
for directories). You can use symbolic links as elements of this
|
397 |
for directories). You can use symbolic links as elements of this
|
|
... |
|
... |
| 489 |
|
508 |
|
| 490 |
The path to the Beagle indexing queue. This is hard-coded in the
|
509 |
The path to the Beagle indexing queue. This is hard-coded in the
|
| 491 |
Beagle plugin as ~/.beagle/ToIndex so there should be no need to
|
510 |
Beagle plugin as ~/.beagle/ToIndex so there should be no need to
|
| 492 |
change it.
|
511 |
change it.
|
| 493 |
|
512 |
|
| 494 |
7.4.1.2. Parameters affecting how we generate terms:
|
513 |
5.4.1.2. Parameters affecting how we generate terms:
|
| 495 |
|
514 |
|
| 496 |
Changing some of these parameters will imply a full reindex. Also, when
|
515 |
Changing some of these parameters will imply a full reindex. Also, when
|
| 497 |
using multiple indexes, it may not make sense to search indexes that don't
|
516 |
using multiple indexes, it may not make sense to search indexes that don't
|
| 498 |
share the values for these parameters, because they usually affect both
|
517 |
share the values for these parameters, because they usually affect both
|
| 499 |
search and index operations.
|
518 |
search and index operations.
|
|
... |
|
... |
| 554 |
are to be set, they should be separated with a colon (':')
|
573 |
are to be set, they should be separated with a colon (':')
|
| 555 |
character (which there is currently no way to escape). Ie:
|
574 |
character (which there is currently no way to escape). Ie:
|
| 556 |
localfields= rclaptg=gnus:other = val, then select specifier
|
575 |
localfields= rclaptg=gnus:other = val, then select specifier
|
| 557 |
viewer with mimetype|tag=... in mimeview.
|
576 |
viewer with mimetype|tag=... in mimeview.
|
| 558 |
|
577 |
|
| 559 |
7.4.1.3. Parameters affecting where and how we store things:
|
578 |
5.4.1.3. Parameters affecting where and how we store things:
|
| 560 |
|
579 |
|
| 561 |
dbdir
|
580 |
dbdir
|
| 562 |
|
581 |
|
| 563 |
The name of the Xapian data directory. It will be created if
|
582 |
The name of the Xapian data directory. It will be created if
|
| 564 |
needed when the index is initialized. If this is not an absolute
|
583 |
needed when the index is initialized. If this is not an absolute
|
|
... |
|
... |
| 602 |
to disk index. Setting this can help control memory usage. A value
|
621 |
to disk index. Setting this can help control memory usage. A value
|
| 603 |
of 0 means no explicit flushing, letting Xapian use its own
|
622 |
of 0 means no explicit flushing, letting Xapian use its own
|
| 604 |
default, which is flushing every 10000 documents (memory usage
|
623 |
default, which is flushing every 10000 documents (memory usage
|
| 605 |
depends on average document size). The default value is 10.
|
624 |
depends on average document size). The default value is 10.
|
| 606 |
|
625 |
|
| 607 |
7.4.1.4. Miscellaneous parameters:
|
626 |
5.4.1.4. Miscellaneous parameters:
|
| 608 |
|
627 |
|
| 609 |
loglevel,daemloglevel
|
628 |
loglevel,daemloglevel
|
| 610 |
|
629 |
|
| 611 |
Verbosity level for recoll and recollindex. A value of 4 lists
|
630 |
Verbosity level for recoll and recollindex. A value of 4 lists
|
| 612 |
quite a lot of debug/information messages. 2 only lists errors.
|
631 |
quite a lot of debug/information messages. 2 only lists errors.
|
|
... |
|
... |
| 666 |
|
685 |
|
| 667 |
Decide if we try to guess the character set of files if no
|
686 |
Decide if we try to guess the character set of files if no
|
| 668 |
internal value is available (ie: for plain text files). This does
|
687 |
internal value is available (ie: for plain text files). This does
|
| 669 |
not work well in general, and should probably not be used.
|
688 |
not work well in general, and should probably not be used.
|
| 670 |
|
689 |
|
| 671 |
7.4.2. The fields file
|
690 |
5.4.2. The fields file
|
| 672 |
|
691 |
|
| 673 |
This file contains information about dynamic fields handling in Recoll.
|
692 |
This file contains information about dynamic fields handling in Recoll.
|
| 674 |
Some very basic fields have hard-wired behaviour, and, mostly, you should
|
693 |
Some very basic fields have hard-wired behaviour, and, mostly, you should
|
| 675 |
not change the original data inside the fields file. But you can create
|
694 |
not change the original data inside the fields file. But you can create
|
| 676 |
custom fields fitting your data and handle them just like they were native
|
695 |
custom fields fitting your data and handle them just like they were native
|
|
... |
|
... |
| 726 |
[mail]
|
745 |
[mail]
|
| 727 |
# Extract the X-My-Tag mail header, and use it internally with the
|
746 |
# Extract the X-My-Tag mail header, and use it internally with the
|
| 728 |
# mailmytag field name
|
747 |
# mailmytag field name
|
| 729 |
x-my-tag = mailmytag
|
748 |
x-my-tag = mailmytag
|
| 730 |
|
749 |
|
| 731 |
7.4.3. The mimemap file
|
750 |
5.4.3. The mimemap file
|
| 732 |
|
751 |
|
| 733 |
mimemap specifies the file name extension to mime type mappings.
|
752 |
mimemap specifies the file name extension to mime type mappings.
|
| 734 |
|
753 |
|
| 735 |
For file names without an extension, or with an unknown one, the system's
|
754 |
For file names without an extension, or with an unknown one, the system's
|
| 736 |
file -i command will be executed to determine the mime type (this can be
|
755 |
file -i command will be executed to determine the mime type (this can be
|
|
... |
|
... |
| 750 |
indexed (not even the file names are indexed for patterns in skippedNames.
|
769 |
indexed (not even the file names are indexed for patterns in skippedNames.
|
| 751 |
recoll_noindex is used mostly for things known to be unindexable by a
|
770 |
recoll_noindex is used mostly for things known to be unindexable by a
|
| 752 |
given Recoll version. Having it there avoids cluttering the more
|
771 |
given Recoll version. Having it there avoids cluttering the more
|
| 753 |
user-oriented and locally customized skippedNames.
|
772 |
user-oriented and locally customized skippedNames.
|
| 754 |
|
773 |
|
| 755 |
7.4.4. The mimeconf file
|
774 |
5.4.4. The mimeconf file
|
| 756 |
|
775 |
|
| 757 |
mimeconf specifies how the different mime types are handled for indexing,
|
776 |
mimeconf specifies how the different mime types are handled for indexing,
|
| 758 |
and which icons are displayed in the recoll result lists.
|
777 |
and which icons are displayed in the recoll result lists.
|
| 759 |
|
778 |
|
| 760 |
Changing the parameters in the [index] section is probably not a good idea
|
779 |
Changing the parameters in the [index] section is probably not a good idea
|
|
... |
|
... |
| 762 |
|
781 |
|
| 763 |
The [icons] section allows you to change the icons which are displayed by
|
782 |
The [icons] section allows you to change the icons which are displayed by
|
| 764 |
recoll in the result lists (the values are the basenames of the png images
|
783 |
recoll in the result lists (the values are the basenames of the png images
|
| 765 |
inside the iconsdir directory (specified in recoll.conf).
|
784 |
inside the iconsdir directory (specified in recoll.conf).
|
| 766 |
|
785 |
|
| 767 |
7.4.5. The mimeview file
|
786 |
5.4.5. The mimeview file
|
| 768 |
|
787 |
|
| 769 |
mimeview specifies which programs are started when you click on an Edit
|
788 |
mimeview specifies which programs are started when you click on an Open
|
| 770 |
link in a result list. Ie: HTML is normally displayed using firefox, but
|
789 |
link in a result list. Ie: HTML is normally displayed using firefox, but
|
| 771 |
you may prefer Konqueror, your openoffice.org program might be named
|
790 |
you may prefer Konqueror, your openoffice.org program might be named
|
| 772 |
oofice instead of openoffice etc.
|
791 |
oofice instead of openoffice etc.
|
| 773 |
|
792 |
|
| 774 |
Changes to this file can be done by direct editing, or through the recoll
|
793 |
Changes to this file can be done by direct editing, or through the recoll
|
| 775 |
user preferences dialog.
|
794 |
user preferences dialog.
|
|
|
795 |
|
|
|
796 |
If Use desktop preferences to choose document editor is checked in the
|
|
|
797 |
Recoll GUI user preferences, all mimeview entries will be ignored except
|
|
|
798 |
the one labelled application/x-all (which is set to use xdg-open by
|
|
|
799 |
default).
|
| 776 |
|
800 |
|
| 777 |
As for the other configuration files, the normal usage is to have a
|
801 |
As for the other configuration files, the normal usage is to have a
|
| 778 |
mimeview inside your own configuration directory, with just the
|
802 |
mimeview inside your own configuration directory, with just the
|
| 779 |
non-default entries, which will override those from the central
|
803 |
non-default entries, which will override those from the central
|
| 780 |
configuration file.
|
804 |
configuration file.
|
|
... |
|
... |
| 784 |
The keys in the file are normally mime types. You can add an application
|
808 |
The keys in the file are normally mime types. You can add an application
|
| 785 |
tag to specialize the choice for an area of the filesystem (using a
|
809 |
tag to specialize the choice for an area of the filesystem (using a
|
| 786 |
localfields specification in mimeconf). The syntax for the key is
|
810 |
localfields specification in mimeconf). The syntax for the key is
|
| 787 |
mimetype|tag
|
811 |
mimetype|tag
|
| 788 |
|
812 |
|
| 789 |
If Use desktop preferences to choose document editor is checked in the
|
|
|
| 790 |
user preferences, all mimeview entries will be ignored except the one
|
|
|
| 791 |
labelled application/x-all (which is set to use xdg-open by default).
|
|
|
| 792 |
|
|
|
| 793 |
The nouncompforviewmts entry, (placed at the top level, outside of the
|
813 |
The nouncompforviewmts entry, (placed at the top level, outside of the
|
| 794 |
[view] section), holds a list of mime types that should not be
|
814 |
[view] section), holds a list of mime types that should not be
|
| 795 |
uncompressed before starting the viewer (if they are found compressed, ie:
|
815 |
uncompressed before starting the viewer (if they are found compressed, ie:
|
| 796 |
mydoc.doc.gz).
|
816 |
mydoc.doc.gz).
|
| 797 |
|
817 |
|
|
|
818 |
The right side of each assignment holds a command to be executed for
|
|
|
819 |
opening the file. The following substitutions are performed:
|
|
|
820 |
|
|
|
821 |
* %D. Document date
|
|
|
822 |
|
|
|
823 |
* %f. File name. This may be the name of a temporary file if it was
|
|
|
824 |
necessary to create one (ie: to extract a subdocument from a
|
|
|
825 |
container).
|
|
|
826 |
|
|
|
827 |
* %F. Original file name. Same as %f except if a temporary file is used.
|
|
|
828 |
|
|
|
829 |
* %i. Internal path, for subdocuments of containers. The format depends
|
|
|
830 |
on the container type. If this appears in the command line, Recoll
|
|
|
831 |
will not create a temporary file to extract the subdocument, expecting
|
|
|
832 |
the called application (possibly a script) to be able to handle it.
|
|
|
833 |
|
|
|
834 |
* %M. Mime type
|
|
|
835 |
|
|
|
836 |
* %U, %u. Url.
|
|
|
837 |
|
|
|
838 |
In addition to the predefined values above, all strings like %(fieldname)
|
|
|
839 |
will be replaced by the value of the field named fieldname for the
|
|
|
840 |
document. This could be used in combination with field customisation to
|
|
|
841 |
help with opening the document.
|
|
|
842 |
|
| 798 |
7.4.6. Examples of configuration adjustments
|
843 |
5.4.6. Examples of configuration adjustments
|
| 799 |
|
844 |
|
| 800 |
7.4.6.1. Adding an external viewer for an non-indexed type
|
845 |
5.4.6.1. Adding an external viewer for an non-indexed type
|
| 801 |
|
846 |
|
| 802 |
Imagine that you have some kind of file which does not have indexable
|
847 |
Imagine that you have some kind of file which does not have indexable
|
| 803 |
content, but for which you would like to have a functional Edit link in
|
848 |
content, but for which you would like to have a functional Open link in
|
| 804 |
the result list (when found by file name). The file names end in .blob and
|
849 |
the result list (when found by file name). The file names end in .blob and
|
| 805 |
can be displayed by application blobviewer.
|
850 |
can be displayed by application blobviewer.
|
| 806 |
|
851 |
|
| 807 |
You need two entries in the configuration files for this to work:
|
852 |
You need two entries in the configuration files for this to work:
|
| 808 |
|
853 |
|
|
... |
|
... |
| 825 |
mime type which it already knows, you would just need to edit mimeview.
|
870 |
mime type which it already knows, you would just need to edit mimeview.
|
| 826 |
The entries you add in your personal file override those in the central
|
871 |
The entries you add in your personal file override those in the central
|
| 827 |
configuration, which you do not need to alter. mimeview can also be
|
872 |
configuration, which you do not need to alter. mimeview can also be
|
| 828 |
modified from the Gui.
|
873 |
modified from the Gui.
|
| 829 |
|
874 |
|
| 830 |
7.4.6.2. Adding indexing support for a new file type
|
875 |
5.4.6.2. Adding indexing support for a new file type
|
| 831 |
|
876 |
|
| 832 |
Let us now imagine that the above .blob files actually contain indexable
|
877 |
Let us now imagine that the above .blob files actually contain indexable
|
| 833 |
text and that you know how to extract it with a command line program.
|
878 |
text and that you know how to extract it with a command line program.
|
| 834 |
Getting Recoll to index the files is easy. You need to perform the above
|
879 |
Getting Recoll to index the files is easy. You need to perform the above
|
| 835 |
alteration, and also to add data to the mimeconf file (typically in
|
880 |
alteration, and also to add data to the mimeconf file (typically in
|
|
... |
|
... |
| 856 |
The filter programming section describes in more detail how to write a
|
901 |
The filter programming section describes in more detail how to write a
|
| 857 |
filter.
|
902 |
filter.
|
| 858 |
|
903 |
|
| 859 |
--------------------------------------------------------------------------
|
904 |
--------------------------------------------------------------------------
|
| 860 |
|
905 |
|
| 861 |
Prev Home Next
|
906 |
Prev Home
|
| 862 |
Building from source Up The KDE Kicker Recoll applet
|
907 |
Building from source Up
|