diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 85405efa..809e63f9 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -423,7 +423,7 @@ alink="#0000FF">

List of Tables

-
3.1. Keyboard shortcuts
+
3.1. Keyboard shortcuts
@@ -1976,6 +1976,25 @@ recollindex -c "$confdir" "application">Recoll then processes, storing the data into a local cache, then indexing it, then removing the file from the queue.

+
+

The local cache is not an archive

+

As mentioned above, a copy of the indexed Web pages is + retained by Recoll in a local cache (from which data is + fetched for previews, or when resetting the index). The + cache is not changed by an index reset, just read for + indexing. The cache has a maximum size, which can be + adjusted from the Index + configuration / Web + history panel (webcachemaxmbs parameter in recoll.conf). Once the maximum size is + reached, old pages are erased to make room for new ones. + The pages which you want to keep indefinitely need to be + explicitly archived elsewhere. Using a very high value + for the cache size can avoid data erasure, but see the + above 'Howto' page for more details and gotchas.

+

The visited Web pages indexing feature can be enabled on the Recoll side from the GUI Index configuration @@ -1989,23 +2008,6 @@ recollindex -c "$confdir" configuration in a Recoll 'Howto' entry.

-
-

The cache is not an archive

-

A copy of the indexed Web pages is retained by Recoll - in a local cache (from which data is fetched for - previews, or when resetting the index). The cache has a - maximum size, which can be adjusted from the Index configuration / Web history panel (webcachemaxmbs parameter in recoll.conf). Once the maximum size is - reached, old pages are erased to make room for new ones. - The pages which you want to keep indefinitely need to be - explicitly archived elsewhere. Using a very high value - for the cache size can avoid data erasure, but see the - above 'Howto' page for more details and gotchas.

-
@@ -2357,10 +2359,11 @@ metadatacmds = ; The GUI File menu has entries to start or stop the current indexing operation. When indexing is not currently running, you have a choice - of updating the index or rebuilding it (the first choice - only processes changed files, the second one zeroes the - index before starting so that all files are - processed).

+ between Update Index or + Rebuild Index. The first + choice only processes changed files, the second one + erases the index before starting so that all files are + processed.

On Linux and Windows, the GUI can be used to manage the indexing operation. Stopping the indexer can be done from the In this situation, the recoll GUI File menu makes two operations available: - 'Stop' and 'Trigger incremental pass'.

+ Stop and Trigger incremental pass.

+

Trigger incremental + pass has the same effect as restarting the indexer, + and will cause a complete walk of the indexed area, + processing the changed files, then switch to monitoring. + This is only marginally useful, maybe in cases where the + indexer is configured to delay updates, or to force an + immediate rebuild of the stemming and phonetic data, which + are only processed at intervals by the real time + indexer.

While it is convenient that data is indexed in real time, repeated indexing can generate a significant load on the system when files such as email folders change. Also, @@ -3987,7 +4000,7 @@ fs.inotify.max_user_watches=32768 given context (e.g. within a preview window, within the result table).

- +

Table 3.1. Keyboard shortcuts

diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 9526a320..aad9cb27 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -1277,31 +1277,34 @@ recollindex -c "$confdir" local cache, then indexing it, then removing the file from the queue. + The local cache is not an archiveAs + mentioned above, a copy of the indexed Web pages is retained by + Recoll in a local cache (from which data is fetched for previews, + or when resetting the index). The cache is not changed by an + index reset, just read for indexing. The cache has a maximum + size, which can be adjusted from the Index + configuration / Web history panel + (webcachemaxmbs parameter + in recoll.conf). Once the maximum size is + reached, old pages are erased to make room for new ones. The + pages which you want to keep indefinitely need to be explicitly + archived elsewhere. Using a very high value for the cache size + can avoid data erasure, but see the above 'Howto' page for more + details and gotchas. + The visited Web pages indexing feature can be enabled on the &RCL; side from the GUI Index configuration panel, or by editing the configuration file (set processwebqueue to 1). The &RCL; GUI has a tool to list and edit the contents of the - Web - cache. (ToolsWebcache + Web cache. (ToolsWebcache editor) You can find more details on Web indexing, its usage and configuration - in a Recoll 'Howto' entry. + in a Recoll 'Howto' + entry. - The cache is not an archiveA copy of - the indexed Web pages is retained by Recoll in a local cache - (from which data is fetched for previews, or when resetting the - index). The cache has a maximum size, which can be adjusted from - the Index configuration / Web - history panel (webcachemaxmbs - parameter in recoll.conf). Once the maximum - size is reached, old pages are erased to make room for new ones. - The pages which you want to keep indefinitely need to be - explicitly archived elsewhere. Using a very high value for - the cache size can avoid data erasure, but see the above 'Howto' - page for more details and gotchas. @@ -1576,9 +1579,11 @@ metadatacmds = ; tags = tmsu tags %f The GUI File menu has entries to start or stop the current indexing operation. When indexing is not currently running, you have a - choice of updating the index or rebuilding it (the first choice - only processes changed files, the second one zeroes the index - before starting so that all files are processed). + choice between Update + Index or Rebuild Index. + The first choice only processes changed files, the second one + erases the index before starting so that all files are + processed. On Linux and Windows, the GUI can be used to manage the indexing operation. Stopping the indexer can be done @@ -1721,11 +1726,20 @@ metadatacmds = ; tags = tmsu tags %f from the terminal and become a daemon, permanently monitoring file changes and updating the index. - In this situation, the recoll GUI - File menu - makes two operations available: 'Stop' and 'Trigger incremental pass'. + In this situation, the recoll + GUI File menu makes two + operations available: Stop + and Trigger incremental pass. + Trigger incremental pass has the + same effect as restarting the indexer, and will cause a complete + walk of the indexed area, processing the changed files, then switch + to monitoring. This is only marginally useful, maybe in cases where + the indexer is configured to delay updates, or to force an + immediate rebuild of the stemming and phonetic data, which are only + processed at intervals by the real time indexer. + While it is convenient that data is indexed in real time, repeated indexing can generate a significant load on the system when files such as email folders change. Also,