recoll / Code / Diff of /src/README

Diff of /src/README [20f0e3] .. [5fb98c]

Switch to unified view


...

   Copyright (c) 2005 Jean-Francois Dockes

   This document introduces full text search notions and describes the
   installation and use of the Recoll application. It currently describes
   Recoll 1.14.

   [ Split HTML / Single HTML ]

     ----------------------------------------------------------------------

...

                             2.5.2. Using cron to automate indexing

                2.6. Real time indexing

   3. Searching

                3.1. Searching with the Qt graphical user interface

                             3.1.1. Simple search

                             3.1.2. The result list



                             3.1.3. The preview window

                             3.1.4. Complex/advanced search

                             3.1.5. The term explorer tool

                             3.1.6. Multiple databases

                             3.1.7. Document history

                             3.1.8. Sorting search results and collapsing
                             duplicates

                             3.1.9. Search tips, shortcuts

                             3.1.10. Customizing the search interface

                3.2. Searching with the KDE KIO slave

                             3.2.1. What's this

                             3.2.2. Searchable documents

                3.3. Searching on the command line

                3.4. The query language





                             3.4.1. More about wildcards

                3.5. Desktop integration











                             3.5.1. Hotkeying recoll

                             3.5.2. The KDE Kicker Recoll applet











   4. Programming interface

                4.1. Writing a document filter

                             4.1.1. Filter HTML output

                4.2. Field data processing

                4.3. API

                             4.3.1. Interface elements

                             4.3.2. Python interface

   5. Installation and configuration

                5.1. Installing a binary copy

                             5.1.1. Installing through a package system

                             5.1.2. Installing a prebuilt Recoll

                5.2. Supporting packages

                5.3. Building from source

                             5.3.1. Prerequisites

                             5.3.2. Building

                             5.3.3. Installation

                5.4. Configuration overview

                             5.4.1. Main configuration file

                             5.4.2. The fields file

                             5.4.3. The mimemap file

                             5.4.4. The mimeconf file

                             5.4.5. The mimeview file

                             5.4.6. Examples of configuration adjustments



     ----------------------------------------------------------------------

                            Chapter 1. Introduction

...
   it if your system is short on resources. Periodic indexing is adequate in
   most cases.

     ----------------------------------------------------------------------

                              Chapter 3. Searching

3.1. Searching with the Qt graphical user interface

   The recoll program provides the main user interface for searching. It is
   based on the Qt library.

   recoll has two search modes:
...
   white space in this case (they would typically be printed without white
   space).

     ----------------------------------------------------------------------

  3.1.1. Simple search

    1. Start the recoll program.

    2. Possibly choose a search mode: Any term, All terms, File name or Query
       language.
...

   You can use the Tools / Advanced search dialog for more complex searches.

     ----------------------------------------------------------------------

  3.1.2. The result list

   After starting a search, a list of results will instantly be displayed in
   the main list window.

   By default, the document list is presented in order of relevance (how well
...
   the preferences). Use the arrow buttons in the toolbar or the links at the
   bottom of the page to browse the results.

     ----------------------------------------------------------------------

    3.1.2.1. The result list right-click menu

   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:

     * Preview

     * Open

     * Copy File Name

     * Copy Url

...

     * Preview Parent document

     * Open Parent document

   The Preview and Open entries do the same thing as the corresponding links.

   The Copy File Name and Copy Url copy the relevant data to the clipboard,
   for later pasting.

   Save to File allows saving the contents of a result document to a chosen
...
   this case. In other cases, the Open option makes sense, for exemple to
   start a chm viewer on the parent document for a help page.

     ----------------------------------------------------------------------

  3.1.3. The preview window

   The preview window opens when you first click a Preview link inside the
   result list.

   Subsequent preview requests for a given search open new tabs in the
...
   You can print the current preview window contents by typing ^P (Ctrl + P)
   in the window text.

     ----------------------------------------------------------------------




























































































































  3.1.4. Complex/advanced search

   The advanced search dialog helps you build more complex queries without
   memorizing the search language constructs. It can be opened through the
   Tools menu or through the main toolbar.

   The dialog has three parts:

     * The top part allows constructing a query by combining multiple clauses
       of different types. Each entry field is configurable for the following
...
   Click on the Show query details link at the top of the result page to see
   the query expansion.

     ----------------------------------------------------------------------

  3.1.5. The term explorer tool

   Recoll 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.
...
   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).

     ----------------------------------------------------------------------
































  3.1.6. Multiple databases

   Multiple Recoll databases or indexes can be created by using several
   configuration directories which are usually set to index different areas
   of the file system. A specific index can be selected for updating or
   searching, using the RECOLL_CONFDIR environment variable or the -c option
...
   with the directory filter in advanced search, but multiple indexes will
   have much better performance and may be worth the trouble.

     ----------------------------------------------------------------------

  3.1.7. Document history

   Documents that you actually view (with the internal preview or an external
   tool) are entered into the document history, which is remembered.

   You can display the history list by using the Tools/Doc History menu
...
   You can erase the document history by using the Erase document history
   entry in the File menu.

     ----------------------------------------------------------------------

  3.1.8. Sorting search results and collapsing duplicates

   The documents in a result list are normally sorted in order of relevance.
   It is possible to specify different sort parameters by using the Sort
   parameters dialog (located in the Tools menu).

...
   not be a duplicate of the text only). Duplicates hiding is controlled by
   an entry in the Query configuration dialog, and is off by default.

     ----------------------------------------------------------------------

  3.1.9. Search tips, shortcuts

    3.1.9.1. Terms and search expansion

   Term completion. Typing Esc Space 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.
...
   file name search which will only look for file names, and may be faster
   than the generic search especially when using wildcards.

     ----------------------------------------------------------------------

    3.1.9.2. Working with phrases and proximity

   Phrases and Proximity searches. A phrase can be looked for by enclosing it
   in double quotes. Example: "user manual" will look only for occurrences of
   user immediately followed by manual. You can use the This phrase field of
   the advanced search dialog to the same effect. Phrases can be entered
...
   documents where either virtual or reality or both appear, but those which
   contain virtual reality should appear sooner in the list.

     ----------------------------------------------------------------------

    3.1.9.3. Others

   Using fields. You can use the query language 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:
   search tips from:helpfulgui
