Switch to side-by-side view

--- a/src/README
+++ b/src/README
@@ -45,35 +45,39 @@
 
                 3.1. Simple search
 
-                3.2. Complex/advanced search
-
-                3.3. Multiple databases
-
-                3.4. Document history
-
-                3.5. Result list sorting
-
-                3.6. Additional result list functionality
-
-                3.7. Search tips, shortcuts
-
-                3.8. Customising the search interface
+                3.2. The result list
+
+                             3.2.1. The result list right-click menu
+
+                3.3. The preview window
+
+                3.4. Complex/advanced search
+
+                3.5. Multiple databases
+
+                3.6. Document history
+
+                3.7. Sorting search results
+
+                3.8. Search tips, shortcuts
+
+                3.9. Customising the search interface
 
    4. Installation
 
-                4.1. Building from source
-
-                             4.1.1. Prerequisites
-
-                             4.1.2. Building
-
-                             4.1.3. Installation
-
-                4.2. Installing a prebuilt copy
-
-                             4.2.1. Installing through a package system
-
-                             4.2.2. Installing a prebuilt Recoll
+                4.1. Installing a prebuilt copy
+
+                             4.1.1. Installing through a package system
+
+                             4.1.2. Installing a prebuilt Recoll
+
+                4.2. Building from source
+
+                             4.2.1. Prerequisites
+
+                             4.2.2. Building
+
+                             4.2.3. Installation
 
                 4.3. Packages needed for external file types
 
@@ -93,14 +97,15 @@
 
    If you do not like reading manuals (who does?) and would like to give
    Recoll a try, just perform installation and start the recoll user
-   interface, which will index your home directory and let you search it
-   right after.
-
-   Do not do this if your home has a huge number of documents and you do not
-   want to wait or are very short on disk space. In this case, you may want
-   to edit the configuration file first to restrict the indexed area.
-
-   Also be aware that you will need to install the appropriate supporting
+   interface, which will index your home directory by default, allowing you
+   to search immediately after indexing completes.
+
+   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 want to edit the configuration file first to restrict the indexed
+   area.
+
+   Also be aware that you may need to install the appropriate supporting
    applications for document types that need them (for example antiword for
    ms-word files).
 
@@ -117,15 +122,15 @@
 
    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 those terms are prominent.
-
-   This mode of operation has been made very familiar by internet search
-   engines.
-
-   The notion of relevance is a difficult one, as only you, the user,
-   actually know which documents are relevant to your search, and the
-   application can only try a guess. The quality of this guess is probably
-   the most important element for a search application.
+   will return a list of documents where those terms are prominent, in a
+   similar way to internet search engines.
+
+   Recoll tries to determine which documents are most relevant to the search
+   terms you provide. Computer algorithms for determining relevance can be
+   very complex, and in general are inferior to the power of the human mind
+   to rapidly determine relevance. The quality of relevance guessing by the
+   search tool is probably the most important element for a search
+   application.
 
    In many cases, you are looking for all the forms of a word, not for a
    specific form or spelling. These different forms may include plurals,
@@ -134,8 +139,8 @@
    expand queries to all such related terms (words that reduce to the same
    stem). This expansion can be disabled at search time.
 
-   Stemming, by itself, does not provide for misspellings or phonetic
-   searches. Recoll currently does not support these.
+   Stemming, by itself, does not accomodate for misspellings or phonetic
+   searches. Recoll currently does not support these features.
 
      ----------------------------------------------------------------------
 
@@ -202,12 +207,12 @@
    have a nightly indexing run programmed into your cron file.
 
    +------------------------------------------------------------------------+
-   | Side note: there is nothing in Recoll and Xapian that would prevent    |
-   | interfacing with a real time file modification monitor, but this would |
-   | tend to consume significant system resources for dubious gain, because |
-   | you rarely need a full text search to find documents you just          |
-   | modified. recollindex -i can be used to add individual files to the    |
-   | index if you want to play with this, see the manual page.              |
+   | There is nothing in Recoll and Xapian that would prevent interfacing   |
+   | with a real time file modification monitor, but this would tend to     |
+   | consume significant system resources for dubious gain, because you     |
+   | rarely need a full text search to find documents you just modified.    |
+   | recollindex -i can be used to add individual files to the index if you |
+   | want to play with this, see the manual page.                           |
    +------------------------------------------------------------------------+
 
    Recoll knows about quite a few different document types. The parameters
