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 2019-08-07 11:35:25 +02:00
parent ec7fab78c5
commit 14ba0412f5
2 changed files with 77 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -92,11 +92,11 @@ alink="#0000FF">
"#RCL.INDEXING.INTRODUCTION.CONFIG">Configurations, "#RCL.INDEXING.INTRODUCTION.CONFIG">Configurations,
multiple indexes</a></span></dt> multiple indexes</a></span></dt>
<dt><span class="sect2">2.1.3. <a href= <dt><span class="sect2">2.1.3. <a href=
"#idm218">Document types</a></span></dt> "#idm233">Document types</a></span></dt>
<dt><span class="sect2">2.1.4. <a href= <dt><span class="sect2">2.1.4. <a href=
"#idm259">Indexing failures</a></span></dt> "#idm274">Indexing failures</a></span></dt>
<dt><span class="sect2">2.1.5. <a href= <dt><span class="sect2">2.1.5. <a href=
"#idm271">Recovery</a></span></dt> "#idm286">Recovery</a></span></dt>
</dl> </dl>
</dd> </dd>
<dt><span class="sect1">2.2. <a href= <dt><span class="sect1">2.2. <a href=
@ -851,10 +851,10 @@ alink="#0000FF">
</div> </div>
<p><span class="application">Recoll</span> supports <p><span class="application">Recoll</span> supports
defining multiple indexes, each defined by its own defining multiple indexes, each defined by its own
<a class="link" href="#RCL.INDEXING.CONFIG" title= configuration directory. A configuration directory
"2.3.&nbsp;Index configuration">configuration contains <a class="link" href="#RCL.INDEXING.CONFIG"
directory</a>, in which several configuration files title="2.3.&nbsp;Index configuration">several files</a>
describe what should be indexed and how.</p> which describe what should be indexed and how.</p>
<p>When <span class= <p>When <span class=
"command"><strong>recoll</strong></span> or <span class= "command"><strong>recoll</strong></span> or <span class=
"command"><strong>recollindex</strong></span> is first "command"><strong>recollindex</strong></span> is first
@ -864,14 +864,14 @@ alink="#0000FF">
is located in <code class= is located in <code class=
"filename">$HOME/.recoll/</code> for <span class= "filename">$HOME/.recoll/</code> for <span class=
"application">Unix</span>-like systems and <code class= "application">Unix</span>-like systems and <code class=
"filename">%LOCALAPPDATA%</code> on <span class= "filename">%LOCALAPPDATA%\Recoll</code> on <span class=
"application">Windows</span> (typically <code class= "application">Windows</span> (typically <code class=
"filename">C:\Users\[me]\Appdata\Local</code>).</p> "filename">C:\Users\[me]\Appdata\Local\Recoll</code>).</p>
<p>All configuration parameters have defaults, defined in <p>All configuration parameters have defaults, defined in
system-wide files. Without further customisation, the system-wide files. Without further customisation, the
default configuration will process your complete home default configuration will process your complete home
directory, with a reasonable set of defaults. It can be directory, with a reasonable set of defaults. It can be
changed to process a different area of the file system, adjusted to process a different area of the file system,
select files in different ways, and many other select files in different ways, and many other
things.</p> things.</p>
<p>In some cases, it may be useful to create additional <p>In some cases, it may be useful to create additional
@ -879,6 +879,35 @@ alink="#0000FF">
personal and shared indexes, or to take advantage of the personal and shared indexes, or to take advantage of the
organization of your data to improve search organization of your data to improve search
precision.</p> precision.</p>
<p>In order to do this, you would create an empty
directory in a location of your choice, and then instruct
<span class="command"><strong>recoll</strong></span> or
<span class="command"><strong>recollindex</strong></span>
to use it by setting either a command line option
(<code class="literal">-c</code> <em class=
"replaceable"><code>/some/directory</code></em>), or an
environment variable (<code class=
"envar">RECOLL_CONFDIR</code>=<em class=
"replaceable"><code>/some/directory</code></em>). Any
modification performed by the commands (e.g.
configuration customisation or searches by <span class=
"command"><strong>recoll</strong></span> or index
creation by <span class=
"command"><strong>recollindex</strong></span>) would then
apply to the new directory and not to the default
one.</p>
<p>Once multiple indexes are created, you can use each of
them separately by setting the <code class=
"literal">-c</code> option or the <code class=
"envar">RECOLL_CONFDIR</code> environment variable when
starting a command, to select the desired index.</p>
<p>It is also possible to instruct one configuration to
query one or several other indexes in addition to its
own, by using the <span class="guimenuitem">External
index</span> function in the <span class=
"command"><strong>recoll</strong></span> GUI, or some
other functions in the command line and programming
tools.</p>
<p>A plausible usage scenario for the multiple index <p>A plausible usage scenario for the multiple index
feature would be for a system administrator to set up a feature would be for a system administrator to set up a
central index for shared data, that you choose to search central index for shared data, that you choose to search
@ -904,8 +933,8 @@ alink="#0000FF">
<div class="titlepage"> <div class="titlepage">
<div> <div>
<div> <div>
<h3 class="title"><a name="idm218" id= <h3 class="title"><a name="idm233" id=
"idm218"></a>2.1.3.&nbsp;Document types</h3> "idm233"></a>2.1.3.&nbsp;Document types</h3>
</div> </div>
</div> </div>
</div> </div>
@ -1002,8 +1031,8 @@ alink="#0000FF">
<div class="titlepage"> <div class="titlepage">
<div> <div>
<div> <div>
<h3 class="title"><a name="idm259" id= <h3 class="title"><a name="idm274" id=
"idm259"></a>2.1.4.&nbsp;Indexing failures</h3> "idm274"></a>2.1.4.&nbsp;Indexing failures</h3>
</div> </div>
</div> </div>
</div> </div>
@ -1038,8 +1067,8 @@ alink="#0000FF">
<div class="titlepage"> <div class="titlepage">
<div> <div>
<div> <div>
<h3 class="title"><a name="idm271" id= <h3 class="title"><a name="idm286" id=
"idm271"></a>2.1.5.&nbsp;Recovery</h3> "idm286"></a>2.1.5.&nbsp;Recovery</h3>
</div> </div>
</div> </div>
</div> </div>
@ -1390,8 +1419,8 @@ alink="#0000FF">
<div class="titlepage"> <div class="titlepage">
<div> <div>
<div> <div>
<h4 class="title"><a name="idm392" id= <h4 class="title"><a name="idm407" id=
"idm392"></a>In practise: creating and using an "idm407"></a>In practise: creating and using an
additional index</h4> additional index</h4>
</div> </div>
</div> </div>

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