...

   Quitting. Entering ^Q almost anywhere will close the application.

     ----------------------------------------------------------------------

  3.1.10. Customizing the search interface

   You can customize some aspects of the search interface by using the Query
   configuration entry in the Preferences menu.

   There are several tabs in the dialog, dealing with the interface itself,
...
       involves quite a lot of processing, and can be disabled over the given
       text size to speed up loading.

     * Use desktop preferences to choose document editor: if this is checked,
       the xdg-open utility will be used to open files when you click the
       Open link in the result list, instead of the application defined in
       mimeview. xdg-open will in term use your desktop preferences to choose
       an appropriate application.

     * Choose editor applications this will let you choose the command
       started by the Open links inside the result list, for specific
       document types.

     * Display category filter as toolbar... this will let you choose if the
       document categories are displayed as a list or a set of buttons.

...
   alternative indexer may also need to implement a way of purging the index
   from stale data,

     ----------------------------------------------------------------------

    3.1.10.1. The result list paragraph format

   The presentation of each result inside the result list can be customized
   by setting the result list paragraph format inside the User Interface tab
   of the Query configuration.

...
   if the custom formatting results in multiple paragraphs per result, right
   clicks will only work inside the first one.

     ----------------------------------------------------------------------

3.2. Searching with the KDE KIO slave

  3.2.1. What's this

   The Recoll KIO slave allows performing a Recoll search by entering an
   appropriate URL in a KDE open dialog, or with an HTML-based interface
   displayed in Konqueror.

...
   The interface is described in more detail inside a help file which you can
   access by entering recoll:/ inside the konqueror URL line (this works only
   if the recoll KIO slave has been previously installed).

   The instructions for building this module are located in the source tree.
   See: kde/kio/recoll/00README.txt. Some Linux distributions do package the
   kio-recoll module, so check before diving into the build process, maybe
   it's already out there ready for one-click installation.

     ----------------------------------------------------------------------

  3.2.2. Searchable documents

   As a sample application, the Recoll KIO slave could allow preparing a set
   of HTML documents (for example a manual) so that they become their own
   search interface inside konqueror.

...
  ....
 <body ondblclick="recollsearch()">

     ----------------------------------------------------------------------

3.3. Searching on the command line

   There are several ways to obtain search results as a text stream, without
   a graphical interface:

     * By passing option -t to the recoll program.
...
   The first two methods work in the same way and accept/need the same
   arguments (except for the additional -t to recoll). The query to be
   executed is specified as command line arguments.

   recollq is not built by default. You can use the Makefile in the query
   directory to build it. This is a very simple program, and if you can
   program a little c++, you may find it useful to taylor its output format
   to your needs.

   recollq has a man page (not installed by default, look in the doc/man
   directory). The Usage string is as follows:

 recollq [-o|-a|-f] <query string>
