--- a/src/doc/user/usermanual.html
+++ b/src/doc/user/usermanual.html
@@ -1,35 +1,30 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-
+<!DOCTYPE html>
<html>
<head>
<meta name="generator" content=
- "HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
+ "HTML Tidy for HTML5 for Linux version 5.2.0">
<meta http-equiv="Content-Type" content=
- "text/html; charset=us-ascii">
-
+ "text/html; charset=utf-8">
<title>Recoll user manual</title>
<link rel="stylesheet" type="text/css" href="docbook-xsl.css">
- <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<meta name="description" content=
"Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found at the following location: GNU web site. This document introduces full text search notions and describes the installation and use of the Recoll application. This version describes Recoll 1.22.">
- </head>
-
+</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084"
alink="#0000FF">
<div lang="en" class="book">
<div class="titlepage">
<div>
<div>
- <h1 class="title"><a name="idm44986984150384" id=
- "idm44986984150384"></a>Recoll user manual</h1>
- </div>
-
+ <h1 class="title"><a name="idm1" id="idm1"></a>Recoll
+ user manual</h1>
+ </div>
<div>
<div class="author">
<h3 class="author"><span class=
"firstname">Jean-Francois</span> <span class=
"surname">Dockes</span></h3>
-
<div class="affiliation">
<div class="address">
<p><code class="email"><<a class="email" href=
@@ -38,12 +33,10 @@
</div>
</div>
</div>
-
<div>
- <p class="copyright">Copyright © 2005-2015
- Jean-Francois Dockes</p>
- </div>
-
+ <p class="copyright">Copyright ��� 2005-2015 Jean-Francois
+ Dockes</p>
+ </div>
<div>
<div class="abstract">
<p><code class="literal">Permission is granted to copy,
@@ -55,7 +48,6 @@
can be found at the following location: <a class=
"ulink" href="http://www.gnu.org/licenses/fdl.html"
target="_top">GNU web site</a>.</code></p>
-
<p>This document introduces full text search notions
and describes the installation and use of the
<span class="application">Recoll</span> application.
@@ -66,153 +58,120 @@
</div>
<hr>
</div>
-
<div class="toc">
<p><b>Table of Contents</b></p>
-
<dl class="toc">
<dt><span class="chapter">1. <a href=
"#RCL.INTRODUCTION">Introduction</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect1">1.1. <a href=
"#RCL.INTRODUCTION.TRYIT">Giving it a
try</a></span></dt>
-
<dt><span class="sect1">1.2. <a href=
"#RCL.INTRODUCTION.SEARCH">Full text
search</a></span></dt>
-
<dt><span class="sect1">1.3. <a href=
"#RCL.INTRODUCTION.RECOLL">Recoll
overview</a></span></dt>
</dl>
</dd>
-
<dt><span class="chapter">2. <a href=
"#RCL.INDEXING">Indexing</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect1">2.1. <a href=
"#RCL.INDEXING.INTRODUCTION">Introduction</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">2.1.1. <a href=
"#RCL.INDEXING.INTRODUCTION.MODES">Indexing
modes</a></span></dt>
-
<dt><span class="sect2">2.1.2. <a href=
"#RCL.INDEXING.INTRODUCTION.CONFIG">Configurations,
multiple indexes</a></span></dt>
-
<dt><span class="sect2">2.1.3. <a href=
- "#idm44986952097312">Document types</a></span></dt>
-
+ "#idm202">Document types</a></span></dt>
<dt><span class="sect2">2.1.4. <a href=
- "#idm44986952072736">Indexing
- failures</a></span></dt>
-
+ "#idm243">Indexing failures</a></span></dt>
<dt><span class="sect2">2.1.5. <a href=
- "#idm44986952065728">Recovery</a></span></dt>
+ "#idm255">Recovery</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">2.2. <a href=
"#RCL.INDEXING.STORAGE">Index storage</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">2.2.1. <a href=
"#RCL.INDEXING.STORAGE.FORMAT"><span class=
"application">Xapian</span> index
formats</a></span></dt>
-
<dt><span class="sect2">2.2.2. <a href=
"#RCL.INDEXING.STORAGE.SECURITY">Security
aspects</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">2.3. <a href=
"#RCL.INDEXING.CONFIG">Index
configuration</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">2.3.1. <a href=
"#RCL.INDEXING.CONFIG.MULTIPLE">Multiple
indexes</a></span></dt>
-
<dt><span class="sect2">2.3.2. <a href=
"#RCL.INDEXING.CONFIG.SENS">Index case and
diacritics sensitivity</a></span></dt>
-
<dt><span class="sect2">2.3.3. <a href=
"#RCL.INDEXING.CONFIG.THREADS">Indexing threads
configuration</a></span></dt>
-
<dt><span class="sect2">2.3.4. <a href=
"#RCL.INDEXING.CONFIG.GUI">The index configuration
GUI</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">2.4. <a href=
"#RCL.INDEXING.WEBQUEUE">Indexing WEB pages you
wisit</a></span></dt>
-
<dt><span class="sect1">2.5. <a href=
"#RCL.INDEXING.EXTATTR">Extended attributes
data</a></span></dt>
-
<dt><span class="sect1">2.6. <a href=
"#RCL.INDEXING.EXTTAGS">Importing external
tags</a></span></dt>
-
<dt><span class="sect1">2.7. <a href=
"#RCL.INDEXING.PDF">The PDF input
handler</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">2.7.1. <a href=
"#RCL.INDEXING.PDF.OCR">OCR with
Tesseract</a></span></dt>
-
<dt><span class="sect2">2.7.2. <a href=
"#RCL.INDEXING.PDF.XMP">XMP fields
extraction</a></span></dt>
-
<dt><span class="sect2">2.7.3. <a href=
"#RCL.INDEXING.PDF.ATTACH">PDF attachment
indexing</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">2.8. <a href=
"#RCL.INDEXING.PERIODIC">Periodic
indexing</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">2.8.1. <a href=
"#RCL.INDEXING.PERIODIC.EXEC">Running
indexing</a></span></dt>
-
<dt><span class="sect2">2.8.2. <a href=
"#RCL.INDEXING.PERIODIC.AUTOMAT">Using <span class=
"command"><strong>cron</strong></span> to automate
indexing</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">2.9. <a href=
"#RCL.INDEXING.MONITOR">Real time
indexing</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">2.9.1. <a href=
@@ -223,147 +182,115 @@
</dd>
</dl>
</dd>
-
<dt><span class="chapter">3. <a href=
"#RCL.SEARCH">Searching</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect1">3.1. <a href=
"#RCL.SEARCH.GUI">Searching with the Qt graphical user
interface</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">3.1.1. <a href=
"#RCL.SEARCH.GUI.SIMPLE">Simple
search</a></span></dt>
-
<dt><span class="sect2">3.1.2. <a href=
"#RCL.SEARCH.GUI.RESLIST">The default result
list</a></span></dt>
-
<dt><span class="sect2">3.1.3. <a href=
"#RCL.SEARCH.GUI.RESTABLE">The result
table</a></span></dt>
-
<dt><span class="sect2">3.1.4. <a href=
"#RCL.SEARCH.GUI.RUNSCRIPT">Running arbitrary
commands on result files (1.20 and
later)</a></span></dt>
-
<dt><span class="sect2">3.1.5. <a href=
"#RCL.SEARCH.GUI.THUMBNAILS">Displaying
thumbnails</a></span></dt>
-
<dt><span class="sect2">3.1.6. <a href=
"#RCL.SEARCH.GUI.PREVIEW">The preview
window</a></span></dt>
-
<dt><span class="sect2">3.1.7. <a href=
"#RCL.SEARCH.GUI.FRAGBUTS">The Query Fragments
window</a></span></dt>
-
<dt><span class="sect2">3.1.8. <a href=
"#RCL.SEARCH.GUI.COMPLEX">Complex/advanced
search</a></span></dt>
-
<dt><span class="sect2">3.1.9. <a href=
"#RCL.SEARCH.GUI.TERMEXPLORER">The term explorer
tool</a></span></dt>
-
<dt><span class="sect2">3.1.10. <a href=
"#RCL.SEARCH.GUI.MULTIDB">Multiple
indexes</a></span></dt>
-
<dt><span class="sect2">3.1.11. <a href=
"#RCL.SEARCH.GUI.HISTORY">Document
history</a></span></dt>
-
<dt><span class="sect2">3.1.12. <a href=
"#RCL.SEARCH.GUI.SORT">Sorting search results and
collapsing duplicates</a></span></dt>
-
<dt><span class="sect2">3.1.13. <a href=
"#RCL.SEARCH.GUI.TIPS">Search tips,
shortcuts</a></span></dt>
-
<dt><span class="sect2">3.1.14. <a href=
"#RCL.SEARCH.SAVING">Saving and restoring queries
(1.21 and later)</a></span></dt>
-
<dt><span class="sect2">3.1.15. <a href=
"#RCL.SEARCH.GUI.CUSTOM">Customizing the search
interface</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">3.2. <a href=
"#RCL.SEARCH.KIO">Searching with the KDE KIO
slave</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">3.2.1. <a href=
"#RCL.SEARCH.KIO.INTRO">What's this</a></span></dt>
-
<dt><span class="sect2">3.2.2. <a href=
"#RCL.SEARCH.KIO.SEARCHABLEDOCS">Searchable
documents</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">3.3. <a href=
"#RCL.SEARCH.COMMANDLINE">Searching on the command
line</a></span></dt>
-
<dt><span class="sect1">3.4. <a href=
"#RCL.SEARCH.SYNONYMS">Using Synonyms
(1.22)</a></span></dt>
-
<dt><span class="sect1">3.5. <a href=
"#RCL.SEARCH.PTRANS">Path translations</a></span></dt>
-
<dt><span class="sect1">3.6. <a href=
"#RCL.SEARCH.LANG">The query language</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">3.6.1. <a href=
"#RCL.SEARCH.LANG.MODIFIERS">Modifiers</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">3.7. <a href=
"#RCL.SEARCH.CASEDIAC">Search case and diacritics
sensitivity</a></span></dt>
-
<dt><span class="sect1">3.8. <a href=
"#RCL.SEARCH.ANCHORWILD">Anchored searches and
wildcards</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">3.8.1. <a href=
"#RCL.SEARCH.WILDCARDS">More about
wildcards</a></span></dt>
-
<dt><span class="sect2">3.8.2. <a href=
"#RCL.SEARCH.ANCHOR">Anchored
searches</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">3.9. <a href=
"#RCL.SEARCH.DESKTOP">Desktop
integration</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">3.9.1. <a href=
"#RCL.SEARCH.SHORTCUT">Hotkeying
recoll</a></span></dt>
-
<dt><span class="sect2">3.9.2. <a href=
"#RCL.KICKER-APPLET">The KDE Kicker Recoll
applet</a></span></dt>
@@ -371,65 +298,51 @@
</dd>
</dl>
</dd>
-
<dt><span class="chapter">4. <a href=
"#RCL.PROGRAM">Programming interface</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect1">4.1. <a href=
"#RCL.PROGRAM.FILTERS">Writing a document input
handler</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">4.1.1. <a href=
"#RCL.PROGRAM.FILTERS.SIMPLE">Simple input
handlers</a></span></dt>
-
<dt><span class="sect2">4.1.2. <a href=
"#RCL.PROGRAM.FILTERS.MULTIPLE">"Multiple"
handlers</a></span></dt>
-
<dt><span class="sect2">4.1.3. <a href=
"#RCL.PROGRAM.FILTERS.ASSOCIATION">Telling
<span class="application">Recoll</span> about the
handler</a></span></dt>
-
<dt><span class="sect2">4.1.4. <a href=
"#RCL.PROGRAM.FILTERS.HTML">Input handler
output</a></span></dt>
-
<dt><span class="sect2">4.1.5. <a href=
"#RCL.PROGRAM.FILTERS.PAGES">Page
numbers</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">4.2. <a href=
"#RCL.PROGRAM.FIELDS">Field data
processing</a></span></dt>
-
<dt><span class="sect1">4.3. <a href=
"#RCL.PROGRAM.PYTHONAPI">Python API</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">4.3.1. <a href=
"#RCL.PROGRAM.PYTHONAPI.INTRO">Introduction</a></span></dt>
-
<dt><span class="sect2">4.3.2. <a href=
"#RCL.PROGRAM.PYTHONAPI.ELEMENTS">Interface
elements</a></span></dt>
-
<dt><span class="sect2">4.3.3. <a href=
"#RCL.PROGRAM.PYTHONAPI.SEARCH">Python search
interface</a></span></dt>
-
<dt><span class="sect2">4.3.4. <a href=
"#RCL.PROGRAM.PYTHONAPI.UPDATE">Creating Python
external indexers</a></span></dt>
-
<dt><span class="sect2">4.3.5. <a href=
"#RCL.PROGRAM.PYTHONAPI.COMPAT">Package
compatibility with the previous
@@ -438,72 +351,56 @@
</dd>
</dl>
</dd>
-
<dt><span class="chapter">5. <a href=
"#RCL.INSTALL">Installation and
configuration</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect1">5.1. <a href=
"#RCL.INSTALL.BINARY">Installing a binary
copy</a></span></dt>
-
<dt><span class="sect1">5.2. <a href=
"#RCL.INSTALL.EXTERNAL">Supporting
packages</a></span></dt>
-
<dt><span class="sect1">5.3. <a href=
"#RCL.INSTALL.BUILDING">Building from
source</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">5.3.1. <a href=
"#RCL.INSTALL.BUILDING.PREREQS">Prerequisites</a></span></dt>
-
<dt><span class="sect2">5.3.2. <a href=
"#RCL.INSTALL.BUILDING.BUILD">Building</a></span></dt>
-
<dt><span class="sect2">5.3.3. <a href=
"#RCL.INSTALL.BUILDING.INSTALL">Installation</a></span></dt>
</dl>
</dd>
-
<dt><span class="sect1">5.4. <a href=
"#RCL.INSTALL.CONFIG">Configuration
overview</a></span></dt>
-
<dd>
<dl>
<dt><span class="sect2">5.4.1. <a href=
"#RCL.INSTALL.CONFIG.ENVIR">Environment
variables</a></span></dt>
-
<dt><span class="sect2">5.4.2. <a href=
"#RCL.INSTALL.CONFIG.RECOLLCONF">Recoll main
configuration file, recoll.conf</a></span></dt>
-
<dt><span class="sect2">5.4.3. <a href=
"#RCL.INSTALL.CONFIG.FIELDS">The fields
file</a></span></dt>
-
<dt><span class="sect2">5.4.4. <a href=
"#RCL.INSTALL.CONFIG.MIMEMAP">The mimemap
file</a></span></dt>
-
<dt><span class="sect2">5.4.5. <a href=
"#RCL.INSTALL.CONFIG.MIMECONF">The mimeconf
file</a></span></dt>
-
<dt><span class="sect2">5.4.6. <a href=
"#RCL.INSTALL.CONFIG.MIMEVIEW">The mimeview
file</a></span></dt>
-
<dt><span class="sect2">5.4.7. <a href=
"#RCL.INSTALL.CONFIG.PTRANS">The <code class=
"filename">ptrans</code> file</a></span></dt>
-
<dt><span class="sect2">5.4.8. <a href=
"#RCL.INSTALL.CONFIG.EXAMPLES">Examples of
configuration adjustments</a></span></dt>
@@ -513,22 +410,19 @@
</dd>
</dl>
</div>
-
<div class="chapter">
<div class="titlepage">
<div>
<div>
<h1 class="title"><a name="RCL.INTRODUCTION" id=
- "RCL.INTRODUCTION"></a>Chapter 1. Introduction</h1>
+ "RCL.INTRODUCTION"></a>Chapter���1.���Introduction</h1>
</div>
</div>
</div>
-
<p>This document introduces full text search notions and
describes the installation and use of the <span class=
"application">Recoll</span> application. This version
describes <span class="application">Recoll</span> 1.22.</p>
-
<p><span class="application">Recoll</span> was for a long
time dedicated to Unix-like systems. It was only lately
(2015) ported to <span class="application">MS-Windows</span>.
@@ -544,68 +438,61 @@
is stored by default under <code class=
"filename">AppData/Local/Recoll</code> inside the user
directory, along with the index itself.</p>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INTRODUCTION.TRYIT" id=
- "RCL.INTRODUCTION.TRYIT"></a>1.1. Giving it a
+ "RCL.INTRODUCTION.TRYIT"></a>1.1.���Giving it a
try</h2>
</div>
</div>
</div>
-
<p>If you do not like reading manuals (who does?) but wish
to give <span class="application">Recoll</span> a try, just
<a class="link" href="#RCL.INSTALL.BINARY" title=
- "5.1. Installing a binary copy">install</a> the
- application and start the <span class=
+ "5.1.���Installing a binary copy">install</a> the application
+ and start the <span class=
"command"><strong>recoll</strong></span> graphical user
interface (GUI), which will ask permission to index your
home directory by default, allowing you to search
immediately after indexing completes.</p>
-
<p>Do not do this if your home directory contains a huge
number of documents and you do not want to wait or are very
short on disk space. In this case, you may first want to
customize the <a class="link" href="#RCL.INDEXING.CONFIG"
- title="2.3. Index configuration">configuration</a> to
+ title="2.3.���Index configuration">configuration</a> to
restrict the indexed area (for the very impatient with a
completed package install, from the <span class=
"command"><strong>recoll</strong></span> GUI: <span class=
- "guimenu">Preferences</span> → <span class=
+ "guimenu">Preferences</span> ��� <span class=
"guimenuitem">Indexing configuration</span>, then adjust
the <span class="guilabel">Top directories</span>
section).</p>
-
<p>Also be aware that, on Unix/Linux, you may need to
install the appropriate <a class="link" href=
"#RCL.INSTALL.EXTERNAL" title=
- "5.2. Supporting packages">supporting applications</a>
- for document types that need them (for example <span class=
+ "5.2.���Supporting packages">supporting applications</a> for
+ document types that need them (for example <span class=
"application">antiword</span> for <span class=
"application">Microsoft Word</span> files).</p>
-
<p>The <span class="application">Recoll</span> installation
for <span class="application">Windows</span> is
self-contained and includes most useful auxiliary programs.
You will just need to install Python 2.7.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INTRODUCTION.SEARCH" id=
- "RCL.INTRODUCTION.SEARCH"></a>1.2. Full text
+ "RCL.INTRODUCTION.SEARCH"></a>1.2.���Full text
search</h2>
</div>
</div>
</div>
-
<p><span class="application">Recoll</span> is a full text
search application, which means that it finds your data by
content rather than by external attributes (like the file
@@ -614,13 +501,11 @@
return a list of matching documents, ordered so that the
most <span class="emphasis"><em>relevant</em></span>
documents will appear first.</p>
-
<p>You do not need to remember in what file or email
message you stored a given piece of information. You just
ask for related terms, and the tool will return a list of
documents where these terms are prominent, in a similar way
to Internet search engines.</p>
-
<p>Full text search applications try to determine which
documents are most relevant to the search terms you
provide. Computer algorithms for determining relevance can
@@ -628,7 +513,6 @@
of the human mind to rapidly determine relevance. The
quality of relevance guessing is probably the most
important aspect when evaluating a search application.</p>
-
<p>In many cases, you are looking for all the forms of a
word, including plurals, different tenses for a verb, or
terms derived from the same root or <span class=
@@ -638,7 +522,6 @@
expanded to all such related terms (words that reduce to
the same stem). This can be prevented for searching for a
specific form.</p>
-
<p>Stemming, by itself, does not accommodate for
misspellings or phonetic searches. A full text search
application may also support this form of approximation.
@@ -648,19 +531,17 @@
"replaceable"><code>alliteration alteration alterations
altercation</code></em> as possible replacement terms.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INTRODUCTION.RECOLL" id=
- "RCL.INTRODUCTION.RECOLL"></a>1.3. Recoll
+ "RCL.INTRODUCTION.RECOLL"></a>1.3.���Recoll
overview</h2>
</div>
</div>
</div>
-
<p><span class="application">Recoll</span> uses the
<a class="ulink" href="http://www.xapian.org" target=
"_top"><span class="application">Xapian</span></a>
@@ -669,7 +550,6 @@
mature package using <a class="ulink" href=
"http://www.xapian.org/docs/intro_ir.html" target="_top">a
sophisticated probabilistic ranking model</a>.</p>
-
<p>The <span class="application">Xapian</span> library
manages an index database which describes where terms
appear in your document files. It efficiently processes the
@@ -677,7 +557,6 @@
"application">Recoll</span> query expansion mechanism, and
is in charge of the all-important relevance computation
task.</p>
-
<p><span class="application">Recoll</span> provides the
mechanisms and interface to get data into and out of the
index. This includes translating the many possible document
@@ -686,12 +565,10 @@
spelling approximations (using the <span class=
"application">aspell</span> speller), interpreting user
queries and presenting results.</p>
-
<p>In a shorter way, <span class=
"application">Recoll</span> does the dirty footwork,
<span class="application">Xapian</span> deals with the
intelligent parts of the process.</p>
-
<p>The <span class="application">Xapian</span> index can be
big (roughly the size of the original document set), but it
is not a document archive. <span class=
@@ -701,7 +578,6 @@
the information in the index, but the result is not nice,
as all formatting, punctuation and capitalization are
lost).</p>
-
<p><span class="application">Recoll</span> stores all
internal data in <span class="application">Unicode
UTF-8</span> format, and it can index files of many types
@@ -710,7 +586,6 @@
inside other documents (for example a pdf document stored
inside a Zip archive sent as an email attachment...), down
to an arbitrary depth.</p>
-
<p>Stemming is the process by which <span class=
"application">Recoll</span> reduces words to their radicals
so that searching does not depend, for example, on a word
@@ -720,19 +595,16 @@
language, there is a separate <span class=
"application">Xapian</span> stemmer module for most common
languages where stemming makes sense.</p>
-
<p><span class="application">Recoll</span> stores the
unstemmed versions of terms in the main index and uses
auxiliary databases for term expansion (one for each
stemming language), which means that you can switch
stemming languages between searches, or add a language
without needing a full reindex.</p>
-
<p>Storing documents written in different languages in the
same index is possible, and commonly done. In this
situation, you can specify several stemming languages for
the index.</p>
-
<p><span class="application">Recoll</span> currently makes
no attempt at automatic language recognition, which means
that the stemmer will sometimes be applied to terms from
@@ -741,7 +613,6 @@
confusion, this approach has been proven quite useful, and
it is much less cumbersome than separating your documents
according to what language they are written in.</p>
-
<p>By default, <span class="application">Recoll</span>
strips most accents and diacritics from terms, and converts
them to lower case before either storing them in the index
@@ -750,10 +621,9 @@
(<code class="literal">US</code> / <code class=
"literal">us</code>), or to discriminate two terms based on
diacritics (<code class="literal">sake</code> /
- <code class="literal">saké</code>, <code class=
+ <code class="literal">sak���</code>, <code class=
"literal">mate</code> / <code class=
- "literal">maté</code>).</p>
-
+ "literal">mat���</code>).</p>
<p><span class="application">Recoll</span> versions 1.18
and newer can optionally store the raw terms, without
accent stripping or case conversion. In this configuration,
@@ -761,14 +631,13 @@
to perform searches sensitive to case and diacritics. This
is described in more detail in the <a class="link" href=
"#RCL.INDEXING.CONFIG.SENS" title=
- "2.3.2. Index case and diacritics sensitivity">section
+ "2.3.2.���Index case and diacritics sensitivity">section
about index case and diacritics sensitivity</a>.</p>
-
<p><span class="application">Recoll</span> has many
parameters which define exactly what to index, and how to
classify and decode the source documents. These are kept in
<a class="link" href="#RCL.INDEXING.CONFIG" title=
- "2.3. Index configuration">configuration files</a>. A
+ "2.3.���Index configuration">configuration files</a>. A
default configuration is copied into a standard location
(usually something like <code class=
"filename">/usr/share/recoll/examples</code>) during
@@ -787,10 +656,9 @@
"command"><strong>recoll</strong></span> GUI are stored in
the standard location defined by <span class=
"application">Qt</span>.</p>
-
<p>The <a class="link" href="#RCL.INDEXING.PERIODIC.EXEC"
- title="2.8.1. Running indexing">indexing process</a>
- is started automatically the first time you execute the
+ title="2.8.1.���Running indexing">indexing process</a> is
+ started automatically the first time you execute the
<span class="command"><strong>recoll</strong></span> GUI.
Indexing can also be performed by executing the
<span class="command"><strong>recollindex</strong></span>
@@ -799,22 +667,21 @@
resources are available, and can perform in parallel
multiple tasks among text extraction, segmentation and
index updates.</p>
-
<p><a class="link" href="#RCL.SEARCH" title=
- "Chapter 3. Searching">Searches</a> are usually
- performed inside the <span class=
+ "Chapter���3.���Searching">Searches</a> are usually performed
+ inside the <span class=
"command"><strong>recoll</strong></span> GUI, which has
many options to help you find what you are looking for.
However, there are other ways to perform <span class=
"application">Recoll</span> searches: mostly a <a class=
"link" href="#RCL.SEARCH.COMMANDLINE" title=
- "3.3. Searching on the command line">command line
+ "3.3.���Searching on the command line">command line
interface</a>, a <a class="link" href=
"#RCL.PROGRAM.PYTHONAPI" title=
- "4.3. Python API"><span class=
- "application">Python</span> programming interface</a>, a
- <a class="link" href="#RCL.SEARCH.KIO" title=
- "3.2. Searching with the KDE KIO slave"><span class=
+ "4.3.���Python API"><span class="application">Python</span>
+ programming interface</a>, a <a class="link" href=
+ "#RCL.SEARCH.KIO" title=
+ "3.2.���Searching with the KDE KIO slave"><span class=
"application">KDE</span> KIO slave module</a>, and Ubuntu
Unity <a class="ulink" href=
"https://bitbucket.org/medoc/unity-lens-recoll" target=
@@ -823,28 +690,25 @@
target="_top">Scope</a> (for current versions) modules.</p>
</div>
</div>
-
<div class="chapter">
<div class="titlepage">
<div>
<div>
<h1 class="title"><a name="RCL.INDEXING" id=
- "RCL.INDEXING"></a>Chapter 2. Indexing</h1>
+ "RCL.INDEXING"></a>Chapter���2.���Indexing</h1>
</div>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INDEXING.INTRODUCTION" id=
- "RCL.INDEXING.INTRODUCTION"></a>2.1. Introduction</h2>
- </div>
- </div>
- </div>
-
+ "RCL.INDEXING.INTRODUCTION"></a>2.1.���Introduction</h2>
+ </div>
+ </div>
+ </div>
<p>Indexing is the process by which the set of documents is
analyzed and the data entered into the database.
<span class="application">Recoll</span> indexing is
@@ -855,7 +719,6 @@
indexing command (<span class=
"command"><strong>recollindex</strong></span> <code class=
"option">-z</code> or <code class="option">-Z</code>).</p>
-
<p><span class=
"command"><strong>recollindex</strong></span> skips files
which caused an error during a previous pass. This is a
@@ -864,11 +727,9 @@
versions). The command line option <code class=
"option">-k</code> can be set to retry failed files, for
example after updating a filter.</p>
-
<p>The following sections give an overview of different
aspects of the indexing processes and configuration, with
links to detailed sections.</p>
-
<p>Depending on your data, temporary files may be needed
during indexing, some of them possibly quite big. You can
use the <code class="envar">RECOLL_TMPDIR</code> or
@@ -879,44 +740,40 @@
also be taken into account by auxiliary commands executed
by <span class=
"command"><strong>recollindex</strong></span>.</p>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.INTRODUCTION.MODES" id=
- "RCL.INDEXING.INTRODUCTION.MODES"></a>2.1.1. Indexing
+ "RCL.INDEXING.INTRODUCTION.MODES"></a>2.1.1.���Indexing
modes</h3>
</div>
</div>
</div>
-
<p><span class="application">Recoll</span> indexing can
be performed along two different modes:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
<li class="listitem">
<p><b><a class="link" href="#RCL.INDEXING.PERIODIC"
- title="2.8. Periodic indexing">Periodic (or
- batch) indexing:</a> </b>indexing takes place
- at discrete times, by executing the <span class=
+ title="2.8.���Periodic indexing">Periodic (or batch)
+ indexing:</a>���</b>indexing takes place at discrete
+ times, by executing the <span class=
"command"><strong>recollindex</strong></span>
command. The typical usage is to have a nightly
indexing run <a class="link" href=
"#RCL.INDEXING.PERIODIC.AUTOMAT" title=
- "2.8.2. Using cron to automate indexing">programmed</a>
+ "2.8.2.���Using cron to automate indexing">programmed</a>
into your <span class=
"command"><strong>cron</strong></span> file.</p>
</li>
-
<li class="listitem">
<p><b><a class="link" href="#RCL.INDEXING.MONITOR"
- title="2.9. Real time indexing">Real time
- indexing:</a> </b>indexing takes place as soon
- as a file is created or changed. <span class=
+ title="2.9.���Real time indexing">Real time
+ indexing:</a>���</b>indexing takes place as soon as a
+ file is created or changed. <span class=
"command"><strong>recollindex</strong></span> runs
as a daemon and uses a file system alteration
monitor such as <span class=
@@ -927,20 +784,17 @@
</li>
</ul>
</div>
-
<p>The choice between the two methods is mostly a matter
of preference, and they can be combined by setting up
multiple indexes (ie: use periodic indexing on a big
documentation directory, and real time indexing on a
small home directory). Monitoring a big file system tree
can consume significant system resources.</p>
-
<p>The choice of method and the parameters used can be
configured from the <span class=
"command"><strong>recoll</strong></span> GUI:
- <span class="guimenu">Preferences</span> →
- <span class="guimenuitem">Indexing schedule</span></p>
-
+ <span class="guimenu">Preferences</span> ��� <span class=
+ "guimenuitem">Indexing schedule</span></p>
<p>The <span class="guimenu">File</span> menu also has
entries to start or stop the current indexing operation.
Stopping indexing is performed by killing the
@@ -949,7 +803,6 @@
later restart of indexing will mostly resume from where
things stopped (the file tree walk has to be restarted
from the beginning).</p>
-
<p>When the real time indexer is running, only a stop
operation is available from the menu. When no indexing is
running, you have a choice of updating the index or
@@ -957,33 +810,28 @@
files, the second one zeroes the index before starting so
that all files are processed).</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.INTRODUCTION.CONFIG" id=
- "RCL.INDEXING.INTRODUCTION.CONFIG"></a>2.1.2. Configurations,
+ "RCL.INDEXING.INTRODUCTION.CONFIG"></a>2.1.2.���Configurations,
multiple indexes</h3>
</div>
</div>
</div>
-
<p>The parameters describing what is to be indexed and
local preferences are defined in text files contained in
a <a class="link" href="#RCL.INDEXING.CONFIG" title=
- "2.3. Index configuration">configuration
+ "2.3.���Index configuration">configuration
directory</a>.</p>
-
<p>All parameters have defaults, defined in system-wide
files.</p>
-
<p>Without further configuration, <span class=
"application">Recoll</span> will index all appropriate
files from your home directory, with a reasonable set of
defaults.</p>
-
<p>A default personal configuration directory
(<code class="filename">$HOME/.recoll/</code>) is created
when a <span class="application">Recoll</span> program is
@@ -993,7 +841,6 @@
variable, or giving the <code class="option">-c</code>
option to any of the <span class=
"application">Recoll</span> commands.</p>
-
<p>In some cases, it may be interesting to index
different areas of the file system to separate databases.
You can do this by using multiple configuration
@@ -1002,36 +849,29 @@
separate personal and shared indexes, or to take
advantage of the organization of your data to improve
search precision.</p>
-
<p>The generated indexes can be queried concurrently in a
transparent manner.</p>
-
<p>For index generation, multiple configurations are
totally independant from each other. When multiple
indexes need to be used for a single search, <a class=
"link" href="#RCL.INDEXING.CONFIG.MULTIPLE" title=
- "2.3.1. Multiple indexes">some parameters should be
+ "2.3.1.���Multiple indexes">some parameters should be
consistent among the configurations</a>.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a name="idm44986952097312" id=
- "idm44986952097312"></a>2.1.3. Document
- types</h3>
- </div>
- </div>
- </div>
-
+ <h3 class="title"><a name="idm202" id=
+ "idm202"></a>2.1.3.���Document types</h3>
+ </div>
+ </div>
+ </div>
<p><span class="application">Recoll</span> knows about
quite a few different document types. The parameters for
document types recognition and processing are set in
<a class="link" href="#RCL.INDEXING.CONFIG" title=
- "2.3. Index configuration">configuration
- files</a>.</p>
-
+ "2.3.���Index configuration">configuration files</a>.</p>
<p>Most file types, like HTML or word processing files,
only hold one document. Some file types, like email
folders or zip archives, can hold many individually
@@ -1041,27 +881,24 @@
<span class="application">LibreOffice</span> document
stored as an attachment to an email message inside an
email folder archived in a zip file...</p>
-
<p><span class="application">Recoll</span> indexing
processes plain text, HTML, OpenDocument
(Open/LibreOffice), email formats, and a few others
internally.</p>
-
<p>Other file types (ie: postscript, pdf, ms-word, rtf
...) need external applications for preprocessing. The
list is in the <a class="link" href=
"#RCL.INSTALL.EXTERNAL" title=
- "5.2. Supporting packages">installation</a> section.
+ "5.2.���Supporting packages">installation</a> section.
After every indexing operation, <span class=
"application">Recoll</span> updates a list of commands
that would be needed for indexing existing files types.
This list can be displayed by selecting the menu option
- <span class="guimenu">File</span> → <span class=
+ <span class="guimenu">File</span> ��� <span class=
"guimenuitem">Show Missing Helpers</span> in the
<span class="command"><strong>recoll</strong></span> GUI.
It is stored in the <code class="filename">missing</code>
text file inside the configuration directory.</p>
-
<p>By default, <span class="application">Recoll</span>
will try to index any file type that it has a way to
read. This is sometimes not desirable, and there are ways
@@ -1069,11 +906,9 @@
define a positive list of types to be indexed. In the
latter case, any type not in the list will be
ignored.</p>
-
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note about MIME types</h3>
-
<p>When editing the <code class=
"literal">indexedmimetypes</code> or <code class=
"literal">excludedmimetypes</code> lists, you should
@@ -1086,7 +921,6 @@
the extension is not listed in <code class=
"filename">mimemap</code></p>
</div>
-
<p>Excluding types can be done by adding wildcard name
patterns to the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES">skippedNames</a>
@@ -1096,7 +930,6 @@
"#RCL.INSTALL.CONFIG.RECOLLCONF.EXCLUDEDMIMETYPES">excludedmimetypes</a>
list in the configuration file. This can be redefined for
subdirectories.</p>
-
<p>You can also define an exclusive list of MIME types to
be indexed (no others will be indexed), by settting the
<a class="link" href=
@@ -1104,47 +937,38 @@
configuration variable. Example:</p>
<pre class="programlisting">
indexedmimetypes = text/html application/pdf
-
-</pre>
-
+ </pre>
<p>It is possible to redefine this parameter for
subdirectories. Example:</p>
<pre class="programlisting">
[/path/to/my/dir]
indexedmimetypes = application/pdf
-
-</pre>
-
+ </pre>
<p>(When using sections like this, don't forget that they
remain in effect until the end of the file or another
section indicator).</p>
-
<p><code class="literal">excludedmimetypes</code> or
<code class="literal">indexedmimetypes</code>, can be set
either by editing the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF" title=
- "5.4.2. Recoll main configuration file, recoll.conf">
- main configuration file (<code class=
+ "5.4.2.���Recoll main configuration file, recoll.conf">main
+ configuration file (<code class=
"filename">recoll.conf</code>)</a>, or from the GUI index
configuration tool.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a name="idm44986952072736" id=
- "idm44986952072736"></a>2.1.4. Indexing
- failures</h3>
- </div>
- </div>
- </div>
-
+ <h3 class="title"><a name="idm243" id=
+ "idm243"></a>2.1.4.���Indexing failures</h3>
+ </div>
+ </div>
+ </div>
<p>Indexing may fail for some documents, for a number of
reasons: a helper program may be missing, the document
may be corrupt, we may fail to uncompress a file because
no file system space is available, etc.</p>
-
<p><span class="application">Recoll</span> versions prior
to 1.21 always retried to index files which had
previously caused an error. This guaranteed that anything
@@ -1153,7 +977,6 @@
was bad for performance because some indexing failures
may be quite costly (for example failing to uncompress a
big file because of insufficient disk space).</p>
-
<p>The indexer in <span class="application">Recoll</span>
versions 1.21 and later does not retry failed file by
default. Retrying will only occur if an explicit option
@@ -1169,43 +992,38 @@
<code class="filename">bin</code> directories have
changed.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a name="idm44986952065728" id=
- "idm44986952065728"></a>2.1.5. Recovery</h3>
- </div>
- </div>
- </div>
-
+ <h3 class="title"><a name="idm255" id=
+ "idm255"></a>2.1.5.���Recovery</h3>
+ </div>
+ </div>
+ </div>
<p>In the rare case where the index becomes corrupted
(which can signal itself by weird search results or
crashes), the index files need to be erased before
restarting a clean indexing pass. Just delete the
<code class="filename">xapiandb</code> directory (see
<a class="link" href="#RCL.INDEXING.STORAGE" title=
- "2.2. Index storage">next section</a>), or,
+ "2.2.���Index storage">next section</a>), or,
alternatively, start the next <span class=
"command"><strong>recollindex</strong></span> with the
<code class="option">-z</code> option, which will reset
the database before indexing.</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INDEXING.STORAGE" id=
- "RCL.INDEXING.STORAGE"></a>2.2. Index
- storage</h2>
- </div>
- </div>
- </div>
-
+ "RCL.INDEXING.STORAGE"></a>2.2.���Index storage</h2>
+ </div>
+ </div>
+ </div>
<p>The default location for the index data is the
<code class="filename">xapiandb</code> subdirectory of the
<span class="application">Recoll</span> configuration
@@ -1213,7 +1031,6 @@
"filename">$HOME/.recoll/xapiandb/</code>. This can be
changed via two different methods (with different
purposes):</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -1227,9 +1044,7 @@
indexes. For example, if you were to issue the
following command:</p>
<pre class="programlisting">
-recoll -c ~/.indexes-email
-</pre>
-
+ recoll -c ~/.indexes-email</pre>
<p>Then <span class="application">Recoll</span> would
use configuration files stored in <code class=
"filename">~/.indexes-email/</code> and, (unless
@@ -1237,17 +1052,15 @@
"filename">recoll.conf</code>) would look for the
index in <code class=
"filename">~/.indexes-email/xapiandb/</code>.</p>
-
<p>Using multiple configuration directories and
<a class="link" href="#RCL.INSTALL.CONFIG.RECOLLCONF"
title=
- "5.4.2. Recoll main configuration file, recoll.conf">
- configuration options</a> allows you to tailor
- multiple configurations and indexes to handle
- whatever subset of the available data you wish to
- make searchable.</p>
+ "5.4.2.���Recoll main configuration file, recoll.conf">configuration
+ options</a> allows you to tailor multiple
+ configurations and indexes to handle whatever subset
+ of the available data you wish to make
+ searchable.</p>
</li>
-
<li class="listitem">
<p>For a given configuration directory, you can
specify a non-default storage location for the index
@@ -1255,16 +1068,15 @@
parameter in the configuration file (see the
<a class="link" href="#RCL.INSTALL.CONFIG.RECOLLCONF"
title=
- "5.4.2. Recoll main configuration file, recoll.conf">
- configuration section</a>). This method would mainly
- be of use if you wanted to keep the configuration
- directory in its default location, but desired
- another location for the index, typically out of disk
- occupation concerns.</p>
+ "5.4.2.���Recoll main configuration file, recoll.conf">configuration
+ section</a>). This method would mainly be of use if
+ you wanted to keep the configuration directory in its
+ default location, but desired another location for
+ the index, typically out of disk occupation
+ concerns.</p>
</li>
</ul>
</div>
-
<p>The size of the index is determined by the size of the
set of documents, but the ratio can vary a lot. For a
typical mixed set of documents, the index size will often
@@ -1274,37 +1086,32 @@
if the documents contain a lot of images or other
non-indexed data (an extreme example being a set of mp3
files where only the tags would be indexed).</p>
-
<p>Of course, images, sound and video do not increase the
index size, which means that nowadays (2012), typically,
even a big index will be negligible against the total
amount of data on the computer.</p>
-
<p>The index data directory (<code class=
"filename">xapiandb</code>) only contains data that can be
completely rebuilt by an index run (as long as the original
documents exist), and it can always be destroyed
safely.</p>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.STORAGE.FORMAT" id=
- "RCL.INDEXING.STORAGE.FORMAT"></a>2.2.1. <span class="application">Xapian</span>
+ "RCL.INDEXING.STORAGE.FORMAT"></a>2.2.1.���<span class="application">Xapian</span>
index formats</h3>
</div>
</div>
</div>
-
<p><span class="application">Xapian</span> versions
usually support several formats for index storage. A
given major <span class="application">Xapian</span>
version will have a current format, used to create new
indexes, and will also support the format from the
previous major version.</p>
-
<p><span class="application">Xapian</span> will not
convert automatically an existing index from the older
format to the newer one. If you want to upgrade to the
@@ -1312,7 +1119,6 @@
because its format is not supported any more, you will
have to explicitly delete the old index, then run a
normal indexing process.</p>
-
<p>Using the <code class="option">-z</code> option to
<span class="command"><strong>recollindex</strong></span>
is not sufficient to change the format, you will have to
@@ -1320,31 +1126,27 @@
<code class="filename">~/.recoll/xapiandb</code>) before
starting the indexing.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.STORAGE.SECURITY" id=
- "RCL.INDEXING.STORAGE.SECURITY"></a>2.2.2. Security
+ "RCL.INDEXING.STORAGE.SECURITY"></a>2.2.2.���Security
aspects</h3>
</div>
</div>
</div>
-
<p>The <span class="application">Recoll</span> index does
not hold copies of the indexed documents. But it does
hold enough data to allow for an almost complete
reconstruction. If confidential data is indexed, access
to the database directory should be restricted.</p>
-
<p><span class="application">Recoll</span> will create
the configuration directory with a mode of 0700 (access
by owner only). As the index data directory is by default
a sub-directory of the configuration directory, this
should result in appropriate protection.</p>
-
<p>If you use another setup, you should think of the kind
of protection you need for your index, set the directory
and files access modes appropriately, and also maybe
@@ -1352,31 +1154,28 @@
index updates.</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INDEXING.CONFIG" id=
- "RCL.INDEXING.CONFIG"></a>2.3. Index
+ "RCL.INDEXING.CONFIG"></a>2.3.���Index
configuration</h2>
</div>
</div>
</div>
-
<p>Variables set inside the <a class="link" href=
"#RCL.INSTALL.CONFIG" title=
- "5.4. Configuration overview"><span class=
+ "5.4.���Configuration overview"><span class=
"application">Recoll</span> configuration files</a> control
which areas of the file system are indexed, and how files
are processed. These variables can be set either by editing
the text files or by using the <a class="link" href=
"#RCL.INDEXING.CONFIG.GUI" title=
- "2.3.4. The index configuration GUI">dialogs in the
+ "2.3.4.���The index configuration GUI">dialogs in the
<span class="command"><strong>recoll</strong></span>
GUI</a>.</p>
-
<p>The first time you start <span class=
"command"><strong>recoll</strong></span>, you will be asked
whether or not you would like it to build the index. If you
@@ -1387,11 +1186,10 @@
will have created a <code class="filename">~/.recoll</code>
directory containing empty configuration files, which you
can edit by hand.</p>
-
<p>The configuration is documented inside the <a class=
"link" href="#RCL.INSTALL.CONFIG" title=
- "5.4. Configuration overview">installation chapter</a>
- of this document, or in the <span class=
+ "5.4.���Configuration overview">installation chapter</a> of
+ this document, or in the <span class=
"citerefentry"><span class=
"refentrytitle">recoll.conf</span>(5)</span> man page, but
the most current information will most likely be the
@@ -1401,31 +1199,27 @@
"#RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS"><code class=
"varname">topdirs</code></a>, which determines what
subtrees get indexed.</p>
-
<p>The applications needed to index file types other than
text, HTML or email (ie: pdf, postscript, ms-word...) are
described in the <a class="link" href=
"#RCL.INSTALL.EXTERNAL" title=
- "5.2. Supporting packages">external packages
+ "5.2.���Supporting packages">external packages
section.</a></p>
-
<p>As of Recoll 1.18 there are two incompatible types of
Recoll indexes, depending on the treatment of character
case and diacritics. The next section describes the two
types in more detail.</p>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.CONFIG.MULTIPLE" id=
- "RCL.INDEXING.CONFIG.MULTIPLE"></a>2.3.1. Multiple
+ "RCL.INDEXING.CONFIG.MULTIPLE"></a>2.3.1.���Multiple
indexes</h3>
</div>
</div>
</div>
-
<p>Multiple <span class="application">Recoll</span>
indexes can be created by using several configuration
directories which are usually set to index different
@@ -1436,7 +1230,6 @@
<span class="command"><strong>recoll</strong></span> and
<span class=
"command"><strong>recollindex</strong></span>.</p>
-
<p>When working with the <span class=
"command"><strong>recoll</strong></span> index
configuration GUI, the configuration directory for which
@@ -1444,14 +1237,12 @@
<code class="envar">RECOLL_CONFDIR</code> or the
<code class="option">-c</code> parameter, and there is no
way to switch configurations within the GUI.</p>
-
<p>Additional configuration directory (beyond
<code class="filename">~/.recoll</code>) must be created
by hand (<span class=
"command"><strong>mkdir</strong></span> or such), the GUI
will not do it. This is to avoid mistakenly creating
additional directories when an argument is mistyped.</p>
-
<p>A typical usage scenario for the multiple index
feature would be for a system administrator to set up a
central index for shared data, that you choose to search
@@ -1463,21 +1254,17 @@
directory filter in advanced search, but multiple indexes
will have much better performance and may be worth the
trouble.</p>
-
<p>A <span class=
"command"><strong>recollindex</strong></span> program
instance can only update one specific index.</p>
-
<p>The main index (defined by <code class=
"envar">RECOLL_CONFDIR</code> or <code class=
"option">-c</code>) is always active. If this is
undesirable, you can set up your base configuration to
index an empty directory.</p>
-
<p>The different search interfaces (GUI, command line,
...) have different methods to define the set of indexes
to be used, see the appropriate section.</p>
-
<p>If a set of multiple indexes are to be used together
for searches, some configuration parameters must be
consistent among the set. These are parameters which need
@@ -1486,56 +1273,50 @@
searching, they need to be compatible with what was set
when creating the other indexes (which came from their
respective configuration directories).</p>
-
<p>Most importantly, all indexes to be queried
concurrently must have the same option concerning
character case and diacritics stripping, but there are
other constraints. Most of the relevant parameters are
described in the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.TERMS" title=
- "5.4.2.2. Parameters affecting how we generate terms">
- linked section</a>.</p>
- </div>
-
+ "5.4.2.2.���Parameters affecting how we generate terms">linked
+ section</a>.</p>
+ </div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.CONFIG.SENS" id=
- "RCL.INDEXING.CONFIG.SENS"></a>2.3.2. Index
- case and diacritics sensitivity</h3>
- </div>
- </div>
- </div>
-
+ "RCL.INDEXING.CONFIG.SENS"></a>2.3.2.���Index case
+ and diacritics sensitivity</h3>
+ </div>
+ </div>
+ </div>
<p>As of <span class="application">Recoll</span> version
1.18 you have a choice of building an index with terms
stripped of character case and diacritics, or one with
raw terms. For a source term of <code class=
- "literal">Résumé</code>, the former will
- store <code class="literal">resume</code>, the latter
- <code class="literal">Résumé</code>.</p>
-
+ "literal">R���sum���</code>, the former will store
+ <code class="literal">resume</code>, the latter
+ <code class="literal">R���sum���</code>.</p>
<p>Each type of index allows performing searches
insensitive to case and diacritics: with a raw index, the
user entry will be expanded to match all case and
diacritics variations present in the index. With a
stripped index, the search term will be stripped before
searching.</p>
-
<p>A raw index allows for another possibility which a
stripped index cannot offer: using case and diacritics to
discriminate between terms, returning different results
when searching for <code class="literal">US</code> and
<code class="literal">us</code> or <code class=
"literal">resume</code> and <code class=
- "literal">résumé</code>. Read the <a class=
- "link" href="#RCL.SEARCH.CASEDIAC" title=
- "3.7. Search case and diacritics sensitivity">section
+ "literal">r���sum���</code>. Read the <a class="link" href=
+ "#RCL.SEARCH.CASEDIAC" title=
+ "3.7.���Search case and diacritics sensitivity">section
about search case and diacritics sensitivity</a> for more
details.</p>
-
<p>The type of index to be created is controlled by the
<code class="literal">indexStripChars</code>
configuration variable which can only be changed by
@@ -1544,37 +1325,32 @@
"application">Recoll</span>), and all indexes in a search
must be set in the same way (again, not checked by
<span class="application">Recoll</span>).</p>
-
<p>If the <code class="literal">indexStripChars</code> is
not set, <span class="application">Recoll</span> 1.18
creates a stripped index by default, for compatibility
with previous versions.</p>
-
<p>As a cost for added capability, a raw index will be
slightly bigger than a stripped one (around 10%). Also,
searches will be more complex, so probably slightly
slower, and the feature is still young, so that a certain
amount of weirdness cannot be excluded.</p>
-
<p>One of the most adverse consequence of using a raw
index is that some phrase and proximity searches may
become impossible: because each term needs to be
expanded, and all combinations searched for, the
multiplicative expansion may become unmanageable.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.CONFIG.THREADS" id=
- "RCL.INDEXING.CONFIG.THREADS"></a>2.3.3. Indexing
+ "RCL.INDEXING.CONFIG.THREADS"></a>2.3.3.���Indexing
threads configuration</h3>
</div>
</div>
</div>
-
<p>The <span class="application">Recoll</span> indexing
process <span class=
"command"><strong>recollindex</strong></span> can use
@@ -1582,37 +1358,29 @@
systems. The work done to index files is divided in
several stages and some of the stages can be executed by
multiple threads. The stages are:</p>
-
<div class="orderedlist">
<ol class="orderedlist" type="1">
<li class="listitem">File system walking: this is
always performed by the main thread.</li>
-
<li class="listitem">File conversion and data
extraction.</li>
-
<li class="listitem">Text processing (splitting,
stemming, etc.)</li>
-
<li class="listitem"><span class=
"application">Xapian</span> index update.</li>
</ol>
</div>
-
<p>You can also read a <a class="ulink" href=
"http://www.recoll.org/idxthreads/threadingRecoll.html"
target="_top">longer document</a> about the
transformation of <span class="application">Recoll</span>
indexing to multithreading.</p>
-
<p>The threads configuration is controlled by two
configuration file parameters.</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term"><code class=
"varname">thrQSizes</code></span></dt>
-
<dd>
<p>This variable defines the job input queues
configuration. There are three possible queues for
@@ -1628,10 +1396,8 @@
this case, thrTCounts is not used) - this is the
default configuration.</p>
</dd>
-
<dt><span class="term"><code class=
"varname">thrTCounts</code></span></dt>
-
<dd>
<p>This defines the number of threads used for each
stage. If a value of -1 is used for one of the
@@ -1644,16 +1410,13 @@
</dd>
</dl>
</div>
-
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-
<p>If the first value in <code class=
"varname">thrQSizes</code> is 0, <code class=
"varname">thrTCounts</code> is ignored.</p>
</div>
-
<p>The following example would use three queues (of depth
2), and 4 threads for converting source documents, 2 for
processing their text, and one to update the index. This
@@ -1663,7 +1426,6 @@
thrQSizes = 2 2 2
thrTCounts = 4 2 1
</pre>
-
<p>The following example would use a single queue, and
the complete processing for each document would be
performed by a single thread (several documents will
@@ -1678,46 +1440,40 @@
thrQSizes = 2 -1 -1
thrTCounts = 6 1 1
</pre>
-
<p>The following example would disable multithreading.
Indexing will be performed by a single thread.</p>
<pre class="programlisting">
thrQSizes = -1 -1 -1
</pre>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.INDEXING.CONFIG.GUI"
- id="RCL.INDEXING.CONFIG.GUI"></a>2.3.4. The
- index configuration GUI</h3>
- </div>
- </div>
- </div>
-
+ id="RCL.INDEXING.CONFIG.GUI"></a>2.3.4.���The index
+ configuration GUI</h3>
+ </div>
+ </div>
+ </div>
<p>Most parameters for a given index configuration can be
set from a <span class=
"command"><strong>recoll</strong></span> GUI running on
this configuration (either as default, or by setting
<code class="envar">RECOLL_CONFDIR</code> or the
<code class="option">-c</code> option.)</p>
-
<p>The interface is started from the <span class=
- "guimenu">Preferences</span> → <span class=
+ "guimenu">Preferences</span> ��� <span class=
"guimenuitem">Index Configuration</span> menu entry. It
is divided in four tabs, <span class="guilabel">Global
parameters</span>, <span class="guilabel">Local
parameters</span>, <span class="guilabel">Web
history</span> (which is explained in the next section)
and <span class="guilabel">Search parameters</span>.</p>
-
<p>The <span class="guilabel">Global parameters</span>
tab allows setting global variables, like the lists of
top directories, skipped paths, or stemming
languages.</p>
-
<p>The <span class="guilabel">Local parameters</span> tab
allows setting variables that can be redefined for
subdirectories. This second tab has an initially empty
@@ -1725,20 +1481,17 @@
The variables are then set for the currently selected
directory (or at the top level if the empty line is
selected).</p>
-
<p>The <span class="guilabel">Search parameters</span>
section defines parameters which are used at query time,
but are global to an index and affect all search tools,
not only the GUI.</p>
-
<p>The meaning for most entries in the interface is
self-evident and documented by a <code class=
"literal">ToolTip</code> popup on the text label. For
more detail, you will need to refer to the <a class=
"link" href="#RCL.INSTALL.CONFIG" title=
- "5.4. Configuration overview">configuration
- section</a> of this guide.</p>
-
+ "5.4.���Configuration overview">configuration section</a>
+ of this guide.</p>
<p>The configuration tool normally respects the comments
and most of the formatting inside the configuration file,
so that it is quite possible to use it on hand-edited
@@ -1746,19 +1499,17 @@
first...</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INDEXING.WEBQUEUE" id=
- "RCL.INDEXING.WEBQUEUE"></a>2.4. Indexing WEB
- pages you wisit</h2>
- </div>
- </div>
- </div>
-
+ "RCL.INDEXING.WEBQUEUE"></a>2.4.���Indexing WEB pages
+ you wisit</h2>
+ </div>
+ </div>
+ </div>
<p>With the help of a <span class=
"application">Firefox</span> extension, <span class=
"application">Recoll</span> can index the Internet pages
@@ -1766,23 +1517,19 @@
the <span class="application">Beagle</span> indexer, but it
has recently be renamed and better adapted to <span class=
"application">Recoll</span>.</p>
-
<p>The extension works by copying visited WEB pages to an
indexing queue directory, which <span class=
"application">Recoll</span> then processes, indexing the
data, storing it into a local cache, then removing the file
from the queue.</p>
-
<p>This feature can be enabled in the GUI <span class=
"guilabel">Index configuration</span> panel, or by editing
the configuration file (set <code class=
"varname">processwebqueue</code> to 1).</p>
-
<p>A current pointer to the extension can be found, along
with up-to-date instructions, on the <a class="ulink" href=
"https://www.lesbonscomptes.com/recoll/faqsandhowtos/IndexWebHistory"
target="_top">Recoll wiki</a>.</p>
-
<p>A copy of the indexed WEB pages is retained by Recoll in
a local cache (from which previews can be fetched). The
cache size can be adjusted from the <span class=
@@ -1793,106 +1540,86 @@
explicitly archive in some other place the pages that you
want to keep indefinitely.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INDEXING.EXTATTR" id=
- "RCL.INDEXING.EXTATTR"></a>2.5. Extended
- attributes data</h2>
- </div>
- </div>
- </div>
-
+ "RCL.INDEXING.EXTATTR"></a>2.5.���Extended attributes
+ data</h2>
+ </div>
+ </div>
+ </div>
<p>User extended attributes are named pieces of information
that most modern file systems can attach to any file.</p>
-
<p><span class="application">Recoll</span> versions 1.19
and later process extended attributes as document fields by
default. For older versions, this has to be activated at
build time.</p>
-
<p>A <a class="ulink" href=
"http://www.freedesktop.org/wiki/CommonExtendedAttributes"
target="_top">freedesktop standard</a> defines a few
special attributes, which are handled as such by
<span class="application">Recoll</span>:</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">mime_type</span></dt>
-
<dd>
<p>If set, this overrides any other determination of
the file MIME type.</p>
</dd>
-
<dt><span class="term">charset</span></dt>
-
<dd>If set, this defines the file character set (mostly
useful for plain text files).</dd>
</dl>
</div>
-
<p>By default, other attributes are handled as <span class=
"application">Recoll</span> fields. On Linux, the
<code class="literal">user</code> prefix is removed from
the name. This can be configured more precisely inside the
<a class="link" href="#RCL.INSTALL.CONFIG.FIELDS" title=
- "5.4.3. The fields file"><code class=
+ "5.4.3.���The fields file"><code class=
"filename">fields</code> configuration file</a>.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INDEXING.EXTTAGS" id=
- "RCL.INDEXING.EXTTAGS"></a>2.6. Importing
- external tags</h2>
- </div>
- </div>
- </div>
-
+ "RCL.INDEXING.EXTTAGS"></a>2.6.���Importing external
+ tags</h2>
+ </div>
+ </div>
+ </div>
<p>During indexing, it is possible to import metadata for
each file by executing commands. For example, this could
extract user tag data for the file and store it in a field
for indexing.</p>
-
<p>See the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.METADATACMDS">section about
the <code class="literal">metadatacmds</code> field</a> in
the main configuration chapter for a description of the
configuration syntax.</p>
-
<p>As an example, if you would want <span class=
"application">Recoll</span> to use tags managed by
<span class="application">tmsu</span>, you would add the
following to the configuration file:</p>
- <pre class="programlisting">
-[/some/area/of/the/fs]
+ <pre class="programlisting">[/some/area/of/the/fs]
metadatacmds = ; tags = tmsu tags %f
-
-</pre>
-
+ </pre>
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-
<p>Depending on the <span class="application">tmsu</span>
version, you may need/want to add options like
<code class="literal">--database=/some/db</code>.</p>
</div>
-
<p>You may want to restrict this processing to a subset of
the directory tree, because it may slow down indexing a bit
(<code class="literal">[some/area/of/the/fs]</code>).</p>
-
<p>Note the initial semi-colon after the equal sign.</p>
-
<p>In the example above, the output of <span class=
"command"><strong>tmsu</strong></span> is used to set a
field named <code class="literal">tags</code>. The field
@@ -1905,9 +1632,7 @@
"command"><strong>tmsu</strong></span> output will just
augment its contents. This will avoid the need to extend
the <a class="link" href="#RCL.PROGRAM.FIELDS" title=
- "4.2. Field data processing">field
- configuration</a>.</p>
-
+ "4.2.���Field data processing">field configuration</a>.</p>
<p>Once re-indexing is performed (you'll need to force the
file reindexing, <span class="application">Recoll</span>
will not detect the need by itself), you will be able to
@@ -1919,7 +1644,6 @@
<code class="literal">tags:</code> specifier for each term,
e.g. <code class="literal">tags:some OR
tags:alternate</code>).</p>
-
<p>You should be aware that tags changes will not be
detected by the indexer if the file itself did not change.
One possible workaround would be to update the file
@@ -1932,25 +1656,21 @@
<code class="literal">recollindex -e -i
filename.</code></p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
- "RCL.INDEXING.PDF" id=
- "RCL.INDEXING.PDF"></a>2.7. The PDF input
- handler</h2>
- </div>
- </div>
- </div>
-
+ "RCL.INDEXING.PDF" id="RCL.INDEXING.PDF"></a>2.7.���The
+ PDF input handler</h2>
+ </div>
+ </div>
+ </div>
<p>The PDF format is very important for scientific and
technical documentation, and document archival. It has
extensive facilities for storing metadata along with the
document, and these facilities are actually used in the
real world.</p>
-
<p>In consequence, the <code class=
"filename">rclpdf.py</code> PDF input handler has more
complex capabilities than most others, and it is also more
@@ -1960,18 +1680,16 @@
if the document text is empty, it can be configured to
extract specific metadata tags from an XMP packet, and to
extract PDF attachments.</p>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.INDEXING.PDF.OCR"
- id="RCL.INDEXING.PDF.OCR"></a>2.7.1. OCR with
+ id="RCL.INDEXING.PDF.OCR"></a>2.7.1.���OCR with
Tesseract</h3>
</div>
</div>
</div>
-
<p>If both <span class="application">tesseract</span> and
<span class="command"><strong>pdftoppm</strong></span>
(generally from the <span class=
@@ -1982,7 +1700,6 @@
"#RCL.INSTALL.CONFIG.RECOLLCONF.PDFOCR">pdfocr</a>
configuration variable, which is false by default because
OCR is very slow.</p>
-
<p>The choice of language is very important for
successfull OCR. Recoll has currently no way to determine
this from the document itself. You can set the language
@@ -1996,18 +1713,16 @@
<span class="application">Recoll</span> will try to guess
the language from the NLS environment.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.INDEXING.PDF.XMP"
- id="RCL.INDEXING.PDF.XMP"></a>2.7.2. XMP
- fields extraction</h3>
- </div>
- </div>
- </div>
-
+ id="RCL.INDEXING.PDF.XMP"></a>2.7.2.���XMP fields
+ extraction</h3>
+ </div>
+ </div>
+ </div>
<p>The <code class="filename">rclpdf.py</code> script in
<span class="application">Recoll</span> version 1.23.2
and later can extract XMP metadata fields by executing
@@ -2018,15 +1733,13 @@
"#RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETA">pdfextrameta</a>
configuration variable, which specifies which tags to
extract and, possibly, how to rename them.</p>
-
<p>The <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETAFIX">pdfextrametafix</a>
variable can be used to designate a file with Python code
to edit the metadata fields (available for <span class=
"application">Recoll</span> 1.23.3 and later. 1.23.2 has
equivalent code inside the handler script). Example:</p>
- <pre class="programlisting">
-import sys
+ <pre class="programlisting">import sys
import re
class MetaFixer(object):
@@ -2046,9 +1759,7 @@
return txt
def wrapup(self, metaheaders):
pass
-
-</pre>
-
+ </pre>
<p>If the 'metafix()' method is defined, it is called for
each metadata field. A new MetaFixer object is created
for each PDF document (so the object can keep state for,
@@ -2059,18 +1770,16 @@
alternate approach for editing or adding/deleting
fields.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.INDEXING.PDF.ATTACH"
- id="RCL.INDEXING.PDF.ATTACH"></a>2.7.3. PDF
+ id="RCL.INDEXING.PDF.ATTACH"></a>2.7.3.���PDF
attachment indexing</h3>
</div>
</div>
</div>
-
<p>If <span class="application">pdftk</span> is
installed, and if the the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.PDFATTACH">pdfattach</a>
@@ -2082,31 +1791,28 @@
uncommon in my experience).</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INDEXING.PERIODIC" id=
- "RCL.INDEXING.PERIODIC"></a>2.8. Periodic
+ "RCL.INDEXING.PERIODIC"></a>2.8.���Periodic
indexing</h2>
</div>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.PERIODIC.EXEC" id=
- "RCL.INDEXING.PERIODIC.EXEC"></a>2.8.1. Running
+ "RCL.INDEXING.PERIODIC.EXEC"></a>2.8.1.���Running
indexing</h3>
</div>
</div>
</div>
-
<p>Indexing is always performed by the <span class=
"command"><strong>recollindex</strong></span> program,
which can be started either from the command line or from
@@ -2121,12 +1827,10 @@
accept a <code class="option">-c</code> <em class=
"replaceable"><code>confdir</code></em> option to specify
a non-default configuration directory.</p>
-
<p>If the <span class=
"command"><strong>recoll</strong></span> program finds no
index when it starts, it will automatically start
indexing (except if canceled).</p>
-
<p>The <span class=
"command"><strong>recollindex</strong></span> indexing
process can be interrupted by sending an interrupt
@@ -2135,9 +1839,8 @@
exits, because it needs to properly flush and close the
index. This can also be done from the <span class=
"command"><strong>recoll</strong></span> GUI <span class=
- "guimenu">File</span> → <span class=
- "guimenuitem">Stop Indexing</span> menu entry.</p>
-
+ "guimenu">File</span> ��� <span class="guimenuitem">Stop
+ Indexing</span> menu entry.</p>
<p>After such an interruption, the index will be somewhat
inconsistent because some operations which are normally
performed at the end of the indexing pass will have been
@@ -2148,18 +1851,15 @@
full file tree will be traversed, but files that were
indexed up to the interruption and for which the index is
still up to date will not need to be reindexed).</p>
-
<p><span class=
"command"><strong>recollindex</strong></span> has a
number of other options which are described in its man
page. Only a few will be described here.</p>
-
<p>Option <code class="option">-z</code> will reset the
index when starting. This is almost the same as
destroying the index files (the nuance is that the
<span class="application">Xapian</span> format version
will not be changed).</p>
-
<p>Option <code class="option">-Z</code> will force the
update of all documents without resetting the index
first. This will not have the "clean start" aspect of
@@ -2168,11 +1868,9 @@
rebuilt, which can be a significant advantage if it is
very big (some installations need days for a full index
rebuild).</p>
-
<p>Option <code class="option">-k</code> will force
retrying files which previously failed to be indexed, for
example because of a missing helper program.</p>
-
<p>Of special interest also, maybe, are the <code class=
"option">-i</code> and <code class="option">-f</code>
options. <code class="option">-i</code> allows indexing
@@ -2192,9 +1890,7 @@
<code class="option">-if</code>. Trivial example:</p>
<pre class="programlisting">
find . -name indexable.txt -print | recollindex -if
-
-</pre>
-
+ </pre>
<p><span class=
"command"><strong>recollindex</strong></span>
<code class="option">-i</code> will not descend into
@@ -2202,20 +1898,18 @@
as index entries. It is up to the external file selection
method to build the complete file list.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.PERIODIC.AUTOMAT" id=
- "RCL.INDEXING.PERIODIC.AUTOMAT"></a>2.8.2. Using
+ "RCL.INDEXING.PERIODIC.AUTOMAT"></a>2.8.2.���Using
<span class="command"><strong>cron</strong></span>
to automate indexing</h3>
</div>
</div>
</div>
-
<p>The most common way to set up indexing is to have a
cron task execute it every night. For example the
following <code class="filename">crontab</code> entry
@@ -2225,26 +1919,23 @@
<pre class="screen">
30 3 * * * recollindex > /some/tmp/dir/recolltrace 2>&1
</pre>
-
<p>Or, using <span class=
"command"><strong>anacron</strong></span>:</p>
<pre class="screen">
1 15 su mylogin -c "recollindex recollindex > /tmp/rcltraceme 2>&1"
</pre>
-
<p>As of version 1.17 the <span class=
"application">Recoll</span> GUI has dialogs to manage
<code class="filename">crontab</code> entries for
<span class=
"command"><strong>recollindex</strong></span>. You can
reach them from the <span class=
- "guimenu">Preferences</span> → <span class=
+ "guimenu">Preferences</span> ��� <span class=
"guimenuitem">Indexing Schedule</span> menu. They only
work with the good old <span class=
"command"><strong>cron</strong></span>, and do not give
access to all features of <span class=
"command"><strong>cron</strong></span> scheduling.</p>
-
<p>The usual command to edit your <code class=
"filename">crontab</code> is <span class=
"command"><strong>crontab</strong></span> <code class=
@@ -2252,7 +1943,6 @@
<span class="command"><strong>vi</strong></span> editor
to edit the file). You may have more sophisticated tools
available on your system.</p>
-
<p>Please be aware that there may be differences between
your usual interactive command line environment and the
one seen by crontab commands. Especially the PATH
@@ -2260,19 +1950,17 @@
manual pages about possible issues.</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INDEXING.MONITOR" id=
- "RCL.INDEXING.MONITOR"></a>2.9. Real time
+ "RCL.INDEXING.MONITOR"></a>2.9.���Real time
indexing</h2>
</div>
</div>
</div>
-
<p>Real time monitoring/indexing is performed by starting
the <span class=
"command"><strong>recollindex</strong></span> <code class=
@@ -2280,7 +1968,6 @@
"command"><strong>recollindex</strong></span> will detach
from the terminal and become a daemon, permanently
monitoring file changes and updating the index.</p>
-
<p>Under <span class="application">KDE</span>, <span class=
"application">Gnome</span> and some other desktop
environments, the daemon can automatically started when you
@@ -2290,46 +1977,38 @@
"application">Recoll</span> GUI. Use the <span class=
"guimenu">Preferences->Indexing Schedule</span>
menu.</p>
-
<p>With older <span class="application">X11</span> setups,
starting the daemon is normally performed as part of the
user session script.</p>
-
<p>The <code class="filename">rclmon.sh</code> script can
be used to easily start and stop the daemon. It can be
found in the <code class="filename">examples</code>
directory (typically <code class=
"filename">/usr/local/[share/]recoll/examples</code>).</p>
-
<p>For example, my out of fashion <span class=
"application">xdm</span>-based session has a <code class=
"filename">.xsession</code> script with the following lines
at the end:</p>
- <pre class="programlisting">
-recollconf=$HOME/.recoll-home
+ <pre class="programlisting">recollconf=$HOME/.recoll-home
recolldata=/usr/local/share/recoll
RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh start
fvwm
</pre>
-
<p>The indexing daemon gets started, then the window
manager, for which the session waits.</p>
-
<p>By default the indexing daemon will monitor the state of
the X11 session, and exit when it finishes, it is not
necessary to kill it explicitly. (The <span class=
"application">X11</span> server monitoring can be disabled
with option <code class="option">-x</code> to <span class=
"command"><strong>recollindex</strong></span>).</p>
-
<p>If you use the daemon completely out of an <span class=
"application">X11</span> session, you need to add option
<code class="option">-x</code> to disable <span class=
"application">X11</span> session monitoring (else the
daemon will not start).</p>
-
<p>By default, the messages from the indexing daemon will
be setn to the same file as those from the interactive
commands (<code class="literal">logfilename</code>). You
@@ -2339,11 +2018,10 @@
Also the log file will only be truncated when the daemon
starts. If the daemon runs permanently, the log file may
grow quite big, depending on the log level.</p>
-
<p>When building <span class="application">Recoll</span>,
the real time indexing support can be customised during
package <a class="link" href="#RCL.INSTALL.BUILDING.BUILD"
- title="5.3.2. Building">configuration</a> with the
+ title="5.3.2.���Building">configuration</a> with the
<code class="option">--with[out]-fam</code> or <code class=
"option">--with[out]-inotify</code> options. The default is
currently to include <span class=
@@ -2352,7 +2030,6 @@
"application">Recoll</span> 1.17, <span class=
"application">gamin</span> support on <span class=
"application">FreeBSD</span>.</p>
-
<p>While it is convenient that data is indexed in real
time, repeated indexing can generate a significant load on
the system when files such as email folders change. Also,
@@ -2360,11 +2037,9 @@
system resources. You probably do not want to enable it if
your system is short on resources. Periodic indexing is
adequate in most cases.</p>
-
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Increasing resources for inotify</h3>
-
<p>On Linux systems, monitoring a big tree may need
increasing the resources available to inotify, which are
normally defined in <code class=
@@ -2381,33 +2056,28 @@
fs.inotify.max_queued_events=32768
fs.inotify.max_user_instances=256
fs.inotify.max_user_watches=32768
-
-</pre>
-
+ </pre>
<p>Especially, you will need to trim your tree or adjust
the <code class="literal">max_user_watches</code> value
if indexing exits with a message about errno <code class=
"literal">ENOSPC</code> (28) from <code class=
"function">inotify_add_watch</code>.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INDEXING.MONITOR.FASTFILES" id=
- "RCL.INDEXING.MONITOR.FASTFILES"></a>2.9.1. Slowing
+ "RCL.INDEXING.MONITOR.FASTFILES"></a>2.9.1.���Slowing
down the reindexing rate for fast changing
files</h3>
</div>
</div>
</div>
-
<p>When using the real time monitor, it may happen that
some files need to be indexed, but change so often that
they impose an excessive load for the system.</p>
-
<p><span class="application">Recoll</span> provides a
configuration option to specify the minimum time before
which a file, specified by a wildcard pattern, cannot be
@@ -2415,42 +2085,37 @@
"varname">mondelaypatterns</code> parameter in the
<a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.MISC" title=
- "5.4.2.5. Miscellaneous parameters">configuration
+ "5.4.2.5.���Miscellaneous parameters">configuration
section</a>.</p>
</div>
</div>
</div>
-
<div class="chapter">
<div class="titlepage">
<div>
<div>
<h1 class="title"><a name="RCL.SEARCH" id=
- "RCL.SEARCH"></a>Chapter 3. Searching</h1>
+ "RCL.SEARCH"></a>Chapter���3.���Searching</h1>
</div>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.SEARCH.GUI" id=
- "RCL.SEARCH.GUI"></a>3.1. Searching with the Qt
+ "RCL.SEARCH.GUI"></a>3.1.���Searching with the Qt
graphical user interface</h2>
</div>
</div>
</div>
-
<p>The <span class="command"><strong>recoll</strong></span>
program provides the main user interface for searching. It
is based on the <span class="application">Qt</span>
library.</p>
-
<p><span class="command"><strong>recoll</strong></span> has
two search modes:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -2458,7 +2123,6 @@
has a single entry field where you can enter multiple
words.</p>
</li>
-
<li class="listitem">
<p>Advanced search (a panel accessed through the
<span class="guilabel">Tools</span> menu or the
@@ -2469,40 +2133,35 @@
</li>
</ul>
</div>
-
<p>In most cases, you can enter the terms as you think
them, even if they contain embedded punctuation or other
non-textual characters. For example, <span class=
"application">Recoll</span> can handle things like email
addresses, or arbitrary cut and paste from another text
window, punctation and all.</p>
-
<p>The main case where you should enter text differently
from how it is printed is for east-asian languages
(Chinese, Japanese, Korean). Words composed of single or
multiple characters should be entered separated by white
space in this case (they would typically be printed without
white space).</p>
-
<p>Some searches can be quite complex, and you may want to
re-use them later, perhaps with some tweaking. <span class=
"application">Recoll</span> versions 1.21 and later can
save and restore searches, using XML files. See <a class=
"link" href="#RCL.SEARCH.SAVING" title=
- "3.1.14. Saving and restoring queries (1.21 and later)">
- Saving and restoring queries</a>.</p>
-
+ "3.1.14.���Saving and restoring queries (1.21 and later)">Saving
+ and restoring queries</a>.</p>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.SIMPLE"
- id="RCL.SEARCH.GUI.SIMPLE"></a>3.1.1. Simple
+ id="RCL.SEARCH.GUI.SIMPLE"></a>3.1.1.���Simple
search</h3>
</div>
</div>
</div>
-
<div class="procedure">
<ol class="procedure" type="1">
<li class="step">
@@ -2510,7 +2169,6 @@
"command"><strong>recoll</strong></span>
program.</p>
</li>
-
<li class="step">
<p>Possibly choose a search mode: <span class=
"guilabel">Any term</span>, <span class=
@@ -2518,12 +2176,10 @@
"guilabel">File name</span> or <span class=
"guilabel">Query language</span>.</p>
</li>
-
<li class="step">
<p>Enter search term(s) in the text field at the
top of the window.</p>
</li>
-
<li class="step">
<p>Click the <span class="guilabel">Search</span>
button or hit the <span class=
@@ -2532,7 +2188,6 @@
</li>
</ol>
</div>
-
<p>The initial default search mode is <span class=
"guilabel">Query language</span>. Without special
directives, this will look for documents containing all
@@ -2541,27 +2196,23 @@
terms</span> mode which will ignore such directives.
<span class="guilabel">Any term</span> will search for
documents where at least one of the terms appear.</p>
-
<p>The <span class="guilabel">Query Language</span>
features are described in <a class="link" href=
- "#RCL.SEARCH.LANG" title="3.6. The query language">a
+ "#RCL.SEARCH.LANG" title="3.6.���The query language">a
separate section</a>.</p>
-
<p>All search modes allow wildcards inside terms
(<code class="literal">*</code>, <code class=
"literal">?</code>, <code class="literal">[]</code>). You
may want to have a look at the <a class="link" href=
"#RCL.SEARCH.WILDCARDS" title=
- "3.8.1. More about wildcards">section about
- wildcards</a> for more information about this.</p>
-
+ "3.8.1.���More about wildcards">section about wildcards</a>
+ for more information about this.</p>
<p><span class="guilabel">File name</span> will
specifically look for file names. The point of having a
separate file name search is that wild card expansion can
be performed more efficiently on a small subset of the
index (allowing wild cards on the left of terms without
excessive penality). Things to know:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -2570,12 +2221,10 @@
space in the file name, and is not treated
specially.</p>
</li>
-
<li class="listitem">
<p>The search is insensitive to character case and
accents, independantly of the type of index.</p>
</li>
-
<li class="listitem">
<p>An entry without any wild card character and not
capitalized will be prepended and appended with '*'
@@ -2585,7 +2234,6 @@
<em class="replaceable"><code>Etc</code></em> ->
<em class="replaceable"><code>etc</code></em>).</p>
</li>
-
<li class="listitem">
<p>If you have a big index (many files),
excessively generic fragments may result in
@@ -2593,11 +2241,9 @@
</li>
</ul>
</div>
-
<p>You can search for exact phrases (adjacent words in a
given order) by enclosing the input inside double quotes.
Ex: <code class="literal">"virtual reality"</code>.</p>
-
<p>When using a stripped index, character case has no
influence on search, except that you can disable stem
expansion for any term by capitalizing it. Ie: a search
@@ -2609,27 +2255,23 @@
case. Stemming can also be disabled globally in the
preferences. When using a raw index, <a class="link"
href="#RCL.SEARCH.CASEDIAC" title=
- "3.7. Search case and diacritics sensitivity">the
- rules are a bit more complicated</a>.</p>
-
+ "3.7.���Search case and diacritics sensitivity">the rules
+ are a bit more complicated</a>.</p>
<p><span class="application">Recoll</span> remembers the
last few searches that you performed. You can use the
simple search text entry widget (a combobox) to recall
them (click on the thing at the right of the text field).
Please note, however, that only the search texts are
remembered, not the mode (all/any/file name).</p>
-
<p>Typing <span class=
"keycap"><strong>Esc</strong></span> <span class=
"keycap"><strong>Space</strong></span> while entering a
word in the simple search entry will open a window with
possible completions for the word. The completions are
extracted from the database.</p>
-
<p>Double-clicking on a word in the result list or a
preview window will insert it into the simple search
entry field.</p>
-
<p>You can cut and paste any text into an <span class=
"guilabel">All terms</span> or <span class="guilabel">Any
term</span> search field, punctuation, newlines and all -
@@ -2640,35 +2282,30 @@
mode from the <span class="guilabel">Query
Language</span> mode, where you have to care about the
syntax.</p>
-
<p>You can use the <a class="link" href=
"#RCL.SEARCH.GUI.COMPLEX" title=
- "3.1.8. Complex/advanced search"><span class=
- "guimenu">Tools</span> → <span class=
+ "3.1.8.���Complex/advanced search"><span class=
+ "guimenu">Tools</span> ��� <span class=
"guimenuitem">Advanced search</span></a> dialog for more
complex searches.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.RESLIST"
- id="RCL.SEARCH.GUI.RESLIST"></a>3.1.2. The
- default result list</h3>
- </div>
- </div>
- </div>
-
+ id="RCL.SEARCH.GUI.RESLIST"></a>3.1.2.���The default
+ result list</h3>
+ </div>
+ </div>
+ </div>
<p>After starting a search, a list of results will
instantly be displayed in the main list window.</p>
-
<p>By default, the document list is presented in order of
relevance (how well the system estimates that the
document matches the query). You can sort the result by
ascending or descending date by using the vertical arrows
in the toolbar.</p>
-
<p>Clicking on the <code class="literal">Preview</code>
link for an entry will open an internal preview window
for the document. Further <code class=
@@ -2682,7 +2319,6 @@
"keycap"><strong>Shift</strong></span>+<span class=
"keycap"><strong>ArrowUp/Down</strong></span> in the
window).</p>
-
<p>Clicking the <code class="literal">Open</code> link
will start an external viewer for the document. By
default, <span class="application">Recoll</span> lets the
@@ -2697,7 +2333,6 @@
"application">Recoll</span> choices. The tool accepts
multiple selections of MIME types (e.g. to set up the
editor for the dozens of office file types).</p>
-
<p>Even when <span class="guilabel">Use desktop
preferences</span> is checked, there is a small list of
exceptions, for MIME types where the <span class=
@@ -2710,20 +2345,17 @@
search string as an argument. Of course, you can edit the
list (in the GUI preferences) if you would prefer to lose
the functionality and use the standard desktop tool.</p>
-
<p>You may also change the choice of applications by
editing the <a class="link" href=
"#RCL.INSTALL.CONFIG.MIMEVIEW" title=
- "5.4.6. The mimeview file"><code class=
+ "5.4.6.���The mimeview file"><code class=
"filename">mimeview</code></a> configuration file if you
find this more convenient.</p>
-
<p>Each result entry also has a right-click menu with an
<span class="guilabel">Open With</span> entry. This lets
you choose an application from the list of those which
registered with the desktop for the document MIME
type.</p>
-
<p>The <code class="literal">Preview</code> and
<code class="literal">Open</code> edit links may not be
present for all entries, meaning that <span class=
@@ -2732,46 +2364,40 @@
only), or no configured external editor for the file
type. This can sometimes be adjusted simply by tweaking
the <a class="link" href="#RCL.INSTALL.CONFIG.MIMEMAP"
- title="5.4.4. The mimemap file"><code class=
+ title="5.4.4.���The mimemap file"><code class=
"filename">mimemap</code></a> and <a class="link" href=
"#RCL.INSTALL.CONFIG.MIMEVIEW" title=
- "5.4.6. The mimeview file"><code class=
+ "5.4.6.���The mimeview file"><code class=
"filename">mimeview</code></a> configuration files (the
latter can be modified with the user preferences
dialog).</p>
-
<p>The format of the result list entries is entirely
configurable by using the preference dialog to <a class=
"link" href="#RCL.SEARCH.GUI.CUSTOM.RESLIST" title=
- "3.1.15.1. The result list format">edit an HTML
+ "3.1.15.1.���The result list format">edit an HTML
fragment</a>.</p>
-
<p>You can click on the <code class="literal">Query
details</code> link at the top of the results page to see
the query actually performed, after stem expansion and
other processing.</p>
-
<p>Double-clicking on any word inside the result list or
a preview window will insert it into the simple search
text.</p>
-
<p>The result list is divided into pages (the size of
which you can change in the preferences). Use the arrow
buttons in the toolbar or the links at the bottom of the
page to browse the results.</p>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.RESLIST.SUGGS" id=
- "RCL.SEARCH.GUI.RESLIST.SUGGS"></a>3.1.2.1. No
+ "RCL.SEARCH.GUI.RESLIST.SUGGS"></a>3.1.2.1.���No
results: the spelling suggestions</h4>
</div>
</div>
</div>
-
<p>When a search yields no result, and if the
<span class="application">aspell</span> dictionary is
configured, <span class="application">Recoll</span>
@@ -2783,100 +2409,82 @@
rather stay on the suggestion screen because several
terms need replacement.</p>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.RESULTLIST.MENU" id=
- "RCL.SEARCH.GUI.RESULTLIST.MENU"></a>3.1.2.2. The
+ "RCL.SEARCH.GUI.RESULTLIST.MENU"></a>3.1.2.2.���The
result list right-click menu</h4>
</div>
</div>
</div>
-
<p>Apart from the preview and edit links, you can
display a pop-up menu by right-clicking over a
paragraph in the result list. This menu has the
following entries:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
<li class="listitem">
<p><span class="guilabel">Preview</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Open</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Open With</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Run Script</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Copy File
Name</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Copy Url</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Save to File</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Find similar</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Preview Parent
document</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Open Parent
document</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Open Snippets
Window</span></p>
</li>
</ul>
</div>
-
<p>The <span class="guilabel">Preview</span> and
<span class="guilabel">Open</span> entries do the same
thing as the corresponding links.</p>
-
<p><span class="guilabel">Open With</span> lets you
open the document with one of the applications claiming
to be able to handle its MIME type (the information
comes from the <code class="literal">.desktop</code>
files in <code class=
"filename">/usr/share/applications</code>).</p>
-
<p><span class="guilabel">Run Script</span> allows
starting an arbitrary command on the result file. It
will only appear for results which are top-level files.
See <a class="link" href="#RCL.SEARCH.GUI.RUNSCRIPT"
title=
- "3.1.4. Running arbitrary commands on result files (1.20 and later)">
+ "3.1.4.���Running arbitrary commands on result files (1.20 and later)">
further</a> for a more detailed description.</p>
-
<p>The <span class="guilabel">Copy File Name</span> and
<span class="guilabel">Copy Url</span> copy the
relevant data to the clipboard, for later pasting.</p>
-
<p><span class="guilabel">Save to File</span> allows
saving the contents of a result document to a chosen
file. This entry will only appear if the document does
@@ -2884,7 +2492,6 @@
subdocument inside such a file (ie: an email
attachment). It is especially useful to extract
attachments with no associated editor.</p>
-
<p>The <span class="guilabel">Open/Preview Parent
document</span> entries allow working with the higher
level document (e.g. the email message an attachment
@@ -2895,11 +2502,9 @@
email which is part of an mbox folder file, but you
can't actually visualize the mbox (there will be an
error dialog if you try).</p>
-
<p>If the document is a top-level file, <span class=
"guilabel">Open Parent</span> will start the default
file manager on the enclosing filesystem directory.</p>
-
<p>The <span class="guilabel">Find similar</span> entry
will select a number of relevant term from the current
document and enter them into the simple search field.
@@ -2907,7 +2512,6 @@
of finding documents related to the current result. I
can't remember a single instance where this function
was actually useful to me...</p>
-
<p><a name="RCL.SEARCH.GUI.RESULTLIST.MENU.SNIPPETS"
id="RCL.SEARCH.GUI.RESULTLIST.MENU.SNIPPETS"></a>The
<span class="guilabel">Open Snippets Window</span>
@@ -2921,42 +2525,36 @@
with one of the search terms.</p>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.RESTABLE"
- id="RCL.SEARCH.GUI.RESTABLE"></a>3.1.3. The
- result table</h3>
- </div>
- </div>
- </div>
-
+ id="RCL.SEARCH.GUI.RESTABLE"></a>3.1.3.���The result
+ table</h3>
+ </div>
+ </div>
+ </div>
<p>In <span class="application">Recoll</span> 1.15 and
newer, the results can be displayed in spreadsheet-like
fashion. You can switch to this presentation by clicking
the table-like icon in the toolbar (this is a toggle,
click again to restore the list).</p>
-
<p>Clicking on the column headers will allow sorting by
the values in the column. You can click again to invert
the order, and use the header right-click menu to reset
sorting to the default relevance order (you can also use
the sort-by-date arrows to do this).</p>
-
<p>Both the list and the table display the same
underlying results. The sort order set from the table is
still active if you switch back to the list mode. You can
click twice on a date sort arrow to reset it from
there.</p>
-
<p>The header right-click menu allows adding or deleting
columns. The columns can be resized, and their order can
be changed (by dragging). All the changes are recorded
when you quit <span class=
"command"><strong>recoll</strong></span></p>
-
<p>Hovering over a table row will update the detail area
at the bottom of the window with the corresponding
values. You can click the row to freeze the display. The
@@ -2966,20 +2564,18 @@
<span class="keycap"><strong>Esc</strong></span> (the
Escape key) will unfreeze the display.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.SEARCH.GUI.RUNSCRIPT" id=
- "RCL.SEARCH.GUI.RUNSCRIPT"></a>3.1.4. Running
+ "RCL.SEARCH.GUI.RUNSCRIPT"></a>3.1.4.���Running
arbitrary commands on result files (1.20 and
later)</h3>
</div>
</div>
</div>
-
<p>Apart from the <span class="guilabel">Open</span> and
<span class="guilabel">Open With</span> operations, which
allow starting an application on a result document (or a
@@ -2987,13 +2583,11 @@
possible to run arbitrary commands on results which are
top-level files, using the <span class="guilabel">Run
Script</span> entry in the results pop-up menu.</p>
-
<p>The commands which will appear in the <span class=
"guilabel">Run Script</span> submenu must be defined by
<code class="literal">.desktop</code> files inside the
<code class="filename">scripts</code> subdirectory of the
current configuration directory.</p>
-
<p>Here follows an example of a <code class=
"literal">.desktop</code> file, which could be named for
example, <code class=
@@ -3005,9 +2599,7 @@
Name=MyFirstScript
Exec=/home/me/bin/tryscript %F
MimeType=*/*
-
-</pre>
-
+ </pre>
<p>The <code class="literal">Name</code> attribute
defines the label which will appear inside the
<span class="guilabel">Run Script</span> menu. The
@@ -3016,30 +2608,26 @@
script, of course. The <code class=
"literal">MimeType</code> attribute is not used, but
needs to exist.</p>
-
<p>The commands defined this way can also be used from
links inside the <a class="link" href=
"#RCL.SEARCH.GUI.CUSTOM.RESLIST.PARA" title=
"The paragraph format">result paragraph</a>.</p>
-
<p>As an example, it might make sense to write a script
which would move the document to the trash and purge it
from the <span class="application">Recoll</span>
index.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.SEARCH.GUI.THUMBNAILS" id=
- "RCL.SEARCH.GUI.THUMBNAILS"></a>3.1.5. Displaying
+ "RCL.SEARCH.GUI.THUMBNAILS"></a>3.1.5.���Displaying
thumbnails</h3>
</div>
</div>
</div>
-
<p>The default format for the result list entries and the
detail area of the result table display an icon for each
result document. The icon is either a generic one
@@ -3048,7 +2636,6 @@
found in the standard <span class=
"application">freedesktop</span> location, where they
would typically have been created by a file manager.</p>
-
<p>Recoll has no capability to create thumbnails. A
relatively simple trick is to use the <span class=
"guilabel">Open parent document/folder</span> entry in
@@ -3057,49 +2644,41 @@
in turn create the thumbnails (depending on your
settings). Restarting the search should then display the
thumbnails.</p>
-
<p>There are also <a class="ulink" href=
"https://www.lesbonscomptes.com/recoll/faqsandhowtos/ResultsThumbnails.wiki"
target="_top">some pointers about thumbnail
generation</a> on the <span class=
"application">Recoll</span> wiki.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.PREVIEW"
- id="RCL.SEARCH.GUI.PREVIEW"></a>3.1.6. The
- preview window</h3>
- </div>
- </div>
- </div>
-
+ id="RCL.SEARCH.GUI.PREVIEW"></a>3.1.6.���The preview
+ window</h3>
+ </div>
+ </div>
+ </div>
<p>The preview window opens when you first click a
<code class="literal">Preview</code> link inside the
result list.</p>
-
<p>Subsequent preview requests for a given search open
new tabs in the existing window (except if you hold the
<span class="keycap"><strong>Shift</strong></span> key
while clicking which will open a new window for side by
side viewing).</p>
-
<p>Starting another search and requesting a preview will
create a new preview window. The old one stays open until
you close it.</p>
-
<p>You can close a preview tab by typing <span class=
"keycap"><strong>Ctrl-W</strong></span> (<span class=
"keycap"><strong>Ctrl</strong></span> + <span class=
"keycap"><strong>W</strong></span>) in the window.
Closing the last tab for a window will also close the
window.</p>
-
<p>Of course you can also close a preview window by using
the window manager button in the top of the frame.</p>
-
<p>You can display successive or previous documents from
the result list inside a preview tab by typing
<span class=
@@ -3110,7 +2689,6 @@
"keycap"><strong>Down</strong></span> and <span class=
"keycap"><strong>Up</strong></span> are the arrow
keys).</p>
-
<p>A right-click menu in the text area allows switching
between displaying the main text or the contents of
fields associated to the document (ie: author, abtract,
@@ -3121,26 +2699,23 @@
extracted by <span class=
"command"><strong>exiftool</strong></span> and the
fields, which is the metadata stored in the index.</p>
-
<p>You can print the current preview window contents by
typing <span class=
"keycap"><strong>Ctrl-P</strong></span> (<span class=
"keycap"><strong>Ctrl</strong></span> + <span class=
"keycap"><strong>P</strong></span>) in the window
text.</p>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.PREVIEW.SEARCH" id=
- "RCL.SEARCH.GUI.PREVIEW.SEARCH"></a>3.1.6.1. Searching
+ "RCL.SEARCH.GUI.PREVIEW.SEARCH"></a>3.1.6.1.���Searching
inside the preview</h4>
</div>
</div>
</div>
-
<p>The preview window has an internal search
capability, mostly controlled by the panel at the
bottom of the window, which works in two modes: as a
@@ -3148,12 +2723,10 @@
the text entered in the entry zone, or as a way to walk
the matches between the document and the <span class=
"application">Recoll</span> query that found it.</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">Incremental text
search</span></dt>
-
<dd>
<p>The preview tabs have an internal incremental
search function. You initiate the search either
@@ -3170,7 +2743,6 @@
type <span class=
"keycap"><strong>F3</strong></span> inside the
text area to get to the next occurrence.</p>
-
<p>If you have a search string entered and you
use Ctrl-Up/Ctrl-Down to browse the results, the
search is initiated for each successive document.
@@ -3178,10 +2750,8 @@
positioned at the first occurrence of the search
string.</p>
</dd>
-
<dt><span class="term">Walking the match
lists</span></dt>
-
<dd>
<p>If the entry area is empty when you click the
<span class="guilabel">Next</span> or
@@ -3202,28 +2772,25 @@
</div>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.FRAGBUTS"
- id="RCL.SEARCH.GUI.FRAGBUTS"></a>3.1.7. The
- Query Fragments window</h3>
- </div>
- </div>
- </div>
-
- <p>Selecting the <span class="guimenu">Tools</span>
- → <span class="guimenuitem">Query Fragments</span>
- menu entry will open a window with radio- and
- check-buttons which can be used to activate query
- language fragments for filtering the current query. This
- can be useful if you have frequent reusable selectors,
- for example, filtering on alternate directories, or
- searching just one category of files, not covered by the
- standard category selectors.</p>
-
+ id="RCL.SEARCH.GUI.FRAGBUTS"></a>3.1.7.���The Query
+ Fragments window</h3>
+ </div>
+ </div>
+ </div>
+ <p>Selecting the <span class="guimenu">Tools</span> ���
+ <span class="guimenuitem">Query Fragments</span> menu
+ entry will open a window with radio- and check-buttons
+ which can be used to activate query language fragments
+ for filtering the current query. This can be useful if
+ you have frequent reusable selectors, for example,
+ filtering on alternate directories, or searching just one
+ category of files, not covered by the standard category
+ selectors.</p>
<p>The contents of the window are entirely customizable,
and defined by the contents of the <code class=
"filename">fragbuts.xml</code> file inside the
@@ -3233,7 +2800,6 @@
"filename">/usr/share/recoll/examples/fragbuts.xml</code>),
contains an example which filters the results from the
WEB history.</p>
-
<p>Here follows an example:</p>
<pre class="programlisting">
<?xml version="1.0" encoding="UTF-8"?>
@@ -3274,49 +2840,41 @@
</buttons>
</fragbuts>
</pre>
-
<p>Each <code class="literal">radiobuttons</code> or
<code class="literal">buttons</code> section defines a
line of checkbuttons or radiobuttons inside the window.
Any number of buttons can be selected, but the
radiobuttons in a line are exclusive.</p>
-
<p>Each <code class="literal">fragbut</code> section
defines the label for a button, and the Query Language
fragment which will be added (as an AND filter) before
performing the query if the button is active.</p>
-
<p>This feature is new in <span class=
"application">Recoll</span> 1.20, and will probably be
refined depending on user feedback.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.COMPLEX"
id=
- "RCL.SEARCH.GUI.COMPLEX"></a>3.1.8. Complex/advanced
+ "RCL.SEARCH.GUI.COMPLEX"></a>3.1.8.���Complex/advanced
search</h3>
</div>
</div>
</div>
-
<p>The advanced search dialog helps you build more
complex queries without memorizing the search language
constructs. It can be opened through the <span class=
"guilabel">Tools</span> menu or through the main
toolbar.</p>
-
<p><span class="application">Recoll</span> keeps a
history of searches. See <a class="link" href=
"#RCL.SEARCH.GUI.COMPLEX.HISTORY" title=
- "3.1.8.3. Avanced search history">Advanced search
+ "3.1.8.3.���Avanced search history">Advanced search
history</a>.</p>
-
<p>The dialog has two tabs:</p>
-
<div class="orderedlist">
<ol class="orderedlist" type="1">
<li class="listitem">
@@ -3324,7 +2882,6 @@
for, and permits specifying multiple clauses which
are combined to build the search.</p>
</li>
-
<li class="listitem">
<p>The second tab lets filter the results according
to file size, date of modification, MIME type, or
@@ -3332,84 +2889,70 @@
</li>
</ol>
</div>
-
<p>Click on the <span class="guilabel">Start
Search</span> button in the advanced search dialog, or
type <span class="keycap"><strong>Enter</strong></span>
in any text field to start the search. The button in the
main window always performs a simple search.</p>
-
<p>Click on the <code class="literal">Show query
details</code> link at the top of the result page to see
the query expansion.</p>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.COMPLEX.TERMS" id=
- "RCL.SEARCH.GUI.COMPLEX.TERMS"></a>3.1.8.1. Avanced
+ "RCL.SEARCH.GUI.COMPLEX.TERMS"></a>3.1.8.1.���Avanced
search: the "find" tab</h4>
</div>
</div>
</div>
-
<p>This part of the dialog lets you constructc a query
by combining multiple clauses of different types. Each
entry field is configurable for the following
modes:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
<li class="listitem">
<p>All terms.</p>
</li>
-
<li class="listitem">
<p>Any term.</p>
</li>
-
<li class="listitem">
<p>None of the terms.</p>
</li>
-
<li class="listitem">
<p>Phrase (exact terms in order within an
adjustable window).</p>
</li>
-
<li class="listitem">
<p>Proximity (terms in any order within an
adjustable window).</p>
</li>
-
<li class="listitem">
<p>Filename search.</p>
</li>
</ul>
</div>
-
<p>Additional entry fields can be created by clicking
the <span class="guilabel">Add clause</span>
button.</p>
-
<p>When searching, the non-empty clauses will be
combined either with an AND or an OR conjunction,
depending on the choice made on the left (<span class=
"guilabel">All clauses</span> or <span class=
"guilabel">Any clause</span>).</p>
-
<p>Entries of all types except "Phrase" and "Near"
accept a mix of single words and phrases enclosed in
double quotes. Stemming and wildcard expansion will be
performed as for simple search.</p>
-
- <p><b>Phrases and Proximity searches. </b>These
- two clauses work in similar ways, with the difference
- that proximity searches do not impose an order on the
- words. In both cases, an adjustable number (slack) of
+ <p><b>Phrases and Proximity searches.���</b>These two
+ clauses work in similar ways, with the difference that
+ proximity searches do not impose an order on the words.
+ In both cases, an adjustable number (slack) of
non-matched words may be accepted between the searched
ones (use the counter on the left to adjust this
count). For phrases, the default count is zero (exact
@@ -3426,23 +2969,20 @@
<code class="literal">a fox is a cunning and quick
animal</code>.</p>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.COMPLEX.FILTER" id=
- "RCL.SEARCH.GUI.COMPLEX.FILTER"></a>3.1.8.2. Avanced
+ "RCL.SEARCH.GUI.COMPLEX.FILTER"></a>3.1.8.2.���Avanced
search: the "filter" tab</h4>
</div>
</div>
</div>
-
<p>This part of the dialog has several sections which
allow filtering the results of a search according to a
number of criteria</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -3453,7 +2993,6 @@
according to the oldest and newest documents
found in the index.</p>
</li>
-
<li class="listitem">
<p>The next section allows filtering the results
by file size. There are two entries for minimum
@@ -3465,22 +3004,18 @@
"literal">t/T</code> for 1E3, 1E6, 1E9, 1E12
respectively.</p>
</li>
-
<li class="listitem">
<p>The next section allows filtering the results
by their MIME types, or MIME categories (ie:
media/text/message/etc.).</p>
-
<p>You can transfer the types between two boxes,
to define which will be included or excluded by
the search.</p>
-
<p>The state of the file type selection can be
saved as the default (the file type filter will
not be activated at program start-up, but the
lists will be in the restored state).</p>
</li>
-
<li class="listitem">
<p>The bottom section allows restricting the
search results to a sub-tree of the indexed area.
@@ -3491,7 +3026,6 @@
the file system, you may think of setting up
multiple indexes instead, as the performance may
be better.</p>
-
<p>You can use relative/partial paths for
filtering. Ie, entering <code class=
"literal">dirA/dirB</code> would match either
@@ -3503,67 +3037,58 @@
</ul>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.COMPLEX.HISTORY" id=
- "RCL.SEARCH.GUI.COMPLEX.HISTORY"></a>3.1.8.3. Avanced
+ "RCL.SEARCH.GUI.COMPLEX.HISTORY"></a>3.1.8.3.���Avanced
search history</h4>
</div>
</div>
</div>
-
<p>The advanced search tool memorizes the last 100
searches performed. You can walk the saved searches by
using the up and down arrow keys while the keyboard
focus belongs to the advanced search dialog.</p>
-
<p>The complex search history can be erased, along with
the one for simple search, by selecting the
- <span class="guimenu">File</span> → <span class=
+ <span class="guimenu">File</span> ��� <span class=
"guimenuitem">Erase Search History</span> menu
entry.</p>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.SEARCH.GUI.TERMEXPLORER" id=
- "RCL.SEARCH.GUI.TERMEXPLORER"></a>3.1.9. The
- term explorer tool</h3>
- </div>
- </div>
- </div>
-
+ "RCL.SEARCH.GUI.TERMEXPLORER"></a>3.1.9.���The term
+ explorer tool</h3>
+ </div>
+ </div>
+ </div>
<p><span class="application">Recoll</span> automatically
manages the expansion of search terms to their
derivatives (ie: plural/singular, verb inflections). But
there are other cases where the exact search term is not
known. For example, you may not remember the exact
spelling, or only know the beginning of the name.</p>
-
<p>The search will only propose replacement terms with
spelling variations when no matching document were found.
In some cases, both proper spellings and mispellings are
present in the index, and it may be interesting to look
for them explicitely.</p>
-
<p>The term explorer tool (started from the toolbar icon
or from the <span class="guilabel">Term explorer</span>
entry of the <span class="guilabel">Tools</span> menu)
can be used to search the full index terms list. It has
three modes of operations:</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">Wildcard</span></dt>
-
<dd>
<p>In this mode of operation, you can enter a
search string with shell-like wildcards (*, ?, []).
@@ -3572,11 +3097,9 @@
<em class="replaceable"><code>xapi</code></em>.
(More about wildcards <a class="link" href=
"#RCL.SEARCH.WILDCARDS" title=
- "3.8.1. More about wildcards">here</a>).</p>
- </dd>
-
+ "3.8.1.���More about wildcards">here</a>).</p>
+ </dd>
<dt><span class="term">Regular expression</span></dt>
-
<dd>
<p>This mode will accept a regular expression as
input. Example: <em class=
@@ -3593,18 +3116,14 @@
full index term list scan, which can be quite
long.</p>
</dd>
-
<dt><span class="term">Stem expansion</span></dt>
-
<dd>
<p>This mode will perform the usual stem expansion
normally done as part user input processing. As
such it is probably mostly useful to demonstrate
the process.</p>
</dd>
-
<dt><span class="term">Spelling/Phonetic</span></dt>
-
<dd>
<p>In this mode, you enter the term as you think it
is spelled, and <span class=
@@ -3624,7 +3143,6 @@
</dd>
</dl>
</div>
-
<p>Note that in cases where <span class=
"application">Recoll</span> does not know the beginning
of the string to search for (ie a wildcard expression
@@ -3634,33 +3152,28 @@
is currently limited at 10000 results for wildcards and
regular expressions. It is possible to change the limit
in the configuration file.</p>
-
<p>Double-clicking on a term in the result list will
insert it into the simple search entry field. You can
also cut/paste between the result list and any entry
field (the end of lines will be taken care of).</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.MULTIDB"
- id=
- "RCL.SEARCH.GUI.MULTIDB"></a>3.1.10. Multiple
+ id="RCL.SEARCH.GUI.MULTIDB"></a>3.1.10.���Multiple
indexes</h3>
</div>
</div>
</div>
-
<p>See the <a class="link" href=
"#RCL.INDEXING.CONFIG.MULTIPLE" title=
- "2.3.1. Multiple indexes">section describing the use
- of multiple indexes</a> for generalities. Only the
- aspects concerning the <span class=
+ "2.3.1.���Multiple indexes">section describing the use of
+ multiple indexes</a> for generalities. Only the aspects
+ concerning the <span class=
"command"><strong>recoll</strong></span> GUI are
described here.</p>
-
<p>A <span class="command"><strong>recoll</strong></span>
program instance is always associated with a specific
index, which is the one to be updated when requested from
@@ -3669,7 +3182,6 @@
indexes for searching. The external indexes can be
selected through the <span class="guilabel">external
indexes</span> tab in the preferences dialog.</p>
-
<p>Index selection is performed in two phases. A set of
all usable indexes must first be defined, and then the
subset of indexes to be used for searching. These
@@ -3678,12 +3190,10 @@
"application">Recoll</span> configuration). The set of
all indexes is usually quite stable, while the active
ones might typically be adjusted quite frequently.</p>
-
<p>The main index (defined by <code class=
"envar">RECOLL_CONFDIR</code>) is always active. If this
is undesirable, you can set up your base configuration to
index an empty directory.</p>
-
<p>When adding a new index to the set, you can select
either a <span class="application">Recoll</span>
configuration directory, or directly a <span class=
@@ -3691,7 +3201,6 @@
case, the <span class="application">Xapian</span> index
directory will be obtained from the selected
configuration.</p>
-
<p>As building the set of all indexes can be a little
tedious when done through the user interface, you can use
the <code class="envar">RECOLL_EXTRA_DBS</code>
@@ -3701,9 +3210,7 @@
should define a colon-separated list of index
directories, ie:</p>
<pre class="screen">
-export RECOLL_EXTRA_DBS=/some/place/xapiandb:/some/other/db
-</pre>
-
+ export RECOLL_EXTRA_DBS=/some/place/xapiandb:/some/other/db</pre>
<p>Another environment variable, <code class=
"envar">RECOLL_ACTIVE_EXTRA_DBS</code> allows adding to
the active list of indexes. This variable was suggested
@@ -3716,7 +3223,6 @@
can add and activate the index for the mounted volume
when starting <span class=
"command"><strong>recoll</strong></span>.</p>
-
<p><code class="envar">RECOLL_ACTIVE_EXTRA_DBS</code> is
available for <span class="application">Recoll</span>
versions 1.17.2 and later. A change was made in the same
@@ -3725,43 +3231,36 @@
automatically deactivate unreachable indexes when
starting up.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.HISTORY"
- id=
- "RCL.SEARCH.GUI.HISTORY"></a>3.1.11. Document
+ id="RCL.SEARCH.GUI.HISTORY"></a>3.1.11.���Document
history</h3>
</div>
</div>
</div>
-
<p>Documents that you actually view (with the internal
preview or an external tool) are entered into the
document history, which is remembered.</p>
-
<p>You can display the history list by using the
<span class="guilabel">Tools/</span><span class=
"guilabel">Doc History</span> menu entry.</p>
-
<p>You can erase the document history by using the
<span class="guilabel">Erase document history</span>
entry in the <span class="guimenu">File</span> menu.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.SORT" id=
- "RCL.SEARCH.GUI.SORT"></a>3.1.12. Sorting
- search results and collapsing duplicates</h3>
- </div>
- </div>
- </div>
-
+ "RCL.SEARCH.GUI.SORT"></a>3.1.12.���Sorting search
+ results and collapsing duplicates</h3>
+ </div>
+ </div>
+ </div>
<p>The documents in a result list are normally sorted in
order of relevance. It is possible to specify a different
sort order, either by using the vertical arrows in the
@@ -3771,14 +3270,12 @@
switch back to the result list, until you click one of
the vertical arrows, until both are unchecked (you are
back to sort by relevance).</p>
-
<p>Sort parameters are remembered between program
invocations, but result sorting is normally always
inactive when the program starts. It is possible to keep
the sorting activation state between program invocations
by checking the <span class="guilabel">Remember sort
activation state</span> option in the preferences.</p>
-
<p>It is also possible to hide duplicate entries inside
the result list (documents with the exact same contents
as the displayed one). The test of identity is based on
@@ -3788,65 +3285,57 @@
Duplicates hiding is controlled by an entry in the
<span class="guilabel">GUI configuration</span> dialog,
and is off by default.</p>
-
<p>As of release 1.19, when a result document does have
undisplayed duplicates, a <code class=
"literal">Dups</code> link will be shown with the result
list entry. Clicking the link will display the paths
(URLs + ipaths) for the duplicate entries.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.TIPS" id=
- "RCL.SEARCH.GUI.TIPS"></a>3.1.13. Search tips,
+ "RCL.SEARCH.GUI.TIPS"></a>3.1.13.���Search tips,
shortcuts</h3>
</div>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.TIPS.TERMS" id=
- "RCL.SEARCH.GUI.TIPS.TERMS"></a>3.1.13.1. Terms
+ "RCL.SEARCH.GUI.TIPS.TERMS"></a>3.1.13.1.���Terms
and search expansion</h4>
</div>
</div>
</div>
-
- <p><b>Term completion. </b>Typing <span class=
+ <p><b>Term completion.���</b>Typing <span class=
"keycap"><strong>Esc</strong></span> <span class=
"keycap"><strong>Space</strong></span> in the simple
search entry field while entering a word will either
complete the current word if its beginning matches a
unique term in the index, or open a window to propose a
list of completions.</p>
-
<p><b>Picking up new terms from result or preview
- text. </b>Double-clicking on a word in the result
- list or in a preview window will copy it to the simple
+ text.���</b>Double-clicking on a word in the result list
+ or in a preview window will copy it to the simple
search entry field.</p>
-
- <p><b>Wildcards. </b>Wildcards can be used inside
+ <p><b>Wildcards.���</b>Wildcards can be used inside
search terms in all forms of searches. <a class="link"
href="#RCL.SEARCH.WILDCARDS" title=
- "3.8.1. More about wildcards">More about
+ "3.8.1.���More about wildcards">More about
wildcards</a>.</p>
-
- <p><b>Automatic suffixes. </b>Words like
- <code class="literal">odt</code> or <code class=
+ <p><b>Automatic suffixes.���</b>Words like <code class=
+ "literal">odt</code> or <code class=
"literal">ods</code> can be automatically turned into
query language <code class="literal">ext:xxx</code>
clauses. This can be enabled in the <span class=
"guilabel">Search preferences</span> panel in the
GUI.</p>
-
- <p><b>Disabling stem expansion. </b>Entering a
+ <p><b>Disabling stem expansion.���</b>Entering a
capitalized word in any search field will prevent stem
expansion (no search for <code class=
"literal">gardening</code> if you enter <code class=
@@ -3856,8 +3345,7 @@
<span class="application">Recoll</span> search. You can
also disable stem expansion or change the stemming
language in the preferences.</p>
-
- <p><b>Finding related documents. </b>Selecting the
+ <p><b>Finding related documents.���</b>Selecting the
<span class="guilabel">Find similar documents</span>
entry in the result list paragraph right-click menu
will select a set of "interesting" terms from the
@@ -3865,10 +3353,9 @@
entry field. You can then possibly edit the list and
start a search to find documents which may be
apparented to the current result.</p>
-
- <p><b>File names. </b>File names are added as
- terms during indexing, and you can specify them as
- ordinary terms in normal search fields (<span class=
+ <p><b>File names.���</b>File names are added as terms
+ during indexing, and you can specify them as ordinary
+ terms in normal search fields (<span class=
"application">Recoll</span> used to index all
directories in the file path as terms. This has been
abandoned as it did not seem really useful).
@@ -3878,21 +3365,19 @@
and may be faster than the generic search especially
when using wildcards.</p>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.TIPS.PHRASES" id=
- "RCL.SEARCH.GUI.TIPS.PHRASES"></a>3.1.13.2. Working
+ "RCL.SEARCH.GUI.TIPS.PHRASES"></a>3.1.13.2.���Working
with phrases and proximity</h4>
</div>
</div>
</div>
-
- <p><b>Phrases and Proximity searches. </b>A phrase
- can be looked for by enclosing it in double quotes.
+ <p><b>Phrases and Proximity searches.���</b>A phrase can
+ be looked for by enclosing it in double quotes.
Example: <code class="literal">"user manual"</code>
will look only for occurrences of <code class=
"literal">user</code> immediately followed by
@@ -3902,9 +3387,8 @@
be entered along simple terms in all simple or advanced
search entry fields (except <span class="guilabel">This
exact phrase</span>).</p>
-
- <p><b>AutoPhrases. </b>This option can be set in
- the preferences dialog. If it is set, a phrase will be
+ <p><b>AutoPhrases.���</b>This option can be set in the
+ preferences dialog. If it is set, a phrase will be
automatically built and added to simple searches when
looking for <code class="literal">Any terms</code>.
This will not change radically the results, but will
@@ -3916,7 +3400,6 @@
"literal">reality</code> or both appear, but those
which contain <code class="literal">virtual
reality</code> should appear sooner in the list.</p>
-
<p>Phrase searches can strongly slow down a query if
most of the terms in the phrase are common. This is why
the <code class="varname">autophrase</code> option is
@@ -3926,42 +3409,38 @@
is on by default, but very common terms will be removed
from the constructed phrase. The removal threshold can
be adjusted from the search preferences.</p>
-
- <p><b>Phrases and abbreviations. </b>As of
- <span class="application">Recoll</span> version 1.17,
- dotted abbreviations like <code class=
- "literal">I.B.M.</code> are also automatically indexed
- as a word without the dots: <code class=
- "literal">IBM</code>. Searching for the word inside a
- phrase (ie: <code class="literal">"the IBM
- company"</code>) will only match the dotted
- abrreviation if you increase the phrase slack (using
- the advanced search panel control, or the <code class=
- "literal">o</code> query language modifier). Literal
- occurences of the word will be matched normally.</p>
- </div>
-
+ <p><b>Phrases and abbreviations.���</b>As of <span class=
+ "application">Recoll</span> version 1.17, dotted
+ abbreviations like <code class="literal">I.B.M.</code>
+ are also automatically indexed as a word without the
+ dots: <code class="literal">IBM</code>. Searching for
+ the word inside a phrase (ie: <code class=
+ "literal">"the IBM company"</code>) will only match the
+ dotted abrreviation if you increase the phrase slack
+ (using the advanced search panel control, or the
+ <code class="literal">o</code> query language
+ modifier). Literal occurences of the word will be
+ matched normally.</p>
+ </div>
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.TIPS.MISC" id=
- "RCL.SEARCH.GUI.TIPS.MISC"></a>3.1.13.3. Others</h4>
+ "RCL.SEARCH.GUI.TIPS.MISC"></a>3.1.13.3.���Others</h4>
</div>
</div>
</div>
-
- <p><b>Using fields. </b>You can use the <a class=
- "link" href="#RCL.SEARCH.LANG" title=
- "3.6. The query language">query language</a> and
- field specifications to only search certain parts of
+ <p><b>Using fields.���</b>You can use the <a class="link"
+ href="#RCL.SEARCH.LANG" title=
+ "3.6.���The query language">query language</a> and field
+ specifications to only search certain parts of
documents. This can be especially helpful with email,
for example only searching emails from a specific
originator: <code class="literal">search tips
from:helpfulgui</code></p>
-
- <p><b>Ajusting the result table columns. </b>When
+ <p><b>Ajusting the result table columns.���</b>When
displaying results in table mode, you can use a right
click on the table headers to activate a pop-up menu
which will let you adjust what columns are displayed.
@@ -3969,30 +3448,25 @@
You can click them to sort by the field displayed in
the column. You can also save the result list in CSV
format.</p>
-
- <p><b>Changing the GUI geometry. </b>It is
- possible to configure the GUI in wide form factor by
- dragging the toolbars to one of the sides (their
- location is remembered between sessions), and moving
- the category filters to a menu (can be set in the
- <span class="guimenu">Preferences</span> →
- <span class="guimenuitem">GUI configuration</span>
- → <span class="guimenuitem">User interface</span>
- panel).</p>
-
- <p><b>Query explanation. </b>You can get an exact
+ <p><b>Changing the GUI geometry.���</b>It is possible to
+ configure the GUI in wide form factor by dragging the
+ toolbars to one of the sides (their location is
+ remembered between sessions), and moving the category
+ filters to a menu (can be set in the <span class=
+ "guimenu">Preferences</span> ��� <span class=
+ "guimenuitem">GUI configuration</span> ��� <span class=
+ "guimenuitem">User interface</span> panel).</p>
+ <p><b>Query explanation.���</b>You can get an exact
description of what the query looked for, including
stem expansion, and Boolean operators used, by clicking
on the result list header.</p>
-
- <p><b>Advanced search history. </b>As of
- <span class="application">Recoll</span> 1.18, you can
- display any of the last 100 complex searches performed
- by using the up and down arrow keys while the advanced
- search panel is active.</p>
-
+ <p><b>Advanced search history.���</b>As of <span class=
+ "application">Recoll</span> 1.18, you can display any
+ of the last 100 complex searches performed by using the
+ up and down arrow keys while the advanced search panel
+ is active.</p>
<p><b>Browsing the result list inside a preview
- window. </b>Entering <span class=
+ window.���</b>Entering <span class=
"keycap"><strong>Shift-Down</strong></span> or
<span class="keycap"><strong>Shift-Up</strong></span>
(<span class="keycap"><strong>Shift</strong></span> +
@@ -4000,26 +3474,23 @@
or the previous document from the result list. Any
secondary search currently active will be executed on
the new document.</p>
-
<p><b>Scrolling the result list from the
- keyboard. </b>You can use <span class=
+ keyboard.���</b>You can use <span class=
"keycap"><strong>PageUp</strong></span> and
<span class="keycap"><strong>PageDown</strong></span>
to scroll the result list, <span class=
"keycap"><strong>Shift+Home</strong></span> to go back
to the first page. These work even while the focus is
in the search entry.</p>
-
<p><b>Result table: moving the focus to the
- table. </b>You can use <span class=
+ table.���</b>You can use <span class=
"keycap"><strong>Ctrl-r</strong></span> to move the
focus from the search entry to the table, and then use
the arrow keys to change the current row. <span class=
"keycap"><strong>Ctrl-Shift-s</strong></span> returns
to the search.</p>
-
- <p><b>Result table: open / preview. </b>With the
- focus in the result table, you can use <span class=
+ <p><b>Result table: open / preview.���</b>With the focus
+ in the result table, you can use <span class=
"keycap"><strong>Ctrl-o</strong></span> to open the
document from the current row, <span class=
"keycap"><strong>Ctrl-Shift-o</strong></span> to open
@@ -4027,63 +3498,54 @@
"command"><strong>recoll</strong></span>, <span class=
"keycap"><strong>Ctrl-d</strong></span> to preview the
document.</p>
-
<p><b>Editing a new search while the focus is not in
- the search entry. </b>You can use the <span class=
+ the search entry.���</b>You can use the <span class=
"keycap"><strong>Ctrl-Shift-S</strong></span> shortcut
to return the cursor to the search entry (and select
the current search text), while the focus is anywhere
in the main window.</p>
-
- <p><b>Forced opening of a preview window. </b>You
- can use <span class=
+ <p><b>Forced opening of a preview window.���</b>You can
+ use <span class=
"keycap"><strong>Shift</strong></span>+Click on a
result list <code class="literal">Preview</code> link
to force the creation of a preview window instead of a
new tab in the existing one.</p>
-
- <p><b>Closing previews. </b>Entering <span class=
+ <p><b>Closing previews.���</b>Entering <span class=
"keycap"><strong>Ctrl-W</strong></span> in a tab will
close it (and, for the last tab, close the preview
window). Entering <span class=
"keycap"><strong>Esc</strong></span> will close the
preview window and all its tabs.</p>
-
- <p><b>Printing previews. </b>Entering <span class=
+ <p><b>Printing previews.���</b>Entering <span class=
"keycap"><strong>Ctrl-P</strong></span> in a preview
window will print the currently displayed text.</p>
-
- <p><b>Quitting. </b>Entering <span class=
+ <p><b>Quitting.���</b>Entering <span class=
"keycap"><strong>Ctrl-Q</strong></span> almost anywhere
will close the application.</p>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.SAVING" id=
- "RCL.SEARCH.SAVING"></a>3.1.14. Saving and
+ "RCL.SEARCH.SAVING"></a>3.1.14.���Saving and
restoring queries (1.21 and later)</h3>
</div>
</div>
</div>
-
<p>Both simple and advanced query dialogs save recent
history, but the amount is limited: old queries will
eventually be forgotten. Also, important queries may be
difficult to find among others. This is why both types of
queries can also be explicitely saved to files, from the
- GUI menus: <span class="guimenu">File</span> →
+ GUI menus: <span class="guimenu">File</span> ���
<span class="guimenuitem">Save last query / Load last
query</span></p>
-
<p>The default location for saved queries is a
subdirectory of the current configuration directory, but
saved queries are ordinary files and can be written or
moved anywhere.</p>
-
<p>Some of the saved query parameters are part of the
preferences (e.g. <code class="literal">autophrase</code>
or the active external indexes), and may differ when the
@@ -4092,32 +3554,26 @@
differences, but will not change the user
preferences.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.GUI.CUSTOM"
- id=
- "RCL.SEARCH.GUI.CUSTOM"></a>3.1.15. Customizing
+ id="RCL.SEARCH.GUI.CUSTOM"></a>3.1.15.���Customizing
the search interface</h3>
</div>
</div>
</div>
-
<p>You can customize some aspects of the search interface
by using the <span class="guimenu">GUI
configuration</span> entry in the <span class=
"guimenu">Preferences</span> menu.</p>
-
<p>There are several tabs in the dialog, dealing with the
interface itself, the parameters used for searching and
returning results, and what indexes are searched.</p>
-
<p><a name="RCL.SEARCH.GUI.CUSTOM.UI" id=
"RCL.SEARCH.GUI.CUSTOM.UI"></a><b>User interface
- parameters: </b></p>
-
+ parameters:���</b></p>
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -4131,7 +3587,6 @@
"literal">#ff0000</code>). The default is
<code class="literal">blue</code>.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Style sheet</span>: The
name of a <span class="application">Qt</span> style
@@ -4146,7 +3601,6 @@
"command"><strong>recoll</strong></span> graphical
parameters: colors, fonts, etc. See the sample file
for a few simple examples.</p>
-
<p>You should be aware that parameters (e.g.: the
background color) set inside the <span class=
"application">Recoll</span> GUI style sheet will
@@ -4160,7 +3614,6 @@
inside the <span class="application">Recoll</span>
GUI.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Maximum text size
highlighted for preview</span> Inserting highlights
@@ -4169,7 +3622,6 @@
processing, and can be disabled over the given text
size to speed up loading.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Prefer HTML to plain text
for preview</span> if set, Recoll will display HTML
@@ -4177,7 +3629,6 @@
problems with the Qt HTML display, you can uncheck
it to display the plain text version instead.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Plain text to HTML line
style</span>: when displaying plain text inside the
@@ -4194,7 +3645,6 @@
recent releases and is probably now the best one:
use PRE tags with line wrapping.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Choose editor
applicationsr</span>: this opens a dialog which
@@ -4204,7 +3654,6 @@
"command"><strong>xdg-open</strong></span> utility,
but you can override it.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Exceptions</span>: even
wen <span class=
@@ -4220,14 +3669,12 @@
"command"><strong>xdg-open</strong></span> which
only supports passing one parameter.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Document filter choice
style</span>: this will let you choose if the
document categories are displayed as a list or a
set of buttons, or a menu.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Start with simple search
mode</span>: this lets you choose the value of the
@@ -4236,7 +3683,6 @@
Language</code>, or the value in use when the
program last exited.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Auto-start simple search
on white space entry</span>: if this is checked, a
@@ -4246,14 +3692,12 @@
This is off by default, you may like it or
not...</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Start with advanced
search dialog open</span> : If you use this dialog
frequently, checking the entries will get it to
open when recoll starts.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Remember sort activation
state</span> if set, Recoll will remember the sort
@@ -4262,11 +3706,9 @@
</li>
</ul>
</div>
-
<p><a name="RCL.SEARCH.GUI.CUSTOM.RL" id=
"RCL.SEARCH.GUI.CUSTOM.RL"></a><b>Result list
- parameters: </b></p>
-
+ parameters:���</b></p>
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -4274,7 +3716,6 @@
<p><span class="guilabel">Number of results in a
result page</span></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Result list font</span>:
There is quite a lot of information shown in the
@@ -4286,7 +3727,6 @@
"command"><strong>qtconfig</strong></span>
command).</p>
</li>
-
<li class="listitem">
<p><a name="RCL.SEARCH.GUI.CUSTOM.RESULTPARA" id=
"RCL.SEARCH.GUI.CUSTOM.RESULTPARA"></a><span class=
@@ -4295,10 +3735,9 @@
presentation of each result list entry. See the
<a class="link" href=
"#RCL.SEARCH.GUI.CUSTOM.RESLIST" title=
- "3.1.15.1. The result list format">result list
+ "3.1.15.1.���The result list format">result list
customisation section</a>.</p>
</li>
-
<li class="listitem">
<p><a name="RCL.SEARCH.GUI.CUSTOM.RESULTHEAD" id=
"RCL.SEARCH.GUI.CUSTOM.RESULTHEAD"></a><span class=
@@ -4307,10 +3746,9 @@
at the end of the result page HTML header. More
detail in the <a class="link" href=
"#RCL.SEARCH.GUI.CUSTOM.RESLIST" title=
- "3.1.15.1. The result list format">result list
+ "3.1.15.1.���The result list format">result list
customisation section.</a></p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Date format</span>:
allows specifying the format used for displaying
@@ -4318,7 +3756,6 @@
specified as an strftime() string (man
strftime).</p>
</li>
-
<li class="listitem">
<p><a name="RCL.SEARCH.GUI.CUSTOM.ABSSEP" id=
"RCL.SEARCH.GUI.CUSTOM.ABSSEP"></a><span class=
@@ -4330,11 +3767,9 @@
</li>
</ul>
</div>
-
<p><a name="RCL.SEARCH.GUI.CUSTOM.SEARCH" id=
"RCL.SEARCH.GUI.CUSTOM.SEARCH"></a><b>Search
- parameters: </b></p>
-
+ parameters:���</b></p>
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -4344,7 +3779,6 @@
shown for identical documents found in different
places.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Stemming language</span>:
stemming obviously depends on the document's
@@ -4352,7 +3786,7 @@
stemming databases which were built during indexing
(this is set in the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF" title=
- "5.4.2. Recoll main configuration file, recoll.conf">
+ "5.4.2.���Recoll main configuration file, recoll.conf">
main configuration file</a>), or later added with
<span class="command"><strong>recollindex
-s</strong></span> (See the recollindex manual).
@@ -4360,7 +3794,6 @@
be deleted at the next indexing pass unless they
are also added in the configuration file.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Automatically add phrase
to simple searches</span>: a phrase will be
@@ -4370,7 +3803,6 @@
the results where the search terms appear as a
phrase (consecutive and in order).</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Autophrase term frequency
threshold percentage</span>: very frequent terms
@@ -4379,7 +3811,6 @@
cutoff percentage (percentage of the documents
where the term appears).</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Replace abstracts from
documents</span>: this decides if we should
@@ -4387,7 +3818,6 @@
explicit abstract found within the document
itself.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Dynamically build
abstracts</span>: this decides if <span class=
@@ -4398,18 +3828,15 @@
constructed by taking context from the document
information, around the search terms.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Synthetic abstract
size</span>: adjust to taste...</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Synthetic abstract
context words</span>: how many words should be
displayed around each term occurrence.</p>
</li>
-
<li class="listitem">
<p><span class="guilabel">Query language magic file
name suffixes</span>: a list of words which
@@ -4422,41 +3849,36 @@
</li>
</ul>
</div>
-
<p><a name="RCL.SEARCH.GUI.CUSTOM.EXTRADB" id=
"RCL.SEARCH.GUI.CUSTOM.EXTRADB"></a><b>External
- indexes: </b>This panel will let you browse for
+ indexes:���</b>This panel will let you browse for
additional indexes that you may want to search. External
indexes are designated by their database directory (ie:
<code class=
"filename">/home/someothergui/.recoll/xapiandb</code>,
<code class=
"filename">/usr/local/recollglobal/xapiandb</code>).</p>
-
<p>Once entered, the indexes will appear in the
<span class="guilabel">External indexes</span> list, and
you can chose which ones you want to use at any moment by
checking or unchecking their entries.</p>
-
<p>Your main database (the one the current configuration
indexes to), is always implicitly active. If this is not
desirable, you can set up your configuration so that it
indexes, for example, an empty directory. An alternative
indexer may also need to implement a way of purging the
index from stale data,</p>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.GUI.CUSTOM.RESLIST" id=
- "RCL.SEARCH.GUI.CUSTOM.RESLIST"></a>3.1.15.1. The
+ "RCL.SEARCH.GUI.CUSTOM.RESLIST"></a>3.1.15.1.���The
result list format</h4>
</div>
</div>
</div>
-
<p>Newer versions of Recoll (from 1.17) normally use
WebKit HTML widgets for the result list and the
<a class="link" href=
@@ -4467,17 +3889,14 @@
can do with the older Qt QTextBrowser, but still, it is
possible to decide what data each result will contain,
and how it will be displayed.</p>
-
<p>The result list presentation can be exhaustively
customized by adjusting two elements:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
<li class="listitem">
<p>The paragraph format</p>
</li>
-
<li class="listitem">
<p>HTML code inside the header section. For
versions 1.21 and later, this is also used for
@@ -4487,12 +3906,10 @@
</li>
</ul>
</div>
-
<p>The paragraph format and the header fragment can be
edited from the <span class="guilabel">Result
list</span> tab of the <span class="guilabel">GUI
configuration</span>.</p>
-
<p>The header fragment is used both for the result list
and the snippets window. The snippets list is a table
and has a <code class="literal">snippets</code> class
@@ -4500,13 +3917,11 @@
table, with class <code class="literal">respar</code>,
but this can be changed by editing the paragraph
format.</p>
-
<p>There are a few examples on the <a class="ulink"
href="http://www.recoll.org/custom.html" target=
"_top">page about customising the result list</a> on
the <span class="application">Recoll</span> web
site.</p>
-
<div class="sect4">
<div class="titlepage">
<div>
@@ -4518,84 +3933,65 @@
</div>
</div>
</div>
-
<p>This is an arbitrary HTML string where the
following printf-like <code class="literal">%</code>
substitutions will be performed:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
<li class="listitem">
- <p><b>%A. </b>Abstract</p>
+ <p><b>%A.���</b>Abstract</p>
</li>
-
<li class="listitem">
- <p><b>%D. </b>Date</p>
+ <p><b>%D.���</b>Date</p>
</li>
-
<li class="listitem">
- <p><b>%I. </b>Icon image name. This is
- normally determined from the MIME type. The
- associations are defined inside the <a class=
- "link" href="#RCL.INSTALL.CONFIG.MIMECONF"
- title=
- "5.4.5. The mimeconf file"><code class=
+ <p><b>%I.���</b>Icon image name. This is normally
+ determined from the MIME type. The associations
+ are defined inside the <a class="link" href=
+ "#RCL.INSTALL.CONFIG.MIMECONF" title=
+ "5.4.5.���The mimeconf file"><code class=
"filename">mimeconf</code> configuration
file</a>. If a thumbnail for the file is found
at the standard Freedesktop location, this will
be displayed instead.</p>
</li>
-
<li class="listitem">
- <p><b>%K. </b>Keywords (if any)</p>
+ <p><b>%K.���</b>Keywords (if any)</p>
</li>
-
<li class="listitem">
- <p><b>%L. </b>Precooked Preview, Edit, and
+ <p><b>%L.���</b>Precooked Preview, Edit, and
possibly Snippets links</p>
</li>
-
<li class="listitem">
- <p><b>%M. </b>MIME type</p>
+ <p><b>%M.���</b>MIME type</p>
</li>
-
<li class="listitem">
- <p><b>%N. </b>result Number inside the
- result page</p>
+ <p><b>%N.���</b>result Number inside the result
+ page</p>
</li>
-
<li class="listitem">
- <p><b>%P. </b>Parent folder Url. In the
- case of an embedded document, this is the
- parent folder for the top level container
- file.</p>
+ <p><b>%P.���</b>Parent folder Url. In the case of
+ an embedded document, this is the parent folder
+ for the top level container file.</p>
</li>
-
<li class="listitem">
- <p><b>%R. </b>Relevance percentage</p>
+ <p><b>%R.���</b>Relevance percentage</p>
</li>
-
<li class="listitem">
- <p><b>%S. </b>Size information</p>
+ <p><b>%S.���</b>Size information</p>
</li>
-
<li class="listitem">
- <p><b>%T. </b>Title or Filename if not
- set.</p>
+ <p><b>%T.���</b>Title or Filename if not set.</p>
</li>
-
<li class="listitem">
- <p><b>%t. </b>Title or Filename if not
- set.</p>
+ <p><b>%t.���</b>Title or Filename if not set.</p>
</li>
-
<li class="listitem">
- <p><b>%U. </b>Url</p>
+ <p><b>%U.���</b>Url</p>
</li>
</ul>
</div>
-
<p>The format of the Preview, Edit, and Snippets
links is <code class="literal"><a
href="P%N"></code>, <code class="literal"><a
@@ -4603,7 +3999,6 @@
href="A%N"></code> where <em class=
"replaceable"><code>docnum</code></em> (%N) expands
to the document number inside the result page).</p>
-
<p>A link target defined as <code class=
"literal">"F%N"</code> will open the document
corresponding to the <code class="literal">%P</code>
@@ -4611,9 +4006,7 @@
manager window on the folder where the container file
resides. E.g.:</p>
<pre class="programlisting">
-<a href="F%N">%P</a>
-</pre>
-
+ <a href="F%N">%P</a></pre>
<p>A link target defined as <code class=
"literal">R%N|<em class=
"replaceable"><code>scriptname</code></em></code>
@@ -4621,9 +4014,8 @@
(if the document is embedded, the script will be
started on the top-level parent). See the <a class=
"link" href="#RCL.SEARCH.GUI.RUNSCRIPT" title=
- "3.1.4. Running arbitrary commands on result files (1.20 and later)">
+ "3.1.4.���Running arbitrary commands on result files (1.20 and later)">
section about defining scripts</a>.</p>
-
<p>In addition to the predefined values above, all
strings like <code class=
"literal">%(fieldname)</code> will be replaced by the
@@ -4633,7 +4025,7 @@
of indexed but not stored fields is not known at this
point in the search process (see <a class="link"
href="#RCL.PROGRAM.FIELDS" title=
- "4.2. Field data processing">field
+ "4.2.���Field data processing">field
configuration</a>). There are currently very few
fields stored by default, apart from the values above
(only <code class="literal">author</code> and
@@ -4642,7 +4034,6 @@
be useful. An example candidate would be the
<code class="literal">recipient</code> field which is
generated by the message input handlers.</p>
-
<p>The default value for the paragraph format string
is:</p>
<pre class="screen">
@@ -4654,14 +4045,12 @@
"%A %K</td>\n"
"</tr></table>\n"
</pre>
-
<p>You may, for example, try the following for a more
web-like experience:</p>
<pre class="screen">
<u><b><a href="P%N">%T</a></b></u><br>
%A<font color=#008000>%U - %S</font> - %L
</pre>
-
<p>Note that the P%N link in the above paragraph
makes the title a preview link. Or the clean
looking:</p>
@@ -4673,12 +4062,10 @@
<tr><td><div>%A</div></td></tr>
</table>%K
</pre>
-
<p>These samples, and some others are <a class=
"ulink" href="http://www.recoll.org/custom.html"
target="_top">on the web site, with pictures to show
how they look.</a></p>
-
<p>It is also possible to <a class="link" href=
"#RCL.SEARCH.GUI.CUSTOM.ABSSEP">define the value of
the snippet separator inside the abstract
@@ -4687,56 +4074,49 @@
</div>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.SEARCH.KIO" id=
- "RCL.SEARCH.KIO"></a>3.2. Searching with the KDE
- KIO slave</h2>
- </div>
- </div>
- </div>
-
+ "RCL.SEARCH.KIO"></a>3.2.���Searching with the KDE KIO
+ slave</h2>
+ </div>
+ </div>
+ </div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.KIO.INTRO"
- id="RCL.SEARCH.KIO.INTRO"></a>3.2.1. What's
+ id="RCL.SEARCH.KIO.INTRO"></a>3.2.1.���What's
this</h3>
</div>
</div>
</div>
-
<p>The <span class="application">Recoll</span> KIO slave
allows performing a <span class=
"application">Recoll</span> search by entering an
appropriate URL in a KDE open dialog, or with an
HTML-based interface displayed in <span class=
"command"><strong>Konqueror</strong></span>.</p>
-
<p>The HTML-based interface is similar to the Qt-based
interface, but slightly less powerful for now. Its
advantage is that you can perform your search while
staying fully within the KDE framework: drag and drop
from the result list works normally and you have your
normal choice of applications for opening files.</p>
-
<p>The alternative interface uses a directory view of
search results. Due to limitations in the current KIO
slave interface, it is currently not obviously useful (to
me).</p>
-
<p>The interface is described in more detail inside a
help file which you can access by entering <code class=
"filename">recoll:/</code> inside the <span class=
"command"><strong>konqueror</strong></span> URL line
(this works only if the recoll KIO slave has been
previously installed).</p>
-
<p>The instructions for building this module are located
in the source tree. See: <code class=
"filename">kde/kio/recoll/00README.txt</code>. Some Linux
@@ -4744,26 +4124,23 @@
before diving into the build process, maybe it's already
out there ready for one-click installation.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.SEARCH.KIO.SEARCHABLEDOCS" id=
- "RCL.SEARCH.KIO.SEARCHABLEDOCS"></a>3.2.2. Searchable
+ "RCL.SEARCH.KIO.SEARCHABLEDOCS"></a>3.2.2.���Searchable
documents</h3>
</div>
</div>
</div>
-
<p>As a sample application, the <span class=
"application">Recoll</span> KIO slave could allow
preparing a set of HTML documents (for example a manual)
so that they become their own search interface inside
<span class=
"command"><strong>konqueror</strong></span>.</p>
-
<p>This can be done by either explicitly inserting
<code class="literal"><a
href="recoll://..."></code> links around some document
@@ -4772,7 +4149,7 @@
the documents, like the following example, which would
initiate a search by double-clicking any term:</p>
<pre class="programlisting">
-<script language="JavaScript">
+ <script language="JavaScript">
function recollsearch() {
var t = document.getSelection();
window.location.href = 'recoll://search/query?qtp=a&p=0&q=' +
@@ -4785,22 +4162,19 @@
</pre>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.SEARCH.COMMANDLINE" id=
- "RCL.SEARCH.COMMANDLINE"></a>3.3. Searching on
- the command line</h2>
- </div>
- </div>
- </div>
-
+ "RCL.SEARCH.COMMANDLINE"></a>3.3.���Searching on the
+ command line</h2>
+ </div>
+ </div>
+ </div>
<p>There are several ways to obtain search results as a
text stream, without a graphical interface:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -4811,28 +4185,24 @@
"command"><strong>recollq</strong></span> (through a
link).</p>
</li>
-
<li class="listitem">
<p>By using the <span class=
"command"><strong>recollq</strong></span>
program.</p>
</li>
-
<li class="listitem">
<p>By writing a custom <span class=
"application">Python</span> program, using the
<a class="link" href="#RCL.PROGRAM.PYTHONAPI" title=
- "4.3. Python API">Recoll Python API</a>.</p>
+ "4.3.���Python API">Recoll Python API</a>.</p>
</li>
</ul>
</div>
-
<p>The first two methods work in the same way and
accept/need the same arguments (except for the additional
<code class="option">-t</code> to <span class=
"command"><strong>recoll</strong></span>). The query to be
executed is specified as command line arguments.</p>
-
<p><span class="command"><strong>recollq</strong></span> is
not built by default. You can use the <code class=
"filename">Makefile</code> in the <code class=
@@ -4845,7 +4215,6 @@
-t</code>, which takes the exact same parameters and
options which are described for <span class=
"command"><strong>recollq</strong></span></p>
-
<p><span class="command"><strong>recollq</strong></span>
has a man page (not installed by default, look in the
<code class="filename">doc/man</code> directory). The Usage
@@ -4886,10 +4255,9 @@
for use by other programs. Use a normal query with option -m to
see the field names.
</pre>
-
<p>Sample execution:</p>
<pre class="programlisting">
-recollq 'ilur -nautique mime:text/html'
+ recollq 'ilur -nautique mime:text/html'
Recoll query: ((((ilur:(wqf=11) OR ilurs) AND_NOT (nautique:(wqf=11)
OR nautiques OR nautiqu OR nautiquement)) FILTER Ttext/html))
4 results
@@ -4899,22 +4267,19 @@
text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/recu-chasse-maree....
</pre>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.SEARCH.SYNONYMS" id=
- "RCL.SEARCH.SYNONYMS"></a>3.4. Using Synonyms
+ "RCL.SEARCH.SYNONYMS"></a>3.4.���Using Synonyms
(1.22)</h2>
</div>
</div>
</div>
-
- <p><b>Term synonyms: </b>there are a number of ways to
- use term synonyms for searching text:</p>
-
+ <p><b>Term synonyms:���</b>there are a number of ways to use
+ term synonyms for searching text:</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -4924,7 +4289,6 @@
synonyms, or by reducing all synonym terms to a
canonical one.</p>
</li>
-
<li class="listitem">
<p>At query time, they can be used to match texts
containing terms which are synonyms of the ones
@@ -4936,16 +4300,13 @@
</li>
</ul>
</div>
-
<p><span class="application">Recoll</span> only uses
synonyms at query time. A user query term which part of a
synonym group will be optionally expanded into an
<code class="literal">OR</code> query for all terms in the
group.</p>
-
<p>Synonym groups are defined inside ordinary text files.
Each line in the file defines a group.</p>
-
<p>Example:</p>
<pre class="programlisting">
hi hello "good morning"
@@ -4953,36 +4314,29 @@
# not sure about "au revoir" though. Is this english ?
bye goodbye "see you" \
"au revoir"
-
-</pre>
-
+ </pre>
<p>As usual, lines beginning with a <code class=
"literal">#</code> are comments, empty lines are ignored,
and lines can be continued by ending them with a
backslash.</p>
-
<p>Multi-word synonyms are supported, but be aware that
these will generate phrase queries, which may degrade
performance and will disable stemming expansion for the
phrase terms.</p>
-
<p>The synonyms file can be specified in the <span class=
"guilabel">Search parameters</span> tab of the <span class=
"guilabel">GUI configuration</span> <span class=
"guilabel">Preferences</span> menu entry, or as an option
for command-line searches.</p>
-
<p>Once the file is defined, the use of synonyms can be
enabled or disabled directly from the <span class=
"guilabel">Preferences</span> menu.</p>
-
<p>The synonyms are searched for matches with user terms
after the latter are stem-expanded, but the contents of the
synonyms file itself is not subjected to stem expansion.
This means that a match will not be found if the form
present in the synonyms file is not present anywhere in the
document set.</p>
-
<p>The synonyms function is probably not going to help you
find your letters to Mr. Smith. It is best used for
domain-specific searches. For example, it was initially
@@ -4990,24 +4344,20 @@
documents: the synonyms file would contains nicknames and
aliases for each of the persons of interest.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.SEARCH.PTRANS" id=
- "RCL.SEARCH.PTRANS"></a>3.5. Path
- translations</h2>
- </div>
- </div>
- </div>
-
+ "RCL.SEARCH.PTRANS"></a>3.5.���Path translations</h2>
+ </div>
+ </div>
+ </div>
<p>In some cases, the document paths stored inside the
index do not match the actual ones, so that document
previews and accesses will fail. This can occur in a number
of circumstances:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -5024,7 +4374,6 @@
"filename">/net/server/home/me</code> on the local
machine.</p>
</li>
-
<li class="listitem">
<p>The case may also occur with removable disks. It
is perfectly possible to configure an index to live
@@ -5033,7 +4382,6 @@
so that the documents paths from the index are
invalid.</p>
</li>
-
<li class="listitem">
<p>As a last exemple, one could imagine that a big
directory has been moved, but that it is currently
@@ -5041,82 +4389,68 @@
</li>
</ul>
</div>
-
<p><span class="application">Recoll</span> has a facility
for rewriting access paths when extracting the data from
the index. The translations can be defined for the main
index and for any additional query index.</p>
-
<p>The path translation facility will be useful whenever
the documents paths seen by the indexer are not the same as
the ones which should be used at query time.</p>
-
<p>In the above NFS example, <span class=
"application">Recoll</span> could be instructed to rewrite
any <code class="filename">file:///home/me</code> URL from
the index to <code class=
"filename">file:///net/server/home/me</code>, allowing
accesses from the client.</p>
-
<p>The translations are defined in the <a class="link"
href="#RCL.INSTALL.CONFIG.PTRANS" title=
- "5.4.7. The ptrans file"><code class=
+ "5.4.7.���The ptrans file"><code class=
"filename">ptrans</code></a> configuration file, which can
be edited by hand or from the GUI external indexes
configuration dialog: <span class=
- "guimenu">Preferences</span> → <span class=
+ "guimenu">Preferences</span> ��� <span class=
"guimenuitem">External index dialog</span>, then click the
<span class="guilabel">Paths translations</span> button on
the right below the index list.</p>
-
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-
<p>Due to a current bug, the GUI must be restarted after
changing the <code class="filename">ptrans</code> values
(even when they were changed from the GUI).</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
- "RCL.SEARCH.LANG" id=
- "RCL.SEARCH.LANG"></a>3.6. The query
- language</h2>
- </div>
- </div>
- </div>
-
+ "RCL.SEARCH.LANG" id="RCL.SEARCH.LANG"></a>3.6.���The
+ query language</h2>
+ </div>
+ </div>
+ </div>
<p>The query language processor is activated in the GUI
simple search entry when the search mode selector is set to
<span class="guilabel">Query Language</span>. It can also
be used with the KIO slave or the command line search. It
broadly has the same capabilities as the complex search
interface in the GUI.</p>
-
<p>The language was based on the now defunct <a class=
"ulink" href=
"http://www.xesam.org/main/XesamUserSearchLanguage95"
target="_top">Xesam</a> user search language
specification.</p>
-
<p>If the results of a query language search puzzle you and
you doubt what has been actually searched for, you can use
the GUI <code class="literal">Show Query</code> link at the
top of the result list to check the exact query which was
finally executed by Xapian.</p>
-
<p>Here follows a sample request that we are going to
explain:</p>
<pre class="programlisting">
author:"john doe" Beatles OR Lennon Live OR Unplugged -potatoes
-
-</pre>
-
+ </pre>
<p>This would search for all documents with <em class=
"replaceable"><code>John Doe</code></em> appearing as a
phrase in the author field (exactly what this is would
@@ -5129,7 +4463,6 @@
<em class="replaceable"><code>unplugged</code></em> but not
<em class="replaceable"><code>potatoes</code></em> (in any
part of the document).</p>
-
<p>An element is composed of an optional field
specification, and a value, separated by a colon (the field
separator is the last colon in the element). Examples:
@@ -5138,11 +4471,9 @@
<em class="replaceable"><code>dc:title:grandet</code></em>
<em class="replaceable"><code>dc:title:"eugenie
grandet"</code></em></p>
-
<p>The colon, if present, means "contains". Xesam defines
other relations, which are mostly unsupported for now
(except in special cases, described further down).</p>
-
<p>All elements in the search entry are normally combined
with an implicit AND. It is possible to specify that
elements be OR'ed instead, as in <em class=
@@ -5163,17 +4494,14 @@
"replaceable"><code>word2</code></em>) <code class=
"literal">OR</code> <em class=
"replaceable"><code>word3</code></em>.</p>
-
<p><span class="application">Recoll</span> versions 1.21
and later, allow using parentheses to group elements, which
will sometimes make things clearer, and may allow
expressing combinations which would have been difficult
otherwise.</p>
-
<p>An element preceded by a <code class="literal">-</code>
specifies a term that should <span class=
"emphasis"><em>not</em></span> appear.</p>
-
<p>As usual, words inside quotes define a phrase (the order
of words is significant), so that <em class=
"replaceable"><code>title:"prejudice pride"</code></em> is
@@ -5181,47 +4509,35 @@
"replaceable"><code>title:prejudice
title:pride</code></em>, and is unlikely to find a
result.</p>
-
<p>Words inside phrases and capitalized words are not
stem-expanded. Wildcards may be used anywhere inside a
term. Specifying a wild-card on the left of a term can
produce a very slow search (or even an incorrect one if the
expansion is truncated because of excessive size). Also see
<a class="link" href="#RCL.SEARCH.WILDCARDS" title=
- "3.8.1. More about wildcards">More about
- wildcards</a>.</p>
-
+ "3.8.1.���More about wildcards">More about wildcards</a>.</p>
<p>To save you some typing, recent <span class=
"application">Recoll</span> versions (1.20 and later)
interpret a comma-separated list of terms as an AND list
inside the field. Use slash characters ('/') for an OR
list. No white space is allowed. So</p>
- <pre class="programlisting">
-author:john,lennon
-</pre>
-
+ <pre class="programlisting">author:john,lennon</pre>
<p>will search for documents with <code class=
"literal">john</code> and <code class=
"literal">lennon</code> inside the <code class=
"literal">author</code> field (in any order), and</p>
- <pre class="programlisting">
-author:john/ringo
-</pre>
-
+ <pre class="programlisting">author:john/ringo</pre>
<p>would search for <code class="literal">john</code> or
<code class="literal">ringo</code>.</p>
-
<p>Modifiers can be set on a double-quote value, for
example to specify a proximity search (unordered). See
<a class="link" href="#RCL.SEARCH.LANG.MODIFIERS" title=
- "3.6.1. Modifiers">the modifier section</a>. No space
- must separate the final double-quote and the modifiers
- value, e.g. <em class="replaceable"><code>"two
+ "3.6.1.���Modifiers">the modifier section</a>. No space must
+ separate the final double-quote and the modifiers value,
+ e.g. <em class="replaceable"><code>"two
one"po10</code></em></p>
-
<p><span class="application">Recoll</span> currently
manages the following default fields:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -5231,25 +4547,21 @@
data to be searched for in the document title or
subject.</p>
</li>
-
<li class="listitem">
<p><code class="literal">author</code> or
<code class="literal">from</code> for searching the
documents originators.</p>
</li>
-
<li class="listitem">
<p><code class="literal">recipient</code> or
<code class="literal">to</code> for searching the
documents recipients.</p>
</li>
-
<li class="listitem">
<p><code class="literal">keyword</code> for searching
the document-specified keywords (few documents
actually have any).</p>
</li>
-
<li class="listitem">
<p><code class="literal">filename</code> for the
document's file name. This is not necessarily set for
@@ -5262,7 +4574,6 @@
document format, for example the attachment file name
for an email attachment.</p>
</li>
-
<li class="listitem">
<p><code class="literal">containerfilename</code>.
This is set for all documents, both top-level and
@@ -5275,7 +4586,6 @@
This avoids getting matches for all the sub-documents
when searching for the container file name.</p>
</li>
-
<li class="listitem">
<p><code class="literal">ext</code> specifies the
file name extension (Ex: <code class=
@@ -5283,7 +4593,6 @@
</li>
</ul>
</div>
-
<p><span class="application">Recoll</span> 1.20 and later
have a way to specify aliases for the field names, which
will save typing, for example by aliasing <code class=
@@ -5292,18 +4601,15 @@
"literal">containerfilename</code> to <em class=
"replaceable"><code>cfn</code></em>. See the <a class=
"link" href="#RCL.INSTALL.CONFIG.FIELDS" title=
- "5.4.3. The fields file">section about the
- <code class="filename">fields</code> file</a></p>
-
+ "5.4.3.���The fields file">section about the <code class=
+ "filename">fields</code> file</a></p>
<p>The document input handlers used while indexing have the
possibility to create other fields with arbitrary names,
and aliases may be defined in the configuration, so that
the exact field search possibilities may be different for
you if someone took care of the customisation.</p>
-
<p>The field syntax also supports a few field-like, but
special, criteria:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -5316,35 +4622,29 @@
for a bug in versions 1.19 to 1.19.11p1). Wildcards
will be expanded, but please <a class="link" href=
"#RCL.SEARCH.WILDCARDS.PATH" title=
- "3.8.1.1. Wildcards and path filtering">have a
+ "3.8.1.1.���Wildcards and path filtering">have a
look</a> at an important limitation of wildcards in
path filters.</p>
-
<p>Relative paths also make sense, for example,
<code class="literal">dir:share/doc</code> would
match either <code class=
"filename">/usr/share/doc</code> or <code class=
"filename">/usr/local/share/doc</code></p>
-
<p>Several <code class="literal">dir</code> clauses
can be specified, both positive and negative. For
example the following makes sense:</p>
<pre class="programlisting">
dir:recoll dir:src -dir:utils -dir:common
-
-</pre>
-
+ </pre>
<p>This would select results which have both
<code class="filename">recoll</code> and <code class=
"filename">src</code> in the path (in any order), and
which have not either <code class=
"filename">utils</code> or <code class=
"filename">common</code>.</p>
-
<p>You can also use <code class="literal">OR</code>
conjunctions with <code class="literal">dir:</code>
clauses.</p>
-
<p>A special aspect of <code class=
"literal">dir</code> clauses is that the values in
the index are not transcoded to UTF-8, and never
@@ -5355,11 +4655,9 @@
character set conversion issues. Non-ASCII UNIX file
paths are an unending source of trouble and are best
avoided.</p>
-
<p>You need to use double-quotes around the path
value if it contains space characters.</p>
</li>
-
<li class="listitem">
<p><code class="literal">size</code> for filtering
the results on file size. Example: <code class=
@@ -5374,7 +4672,6 @@
"literal">size>1k</code> to search for files
bigger than 1000 bytes.</p>
</li>
-
<li class="listitem">
<p><code class="literal">date</code> for searching or
filtering on dates. The syntax for the argument is
@@ -5402,7 +4699,6 @@
"literal">/</code> is present but an element is
missing, the missing element is interpreted as the
lowest or highest date in the index. Examples:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: circle;">
@@ -5411,41 +4707,34 @@
"literal">2001-03-01/2002-05-01</code> the
basic syntax for an interval of dates.</p>
</li>
-
<li class="listitem">
<p><code class=
"literal">2001-03-01/P1Y2M</code> the same
specified with a period.</p>
</li>
-
<li class="listitem">
<p><code class="literal">2001/</code> from the
beginning of 2001 to the latest date in the
index.</p>
</li>
-
<li class="listitem">
<p><code class="literal">2001</code> the whole
year of 2001</p>
</li>
-
<li class="listitem">
<p><code class="literal">P2D/</code> means 2
days ago up to now if there are no documents
with dates in the future.</p>
</li>
-
<li class="listitem">
<p><code class="literal">/2003</code> all
documents from 2003 or older.</p>
</li>
</ul>
</div>
-
<p>Periods can also be specified with small letters
(ie: p2y).</p>
</li>
-
<li class="listitem">
<p><code class="literal">mime</code> or <code class=
"literal">format</code> for specifying the MIME type.
@@ -5460,7 +4749,6 @@
"literal">mime</code> specification is not supported
and will produce strange results.</p>
</li>
-
<li class="listitem">
<p><code class="literal">type</code> or <code class=
"literal">rclcat</code> for specifying the category
@@ -5476,11 +4764,9 @@
</li>
</ul>
</div>
-
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-
<p><code class="literal">mime</code>, <code class=
"literal">rclcat</code>, <code class=
"literal">size</code> and <code class=
@@ -5488,11 +4774,9 @@
query (they are applied as a final filter), even if set
with other terms inside a parenthese.</p>
</div>
-
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-
<p><code class="literal">mime</code> (or the equivalent
<code class="literal">rclcat</code>) is the <span class=
"emphasis"><em>only</em></span> field with an
@@ -5500,24 +4784,21 @@
use <code class="literal">OR</code> with <code class=
"literal">ext</code> terms for example.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.SEARCH.LANG.MODIFIERS" id=
- "RCL.SEARCH.LANG.MODIFIERS"></a>3.6.1. Modifiers</h3>
- </div>
- </div>
- </div>
-
+ "RCL.SEARCH.LANG.MODIFIERS"></a>3.6.1.���Modifiers</h3>
+ </div>
+ </div>
+ </div>
<p>Some characters are recognized as search modifiers
when found immediately after the closing double quote of
a phrase, as in <code class="literal">"some
term"modifierchars</code>. The actual "phrase" can be a
single term of course. Supported modifiers:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -5527,14 +4808,12 @@
<code class="literal">p</code> because stemming is
off by default for phrases).</p>
</li>
-
<li class="listitem">
<p><code class="literal">s</code> can be used to
turn off synonym expansion, if a synonyms file is
in place (only for <span class=
"application">Recoll</span> 1.22 and later).</p>
</li>
-
<li class="listitem">
<p><code class="literal">o</code> can be used to
specify a "slack" for phrase and proximity
@@ -5544,25 +4823,21 @@
integer number, this is the slack, else the default
is 10.</p>
</li>
-
<li class="listitem">
<p><code class="literal">p</code> can be used to
turn the default phrase search into a proximity one
(unordered). Example: <code class="literal">"order
any in"p</code></p>
</li>
-
<li class="listitem">
<p><code class="literal">C</code> will turn on case
sensitivity (if the index supports it).</p>
</li>
-
<li class="listitem">
<p><code class="literal">D</code> will turn on
diacritics sensitivity (if the index supports
it).</p>
</li>
-
<li class="listitem">
<p>A weight can be specified for a query element by
specifying a decimal value at the start of the
@@ -5573,56 +4848,48 @@
</div>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.SEARCH.CASEDIAC" id=
- "RCL.SEARCH.CASEDIAC"></a>3.7. Search case and
+ "RCL.SEARCH.CASEDIAC"></a>3.7.���Search case and
diacritics sensitivity</h2>
</div>
</div>
</div>
-
<p>For <span class="application">Recoll</span> versions
1.18 and later, and <span class="emphasis"><em>when working
with a raw index</em></span> (not the default), searches
can be sensitive to character case and diacritics. How this
happens is controlled by configuration variables and what
search data is entered.</p>
-
<p>The general default is that searches entered without
upper-case or accented characters are insensitive to case
and diacritics. An entry of <code class=
"literal">resume</code> will match any of <code class=
"literal">Resume</code>, <code class=
"literal">RESUME</code>, <code class=
- "literal">résumé</code>, <code class=
- "literal">Résumé</code> etc.</p>
-
+ "literal">r���sum���</code>, <code class=
+ "literal">R���sum���</code> etc.</p>
<p>Two configuration variables can automate switching on
sensitivity (they were documented but actually did nothing
until <span class="application">Recoll</span> 1.22):</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">autodiacsens</span></dt>
-
<dd>
<p>If this is set, search sensitivity to diacritics
will be turned on as soon as an accented character
exists in a search term. When the variable is set to
true, <code class="literal">resume</code> will start
a diacritics-unsensitive search, but <code class=
- "literal">résumé</code> will be matched
- exactly. The default value is <span class=
+ "literal">r���sum���</code> will be matched exactly. The
+ default value is <span class=
"emphasis"><em>false</em></span>.</p>
</dd>
-
<dt><span class="term">autocasesens</span></dt>
-
<dd>
<p>If this is set, search sensitivity to character
case will be turned on as soon as an upper-case
@@ -5639,11 +4906,9 @@
</dd>
</dl>
</div>
-
<p>As in the past, capitalizing the first letter of a word
will turn off its stem expansion and have no effect on
case-sensitivity.</p>
-
<p>You can also explicitely activate case and diacritics
sensitivity by using modifiers with the query language.
<code class="literal">C</code> will make the term
@@ -5651,64 +4916,52 @@
make it diacritics-sensitive. Examples:</p>
<pre class="programlisting">
"us"C
-
-</pre>
-
+ </pre>
<p>will search for the term <code class="literal">us</code>
exactly (<code class="literal">Us</code> will not be a
match).</p>
<pre class="programlisting">
"resume"D
-
-</pre>
-
+ </pre>
<p>will search for the term <code class=
"literal">resume</code> exactly (<code class=
- "literal">résumé</code> will not be a
- match).</p>
-
+ "literal">r���sum���</code> will not be a match).</p>
<p>When either case or diacritics sensitivity is activated,
stem expansion is turned off. Having both does not make
much sense.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.SEARCH.ANCHORWILD" id=
- "RCL.SEARCH.ANCHORWILD"></a>3.8. Anchored
- searches and wildcards</h2>
- </div>
- </div>
- </div>
-
+ "RCL.SEARCH.ANCHORWILD"></a>3.8.���Anchored searches
+ and wildcards</h2>
+ </div>
+ </div>
+ </div>
<p>Some special characters are interpreted by <span class=
"application">Recoll</span> in search strings to expand or
specialize the search. Wildcards expand a root term in
controlled ways. Anchor characters can restrict a search to
succeed only if the match is found at or near the beginning
of the document or one of its fields.</p>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.WILDCARDS"
- id="RCL.SEARCH.WILDCARDS"></a>3.8.1. More
- about wildcards</h3>
- </div>
- </div>
- </div>
-
+ id="RCL.SEARCH.WILDCARDS"></a>3.8.1.���More about
+ wildcards</h3>
+ </div>
+ </div>
+ </div>
<p>All words entered in <span class=
"application">Recoll</span> search fields will be
processed for wildcard expansion before the request is
finally executed.</p>
-
<p>The wildcard characters are:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -5716,12 +4969,10 @@
<p><code class="literal">*</code> which matches 0
or more characters.</p>
</li>
-
<li class="listitem">
<p><code class="literal">?</code> which matches a
single character.</p>
</li>
-
<li class="listitem">
<p><code class="literal">[]</code> which allow
defining sets of characters to be matched (ex:
@@ -5735,10 +4986,8 @@
</li>
</ul>
</div>
-
<p>You should be aware of a few things when using
wildcards.</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -5752,7 +5001,6 @@
"replaceable"><code>author:*@domain.com</code></em>
can sometimes be very useful.</p>
</li>
-
<li class="listitem">
<p>For <span class="application">Recoll</span>
version 18 only, when working with a raw index
@@ -5761,39 +5009,35 @@
matched exactly for case and diacritics. This is
not true any more for versions 19 and later.</p>
</li>
-
<li class="listitem">
<p>Using a <code class="literal">*</code> at the
end of a word can produce more matches than you
would think, and strange search results. You can
use the <a class="link" href=
"#RCL.SEARCH.GUI.TERMEXPLORER" title=
- "3.1.9. The term explorer tool">term
- explorer</a> tool to check what completions exist
- for a given term. You can also see exactly what
- search was performed by clicking on the link at the
- top of the result list. In general, for natural
- language terms, stem expansion will produce better
- results than an ending <code class=
- "literal">*</code> (stem expansion is turned off
- when any wildcard character appears in the
- term).</p>
+ "3.1.9.���The term explorer tool">term explorer</a>
+ tool to check what completions exist for a given
+ term. You can also see exactly what search was
+ performed by clicking on the link at the top of the
+ result list. In general, for natural language
+ terms, stem expansion will produce better results
+ than an ending <code class="literal">*</code> (stem
+ expansion is turned off when any wildcard character
+ appears in the term).</p>
</li>
</ul>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.SEARCH.WILDCARDS.PATH" id=
- "RCL.SEARCH.WILDCARDS.PATH"></a>3.8.1.1. Wildcards
+ "RCL.SEARCH.WILDCARDS.PATH"></a>3.8.1.1.���Wildcards
and path filtering</h4>
</div>
</div>
</div>
-
<p>Due to the way that <span class=
"application">Recoll</span> processes wildcards inside
<code class="literal">dir</code> path filtering
@@ -5804,7 +5048,6 @@
"replaceable"><code>/home/me/*/*/docdir</code></em>,
will almost certainly fail if your indexed tree is of
any realistic size.</p>
-
<p>Depending on the case, you may be able to work
around the issue by specifying the paths elements more
narrowly, with a constant prefix, or by using 2
@@ -5820,48 +5063,40 @@
useful in some cases).</p>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.ANCHOR" id=
- "RCL.SEARCH.ANCHOR"></a>3.8.2. Anchored
+ "RCL.SEARCH.ANCHOR"></a>3.8.2.���Anchored
searches</h3>
</div>
</div>
</div>
-
<p>Two characters are used to specify that a search hit
should occur at the beginning or at the end of the text.
<code class="literal">^</code> at the beginning of a term
or phrase constrains the search to happen at the start,
<code class="literal">$</code> at the end force it to
happen at the end.</p>
-
<p>As this function is implemented as a phrase search it
is possible to specify a maximum distance at which the
hit should occur, either through the controls of the
advanced search panel, or using the query language, for
example, as in:</p>
- <pre class="programlisting">
-"^someterm"o10
-</pre>
-
+ <pre class="programlisting">"^someterm"o10</pre>
<p>which would force <code class=
"literal">someterm</code> to be found within 10 terms of
the start of the text. This can be combined with a field
search as in <code class=
"literal">somefield:"^someterm"o10</code> or <code class=
"literal">somefield:someterm$</code>.</p>
-
<p>This feature can also be used with an actual phrase
search, but in this case, the distance applies to the
whole phrase and anchor, so that, for example,
<code class="literal">bla bla my unexpected term</code>
at the beginning of the text would be a match for
<code class="literal">"^my term"o5</code>.</p>
-
<p>Anchored searches can be very useful for searches
inside somewhat structured documents like scientific
articles, in case explicit metadata has not been supplied
@@ -5870,33 +5105,29 @@
occur at the top of the document).</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.SEARCH.DESKTOP" id=
- "RCL.SEARCH.DESKTOP"></a>3.9. Desktop
+ "RCL.SEARCH.DESKTOP"></a>3.9.���Desktop
integration</h2>
</div>
</div>
</div>
-
<p>Being independant of the desktop type has its drawbacks:
<span class="application">Recoll</span> desktop integration
is minimal. However there are a few tools available:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
<p>The <span class="application">KDE</span> KIO Slave
was described in a <a class="link" href=
"#RCL.SEARCH.KIO" title=
- "3.2. Searching with the KDE KIO slave">previous
+ "3.2.���Searching with the KDE KIO slave">previous
section</a>.</p>
</li>
-
<li class="listitem">
<p>If you use a recent version of Ubuntu Linux, you
may find the <a class="ulink" href=
@@ -5904,7 +5135,6 @@
target="_top">Ubuntu Unity Lens</a> module
useful.</p>
</li>
-
<li class="listitem">
<p>There is also an independantly developed <a class=
"ulink" href=
@@ -5913,20 +5143,17 @@
</li>
</ul>
</div>
-
<p>Here follow a few other things that may help.</p>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.SEARCH.SHORTCUT" id=
- "RCL.SEARCH.SHORTCUT"></a>3.9.1. Hotkeying
+ "RCL.SEARCH.SHORTCUT"></a>3.9.1.���Hotkeying
recoll</h3>
</div>
</div>
</div>
-
<p>It is surprisingly convenient to be able to show or
hide the <span class="application">Recoll</span> GUI with
a single keystroke. Recoll comes with a small Python
@@ -5937,20 +5164,17 @@
"https://www.lesbonscomptes.com/recoll/faqsandhowtos/HotRecoll"
target="_top">this wiki page</a>.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="RCL.KICKER-APPLET" id=
- "RCL.KICKER-APPLET"></a>3.9.2. The KDE Kicker
+ "RCL.KICKER-APPLET"></a>3.9.2.���The KDE Kicker
Recoll applet</h3>
</div>
</div>
</div>
-
<p>This is probably obsolete now. Anyway:</p>
-
<p>The <span class="application">Recoll</span> source
tree contains the source code to the <span class=
"application">recoll_applet</span>, a small application
@@ -5958,7 +5182,6 @@
"application">find_applet</span>. This can be used to add
a small <span class="application">Recoll</span> launcher
to the KDE panel.</p>
-
<p>The applet is not automatically built with the main
<span class="application">Recoll</span> programs, nor is
it included with the main source distribution (because
@@ -5968,11 +5191,9 @@
"userinput"><code>configure;make;make
install</code></strong> incantation to build and
install.</p>
-
<p>You can then add the applet to the panel by
right-clicking the panel and choosing the <span class=
"guilabel">Add applet</span> entry.</p>
-
<p>The <span class="application">recoll_applet</span> has
a small text window where you can type a <span class=
"application">Recoll</span> query (in query language
@@ -5984,46 +5205,38 @@
</div>
</div>
</div>
-
<div class="chapter">
<div class="titlepage">
<div>
<div>
<h1 class="title"><a name="RCL.PROGRAM" id=
- "RCL.PROGRAM"></a>Chapter 4. Programming
- interface</h1>
+ "RCL.PROGRAM"></a>Chapter���4.���Programming interface</h1>
</div>
</div>
</div>
-
<p><span class="application">Recoll</span> has an Application
Programming Interface, usable both for indexing and
searching, currently accessible from the <span class=
"application">Python</span> language.</p>
-
<p>Another less radical way to extend the application is to
write input handlers for new types of documents.</p>
-
<p>The processing of metadata attributes for documents
(<code class="literal">fields</code>) is highly
configurable.</p>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.PROGRAM.FILTERS" id=
- "RCL.PROGRAM.FILTERS"></a>4.1. Writing a
- document input handler</h2>
- </div>
- </div>
- </div>
-
+ "RCL.PROGRAM.FILTERS"></a>4.1.���Writing a document
+ input handler</h2>
+ </div>
+ </div>
+ </div>
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Terminology</h3>
-
<p>The small programs or pieces of code which handle the
processing of the different document types for
<span class="application">Recoll</span> used to be called
@@ -6038,7 +5251,6 @@
<code class="literal">filter</code> is still used in many
places though.</p>
</div>
-
<p><span class="application">Recoll</span> input handlers
cooperate to translate from the multitude of input document
formats, simple ones as <span class=
@@ -6051,10 +5263,8 @@
scripts. A few handlers are coded in C++ and live inside
<span class="command"><strong>recollindex</strong></span>.
This latter kind will not be described here.</p>
-
<p>There are currently (since version 1.13) two kinds of
external executable input handlers:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -6069,7 +5279,6 @@
it can store metadata fields and it allows preserving
some of the formatting for the GUI preview.</p>
</li>
-
<li class="listitem">
<p>Multiple <code class="literal">execm</code>
handlers can process multiple files (sparing the
@@ -6091,29 +5300,25 @@
</li>
</ul>
</div>
-
<p>In both cases, handlers deal with regular file system
files, and can process either a single document, or a
linear list of documents in each file. <span class=
"application">Recoll</span> is responsible for performing
up to date checks, deal with more complex embedding and
other upper level issues.</p>
-
<p>A simple handler returning a document in <code class=
"literal">text/plain</code> format, can transfer no
metadata to the indexer. Generic metadata, like document
size or modification date, will be gathered and stored by
the indexer.</p>
-
<p>Handlers that produce <code class=
"literal">text/html</code> format can return an arbitrary
amount of metadata inside HTML <code class=
"literal">meta</code> tags. These will be processed
according to the directives found in the <a class="link"
href="#RCL.PROGRAM.FIELDS" title=
- "4.2. Field data processing"><code class=
+ "4.2.���Field data processing"><code class=
"filename">fields</code> configuration file</a>.</p>
-
<p>The handlers that can handle multiple documents per file
return a single piece of data to identify each document
inside the file. This piece of data, called an <code class=
@@ -6121,26 +5326,23 @@
<span class="application">Recoll</span> to extract the
document at query time, for previewing, or for creating a
temporary file to be opened by a viewer.</p>
-
<p>The following section describes the simple handlers, and
the next one gives a few explanations about the
<code class="literal">execm</code> ones. You could
conceivably write a simple handler with only the elements
in the manual. This will not be the case for the other
ones, for which you will have to look at the code.</p>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.FILTERS.SIMPLE" id=
- "RCL.PROGRAM.FILTERS.SIMPLE"></a>4.1.1. Simple
+ "RCL.PROGRAM.FILTERS.SIMPLE"></a>4.1.1.���Simple
input handlers</h3>
</div>
</div>
</div>
-
<p><span class="application">Recoll</span> simple
handlers are usually shell-scripts, but this is in no way
necessary. Extracting the text from the native format is
@@ -6151,11 +5353,9 @@
some cases the output of the translating program is
completely appropriate, and no intermediate shell-script
is needed.</p>
-
<p>Input handlers are called with a single argument which
is the source file name. They should output the result to
stdout.</p>
-
<p>When writing a handler, you should decide if it will
output plain text or HTML. Plain text is simpler, but you
will not be able to add metadata or vary the output
@@ -6165,9 +5365,8 @@
deciding factor is metadata: <span class=
"application">Recoll</span> has a way to <a class="link"
href="#RCL.PROGRAM.FILTERS.HTML" title=
- "4.1.4. Input handler output">extract metadata from
- the HTML header and use it for field searches.</a>.</p>
-
+ "4.1.4.���Input handler output">extract metadata from the
+ HTML header and use it for field searches.</a>.</p>
<p>The <code class=
"envar">RECOLL_FILTER_FORPREVIEW</code> environment
variable (values <code class="literal">yes</code>,
@@ -6177,28 +5376,24 @@
example stripping uninteresting repeated keywords (ie:
<code class="literal">Subject:</code> for email) when
indexing. This is not essential.</p>
-
<p>You should look at one of the simple handlers, for
example <span class=
"command"><strong>rclps</strong></span> for a starting
point.</p>
-
<p>Don't forget to make your handler executable before
testing !</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.FILTERS.MULTIPLE" id=
- "RCL.PROGRAM.FILTERS.MULTIPLE"></a>4.1.2. "Multiple"
+ "RCL.PROGRAM.FILTERS.MULTIPLE"></a>4.1.2.���"Multiple"
handlers</h3>
</div>
</div>
</div>
-
<p>If you can program and want to write an <code class=
"literal">execm</code> handler, it should not be too
difficult to make sense of one of the existing modules.
@@ -6211,18 +5406,15 @@
"ulink" href="https://bitbucket.org/medoc/recoll/src"
target="_top">BitBucket repository</a> (the sample not in
the distributed release at the moment).</p>
-
<p>You can also have a look at the slightly more complex
<span class="command"><strong>rclzip</strong></span>
which uses Zip file paths as identifiers (<code class=
"literal">ipath</code>).</p>
-
<p><code class="literal">execm</code> handlers sometimes
need to make a choice for the nature of the <code class=
"literal">ipath</code> elements that they use in
communication with the indexer. Here are a few
guidelines:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -6231,13 +5423,11 @@
integer print it, for example, like printf %d would
do).</p>
</li>
-
<li class="listitem">
<p>If at all possible, the data should make some
kind of sense when printed to a log file to help
with debugging.</p>
</li>
-
<li class="listitem">
<p><span class="application">Recoll</span> uses a
colon (<code class="literal">:</code>) as a
@@ -6250,12 +5440,10 @@
</li>
</ul>
</div>
-
<p>In any case, the main goal is that it should be easy
for the handler to extract the target document, given the
file name and the <code class="literal">ipath</code>
element.</p>
-
<p><code class="literal">execm</code> handlers will also
produce a document with a null <code class=
"literal">ipath</code> element. Depending on the type of
@@ -6265,46 +5453,41 @@
useful anyway for some operations, as the parent of the
actual data documents.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.FILTERS.ASSOCIATION" id=
- "RCL.PROGRAM.FILTERS.ASSOCIATION"></a>4.1.3. Telling
+ "RCL.PROGRAM.FILTERS.ASSOCIATION"></a>4.1.3.���Telling
<span class="application">Recoll</span> about the
handler</h3>
</div>
</div>
</div>
-
<p>There are two elements that link a file to the handler
which should process it: the association of file to MIME
type and the association of a MIME type with a
handler.</p>
-
<p>The association of files to MIME types is mostly based
on name suffixes. The types are defined inside the
<a class="link" href="#RCL.INSTALL.CONFIG.MIMEMAP" title=
- "5.4.4. The mimemap file"><code class=
+ "5.4.4.���The mimemap file"><code class=
"filename">mimemap</code> file</a>. Example:</p>
<pre class="programlisting">
.doc = application/msword
</pre>
-
<p>If no suffix association is found for the file name,
<span class="application">Recoll</span> will try to
execute a system command (typically <span class=
"command"><strong>file -i</strong></span> or <span class=
"command"><strong>xdg-mime</strong></span>) to determine
a MIME type.</p>
-
<p>The second element is the association of MIME types to
handlers in the <a class="link" href=
"#RCL.INSTALL.CONFIG.MIMECONF" title=
- "5.4.5. The mimeconf file"><code class=
+ "5.4.5.���The mimeconf file"><code class=
"filename">mimeconf</code> file</a>. A sample will
probably be better than a long explanation:</p>
<pre class="programlisting">
@@ -6319,9 +5502,7 @@
application/x-chm = execm rclchm
</pre>
-
<p>The fragment specifies that:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -6333,7 +5514,6 @@
"literal">text/plain</code> encoded in <code class=
"literal">utf-8</code>.</p>
</li>
-
<li class="listitem">
<p><code class="literal">application/ogg</code>
files are processed by the <span class=
@@ -6343,7 +5523,6 @@
in the header, or <code class=
"literal">utf-8</code> by default).</p>
</li>
-
<li class="listitem">
<p><code class="literal">text/rtf</code> is
processed by <span class=
@@ -6355,7 +5534,6 @@
<span class="command"><strong>unrtf</strong></span>
in the HTML header section.</p>
</li>
-
<li class="listitem">
<p><code class="literal">application/x-chm</code>
is processed by a persistant handler. This is
@@ -6365,23 +5543,20 @@
</ul>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.FILTERS.HTML" id=
- "RCL.PROGRAM.FILTERS.HTML"></a>4.1.4. Input
- handler output</h3>
- </div>
- </div>
- </div>
-
+ "RCL.PROGRAM.FILTERS.HTML"></a>4.1.4.���Input handler
+ output</h3>
+ </div>
+ </div>
+ </div>
<p>Both the simple and persistent input handlers can
return any MIME type to Recoll, which will further
process the data according to the MIME configuration.</p>
-
<p>Most input filters filters produce either <code class=
"literal">text/plain</code> or <code class=
"literal">text/html</code> data. There are exceptions,
@@ -6390,13 +5565,11 @@
"literal">tar</code>, etc.) will usually return the
documents as they are found, without processing them
further.</p>
-
<p>There is nothing to say about <code class=
"literal">text/plain</code> output, except that its
character encoding should be consistent with what is
specified in the <code class="filename">mimeconf</code>
file.</p>
-
<p>For filters producing HTML, the output could be very
minimal like the following example:</p>
<pre class="programlisting">
@@ -6408,12 +5581,10 @@
Some text content
</body>
</html>
-
-</pre>
-
+ </pre>
<p>You should take care to escape some characters inside
the text by transforming them into appropriate entities.
- At the very minimum, "<code class="literal">&</code>"
+ At the very minimum, "<code class="literal">&</code>"
should be transformed into "<code class=
"literal">&amp;</code>", "<code class=
"literal"><</code>" should be transformed into
@@ -6421,33 +5592,28 @@
always properly done by external helper programs which
output HTML, and of course never by those which output
plain text.</p>
-
<p>When encapsulating plain text in an HTML body, the
display of a preview may be improved by enclosing the
text inside <code class="literal"><pre></code>
tags.</p>
-
<p>The character set needs to be specified in the header.
It does not need to be UTF-8 (<span class=
"application">Recoll</span> will take care of translating
it), but it must be accurate for good results.</p>
-
<p><span class="application">Recoll</span> will process
<code class="literal">meta</code> tags inside the header
as possible document fields candidates. Documents fields
can be processed by the indexer in different ways, for
searching or displaying inside query results. This is
described in a <a class="link" href="#RCL.PROGRAM.FIELDS"
- title="4.2. Field data processing">following
+ title="4.2.���Field data processing">following
section.</a></p>
-
<p>By default, the indexer will process the standard
header fields if they are present: <code class=
"literal">title</code>, <code class=
"literal">meta/description</code>, and <code class=
"literal">meta/keywords</code> are both indexed and
stored for query-time display.</p>
-
<p>A predefined non-standard <code class=
"literal">meta</code> tag will also be processed by
<span class="application">Recoll</span> without further
@@ -6460,21 +5626,16 @@
<meta name="date" content="YYYY-mm-dd HH:MM:SS">
or
<meta name="date" content="YYYY-mm-ddTHH:MM:SS">
-
-</pre>
-
+ </pre>
<p>Example:</p>
<pre class="programlisting">
<meta name="date" content="2013-02-24 17:50:00">
-
-</pre>
-
+ </pre>
<p>Input handlers also have the possibility to "invent"
field names. This should also be output as meta tags:</p>
<pre class="programlisting">
<meta name="somefield" content="Some textual data" />
</pre>
-
<p>You can embed HTML markup inside the content of custom
fields, for improving the display inside result lists. In
this case, add a (wildly non-standard) <code class=
@@ -6484,12 +5645,10 @@
<pre class="programlisting">
<meta name="somefield" markup="html" content="Some <i>textual</i> data" />
</pre>
-
<p>As written above, the processing of fields is
described in a <a class="link" href="#RCL.PROGRAM.FIELDS"
- title="4.2. Field data processing">further
+ title="4.2.���Field data processing">further
section</a>.</p>
-
<p>Persistent filters can use another, probably simpler,
method to produce metadata, by calling the <code class=
"literal">setfield()</code> helper method. This avoids
@@ -6501,19 +5660,17 @@
"literal">text/plain</code> and uses <code class=
"literal">setfield()</code> to produce metadata.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.FILTERS.PAGES" id=
- "RCL.PROGRAM.FILTERS.PAGES"></a>4.1.5. Page
+ "RCL.PROGRAM.FILTERS.PAGES"></a>4.1.5.���Page
numbers</h3>
</div>
</div>
</div>
-
<p>The indexer will interpret <code class=
"literal">^L</code> characters in the handler output as
indicating page breaks, and will record them. At query
@@ -6522,25 +5679,22 @@
and DVI handlers generate page breaks.</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.PROGRAM.FIELDS" id=
- "RCL.PROGRAM.FIELDS"></a>4.2. Field data
+ "RCL.PROGRAM.FIELDS"></a>4.2.���Field data
processing</h2>
</div>
</div>
</div>
-
<p><code class="literal">Fields</code> are named pieces of
information in or about documents, like <code class=
"literal">title</code>, <code class=
"literal">author</code>, <code class=
"literal">abstract</code>.</p>
-
<p>The field values for documents can appear in several
ways during indexing: either output by input handlers as
<code class="literal">meta</code> fields in the HTML header
@@ -6548,17 +5702,13 @@
added as attributes of the <code class="literal">Doc</code>
object when using the API, or again synthetized internally
by <span class="application">Recoll</span>.</p>
-
<p>The <span class="application">Recoll</span> query
language allows searching for text in a specific field.</p>
-
<p><span class="application">Recoll</span> defines a number
of default fields. Additional ones can be output by
handlers, and described in the <code class=
"filename">fields</code> configuration file.</p>
-
<p>Fields can be:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -6567,7 +5717,6 @@
(with a specific prefix), and that a field-specific
search is possible.</p>
</li>
-
<li class="listitem">
<p><code class="literal">stored</code>, meaning that
their value is recorded in the index data record for
@@ -6576,15 +5725,12 @@
</li>
</ul>
</div>
-
<p>A field can be either or both indexed and stored. This
and other aspects of fields handling is defined inside the
<code class="filename">fields</code> configuration
file.</p>
-
<p>The sequence of events for field processing is as
follows:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -6597,7 +5743,6 @@
done with fields (the <code class=
"filename">fields</code> file)</p>
</li>
-
<li class="listitem">
<p>If the name for the <code class=
"literal">meta</code> element matches one for a field
@@ -6606,7 +5751,6 @@
prefix defined in the <code class=
"filename">fields</code> file.</p>
</li>
-
<li class="listitem">
<p>If the name for the <code class=
"literal">meta</code> element matches one for a field
@@ -6614,20 +5758,18 @@
stored with the document data record, from which it
can be extracted and displayed at query time.</p>
</li>
-
<li class="listitem">
<p>At query time, if a field search is performed, the
index prefix is computed and the match is only
performed against appropriately prefixed terms in the
index.</p>
</li>
-
<li class="listitem">
<p>At query time, the field can be displayed inside
the result list by using the appropriate directive in
the definition of the <a class="link" href=
"#RCL.SEARCH.GUI.CUSTOM.RESLIST" title=
- "3.1.15.1. The result list format">result list
+ "3.1.15.1.���The result list format">result list
paragraph format</a>. All fields are displayed on the
fields screen of the preview window (which you can
reach through the right-click menu). This is
@@ -6636,13 +5778,11 @@
</li>
</ul>
</div>
-
<p>You can find more information in the <a class="link"
href="#RCL.INSTALL.CONFIG.FIELDS" title=
- "5.4.3. The fields file">section about the
- <code class="filename">fields</code> file</a>, or in
- comments inside the file.</p>
-
+ "5.4.3.���The fields file">section about the <code class=
+ "filename">fields</code> file</a>, or in comments inside
+ the file.</p>
<p>You can also have a look at the <a class="ulink" href=
"https://www.lesbonscomptes.com/recoll/faqsandhowtos/HandleCustomField"
target="_top">example in the FAQs area</a>, detailing how
@@ -6650,39 +5790,34 @@
count</em></span> field to pdf documents for displaying
inside result lists.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.PROGRAM.PYTHONAPI" id=
- "RCL.PROGRAM.PYTHONAPI"></a>4.3. Python API</h2>
- </div>
- </div>
- </div>
-
+ "RCL.PROGRAM.PYTHONAPI"></a>4.3.���Python API</h2>
+ </div>
+ </div>
+ </div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.INTRO" id=
- "RCL.PROGRAM.PYTHONAPI.INTRO"></a>4.3.1. Introduction</h3>
- </div>
- </div>
- </div>
-
+ "RCL.PROGRAM.PYTHONAPI.INTRO"></a>4.3.1.���Introduction</h3>
+ </div>
+ </div>
+ </div>
<p><span class="application">Recoll</span> versions after
1.11 define a Python programming interface, both for
searching and creating/updating an index.</p>
-
<p>The search interface is used in the <span class=
"application">Recoll</span> Ubuntu Unity Lens and the
<span class="application">Recoll</span> Web UI. It can
run queries on any <span class=
"application">Recoll</span> configuration.</p>
-
<p>The index update section of the API may be used to
create and update <span class="application">Recoll</span>
indexes on specific configurations (separate from the
@@ -6691,11 +5826,9 @@
resulting databases can be queried alone, or in
conjunction with regular ones, through the GUI or any of
the query interfaces.</p>
-
<p>The search API is modeled along the Python database
API specification. There were two major changes along
<span class="application">Recoll</span> versions:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -6707,7 +5840,6 @@
to version 2.0 (<span class=
"application">Recoll</span> 1.18.2 and later).</p>
</li>
-
<li class="listitem">
<p>The <code class="literal">recoll</code> module
became a package (with an internal <code class=
@@ -6718,16 +5850,13 @@
</li>
</ul>
</div>
-
<p>We will describe the new API and package structure
here. A paragraph at the end of this section will explain
a few differences and ways to write code compatible with
both versions.</p>
-
<p>The Python interface can be found in the source
package, under <code class=
"filename">python/recoll</code>.</p>
-
<p>The <code class="filename">python/recoll/</code>
directory contains the usual <code class=
"filename">setup.py</code>. After configuring the main
@@ -6740,21 +5869,16 @@
"userinput"><code>python setup.py build</code></strong>
<strong class=
"userinput"><code>python setup.py install</code></strong>
-
-</pre>
-
+ </pre>
<p>As of <span class="application">Recoll</span> 1.19,
the module can be compiled for Python3.</p>
-
<p>The normal <span class="application">Recoll</span>
installer installs the Python2 API along with the main
code. The Python3 version must be explicitely built and
installed.</p>
-
<p>When installing from a repository, and depending on
the distribution, the Python API can sometimes be found
in a separate package.</p>
-
<p>As an introduction, the following small sample will
run a query and list the title and url for each of the
results. It would work with <span class=
@@ -6777,27 +5901,25 @@
print(doc.url, doc.title)
</pre>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.ELEMENTS" id=
- "RCL.PROGRAM.PYTHONAPI.ELEMENTS"></a>4.3.2. Interface
+ "RCL.PROGRAM.PYTHONAPI.ELEMENTS"></a>4.3.2.���Interface
elements</h3>
</div>
</div>
</div>
-
<p>A few elements in the interface are specific and and
need an explanation.</p>
-
<div class="variablelist">
<dl class="variablelist">
- <dt><a name="RCL.PROGRAM.PYTHONAPI.ELEMENTS.IPATH"
- id="RCL.PROGRAM.PYTHONAPI.ELEMENTS.IPATH"></a><span class="term">ipath</span></dt>
-
+ <dt>
+ <a name="RCL.PROGRAM.PYTHONAPI.ELEMENTS.IPATH" id=
+ "RCL.PROGRAM.PYTHONAPI.ELEMENTS.IPATH"></a><span class="term">ipath</span>
+ </dt>
<dd>
<p>This data value (set as a field in the Doc
object) is stored, along with the URL, but not
@@ -6827,11 +5949,10 @@
filesystem indexer, and uses it for such functions
as opening the parent of a given document.</p>
</dd>
-
- <dt><a name="RCL.PROGRAM.PYTHONAPI.ELEMENTS.UDI" id=
- "RCL.PROGRAM.PYTHONAPI.ELEMENTS.UDI"></a><span class=
- "term">udi</span></dt>
-
+ <dt>
+ <a name="RCL.PROGRAM.PYTHONAPI.ELEMENTS.UDI" id=
+ "RCL.PROGRAM.PYTHONAPI.ELEMENTS.UDI"></a><span class="term">udi</span>
+ </dt>
<dd>
<p>An <code class="literal">udi</code> (unique
document identifier) identifies a document. Because
@@ -6850,11 +5971,11 @@
module), but it is an explicit element of the
update interface.</p>
</dd>
-
- <dt><a name=
- "RCL.PROGRAM.PYTHONAPI.ELEMENTS.PARENTUDI" id=
- "RCL.PROGRAM.PYTHONAPI.ELEMENTS.PARENTUDI"></a><span class="term">parent_udi</span></dt>
-
+ <dt>
+ <a name="RCL.PROGRAM.PYTHONAPI.ELEMENTS.PARENTUDI"
+ id=
+ "RCL.PROGRAM.PYTHONAPI.ELEMENTS.PARENTUDI"></a><span class="term">parent_udi</span>
+ </dt>
<dd>
<p>If this attribute is set on a document when
entering it in the index, it designates its
@@ -6883,10 +6004,8 @@
the index. The standard filesystem indexer uses
<code class="literal">parent_udi</code>.</p>
</dd>
-
<dt><span class="term">Stored and indexed
fields</span></dt>
-
<dd>
<p>The <code class="filename">fields</code> file
inside the <span class="application">Recoll</span>
@@ -6897,34 +6016,30 @@
</dl>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.SEARCH" id=
- "RCL.PROGRAM.PYTHONAPI.SEARCH"></a>4.3.3. Python
+ "RCL.PROGRAM.PYTHONAPI.SEARCH"></a>4.3.3.���Python
search interface</h3>
</div>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.PACKAGE" id=
- "RCL.PROGRAM.PYTHONAPI.PACKAGE"></a>4.3.3.1. Recoll
+ "RCL.PROGRAM.PYTHONAPI.PACKAGE"></a>4.3.3.1.���Recoll
package</h4>
</div>
</div>
</div>
-
<p>The <code class="literal">recoll</code> package
contains two modules:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -6935,7 +6050,6 @@
describe the query part, see further for the
update part.</p>
</li>
-
<li class="listitem">
<p>The <code class="literal">rclextract</code>
module contains functions and classes used to
@@ -6944,19 +6058,17 @@
</ul>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.RECOLL" id=
- "RCL.PROGRAM.PYTHONAPI.RECOLL"></a>4.3.3.2. The
+ "RCL.PROGRAM.PYTHONAPI.RECOLL"></a>4.3.3.2.���The
recoll module</h4>
</div>
</div>
</div>
-
<div class="sect4">
<div class="titlepage">
<div>
@@ -6967,19 +6079,16 @@
</div>
</div>
</div>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">connect(confdir=None,
extra_dbs=None, writable = False)</span></dt>
-
<dd>
<p>The <code class="literal">connect()</code>
function connects to one or several
<span class="application">Recoll</span>
index(es) and returns a <code class=
"literal">Db</code> object.</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -6988,13 +6097,11 @@
may specify a configuration directory.
The usual defaults apply.</p>
</li>
-
<li class="listitem">
<p><code class="literal">extra_dbs</code>
is a list of additional indexes (Xapian
directories).</p>
</li>
-
<li class="listitem">
<p><code class="literal">writable</code>
decides if we can index new data through
@@ -7002,7 +6109,6 @@
</li>
</ul>
</div>
-
<p>This call initializes the recoll module, and
it should always be performed before any other
call or object creation.</p>
@@ -7010,7 +6116,6 @@
</dl>
</div>
</div>
-
<div class="sect4">
<div class="titlepage">
<div>
@@ -7021,7 +6126,6 @@
</div>
</div>
</div>
-
<div class="sect5">
<div class="titlepage">
<div>
@@ -7033,34 +6137,27 @@
</div>
</div>
</div>
-
<p>A Db object is created by a <code class=
"literal">connect()</code> call and holds a
connection to a Recoll index.</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">Db.close()</span></dt>
-
<dd>
<p>Closes the connection. You can't do
anything with the <code class=
"literal">Db</code> object after this.</p>
</dd>
-
<dt><span class="term">Db.query(),
Db.cursor()</span></dt>
-
<dd>
<p>These aliases return a blank <code class=
"literal">Query</code> object for this
index.</p>
</dd>
-
<dt><span class=
"term">Db.setAbstractParams(maxchars,
contextwords)</span></dt>
-
<dd>
<p>Set the parameters used to build snippets
(sets of keywords in context text fragments).
@@ -7070,11 +6167,9 @@
defines how many terms are shown around the
keyword.</p>
</dd>
-
<dt><span class="term">Db.termMatch(match_type,
expr, field='', maxlen=-1, casesens=False,
diacsens=False, lang='english')</span></dt>
-
<dd>
<p>Expand an expression against the index
term list. Performs the basic function from
@@ -7089,7 +6184,6 @@
</dl>
</div>
</div>
-
<div class="sect5">
<div class="titlepage">
<div>
@@ -7102,47 +6196,38 @@
</div>
</div>
</div>
-
<p>A <code class="literal">Query</code> object
(equivalent to a cursor in the Python DB API) is
created by a <code class=
"literal">Db.query()</code> call. It is used to
execute index searches.</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">Query.sortby(fieldname,
ascending=True)</span></dt>
-
<dd>
<p>Sort results by <em class=
"replaceable"><code>fieldname</code></em>, in
ascending or descending order. Must be called
before executing the search.</p>
</dd>
-
<dt><span class=
"term">Query.execute(query_string, stemming=1,
stemlang="english")</span></dt>
-
<dd>
<p>Starts a search for <em class=
"replaceable"><code>query_string</code></em>,
a <span class="application">Recoll</span>
search language string.</p>
</dd>
-
<dt><span class=
"term">Query.executesd(SearchData)</span></dt>
-
<dd>
<p>Starts a search for the query defined by
the SearchData object.</p>
</dd>
-
<dt><span class=
"term">Query.fetchmany(size=query.arraysize)</span></dt>
-
<dd>
<p>Fetches the next <code class=
"literal">Doc</code> objects in the current
@@ -7151,37 +6236,29 @@
value of the <code class=
"literal">arraysize</code> data member.</p>
</dd>
-
<dt><span class=
"term">Query.fetchone()</span></dt>
-
<dd>
<p>Fetches the next <code class=
"literal">Doc</code> object from the current
search results.</p>
</dd>
-
<dt><span class=
"term">Query.close()</span></dt>
-
<dd>
<p>Closes the query. The object is unusable
after the call.</p>
</dd>
-
<dt><span class="term">Query.scroll(value,
mode='relative')</span></dt>
-
<dd>
<p>Adjusts the position in the current result
set. <code class="literal">mode</code> can be
<code class="literal">relative</code> or
<code class="literal">absolute</code>.</p>
</dd>
-
<dt><span class=
"term">Query.getgroups()</span></dt>
-
<dd>
<p>Retrieves the expanded query terms as a
list of pairs. Meaningful only after
@@ -7192,19 +6269,15 @@
from the user terms and used in the Xapian
Query.</p>
</dd>
-
<dt><span class=
"term">Query.getxquery()</span></dt>
-
<dd>
<p>Return the Xapian query description as a
Unicode string. Meaningful only after
executexx.</p>
</dd>
-
<dt><span class="term">Query.highlight(text,
ishtml = 0, methods = object)</span></dt>
-
<dd>
<p>Will insert <span "class=rclmatch">,
</span> tags around the match areas in
@@ -7219,11 +6292,9 @@
match and should return a begin and end
tag</p>
</dd>
-
<dt><span class=
"term">Query.makedocabstract(doc, methods =
object))</span></dt>
-
<dd>
<p>Create a snippets abstract for
<code class="literal">doc</code> (a
@@ -7232,10 +6303,8 @@
methods is set, will also perform
highlighting. See the highlight method.</p>
</dd>
-
<dt><span class="term">Query.__iter__() and
Query.next()</span></dt>
-
<dd>
<p>So that things like <code class=
"literal">for doc in query:</code> will
@@ -7243,28 +6312,22 @@
</dd>
</dl>
</div>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class=
"term">Query.arraysize</span></dt>
-
<dd>
<p>Default number of records processed by
fetchmany (r/w).</p>
</dd>
-
<dt><span class=
"term">Query.rowcount</span></dt>
-
<dd>
<p>Number of records returned by the last
execute.</p>
</dd>
-
<dt><span class=
"term">Query.rownumber</span></dt>
-
<dd>
<p>Next index to be fetched from results.
Normally increments after each fetchone()
@@ -7276,7 +6339,6 @@
</dl>
</div>
</div>
-
<div class="sect5">
<div class="titlepage">
<div>
@@ -7288,7 +6350,6 @@
</div>
</div>
</div>
-
<p>A <code class="literal">Doc</code> object
contains index data for a given document. The data
is extracted from the index when searching, or set
@@ -7304,7 +6365,6 @@
as strings. Please refer to the <code class=
"filename">rcldb/rcldoc.h</code> C++ file for a
description of the predefined attributes.</p>
-
<p>At query time, only the fields that are defined
as <code class="literal">stored</code> either by
default or in the <code class=
@@ -7314,53 +6374,41 @@
the document text. See the <code class=
"literal">rclextract</code> module for accessing
document contents.</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">get(key), []
operator</span></dt>
-
<dd>
<p>Retrieve the named doc attribute. You can
also use <code class="literal">getattr(doc,
key)</code> or <code class=
"literal">doc.key</code>.</p>
</dd>
-
<dt><span class="term">doc.key =
value</span></dt>
-
<dd>
<p>Set the the named doc attribute. You can
also use <code class="literal">setattr(doc,
key, value)</code>.</p>
</dd>
-
<dt><span class="term">getbinurl()</span></dt>
-
<dd>
<p>Retrieve the URL in byte array format (no
transcoding), for use as parameter to a
system call.</p>
</dd>
-
<dt><span class=
"term">setbinurl(url)</span></dt>
-
<dd>
<p>Set the URL in byte array format (no
transcoding).</p>
</dd>
-
<dt><span class="term">items()</span></dt>
-
<dd>
<p>Return a dictionary of doc object
keys/values</p>
</dd>
-
<dt><span class="term">keys()</span></dt>
-
<dd>
<p>list of doc object keys (attribute
names).</p>
@@ -7368,7 +6416,6 @@
</dl>
</div>
</div>
-
<div class="sect5">
<div class="titlepage">
<div>
@@ -7381,7 +6428,6 @@
</div>
</div>
</div>
-
<p>A <code class="literal">SearchData</code> object
allows building a query by combining clauses, for
execution by <code class=
@@ -7389,31 +6435,29 @@
in replacement of the query language approach. The
interface is going to change a little, so no
detailed doc for now...</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class=
"term">addclause(type='and'|'or'|'excl'|'phrase'|'near'|'sub',
qstring=string, slack=0, field='', stemming=1,
subSearch=SearchData)</span></dt>
+ <dd></dd>
</dl>
</div>
</div>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.RCLEXTRACT" id=
- "RCL.PROGRAM.PYTHONAPI.RCLEXTRACT"></a>4.3.3.3. The
+ "RCL.PROGRAM.PYTHONAPI.RCLEXTRACT"></a>4.3.3.3.���The
rclextract module</h4>
</div>
</div>
</div>
-
<p>Index queries do not provide document content (only
a partial and unprecise reconstruction is performed to
show the snippets text). In order to access the actual
@@ -7423,7 +6467,6 @@
The <code class="literal">rclextract</code> module
currently provides a single class which can be used to
access the data content for result documents.</p>
-
<div class="sect4">
<div class="titlepage">
<div>
@@ -7434,7 +6477,6 @@
</div>
</div>
</div>
-
<div class="sect5">
<div class="titlepage">
<div>
@@ -7447,22 +6489,18 @@
</div>
</div>
</div>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class=
"term">Extractor(doc)</span></dt>
-
<dd>
<p>An <code class="literal">Extractor</code>
object is built from a <code class=
"literal">Doc</code> object, output from a
query.</p>
</dd>
-
<dt><span class=
"term">Extractor.textextract(ipath)</span></dt>
-
<dd>
<p>Extract document defined by <em class=
"replaceable"><code>ipath</code></em> and
@@ -7478,11 +6516,9 @@
# use doc.text, e.g. for previewing
</pre>
</dd>
-
<dt><span class=
"term">Extractor.idoctofile(ipath, targetmtype,
outfile='')</span></dt>
-
<dd>
<p>Extracts document into an output file,
which can be given explicitly or will be
@@ -7491,27 +6527,24 @@
<pre class="programlisting">
qdoc = query.fetchone()
extractor = recoll.Extractor(qdoc)
-filename = extractor.idoctofile(qdoc.ipath, qdoc.mimetype)
-</pre>
+filename = extractor.idoctofile(qdoc.ipath, qdoc.mimetype)</pre>
</dd>
</dl>
</div>
</div>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.SEARCH.EXAMPLE" id=
- "RCL.PROGRAM.PYTHONAPI.SEARCH.EXAMPLE"></a>4.3.3.4. Search
+ "RCL.PROGRAM.PYTHONAPI.SEARCH.EXAMPLE"></a>4.3.3.4.���Search
API usage example</h4>
</div>
</div>
</div>
-
<p>The following sample would query the index with a
user language string. See the <code class=
"filename">python/samples</code> directory inside the
@@ -7546,32 +6579,28 @@
</pre>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.UPDATE" id=
- "RCL.PROGRAM.PYTHONAPI.UPDATE"></a>4.3.4. Creating
+ "RCL.PROGRAM.PYTHONAPI.UPDATE"></a>4.3.4.���Creating
Python external indexers</h3>
</div>
</div>
</div>
-
<p>The update API can be used to create an index from
data which is not accessible to the regular <span class=
"application">Recoll</span> indexer, or structured to
present difficulties to the <span class=
"application">Recoll</span> input handlers.</p>
-
<p>An indexer created using this API will be have
equivalent work to do as the the Recoll file system
indexer: look for modified documents, extract their text,
call the API for indexing it, take care of purging the
index out of data from documents which do not exist in
the document store any more.</p>
-
<p>The data for such an external indexer should be stored
in an index separate from any used by the <span class=
"application">Recoll</span> internal file system indexer.
@@ -7581,15 +6610,12 @@
not seen during the filesystem walk. The main indexer
documents would also probably be a problem for the
external indexer own purge operation.</p>
-
<p>While there would be ways to enable multiple foreign
indexers to cooperate on a single index, it is just
simpler to use separate ones, and use the multiple index
access capabilities of the query interface, if
needed.</p>
-
<p>There are two parts in the update interface:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -7599,7 +6625,6 @@
data into the index, to make it accessible by the
normal query interface.</p>
</li>
-
<li class="listitem">
<p>An interface based on scripts execution is
defined to allow either the GUI or the <code class=
@@ -7609,19 +6634,17 @@
</li>
</ul>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.UPDATE.UPDATE" id=
- "RCL.PROGRAM.PYTHONAPI.UPDATE.UPDATE"></a>4.3.4.1. Python
+ "RCL.PROGRAM.PYTHONAPI.UPDATE.UPDATE"></a>4.3.4.1.���Python
update interface</h4>
</div>
</div>
</div>
-
<p>The update methods are part of the <code class=
"filename">recoll</code> module described above. The
connect() method is used with a <code class=
@@ -7629,12 +6652,10 @@
writable <code class="literal">Db</code> object. The
following <code class="literal">Db</code> object
methods are then available.</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">addOrUpdate(udi, doc,
parent_udi=None)</span></dt>
-
<dd>
<p>Add or update index data for a given document
The <code class="literal"><a class="link" href=
@@ -7656,19 +6677,15 @@
indexer, this would be the one which is an actual
file).</p>
</dd>
-
<dt><span class="term">delete(udi)</span></dt>
-
<dd>
<p>Purge index from all data for <code class=
"literal">udi</code>, and all documents (if any)
which have a matrching <code class=
"literal">parent_udi</code>.</p>
</dd>
-
<dt><span class="term">needUpdate(udi,
sig)</span></dt>
-
<dd>
<p>Test if the index needs to be updated for the
document identified by <code class=
@@ -7682,12 +6699,10 @@
"literal">udi</code>. <code class=
"literal">sig</code> is an opaque value, compared
as a string.</p>
-
<p>The filesystem indexer uses a concatenation of
the decimal string values for file size and
update time, but a hash of the contents could
also be used.</p>
-
<p>As a side effect, if the return value is false
(the index is up to date), the call will set the
existence flag for the document (and any
@@ -7695,16 +6710,13 @@
"literal">parent_udi</code>), so that a later
<code class="literal">purge()</code> call will
preserve them).</p>
-
<p>The use of <code class=
"literal">needUpdate()</code> and <code class=
"literal">purge()</code> is optional, and the
indexer may use another method for checking the
need to reindex or to delete stale entries.</p>
</dd>
-
<dt><span class="term">purge()</span></dt>
-
<dd>
<p>Delete all documents that were not touched
during the just finished indexing pass (since
@@ -7716,19 +6728,17 @@
</dl>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.UPDATE.ACCESS" id=
- "RCL.PROGRAM.PYTHONAPI.UPDATE.ACCESS"></a>4.3.4.2. Query
+ "RCL.PROGRAM.PYTHONAPI.UPDATE.ACCESS"></a>4.3.4.2.���Query
data access for external indexers (1.23)</h4>
</div>
</div>
</div>
-
<p><span class="application">Recoll</span> has internal
methods to access document data for its internal
(filesystem) indexer. An external indexer needs to
@@ -7736,7 +6746,6 @@
with the GUI (e.g. preview function), or support for
the <code class="filename">rclextract</code>
module.</p>
-
<p>The index data and the access method are linked by
the <code class="literal">rclbes</code> (recoll backend
storage) <code class="literal">Doc</code> field. You
@@ -7744,7 +6753,6 @@
your indexer (e.g. the filesystem indexer uses either
"FS" or an empty value, the Web history indexer uses
"BGL").</p>
-
<p>The link is actually performed inside a <code class=
"filename">backends</code> configuration file (stored
in the configuration directory). This defines commands
@@ -7752,20 +6760,16 @@
Example, for the mbox indexing sample found in the
Recoll source (which sets <code class=
"literal">rclbes="MBOX"</code>):</p>
- <pre class="programlisting">
-[MBOX]
+ <pre class="programlisting">[MBOX]
fetch = /path/to/recoll/src/python/samples/rclmbox.py fetch
makesig = path/to/recoll/src/python/samples/rclmbox.py makesig
-
-</pre>
-
+ </pre>
<p><code class="literal">fetch</code> and <code class=
"literal">makesig</code> define two commands to execute
to respectively retrieve the document text and compute
the document signature (the example implementation uses
the same script with different first parameters to
perform both operations).</p>
-
<p>The scripts are called with three additional
arguments: <code class="literal">udi</code>,
<code class="literal">url</code>, <code class=
@@ -7774,19 +6778,17 @@
requested operation. The caller expects the result data
on <code class="literal">stdout</code>.</p>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.UPDATE.SAMPLES" id=
- "RCL.PROGRAM.PYTHONAPI.UPDATE.SAMPLES"></a>4.3.4.3. External
+ "RCL.PROGRAM.PYTHONAPI.UPDATE.SAMPLES"></a>4.3.4.3.���External
indexer samples</h4>
</div>
</div>
</div>
-
<p>The Recoll source tree has two samples of external
indexers in the <code class=
"filename">src/python/samples</code> directory. The
@@ -7795,29 +6797,25 @@
containing <code class="literal">mbox</code> folder
files. It exercises most features in the update
interface, and has a data access interface.</p>
-
<p>See the comments inside the file for more
information.</p>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.PROGRAM.PYTHONAPI.COMPAT" id=
- "RCL.PROGRAM.PYTHONAPI.COMPAT"></a>4.3.5. Package
+ "RCL.PROGRAM.PYTHONAPI.COMPAT"></a>4.3.5.���Package
compatibility with the previous version</h3>
</div>
</div>
</div>
-
<p>The following code fragments can be used to ensure
that code can run with both the old and the new API (as
long as it does not use the new abilities of the new API
of course).</p>
-
<p>Adapting to the new package structure:</p>
<pre class="programlisting">
@@ -7829,9 +6827,7 @@
import recoll
hasextract = False
-
-</pre>
-
+ </pre>
<p>Adapting to the change of nature of the <code class=
"literal">next</code> <code class="literal">Query</code>
member. The same test can be used to choose to use the
@@ -7842,35 +6838,31 @@
rownum = query.next if type(query.next) == int else \
query.rownumber
-
-</pre>
+ </pre>
</div>
</div>
</div>
-
<div class="chapter">
<div class="titlepage">
<div>
<div>
<h1 class="title"><a name="RCL.INSTALL" id=
- "RCL.INSTALL"></a>Chapter 5. Installation and
+ "RCL.INSTALL"></a>Chapter���5.���Installation and
configuration</h1>
</div>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INSTALL.BINARY" id=
- "RCL.INSTALL.BINARY"></a>5.1. Installing a
- binary copy</h2>
- </div>
- </div>
- </div>
-
+ "RCL.INSTALL.BINARY"></a>5.1.���Installing a binary
+ copy</h2>
+ </div>
+ </div>
+ </div>
<p><span class="application">Recoll</span> binary copies
are always distributed as regular packages for your system.
They can be obtained either through the system's normal
@@ -7885,50 +6877,43 @@
"http://www.recoll.org/download.html" target=
"_top"><span class="application">Recoll</span> WEB site
downloads page</a></p>
-
<p>There used to exist another form of binary install, as
pre-compiled source trees, but these are just less
convenient than the packages and don't exist any more.</p>
-
<p>The package management tools will usually automatically
deal with hard dependancies for packages obtained from a
proper package repository. You will have to deal with them
by hand for downloaded packages (for example, when
<span class="command"><strong>dpkg</strong></span>
complains about missing dependancies).</p>
-
<p>In all cases, you will have to check or install
<a class="link" href="#RCL.INSTALL.EXTERNAL" title=
- "5.2. Supporting packages">supporting applications</a>
- for the file types that you want to index beyond those that
- are natively processed by <span class=
+ "5.2.���Supporting packages">supporting applications</a> for
+ the file types that you want to index beyond those that are
+ natively processed by <span class=
"application">Recoll</span> (text, HTML, email files, and a
few others).</p>
-
<p>You should also maybe have a look at the <a class="link"
href="#RCL.INSTALL.CONFIG" title=
- "5.4. Configuration overview">configuration
- section</a> (but this may not be necessary for a quick test
- with default parameters). Most parameters can be more
+ "5.4.���Configuration overview">configuration section</a>
+ (but this may not be necessary for a quick test with
+ default parameters). Most parameters can be more
conveniently set from the GUI interface.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INSTALL.EXTERNAL" id=
- "RCL.INSTALL.EXTERNAL"></a>5.2. Supporting
+ "RCL.INSTALL.EXTERNAL"></a>5.2.���Supporting
packages</h2>
</div>
</div>
</div>
-
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
-
<p>The <span class="application">Windows</span>
installation of <span class="application">Recoll</span>
is self-contained, and only needs Python 2.7 to be
@@ -7936,7 +6921,6 @@
"application">Windows</span> users can skip this
section.</p>
</div>
-
<p><span class="application">Recoll</span> uses external
applications to index some file types. You need to install
them for the file types that you wish to have indexed
@@ -7944,19 +6928,16 @@
for building or running <span class=
"application">Recoll</span> except for indexing their
specific file type).</p>
-
<p>After an indexing pass, the commands that were found
missing can be displayed from the <span class=
"command"><strong>recoll</strong></span> <span class=
"guilabel">File</span> menu. The list is stored in the
<code class="filename">missing</code> text file inside the
configuration directory.</p>
-
<p>A list of common file types which need external commands
follows. Many of the handlers need the <span class=
"command"><strong>iconv</strong></span> command, which is
not always listed as a dependancy.</p>
-
<p>Please note that, due to the relatively dynamic nature
of this information, the most up to date version is now
kept on <a class="ulink" href=
@@ -7965,7 +6946,6 @@
links to the home pages or best source/patches pages, and
misc tips. The list below is not updated often and may be
quite stale.</p>
-
<p>For many Linux distributions, most of the commands
listed can be installed from the package repositories.
However, the packages are sometimes outdated, or not the
@@ -7974,7 +6954,6 @@
"http://www.recoll.org/features.html#doctypes" target=
"_top">http://www.recoll.org/features.html</a> if a file
type is important to you.</p>
-
<p>As of <span class="application">Recoll</span> release
1.14, a number of XML-based formats that were handled by ad
hoc handler code now use the <span class=
@@ -7982,9 +6961,7 @@
usually comes with <span class=
"application">libxslt</span>. These are: abiword, fb2
(ebooks), kword, openoffice, svg.</p>
-
<p>Now for the list:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -7993,7 +6970,6 @@
<span class=
"command"><strong>xsltproc</strong></span>.</p>
</li>
-
<li class="listitem">
<p>PDF files need <span class=
"command"><strong>pdftotext</strong></span> which is
@@ -8003,7 +6979,6 @@
original one from <span class=
"application">Xpdf</span>.</p>
</li>
-
<li class="listitem">
<p>Postscript files need <span class=
"command"><strong>pstotext</strong></span>. The
@@ -8014,7 +6989,6 @@
target="_top">http://www.recoll.org/features.html</a>
for more detail.</p>
</li>
-
<li class="listitem">
<p>MS Word needs <span class=
"command"><strong>antiword</strong></span>. It is
@@ -8025,18 +6999,15 @@
"command"><strong>antiword</strong></span> does not
handle.</p>
</li>
-
<li class="listitem">
<p>MS Excel and PowerPoint are processed by internal
<span class="command"><strong>Python</strong></span>
handlers.</p>
</li>
-
<li class="listitem">
<p>MS Open XML (docx) needs <span class=
"command"><strong>xsltproc</strong></span>.</p>
</li>
-
<li class="listitem">
<p>Wordperfect files need <span class=
"command"><strong>wpd2html</strong></span> from the
@@ -8044,7 +7015,6 @@
<span class="application">libwpd-tools</span> on
Ubuntu) package.</p>
</li>
-
<li class="listitem">
<p>RTF files need <span class=
"command"><strong>unrtf</strong></span>, which, in
@@ -8057,7 +7027,6 @@
target="_top">http://www.recoll.org/features.html</a>
for details.</p>
</li>
-
<li class="listitem">
<p>TeX files need <span class=
"command"><strong>untex</strong></span> or
@@ -8068,12 +7037,10 @@
for sources if it's not packaged for your
distribution.</p>
</li>
-
<li class="listitem">
<p>dvi files need <span class=
"command"><strong>dvips</strong></span>.</p>
</li>
-
<li class="listitem">
<p>djvu files need <span class=
"command"><strong>djvutxt</strong></span> and
@@ -8081,7 +7048,6 @@
from the <span class="application">DjVuLibre</span>
package.</p>
</li>
-
<li class="listitem">
<p>Audio files: <span class=
"application">Recoll</span> releases 1.14 and later
@@ -8090,7 +7056,6 @@
"application">mutagen</span> for all audio file
types.</p>
</li>
-
<li class="listitem">
<p>Pictures: <span class="application">Recoll</span>
uses the <span class="application">Exiftool</span>
@@ -8102,14 +7067,12 @@
tags or textual descriptions inside the image
files.</p>
</li>
-
<li class="listitem">
<p>chm: files in Microsoft help format need Python
and the <span class="application">pychm</span> module
(which needs <span class=
"application">chmlib</span>).</p>
</li>
-
<li class="listitem">
<p>ICS: up to <span class="application">Recoll</span>
1.13, iCalendar files need <span class=
@@ -8118,13 +7081,11 @@
"application">icalendar</span> is not needed for
newer versions, which use internal code.</p>
</li>
-
<li class="listitem">
<p>Zip archives need <span class=
"application">Python</span> (and the standard zipfile
module).</p>
</li>
-
<li class="listitem">
<p>Rar archives need <span class=
"application">Python</span>, the <span class=
@@ -8132,7 +7093,6 @@
<span class="command"><strong>unrar</strong></span>
utility.</p>
</li>
-
<li class="listitem">
<p>Midi karaoke files need <span class=
"application">Python</span> and the <a class="ulink"
@@ -8140,12 +7100,10 @@
"_top"><span class="application">Midi
module</span></a></p>
</li>
-
<li class="listitem">
<p>Konqueror webarchive format with Python (uses the
Tarfile module).</p>
</li>
-
<li class="listitem">
<p>Mimehtml web archive format (support based on the
email handler, which introduces some mild weirdness,
@@ -8153,7 +7111,6 @@
</li>
</ul>
</div>
-
<p>Text, HTML, email folders, and Scribus files are
processed internally. <span class="application">Lyx</span>
is used to index Lyx files. Many handlers need <span class=
@@ -8161,45 +7118,39 @@
<span class="command"><strong>sed</strong></span> and
<span class="command"><strong>awk</strong></span>.</p>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INSTALL.BUILDING" id=
- "RCL.INSTALL.BUILDING"></a>5.3. Building from
+ "RCL.INSTALL.BUILDING"></a>5.3.���Building from
source</h2>
</div>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.BUILDING.PREREQS" id=
- "RCL.INSTALL.BUILDING.PREREQS"></a>5.3.1. Prerequisites</h3>
- </div>
- </div>
- </div>
-
+ "RCL.INSTALL.BUILDING.PREREQS"></a>5.3.1.���Prerequisites</h3>
+ </div>
+ </div>
+ </div>
<p>If you can install any or all of the following through
the package manager for your system, all the better.
Especially <span class="application">Qt</span> is a very
big piece of software, but you will most probably be able
to find a binary package.</p>
-
<p>If you are building for an exotic or older system, it
may be useful to note that functional improvements in
<span class="application">Recoll</span> have been
relatively marginal in recent versions, and that you may
make your life easier by using an older release, without
losing major function.</p>
-
<p>The shopping list:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -8211,19 +7162,16 @@
before <span class="application">Recoll</span> and
including 1.21.</p>
</li>
-
<li class="listitem">
<p>C++ compiler. Recent versions require C++11
compatibility (1.23 and later).</p>
</li>
-
<li class="listitem">
<p><span class=
"command"><strong>bison</strong></span> command
(for <span class="application">Recoll</span> 1.21
and later).</p>
</li>
-
<li class="listitem">
<p><span class=
"command"><strong>xsltproc</strong></span> command.
@@ -8233,16 +7181,13 @@
"literal">libxslt</code> package. And also the
Docbook XML and style sheet files.</p>
</li>
-
<li class="listitem">
<p>Development files for <a class="ulink" href=
"http://www.xapian.org" target="_top"><span class=
"application">Xapian core</span></a>.</p>
-
<div class="important" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Important</h3>
-
<p>If you are building Xapian for an older CPU
(before Pentium 4 or Athlon 64), you need to add
the <code class="option">--disable-sse</code>
@@ -8251,7 +7196,6 @@
"literal">illegal instruction</code> error.</p>
</div>
</li>
-
<li class="listitem">
<p>Development files for <a class="ulink" href=
"http://qt-project.org/downloads" target=
@@ -8265,19 +7209,16 @@
a configuration option to disable its use (see
further).</p>
</li>
-
<li class="listitem">
<p>Development files for <span class=
"application">X11</span> and <span class=
"application">zlib</span>.</p>
</li>
-
<li class="listitem">
<p>Development files for <span class=
"application">Python</span> (or use <code class=
"literal">--disable-python-module</code>).</p>
</li>
-
<li class="listitem">
<p>You may also need <a class="ulink" href=
"http://www.gnu.org/software/libiconv/" target=
@@ -8288,24 +7229,21 @@
</li>
</ul>
</div>
-
<p>Check the <a class="ulink" href=
"http://www.recoll.org/download.html" target=
"_top"><span class="application">Recoll</span> download
page</a> for up to date version information.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.BUILDING.BUILD" id=
- "RCL.INSTALL.BUILDING.BUILD"></a>5.3.2. Building</h3>
- </div>
- </div>
- </div>
-
+ "RCL.INSTALL.BUILDING.BUILD"></a>5.3.2.���Building</h3>
+ </div>
+ </div>
+ </div>
<p><span class="application">Recoll</span> has been built
on Linux, FreeBSD, Mac OS X, and Solaris, most versions
after 2005 should be ok, maybe some older ones too
@@ -8313,9 +7251,7 @@
need to modify things, <a class="ulink" href=
"mailto:jfd@recoll.org" target="_top">I would very much
welcome patches</a>.</p>
-
- <p><b>Configure options: </b></p>
-
+ <p><b>Configure options:���</b></p>
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -8324,7 +7260,6 @@
will disable the code for phonetic matching of
search terms.</p>
</li>
-
<li class="listitem">
<p><code class="option">--with-fam</code> or
<code class="option">--with-inotify</code> will
@@ -8332,7 +7267,6 @@
support is enabled by default on recent Linux
systems.</p>
</li>
-
<li class="listitem">
<p><code class="option">--with-qzeitgeist</code>
will enable sending <span class=
@@ -8340,7 +7274,6 @@
visited search results, and needs the <span class=
"application">qzeitgeist</span> package.</p>
</li>
-
<li class="listitem">
<p><code class="option">--disable-webkit</code> is
available from version 1.17 to implement the result
@@ -8348,7 +7281,6 @@
QTextBrowser instead of a WebKit widget if you do
not or can't depend on the latter.</p>
</li>
-
<li class="listitem">
<p><code class="option">--disable-idxthreads</code>
is available from version 1.19 to suppress
@@ -8363,14 +7295,12 @@
"application">Recoll</span> monitor mode always
uses at least two threads of execution.</p>
</li>
-
<li class="listitem">
<p><code class=
"option">--disable-python-module</code> will avoid
building the <span class=
"application">Python</span> module.</p>
</li>
-
<li class="listitem">
<p><code class="option">--disable-xattr</code> will
prevent fetching data from file extended
@@ -8381,7 +7311,6 @@
comments in the <code class=
"filename">fields</code> configuration file).</p>
</li>
-
<li class="listitem">
<p><code class="option">--enable-camelcase</code>
will enable splitting <em class=
@@ -8395,7 +7324,6 @@
not <code class="literal">"mysql manual"</code>
(only inside phrase searches).</p>
</li>
-
<li class="listitem">
<p><code class="option">--with-file-command</code>
Specify the version of the 'file' command to use
@@ -8403,14 +7331,12 @@
be useful to enable the gnu version on systems
where the native one is bad.</p>
</li>
-
<li class="listitem">
<p><code class="option">--disable-qtgui</code>
Disable the Qt interface. Will allow building the
indexer and the command line search program in
absence of a Qt environment.</p>
</li>
-
<li class="listitem">
<p><code class="option">--disable-x11mon</code>
Disable <span class="application">X11</span>
@@ -8419,7 +7345,6 @@
without <span class="application">Qt</span> and
<span class="application">X11</span>.</p>
</li>
-
<li class="listitem">
<p><code class="option">--disable-userdoc</code>
will avoid building the user manual. This avoids
@@ -8427,7 +7352,6 @@
TeX toolchain used for translating the manual to
PDF.</p>
</li>
-
<li class="listitem">
<p><code class="option">--disable-pic</code>
(<span class="application">Recoll</span> versions
@@ -8438,7 +7362,6 @@
<span class="application">PHP</span> extensions,
but might yield very marginally faster code.</p>
</li>
-
<li class="listitem">
<p>Of course the usual <span class=
"application">autoconf</span> <span class=
@@ -8448,7 +7371,6 @@
</li>
</ul>
</div>
-
<p>Normal procedure (for source extracted from a tar
distribution):</p>
<pre class="screen">
@@ -8458,9 +7380,7 @@
<strong class="userinput"><code>make</code></strong>
<strong class=
"userinput"><code>(practices usual hardship-repelling invocations)</code></strong>
-
-</pre>
-
+ </pre>
<p>When building from source cloned from the BitBucket
repository, you also need to install <span class=
"application">autoconf</span>, <span class=
@@ -8469,26 +7389,23 @@
<code class="literal">sh autogen.sh</code> in the top
source directory before running <code class=
"literal">configure</code>.</p>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.BUILDING.BUILD.SOLARIS" id=
- "RCL.INSTALL.BUILDING.BUILD.SOLARIS"></a>5.3.2.1. Building
+ "RCL.INSTALL.BUILDING.BUILD.SOLARIS"></a>5.3.2.1.���Building
on Solaris</h4>
</div>
</div>
</div>
-
<p>We did not test building the GUI on Solaris for
recent versions. You will need at least Qt 4.4. There
are some hints on <a class="ulink" href=
"http://www.recoll.org/download-1.14.html" target=
"_top">an old web site page</a>, they may still be
valid.</p>
-
<p>Someone did test the 1.19 indexer and Python module
build, they do work, with a few minor glitches. Be sure
to use GNU <span class=
@@ -8496,18 +7413,16 @@
"command"><strong>install</strong></span>.</p>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.BUILDING.INSTALL" id=
- "RCL.INSTALL.BUILDING.INSTALL"></a>5.3.3. Installation</h3>
- </div>
- </div>
- </div>
-
+ "RCL.INSTALL.BUILDING.INSTALL"></a>5.3.3.���Installation</h3>
+ </div>
+ </div>
+ </div>
<p>Use <strong class="userinput"><code>make
install</code></strong> in the root of the source tree.
This will copy the commands to <code class=
@@ -8518,43 +7433,37 @@
"replaceable"><code>prefix</code></em>/share/recoll</code>.</p>
</div>
</div>
-
<div class="sect1">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name=
"RCL.INSTALL.CONFIG" id=
- "RCL.INSTALL.CONFIG"></a>5.4. Configuration
+ "RCL.INSTALL.CONFIG"></a>5.4.���Configuration
overview</h2>
</div>
</div>
</div>
-
<p>Most of the parameters specific to the <span class=
"command"><strong>recoll</strong></span> GUI are set
through the <span class="guilabel">Preferences</span> menu
and stored in the standard Qt place (<code class=
"filename">$HOME/.config/Recoll.org/recoll.conf</code>).
You probably do not want to edit this by hand.</p>
-
<p><span class="application">Recoll</span> indexing options
are set inside text configuration files located in a
configuration directory. There can be several such
directories, each of which defines the parameters for one
index.</p>
-
<p>The configuration files can be edited by hand or through
the <span class="guilabel">Index configuration</span>
dialog (<span class="guilabel">Preferences</span> menu).
The GUI tool will try to respect your formatting and
comments as much as possible, so it is quite possible to
use both approaches on the same configuration.</p>
-
<p>The most accurate documentation for the configuration
parameters is given by comments inside the default files,
and we will just give a general overview here.</p>
-
<p>For each index, there are at least two sets of
configuration files. System-wide configuration files are
kept in a directory named like <code class=
@@ -8562,18 +7471,15 @@
default values, shared by all indexes. For each index, a
parallel set of files defines the customized
parameters.</p>
-
<p>The default location of the customized configuration is
the <code class="filename">.recoll</code> directory in your
home. Most people will only use this directory.</p>
-
<p>This location can be changed, or others can be added
with the <code class="envar">RECOLL_CONFDIR</code>
environment variable or the <code class="option">-c</code>
option parameter to <span class=
"command"><strong>recoll</strong></span> and <span class=
"command"><strong>recollindex</strong></span>.</p>
-
<p>In addition (as of <span class=
"application">Recoll</span> version 1.19.7), it is possible
to specify two additional configuration directories which
@@ -8592,7 +7498,6 @@
probably be interpreted as colon-separated lists in the
future: do not use colon characters inside the directory
paths.</p>
-
<p>If the <code class="filename">.recoll</code> directory
does not exist when <span class=
"command"><strong>recoll</strong></span> or <span class=
@@ -8607,7 +7512,6 @@
<code class="option">-c</code> or <code class=
"envar">RECOLL_CONFDIR</code> were used (in the latter
cases, you will have to create the directory).</p>
-
<p>All configuration files share the same format. For
example, a short extract of the main configuration file
might look as follows:</p>
@@ -8617,33 +7521,26 @@
[~/somedirectory-with-utf8-txt-files]
defaultcharset = utf-8
-
-</pre>
-
+ </pre>
<p>There are three kinds of lines:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
<p>Comment (starts with <span class=
"emphasis"><em>#</em></span>) or empty.</p>
</li>
-
<li class="listitem">
<p>Parameter affectation (<span class=
"emphasis"><em>name = value</em></span>).</p>
</li>
-
<li class="listitem">
<p>Section definition ([<span class=
"emphasis"><em>somedirname</em></span>]).</p>
</li>
</ul>
</div>
-
<p>Long lines can be broken by ending each incomplete part
with a backslash (<code class="literal">\</code>).</p>
-
<p>Depending on the type of configuration file, section
definitions either separate groups of parameters or allow
redefining some parameters for a directory sub-tree. They
@@ -8653,16 +7550,13 @@
directory location upwards. Not all parameters can be
meaningfully redefined, this is specified for each in the
next section.</p>
-
<p>When found at the beginning of a file path, the tilde
character (~) is expanded to the name of the user's home
directory, as a shell would do.</p>
-
<p>Some parameters are lists of strings. White space is
used for separation. List elements with embedded spaces can
be quoted using double-quotes. Double quotes inside these
elements can be escaped with a backslash.</p>
-
<p>No value inside a configuration file can contain a
newline character. Long lines can be continued by escaping
the physical newline with backslash, even inside quoted
@@ -8671,17 +7565,13 @@
astringlist = "some string \
with spaces"
thesame = "some string with spaces"
-
-</pre>
-
+ </pre>
<p>Parameters which are not part of string lists can't be
quoted, and leading and trailing space characters are
stripped before the value is used.</p>
-
- <p><b>Encoding issues. </b>Most of the configuration
+ <p><b>Encoding issues.���</b>Most of the configuration
parameters are plain ASCII. Two particular sets of values
may cause encoding issues:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
@@ -8691,7 +7581,6 @@
means that the configuration file should use the
system default locale encoding.</p>
</li>
-
<li class="listitem">
<p>The <code class="envar">unac_except_trans</code>
parameter should be encoded in UTF-8. If your system
@@ -8706,31 +7595,26 @@
</li>
</ul>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.CONFIG.ENVIR" id=
- "RCL.INSTALL.CONFIG.ENVIR"></a>5.4.1. Environment
+ "RCL.INSTALL.CONFIG.ENVIR"></a>5.4.1.���Environment
variables</h3>
</div>
</div>
</div>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term"><code class=
"varname">RECOLL_CONFDIR</code></span></dt>
-
<dd>
<p>Defines the main configuration directory.</p>
</dd>
-
<dt><span class="term"><code class=
"varname">RECOLL_TMPDIR, TMPDIR</code></span></dt>
-
<dd>
<p>Locations for temporary files, in this order of
priority. The default if none of these is set is to
@@ -8739,52 +7623,42 @@
mostly for decompressing, and also for processing,
e.g. email attachments.</p>
</dd>
-
<dt><span class="term"><code class=
"varname">RECOLL_CONFTOP,
RECOLL_CONFMID</code></span></dt>
-
<dd>
<p>Allow adding configuration directories with
priorities below and above the user directory (see
above the Configuration overview section for
details).</p>
</dd>
-
<dt><span class="term"><code class=
"varname">RECOLL_EXTRA_DBS,
RECOLL_ACTIVE_EXTRA_DBS</code></span></dt>
-
<dd>
<p>Help for setting up external indexes. See
<a class="link" href="#RCL.SEARCH.GUI.MULTIDB"
- title="3.1.10. Multiple indexes">this
- paragraph</a> for explanations.</p>
- </dd>
-
+ title="3.1.10.���Multiple indexes">this paragraph</a>
+ for explanations.</p>
+ </dd>
<dt><span class="term"><code class=
"varname">RECOLL_DATADIR</code></span></dt>
-
<dd>
<p>Defines replacement for the default location of
Recoll data files, normally found in, e.g.,
<code class=
"filename">/usr/share/recoll</code>).</p>
</dd>
-
<dt><span class="term"><code class=
"varname">RECOLL_FILTERSDIR</code></span></dt>
-
<dd>
<p>Defines replacement for the default location of
Recoll filters, normally found in, e.g.,
<code class=
"filename">/usr/share/recoll/filters</code>).</p>
</dd>
-
<dt><span class="term"><code class=
"varname">ASPELL_PROG</code></span></dt>
-
<dd>
<p><span class=
"command"><strong>aspell</strong></span> program to
@@ -8793,46 +7667,41 @@
"filename">libaspell</code> which <span class=
"application">Recoll</span> is using.</p>
</dd>
-
<dt><span class="term"><code class=
"varname">VARNAME</code></span></dt>
-
<dd>
<p>Blabla</p>
</dd>
</dl>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF"></a>5.4.2. Recoll
+ "RCL.INSTALL.CONFIG.RECOLLCONF"></a>5.4.2.���Recoll
main configuration file, recoll.conf</h3>
</div>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.WHATDOCS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.WHATDOCS"></a>5.4.2.1. Parameters
+ "RCL.INSTALL.CONFIG.RECOLLCONF.WHATDOCS"></a>5.4.2.1.���Parameters
affecting what documents we index</h4>
</div>
</div>
</div>
-
<dl>
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS"></a><span class="term"><code class="varname">topdirs</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS"></a><span class="term"><code class="varname">topdirs</code></span>
+ </dt>
<dd>
<p>Space-separated list of files or directories to
recursively index. Default to ~ (indexes $HOME).
@@ -8840,11 +7709,11 @@
be followed, independantly of the value of the
followLinks variable.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES"></a><span class="term"><code class="varname">skippedNames</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES"></a><span class="term"><code class="varname">skippedNames</code></span>
+ </dt>
<dd>
<p>Files and directories which should be ignored.
White space separated list of wildcard patterns
@@ -8864,28 +7733,30 @@
an alternative approach which indexes the file
names. Can be redefined for any subtree.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES-" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES-"></a><span class="term"><code class="varname">skippedNames-</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES-" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES-"></a><span class="term"><code class="varname">skippedNames-</code></span>
+ </dt>
<dd>
<p>List of name endings to remove from the default
skippedNames list.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES+"></a><span class="term"><code class="varname">skippedNames+</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES+" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES+"></a><span class="term"><code class="varname">skippedNames+</code></span>
+ </dt>
<dd>
<p>List of name endings to add to the default
skippedNames list.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES"></a><span class="term"><code class="varname">noContentSuffixes</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES"></a><span class="term"><code class="varname">noContentSuffixes</code></span>
+ </dt>
<dd>
<p>List of name endings (not necessarily
dot-separated suffixes) for which we don't try MIME
@@ -8901,30 +7772,31 @@
normally. This can be redefined for
subdirectories.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES-"
- id="RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES-">
- </a><span class="term"><code class=
- "varname">noContentSuffixes-</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES-"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES-"></a><span class="term"><code class="varname">noContentSuffixes-</code></span>
+ </dt>
<dd>
<p>List of name endings to remove from the default
noContentSuffixes list.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES+"></a><span class="term"><code class="varname">noContentSuffixes+</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES+"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOCONTENTSUFFIXES+"></a><span class="term"><code class="varname">noContentSuffixes+</code></span>
+ </dt>
<dd>
<p>List of name endings to add to the default
noContentSuffixes list.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS"></a><span class="term"><code class="varname">skippedPaths</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS"></a><span class="term"><code class="varname">skippedPaths</code></span>
+ </dt>
<dd>
<p>Paths we should not go into. Space-separated
list of wildcard expressions for filesystem paths.
@@ -8944,23 +7816,25 @@
Explicitely adding '/media/xxx' to the topdirs will
override this.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHSFNMPATHNAME"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHSFNMPATHNAME">
- </a><span class="term"><code class=
- "varname">skippedPathsFnmPathname</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHSFNMPATHNAME"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHSFNMPATHNAME">
+ </a><span class="term"><code class=
+ "varname">skippedPathsFnmPathname</code></span>
+ </dt>
<dd>
<p>Set to 0 to override use of FNM_PATHNAME for
matching skipped paths.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMSKIPPEDPATHS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMSKIPPEDPATHS"></a><span class="term"><code class="varname">daemSkippedPaths</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMSKIPPEDPATHS"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.DAEMSKIPPEDPATHS">
+ </a><span class="term"><code class=
+ "varname">daemSkippedPaths</code></span>
+ </dt>
<dd>
<p>skippedPaths equivalent specific to real time
indexing. This enables having parts of the tree
@@ -8968,11 +7842,11 @@
daemSkippedPaths is not set, the daemon uses
skippedPaths.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ZIPSKIPPEDNAMES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ZIPSKIPPEDNAMES"></a><span class="term"><code class="varname">zipSkippedNames</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ZIPSKIPPEDNAMES" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ZIPSKIPPEDNAMES"></a><span class="term"><code class="varname">zipSkippedNames</code></span>
+ </dt>
<dd>
<p>Space-separated list of wildcard expressions for
names that should be ignored inside zip archives.
@@ -8982,11 +7856,11 @@
Supported by recoll 1.20 and newer. See
https://www.lesbonscomptes.com/recoll/faqsandhowtos/Filtering%20out%20Zip%20archive%20members</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.FOLLOWLINKS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.FOLLOWLINKS"></a><span class="term"><code class="varname">followLinks</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.FOLLOWLINKS"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.FOLLOWLINKS"></a><span class="term"><code class="varname">followLinks</code></span>
+ </dt>
<dd>
<p>Follow symbolic links during indexing. The
default is to ignore symbolic links to avoid
@@ -8998,11 +7872,13 @@
in the 'topdirs' list itself are always
followed.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXEDMIMETYPES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXEDMIMETYPES"></a><span class="term"><code class="varname">indexedmimetypes</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXEDMIMETYPES"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.INDEXEDMIMETYPES">
+ </a><span class="term"><code class=
+ "varname">indexedmimetypes</code></span>
+ </dt>
<dd>
<p>Restrictive list of indexed mime types. Normally
not set (in which case all supported types are
@@ -9014,11 +7890,12 @@
xdg-mime or file -i output in some cases). Can be
redefined for subtrees.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.EXCLUDEDMIMETYPES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.EXCLUDEDMIMETYPES"></a><span class="term"><code class="varname">excludedmimetypes</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.EXCLUDEDMIMETYPES"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.EXCLUDEDMIMETYPES"></a><span class="term"><code class="varname">excludedmimetypes</code></span>
+ </dt>
<dd>
<p>List of excluded MIME types. Lets you exclude
some types from indexing. MIME type names should be
@@ -9026,11 +7903,11 @@
different from xdg-mime or file -i output in some
cases) Can be redefined for subtrees.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOMD5MIMETYPES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOMD5MIMETYPES"></a><span class="term"><code class="varname">nomd5mimetypes</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOMD5MIMETYPES" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOMD5MIMETYPES"></a><span class="term"><code class="varname">nomd5mimetypes</code></span>
+ </dt>
<dd>
<p>Don't compute md5 for these types. md5 checksums
are used only for deduplicating results, and can be
@@ -9043,12 +7920,14 @@
either MIME types (e.g. audio/mpeg) or handler
names (e.g. rclaudio).</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.COMPRESSEDFILEMAXKBS"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.COMPRESSEDFILEMAXKBS"></a><span class="term"><code class="varname">compressedfilemaxkbs</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.COMPRESSEDFILEMAXKBS"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.COMPRESSEDFILEMAXKBS">
+ </a><span class="term"><code class=
+ "varname">compressedfilemaxkbs</code></span>
+ </dt>
<dd>
<p>Size limit for compressed files. We need to
decompress these in a temporary directory for
@@ -9057,32 +7936,35 @@
results in no processing of any compressed file.
Default 50 MB.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.TEXTFILEMAXMBS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.TEXTFILEMAXMBS"></a><span class="term"><code class="varname">textfilemaxmbs</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.TEXTFILEMAXMBS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.TEXTFILEMAXMBS"></a><span class="term"><code class="varname">textfilemaxmbs</code></span>
+ </dt>
<dd>
<p>Size limit for text files. Mostly for skipping
monster logs. Default 20 MB.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXALLFILENAMES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXALLFILENAMES"></a><span class="term"><code class="varname">indexallfilenames</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXALLFILENAMES"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXALLFILENAMES"></a><span class="term"><code class="varname">indexallfilenames</code></span>
+ </dt>
<dd>
<p>Index the file names of unprocessed files Index
the names of files the contents of which we don't
index because of an excluded or unsupported MIME
type.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.USESYSTEMFILECOMMAND"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.USESYSTEMFILECOMMAND"></a><span class="term"><code class="varname">usesystemfilecommand</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.USESYSTEMFILECOMMAND"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.USESYSTEMFILECOMMAND">
+ </a><span class="term"><code class=
+ "varname">usesystemfilecommand</code></span>
+ </dt>
<dd>
<p>Use a system command for file MIME type guessing
as a final step in file type identification This is
@@ -9090,11 +7972,12 @@
indexing of many bogus 'text' files. See
'systemfilecommand' for the command used.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SYSTEMFILECOMMAND" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SYSTEMFILECOMMAND"></a><span class="term"><code class="varname">systemfilecommand</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SYSTEMFILECOMMAND"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SYSTEMFILECOMMAND"></a><span class="term"><code class="varname">systemfilecommand</code></span>
+ </dt>
<dd>
<p>Command used to guess MIME types if the internal
methods fails This should be a "file -i" workalike.
@@ -9104,21 +7987,21 @@
configured default (with a hard-coded fallback to
'file')</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PROCESSWEBQUEUE" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PROCESSWEBQUEUE"></a><span class="term"><code class="varname">processwebqueue</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PROCESSWEBQUEUE" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PROCESSWEBQUEUE"></a><span class="term"><code class="varname">processwebqueue</code></span>
+ </dt>
<dd>
<p>Decide if we process the Web queue. The queue is
a directory where the Recoll Web browser plugins
create the copies of visited pages.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.TEXTFILEPAGEKBS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.TEXTFILEPAGEKBS"></a><span class="term"><code class="varname">textfilepagekbs</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.TEXTFILEPAGEKBS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.TEXTFILEPAGEKBS"></a><span class="term"><code class="varname">textfilepagekbs</code></span>
+ </dt>
<dd>
<p>Page size for text files. If this is set,
text/plain files will be divided into documents of
@@ -9129,11 +8012,11 @@
logs. Also see textfilemaxmbs and
compressedfilemaxkbs.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MEMBERMAXKBS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MEMBERMAXKBS"></a><span class="term"><code class="varname">membermaxkbs</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MEMBERMAXKBS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MEMBERMAXKBS"></a><span class="term"><code class="varname">membermaxkbs</code></span>
+ </dt>
<dd>
<p>Size limit for archive members. This is passed
to the filters in the environment as
@@ -9141,24 +8024,23 @@
</dd>
</dl>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.TERMS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.TERMS"></a>5.4.2.2. Parameters
+ "RCL.INSTALL.CONFIG.RECOLLCONF.TERMS"></a>5.4.2.2.���Parameters
affecting how we generate terms</h4>
</div>
</div>
</div>
-
<dl>
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTRIPCHARS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTRIPCHARS"></a><span class="term"><code class="varname">indexStripChars</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTRIPCHARS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTRIPCHARS"></a><span class="term"><code class="varname">indexStripChars</code></span>
+ </dt>
<dd>
<p>Decide if we store character case and diacritics
in the index. If we do, searches sensitive to case
@@ -9169,11 +8051,11 @@
parameter must be defined identically for all.
Changing the value implies an index reset.</p>
</dd>
-
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.NONUMBERS"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NONUMBERS"></a><span class="term"><code class="varname">nonumbers</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.NONUMBERS"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NONUMBERS"></a><span class="term"><code class="varname">nonumbers</code></span>
+ </dt>
<dd>
<p>Decides if terms will be generated for numbers.
For example "123", "1.5e6", 192.168.1.4, would not
@@ -9186,21 +8068,21 @@
This can only be set for a whole index, not for a
subtree.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DEHYPHENATE" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DEHYPHENATE"></a><span class="term"><code class="varname">dehyphenate</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.DEHYPHENATE"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.DEHYPHENATE"></a><span class="term"><code class="varname">dehyphenate</code></span>
+ </dt>
<dd>
<p>Determines if we index 'coworker' also when the
input is 'co-worker'. This is new in version 1.22,
and on by default. Setting the variable to off
allows restoring the previous behaviour.</p>
</dd>
-
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.NOCJK" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOCJK"></a><span class="term"><code class="varname">nocjk</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.NOCJK" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOCJK"></a><span class="term"><code class="varname">nocjk</code></span>
+ </dt>
<dd>
<p>Decides if specific East Asian (Chinese Korean
Japanese) characters/word splitting is turned off.
@@ -9210,11 +8092,11 @@
it, setting nocjk may be a significant time and
space saver.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.CJKNGRAMLEN" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.CJKNGRAMLEN"></a><span class="term"><code class="varname">cjkngramlen</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.CJKNGRAMLEN"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.CJKNGRAMLEN"></a><span class="term"><code class="varname">cjkngramlen</code></span>
+ </dt>
<dd>
<p>This lets you adjust the size of n-grams used
for indexing CJK text. The default value of 2 is
@@ -9223,25 +8105,25 @@
words, but the index will be approximately twice as
large.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTEMMINGLANGUAGES"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTEMMINGLANGUAGES">
- </a><span class="term"><code class=
- "varname">indexstemminglanguages</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTEMMINGLANGUAGES"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.INDEXSTEMMINGLANGUAGES">
+ </a><span class="term"><code class=
+ "varname">indexstemminglanguages</code></span>
+ </dt>
<dd>
<p>Languages for which to create stemming expansion
data. Stemmer names can be found by executing
'recollindex -l', or this can also be set from a
list in the GUI.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DEFAULTCHARSET" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DEFAULTCHARSET"></a><span class="term"><code class="varname">defaultcharset</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.DEFAULTCHARSET" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.DEFAULTCHARSET"></a><span class="term"><code class="varname">defaultcharset</code></span>
+ </dt>
<dd>
<p>Default character set. This is used for files
which do not contain a character set definition
@@ -9255,11 +8137,12 @@
is not 8859-1, use this variable. This can be
redefined for any sub-directory.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.UNAC_EXCEPT_TRANS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.UNAC_EXCEPT_TRANS"></a><span class="term"><code class="varname">unac_except_trans</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.UNAC_EXCEPT_TRANS"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.UNAC_EXCEPT_TRANS"></a><span class="term"><code class="varname">unac_except_trans</code></span>
+ </dt>
<dd>
<p>A list of characters, encoded in UTF-8, which
should be handled specially when converting text to
@@ -9274,42 +8157,34 @@
will turn-off both standard accent and case
processing. The value is global and affects both
indexing and querying. Examples: Swedish:
- unac_except_trans = ää Ää
- öö Öö üü Üü
- ßss œoe Œoe æae Æae
- ffff fifi flfl åå
- Åå . German: unac_except_trans =
- ää Ää öö Öö
- üü Üü ßss œoe
- Œoe æae Æae ffff fifi
- flfl In French, you probably want to
+ unac_except_trans = ������ ������ ������ ������ ������ ������ ���ss ��oe ��oe
+ ���ae ���ae ���ff ���fi ���fl ������ ������ . German:
+ unac_except_trans = ������ ������ ������ ������ ������ ������ ���ss ��oe ��oe
+ ���ae ���ae ���ff ���fi ���fl In French, you probably want to
decompose oe and ae and nobody would type a German
- ß unac_except_trans = ßss œoe
- Œoe æae Æae ffff fifi
- flfl . The default for all until someone
- protests follows. These decompositions are not
- performed by unac, but it is unlikely that someone
- would type the composed forms in a search.
- unac_except_trans = ßss œoe Œoe
- æae Æae ffff fifi
- flfl</p>
- </dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MAILDEFCHARSET" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MAILDEFCHARSET"></a><span class="term"><code class="varname">maildefcharset</code></span></dt>
-
+ ��� unac_except_trans = ���ss ��oe ��oe ���ae ���ae ���ff ���fi
+ ���fl . The default for all until someone protests
+ follows. These decompositions are not performed by
+ unac, but it is unlikely that someone would type
+ the composed forms in a search. unac_except_trans =
+ ���ss ��oe ��oe ���ae ���ae ���ff ���fi ���fl</p>
+ </dd>
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MAILDEFCHARSET" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MAILDEFCHARSET"></a><span class="term"><code class="varname">maildefcharset</code></span>
+ </dt>
<dd>
<p>Overrides the default character set for email
messages which don't specify one. This is mainly
useful for readpst (libpst) dumps, which are utf-8
but do not say so.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.LOCALFIELDS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.LOCALFIELDS"></a><span class="term"><code class="varname">localfields</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.LOCALFIELDS"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.LOCALFIELDS"></a><span class="term"><code class="varname">localfields</code></span>
+ </dt>
<dd>
<p>Set fields on all files (usually of a specific
fs area). Syntax is the usual: name = value ; attr1
@@ -9318,11 +8193,12 @@
setting the rclaptg field for application selection
inside mimeview.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.TESTMODIFUSEMTIME" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.TESTMODIFUSEMTIME"></a><span class="term"><code class="varname">testmodifusemtime</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.TESTMODIFUSEMTIME"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.TESTMODIFUSEMTIME"></a><span class="term"><code class="varname">testmodifusemtime</code></span>
+ </dt>
<dd>
<p>Use mtime instead of ctime to test if a file has
been modified. The time is used in addition to the
@@ -9342,21 +8218,21 @@
undetected). Perform a full index reset after
changing this.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOXATTRFIELDS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOXATTRFIELDS"></a><span class="term"><code class="varname">noxattrfields</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOXATTRFIELDS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.NOXATTRFIELDS"></a><span class="term"><code class="varname">noxattrfields</code></span>
+ </dt>
<dd>
<p>Disable extended attributes conversion to
metadata fields. This probably needs to be set if
testmodifusemtime is set.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.METADATACMDS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.METADATACMDS"></a><span class="term"><code class="varname">metadatacmds</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.METADATACMDS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.METADATACMDS"></a><span class="term"><code class="varname">metadatacmds</code></span>
+ </dt>
<dd>
<p>Define commands to gather external metadata,
e.g. tmsu tags. There can be several entries,
@@ -9377,24 +8253,22 @@
</dd>
</dl>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.STORE" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.STORE"></a>5.4.2.3. Parameters
+ "RCL.INSTALL.CONFIG.RECOLLCONF.STORE"></a>5.4.2.3.���Parameters
affecting where and how we store things</h4>
</div>
</div>
</div>
-
<dl>
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.CACHEDIR"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.CACHEDIR"></a><span class="term"><code class="varname">cachedir</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.CACHEDIR"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.CACHEDIR"></a><span class="term"><code class="varname">cachedir</code></span>
+ </dt>
<dd>
<p>Top directory for Recoll data. Recoll data
directories are normally located relative to the
@@ -9410,11 +8284,11 @@
different cachedir, there is no automatic
computation of a subpath under cachedir.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MAXFSOCCUPPC" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MAXFSOCCUPPC"></a><span class="term"><code class="varname">maxfsoccuppc</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MAXFSOCCUPPC" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MAXFSOCCUPPC"></a><span class="term"><code class="varname">maxfsoccuppc</code></span>
+ </dt>
<dd>
<p>Maximum file system occupation over which we
stop indexing. The value is a percentage,
@@ -9422,11 +8296,10 @@
column shows. The default value is 0, meaning no
checking.</p>
</dd>
-
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.XAPIANDB"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.XAPIANDB"></a><span class="term"><code class="varname">xapiandb</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.XAPIANDB"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.XAPIANDB"></a><span class="term"><code class="varname">xapiandb</code></span>
+ </dt>
<dd>
<p>Xapian database directory location. This will be
created on first indexing. If the value is not an
@@ -9436,21 +8309,21 @@
specified, the default is then
~/.recoll/xapiandb/</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXSTATUSFILE" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXSTATUSFILE"></a><span class="term"><code class="varname">idxstatusfile</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXSTATUSFILE" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXSTATUSFILE"></a><span class="term"><code class="varname">idxstatusfile</code></span>
+ </dt>
<dd>
<p>Name of the scratch file where the indexer
process updates its status. Default: idxstatus.txt
inside the configuration directory.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MBOXCACHEDIR" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MBOXCACHEDIR"></a><span class="term"><code class="varname">mboxcachedir</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MBOXCACHEDIR" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MBOXCACHEDIR"></a><span class="term"><code class="varname">mboxcachedir</code></span>
+ </dt>
<dd>
<p>Directory location for storing mbox message
offsets cache files. This is normally 'mboxcache'
@@ -9459,54 +8332,54 @@
share a directory between different
configurations.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MBOXCACHEMINMBS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MBOXCACHEMINMBS"></a><span class="term"><code class="varname">mboxcacheminmbs</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MBOXCACHEMINMBS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MBOXCACHEMINMBS"></a><span class="term"><code class="varname">mboxcacheminmbs</code></span>
+ </dt>
<dd>
<p>Minimum mbox file size over which we cache the
offsets. There is really no sense in caching
offsets for small files. The default is 5 MB.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.WEBCACHEDIR" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.WEBCACHEDIR"></a><span class="term"><code class="varname">webcachedir</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.WEBCACHEDIR"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.WEBCACHEDIR"></a><span class="term"><code class="varname">webcachedir</code></span>
+ </dt>
<dd>
<p>Directory where we store the archived web pages.
This is only used by the web history indexing code
Default: cachedir/webcache if cachedir is set, else
$RECOLL_CONFDIR/webcache</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.WEBCACHEMAXMBS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.WEBCACHEMAXMBS"></a><span class="term"><code class="varname">webcachemaxmbs</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.WEBCACHEMAXMBS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.WEBCACHEMAXMBS"></a><span class="term"><code class="varname">webcachemaxmbs</code></span>
+ </dt>
<dd>
<p>Maximum size in MB of the Web archive. This is
only used by the web history indexing code.
Default: 40 MB. Reducing the size will not
physically truncate the file.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.WEBQUEUEDIR" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.WEBQUEUEDIR"></a><span class="term"><code class="varname">webqueuedir</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.WEBQUEUEDIR"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.WEBQUEUEDIR"></a><span class="term"><code class="varname">webqueuedir</code></span>
+ </dt>
<dd>
<p>The path to the Web indexing queue. This is
hard-coded in the plugin as ~/.recollweb/ToIndex so
there should be no need or possibility to change
it.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLDICDIR" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLDICDIR"></a><span class="term"><code class="varname">aspellDicDir</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLDICDIR" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLDICDIR"></a><span class="term"><code class="varname">aspellDicDir</code></span>
+ </dt>
<dd>
<p>Aspell dictionary storage directory location.
The aspell dictionary (aspdict.(lang).rws) is
@@ -9514,11 +8387,11 @@
cachedir if set, or under the configuration
directory.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERSDIR" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERSDIR"></a><span class="term"><code class="varname">filtersdir</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.FILTERSDIR"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERSDIR"></a><span class="term"><code class="varname">filtersdir</code></span>
+ </dt>
<dd>
<p>Directory location for executable input
handlers. If RECOLL_FILTERSDIR is set in the
@@ -9526,11 +8399,10 @@
$prefix/share/recoll/filters. Can be redefined for
subdirectories.</p>
</dd>
-
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.ICONSDIR"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ICONSDIR"></a><span class="term"><code class="varname">iconsdir</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.ICONSDIR"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.ICONSDIR"></a><span class="term"><code class="varname">iconsdir</code></span>
+ </dt>
<dd>
<p>Directory location for icons. The only reason to
change this would be if you want to change the
@@ -9539,25 +8411,24 @@
</dd>
</dl>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.PERFS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PERFS"></a>5.4.2.4. Parameters
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PERFS"></a>5.4.2.4.���Parameters
affecting indexing performance and resource
usage</h4>
</div>
</div>
</div>
-
<dl>
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXFLUSHMB" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXFLUSHMB"></a><span class="term"><code class="varname">idxflushmb</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.IDXFLUSHMB"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXFLUSHMB"></a><span class="term"><code class="varname">idxflushmb</code></span>
+ </dt>
<dd>
<p>Threshold (megabytes of new data) where we flush
from memory to disk index. Setting this allows some
@@ -9578,22 +8449,24 @@
counterproductive. If you find otherwise, please
drop me a note.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERMAXSECONDS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERMAXSECONDS"></a><span class="term"><code class="varname">filtermaxseconds</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERMAXSECONDS"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.FILTERMAXSECONDS">
+ </a><span class="term"><code class=
+ "varname">filtermaxseconds</code></span>
+ </dt>
<dd>
<p>Maximum external filter execution time in
seconds. Default 1200 (20mn). Set to 0 for no
limit. This is mainly to avoid infinite loops in
postscript files (loop.ps)</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERMAXMBYTES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERMAXMBYTES"></a><span class="term"><code class="varname">filtermaxmbytes</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERMAXMBYTES" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.FILTERMAXMBYTES"></a><span class="term"><code class="varname">filtermaxmbytes</code></span>
+ </dt>
<dd>
<p>Maximum virtual memory space for filter
processes (setrlimit(RLIMIT_AS)), in megabytes.
@@ -9603,11 +8476,11 @@
Anything over 2000 will be ignored on 32 bits
machines.</p>
</dd>
-
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.THRQSIZES"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.THRQSIZES"></a><span class="term"><code class="varname">thrQSizes</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.THRQSIZES"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.THRQSIZES"></a><span class="term"><code class="varname">thrQSizes</code></span>
+ </dt>
<dd>
<p>Stage input queues configuration. There are
three internal queues in the indexing pipeline
@@ -9624,11 +8497,11 @@
case). Use thrQSizes = -1 -1 -1 to disable
multithreading entirely.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.THRTCOUNTS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.THRTCOUNTS"></a><span class="term"><code class="varname">thrTCounts</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.THRTCOUNTS"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.THRTCOUNTS"></a><span class="term"><code class="varname">thrTCounts</code></span>
+ </dt>
<dd>
<p>Number of threads used for each indexing stage.
The three stages are: file data extraction, terms
@@ -9644,80 +8517,78 @@
</dd>
</dl>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.MISC" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MISC"></a>5.4.2.5. Miscellaneous
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MISC"></a>5.4.2.5.���Miscellaneous
parameters</h4>
</div>
</div>
</div>
-
<dl>
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.LOGLEVEL"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.LOGLEVEL"></a><span class="term"><code class="varname">loglevel</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.LOGLEVEL"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.LOGLEVEL"></a><span class="term"><code class="varname">loglevel</code></span>
+ </dt>
<dd>
<p>Log file verbosity 1-6. A value of 2 will print
only errors and warnings. 3 will print information
like document updates, 4 is quite verbose and 6
very verbose.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.LOGFILENAME" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.LOGFILENAME"></a><span class="term"><code class="varname">logfilename</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.LOGFILENAME"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.LOGFILENAME"></a><span class="term"><code class="varname">logfilename</code></span>
+ </dt>
<dd>
<p>Log file destination. Use 'stderr' (default) to
write to the console.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXLOGLEVEL" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXLOGLEVEL"></a><span class="term"><code class="varname">idxloglevel</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.IDXLOGLEVEL"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXLOGLEVEL"></a><span class="term"><code class="varname">idxloglevel</code></span>
+ </dt>
<dd>
<p>Override loglevel for the indexer.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXLOGFILENAME" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXLOGFILENAME"></a><span class="term"><code class="varname">idxlogfilename</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXLOGFILENAME" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXLOGFILENAME"></a><span class="term"><code class="varname">idxlogfilename</code></span>
+ </dt>
<dd>
<p>Override logfilename for the indexer.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMLOGLEVEL" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMLOGLEVEL"></a><span class="term"><code class="varname">daemloglevel</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMLOGLEVEL" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMLOGLEVEL"></a><span class="term"><code class="varname">daemloglevel</code></span>
+ </dt>
<dd>
<p>Override loglevel for the indexer in real time
mode. The default is to use the idx... values if
set, else the log... values.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMLOGFILENAME" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMLOGFILENAME"></a><span class="term"><code class="varname">daemlogfilename</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMLOGFILENAME" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.DAEMLOGFILENAME"></a><span class="term"><code class="varname">daemlogfilename</code></span>
+ </dt>
<dd>
<p>Override logfilename for the indexer in real
time mode. The default is to use the idx... values
if set, else the log... values.</p>
</dd>
-
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.IDXRUNDIR"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXRUNDIR"></a><span class="term"><code class="varname">idxrundir</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.IDXRUNDIR"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXRUNDIR"></a><span class="term"><code class="varname">idxrundir</code></span>
+ </dt>
<dd>
<p>Indexing process current directory. The input
handlers sometimes leave temporary files in the
@@ -9730,14 +8601,14 @@
is an absolute path to a directory, we go
there.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.CHECKNEEDRETRYINDEXSCRIPT"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.CHECKNEEDRETRYINDEXSCRIPT">
- </a><span class="term"><code class=
- "varname">checkneedretryindexscript</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.CHECKNEEDRETRYINDEXSCRIPT"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.CHECKNEEDRETRYINDEXSCRIPT">
+ </a><span class="term"><code class=
+ "varname">checkneedretryindexscript</code></span>
+ </dt>
<dd>
<p>Script used to heuristically check if we need to
retry indexing files which previously failed. The
@@ -9746,21 +8617,23 @@
be looked up in the filters dirs, then in the path.
Use an absolute path to do otherwise.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.RECOLLHELPERPATH" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.RECOLLHELPERPATH"></a><span class="term"><code class="varname">recollhelperpath</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.RECOLLHELPERPATH"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.RECOLLHELPERPATH">
+ </a><span class="term"><code class=
+ "varname">recollhelperpath</code></span>
+ </dt>
<dd>
<p>Additional places to search for helper
executables. This is only used on Windows for
now.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXABSMLEN" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXABSMLEN"></a><span class="term"><code class="varname">idxabsmlen</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.IDXABSMLEN"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXABSMLEN"></a><span class="term"><code class="varname">idxabsmlen</code></span>
+ </dt>
<dd>
<p>Length of abstracts we store while indexing.
Recoll stores an abstract for each indexed file.
@@ -9777,11 +8650,13 @@
always prefer the synthetic abstract, you can
reduce this value and save a little space.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXMETASTOREDLEN" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.IDXMETASTOREDLEN"></a><span class="term"><code class="varname">idxmetastoredlen</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.IDXMETASTOREDLEN"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.IDXMETASTOREDLEN">
+ </a><span class="term"><code class=
+ "varname">idxmetastoredlen</code></span>
+ </dt>
<dd>
<p>Truncation length of stored metadata fields.
This does not affect indexing (the whole field is
@@ -9791,11 +8666,11 @@
is 150 bytes which may be too low if you have
custom fields.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLLANGUAGE" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLLANGUAGE"></a><span class="term"><code class="varname">aspellLanguage</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLLANGUAGE" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLLANGUAGE"></a><span class="term"><code class="varname">aspellLanguage</code></span>
+ </dt>
<dd>
<p>Language definitions to use when creating the
aspell dictionary. The value must match a set of
@@ -9804,12 +8679,14 @@
not set is to use the NLS environment to guess the
value.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLADDCREATEPARAM"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLADDCREATEPARAM"></a><span class="term"><code class="varname">aspellAddCreateParam</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLADDCREATEPARAM"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLADDCREATEPARAM">
+ </a><span class="term"><code class=
+ "varname">aspellAddCreateParam</code></span>
+ </dt>
<dd>
<p>Additional option and parameter to aspell
dictionary creation command. Some aspell packages
@@ -9817,21 +8694,22 @@
Jessie: --local-data-dir=/usr/lib/aspell). See
Debian bug 772415.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLKEEPSTDERR" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLKEEPSTDERR"></a><span class="term"><code class="varname">aspellKeepStderr</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLKEEPSTDERR"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.ASPELLKEEPSTDERR">
+ </a><span class="term"><code class=
+ "varname">aspellKeepStderr</code></span>
+ </dt>
<dd>
<p>Set this to have a look at aspell dictionary
creation errors. There are always many, so this is
mostly for debugging.</p>
</dd>
-
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.NOASPELL"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.NOASPELL"></a><span class="term"><code class="varname">noaspell</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.NOASPELL"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.NOASPELL"></a><span class="term"><code class="varname">noaspell</code></span>
+ </dt>
<dd>
<p>Disable aspell use. The aspell dictionary
generation takes time, and some combinations of
@@ -9839,11 +8717,11 @@
in aspell crashing, so it sometimes makes sense to
just disable the thing.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONAUXINTERVAL" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONAUXINTERVAL"></a><span class="term"><code class="varname">monauxinterval</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONAUXINTERVAL" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONAUXINTERVAL"></a><span class="term"><code class="varname">monauxinterval</code></span>
+ </dt>
<dd>
<p>Auxiliary database update interval. The real
time indexer only updates the auxiliary databases
@@ -9851,11 +8729,11 @@
too costly to do it for every document change. The
default period is one hour.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONIXINTERVAL" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONIXINTERVAL"></a><span class="term"><code class="varname">monixinterval</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONIXINTERVAL" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONIXINTERVAL"></a><span class="term"><code class="varname">monixinterval</code></span>
+ </dt>
<dd>
<p>Minimum interval (seconds) between processings
of the indexing queue. The real time indexer does
@@ -9864,11 +8742,13 @@
aggregate multiple events affecting the same file.
Default 30 S.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONDELAYPATTERNS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONDELAYPATTERNS"></a><span class="term"><code class="varname">mondelaypatterns</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONDELAYPATTERNS"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.MONDELAYPATTERNS">
+ </a><span class="term"><code class=
+ "varname">mondelaypatterns</code></span>
+ </dt>
<dd>
<p>Timing parameters for the real time indexing.
Definitions for files which get a longer delay
@@ -9882,23 +8762,22 @@
empty. Example: mondelaypatterns = *.log:20 "*with
spaces.*:30"</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASS"></a><span class="term"><code class="varname">monioniceclass</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASS"></a><span class="term"><code class="varname">monioniceclass</code></span>
+ </dt>
<dd>
<p>ionice class for the real time indexing process
On platforms where this is supported. The default
value is 3.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASSDATA"
- id="RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASSDATA">
- </a><span class="term"><code class=
- "varname">monioniceclassdata</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASSDATA"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MONIONICECLASSDATA"></a><span class="term"><code class="varname">monioniceclassdata</code></span>
+ </dt>
<dd>
<p>ionice class parameter for the real time
indexing process. On platforms where this is
@@ -9906,24 +8785,23 @@
</dd>
</dl>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.QUERY" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.QUERY"></a>5.4.2.6. Query-time
+ "RCL.INSTALL.CONFIG.RECOLLCONF.QUERY"></a>5.4.2.6.���Query-time
parameters (no impact on the index)</h4>
</div>
</div>
</div>
-
<dl>
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.AUTODIACSENS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.AUTODIACSENS"></a><span class="term"><code class="varname">autodiacsens</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.AUTODIACSENS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.AUTODIACSENS"></a><span class="term"><code class="varname">autodiacsens</code></span>
+ </dt>
<dd>
<p>auto-trigger diacritics sensitivity (raw index
only). IF the index is not stripped, decide if we
@@ -9933,11 +8811,11 @@
language and the "D" modifier to specify diacritics
sensitivity. Default is no.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.AUTOCASESENS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.AUTOCASESENS"></a><span class="term"><code class="varname">autocasesens</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.AUTOCASESENS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.AUTOCASESENS"></a><span class="term"><code class="varname">autocasesens</code></span>
+ </dt>
<dd>
<p>auto-trigger case sensitivity (raw index only).
IF the index is not stripped (see indexStripChars),
@@ -9948,11 +8826,11 @@
to specify character-case sensitivity. Default is
yes.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MAXTERMEXPAND" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MAXTERMEXPAND"></a><span class="term"><code class="varname">maxTermExpand</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MAXTERMEXPAND" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MAXTERMEXPAND"></a><span class="term"><code class="varname">maxTermExpand</code></span>
+ </dt>
<dd>
<p>Maximum query expansion count for a single term
(e.g.: when using wildcards). This only affects
@@ -9961,11 +8839,13 @@
low at 1000), but it is unreasonable with a big
index. Default 10000.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MAXXAPIANCLAUSES" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MAXXAPIANCLAUSES"></a><span class="term"><code class="varname">maxXapianClauses</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MAXXAPIANCLAUSES"
+ id="RCL.INSTALL.CONFIG.RECOLLCONF.MAXXAPIANCLAUSES">
+ </a><span class="term"><code class=
+ "varname">maxXapianClauses</code></span>
+ </dt>
<dd>
<p>Maximum number of clauses we add to a single
Xapian query. This only affects queries, not
@@ -9973,11 +8853,12 @@
expansion can be multiplicative, and we want to
avoid eating all the memory. Default 50000.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SNIPPETMAXPOSWALK" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SNIPPETMAXPOSWALK"></a><span class="term"><code class="varname">snippetMaxPosWalk</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SNIPPETMAXPOSWALK"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SNIPPETMAXPOSWALK"></a><span class="term"><code class="varname">snippetMaxPosWalk</code></span>
+ </dt>
<dd>
<p>Maximum number of positions we walk while
populating a snippet for the result list. The
@@ -9987,44 +8868,43 @@
</dd>
</dl>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.PDF" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PDF"></a>5.4.2.7. Parameters
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PDF"></a>5.4.2.7.���Parameters
for the PDF input script</h4>
</div>
</div>
</div>
-
<dl>
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.PDFOCR"
- id="RCL.INSTALL.CONFIG.RECOLLCONF.PDFOCR"></a><span class="term"><code class="varname">pdfocr</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.PDFOCR" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PDFOCR"></a><span class="term"><code class="varname">pdfocr</code></span>
+ </dt>
<dd>
<p>Attempt OCR of PDF files with no text content if
both tesseract and pdftoppm are installed. The
default is off because OCR is so very slow.</p>
</dd>
-
- <dt><a name="RCL.INSTALL.CONFIG.RECOLLCONF.PDFATTACH"
- id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PDFATTACH"></a><span class="term"><code class="varname">pdfattach</code></span></dt>
-
+ <dt>
+ <a name="RCL.INSTALL.CONFIG.RECOLLCONF.PDFATTACH"
+ id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PDFATTACH"></a><span class="term"><code class="varname">pdfattach</code></span>
+ </dt>
<dd>
<p>Enable PDF attachment extraction by executing
pdftk (if available). This is normally disabled,
because it does slow down PDF indexing a bit even
if not one attachment is ever found.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETA" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETA"></a><span class="term"><code class="varname">pdfextrameta</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETA" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETA"></a><span class="term"><code class="varname">pdfextrameta</code></span>
+ </dt>
<dd>
<p>Extract text from selected XMP metadata tags.
This is a space-separated list of qualified XMP tag
@@ -10036,11 +8916,11 @@
file to direct processing of the extracted
data.</p>
</dd>
-
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETAFIX" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETAFIX"></a><span class="term"><code class="varname">pdfextrametafix</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETAFIX" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.PDFEXTRAMETAFIX"></a><span class="term"><code class="varname">pdfextrametafix</code></span>
+ </dt>
<dd>
<p>Define name of XMP field editing script. This
defines the name of a script to be loaded for
@@ -10054,24 +8934,23 @@
</dd>
</dl>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.SPECLOCATIONS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.SPECLOCATIONS"></a>5.4.2.8. Parameters
+ "RCL.INSTALL.CONFIG.RECOLLCONF.SPECLOCATIONS"></a>5.4.2.8.���Parameters
set for specific locations</h4>
</div>
</div>
</div>
-
<dl>
- <dt><a name=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MHMBOXQUIRKS" id=
- "RCL.INSTALL.CONFIG.RECOLLCONF.MHMBOXQUIRKS"></a><span class="term"><code class="varname">mhmboxquirks</code></span></dt>
-
+ <dt>
+ <a name=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MHMBOXQUIRKS" id=
+ "RCL.INSTALL.CONFIG.RECOLLCONF.MHMBOXQUIRKS"></a><span class="term"><code class="varname">mhmboxquirks</code></span>
+ </dt>
<dd>
<p>Enable thunderbird/mozilla-seamonkey mbox format
quirks Set this for the directory where the email
@@ -10080,19 +8959,17 @@
</dl>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.CONFIG.FIELDS" id=
- "RCL.INSTALL.CONFIG.FIELDS"></a>5.4.3. The
- fields file</h3>
- </div>
- </div>
- </div>
-
+ "RCL.INSTALL.CONFIG.FIELDS"></a>5.4.3.���The fields
+ file</h3>
+ </div>
+ </div>
+ </div>
<p>This file contains information about dynamic fields
handling in <span class="application">Recoll</span>. Some
very basic fields have hard-wired behaviour, and, mostly,
@@ -10100,46 +8977,39 @@
<code class="filename">fields</code> file. But you can
create custom fields fitting your data and handle them
just like they were native ones.</p>
-
<p>The <code class="filename">fields</code> file has
several sections, which each define an aspect of fields
processing. Quite often, you'll have to modify several
sections to obtain the desired behaviour.</p>
-
<p>We will only give a short description here, you should
refer to the comments inside the default file for more
detailed information.</p>
-
<p>Field names should be lowercase alphabetic ASCII.</p>
-
<div class="variablelist">
<dl class="variablelist">
<dt><span class="term">[prefixes]</span></dt>
-
<dd>
<p>A field becomes indexed (searchable) by having a
- prefix defined in this section.</p>
- </dd>
-
+ prefix defined in this section. There is a more
+ complete explanation of what prefixes are in used
+ by a standard recoll installation. In a nutshell:
+ extension prefixes should be all caps, begin with
+ XY, and short. E.g. XYMFLD.</p>
+ </dd>
<dt><span class="term">[stored]</span></dt>
-
<dd>
<p>A field becomes stored (displayable inside
results) by having its name listed in this section
(typically with an empty value).</p>
</dd>
-
<dt><span class="term">[aliases]</span></dt>
-
<dd>
<p>This section defines lists of synonyms for the
canonical names used inside the <code class=
"literal">[prefixes]</code> and <code class=
"literal">[stored]</code> sections</p>
</dd>
-
<dt><span class="term">[queryaliases]</span></dt>
-
<dd>
<p>This section also defines aliases for the
canonic field names, with the difference that the
@@ -10147,10 +9017,8 @@
avoiding any possibility that the value would
pick-up random metadata from documents.</p>
</dd>
-
<dt><span class="term">handler-specific
sections</span></dt>
-
<dd>
<p>Some input handlers may need specific
configuration for handling fields. Only the email
@@ -10162,7 +9030,6 @@
</dd>
</dl>
</div>
-
<p>Here follows a small example of a personal
<code class="filename">fields</code> file. This would
extract a specific email header and use it as a
@@ -10171,8 +9038,7 @@
on the values, only plain ascii headers can be indexed,
and only the first occurrence will be used for headers
that occur several times).</p>
- <pre class="programlisting">
-[prefixes]
+ <pre class="programlisting">[prefixes]
# Index mailmytag contents (with the given prefix)
mailmytag = XMTAG
@@ -10190,27 +9056,23 @@
# mailmytag field name
x-my-tag = mailmytag
</pre>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.FIELDS.XATTR" id=
- "RCL.INSTALL.CONFIG.FIELDS.XATTR"></a>5.4.3.1. Extended
+ "RCL.INSTALL.CONFIG.FIELDS.XATTR"></a>5.4.3.1.���Extended
attributes in the fields file</h4>
</div>
</div>
</div>
-
<p><span class="application">Recoll</span> versions
1.19 and later process user extended file attributes as
documents fields by default.</p>
-
<p>Attributes are processed as fields of the same name,
after removing the <code class="literal">user</code>
prefix on Linux.</p>
-
<p>The <code class="literal">[xattrtofields]</code>
section of the <code class="filename">fields</code>
file allows specifying translations from extended
@@ -10220,22 +9082,19 @@
data.</p>
</div>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.CONFIG.MIMEMAP" id=
- "RCL.INSTALL.CONFIG.MIMEMAP"></a>5.4.4. The
- mimemap file</h3>
- </div>
- </div>
- </div>
-
+ "RCL.INSTALL.CONFIG.MIMEMAP"></a>5.4.4.���The mimemap
+ file</h3>
+ </div>
+ </div>
+ </div>
<p><code class="filename">mimemap</code> specifies the
file name extension to MIME type mappings.</p>
-
<p>For file names without an extension, or with an
unknown one, a system command (<span class=
"command"><strong>file</strong></span> <code class=
@@ -10244,14 +9103,12 @@
executed to determine the MIME type (this can be switched
off, or the command changed inside the main configuration
file).</p>
-
<p>All extension values in <code class=
"filename">mimemap</code> must be entered in lower case.
File names extensions are lower-cased for comparison
during indexing, meaning that an upper case <code class=
"filename">mimemap</code> entry will never be
matched.</p>
-
<p>The mappings can be specified on a per-subtree basis,
which may be useful in some cases. Example: <span class=
"application">okular</span> notes have a <code class=
@@ -10259,10 +9116,8 @@
specially, which is possible because they are usually all
located in one place. Example:</p>
<pre class="programlisting">
-[~/.kde/share/apps/okular/docdata]
-.xml = application/x-okular-notes
-</pre>
-
+ [~/.kde/share/apps/okular/docdata]
+.xml = application/x-okular-notes</pre>
<p>The <code class="varname">recoll_noindex</code>
<code class="filename">mimemap</code> variable has been
moved to <code class="filename">recoll.conf</code> and
@@ -10276,29 +9131,25 @@
"varname">recoll_noindex</code> in <code class=
"filename">mimemap</code>.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.CONFIG.MIMECONF" id=
- "RCL.INSTALL.CONFIG.MIMECONF"></a>5.4.5. The
+ "RCL.INSTALL.CONFIG.MIMECONF"></a>5.4.5.���The
mimeconf file</h3>
</div>
</div>
</div>
-
<p><code class="filename">mimeconf</code> specifies how
the different MIME types are handled for indexing, and
which icons are displayed in the <span class=
"command"><strong>recoll</strong></span> result
lists.</p>
-
<p>Changing the parameters in the [index] section is
probably not a good idea except if you are a <span class=
"application">Recoll</span> developer.</p>
-
<p>The [icons] section allows you to change the icons
which are displayed by <span class=
"command"><strong>recoll</strong></span> in the result
@@ -10307,19 +9158,17 @@
directory (specified in <code class=
"filename">recoll.conf</code>).</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.CONFIG.MIMEVIEW" id=
- "RCL.INSTALL.CONFIG.MIMEVIEW"></a>5.4.6. The
+ "RCL.INSTALL.CONFIG.MIMEVIEW"></a>5.4.6.���The
mimeview file</h3>
</div>
</div>
</div>
-
<p><code class="filename">mimeview</code> specifies which
programs are started when you click on an <span class=
"guilabel">Open</span> link in a result list. Ie: HTML is
@@ -10331,12 +9180,10 @@
"command"><strong>oofice</strong></span> instead of
<span class="command"><strong>openoffice</strong></span>
etc.</p>
-
<p>Changes to this file can be done by direct editing, or
through the <span class=
"command"><strong>recoll</strong></span> GUI preferences
dialog.</p>
-
<p>If <span class="guilabel">Use desktop preferences to
choose document editor</span> is checked in the
<span class="application">Recoll</span> GUI preferences,
@@ -10345,7 +9192,6 @@
"literal">application/x-all</code> (which is set to use
<span class="command"><strong>xdg-open</strong></span> by
default).</p>
-
<p>In this case, the <code class=
"literal">xallexcepts</code> top level variable defines a
list of MIME type exceptions which will be processed
@@ -10355,16 +9201,13 @@
or a search string can be passed to applications that
support them, such as the <span class=
"application">evince</span> viewer.</p>
-
<p>As for the other configuration files, the normal usage
is to have a <code class="filename">mimeview</code>
inside your own configuration directory, with just the
non-default entries, which will override those from the
central configuration file.</p>
-
<p>All viewer definition entries must be placed under a
<code class="literal">[view]</code> section.</p>
-
<p>The keys in the file are normally MIME types. You can
add an application tag to specialize the choice for an
area of the filesystem (using a <code class=
@@ -10374,7 +9217,6 @@
"replaceable"><code>mimetype</code></em><code class=
"literal">|</code><em class=
"replaceable"><code>tag</code></em></p>
-
<p>The <code class="varname">nouncompforviewmts</code>
entry, (placed at the top level, outside of the
<code class="literal">[view]</code> section), holds a
@@ -10382,62 +9224,53 @@
starting the viewer (if they are found compressed, ie:
<em class=
"replaceable"><code>mydoc.doc.gz</code></em>).</p>
-
<p>The right side of each assignment holds a command to
be executed for opening the file. The following
substitutions are performed:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
<li class="listitem">
- <p><b>%D. </b>Document date</p>
+ <p><b>%D.���</b>Document date</p>
</li>
-
<li class="listitem">
- <p><b>%f. </b>File name. This may be the name
- of a temporary file if it was necessary to create
- one (ie: to extract a subdocument from a
+ <p><b>%f.���</b>File name. This may be the name of a
+ temporary file if it was necessary to create one
+ (ie: to extract a subdocument from a
container).</p>
</li>
-
<li class="listitem">
- <p><b>%i. </b>Internal path, for subdocuments
- of containers. The format depends on the container
+ <p><b>%i.���</b>Internal path, for subdocuments of
+ containers. The format depends on the container
type. If this appears in the command line,
<span class="application">Recoll</span> will not
create a temporary file to extract the subdocument,
expecting the called application (possibly a
script) to be able to handle it.</p>
</li>
-
<li class="listitem">
- <p><b>%M. </b>MIME type</p>
+ <p><b>%M.���</b>MIME type</p>
</li>
-
<li class="listitem">
- <p><b>%p. </b>Page index. Only significant for
- a subset of document types, currently only PDF,
+ <p><b>%p.���</b>Page index. Only significant for a
+ subset of document types, currently only PDF,
Postscript and DVI files. Can be used to start the
editor at the right page for a match or
snippet.</p>
</li>
-
<li class="listitem">
- <p><b>%s. </b>Search term. The value will only
- be set for documents with indexed page numbers (ie:
+ <p><b>%s.���</b>Search term. The value will only be
+ set for documents with indexed page numbers (ie:
PDF). The value will be one of the matched search
terms. It would allow pre-setting the value in the
"Find" entry inside Evince for example, for easy
highlighting of the term.</p>
</li>
-
<li class="listitem">
- <p><b>%u. </b>Url.</p>
+ <p><b>%u.���</b>Url.</p>
</li>
</ul>
</div>
-
<p>In addition to the predefined values above, all
strings like <code class="literal">%(fieldname)</code>
will be replaced by the value of the field named
@@ -10445,24 +9278,21 @@
This could be used in combination with field
customisation to help with opening the document.</p>
</div>
-
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.CONFIG.PTRANS" id=
- "RCL.INSTALL.CONFIG.PTRANS"></a>5.4.7. The
+ "RCL.INSTALL.CONFIG.PTRANS"></a>5.4.7.���The
<code class="filename">ptrans</code> file</h3>
</div>
</div>
</div>
-
<p><code class="filename">ptrans</code> specifies
query-time path translations. These can be useful in
<a class="link" href="#RCL.SEARCH.PTRANS" title=
- "3.5. Path translations">multiple cases</a>.</p>
-
+ "3.5.���Path translations">multiple cases</a>.</p>
<p>The file has a section for any index which needs
translations, either the main one or additional query
indexes. The sections are named with the <span class=
@@ -10477,34 +9307,30 @@
[/path/to/additional/xapiandb]
/server/volume1/docdir = /net/server/volume1/docdir
/server/volume2/docdir = /net/server/volume2/docdir
-
-</pre>
- </div>
-
+ </pre>
+ </div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name=
"RCL.INSTALL.CONFIG.EXAMPLES" id=
- "RCL.INSTALL.CONFIG.EXAMPLES"></a>5.4.8. Examples
+ "RCL.INSTALL.CONFIG.EXAMPLES"></a>5.4.8.���Examples
of configuration adjustments</h3>
</div>
</div>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.EXAMPLES.ADDVIEW" id=
- "RCL.INSTALL.CONFIG.EXAMPLES.ADDVIEW"></a>5.4.8.1. Adding
+ "RCL.INSTALL.CONFIG.EXAMPLES.ADDVIEW"></a>5.4.8.1.���Adding
an external viewer for an non-indexed type</h4>
</div>
</div>
</div>
-
<p>Imagine that you have some kind of file which does
not have indexable content, but for which you would
like to have a functional <span class=
@@ -10513,10 +9339,8 @@
"replaceable"><code>.blob</code></em> and can be
displayed by application <em class=
"replaceable"><code>blobviewer</code></em>.</p>
-
<p>You need two entries in the configuration files for
this to work:</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -10529,13 +9353,11 @@
<pre class="programlisting">
.blob = application/x-blobapp
</pre>
-
<p>Note that the MIME type is made up here, and
you could call it <em class=
"replaceable"><code>diesel/oil</code></em> just
the same.</p>
</li>
-
<li class="listitem">
<p>In <code class=
"filename">$RECOLL_CONFDIR/mimeview</code> under
@@ -10544,7 +9366,6 @@
<pre class="programlisting">
application/x-blobapp = blobviewer %f
</pre>
-
<p>We are supposing that <em class=
"replaceable"><code>blobviewer</code></em> wants
a file name parameter here, you would use
@@ -10553,7 +9374,6 @@
</li>
</ul>
</div>
-
<p>If you just wanted to change the application used by
<span class="application">Recoll</span> to display a
MIME type which it already knows, you would just need
@@ -10563,19 +9383,17 @@
alter. <code class="filename">mimeview</code> can also
be modified from the Gui.</p>
</div>
-
<div class="sect3">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a name=
"RCL.INSTALL.CONFIG.EXAMPLES.ADDINDEX" id=
- "RCL.INSTALL.CONFIG.EXAMPLES.ADDINDEX"></a>5.4.8.2. Adding
+ "RCL.INSTALL.CONFIG.EXAMPLES.ADDINDEX"></a>5.4.8.2.���Adding
indexing support for a new file type</h4>
</div>
</div>
</div>
-
<p>Let us now imagine that the above <em class=
"replaceable"><code>.blob</code></em> files actually
contain indexable text and that you know how to extract
@@ -10585,7 +9403,6 @@
add data to the <code class="filename">mimeconf</code>
file (typically in <code class=
"filename">~/.recoll/mimeconf</code>):</p>
-
<div class="itemizedlist">
<ul class="itemizedlist" style=
"list-style-type: disc;">
@@ -10598,7 +9415,6 @@
application/x-blobapp = exec rclblob
</pre>
</li>
-
<li class="listitem">
<p>Under the <code class="literal">[icons]</code>
section, you should choose an icon to be
@@ -10607,7 +9423,6 @@
live in <code class=
"filename">/usr/share/recoll/images</code>.</p>
</li>
-
<li class="listitem">
<p>Under the <code class=
"literal">[categories]</code> section, you should
@@ -10617,7 +9432,6 @@
</li>
</ul>
</div>
-
<p>The <em class=
"replaceable"><code>rclblob</code></em> handler should
be an executable program or script which exists inside
@@ -10625,10 +9439,8 @@
"filename">/usr/share/recoll/filters</code>. It will be
given a file name as argument and should output the
text or html contents on the standard output.</p>
-
<p>The <a class="link" href="#RCL.PROGRAM.FILTERS"
- title=
- "4.1. Writing a document input handler">filter
+ title="4.1.���Writing a document input handler">filter
programming</a> section describes in more detail how to
write an input handler.</p>
</div>