|
a/src/doc/user/recoll.conf.xml |
|
b/src/doc/user/recoll.conf.xml |
| 1 |
<?xml version="1.0"?>
|
1 |
<?xml version="1.0"?>
|
| 2 |
<sect2 id="RCL.INSTALL.CONFIG.RECOLLCONF">
|
2 |
<sect2 id="RCL.INSTALL.CONFIG.RECOLLCONF">
|
| 3 |
<title>Recoll main configuration file, recoll.conf </title>
|
3 |
<title>Recoll main configuration file, recoll.conf </title>
|
| 4 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.WHATDOCS">
|
4 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.WHATDOCS">
|
| 5 |
<title>Parameters affecting what documents we index </title>
|
5 |
<title>Parameters affecting what documents we index </title><variablelist>
|
| 6 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS">
|
6 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS">
|
| 7 |
<term><varname>topdirs</varname></term>
|
7 |
<term><varname>topdirs</varname></term>
|
| 8 |
<listitem><para>Space-separated list of files or
|
8 |
<listitem><para>Space-separated list of files or
|
| 9 |
directories to recursively index. Default to ~ (indexes
|
9 |
directories to recursively index. Default to ~ (indexes
|
| 10 |
$HOME). You can use symbolic links in the list, they will be followed,
|
10 |
$HOME). You can use symbolic links in the list, they will be followed,
|
|
... |
|
... |
| 170 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.MEMBERMAXKBS">
|
170 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.MEMBERMAXKBS">
|
| 171 |
<term><varname>membermaxkbs</varname></term>
|
171 |
<term><varname>membermaxkbs</varname></term>
|
| 172 |
<listitem><para>Size limit for archive
|
172 |
<listitem><para>Size limit for archive
|
| 173 |
members. This is passed to the filters in the environment
|
173 |
members. This is passed to the filters in the environment
|
| 174 |
as RECOLL_FILTER_MAXMEMBERKB.</para></listitem></varlistentry>
|
174 |
as RECOLL_FILTER_MAXMEMBERKB.</para></listitem></varlistentry>
|
| 175 |
</sect3>
|
175 |
</variablelist></sect3>
|
| 176 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.TERMS">
|
176 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.TERMS">
|
| 177 |
<title>Parameters affecting how we generate terms </title>
|
177 |
<title>Parameters affecting how we generate terms </title><variablelist>
|
| 178 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTRIPCHARS">
|
178 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTRIPCHARS">
|
| 179 |
<term><varname>indexStripChars</varname></term>
|
179 |
<term><varname>indexStripChars</varname></term>
|
| 180 |
<listitem><para>Decide if we store
|
180 |
<listitem><para>Decide if we store
|
| 181 |
character case and diacritics in the index. If we do,
|
181 |
character case and diacritics in the index. If we do,
|
| 182 |
searches sensitive to case and diacritics can be performed, but the index
|
182 |
searches sensitive to case and diacritics can be performed, but the index
|
|
... |
|
... |
| 304 |
returns multiple field values inside a text blob formatted as a recoll
|
304 |
returns multiple field values inside a text blob formatted as a recoll
|
| 305 |
configuration file ("fieldname = fieldvalue" lines). The rclmultixx name
|
305 |
configuration file ("fieldname = fieldvalue" lines). The rclmultixx name
|
| 306 |
will be ignored, and field names and values will be parsed from the data.
|
306 |
will be ignored, and field names and values will be parsed from the data.
|
| 307 |
Example: metadatacmds = ; tags = tmsu tags %f; rclmulti1 = cmdOutputsConf %f
|
307 |
Example: metadatacmds = ; tags = tmsu tags %f; rclmulti1 = cmdOutputsConf %f
|
| 308 |
</para></listitem></varlistentry>
|
308 |
</para></listitem></varlistentry>
|
| 309 |
</sect3>
|
309 |
</variablelist></sect3>
|
| 310 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.STORE">
|
310 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.STORE">
|
| 311 |
<title>Parameters affecting where and how we store things </title>
|
311 |
<title>Parameters affecting where and how we store things </title><variablelist>
|
| 312 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.CACHEDIR">
|
312 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.CACHEDIR">
|
| 313 |
<term><varname>cachedir</varname></term>
|
313 |
<term><varname>cachedir</varname></term>
|
| 314 |
<listitem><para>Top directory for Recoll data. Recoll data
|
314 |
<listitem><para>Top directory for Recoll data. Recoll data
|
| 315 |
directories are normally located relative to the configuration directory
|
315 |
directories are normally located relative to the configuration directory
|
| 316 |
(e.g. ~/.recoll/xapiandb, ~/.recoll/mboxcache). If 'cachedir' is set, the
|
316 |
(e.g. ~/.recoll/xapiandb, ~/.recoll/mboxcache). If 'cachedir' is set, the
|
|
... |
|
... |
| 388 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.ICONSDIR">
|
388 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.ICONSDIR">
|
| 389 |
<term><varname>iconsdir</varname></term>
|
389 |
<term><varname>iconsdir</varname></term>
|
| 390 |
<listitem><para>Directory location for icons. The only reason to
|
390 |
<listitem><para>Directory location for icons. The only reason to
|
| 391 |
change this would be if you want to change the icons displayed in the
|
391 |
change this would be if you want to change the icons displayed in the
|
| 392 |
result list. Defaults to $prefix/share/recoll/images</para></listitem></varlistentry>
|
392 |
result list. Defaults to $prefix/share/recoll/images</para></listitem></varlistentry>
|
| 393 |
</sect3>
|
393 |
</variablelist></sect3>
|
| 394 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.PERFS">
|
394 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.PERFS">
|
| 395 |
<title>Parameters affecting indexing performance and resource usage </title>
|
395 |
<title>Parameters affecting indexing performance and resource usage </title><variablelist>
|
| 396 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.IDXFLUSHMB">
|
396 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.IDXFLUSHMB">
|
| 397 |
<term><varname>idxflushmb</varname></term>
|
397 |
<term><varname>idxflushmb</varname></term>
|
| 398 |
<listitem><para>Threshold (megabytes of new data) where we flush from memory to
|
398 |
<listitem><para>Threshold (megabytes of new data) where we flush from memory to
|
| 399 |
disk index. Setting this allows some control over memory
|
399 |
disk index. Setting this allows some control over memory
|
| 400 |
usage by the indexer process. A value of 0 means no explicit flushing,
|
400 |
usage by the indexer process. A value of 0 means no explicit flushing,
|
|
... |
|
... |
| 441 |
in thrQSizes: if the first queue depth is 0, all counts are ignored
|
441 |
in thrQSizes: if the first queue depth is 0, all counts are ignored
|
| 442 |
(autoconfigured); if a value of -1 is used for a queue depth, the
|
442 |
(autoconfigured); if a value of -1 is used for a queue depth, the
|
| 443 |
corresponding thread count is ignored. It makes no sense to use a value
|
443 |
corresponding thread count is ignored. It makes no sense to use a value
|
| 444 |
other than 1 for the last stage because updating the Xapian index is
|
444 |
other than 1 for the last stage because updating the Xapian index is
|
| 445 |
necessarily single-threaded (and protected by a mutex).</para></listitem></varlistentry>
|
445 |
necessarily single-threaded (and protected by a mutex).</para></listitem></varlistentry>
|
| 446 |
</sect3>
|
446 |
</variablelist></sect3>
|
| 447 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.MISC">
|
447 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.MISC">
|
| 448 |
<title>Miscellaneous parameters </title>
|
448 |
<title>Miscellaneous parameters </title><variablelist>
|
| 449 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.LOGLEVEL">
|
449 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.LOGLEVEL">
|
| 450 |
<term><varname>loglevel</varname></term>
|
450 |
<term><varname>loglevel</varname></term>
|
| 451 |
<listitem><para>Log file verbosity 1-6. A value of 2 will print
|
451 |
<listitem><para>Log file verbosity 1-6. A value of 2 will print
|
| 452 |
only errors and warnings. 3 will print information like document updates,
|
452 |
only errors and warnings. 3 will print information like document updates,
|
| 453 |
4 is quite verbose and 6 very verbose.</para></listitem></varlistentry>
|
453 |
4 is quite verbose and 6 very verbose.</para></listitem></varlistentry>
|
|
... |
|
... |
| 561 |
3.</para></listitem></varlistentry>
|
561 |
3.</para></listitem></varlistentry>
|
| 562 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASSDATA">
|
562 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASSDATA">
|
| 563 |
<term><varname>monioniceclassdata</varname></term>
|
563 |
<term><varname>monioniceclassdata</varname></term>
|
| 564 |
<listitem><para>ionice class parameter for the real time indexing process. On platforms where this is supported. The default is
|
564 |
<listitem><para>ionice class parameter for the real time indexing process. On platforms where this is supported. The default is
|
| 565 |
empty.</para></listitem></varlistentry>
|
565 |
empty.</para></listitem></varlistentry>
|
| 566 |
</sect3>
|
566 |
</variablelist></sect3>
|
| 567 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.QUERY">
|
567 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.QUERY">
|
| 568 |
<title>Query-time parameters (no impact on the index) </title>
|
568 |
<title>Query-time parameters (no impact on the index) </title><variablelist>
|
| 569 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.AUTODIACSENS">
|
569 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.AUTODIACSENS">
|
| 570 |
<term><varname>autodiacsens</varname></term>
|
570 |
<term><varname>autodiacsens</varname></term>
|
| 571 |
<listitem><para>auto-trigger diacritics sensitivity (raw index only). IF the index is not stripped, decide if we automatically trigger
|
571 |
<listitem><para>auto-trigger diacritics sensitivity (raw index only). IF the index is not stripped, decide if we automatically trigger
|
| 572 |
diacritics sensitivity if the search term has accented characters (not in
|
572 |
diacritics sensitivity if the search term has accented characters (not in
|
| 573 |
unac_except_trans). Else you need to use the query language and the "D"
|
573 |
unac_except_trans). Else you need to use the query language and the "D"
|
|
... |
|
... |
| 598 |
<term><varname>snippetMaxPosWalk</varname></term>
|
598 |
<term><varname>snippetMaxPosWalk</varname></term>
|
| 599 |
<listitem><para>Maximum number of positions we walk while populating a snippet for
|
599 |
<listitem><para>Maximum number of positions we walk while populating a snippet for
|
| 600 |
the result list. The default of 1,000,000 may be
|
600 |
the result list. The default of 1,000,000 may be
|
| 601 |
insufficient for very big documents, the consequence would be snippets
|
601 |
insufficient for very big documents, the consequence would be snippets
|
| 602 |
with possibly meaning-altering missing words.</para></listitem></varlistentry>
|
602 |
with possibly meaning-altering missing words.</para></listitem></varlistentry>
|
| 603 |
</sect3>
|
603 |
</variablelist></sect3>
|
| 604 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.PDF">
|
604 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.PDF">
|
| 605 |
<title>Parameters for the PDF input script </title>
|
605 |
<title>Parameters for the PDF input script </title><variablelist>
|
| 606 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.PDFOCR">
|
606 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.PDFOCR">
|
| 607 |
<term><varname>pdfocr</varname></term>
|
607 |
<term><varname>pdfocr</varname></term>
|
| 608 |
<listitem><para>Attempt OCR of PDF files with no text content if both tesseract and
|
608 |
<listitem><para>Attempt OCR of PDF files with no text content if both tesseract and
|
| 609 |
pdftoppm are installed. The default is off because OCR is so
|
609 |
pdftoppm are installed. The default is off because OCR is so
|
| 610 |
very slow.</para></listitem></varlistentry>
|
610 |
very slow.</para></listitem></varlistentry>
|
|
... |
|
... |
| 629 |
values. The script should define a 'MetaFixer' class with a metafix()
|
629 |
values. The script should define a 'MetaFixer' class with a metafix()
|
| 630 |
method which will be called with the qualified tag name and value of each
|
630 |
method which will be called with the qualified tag name and value of each
|
| 631 |
selected field, for editing or erasing. A new instance is created for
|
631 |
selected field, for editing or erasing. A new instance is created for
|
| 632 |
each document, so that the object can keep state for, e.g. eliminating
|
632 |
each document, so that the object can keep state for, e.g. eliminating
|
| 633 |
duplicate values.</para></listitem></varlistentry>
|
633 |
duplicate values.</para></listitem></varlistentry>
|
| 634 |
</sect3>
|
634 |
</variablelist></sect3>
|
| 635 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.SPECLOCATIONS">
|
635 |
<sect3 id="RCL.INSTALL.CONFIG.RECOLLCONF.SPECLOCATIONS">
|
| 636 |
<title>Parameters set for specific locations </title>
|
636 |
<title>Parameters set for specific locations </title><variablelist>
|
| 637 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.MHMBOXQUIRKS">
|
637 |
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.MHMBOXQUIRKS">
|
| 638 |
<term><varname>mhmboxquirks</varname></term>
|
638 |
<term><varname>mhmboxquirks</varname></term>
|
| 639 |
<listitem><para>Enable thunderbird/mozilla-seamonkey mbox format quirks Set this for the directory where the email mbox files are
|
639 |
<listitem><para>Enable thunderbird/mozilla-seamonkey mbox format quirks Set this for the directory where the email mbox files are
|
| 640 |
stored.</para></listitem></varlistentry>
|
640 |
stored.</para></listitem></varlistentry>
|
| 641 |
</sect3>
|
641 |
</variablelist></sect3>
|
| 642 |
</sect2>
|
642 |
</sect2>
|