...
 text/html       [file:///Users/uncrypted-dockes/projets/pagepers/index.html]    [psxtcl/writemime/recoll]...
 text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/recu-chasse-maree....

     ----------------------------------------------------------------------

3.4. The query language

   The query language processor is activated in the GUI simple search entry
   when the search mode selector is set to Query Language. 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.
   Additionally, the query language is for now the only way to access the
   important Recoll field search capabilities.

   The language is roughly based on the Xesam user search language
   specification.

   If the results of a query language search puzzle you and you doubt what
   has been actually searched for, you can use the GUI show query link at the
   top of the result list to check the exact query which was finally executed
   by Xapian.

   Here follows a sample request that we are going to explain:

           author:"john doe" Beatles OR Lennon Live OR Unplugged -potatoes
     

   This would search for all documents with John Doe appearing as a phrase in
   the author field (exactly what this is would depend on the document type,
   ie: the From: header, for an email message), and containing either beatles
   or lennon and either live or unplugged but not potatoes (in any part of
   the document).

   An element is composed of an optional field specification, and a value,
   separated by a colon. Exemple: Beatles, author:balzac, dc:title:grandet

   The colon, if present, means "contains". Xesam defines other relations,
   which are not supported for now.

   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
   Beatles OR Lennon. The OR must be entered literally (capitals), and it has
   priority over the AND associations: word1 word2 OR word3 means word1 AND
   (word2 OR word3) not (word1 AND word2) OR word3. Do not enter explicit
   parenthesis, they are not supported for now.

   An element preceded by a - specifies a term that should not appear. Pure
   negative queries are forbidden.

   As usual, words inside quotes define a phrase (the order of words is
   significant), so that title:"prejudice pride" is not the same as
   title:prejudice title:pride, and is unlikely to find a result.

   Most Xesam phrase modifiers are unsupported, except for l (small ell) to
   disable stemming, and p to turn a phrase into a NEAR (unordered proximity)
   search. Exemple: "prejudice pride"p

   Recoll currently manages the following default fields:

     * title, subject or caption are synonyms which specify data to be
       searched for in the document title or subject.

     * author or from for searching the documents originators.

     * recipient or to for searching the documents recipients.

     * keyword for searching the document-specified keywords (few documents
       actually have any).

     * filename for the document's file name.

     * ext specifies the file name extension (Ex: ext:html)

   The field syntax also supports a few field-like, but special, criteria:

     * dir for filtering the results on file location (Ex:
       dir:/home/me/somedir). Please note that this is quite inefficient,
       that it may produce very slow searches, and that it may be worth in
       some cases to set up separate databases instead.

     * date for searching or filtering on dates. The syntax for the argument
       is based on the ISO8601 standard for dates and time intervals. Only
       dates are supported, no times. The general syntax is 2 elements
       separated by a / character. Each element can be a date or a period of
       time. Periods are specified as PnYnMnD. The n numbers are the
       respective numbers of years, months or days, any of which may be
       missing. Dates are specified as YYYY-MM-DD. The days and months parts
       may be missing. If the / is present but an element is missing, the
       missing element is interpreted as the lowest or highest date in the
       index. Exemples:

          * 2001-03-01/2002-05-01 the basic syntax for an interval of dates.

          * 2001-03-01/P1Y2M the same specified with a period.

          * 2001/ from the beginning of 2001 to the latest date in the index.

          * 2001 the whole year of 2001

          * P2D/ means 2 days ago up to now if there are no documents with
            dates in the future.

          * /2003 all documents from 2003 or older.

       Periods can also be specified with small letters (ie: p2y).

     * mime or format for specifying the mime type. This one is quite special
       because you can specify several values which will be OR'ed (the normal
       default for the language is AND). Ex: mime:text/plain mime:text/html.
       Specifying an explicit boolean operator or negation (-) before a mime
       specification is not supported and will produce strange results. Note
       that mime is the ONLY field with an OR default. You do need to use OR
       with ext terms for example.

     * type or rclcat for specifying the category (as in
       text/media/presentation/etc.). The classification of mime types in
       categories is defined in the Recoll configuration (mimeconf), and can
       be modified or extended. The default category names are those which
       permit filtering results in the main GUI screen. Categories are OR'ed
       like mime types above.

   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
   More about wildcards.

   The document filters 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.

     ----------------------------------------------------------------------

  3.4.1. More about wildcards

   All words entered in Recoll search fields will be processed for wildcard
   expansion before the request is finally executed.

   The wildcard characters are:

     * * which matches 0 or more characters.

     * ? which matches a single character.

     * [] which allow defining sets of characters to be matched (ex: [abc]
       matches a single character which may be 'a' or 'b' or 'c', [0-9]
       matches any number.

   You should be aware of a few things before using wildcards.

     * Using a wildcard character at the beginning of a word can make for a
       slow search because Recoll will have to scan the whole index term list
       to find the matches.

     * Using a * at the end of a word can produce more matches than you would
       think, and strange search results. You can use the term explorer 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 * (stem expansion
       is turned off when any wildcard character appears in the term).

     ----------------------------------------------------------------------

3.5. Desktop integration

   Being independant of the desktop type has its drawbacks: Recoll desktop
   integration is minimal. Here follow a few things that may help.

     ----------------------------------------------------------------------

  3.5.1. Hotkeying recoll

   It is surprisingly convenient to be able to show or hide the Recoll GUI
   with a single keystroke. Recoll comes with a small python script, based on
   the libwnck window manager interface library, which will allow you to do
   just this. The detailed instructions are on this wiki page.

     ----------------------------------------------------------------------

  3.5.2. The KDE Kicker Recoll applet

   The Recoll source tree contains the source code to the recoll_applet, a
   small application derived from the find_applet. This can be used to add a
   small Recoll launcher to the KDE panel.

   The applet is not automatically built with the main Recoll programs, nor
   is it included with the main source distribution (because the KDE build
   boilerplate makes it relatively big). You can download its source from the
   recoll.org download page. Use the omnipotent configure;make;make install
   incantation to build and install.

   You can then add the applet to the panel by right-clicking the panel and
   choosing the Add applet entry.

   The recoll_applet has a small text window where you can type a Recoll
   query (in query language form), and an icon which can be used to restrict
   the search to certain types of files. It is quite primitive, and launches
   a new recoll GUI instance every time (even if it is already running). You
   may find it useful anyway.

     ----------------------------------------------------------------------

                        Chapter 4. Programming interface

   Recoll has an Application programming Interface, usable both for indexing
   and searching, currently accessible from the Python language.

   Another less radical way to extend the application is to write filters for
...
   The processing of metadata attributes for documents (fields) is highly
   configurable.

     ----------------------------------------------------------------------

4.1. Writing a document filter

   Recoll filters are executable programs which translate from a specific
   format (ie: openoffice, acrobat, etc.) to the Recoll indexing input
   format, which may be text/plain or text/html.

...
   cannot specify the character set and other metadata, so they are limited
   to cases where these elements are not needed.

     ----------------------------------------------------------------------

  4.1.1. Filter HTML output

   The output HTML could be very minimal like the following example:

 <html><head>
 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
...
   See the following section for details about configuring how field data is
   processed by the indexer.

     ----------------------------------------------------------------------

4.2. Field data processing

   Fields are named pieces of information in or about documents, like title,
   author, abstract.

   The field values for documents can appear in several ways during indexing:
...
   You can find more information in the section about the fields file, or in
   comments inside the file.

     ----------------------------------------------------------------------

4.3. API

  4.3.1. Interface elements

   A few elements in the interface are specific and and need an explanation.

   udi

...
   during indexing. The main indexer documents would also probably be a
   problem for the external indexer purge operation.

     ----------------------------------------------------------------------

  4.3.2. Python interface

    4.3.2.1. Introduction

   Recoll versions after 1.11 define a Python programming interface, both for
   searching and indexing.

   The Python interface is not built by default and can be found in the
...
   python setup.py build
   python setup.py install

     ----------------------------------------------------------------------

    4.3.2.2. Interface manual

   NAME
       recoll - This is an interface to the Recoll full text indexer.

   FILE
...

   

     ----------------------------------------------------------------------

    4.3.2.3. Example code

   The following sample would query the index with a user language string.
   See the python/samples directory inside the Recoll source for other
   examples.

...

 

     ----------------------------------------------------------------------

                   Chapter 5. Installation and configuration

5.1. Installing a binary copy

   There are three types of binary Recoll installations:

     * Through your system normal software distribution framework (ie,
       Debian/Ubuntu apt, FreeBSD ports, etc.).
...
   may not be necessary for a quick test with default parameters). Most
   parameters can be more conveniently set from the GUI interface.

     ----------------------------------------------------------------------

  5.1.1. Installing through a package system

   If you use a BSD-type port system or a prebuilt package (DEB, RPM,
   manually or through the system software configuration utility), just
   follow the usual procedure for your system.

     ----------------------------------------------------------------------

  5.1.2. Installing a prebuilt Recoll

   The unpackaged binary versions on the Recoll web site are just compressed
   tar files of a build tree, where only the useful parts were kept
   (executables and sample configuration).

...
   had built the package from source (that is, just type make install). The
   binary trees are built for installation to /usr/local.

     ----------------------------------------------------------------------

5.2. Supporting packages

   Recoll uses external applications to index some file types. You need to
   install them for the file types that you wish to have indexed (these are
   run-time optional dependencies. None is needed for building or running
   Recoll except for indexing their specific file type).
