From 273071823f7102acb2faecc3d8f47d565ab3cf4b Mon Sep 17 00:00:00 2001 From: dockes Date: Tue, 13 Jan 2009 08:49:50 +0000 Subject: [PATCH] update version --- src/doc/user/usermanual.sgml | 74 +++++++++++++++++++++--------------- 1 file changed, 44 insertions(+), 30 deletions(-) diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 05447521..b202533e 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -29,7 +29,7 @@ This document introduces full text search notions and describes the installation and use of the &RCL; - application. It currently describes &RCL; 1.9. + application. It currently describes &RCL; 1.10. @@ -49,16 +49,16 @@ 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. + number of documents and you do not want to wait or are very + short on disk space. In this case, you may first want to customize + the configuration + 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). + appropriate supporting + applications for document types that need them (for + example antiword for ms-word + files). Full text search @@ -140,8 +140,8 @@ &RCL; has many parameters which define exactly what to index, and how to classify and decode the source - documents. These are kept in a configuration file. A + documents. These are kept in configuration files. A default configuration is copied into a standard location (usually something like /usr/[local/]share/recoll/examples) @@ -2411,31 +2411,45 @@ while query.next >= 0 and query.next < nres: 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. + 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. - For other options, &RCL; uses text configuration - files. You will have to edit them by hand for - now (there is still some hope for a GUI configuration tool - in the future). The most accurate documentation for the + &RCL; indexing options are set inside text configuration + files located in a configuration directory. There can be + several such directories, each of which define the parameters + for one index. + + The configuration files can be edited by hand or through + the Indexing configuration dialog + (Preferences menu). The GUI tool will try + to respect your formatting and comments as much as possible, + so it is quite possible to use both ways. + + The most accurate documentation for the configuration parameters is given by comments inside the default files, and we will just give a general overview here. - 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 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. + For each index, there are two sets of configuration + files. System-wide configuration files are kept in a directory named + like /usr/[local/]share/recoll/examples, + and define default values, shared by all indexes. For each + index, a parallel set of files defines the customized + parameters. + + The default location of the configuration is the + .recoll + directory in your home. Most people will only use this + directory. + + This location can be changed, or others can be added 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 + exist when recoll or recollindex are started, it will be created with a set of empty configuration files. recoll will give you a chance to edit the