@@ -222,6 +227,14 @@
 
    Without further configuration, Recoll will index all appropriate files
    from your home directory, with a reasonable set of defaults.
+
+   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 directories, each indexing a file system area to a specific
+   database. You would use the RECOLL_CONFDIR environment variable or the -c
+   confdir option to recollindex to indicate which configuration to process.
+   The recoll search program can use any selection of the existing databases
+   for each search, this is configurable inside the user interface.
 
      ----------------------------------------------------------------------
 
@@ -244,8 +257,8 @@
    means that it will be quite typical nowadays (2006), that even a big index
    will be negligible against the total amount of data on the computer.
 
-   The index data directory only contains data that will be rebuilt by an
-   index run, so that it can be destroyed safely.
+   The index data directory (xapiandb) only contains data that will be
+   rebuilt by an index run, and it can always be destroyed safely.
 
      ----------------------------------------------------------------------
 
@@ -257,12 +270,13 @@
    restricted.
 
    As of version 1.4, Recoll will create the configuration directory with a
-   mode of 0700 (access by owner only). As the index directory is by default
-   a subdirectory of the configuration directory, this should result in
-   appropriate protection.
+   mode of 0700 (access by owner only). As the index data directory is by
+   default a subdirectory of the configuration directory, this should result
+   in appropriate protection.
 
    If you use another setup, you should think of the kind of protection you
-   need for your index, and set the directory access modes appropriately.
+   need for your index, and set the directory and files access modes
+   appropriately.
 
      ----------------------------------------------------------------------
 
@@ -282,23 +296,28 @@
    The configuration is also documented inside the installation chapter of
    this document, or in the recoll.conf(5) man page.
 
+   The applications needed to index file types other than text, html or email
+   (ie: pdf, postscript, ms-word...) are described in the external packages
+   section
+
      ----------------------------------------------------------------------
 
 2.4. Starting indexing
 
    Indexing is performed either by the recollindex program, or by the
-   indexing thread inside the recoll program (use the File menu).
+   indexing thread inside the recoll program (use the File menu). Both
+   programs will use of the RECOLL_CONFDIR variable or accept a -c confdir
+   option to specify the configuration directory to be used.
 
    If the recoll program finds no index when it starts, it will automatically
    start indexing (except if cancelled).
 
    It is best to avoid interrupting the indexing process, as this may
-   sometimes leave the database in a bad state. This is not a serious
-   problem, as you then just need to clear everything and restart the
-   indexing: the index files are normally stored in the
-   $HOME/.recoll/xapiandb directory, which you can just delete if needed.
-   Alternatively, you can start recollindex -z, which will reset the database
-   before indexing.
+   sometimes leave the index in a bad state. This is not a serious problem,
+   as you then just need to clear everything and restart the indexing: the
+   index files are normally stored in the $HOME/.recoll/xapiandb directory,
+   which you can just delete if needed. Alternatively, you can start
+   recollindex with option -z, which will reset the database before indexing.
 
      ----------------------------------------------------------------------
 
@@ -339,22 +358,44 @@
    be returned. File name will specifically look for file names, and allows
    using wildcards (*, ? , []).
 
+   You can search for exact phrases (adjacent words in a given order) by
+   enclosing the input inside double quotes. Ex: "virtual reality".
+
+   Character case has no influence on search, except that you can disable
+   stem expansion for any term by capitalizing it. Ie: a search for floor
+   will also normally look for flooring, floored, etc., but a search for
+   Floor will only look for floor, in any character case (stemming can also
+   be disabled globally in the preferences).
+
    Recoll 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/filename).
 
+   Hitting ^Tab (Ctrl + Tab) 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.
+
+   Double-clicking on a word in the result list or a preview window will
+   insert it into the simple search entry field.
+
    You can use the Tools / Advanced search dialog for more complex searches.
 
+     ----------------------------------------------------------------------
+
+3.2. The result list
+
    After starting a search, a list of results will instantly be displayed in
