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

doc

Browse Source
This commit is contained in:
Jean-Francois Dockes 2011-06-20 13:53:36 +02:00
parent d41561638a
commit e41216aa9d
1 changed files with 102 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -20,7 +20,7 @@
</author>
<copyright>
<year>2005</year>
<year>2005-2011</year>
<holder role="mailto:jfd@recoll.org">Jean-Francois
Dockes</holder>
</copyright>
@ -199,8 +199,8 @@
<para>indexing takes place at discrete
times, by executing the <command>recollindex</command>
command. The typical usage is to have a nightly indexing run
<link linkend="rcl.indexing.periodic.automat">programmed</link> into your
<command>cron</command> file.</para>
<link linkend="rcl.indexing.periodic.automat">programmed</link>
into your <command>cron</command> file.</para>
</formalpara>
</listitem>
@ -227,8 +227,7 @@
<para>&RCL; knows about quite a few different document
types. The parameters for document types recognition and
processing are set in
<link linkend="rcl.indexing.config">configuration files</link>.
</para>
<link linkend="rcl.indexing.config">configuration files</link>.</para>
<para>Most file types, like HTML or word processing files, only hold
one document. Some file types, like mail folder files or zip
@ -236,8 +235,7 @@
in turn be themselves compound ones. Such hierarchies can go quite
deep, and &RCL; has no problem processing, for example, an ms-word
document which would be an attachment to an email message part of
a folder file archived inside a zip file...
</para>
a folder file archived inside a zip file...</para>
<para>&RCL; indexing processes plain text, HTML, openoffice
and e-mail files internally (a few more actually).</para>
@ -428,13 +426,13 @@ recoll
<filename>recoll</filename> will have created a ~/.recoll directory
containing empty configuration files, which you can edit by hand.</para>
<para>The configuration is documented inside the <link
linkend="rcl.install.config">installation chapter</link> of this
document, or in the recoll.conf(5) man page, but the most
<para>The configuration is documented inside the
<link linkend="rcl.install.config">installation chapter</link>
of this document, or in the recoll.conf(5) man page, but the most
current information will most likely be the comments inside the
sample file. The most immediately useful variable you may
interested in is probably <link
linkend="rcl.install.config.recollconf.topdirs">topdirs</link>,
interested in is probably
<link linkend="rcl.install.config.recollconf.topdirs">topdirs</link>,
which determines what subtrees get indexed.</para>
<para>The applications needed to index file types other than
@ -510,7 +508,7 @@ recoll
<title>Periodic indexing</title>
<sect2 id="rcl.indexing.periodic.exec">
<title>Starting indexing</title>
<title>Running indexing</title>
<para>Indexing is performed either by the
<command>recollindex</command> program, or by the
@ -532,8 +530,8 @@ recoll
(<literal>-z</literal>).</para>
</listitem>
<listitem><para>The <command>recollindex</command> command will
not take down your GUI if it crashes (a rare occurrence, but who
knows...)</para>
not take down your GUI if it crashes (a rare occurrence,
but who knows...)</para>
</listitem>
<listitem><para>The <command>recollindex</command> command uses
<command>setpriority/nice</command> to lower its priority while
@ -568,6 +566,23 @@ recoll
<para><command>recollindex</command> has a number of other options
which are described in its man page.</para>
<para>Of special interest maybe are the <literal>-i</literal> and
<literal>-f</literal> options. <literal>-i</literal> allows
indexing an explicit list of files (given as command line
parameters or read on stdin). <literal>-f</literal> tells
<command>recollindex</command> to ignore file selection
parameters from the configuration. Together, these options allow
building a custom file selection process for some area of the
file system, by adding the top directory to the
<literal>skippedPaths</literal> list and using an appropriate
file selection method to build the file list to be fed to
<literal>recollindex&nbsp;-if</literal> .</para>
<para><literal>recollindex&nbsp;-i</literal> will not descend into
directory parameters, but just add them as index entries. It is
up to the external file selection method to build the complete
file list.</para>
</sect2>
<sect2 id="rcl.indexing.periodic.automat">