tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
dockes 2008-05-07 06:14:14 +00:00
parent 090d2f0b2c
commit 74b82e0837
1 changed files with 39 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
src/doc/user/usermanual.sgml
View File

@ -24,7 +24,7 @@
Dockes</holder> Dockes</holder>
</copyright> </copyright>
<releaseinfo>$Id: usermanual.sgml,v 1.62 2008-05-05 20:31:24 dockes Exp $</releaseinfo> <releaseinfo>$Id: usermanual.sgml,v 1.63 2008-05-07 06:14:14 dockes Exp $</releaseinfo>
<abstract> <abstract>
<para>This document introduces full text search notions <para>This document introduces full text search notions
@ -456,10 +456,10 @@ recoll
<command>recollindex</command> program, or by the <command>recollindex</command> program, or by the
indexing thread inside the <command>recoll</command> indexing thread inside the <command>recoll</command>
program (use the <guimenu>File</guimenu> menu). Both programs program (use the <guimenu>File</guimenu> menu). Both programs
will use of the <literal>RECOLL_CONFDIR</literal> will use the <literal>RECOLL_CONFDIR</literal>
variable or accept a <literal>-c</literal> variable or accept a <literal>-c</literal>
<replaceable>confdir</replaceable> option to specify the <replaceable>confdir</replaceable> option to specify a non-default
configuration directory to be used.</para> configuration directory.</para>
<para>If the <command>recoll</command> program finds no index <para>If the <command>recoll</command> program finds no index
when it starts, it will automatically start indexing (except when it starts, it will automatically start indexing (except
@ -484,15 +484,17 @@ recoll
<para>The most common way to set up indexing is to have a cron <para>The most common way to set up indexing is to have a cron
task execute it every night. For example the following task execute it every night. For example the following
<filename>crontab</filename> entry would do it every day at <filename>crontab</filename> entry would do it every day at
3:30AM (supposing <command>recollindex</command> is in your PATH):</para> 3:30AM (supposing <command>recollindex</command> is in your
PATH):</para>
<programlisting>30 3 * * * recollindex > /tmp/recolltrace 2>&1</programlisting> <programlisting>30 3 * * * recollindex > /tmp/recolltrace 2>&1</programlisting>
<para>The usual command to edit your <para>The usual command to edit your
<filename>crontab</filename> is <filename>crontab</filename> is
<userinput>crontab -e</userinput> (which will usually start the <userinput>crontab -e</userinput> (which will usually start
<command>vi</command> editor to edit the file). You may have the <command>vi</command> editor to edit the file). You may
more sophisticated tools available on your system.</para> have more sophisticated tools available on your
system.</para>
</sect2> </sect2>
</sect1> </sect1>
@ -548,18 +550,21 @@ fvwm
control tool in the menus and use the "Startup programs" tab).</para> control tool in the menus and use the "Startup programs" tab).</para>
<para>By default, the indexing daemon will write its messages to <para>By default, the indexing daemon will write its messages to
a file inside the configuration directory (this is controlled by a file inside the configuration directory (this is controlled
the <literal>daemlogfilename</literal> and by the <literal>daemlogfilename</literal>
<literal>daemloglevel</literal> configuration parameters). You and <literal>daemloglevel</literal> configuration
may want to change this. Also the log file will only be truncated parameters). You may want to change this. Also the log file
when the daemon starts. If the daemon runs permanently, the log will only be truncated when the daemon starts. If the daemon
file may grow quite big, depending on the log level.</para> runs permanently, the log file may grow quite big, depending
on the log level.</para>
<para>While it is convenient that data is indexed in real time, <para>While it is convenient that data is indexed in real time,
repeated indexing can generate a significant load on the system repeated indexing can generate a significant load on the
when files such as email folders change. You probably do not system when files such as email folders change. Also,
want to enable it if your system is short on resources. Periodic monitoring large file trees by itself significantly taxes
indexing is adequate in most cases.</para> system resources. You probably do not want to enable it if
your system is short on resources. Periodic indexing is
adequate in most cases.</para>
</sect1> </sect1>