From 14ba0412f5a3b0292fdd1722cad4c70453b1902d Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Wed, 7 Aug 2019 11:35:25 +0200 Subject: [PATCH] doc --- src/doc/user/usermanual.html | 65 ++++++++++++++++++++++++++---------- src/doc/user/usermanual.xml | 36 ++++++++++++++++---- 2 files changed, 77 insertions(+), 24 deletions(-) diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 60c0cb20..d5222ca8 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -92,11 +92,11 @@ alink="#0000FF"> "#RCL.INDEXING.INTRODUCTION.CONFIG">Configurations, multiple indexes
2.1.3. Document types
+ "#idm233">Document types
2.1.4. Indexing failures
+ "#idm274">Indexing failures
2.1.5. Recovery
+ "#idm286">Recovery
2.2.

Recoll supports defining multiple indexes, each defined by its own - configuration - directory, in which several configuration files - describe what should be indexed and how.

+ configuration directory. A configuration directory + contains several files + which describe what should be indexed and how.

When recoll or recollindex is first @@ -864,14 +864,14 @@ alink="#0000FF"> is located in $HOME/.recoll/ for Unix-like systems and %LOCALAPPDATA% on %LOCALAPPDATA%\Recoll on Windows (typically C:\Users\[me]\Appdata\Local).

+ "filename">C:\Users\[me]\Appdata\Local\Recoll).

All configuration parameters have defaults, defined in system-wide files. Without further customisation, the default configuration will process your complete home 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 things.

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 organization of your data to improve search precision.

+

In order to do this, you would create an empty + directory in a location of your choice, and then instruct + recoll or + recollindex + to use it by setting either a command line option + (-c /some/directory), or an + environment variable (RECOLL_CONFDIR=/some/directory). Any + modification performed by the commands (e.g. + configuration customisation or searches by recoll or index + creation by recollindex) would then + apply to the new directory and not to the default + one.

+

Once multiple indexes are created, you can use each of + them separately by setting the -c option or the RECOLL_CONFDIR environment variable when + starting a command, to select the desired index.

+

It is also possible to instruct one configuration to + query one or several other indexes in addition to its + own, by using the External + index function in the recoll GUI, or some + other functions in the command line and programming + tools.

A plausible usage scenario for the multiple index feature would be for a system administrator to set up a central index for shared data, that you choose to search @@ -904,8 +933,8 @@ alink="#0000FF">

-

2.1.3. Document types

+

2.1.3. Document types

@@ -1002,8 +1031,8 @@ alink="#0000FF">
-

2.1.4. Indexing failures

+

2.1.4. Indexing failures

@@ -1038,8 +1067,8 @@ alink="#0000FF">
-

2.1.5. Recovery

+

2.1.5. Recovery

@@ -1390,8 +1419,8 @@ alink="#0000FF">
-

In practise: creating and using an +

In practise: creating and using an additional index

diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 47f69462..b6bf8624 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -377,22 +377,23 @@ Configurations, multiple indexes &RCL; supports defining multiple indexes, each defined by its - own configuration directory, - in which several configuration files describe - what should be indexed and how. + own configuration directory. A configuration directory contains + several files which + describe what should be indexed and how. When recoll or recollindex is first executed, it creates a default configuration directory. This configuration is the one used for indexing and querying when no specific configuration is specified. It is located in $HOME/.recoll/ for - &LIN; and %LOCALAPPDATA% on &WIN; - (typically C:\Users\[me]\Appdata\Local). + &LIN; and %LOCALAPPDATA%\Recoll on &WIN; + (typically + C:\Users\[me]\Appdata\Local\Recoll). All configuration parameters have defaults, defined in system-wide files. Without further customisation, the default 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, and many other things. @@ -401,6 +402,29 @@ shared indexes, or to take advantage of the organization of your data to improve search precision. + In order to do this, you would create an empty directory in a + location of your choice, and then instruct + recoll or recollindex to use + it by setting either a command line option (-c + /some/directory), or an environment + variable + (RECOLL_CONFDIR=/some/directory). + Any modification performed by the commands (e.g. configuration + customisation or searches by recoll or index + creation by recollindex) would then apply to the + new directory and not to the default one. + + Once multiple indexes are created, you can use each of them + separately by setting the -c option or the + RECOLL_CONFDIR environment variable when starting a + command, to select the desired index. + + It is also possible to instruct one configuration to + query one or several other indexes in addition to its own, by using + the External index function in the + recoll GUI, or some other functions in the + command line and programming tools. + A plausible usage scenario for the multiple index feature 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