...

   A list of common file types which need external commands follows. Many of
   the filters need the iconv command, which is not always listed as a
   dependancy.

   Please note that, due to the relatively dynamic nature of this
   information, the most up to date version is now kept on the Recoll helper
   applications page along with links to the home pages or best
   source/patches download links. The list below is not updated often and may
   be quite stale.

   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 best version for Recoll, so you should take a look at
   the Recoll helper applications page if a file type is important to you.

   As of Recoll release 1.14, a number of XML-based formats that were handled
   by ad hoc filter code now use the xsltproc command, which usually comes
   with libxslt. These are: abiword, fb2 (ebooks), kword, openoffice, svg.

   Now for the list:


     * Openoffice files need unzip and xsltproc.

     * PDF files need pdftotext which is part of the Xpdf or Poppler
       packages.

     * Postscript files need pstotext. The original version has an issue with
       shell character in file names, which is corrected in recent packages.
       See the the Recoll helper applications page for more detail.

     * MS Word needs antiword. It is also useful to have wvWare installed as
       it may be be used as a fallback for some files which antiword does not
       handle.

     * MS Excel and PowerPoint need catdoc.

     * MS Open XML (docx) needs xsltproc.

     * Wordperfect files need wpd2html from the libwpd package.

     * RTF files need unrtf, which, in its standard version, has much trouble
       with non-western character sets. Check the Recoll helper applications
       page.

     * TeX files need untex or detex. Check the Recoll helper applications
       page for sources if it's not packaged for your distribution.



     * dvi files need dvips.

     * djvu files need djvutxt and djvused from the DjVuLibre package.

     * Audio files: Recoll releases before 1.13 used the id3info command from
       the id3lib package to extract mp3 tag information, metaflac (standard
       flac tools) for flac files, and ogginfo (vorbis tools) for ogg files.
       Releases 1.14 and later use a single Python filter based on mutagen
       for all audio file types.


     * Pictures: Recoll uses the Exiftool Perl package to extract tag
       information. Most image file formats are supported. Note that there
       may not be much interest in indexing the technical tags (image size,
       aperture, etc.). This is only of interest if you store personal tags
       or textual descriptions inside the image files.

     * chm: files in microsoft help format need Python and the pychm module
       (which needs chmlib).

     * ICS: up to Recoll 1.13, iCalendar files need Python and the icalendar
       module. icalendar is not needed for newer versions, which use internal
       code.

     * Zip archives need Python (and the standard zipfile module).

   Text, HTML, mail folders, and Scribus files are processed internally. Lyx
   is used to index Lyx files. Many filters need iconv and the standard sed
   and awk.

     ----------------------------------------------------------------------

5.3. Building from source

  5.3.1. Prerequisites

   C++ compiler. Up to Recoll version 1.13.04, its absence can manifest
   itself by strange messages about a missing iconv_open.

   Development files for Xapian core.

     Important: If you are building Xapian for an older CPU (before Pentium 4
     or Athlon 64), you need to add the --disable-sse flag to the configure
     command. Else all Xapian application will crash with an illegal
     instruction error.

   Development files for Qt .

   Development files for X11 and zlib.

...
   not be critical). On Linux systems, the iconv interface is part of libc
   and you should not need to do anything special.

     ----------------------------------------------------------------------

  5.3.2. Building

   Recoll has been built on Linux, FreeBSD, Mac OS X, and Solaris, most
   versions after 2005 should be ok, maybe some older ones too (Solaris 8 is
   ok). If you build on another system, and need to modify things, I would
   very much welcome patches.
...
   to manually copy and modify one of the existing files (the new file name
   should be the output of uname -s).

     ----------------------------------------------------------------------

  5.3.3. Installation

   Either type make install or execute recollinstall prefix, in the root of
   the source tree. This will copy the commands to prefix/bin and the sample
   configuration files, scripts and other shared data to prefix/share/recoll.

...

   You can then proceed to configuration.

     ----------------------------------------------------------------------

5.4. Configuration overview

   Most of the parameters specific to the recoll GUI are set through the
   Preferences menu and stored in the standard Qt place ($HOME/.qt/recollrc).
   You probably do not want to edit this by hand.

...
   White space is used for separation inside lists. List elements with
   embedded spaces can be quoted using double-quotes.

     ----------------------------------------------------------------------

  5.4.1. Main configuration file

   recoll.conf is the main configuration file. It defines things like what to
   index (top directories and things to ignore), and the default character
   set to use for document types which do not specify it internally.

...
   Configuration menu in the recoll interface. Some can only be set by
   editing the configuration file.

     ----------------------------------------------------------------------

    5.4.1.1. Parameters affecting what documents we index:

   topdirs

           Specifies the list of directories or files to index (recursively
           for directories). You can use symbolic links as elements of this
...
           Beagle plugin as ~/.beagle/ToIndex so there should be no need to
           change it.

     ----------------------------------------------------------------------

    5.4.1.2. Parameters affecting how we generate terms:

   Changing some of these parameters will imply a full reindex. Also, when
   using multiple indexes, it may not make sense to search indexes that don't
   share the values for these parameters, because they usually affect both
   search and index operations.
...
           localfields= rclaptg=gnus:other = val, then select specifier
           viewer with mimetype|tag=... in mimeview.

     ----------------------------------------------------------------------

    5.4.1.3. Parameters affecting where and how we store things:

   dbdir

           The name of the Xapian data directory. It will be created if
           needed when the index is initialized. If this is not an absolute
...
           default, which is flushing every 10000 documents (memory usage
           depends on average document size). The default value is 10.

     ----------------------------------------------------------------------

    5.4.1.4. Miscellaneous parameters:

   loglevel,daemloglevel

           Verbosity level for recoll and recollindex. A value of 4 lists
           quite a lot of debug/information messages. 2 only lists errors.
...
           internal value is available (ie: for plain text files). This does
           not work well in general, and should probably not be used.

     ----------------------------------------------------------------------

  5.4.2. The fields file

   This file contains information about dynamic fields handling in Recoll.
   Some very basic fields have hard-wired behaviour, and, mostly, you should
   not change the original data inside the fields file. But you can create
   custom fields fitting your data and handle them just like they were native
...
 # mailmytag field name
 x-my-tag = mailmytag

     ----------------------------------------------------------------------

  5.4.3. The mimemap file

   mimemap specifies the file name extension to mime type mappings.

   For file names without an extension, or with an unknown one, the system's
   file -i command will be executed to determine the mime type (this can be
...
   given Recoll version. Having it there avoids cluttering the more
   user-oriented and locally customized skippedNames.

     ----------------------------------------------------------------------

  5.4.4. The mimeconf file

   mimeconf specifies how the different mime types are handled for indexing,
   and which icons are displayed in the recoll result lists.

   Changing the parameters in the [index] section is probably not a good idea
...
   recoll in the result lists (the values are the basenames of the png images
   inside the iconsdir directory (specified in recoll.conf).

     ----------------------------------------------------------------------

  5.4.5. The mimeview file

   mimeview specifies which programs are started when you click on an Open
   link in a result list. Ie: HTML is normally displayed using firefox, but
   you may prefer Konqueror, your openoffice.org program might be named
   oofice instead of openoffice etc.

   Changes to this file can be done by direct editing, or through the recoll
   user preferences dialog.

   If Use desktop preferences to choose document editor is checked in the
   Recoll GUI user preferences, all mimeview entries will be ignored except
   the one labelled application/x-all (which is set to use xdg-open by
   default).

   As for the other configuration files, the normal usage is to have a
   mimeview inside your own configuration directory, with just the
   non-default entries, which will override those from the central
   configuration file.
...
   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
   localfields specification in mimeconf). The syntax for the key is
   mimetype|tag





   The nouncompforviewmts entry, (placed at the top level, outside of the
   [view] section), holds a list of mime types that should not be
   uncompressed before starting the viewer (if they are found compressed, ie:
   mydoc.doc.gz).

   The right side of each assignment holds a command to be executed for
   opening the file. The following substitutions are performed:

     * %D. Document date

     * %f. 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).

     * %F. Original file name. Same as %f except if a temporary file is used.

     * %i. Internal path, for subdocuments of containers. The format depends
       on the container type. If this appears in the command line, Recoll
       will not create a temporary file to extract the subdocument, expecting
       the called application (possibly a script) to be able to handle it.

     * %M. Mime type

     * %U, %u. Url.

   In addition to the predefined values above, all strings like %(fieldname)
   will be replaced by the value of the field named fieldname for the
   document. This could be used in combination with field customisation to
   help with opening the document.

     ----------------------------------------------------------------------

  5.4.6. Examples of configuration adjustments

    5.4.6.1. Adding an external viewer for an non-indexed type

   Imagine that you have some kind of file which does not have indexable
   content, but for which you would like to have a functional Open link in
   the result list (when found by file name). The file names end in .blob and
   can be displayed by application blobviewer.

   You need two entries in the configuration files for this to work:

...
   configuration, which you do not need to alter. mimeview can also be
   modified from the Gui.

     ----------------------------------------------------------------------

    5.4.6.2. Adding indexing support for a new file type

   Let us now imagine that the above .blob files actually contain indexable
   text and that you know how to extract it with a command line program.
   Getting Recoll to index the files is easy. You need to perform the above
   alteration, and also to add data to the mimeconf file (typically in
...

   The filter programming section describes in more detail how to write a
   filter.

     ----------------------------------------------------------------------
























	a/src/README		b/src/README
	...		...
10		10
11	Copyright (c) 2005 Jean-Francois Dockes	11	Copyright (c) 2005 Jean-Francois Dockes
12		12
13	This document introduces full text search notions and describes the	13	This document introduces full text search notions and describes the
14	installation and use of the Recoll application. It currently describes	14	installation and use of the Recoll application. It currently describes
15	Recoll 1.12-1.13.	15	Recoll 1.14.
16		16
17	[ Split HTML / Single HTML ]	17	[ Split HTML / Single HTML ]
18		18
19	----------------------------------------------------------------------	19	----------------------------------------------------------------------
20		20
	...		...
50		50
51	2.5.2. Using cron to automate indexing	51	2.5.2. Using cron to automate indexing
52		52
53	2.6. Real time indexing	53	2.6. Real time indexing
54		54
		55	3. Searching
		56
55	3. Searching with the Qt graphical user interface	57	3.1. Searching with the Qt graphical user interface
56		58
57	3.1. Simple search	59	3.1.1. Simple search
58		60
59	3.2. The result list	61	3.1.2. The result list
60		62
61	3.2.1. The result list right-click menu
62
63	3.3. The preview window	63	3.1.3. The preview window
		64
		65	3.1.4. Complex/advanced search
		66
		67	3.1.5. The term explorer tool
		68
		69	3.1.6. Multiple databases
		70
		71	3.1.7. Document history
		72
		73	3.1.8. Sorting search results and collapsing
		74	duplicates
		75
		76	3.1.9. Search tips, shortcuts
		77
		78	3.1.10. Customizing the search interface
		79
		80	3.2. Searching with the KDE KIO slave
		81
		82	3.2.1. What's this
		83
		84	3.2.2. Searchable documents
		85
		86	3.3. Searching on the command line
64		87
65	3.4. The query language	88	3.4. The query language
66		89
67	3.5. Complex/advanced search
68
69	3.6. The term explorer tool
70
71	3.7. More about wildcards	90	3.4.1. More about wildcards
72		91
73	3.8. Multiple databases	92	3.5. Desktop integration
74		93
75	3.9. Document history
76
77	3.10. Sorting search results and collapsing duplicates
78
79	3.11. Search tips, shortcuts
80
81	3.11.1. Terms and search expansion
82
83	3.11.2. Working with phrases and proximity
84
85	3.11.3. Others	94	3.5.1. Hotkeying recoll
86		95
87	3.12. Customizing the search interface	96	3.5.2. The KDE Kicker Recoll applet
88		97
89	3.12.1. The result list paragraph format
90
91	4. Searching with the KDE KIO slave
92
93	4.1. What's this
94
95	4.2. Searchable documents
96
97	5. Searching on the command line
98
99	6. Programming interface	98	4. Programming interface
100		99
101	6.1. Writing a document filter	100	4.1. Writing a document filter
102		101
103	6.1.1. Filter HTML output	102	4.1.1. Filter HTML output
104		103
105	6.2. Field data processing	104	4.2. Field data processing
106		105
107	6.3. API	106	4.3. API
108		107
109	6.3.1. Interface elements	108	4.3.1. Interface elements
110		109
111	6.3.2. Python interface	110	4.3.2. Python interface
112		111
113	7. Installation	112	5. Installation and configuration
114		113
115	7.1. Installing a binary copy	114	5.1. Installing a binary copy
116		115
117	7.1.1. Installing through a package system	116	5.1.1. Installing through a package system
118		117
119	7.1.2. Installing a prebuilt Recoll	118	5.1.2. Installing a prebuilt Recoll
120		119
121	7.2. Supporting packages	120	5.2. Supporting packages
122		121
123	7.3. Building from source	122	5.3. Building from source
124		123
125	7.3.1. Prerequisites	124	5.3.1. Prerequisites
126		125
127	7.3.2. Building	126	5.3.2. Building
128		127
129	7.3.3. Installation	128	5.3.3. Installation
130		129
131	7.4. Configuration overview	130	5.4. Configuration overview
132		131
133	7.4.1. Main configuration file	132	5.4.1. Main configuration file
134		133
135	7.4.2. The fields file	134	5.4.2. The fields file
136		135
137	7.4.3. The mimemap file	136	5.4.3. The mimemap file
138		137
139	7.4.4. The mimeconf file	138	5.4.4. The mimeconf file
140		139
141	7.4.5. The mimeview file	140	5.4.5. The mimeview file
142		141
143	7.4.6. Examples of configuration adjustments	142	5.4.6. Examples of configuration adjustments
144
145	7.5. The KDE Kicker Recoll applet
146		143
147	----------------------------------------------------------------------	144	----------------------------------------------------------------------
148		145
149	Chapter 1. Introduction	146	Chapter 1. Introduction
150		147
	...		...
578	it if your system is short on resources. Periodic indexing is adequate in	575	it if your system is short on resources. Periodic indexing is adequate in
579	most cases.	576	most cases.
580		577
581	----------------------------------------------------------------------	578	----------------------------------------------------------------------
582		579
		580	Chapter 3. Searching
		581
583	Chapter 3. Searching with the Qt graphical user interface	582	3.1. Searching with the Qt graphical user interface
584		583
585	The recoll program provides the main user interface for searching. It is	584	The recoll program provides the main user interface for searching. It is
586	based on the Qt library.	585	based on the Qt library.
587		586
588	recoll has two search modes:	587	recoll has two search modes:
	...		...
606	white space in this case (they would typically be printed without white	605	white space in this case (they would typically be printed without white
607	space).	606	space).
608		607
609	----------------------------------------------------------------------	608	----------------------------------------------------------------------
610		609
611	3.1. Simple search	610	3.1.1. Simple search
612		611
613	1. Start the recoll program.	612	1. Start the recoll program.
614		613
615	2. Possibly choose a search mode: Any term, All terms, File name or Query	614	2. Possibly choose a search mode: Any term, All terms, File name or Query
616	language.	615	language.
	...		...
666		665
667	You can use the Tools / Advanced search dialog for more complex searches.	666	You can use the Tools / Advanced search dialog for more complex searches.
668		667
669	----------------------------------------------------------------------	668	----------------------------------------------------------------------
670		669
671	3.2. The result list	670	3.1.2. The result list
672		671
673	After starting a search, a list of results will instantly be displayed in	672	After starting a search, a list of results will instantly be displayed in
674	the main list window.	673	the main list window.
675		674
676	By default, the document list is presented in order of relevance (how well	675	By default, the document list is presented in order of relevance (how well
	...		...
712	the preferences). Use the arrow buttons in the toolbar or the links at the	711	the preferences). Use the arrow buttons in the toolbar or the links at the
713	bottom of the page to browse the results.	712	bottom of the page to browse the results.
714		713
715	----------------------------------------------------------------------	714	----------------------------------------------------------------------
716		715
717	3.2.1. The result list right-click menu	716	3.1.2.1. The result list right-click menu
718		717
719	Apart from the preview and edit links, you can display a pop-up menu by	718	Apart from the preview and edit links, you can display a pop-up menu by
720	right-clicking over a paragraph in the result list. This menu has the	719	right-clicking over a paragraph in the result list. This menu has the
721	following entries:	720	following entries:
722		721
723	* Preview	722	* Preview
724		723
725	* Edit	724	* Open
726		725
727	* Copy File Name	726	* Copy File Name
728		727
729	* Copy Url	728	* Copy Url
730		729
	...		...
734		733
735	* Preview Parent document	734	* Preview Parent document
736		735
737	* Open Parent document	736	* Open Parent document
738		737
739	The Preview and Edit entries do the same thing as the corresponding links.	738	The Preview and Open entries do the same thing as the corresponding links.
740		739
741	The Copy File Name and Copy Url copy the relevant data to the clipboard,	740	The Copy File Name and Copy Url copy the relevant data to the clipboard,
742	for later pasting.	741	for later pasting.
743		742
744	Save to File allows saving the contents of a result document to a chosen	743	Save to File allows saving the contents of a result document to a chosen
	...		...
762	this case. In other cases, the Open option makes sense, for exemple to	761	this case. In other cases, the Open option makes sense, for exemple to
763	start a chm viewer on the parent document for a help page.	762	start a chm viewer on the parent document for a help page.
764		763
765	----------------------------------------------------------------------	764	----------------------------------------------------------------------
766		765
767	3.3. The preview window	766	3.1.3. The preview window
768		767
769	The preview window opens when you first click a Preview link inside the	768	The preview window opens when you first click a Preview link inside the
770	result list.	769	result list.
771		770
772	Subsequent preview requests for a given search open new tabs in the	771	Subsequent preview requests for a given search open new tabs in the
	...		...
806	You can print the current preview window contents by typing ^P (Ctrl + P)	805	You can print the current preview window contents by typing ^P (Ctrl + P)
807	in the window text.	806	in the window text.
808		807
809	----------------------------------------------------------------------	808	----------------------------------------------------------------------
810		809
811	3.4. The query language
812
813	The query language processor is activated on the simple search entry when
814	the search mode selector is set to Query Language.
815
816	The language is roughly based on the Xesam user search language
817	specification.
818
819	Here follows a sample request that we are going to explain:
820
821	author:"john doe" Beatles OR Lennon Live OR Unplugged -potatoes
822
823
824	This would search for all documents with John Doe appearing as a phrase in
825	the author field (exactly what this is would depend on the document type,
826	ie: the From: header, for an email message), and containing either beatles
827	or lennon and either live or unplugged but not potatoes (in any part of
828	the document).
829
830	An element is composed of an optional field specification, and a value,
831	separated by a colon. Exemple: Beatles, author:balzac, dc:title:grandet
832
833	The colon, if present, means "contains". Xesam defines other relations,
834	which are not supported for now.
835
836	All elements in the search entry are normally combined with an implicit
837	AND. It is possible to specify that elements be OR'ed instead, as in
838	Beatles OR Lennon. The OR must be entered literally (capitals), and it has
839	priority over the AND associations: word1 word2 OR word3 means word1 AND
840	(word2 OR word3) not (word1 AND word2) OR word3. Do not enter explicit
841	parenthesis, they are not supported for now.
842
843	An element preceded by a - specifies a term that should not appear. Pure
844	negative queries are forbidden.
845
846	As usual, words inside quotes define a phrase (the order of words is
847	significant), so that title:"prejudice pride" is not the same as
848	title:prejudice title:pride, and is unlikely to find a result.
849
850	Recoll currently manages the following default fields:
851
852	* title, subject or caption are synonyms which specify data to be
853	searched for in the document title or subject.
854
855	* author or from for searching the documents originators.
856
857	* recipient or to for searching the documents recipients.
858
859	* keyword for searching the document-specified keywords (few documents
860	actually have any).
861
862	* filename for the document's file name.
863
864	* ext specifies the file name extension (Ex: ext:html)
865
866	The field syntax also supports a few field-like, but special, criteria:
867
868	* dir for filtering the results on file location (Ex:
869	dir:/home/me/somedir). Please note that this is quite inefficient,
870	that it may produce very slow searches, and that it may be worth in
871	some cases to set up separate databases instead.
872
873	* date for searching or filtering on dates. The syntax for the argument
874	is based on the ISO8601 standard for dates and time intervals. Only
875	dates are supported, no times. The general syntax is 2 elements
876	separated by a / character. Each element can be a date or a period of
877	time. Periods are specified as PnYnMnD. The n numbers are the
878	respective numbers of years, months or days, any of which may be
879	missing. Dates are specified as YYYY-MM-DD. The days and months parts
880	may be missing. If the / is present but an element is missing, the
881	missing element is interpreted as the lowest or highest date in the
882	index. Exemples:
883
884	* 2001-03-01/2002-05-01 the basic syntax for an interval of dates.
885
886	* 2001-03-01/P1Y2M the same specified with a period.
887
888	* 2001/ from the beginning of 2001 to the latest date in the index.
889
890	* 2001 the whole year of 2001
891
892	* P2D/ means 2 days ago up to now if there are no documents with
893	dates in the future.
894
895	* /2003 all documents from 2003 or older.
896
897	Periods can also be specified with small letters (ie: p2y).
898
899	* mime or format for specifying the mime type. This one is quite special
900	because you can specify several values which will be OR'ed (the normal
901	default for the language is AND). Ex: mime:text/plain mime:text/html.
902	Specifying an explicit boolean operator or negation (-) before a mime
903	specification is not supported and will produce strange results.
904
905	* type or rclcat for specifying the category (as in
906	text/media/presentation/etc.). The classification of mime types in
907	categories is defined in the Recoll configuration (mimeconf), and can
908	be modified or extended. The default category names are those which
909	permit filtering results in the main GUI screen. Categories are OR'ed
910	like mime types above.
911
912	The document filters used while indexing have the possibility to create
913	other fields with arbitrary names, and aliases may be defined in the
914	configuration, so that the exact field search possibilities may be
915	different for you if someone took care of the customisation.
916
917	The query language is currently the only way to use the Recoll field
918	search capability.
919
920	Words inside phrases and capitalized words are not stem-expanded.
921	Wildcards may be used anywhere inside a term. Specifying a wild-card on
922	the left of a term can produce a very slow search (or even an incorrect
923	one if the expansion is truncated because of excessive size).
924
925	You can use the show query link at the top of the result list to check the
926	exact query which was finally executed by Xapian.
927
928	Most Xesam phrase modifiers are unsupported, except for l (small ell) to
929	disable stemming, and p to turn a phrase into a NEAR (unordered) search.
930	Exemple: "prejudice pride"p
931
932	----------------------------------------------------------------------
933
934	3.5. Complex/advanced search	810	3.1.4. Complex/advanced search
935		811
936	The advanced search dialog helps you build more complex queries. It can be	812	The advanced search dialog helps you build more complex queries without
937	opened through the Tools menu or through the main toolbar.	813	memorizing the search language constructs. It can be opened through the
		814	Tools menu or through the main toolbar.
