Use structured comments in recoll.conf and use them to generate the docbook and man page texts

2016-05-26 18:20:09 +02:00
parent 3c6a17ba81
commit eef58925d8
6 changed files with 2376 additions and 2267 deletions
@@ -1,4 +1,4 @@
-# <filetitle>Recoll default main configuration file</filetitle>
+# <filetitle>Recoll main configuration file, recoll.conf</filetitle>

 # The XML tags in the comments are used to help produce the documentation
 # from the sample/reference file, and not at all at run time, where
@@ -11,7 +11,8 @@
 # Most of the important values in this file can be set from the GUI
 # configuration menus, which may be an easier approach than direct editing.

-# <grouptitle>Parameters affecting what documents we index</grouptitle>
+# <grouptitle id="WHATDOCS">Parameters affecting what documents we
+# index</grouptitle> 

 # <var name="topdirs" type="string"><brief>Space-separated list of files or
 # directories to recursively index.</brief><descr>Default to ~ (indexes
@@ -19,34 +20,37 @@
 # independantly of the value of the followLinks variable.</descr></var>
 topdirs = ~

-# <var name="skippedNames" type="string"><brief>Wildcard expressions for
-# names of files and directories that we should ignore.</brief>
-# <descr> White space separated list of wildcard patterns (simple
-# ones, not paths, must contain no / ), which will be tested against file
-# and directory names.  The list in the default configuration does not
-# exclude hidden directories (names beginning with a dot), which means that
-# it may index quite a few things that you do not want. On the other hand,
-# email user agents like Thunderbird usually store messages in hidden
-# directories, and you probably want this indexed. One possible solution is
-# to have '.*' in 'skippedNames', and add things like '~/.thunderbird'
-# '~/.evolution' to 'topdirs'.  Not even the file names are indexed for
-# patterns in this list, see the 'noContentSuffixes' variable for an
-# alternative approach which indexes the file names. Can be redefined for
-# any subtree.</descr></var>
+# <var name="skippedNames" type="string">
+#
+# <brief>Files and directories which should be ignored.</brief> <descr>
+# White space separated list of wildcard patterns (simple ones, not paths,
+# must contain no / ), which will be tested against file and directory
+# names.  The list in the default configuration does not exclude hidden
+# directories (names beginning with a dot), which means that it may index
+# quite a few things that you do not want. On the other hand, email user
+# agents like Thunderbird usually store messages in hidden directories, and
+# you probably want this indexed. One possible solution is to have '.*' in
+# 'skippedNames', and add things like '~/.thunderbird' '~/.evolution' to
+# 'topdirs'.  Not even the file names are indexed for patterns in this
+# list, see the 'noContentSuffixes' variable for an alternative approach
+# which indexes the file names. Can be redefined for any
+# subtree.</descr></var>
 skippedNames = #* bin CVS  Cache cache* .cache caughtspam tmp \
     .thumbnails .svn \
     *~ .beagle .git .hg .bzr loop.ps .xsession-errors \
     .recoll* xapiandb recollrc recoll.conf

-# <var name="noContentSuffixes" type="string"><brief>List of name endings (not
-# necessarily dot-separated suffixes) for which we don't try MIME type
-# identification, and don't uncompress or index content.</brief><descr>Only
-# the names will be indexed. This complements the now obsoleted mimemap
-# recoll_noindex list, which will go away in a future release (the move
-# from mimemap to recoll.conf allows editing the list through the
-# GUI). This is different from skippedNames because these are name ending
-# matches only (not wildcard patterns), and the file name itself gets
-# indexed normally. This can be redefined for subdirectories.</descr></var>
+# <var name="noContentSuffixes" type="string">
+#
+# <brief>List of name endings (not necessarily dot-separated suffixes) for
+# which we don't try MIME type identification, and don't uncompress or
+# index content.</brief><descr>Only the names will be indexed. This
+# complements the now obsoleted recoll_noindex list from the mimemap file,
+# which will go away in a future release (the move from mimemap to
+# recoll.conf allows editing the list through the GUI). This is different
+# from skippedNames because these are name ending matches only (not
+# wildcard patterns), and the file name itself gets indexed normally. This
+# can be redefined for subdirectories.</descr></var>
 noContentSuffixes = .md5 .map \
       .o .lib .dll .a .sys .exe .com \
       .mpp .mpt .vsd \
