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 2018-04-16 09:24:13 +02:00
parent 9481bc1ab4
commit 0396e2b868
3 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/doc/man/recoll.conf.5
View File

@ -10,10 +10,11 @@ The system-wide configuration file is normally located inside
may be overridden by setting it in the personal configuration file, by default: may be overridden by setting it in the personal configuration file, by default:
.IR $HOME/.recoll/recoll.conf .IR $HOME/.recoll/recoll.conf
.LP .LP
Please note while we try to keep this manual page reasonably up to date, it Please note while I try to keep this manual page reasonably up to date, it
will frequently lag the current state of the software. The best source of will frequently lag the current state of the software. The best source of
information about the configuration are the comments in the system-wide information about the configuration are the comments in the system-wide
configuration file. configuration file or the user manual which you can access from the recoll GUI
help menu or on the recoll web site.
.LP .LP
A short extract of the file might look as follows: A short extract of the file might look as follows:

7
src/doc/user/usermanual.html
View File

@ -1254,7 +1254,7 @@ alink="#0000FF">
"link" href= "link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS"><code class= "#RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS"><code class=
"varname">topdirs</code></a>, which determines what "varname">topdirs</code></a>, which determines what
subtrees get indexed.</p> subtrees and files get indexed.</p>
<p>The applications needed to index file types other than <p>The applications needed to index file types other than
text, HTML or email (ie: pdf, postscript, ms-word...) are text, HTML or email (ie: pdf, postscript, ms-word...) are
described in the <a class="link" href= described in the <a class="link" href=
@ -6555,7 +6555,8 @@ recollindex -c "$confdir"
<dd> <dd>
<p>Fetches the next <code class= <p>Fetches the next <code class=
"literal">Doc</code> object from the current "literal">Doc</code> object from the current
search results.</p> search results. Generates a StopIteration
exception if there are no results left.</p>
</dd> </dd>
<dt><span class= <dt><span class=
"term">Query.close()</span></dt> "term">Query.close()</span></dt>
@ -7845,7 +7846,7 @@ for i in range(nres):
example, a short extract of the main configuration file example, a short extract of the main configuration file
might look as follows:</p> might look as follows:</p>
<pre class="programlisting"> <pre class="programlisting">
# Space-separated list of directories to index. # Space-separated list of files and directories to index.
topdirs = ~/docs /usr/share/doc topdirs = ~/docs /usr/share/doc
[~/somedirectory-with-utf8-txt-files] [~/somedirectory-with-utf8-txt-files]

11
src/doc/user/usermanual.xml
View File

@ -722,7 +722,7 @@
interested in is probably interested in is probably
<link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS"> <link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.TOPDIRS">
<varname>topdirs</varname></link>, <varname>topdirs</varname></link>,
which determines what subtrees get indexed.</para> which determines what subtrees and files get indexed.</para>
<para>The applications needed to index file types other than <para>The applications needed to index file types other than
text, HTML or email (ie: pdf, postscript, ms-word...) are text, HTML or email (ie: pdf, postscript, ms-word...) are
@ -5095,9 +5095,10 @@ recollindex -c "$confdir"
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Query.fetchone()</term> <term>Query.fetchone()</term> <listitem><para>Fetches the
<listitem><para>Fetches the next <literal>Doc</literal> object next <literal>Doc</literal> object from the current
from the current search results.</para></listitem> search results. Generates a StopIteration exception if
there are no results left.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -6117,7 +6118,7 @@ for i in range(nres):
example, a short extract of the main configuration file might example, a short extract of the main configuration file might
look as follows:</para> look as follows:</para>
<programlisting> <programlisting>
# Space-separated list of directories to index. # Space-separated list of files and directories to index.
topdirs = ~/docs /usr/share/doc topdirs = ~/docs /usr/share/doc
[~/somedirectory-with-utf8-txt-files] [~/somedirectory-with-utf8-txt-files]