938		815
939	The dialog has three parts:	816	The dialog has three parts:
940		817
941	* The top part allows constructing a query by combining multiple clauses	818	* The top part allows constructing a query by combining multiple clauses
942	of different types. Each entry field is configurable for the following	819	of different types. Each entry field is configurable for the following
	...		...
995	Click on the Show query details link at the top of the result page to see	872	Click on the Show query details link at the top of the result page to see
996	the query expansion.	873	the query expansion.
997		874
998	----------------------------------------------------------------------	875	----------------------------------------------------------------------
999		876
1000	3.6. The term explorer tool	877	3.1.5. The term explorer tool
1001		878
1002	Recoll automatically manages the expansion of search terms to their	879	Recoll automatically manages the expansion of search terms to their
1003	derivatives (ie: plural/singular, verb inflections). But there are other	880	derivatives (ie: plural/singular, verb inflections). But there are other
1004	cases where the exact search term is not known. For example, you may not	881	cases where the exact search term is not known. For example, you may not
1005	remember the exact spelling, or only know the beginning of the name.	882	remember the exact spelling, or only know the beginning of the name.
	...		...
1050	simple search entry field. You can also cut/paste between the result list	927	simple search entry field. You can also cut/paste between the result list
1051	and any entry field (the end of lines will be taken care of).	928	and any entry field (the end of lines will be taken care of).
1052		929
1053	----------------------------------------------------------------------	930	----------------------------------------------------------------------
1054		931
1055	3.7. More about wildcards
1056
1057	All words entered in Recoll search fields will be processed for wildcard
1058	expansion before the request is finally executed.
1059
1060	The wildcard characters are:
1061
1062	* * which matches 0 or more characters.
1063
1064	* ? which matches a single character.
1065
1066	* [] which allow defining sets of characters to be matched (ex: [abc]
1067	matches a single character which may be 'a' or 'b' or 'c', [0-9]
1068	matches any number.
1069
1070	You should be aware of a few things before using wildcards.
1071
1072	* Using a wildcard character at the beginning of a word can make for a
1073	slow search because Recoll will have to scan the whole index term list
1074	to find the matches.
1075
1076	* Using a * at the end of a word can produce more matches than you would
1077	think, and strange search results. You can use the term explorer tool
1078	to check what completions exist for a given term. You can also see
1079	exactly what search was performed by clicking on the link at the top
1080	of the result list. In general, for natural language terms, stem
1081	expansion will produce better results than an ending * (stem expansion
1082	is turned off when any wildcard character appears in the term).
1083
1084	----------------------------------------------------------------------
1085
1086	3.8. Multiple databases	932	3.1.6. Multiple databases
1087		933
1088	Multiple Recoll databases or indexes can be created by using several	934	Multiple Recoll databases or indexes can be created by using several
1089	configuration directories which are usually set to index different areas	935	configuration directories which are usually set to index different areas
1090	of the file system. A specific index can be selected for updating or	936	of the file system. A specific index can be selected for updating or
1091	searching, using the RECOLL_CONFDIR environment variable or the -c option	937	searching, using the RECOLL_CONFDIR environment variable or the -c option
	...		...
1126	with the directory filter in advanced search, but multiple indexes will	972	with the directory filter in advanced search, but multiple indexes will
1127	have much better performance and may be worth the trouble.	973	have much better performance and may be worth the trouble.
1128		974
1129	----------------------------------------------------------------------	975	----------------------------------------------------------------------
1130		976
1131	3.9. Document history	977	3.1.7. Document history
1132		978
1133	Documents that you actually view (with the internal preview or an external	979	Documents that you actually view (with the internal preview or an external
1134	tool) are entered into the document history, which is remembered.	980	tool) are entered into the document history, which is remembered.
1135		981
1136	You can display the history list by using the Tools/Doc History menu	982	You can display the history list by using the Tools/Doc History menu
	...		...
1139	You can erase the document history by using the Erase document history	985	You can erase the document history by using the Erase document history
1140	entry in the File menu.	986	entry in the File menu.
1141		987
1142	----------------------------------------------------------------------	988	----------------------------------------------------------------------
1143		989
1144	3.10. Sorting search results and collapsing duplicates	990	3.1.8. Sorting search results and collapsing duplicates
1145		991
1146	The documents in a result list are normally sorted in order of relevance.	992	The documents in a result list are normally sorted in order of relevance.
1147	It is possible to specify different sort parameters by using the Sort	993	It is possible to specify different sort parameters by using the Sort
1148	parameters dialog (located in the Tools menu).	994	parameters dialog (located in the Tools menu).
1149		995
	...		...
1166	not be a duplicate of the text only). Duplicates hiding is controlled by	1012	not be a duplicate of the text only). Duplicates hiding is controlled by
1167	an entry in the Query configuration dialog, and is off by default.	1013	an entry in the Query configuration dialog, and is off by default.
1168		1014
1169	----------------------------------------------------------------------	1015	----------------------------------------------------------------------
1170		1016
1171	3.11. Search tips, shortcuts	1017	3.1.9. Search tips, shortcuts
1172		1018
1173	3.11.1. Terms and search expansion	1019	3.1.9.1. Terms and search expansion
1174		1020
1175	Term completion. Typing Esc Space in the simple search entry field while	1021	Term completion. Typing Esc Space in the simple search entry field while
1176	entering a word will either complete the current word if its beginning	1022	entering a word will either complete the current word if its beginning
1177	matches a unique term in the index, or open a window to propose a list of	1023	matches a unique term in the index, or open a window to propose a list of
1178	completions.	1024	completions.
	...		...
