From 74b82e08374dc3f8ec6b87913c92093d4c662464 Mon Sep 17 00:00:00 2001 From: dockes Date: Wed, 7 May 2008 06:14:14 +0000 Subject: [PATCH] *** empty log message *** --- src/doc/user/usermanual.sgml | 73 +++++++++++++++++++----------------- 1 file changed, 39 insertions(+), 34 deletions(-) diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml index 640dac2a..ba6677d3 100644 --- a/src/doc/user/usermanual.sgml +++ b/src/doc/user/usermanual.sgml @@ -24,7 +24,7 @@ Dockes - $Id: usermanual.sgml,v 1.62 2008-05-05 20:31:24 dockes Exp $ + $Id: usermanual.sgml,v 1.63 2008-05-07 06:14:14 dockes Exp $ This document introduces full text search notions @@ -456,43 +456,45 @@ recoll recollindex program, or by the indexing thread inside the recoll program (use the File menu). Both programs - will use of the RECOLL_CONFDIR + will use the RECOLL_CONFDIR variable or accept a -c - confdir option to specify the - configuration directory to be used. + confdir option to specify a non-default + configuration directory. If the recoll program finds no index - when it starts, it will automatically start indexing (except - if canceled). + when it starts, it will automatically start indexing (except + if canceled). It is best to avoid interrupting the indexing process, as - this may sometimes leave the index in a bad state. This is - not a serious problem, as you then just need to delete - the index files 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. + this may sometimes leave the index in a bad state. This is + not a serious problem, as you then just need to delete + the index files 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. Using <command>cron</command> to automate - indexing + indexing The most common way to set up indexing is to have a cron - task execute it every night. For example the following - crontab entry would do it every day at - 3:30AM (supposing recollindex is in your PATH): + task execute it every night. For example the following + crontab entry would do it every day at + 3:30AM (supposing recollindex is in your + PATH): 30 3 * * * recollindex > /tmp/recolltrace 2>&1 The usual command to edit your - crontab is - crontab -e (which will usually start the - vi editor to edit the file). You may have - more sophisticated tools available on your system. + crontab is + crontab -e (which will usually start + the vi editor to edit the file). You may + have more sophisticated tools available on your + system. @@ -548,18 +550,21 @@ fvwm control tool in the menus and use the "Startup programs" tab). By default, the indexing daemon will write its messages to - a file inside the configuration directory (this is controlled by - the daemlogfilename and - daemloglevel configuration parameters). You - may want to change this. Also the log file will only be truncated - when the daemon starts. If the daemon runs permanently, the log - file may grow quite big, depending on the log level. + a file inside the configuration directory (this is controlled + by the daemlogfilename + and daemloglevel configuration + parameters). You may want to change this. Also the log file + will only be truncated when the daemon starts. If the daemon + runs permanently, the log file may grow quite big, depending + on the log level. While it is convenient that data is indexed in real time, - repeated indexing can generate a significant load on the system - when files such as email folders change. You probably do not - want to enable it if your system is short on resources. Periodic - indexing is adequate in most cases. + repeated indexing can generate a significant load on the + system when files such as email folders change. Also, + monitoring large file trees by itself significantly taxes + system resources. You probably do not want to enable it if + your system is short on resources. Periodic indexing is + adequate in most cases. @@ -569,8 +574,8 @@ fvwm Searching The recoll program provides the user - interface for searching. It is based on the - QT library. + interface for searching. It is based on the + QT library. recoll has two search modes: