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 2017-05-10 11:25:39 +02:00
parent 9cae1f2cb3
commit cbd7293833
3 changed files with 71 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/doc/user/recoll.conf.xml
View File

@ -98,16 +98,18 @@ followed.</para></listitem></varlistentry>
<term><varname>indexedmimetypes</varname></term>
<listitem><para>Restrictive list of
indexed mime types. Normally not set (in which case all
supported types are indexed). If it is set,
only the types from the list will have their contents indexed. The names
will be indexed anyway if indexallfilenames is set (default). MIME
type names should be taken from the mimemap file. Can be redefined for
subtrees.</para></listitem></varlistentry>
supported types are indexed). If it is set, only the types from the list
will have their contents indexed. The names will be indexed anyway if
indexallfilenames is set (default). MIME type names should be taken from
the mimemap file (the values may be different from xdg-mime or file -i
output in some cases). Can be redefined for subtrees.</para></listitem></varlistentry>
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.EXCLUDEDMIMETYPES">
<term><varname>excludedmimetypes</varname></term>
<listitem><para>List of excluded MIME
types. Lets you exclude some types from indexing. Can be
redefined for subtrees.</para></listitem></varlistentry>
types. Lets you exclude some types from indexing. MIME type
names should be taken from the mimemap file (the values may be different
from xdg-mime or file -i output in some cases) Can be redefined for
subtrees.</para></listitem></varlistentry>
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.NOMD5MIMETYPES">
<term><varname>nomd5mimetypes</varname></term>
<listitem><para>Don't compute md5 for

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

@ -20,8 +20,8 @@ alink="#0000FF">
<div class="titlepage">
<div>
<div>
<h1 class="title"><a name="idp37843648" id=
"idp37843648"></a>Recoll user manual</h1>
<h1 class="title"><a name="idp37528496" id=
"idp37528496"></a>Recoll user manual</h1>
</div>
<div>
@ -109,13 +109,13 @@ alink="#0000FF">
multiple indexes</a></span></dt>
<dt><span class="sect2">2.1.3. <a href=
"#idp69806816">Document types</a></span></dt>
"#idp43099712">Document types</a></span></dt>
<dt><span class="sect2">2.1.4. <a href=
"#idp69829680">Indexing failures</a></span></dt>
"#idp43124208">Indexing failures</a></span></dt>
<dt><span class="sect2">2.1.5. <a href=
"#idp69836688">Recovery</a></span></dt>
"#idp43131216">Recovery</a></span></dt>
</dl>
</dd>
@ -997,8 +997,8 @@ alink="#0000FF">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="idp69806816" id=
"idp69806816"></a>2.1.3.&nbsp;Document types</h3>
<h3 class="title"><a name="idp43099712" id=
"idp43099712"></a>2.1.3.&nbsp;Document types</h3>
</div>
</div>
</div>
@ -1048,17 +1048,37 @@ alink="#0000FF">
latter case, any type not in the list will be
ignored.</p>
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note about MIME types</h3>
<p>When editing the <code class=
"literal">indexedmimetypes</code> or <code class=
"literal">excludedmimetypes</code> lists, you should
use the MIME values listed in the <code class=
"filename">mimemap</code> file or in Recoll result
lists in preference to <code class="literal">file
-i</code> output: there are a number of differences.
The <code class="literal">file -i</code> output should
only be used for files without extensions, or for which
the extension is not listed in <code class=
"filename">mimemap</code></p>
</div>
<p>Excluding types can be done by adding wildcard name
patterns to the <code class="literal">skippedNames</code>
patterns to the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES">skippedNames</a>
list, which can be done from the GUI Index configuration
menu. For versions 1.20 and later, you can alternatively
set the <code class="literal">excludedmimetypes</code>
set the <a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.EXCLUDEDMIMETYPES">excludedmimetypes</a>
list in the configuration file. This can be redefined for
subdirectories.</p>
<p>You can also define an exclusive list of MIME types to
be indexed (no others will be indexed), by settting the
<code class="literal">indexedmimetypes</code>
<a class="link" href=
"#RCL.INSTALL.CONFIG.RECOLLCONF.INDEXEDMIMETYPES">indexedmimetypes</a>
configuration variable. Example:</p>
<pre class="programlisting">
indexedmimetypes = text/html application/pdf
@ -1085,28 +1105,14 @@ indexedmimetypes = application/pdf
main configuration file (<code class=
"filename">recoll.conf</code>)</a>, or from the GUI index
configuration tool.</p>
<div class="note" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>When editing the <code class=
"literal">indexedmimetypes</code> or <code class=
"literal">excludedmimetypes</code> lists, you should
use the MIME values listed in the <code class=
"filename">mimemap</code> file or in Recoll result
lists in preference to <code class="literal">file
-i</code> output: there are a number of
differences.</p>
</div>
</div>
<div class="sect2">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="idp69829680" id=
"idp69829680"></a>2.1.4.&nbsp;Indexing
<h3 class="title"><a name="idp43124208" id=
"idp43124208"></a>2.1.4.&nbsp;Indexing
failures</h3>
</div>
</div>
@ -1146,8 +1152,8 @@ indexedmimetypes = application/pdf
<div class="titlepage">
<div>
<div>
<h3 class="title"><a name="idp69836688" id=
"idp69836688"></a>2.1.5.&nbsp;Recovery</h3>
<h3 class="title"><a name="idp43131216" id=
"idp43131216"></a>2.1.5.&nbsp;Recovery</h3>
</div>
</div>
</div>
@ -8832,7 +8838,9 @@ thesame = "some string with spaces"
list will have their contents indexed. The names
will be indexed anyway if indexallfilenames is set
(default). MIME type names should be taken from the
mimemap file. Can be redefined for subtrees.</p>
mimemap file (the values may be different from
xdg-mime or file -i output in some cases). Can be
redefined for subtrees.</p>
</dd>
<dt><a name=
@ -8841,8 +8849,10 @@ thesame = "some string with spaces"
<dd>
<p>List of excluded MIME types. Lets you exclude
some types from indexing. Can be redefined for
subtrees.</p>
some types from indexing. MIME type names should be
taken from the mimemap file (the values may be
different from xdg-mime or file -i output in some
cases) Can be redefined for subtrees.</p>
</dd>
<dt><a name=

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

@ -454,17 +454,30 @@
indexed. In the latter case, any type not in the list will
be ignored.</para>
<para>Excluding types can be done by adding wildcard name
patterns to the <literal>skippedNames</literal> list, which
<note><title>Note about MIME types</title>
<para>When editing the <literal>indexedmimetypes</literal>
or <literal>excludedmimetypes</literal> lists, you should use the
MIME values listed in the <filename>mimemap</filename> file
or in Recoll result lists in preference to <literal>file -i</literal>
output: there are a number of differences. The
<literal>file -i</literal> output should only be used for files
without extensions, or for which the extension is not listed in
<filename>mimemap</filename></para></note>
<para>Excluding types can be done by adding wildcard name
patterns to the
<link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDNAMES">
skippedNames</link> list, which
can be done from the GUI Index configuration menu. For
versions 1.20 and later, you can alternatively set the
<literal>excludedmimetypes</literal> list in the
configuration file. This can be redefined for
subdirectories.</para>
<link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.EXCLUDEDMIMETYPES">
excludedmimetypes</link> list in the configuration file. This
can be redefined for subdirectories.</para>
<para>You can also define an exclusive list of MIME types to be indexed (no others will be indexed), by settting
the <literal>indexedmimetypes</literal> configuration
variable. Example:<programlisting>
<para>You can also define an exclusive list of MIME types to be
indexed (no others will be indexed), by settting
the <link linkend="RCL.INSTALL.CONFIG.RECOLLCONF.INDEXEDMIMETYPES">
indexedmimetypes</link> configuration variable. Example:<programlisting>
indexedmimetypes = text/html application/pdf
</programlisting>
It is possible to redefine this parameter for
@ -484,11 +497,6 @@ indexedmimetypes = application/pdf
(<filename>recoll.conf</filename>)</link>, or from the GUI
index configuration tool.</para>
<note><para>When editing the <literal>indexedmimetypes</literal>
or <literal>excludedmimetypes</literal> lists, you should use the
MIME values listed in the <filename>mimemap</filename> file
or in Recoll result lists in preference to <literal>file -i</literal>
output: there are a number of differences.</para></note>
</sect2>