@ -377,22 +377,23 @@
<title>Configurations, multiple indexes</title> <title>Configurations, multiple indexes</title>
<para>&RCL; supports defining multiple indexes, each defined by its <para>&RCL; supports defining multiple indexes, each defined by its
own <link linkend="RCL.INDEXING.CONFIG">configuration directory</link>, own configuration directory. A configuration directory contains
in which several configuration files describe <link linkend="RCL.INDEXING.CONFIG">several files</link> which
what should be indexed and how.</para> describe what should be indexed and how.</para>
<para>When <command>recoll</command> or <para>When <command>recoll</command> or
<command>recollindex</command> is first executed, it creates a <command>recollindex</command> is first executed, it creates a
default configuration directory. This configuration is the one used default configuration directory. This configuration is the one used
for indexing and querying when no specific configuration is for indexing and querying when no specific configuration is
specified. It is located in <filename>$HOME/.recoll/</filename> for specified. It is located in <filename>$HOME/.recoll/</filename> for
&LIN; and <filename>%LOCALAPPDATA%</filename> on &WIN; &LIN; and <filename>%LOCALAPPDATA%\Recoll</filename> on &WIN;
(typically <filename>C:\Users\[me]\Appdata\Local</filename>).</para> (typically
<filename>C:\Users\[me]\Appdata\Local\Recoll</filename>).</para>
<para>All configuration parameters have defaults, defined in <para>All configuration parameters have defaults, defined in
system-wide files. Without further customisation, the default system-wide files. Without further customisation, the default
configuration will process your complete home directory, with a configuration will process your complete home directory, with a
reasonable set of defaults. It can be changed to process a reasonable set of defaults. It can be adjusted to process a
different area of the file system, select files in different ways, different area of the file system, select files in different ways,
and many other things.</para> and many other things.</para>
@ -401,6 +402,29 @@
shared indexes, or to take advantage of the organization of your shared indexes, or to take advantage of the organization of your
data to improve search precision.</para> data to improve search precision.</para>
<para>In order to do this, you would create an empty directory in a
location of your choice, and then instruct
<command>recoll</command> or <command>recollindex</command> to use
it by setting either a command line option (<literal>-c</literal>
<replaceable>/some/directory</replaceable>), or an environment
variable
(<envar>RECOLL_CONFDIR</envar>=<replaceable>/some/directory</replaceable>).
Any modification performed by the commands (e.g. configuration
customisation or searches by <command>recoll</command> or index
creation by <command>recollindex</command>) would then apply to the
new directory and not to the default one.</para>
<para>Once multiple indexes are created, you can use each of them
separately by setting the <literal>-c</literal> option or the
<envar>RECOLL_CONFDIR</envar> environment variable when starting a
command, to select the desired index.</para>
<para>It is also possible to instruct one configuration to
query one or several other indexes in addition to its own, by using
the <guimenuitem>External index</guimenuitem> function in the
<command>recoll</command> GUI, or some other functions in the
command line and programming tools.</para>
<para>A plausible usage scenario for the multiple index feature <para>A plausible usage scenario for the multiple index feature
would be for a system administrator to set up a central index for would be for a system administrator to set up a central index for
shared data, that you choose to search or not in addition to your shared data, that you choose to search or not in addition to your