-   the main list window. Clicking on the Preview link for an entry will open
-   an internal preview window for the document. Clicking the Edit link will
-   attempt to start an external viewer (have a look at the mimeconf
-   configuration file to see how these are configured).
+   the main list window.
 
    By default, the document list is presented in order of relevance (how well
    the system estimates that the document matches the query). You can specify
    a different ordering by using the Tools / Sort parameters dialog.
+
+   Clicking on the Preview link for an entry will open an internal preview
+   window for the document. Clicking the Edit link will attempt to start an
+   external viewer (have a look at the mimeconf configuration file to see how
+   these are configured).
 
    The Preview and Edit edit links may not be present for all entries,
    meaning that Recoll has no configured way to preview a given file type
@@ -366,53 +407,152 @@
    see the query actually performed, after stem expansion and other
    processing.
 
-     ----------------------------------------------------------------------
-
-3.2. Complex/advanced search
+   Double-clicking on any word inside the result list or a preview window
+   will insert it into the simple search text.
+
+   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.
+
+     ----------------------------------------------------------------------
+
+  3.2.1. The result list right-click menu
+
+   Apart from the preview and edit links, you can display a popup menu by
+   right-clicking over a paragraph in the result list. This menu has the
+   following entries:
+
+     * Preview
+
+     * Edit
+
+     * Copy File Name
+
+     * Copy Url
+
+     * Find similar
+
+   The Preview and Edit entries do the same thing as the corresponding links.
+   The two following entries will copy either an url or the file path to the
+   clipboard, for pasting into another application.
+
+   The Find similar entry will select a number of relevant term from the
+   current document and enter them into the simple search field. You can then
+   start a simple search, with a good chance of finding documents related to
+   the current result.
+
+     ----------------------------------------------------------------------
+
+3.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
+   existing window.
+
+   Starting another search and requesting a preview will create a new preview
+   window. The old one stays open until you close it.
+
+   You can close a preview tab by typing ^W (Ctrl + W) in the window. Closing
+   the last tab for a window will also close the window.
+
+   Of course you can also close a preview window by using the window manager
+   button in the top of the frame.
+
+   You can display successive or previous documents from the result list
+   inside a preview tab by typing Ctrl+Down or Ctrl+Up (Down and Up are the
+   arrow keys).
+
+   The preview tabs have an internal incremental search function. You
+   initiate the search either by typing a / (slash) inside the text area or
+   by clicking into the Search for: text field and entering the search
+   string. You can then use the Next and Previous buttons to find the
+   next/previous occurence. You can also type F3 inside the text area to get
+   to the next occurrence.
+
+   If you have a search string entered and you use ^Up/^Down to browse the
+   results, the search is initiated for each successive document. If the
+   string is found, the cursor will be positionned at the first occurrence of
+   the search string.
+
+     ----------------------------------------------------------------------
+
+3.4. Complex/advanced search
 
    The advanced search dialog has fields that will allow a more refined
-   search, looking for documents with all given words, a given exact phrase,
-   none of the given words, or a given file name (with wildcard expansion).
-   All relevant fields will be combined by an implicit AND clause.
-
-   It will let you search for documents of specific mime types (ie: only
-   text/plain, or text/html or application/pdf etc...)
-
-   It will let you restrict the search results to a subtree of the indexed
-   area.
-
-   Click on the Start Search button in the advanced search dialog to start
-   the search. The button in the main window always performs a simple search.
+   search, looking for documents with all given elements, a given exact
+   phrase, none of the given elements, or a given file name (with wildcard
+   expansion). All relevant fields will be combined by an implicit AND
+   clause. All fields except "Exact phrase" can accept a mix of single words
+   and phrases enclosed in double quotes.
+
+   Advanced search will let you search for documents of specific mime types
+   (ie: only text/plain, or text/html or application/pdf etc...). The state
+   of the file type selection can be saved as the default (the file type
+   filter will not be activated at program startup, but the lists will be in
+   the restored state).
+
+   You can also restrict the search results to a subtree of the indexed area.
+   If you need to do this often, you may think of setting up multiple indexes
+   instead, as the performance will be much better.
+
+   Click on the Start Search button in the advanced search dialog, or type
+   Enter in any text field to start the search. The button in the main window
+   always performs a simple search.
 
    Click on the Show query details link at the top of the result page to see
    the query expansion.
 
      ----------------------------------------------------------------------
 