@@ -54,20 +58,20 @@ noContentSuffixes = .md5 .map \
       .dat .bak .rdf .log.gz .log .db .msf .pid \
       ,v ~ #

-# <var name="skippedPaths" type="string"><brief>Space-separated list of
-# wildcard expressions for paths we shouldn't go into.</brief><descr>Can
-# contain files and directories. The database and configuration directories
-# will automatically be added.  The expressions are matched 'fnmatch(3)'
+# <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 contains the usual mount point for
-# removable media by default to remind people that it is a bad idea to
-# naively have recoll work on these (esp. with the monitor: media gets
-# indexed on mount, all data gets erased on unmount). Typically the
-# presence of '/media' is mostly a reminder, it would only have effect for
-# someone who is indexing '/'.  Explicitely adding '/media/xxx' to the
-# topdirs will override this.</descr></var>
+# '/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>
 skippedPaths = /media

 # <var name="skippedPathsFnmPathname" type="bool"><brief>Set to 0 to
@@ -75,19 +79,22 @@ skippedPaths = /media
 # paths.</brief><descr></descr></var> 
 #skippedPathsFnmPathname = 1

-# <var name="daemSkippedPaths"><brief>skippedPaths equivalent specific to
+# <var name="daemSkippedPaths" type="string">
+#
+# <brief>skippedPaths equivalent specific to
 # real time indexing.</brief><descr>This enables having parts of the tree
 # which are initially indexed but not monitored. If daemSkippedPaths is
 # not set, the daemon uses skippedPaths.</descr></var>
 #daemSkippedPaths = 


-# <var name="zipSkippedNames" type="string"><brief>Space-separated list of
-# wildcard expresions for names that should be ignored
-# inside zip archives.</brief><descr>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
+# <var name="zipSkippedNames" type="string">
+#
+# <brief>Space-separated list of wildcard expressions for names that should
+# be ignored inside zip archives.</brief><descr>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://bitbucket.org/medoc/recoll/wiki/Filtering%20out%20Zip%20archive%20members
 # </descr></var>
 #zipSkippedNames =
@@ -119,12 +126,12 @@ skippedPaths = /media
 # files.</brief><descr>We need to decompress these in a
 # temporary directory for identification, which can be wasteful in some
 # cases. Limit the waste. Negative means no limit. 0 results in no
-# processing of any compressed file.</descr></var>
+# processing of any compressed file. Default 50 MB.</descr></var>
 compressedfilemaxkbs = 50000

 # <var name="textfilemaxmbs" type="int"><brief>Size limit for text
 # files.</brief><descr>Mostly for skipping monster
-# logs.</descr></var> 
+# logs. Default 20 MB.</descr></var> 
 textfilemaxmbs = 20

 # <var name="indexallfilenames" type="bool"><brief>Index the file names of
@@ -158,7 +165,8 @@ processwebqueue = 0
 # into documents of approximately this size. Will reduce memory usage at
 # index time and help with loading data in the preview window at query
 # time. Particularly useful with very big files, such as application or
-# system logs.</descr></var>
+# system logs. Also see textfilemaxmbs and
+# compressedfilemaxkbs.</descr></var>
 textfilepagekbs = 1000

 # <var name="membermaxkbs" type="int"><brief>Size limit for archive
@@ -168,7 +176,8 @@ membermaxkbs = 50000



-# <grouptitle>Parameters affecting how we generate terms</grouptitle>
+# <grouptitle id="TERMS">Parameters affecting how we generate
+# terms</grouptitle> 

 # Changing some of these parameters will imply a full
 # reindex. Also, when using multiple indexes, it may not make sense
@@ -201,9 +210,9 @@ indexStripChars = 1
 # restoring the previous behaviour.</descr></var>
 #dehyphenate = 1

-# <var name="nocjk" type="bool"><brief>Decides if specific east asian
+# <var name="nocjk" type="bool"><brief>Decides if specific East Asian
 # (Chinese Korean Japanese) characters/word splitting is turned
