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 2018-11-08 17:43:16 +01:00
parent af0a389043
commit e1a937f608
4 changed files with 79 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -60,18 +60,19 @@ list. </para></listitem></varlistentry>
list. </para></listitem></varlistentry>
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS">
<term><varname>skippedPaths</varname></term>
<listitem><para>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.</para></listitem></varlistentry>
<listitem><para>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.</para></listitem></varlistentry>
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHSFNMPATHNAME">
<term><varname>skippedPathsFnmPathname</varname></term>
<listitem><para>Set to 0 to
@ -83,14 +84,22 @@ paths. </para></listitem></varlistentry>
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.</para></listitem></varlistentry>
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.ZIPUSESKIPPEDNAMES">
<term><varname>zipUseSkippedNames</varname></term>
<listitem><para>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
</para></listitem></varlistentry>
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.ZIPSKIPPEDNAMES">
<term><varname>zipSkippedNames</varname></term>
<listitem><para>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
</para></listitem></varlistentry>
<varlistentry id="RCL.INSTALL.CONFIG.RECOLLCONF.FOLLOWLINKS">
<term><varname>followLinks</varname></term>

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

@ -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.</p>
<div class="important" style=
"margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Important</h3>
<p>Global parameters <span class="emphasis"><em>must
not</em></span> be defined in a directory subsection,
else they will not be found at all by the <span class=
"application">Recoll</span> code, which looks for them at
the top level (e.g. <code class=
"literal">skippedPaths</code>).</p>
</div>
<p>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.</p>
@ -8165,10 +8175,12 @@ for i in range(nres):
"RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS" id=
"RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHS"></a><span class="term"><code class="varname">skippedPaths</code></span></dt>
<dd>
<p>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
<p>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.</p>
the 'topdirs' variable will override this.</p>
</dd>
<dt><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.SKIPPEDPATHSFNMPATHNAME"
@ -8206,16 +8218,28 @@ for i in range(nres):
skippedPaths.</p>
</dd>
<dt><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.ZIPUSESKIPPEDNAMES"
id=
"RCL.INSTALL.CONFIG.RECOLLCONF.ZIPUSESKIPPEDNAMES"></a><span class="term"><code class="varname">zipUseSkippedNames</code></span></dt>
<dd>
<p>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</p>
</dd>
<dt><a name=
"RCL.INSTALL.CONFIG.RECOLLCONF.ZIPSKIPPEDNAMES" id=
"RCL.INSTALL.CONFIG.RECOLLCONF.ZIPSKIPPEDNAMES"></a><span class="term"><code class="varname">zipSkippedNames</code></span></dt>
<dd>
<p>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</p>
</dd>
<dt><a name=

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

@ -6171,6 +6171,13 @@ for i in range(nres):
redefined, this is specified for each in the next
section. </para>
<important>
<para>Global parameters <emphasis>must not</emphasis> 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. <literal>skippedPaths</literal>).</para>
</important>
<para>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.</para>

26
src/sampleconf/recoll.conf
View File

@ -92,18 +92,20 @@ noContentSuffixes+ =
# <var name="skippedPaths" type="string">
#
# <brief>Paths we should not go into.</brief><descr>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.</descr></var>
# <brief>Absolute paths we should not go into.</brief>
# <descr>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.</descr></var>
skippedPaths = /media
# <var name="skippedPathsFnmPathname" type="bool"><brief>Set to 0 to