-3.3. Multiple databases
-
-   Your Recoll configuration always defines a main index. This is what gets
-   updated, for example, when you execute recollindex.
-
-   You can use the search configuration tool to define additional databases
-   to be searched. These databases can be made active or inactive at any
-   moment.
-
-   The typical use of this feature is for a system administrator to set up a
-   central index, that you may choose to search, or not, in addition to your
-   personal data. Of course, there are other possibilities.
-
-   The main index (defined by your personal configuration) is always active.
-
-   The list of searchable databases may also be defined by the
-   RECOLL_EXTRA_DBS environment variable. This should hold a colon-separated
-   list of index directories, ie:
+3.5. 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
+   to recoll and recollindex.
+
+   A recollindex program instance can only update one specific index.
+
+   A recoll program instance is also associated with a specific index, which
+   is the one to be updated by its indexing thread, but it can use any number
+   of Recoll indexes for searching. The external indexes can be selected
+   through the external indexes tab in the preferences dialog.
+
+   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. Of course, these parameters are retained across program
+   executions (there are kept separately for each Recoll configuration). The
+   set of all indexes is usually quite stable, while the active ones might
+   typically be adjusted quite frequently.
+
+   The main index (defined by RECOLL_CONFDIR) is always active. If this is
+   undesirable, you can set up your base configuration to index an empty
+   directory.
+
+   As building the set of all indexes can be a little tedious when done
+   through the user interface, you can use the RECOLL_EXTRA_DBS environment
+   variable to provide an initial set. This might typically be set up by a
+   system administrator so that every user does not have to do it. The
+   variable should define a colon-separated list of index directories, ie:
 
  export RECOLL_EXTRA_DBS=/some/place/xapiandb:/some/other/db
 
-     ----------------------------------------------------------------------
-
-3.4. Document history
+   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
+   may choose to search, or not, in addition to your personal data. Of
+   course, there are other possibilities. There are many cases where you know
+   the subset of files that you want to be searched for a given query, and
+   where restricting the query will much improve the precision of the
+   results. This can also be performed with the directory filter in advanced
+   search, but multiple indexes will have much better performance and may be
+   worth the trouble.
+
+     ----------------------------------------------------------------------
+
+3.6. 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
@@ -420,7 +560,7 @@
 
      ----------------------------------------------------------------------
 
-3.5. Result list sorting
+3.7. Sorting search results
 
    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
@@ -436,34 +576,7 @@
 
      ----------------------------------------------------------------------
 
-3.6. Additional result list functionality
-
-   Apart from the preview and edit links, you can display a popup menu by
-   right-clicking over a paragraph in the result list. This menu has the
-   following entries:
-
-     * Preview
-
-     * Edit
-
-     * Copy File Name
-
-     * Copy Url
-
-     * More like this
-
-   The Preview and Edit entries do the same thing as the corresponding links.
-   The two following entries will copy either an url or the file path to the
-   clipboard, for pasting into another application.
-
-   The More like this entry will select a number of relevant term from the
-   current document and enter them into the simple search field. You can then
-   start a simple search, with a good chance of finding documents related to
-   the current result.
-
-     ----------------------------------------------------------------------
-
-3.7. Search tips, shortcuts
+3.8. Search tips, shortcuts
 
    Disabling stem expansion. Entering a capitalized word in any search field
    will prevent stem expansion (no search for gardening if you enter Garden
@@ -473,9 +586,18 @@
    Phrases. 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 exact phrase field of the
-   advanced search dialog to the same effect.
-
-   Term completion. Typing ^TAB (Control+Tab) in the simple search entry
+   advanced search dialog to the same effect. Phrases can be entered along
+   simple terms in all search entry fields (except This exact phrase).
+
+   AutoPhrases. 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 Any terms. This will not change radically the results,
+   but will give a relevance boost to the results where the search terms
+   appear as a phrase. Ie: searching for virtual reality will still find all
+   documents where either virtual or reality or both appear, but those which
+   contain virtual reality should appear sooner in the list.
+
+   Term completion. Typing ^TAB (Control + Tab) 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
@@ -484,11 +606,11 @@
    on a word in the result list or in a preview window will copy it to the
    simple search entry field.
 
-   Finding related documents. Selecting the More like this entry in the
-   result list paragraph right-click menu will select a set of "interesting"
-   terms from the current result, and insert them into the simple search
-   entry field. You can then possibly edit the list and start a search to
-   find documents which may be apparented to the current result.
+   Finding related documents. Selecting the Find similar documents entry in
+   the result list paragraph right-click menu will select a set of
+   "interesting" terms from the current result, and insert them into the
+   simple search entry field. You can then possibly edit the list and start a
+   search to find documents which may be apparented to the current result.
 
    Query explanation. You can get an exact description of what the query
    looked for, including stem expansion, and boolean operators used, by
@@ -497,18 +619,24 @@
    File names. File names are added as terms during indexing, and you can
    specify them as ordinary terms in normal search fields (Recoll used to
    index all directories in the file path as terms. This has been abandonned
-   as it did not seem really useful). Alternatively, you can use specific
+   as it did not seem really useful). Alternatively, you can use the specific
    file name search which will only look for file names and can use wildcard
    expansion.
 
    Quitting. Entering ^Q almost anywhere will close the application.
 
