From 40c07f28d23a2726b3626f6baf89b73dd63a1107 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Mon, 23 Nov 2015 11:01:15 +0100 Subject: [PATCH] doc --- src/doc/user/usermanual.xml | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index dc1b18d7..c5675a49 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -2,8 +2,8 @@ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ Recoll"> -http://www.recoll.org/features.html"> - +http://www.recoll.org/features.html"> + Xapian"> ]> @@ -466,7 +466,7 @@ indexedmimetypes = application/pdf may be quite costly (for example failing to uncompress a big file because of insufficient disk space). - The indexer in &RCL; versions 1.21 and later do not + The indexer in &RCL; versions 1.21 and later does not retry failed file by default. Retrying will only occur if an explicit option () is set on the recollindex command line, or if a script @@ -508,11 +508,9 @@ indexedmimetypes = application/pdf option to the &RCL; commands. This method would typically be used to index different areas of the file system to different indexes. For example, if you were to issue the - following commands: - -export RECOLL_CONFDIR=~/.indexes-email -recoll - Then &RCL; would use configuration files + following command: + recoll -c ~/.indexes-email Then + &RCL; would use configuration files stored in ~/.indexes-email/ and, (unless specified otherwise in recoll.conf) would look for @@ -592,11 +590,10 @@ recoll complete reconstruction. If confidential data is indexed, access to the database directory should be restricted. - &RCL; (since version 1.4) will create the configuration - directory with a mode of 0700 (access by owner only). As the - index data directory is by default a sub-directory of the - configuration directory, this should result in appropriate - protection. + &RCL; will create the configuration directory with a mode of + 0700 (access by owner only). As the index data directory is by + default a sub-directory of the configuration directory, this should + result in appropriate protection. If you use another setup, you should think of the kind of protection you need for your index, set the directory @@ -2989,6 +2986,13 @@ text/html [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r synonym group will be optionally expanded into an OR query for all synonyms. + What is it good for ? The synonyms function is probably not going + to help you find your letters to Mr. Smith. It is best used for + domain-specific searches. For example, it was initially suggested by a + user performing searches among historical documents: the synonyms file + would contains nicknames and aliases for each of the persons of + interest. + In practise, synonym groups are defined inside ordinary text files. Each line in the file defines a group. Example: @@ -3018,7 +3022,8 @@ bye goodbye "see you" \ This feature is new in &RCL; 1.22 and will probably need to be refined after some user feedback. - + +