From e1a937f60896fcfd8fc778cc1ffdaaeba2bb8ee5 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Thu, 8 Nov 2018 17:43:16 +0100 Subject: [PATCH] doc --- src/doc/user/recoll.conf.xml | 41 +++++++++++++++++++++-------------- src/doc/user/usermanual.html | 42 ++++++++++++++++++++++++++++-------- src/doc/user/usermanual.xml | 7 ++++++ src/sampleconf/recoll.conf | 26 +++++++++++----------- 4 files changed, 79 insertions(+), 37 deletions(-) diff --git a/src/doc/user/recoll.conf.xml b/src/doc/user/recoll.conf.xml index 7a06f7e7..63ee876a 100644 --- a/src/doc/user/recoll.conf.xml +++ b/src/doc/user/recoll.conf.xml @@ -60,18 +60,19 @@ list. list. skippedPaths -Paths we should not go into. Space-separated list of -wildcard expressions for filesystem paths. Can contain files and -directories. The database and configuration directories will -automatically be added. The expressions are matched using 'fnmatch(3)' -with the FNM_PATHNAME flag set by default. This means that '/' characters -must be matched explicitely. You can set 'skippedPathsFnmPathname' to 0 -to disable the use of FNM_PATHNAME (meaning that '/*/dir3' will match -'/dir1/dir2/dir3'). The default value contains the usual mount point for -removable media to remind you that it is a bad idea to have Recoll work -on these (esp. with the monitor: media gets indexed on mount, all data -gets erased on unmount). Explicitely adding '/media/xxx' to the topdirs -will override this. +Absolute paths we should not go into. Space-separated list of wildcard expressions for absolute +filesystem paths. Must be defined at the top level of the configuration +file, not in a subsection. Can contain files and directories. The database and +configuration directories will automatically be added. The expressions +are matched using 'fnmatch(3)' with the FNM_PATHNAME flag set by +default. This means that '/' characters must be matched explicitely. You +can set 'skippedPathsFnmPathname' to 0 to disable the use of FNM_PATHNAME +(meaning that '/*/dir3' will match '/dir1/dir2/dir3'). The default value +contains the usual mount point for removable media to remind you that it +is a bad idea to have Recoll work on these (esp. with the monitor: media +gets indexed on mount, all data gets erased on unmount). Explicitely +adding '/media/xxx' to the 'topdirs' variable will override +this. skippedPathsFnmPathname Set to 0 to @@ -83,14 +84,22 @@ paths. real time indexing. This enables having parts of the tree which are initially indexed but not monitored. If daemSkippedPaths is not set, the daemon uses skippedPaths. + +zipUseSkippedNames +Use skippedNames inside Zip archives. Fetched +directly by the rclzip handler. Skip the patterns defined by skippedNames +inside Zip archives. Can be redefined for subdirectories. +See https://www.lesbonscomptes.com/recoll/faqsandhowtos/FilteringOutZipArchiveMembers.html + zipSkippedNames Space-separated list of wildcard expressions for names that should be ignored inside zip archives. This is used directly by -the zip handler, and has a function similar to skippedNames, but works -independantly. Can be redefined for subdirectories. Supported by recoll -1.20 and newer. See -https://www.lesbonscomptes.com/recoll/faqsandhowtos/FilteringOutZipArchiveMembers.html +the zip handler. If zipUseSkippedNames is not set, zipSkippedNames +defines the patterns to be skipped inside archives. If zipUseSkippedNames +is set, the two lists are concatenated and used. Can be redefined for +subdirectories. +See https://www.lesbonscomptes.com/recoll/faqsandhowtos/FilteringOutZipArchiveMembers.html followLinks diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index cbcd76e5..31d919a4 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -7919,6 +7919,16 @@ for i in range(nres): directory location upwards. Not all parameters can be meaningfully redefined, this is specified for each in the next section.

+
+

Important

+

Global parameters must + not be defined in a directory subsection, + else they will not be found at all by the Recoll code, which looks for them at + the top level (e.g. skippedPaths).

+