-   Closing previews. Entering ^W in a preview tab will close it (and, for the
-   last tab, close the preview window).
-
-     ----------------------------------------------------------------------
-
-3.8. Customising the search interface
+   Closing previews. Entering Esc will close the preview window and all its
+   tabs. Entering ^W in a tab will close it (and, for the last tab, close the
+   preview window).
+
+   List browsing in preview. Entering ^Down or ^Up (Ctrl + an arrow key) in a
+   preview window will display the next or the previous document from the
+   result list. Any secondary search currently active will be executed on the
+   new document.
+
+     ----------------------------------------------------------------------
+
+3.9. Customising the search interface
 
    It is possible to customise some aspects of the search interface by using
    Query configuration entry in the Preferences menu.
@@ -559,15 +687,19 @@
        and display an abstract in place of an explicit abstract found within
        the document itself.
 
-   Extra databases:
-
-   This panel will let you browse for additional databases that you may want
-   to search. Extra databases are designated by their database directory (ie:
-   /home/someothergui/.recoll/xapiandb, /usr/local/recollglobal/xapiandb).
-
-   Once entered, the databases will appear in the All extra databases list,
-   and you can chose which ones you want to use at any moment by tranferring
-   them to/from the Active extra databases list.
+     * Synthetic abstract size: adjust to taste...
+
+     * Synthetic abstract context words: how many words should be displayed
+       around each term occurrence.
+
+   External indexes: This panel will let you browse for additional indexes
+   that you may want to search. External indexes are designated by their
+   database directory (ie: /home/someothergui/.recoll/xapiandb,
+   /usr/local/recollglobal/xapiandb).
+
+   Once entered, the indexes will appear in the All indexes list, and you can
+   chose which ones you want to use at any moment by tranferring them to/from
+   the Active indexes list.
 
    Your main database (the one the current configuration indexes to), is
    always implicitely active. If this is not desirable, you can set up your
@@ -577,9 +709,44 @@
 
                             Chapter 4. Installation
 
-4.1. Building from source
-
-  4.1.1. Prerequisites
+4.1. Installing a prebuilt copy
+
+   Recoll binary installations are always linked statically to the xapian
+   libraries, and have no other dependencies. You will only have to check or
+   install supporting applications for the file types that you want to index
+   beyond text, html and mail files.
+
+     ----------------------------------------------------------------------
+
+  4.1.1. Installing through a package system
+
+   If you use a BSD-type port system or a prebuilt package (RPM or other),
+   just follow the usual procedure, and maybe have a look at the
+   configuration section (but this may not be necessary for a quick test with
+   default parameters).
+
+     ----------------------------------------------------------------------
+
+  4.1.2. Installing a prebuilt Recoll
+
+   The unpackaged binary versions are just compressed tar files of a build
+   tree, where only the useful parts were kept (executables and sample
+   configuration).
+
+   The executable binary files are built with a static link to libxapian and
+   libiconv, to make installation easier (no dependencies). However, this
+   also means that you cannot change the versions which are used.
+
+   After extracting the tar file, you can proceed with installation as if you
+   had built the package from source.
+
+   The binary trees are built for installation to /usr/local.
+
+     ----------------------------------------------------------------------
+
+4.2. Building from source
+
+  4.2.1. Prerequisites
 
    At the very least, you will need to download and install the xapian core
    package (Recoll development currently uses version 0.9.5), and the qt