1207	file name search which will only look for file names, and may be faster	1053	file name search which will only look for file names, and may be faster
1208	than the generic search especially when using wildcards.	1054	than the generic search especially when using wildcards.
1209		1055
1210	----------------------------------------------------------------------	1056	----------------------------------------------------------------------
1211		1057
1212	3.11.2. Working with phrases and proximity	1058	3.1.9.2. Working with phrases and proximity
1213		1059
1214	Phrases and Proximity searches. A phrase can be looked for by enclosing it	1060	Phrases and Proximity searches. A phrase can be looked for by enclosing it
1215	in double quotes. Example: "user manual" will look only for occurrences of	1061	in double quotes. Example: "user manual" will look only for occurrences of
1216	user immediately followed by manual. You can use the This phrase field of	1062	user immediately followed by manual. You can use the This phrase field of
1217	the advanced search dialog to the same effect. Phrases can be entered	1063	the advanced search dialog to the same effect. Phrases can be entered
	...		...
1226	documents where either virtual or reality or both appear, but those which	1072	documents where either virtual or reality or both appear, but those which
1227	contain virtual reality should appear sooner in the list.	1073	contain virtual reality should appear sooner in the list.
1228		1074
1229	----------------------------------------------------------------------	1075	----------------------------------------------------------------------
1230		1076
1231	3.11.3. Others	1077	3.1.9.3. Others
1232		1078
1233	Using fields. You can use the query language and field specifications to	1079	Using fields. You can use the query language and field specifications to
1234	only search certain parts of documents. This can be especially helpful	1080	only search certain parts of documents. This can be especially helpful
1235	with email, for example only searching emails from a specific originator:	1081	with email, for example only searching emails from a specific originator:
1236	search tips from:helpfulgui	1082	search tips from:helpfulgui
	...		...
1261		1107
1262	Quitting. Entering ^Q almost anywhere will close the application.	1108	Quitting. Entering ^Q almost anywhere will close the application.
1263		1109
1264	----------------------------------------------------------------------	1110	----------------------------------------------------------------------
1265		1111
1266	3.12. Customizing the search interface	1112	3.1.10. Customizing the search interface
1267		1113
1268	You can customize some aspects of the search interface by using the Query	1114	You can customize some aspects of the search interface by using the Query
1269	configuration entry in the Preferences menu.	1115	configuration entry in the Preferences menu.
1270		1116
1271	There are several tabs in the dialog, dealing with the interface itself,	1117	There are several tabs in the dialog, dealing with the interface itself,
	...		...
1297	involves quite a lot of processing, and can be disabled over the given	1143	involves quite a lot of processing, and can be disabled over the given
1298	text size to speed up loading.	1144	text size to speed up loading.
1299		1145
1300	* Use desktop preferences to choose document editor: if this is checked,	1146	* Use desktop preferences to choose document editor: if this is checked,
1301	the xdg-open utility will be used to open files when you click the	1147	the xdg-open utility will be used to open files when you click the
1302	Edit link in the result list, instead of the application defined in	1148	Open link in the result list, instead of the application defined in
1303	mimeview. xdg-open will in term use your desktop preferences to choose	1149	mimeview. xdg-open will in term use your desktop preferences to choose
1304	an appropriate application.	1150	an appropriate application.
1305		1151
1306	* Choose editor applications this will let you choose the command	1152	* Choose editor applications this will let you choose the command