When found at the beginning of a file path, the tilde character (~) is expanded to the name of the user's home directory, as a shell would do.

@@ -8165,10 +8175,12 @@ for i in range(nres): "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS" id= "RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS">skippedPaths
-

Paths we should not go into. Space-separated - list of wildcard expressions for filesystem - paths. Can contain files and directories. The - database and configuration directories will +

Absolute paths we should not go into. + Space-separated list of wildcard expressions for + absolute filesystem paths. Must be defined at the + top level of the configuration file, not in a + subsection. Can contain files and directories. + The database and configuration directories will automatically be added. The expressions are matched using 'fnmatch(3)' with the FNM_PATHNAME flag set by default. This means that '/' @@ -8181,7 +8193,7 @@ for i in range(nres): Recoll work on these (esp. with the monitor: media gets indexed on mount, all data gets erased on unmount). Explicitely adding '/media/xxx' to - the topdirs will override this.

+ the 'topdirs' variable will override this.

zipUseSkippedNames
+
+

Use skippedNames inside Zip archives. Fetched + directly by the rclzip handler. Skip the patterns + defined by skippedNames inside Zip archives. Can + be redefined for subdirectories. See + https://www.lesbonscomptes.com/recoll/faqsandhowtos/FilteringOutZipArchiveMembers.html

+
+
zipSkippedNames

Space-separated list of wildcard expressions for names that should be ignored inside zip archives. This is used directly by the zip - handler, and has a function similar to - skippedNames, but works independantly. Can be - redefined for subdirectories. Supported by recoll - 1.20 and newer. See + handler. If zipUseSkippedNames is not set, + zipSkippedNames defines the patterns to be + skipped inside archives. If zipUseSkippedNames is + set, the two lists are concatenated and used. Can + be redefined for subdirectories. See https://www.lesbonscomptes.com/recoll/faqsandhowtos/FilteringOutZipArchiveMembers.html

+ + Global parameters must not be defined in + a directory subsection, else they will not be found at all by the + &RCL; code, which looks for them at the top level + (e.g. skippedPaths). + + When found at the beginning of a file path, the tilde character (~) is expanded to the name of the user's home directory, as a shell would do. diff --git a/src/sampleconf/recoll.conf b/src/sampleconf/recoll.conf index 64090065..a4627d78 100644 --- a/src/sampleconf/recoll.conf +++ b/src/sampleconf/recoll.conf @@ -92,18 +92,20 @@ noContentSuffixes+ = # # -# Paths we should not go into.Space-separated list of -# wildcard expressions for filesystem paths. Can contain files and -# directories. The database and configuration directories will -# automatically be added. The expressions are matched using 'fnmatch(3)' -# with the FNM_PATHNAME flag set by default. This means that '/' characters -# must be matched explicitely. You can set 'skippedPathsFnmPathname' to 0 -# to disable the use of FNM_PATHNAME (meaning that '/*/dir3' will match -# '/dir1/dir2/dir3'). The default value contains the usual mount point for -# removable media to remind you that it is a bad idea to have Recoll work -# on these (esp. with the monitor: media gets indexed on mount, all data -# gets erased on unmount). Explicitely adding '/media/xxx' to the topdirs -# will override this. +# Absolute paths we should not go into. +# Space-separated list of wildcard expressions for absolute +# filesystem paths. Must be defined at the top level of the configuration +# file, not in a subsection. Can contain files and directories. The database and +# configuration directories will automatically be added. The expressions +# are matched using 'fnmatch(3)' with the FNM_PATHNAME flag set by +# default. This means that '/' characters must be matched explicitely. You +# can set 'skippedPathsFnmPathname' to 0 to disable the use of FNM_PATHNAME +# (meaning that '/*/dir3' will match '/dir1/dir2/dir3'). The default value +# contains the usual mount point for removable media to remind you that it +# is a bad idea to have Recoll work on these (esp. with the monitor: media +# gets indexed on mount, all data gets erased on unmount). Explicitely +# adding '/media/xxx' to the 'topdirs' variable will override +# this. skippedPaths = /media # Set to 0 to