-# off.</brief><descr>This will save a small amount of cpu if you have no CJK
+# off.</brief><descr>This will save a small amount of CPU if you have no CJK
 # documents. If your document base does include such text but you are not
 # interested in searching it, setting nocjk may be a
 # significant time and space saver.</descr></var>
@@ -216,10 +225,11 @@ indexStripChars = 1
 # as large.</descr></var>
 #cjkngramlen = 2

-# <var name="indexstemminglanguages" type="string"><brief>Languages for
-# which to create stemming expansion data.</brief><descr>Stemmer names can
-# be found on http://www.xapian.org, or by executing 'recollindex -l', or
-# this can also be set from a list in the GUI</descr></var>
+# <var name="indexstemminglanguages" type="string">
+#
+# <brief>Languages for which to create stemming expansion
+# data.</brief><descr>Stemmer names can be found by executing 'recollindex
+# -l', or this can also be set from a list in the GUI.</descr></var>
 indexstemminglanguages = english 

 # <var name="defaultcharset" type="string"><brief>Default character
@@ -246,14 +256,14 @@ indexstemminglanguages = english
 # Examples: 
 # Swedish:
 # unac_except_trans = ää Ää öö Öö üü Üü ßss œoe Œoe æae Æae ﬀff ﬁfi ﬂfl åå Åå
-# German:
+# . German:
 # unac_except_trans = ää Ää öö Öö üü Üü ßss œoe Œoe æae Æae ﬀff ﬁfi ﬂfl
 # In French, you probably want to decompose oe and ae and nobody would type
 # a German ß
 # unac_except_trans = ßss œoe Œoe æae Æae ﬀff ﬁfi ﬂfl
-# Reasonable default for all until someone protests. These decompositions
-# are not performed by unac, but I cant imagine someone typing the composed
-# forms in a search.
+# . The default for all until someone protests follows. These decompositions
+# are not performed by unac, but it is unlikely that someone would type the
+# composed forms in a search.
 # unac_except_trans = ßss œoe Œoe æae Æae ﬀff ﬁfi ﬂfl</descr></var>
 unac_except_trans = ßss œoe Œoe æae Æae ﬀff ﬁfi ﬂfl

@@ -274,7 +284,7 @@ unac_except_trans = ßss œoe Œoe æae Æae ﬀff ﬁfi ﬂfl

 # <var name="testmodifusemtime" type="bool"><brief>Use mtime instead of
 # ctime to test if a file has been modified.</brief><descr>The time is used
-# in in addition to the size, which is always used.
+# in addition to the size, which is always used.
 # Setting this can reduce re-indexing on systems where extended attributes
 # are used (by some other application), but not indexed, because changing
 # extended attributes only affects ctime.
@@ -305,6 +315,7 @@ noxattrfields = 0
 # returns multiple field values inside a text blob formatted as a recoll
 # configuration file ("fieldname = fieldvalue" lines). The rclmultixx name
 # will be ignored, and field names and values will be parsed from the data.
+# Example: metadatacmds = ; tags = tmsu tags %f; rclmulti1 = cmdOutputsConf %f
 # </descr></var>
 #[/some/area/of/the/fs]
 #metadatacmds = ; tags = tmsu tags %f; rclmulti1 = cmdOutputsConf %f
@@ -312,24 +323,27 @@ noxattrfields = 0



-# <grouptitle>Parameters affecting where and how we store things</grouptitle>
+# <grouptitle id="STORE">Parameters affecting where and how we store
+# things</grouptitle> 