@@ -596,7 +763,7 @@
 
      ----------------------------------------------------------------------
 
-  4.1.2. Building
+  4.2.2. Building
 
    Recoll has been built on Linux (redhat7.3, mandriva 2005, Fedora Core 3),
    FreeBSD and Solaris 8. If you build on another system, I would very much
@@ -636,38 +803,18 @@
 
      ----------------------------------------------------------------------
 
-  4.1.3. Installation
+  4.2.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.
 
+   If the installation prefix given to recollinstall is different from what
+   was specified when executing configure, you will have to set the
+   RECOLL_DATADIR environment variable to indicate where the shared data is
+   to be found.
+
    You can then proceed to configuration.
-
-     ----------------------------------------------------------------------
-
-4.2. Installing a prebuilt copy
-
-  4.2.1. Installing through a package system
-
-   If you are lucky enough to be using a port system or a prebuilt package
-   (RPM or other), just follow the usual procedure, and have a look at the
-   configuration section.
-
-     ----------------------------------------------------------------------
-
-  4.2.2. Installing a prebuilt Recoll
-
-   The unpackaged binary versions are just compressed tar files of a build
-   tree, where only the useful parts were kept (executables and sample
-   configuration).
-
-   The executable binary files are built with a static link to libxapian and
-   libiconv, to make installation easier (no dependencies). However, this
-   also means that you cannot change the versions which are used.
-
-   After extracting the tar file, you can proceed with installation as if you
-   had built the package from source.
 
      ----------------------------------------------------------------------
 
@@ -683,6 +830,8 @@
 
      * MS Word: antiword.
 
+     * MS Excel and PowerPoint: catdoc.
+
      * RTF: unrtf
 
      * dvi: dvips
@@ -701,9 +850,10 @@
 
    There are two sets of configuration files. The system-wide files are kept
    in a directory named like /usr/[local/]share/recoll/examples, they define
-   default values for the system. A parallel set of files exists in the
-   .recoll directory in your home (this can be changed with the
-   RECOLL_CONFDIR environment variable.
+   default values for the system. A parallel set of files exists by default
+   in the .recoll directory in your home. This directory can be changed with
+   the RECOLL_CONFDIR environment variable or the -c option parameter to
+   recoll and recollindex.
 
    If the .recoll directory does not exist when recoll or recollindex are
    started, it will be created with a set of empty configuration files.
@@ -770,6 +920,13 @@
            for directories). The indexer will not follow symbolic links
            inside the indexed trees. If an entry in the topdirs list is a
            symbolic link, indexing will not start and will generate an error.
+
+   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
+           path, it will be interpreted relative to the configuration
+           directory.
 
    skippedNames
 
@@ -818,16 +975,6 @@
            -s, but it will be deleted during the next indexing. Only
            languages listed in the configuration file are permanent.
 
-   iconsdir
-
-           The name of the directory where recoll result list icons are
-           stored. You can change this if you want different images.
-
-   dbdir
-
-           The name of the Xapian data directory. It will be created if
-           needed when the index is initialized.
-
    defaultcharset
 
            The name of the character set used for files that do not contain a
@@ -859,6 +1006,20 @@
            indexing, or for all files inside the selected subtrees,
            independant of mime type.
 
+   idxabsmlen
+
+           Recoll stores an abstract for each indexed file inside the
+           database. This is so that they can be displayed inside the result
+           lists without decoding the original file. This parameter defines
+           the size of the stored abstract (which can come from an actual
+           section or just be the beginning of the text). The default value
+           is 250.
+
+   iconsdir
+
+           The name of the directory where recoll result list icons are
+           stored. You can change this if you want different images.
+
      ----------------------------------------------------------------------
 
   4.4.2. The mimemap file