-# <var name="cachedir" type="dfn"><brief>Top directory for Recoll
-# data</brief><descr>Recoll data directories are normally located relative
-# to the configuration directory (e.g. ~/.recoll/xapiandb,
-# ~/.recoll/mboxcache). If 'cachedir' is set, the directories are stored under
-# the specified value instead (e.g. if cachedir is ~/.cache/recoll, the
-# default dbdir would be ~/.cache/recoll/xapiandb).  This affects dbdir,
-# webcachedir, mboxcachedir, aspellDicDir, which can still be individually
-# specified to override cachedir.  Note that if you have multiple
-# configurations, each must have a different cachedir, there is no
-# automatic computation of a subpath under cachedir.</descr></var>
+# <var name="cachedir" type="dfn">
+#
+# <brief>Top directory for Recoll data.</brief><descr>Recoll data
+# directories are normally located relative to the configuration directory
+# (e.g. ~/.recoll/xapiandb, ~/.recoll/mboxcache). If 'cachedir' is set, the
+# directories are stored under the specified value instead (e.g. if
+# cachedir is ~/.cache/recoll, the default dbdir would be
+# ~/.cache/recoll/xapiandb).  This affects dbdir, webcachedir,
+# mboxcachedir, aspellDicDir, which can still be individually specified to
+# override cachedir.  Note that if you have multiple configurations, each
+# must have a different cachedir, there is no automatic computation of a
+# subpath under cachedir.</descr></var>
 #cachedir = ~/.cache/recoll

 # <var name="maxfsoccuppc" type="int"><brief>Maximum file system occupation
 # over which we stop indexing.</brief><descr>The value is a percentage,
 # corresponding to what the "Capacity" df output column shows. The default
-# value is 0, meaning no checking.</descr></brief>
+# value is 0, meaning no checking.</descr></var>
 maxfsoccuppc = 0

 # <var name="xapiandb" type="dfn"><brief>Xapian database directory
@@ -340,9 +354,11 @@ maxfsoccuppc = 0
 # ~/.recoll/xapiandb/</descr></var>
 dbdir = xapiandb

-# <var name="idxstatusfile" type="fn"><brief>Name of the scratch file where
-# the indexer process updates its status. Default:
-# idxstatus.txt inside the configuration directory
+# <var name="idxstatusfile" type="fn">
+#
+# <brief>Name of the scratch file where the indexer process updates its
+# status.</brief><descr>Default: idxstatus.txt inside the configuration
+# directory.</descr></var>
 #idxstatusfile = idxstatus.txt

 # <var name="mboxcachedir" type="dfn">
@@ -371,9 +387,9 @@ webcachedir = webcache
 # <var name="webcachemaxmbs" type="int">
 # <brief>Maximum size in MB of the Web archive.</brief>
 # <descr>This is only used by the web history indexing code.
-# Default: 100 MB.
+# Default: 40 MB.
 # Reducing the size will not physically truncate the file.</descr></var>
-webcachemaxmbs = 100
+webcachemaxmbs = 40

 # <var name="webqueuedir" type="fn">
 #
@@ -405,21 +421,21 @@ webcachemaxmbs = 100
 # result list. Defaults to $prefix/share/recoll/images</descr></var>
 #iconsdir = /path/to/my/icons

-# <grouptitle>Parameters affecting indexing performance and resource
-# usage</grouptitle> 
+# <grouptitle id="PERFS">Parameters affecting indexing performance and
+# resource usage</grouptitle> 

 # <var name="idxflushmb" type="int">
 #
-# <brief>Threshold (megabytes of new data) where we flush from memory to disk
-# index.</brief>
-# <descr>Setting this allows some control over memory usage by the indexer
-# process. A value of 0 means no explicit flushing, which lets Xapian
-# perform its own thing, meaning flushing every XAPIAN_FLUSH_THRESHOLD
-# documents created, modified or deleted. XAPIAN_FLUSH_THRESHOLD is an
-# environment variable. As memory usage depends on average document size,
-# not only document count, this is not very useful.
-# The default value of 10 MB may be a bit low. If you are looking for
-# maximum speed, you may want to experiment with values between 20 and
+# <brief>Threshold (megabytes of new data) where we flush from memory to
+# disk index.</brief> <descr>Setting this allows some control over memory
+# usage by the indexer process. A value of 0 means no explicit flushing,
+# which lets Xapian perform its own thing, meaning flushing every
+# $XAPIAN_FLUSH_THRESHOLD documents created, modified or deleted: as memory
+# usage depends on average document size, not only document count, the
+# Xapian approach is is not very useful, and you should let Recoll manage
+# the flushes.  The default value of idxflushmb is 10 MB, and may be a bit
+# low. If you are looking for maximum speed, you may want to experiment
+# with values between 20 and
 # 80. In my experience, values beyond 100 are always counterproductive. If
 # you find otherwise, please drop me a note.</descr></var>
 idxflushmb = 10
@@ -449,7 +465,7 @@ filtermaxmbytes = 2000
 # for each stage (three integer values). If a value of -1 is given for a
 # given stage, no queue is used, and the thread will go on performing the
 # next stage. In practise, deep queues have not been shown to increase
-# performance. Default: a value of 0 for the first queue tells &RCL; to
+# performance. Default: a value of 0 for the first queue tells Recoll to
 # perform autoconfiguration based on the detected number of CPUs (no need
 # for the two other values in this case).  Use thrQSizes = -1 -1 -1 to
 # disable multithreading entirely.</descr></var>
@@ -463,23 +479,23 @@ thrQSizes = 0
 # in thrQSizes: if the first queue depth is 0, all counts are ignored
 # (autoconfigured); if a value of -1 is used for a queue depth, the
 # corresponding thread count is ignored. It makes no sense to use a value
-# other than 1 for the last stage because updating the &XAP; index is
+# other than 1 for the last stage because updating the Xapian index is
 # necessarily single-threaded (and protected by a mutex).</descr></var>
 #thrTCounts = 4 2 1


-# <grouptitle>Miscellaneous parameters</grouptitle>
+# <grouptitle id="MISC">Miscellaneous parameters</grouptitle>

 # <var name="loglevel" type="int">
 #
-# <brief>Debug log verbosity 1-6</brief> <descr>2 is errors/warnings
-# only. 3 information like document updates, 4 is quite verbose and 6 very
-# verbose.</descr></var>
+# <brief>Log file verbosity 1-6.</brief> <descr>A value of 2 will print
+# only errors and warnings. 3 will print information like document updates,
+# 4 is quite verbose and 6 very verbose.</descr></var>
 loglevel = 3

 # <var name="logfilename" type="fn">
 #
-# <brief>Debug log destination. Use 'stderr' (default) to write to the
+# <brief>Log file destination. Use 'stderr' (default) to write to the
 # console.</brief><descr></descr></var>
 logfilename = stderr

@@ -511,12 +527,11 @@ logfilename = stderr
 #
 # <brief>Indexing process current directory.</brief> <descr>The input
 # handlers sometimes leave temporary files in the current directory, so it
-# makes sense to have recollindex chdir to some temporary directory. Three
-# possible types of values:
-#  - (literal) tmp : go to temp dir as set by environment (RECOLL_TMPDIR else
-#    TMPDIR else /tmp)
-#  - Empty: stay where started
-#  - Absolute path value: go there.</descr></var>
+# makes sense to have recollindex chdir to some temporary directory. If the
+# value is empty, the current directory is not changed. If the
+# value is (literal) tmp, we use the temporary directory as set by the
+# environment (RECOLL_TMPDIR else TMPDIR else /tmp). If the value is an
+# absolute path to a directory, we go there.</descr></var>
 idxrundir = tmp

 # <var name="checkneedretryindexscript" type="fn">
@@ -525,7 +540,7 @@ idxrundir = tmp
 # files which previously failed. </brief> <descr>The default script checks
 # the modified dates on /usr/bin and /usr/local/bin. A relative path will
 # be looked up in the filters dirs, then in the path. Use an absolute path
-# to do otherwise.</descr>
+# to do otherwise.</descr></var>
 checkneedretryindexscript = rclcheckneedretry.sh

 # <var name="recollhelperpath" type="string">
@@ -569,9 +584,10 @@ checkneedretryindexscript = rclcheckneedretry.sh

 # <var name="aspellAddCreateParam" type="string">
 #
-# <brief>Additional parameter to aspell dictionary creation
+# <brief>Additional option and parameter to aspell dictionary creation
 # command.</brief><descr>Some aspell packages may need an additional option
-# (e.g. on Debian Jessie). See Debian bug 772415.</descr></var>
+# (e.g. on Debian Jessie: --local-data-dir=/usr/lib/aspell). See Debian bug
+# 772415.</descr></var>
 #aspellAddCreateParam = --local-data-dir=/usr/lib/aspell

 # <var name="aspellKeepStderr" type="bool">
@@ -589,18 +605,21 @@ checkneedretryindexscript = rclcheckneedretry.sh
 # disable the thing.</descr></var>
 #noaspell = 1

-# <var name="monixinterval" type="int">
+# <var name="monauxinterval" type="int">
 #
-# <brief>Seconds between auxiliary databases updates (stemdb,
-# aspell).</brief><descr>The default is one hour.</descr></var>
+# <brief>Auxiliary database update interval.</brief><descr>The real time
+# indexer only updates the auxiliary databases (stemdb, aspell)
+# periodically, because it would be too costly to do it for every document
+# change. The default period is one hour.</descr></var>
 #monauxinterval = 3600

 # <var name="monixinterval" type="int">
 # 
 # <brief>Minimum interval (seconds) between processings of the indexing
-# queue.</brief> <descr>The real time monitor does not process each event
+# queue.</brief><descr>The real time indexer does not process each event
 # when it comes in, but lets the queue accumulate, to diminish overhead and
-# to aggregate multiple events to the same file. Default 30 S.</descr></var>
+# to aggregate multiple events affecting the same file. Default 30
+# S.</descr></var>
 #monixinterval = 30

 # <var name="mondelaypatterns" type="string">
@@ -611,14 +630,14 @@ checkneedretryindexscript = rclcheckneedretry.sh
 # reindexed once in a while. A list of wildcardPattern:seconds pairs. The
 # patterns are matched with fnmatch(pattern, path, 0) You can quote entries
 # containing white space with double quotes (quote the whole entry, not the
-# pattern). The default is empty.  Example:mondelaypatterns = *.log:20
-# "*with spaces.*:30"</descr></brief>
+# pattern). The default is empty.
+# Example: mondelaypatterns = *.log:20 "*with spaces.*:30"</descr></var>
 #mondelaypatterns = *.log:20  "*with spaces.*:30"

 # <var name="monioniceclass" type="int">
 #
 # <brief>ionice class for the real time indexing process</brief>
-# <descr>On platforms where this is supported, the default value is
+# <descr>On platforms where this is supported. The default value is
 # 3.</descr></var> 
 # monioniceclass = 3

@@ -631,11 +650,12 @@ checkneedretryindexscript = rclcheckneedretry.sh



-# <grouptitle>Query-time parameters (no impact on the index)</grouptitle>
+# <grouptitle id="QUERY">Query-time parameters (no impact on the
+# index)</grouptitle> 

 # <var name="autodiacsens" type="bool">
 #
-# <brief>auto-trigger diacritics sensitivity (raw index only)</brief>
+# <brief>auto-trigger diacritics sensitivity (raw index only).</brief>
 # <descr>IF the index is not stripped, decide if we automatically trigger
 # diacritics sensitivity if the search term has accented characters (not in
 # unac_except_trans). Else you need to use the query language and the "D"
@@ -644,7 +664,7 @@ autodiacsens = 0

 # <var name="autocasesens" type="bool">
 #
-# <brief>auto-trigger case sensitivity (raw index only)</brief> <descr>IF
+# <brief>auto-trigger case sensitivity (raw index only).</brief><descr>IF
 # the index is not stripped (see indexStripChars), decide if we
 # automatically trigger character case sensitivity if the search term has
 # upper-case characters in any but the first position. Else you need to use
@@ -668,14 +688,14 @@ maxXapianClauses = 50000

 # <var name="snippetMaxPosWalk" type="int">
 #
-# <brief>Maximum number of positions we walk while populating a snippet for the
-# result list.</brief><descr>The default of 1,000,000 may be insufficient
-# for big documents, the consequence would be snippets with possibly
-# meaning-altering missing words.</descr></var>
+# <brief>Maximum number of positions we walk while populating a snippet for
+# the result list.</brief><descr>The default of 1,000,000 may be
+# insufficient for very big documents, the consequence would be snippets
+# with possibly meaning-altering missing words.</descr></var>
 snippetMaxPosWalk = 1000000


-# <grouptitle>Parameters for the PDF input script</grouptitle>
+# <grouptitle id="PDF">Parameters for the PDF input script</grouptitle>

 # <var name="pdfocr" type="bool">
 #
@@ -693,7 +713,8 @@ snippetMaxPosWalk = 1000000
 #pdfattach = 0


-# <grouptitle>Parameters set for specific locations</grouptitle>
+# <grouptitle id="SPECLOCATIONS">Parameters set for specific
+# locations</grouptitle> 

 # You could specify different parameters for a subdirectory like this:
 #[~/hungariandocs/plain]