diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index 31d919a4..5ff1d1fb 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -35,7 +35,7 @@ alink="#0000FF">
-
@@ -92,11 +92,11 @@ alink="#0000FF"> "#RCL.INDEXING.INTRODUCTION.CONFIG">Configurations, multiple indexes
2.1.3. Document types
+ "#idm224">Document types
2.1.4. Indexing failures
+ "#idm265">Indexing failures
2.1.5. Recovery
+ "#idm277">Recovery
2.2.
2.9.1. Slowing down the - reindexing rate for fast changing - files
+ "#RCL.INDEXING.MONITOR.START">Real time indexing: + automatic daemon start +
2.9.2. Real time indexing: + miscellaneous details
@@ -481,9 +483,8 @@ alink="#0000FF"> "guimenuitem">Indexing configuration, then adjust the Top directories section).

-

Also be aware that, on Unix/Linux, you may need to - install the appropriate On Unix/Linux, you may need to install the appropriate + supporting applications for document types that need them (for example antiword for "application">Recoll can only display documents that still exist at the place from which they were indexed. (Actually, there is a way to reconstruct a document from - the information in the index, but the result is not nice, - as all formatting, punctuation and capitalization are - lost).

+ the information in the index, but only the pure text is + saved, possibly without punctuation and capitalization, + depending on Recoll + version).

Recoll stores all internal data in Unicode UTF-8 format, and it can index files of many types @@ -796,11 +798,10 @@ alink="#0000FF">

  • Periodic (or - batch) indexing: indexing takes place - at discrete times, by executing the recollindex - command. The typical usage is to have a nightly - indexing run  recollindex is + executed at discrete times. The typical usage is to + have a nightly run programmed into your

  • Real time - indexing: indexing takes place as soon - as a file is created or changed.  recollindex runs - as a daemon and uses a file system alteration - monitor (e.g. inotify) to detect file - changes.

    + changes. New or updated files are indexed at + once.

  • @@ -825,7 +826,7 @@ alink="#0000FF"> documentation directory, and real time indexing on a small home directory). Monitoring a big file system tree can consume significant system resources.

    -

    With Recoll 1.25 and +

    With Recoll 1.24 and newer, it is also possible to set up an index so that only a subset of the tree will be monitored and the rest will be covered by batch/incremental indexing. (See the @@ -838,9 +839,9 @@ alink="#0000FF"> "command">recoll GUI: PreferencesIndexing schedule

    -

    The File menu also has - entries to start or stop the current indexing operation. - Stopping indexing is performed by killing the +

    The GUI File menu also + has entries to start or stop the current indexing + operation. Stopping indexing is performed by killing the recollindex process, which will checkpoint its state and exit. A later restart of indexing will mostly resume from where @@ -900,7 +901,7 @@ alink="#0000FF">

    When generating indexes, the different configurations are entirely independant (no parameters are ever shared between configurations when indexing).

    -

    Multiple indexes can queryied concurrently, either +

    Multiple indexes can be queryied concurrently, either from the GUI or the command line. When doing this, there is always a main configuration, from which both configuration and index data are used. Only the index @@ -923,8 +924,8 @@ alink="#0000FF">

    -

    2.1.3. Document types

    +

    2.1.3. Document types

    @@ -943,10 +944,10 @@ alink="#0000FF"> LibreOffice document stored as an attachment to an email message inside an email folder archived in a zip file...

    -

    Recoll indexing - processes plain text, HTML, OpenDocument - (Open/LibreOffice), email formats, and a few others - internally.

    +

    recollindex processes + plain text, HTML, OpenDocument (Open/LibreOffice), email + formats, and a few others internally.

    Other file types (ie: postscript, pdf, ms-word, rtf ...) need external applications for preprocessing. The list is in the to either exclude some types, or on the contrary define a positive list of types to be indexed. In the latter case, any type not in the list will be ignored.

    -

    Excluding file types can be done by adding wildcard +

    Excluding files by name can be done by adding wildcard name patterns to the skippedNames list, which can be done from the GUI Index configuration - menu. For versions 1.20 and later, you can alternatively - set the excludedmimetypes - list in the configuration file. This can be redefined for - subdirectories.

    + list in the configuration file (1.20 and later). This can + be redefined for subdirectories.

    You can also define an exclusive list of MIME types to be indexed (no others will be indexed), by settting the

    -

    2.1.4. Indexing failures

    +

    2.1.4. Indexing failures

    @@ -1039,7 +1040,7 @@ alink="#0000FF"> may be quite costly (for example failing to uncompress a big file because of insufficient disk space).

    The indexer in Recoll - versions 1.21 and later does not retry failed file by + versions 1.21 and later does not retry failed files by default. Retrying will only occur if an explicit option (-k) is set on the recollindex @@ -1057,8 +1058,8 @@ alink="#0000FF">

    -

    2.1.5. Recovery

    +

    2.1.5. Recovery

    @@ -1153,9 +1154,9 @@ alink="#0000FF"> non-indexed data (an extreme example being a set of mp3 files where only the tags would be indexed).

    Of course, images, sound and video do not increase the - index size, which means that nowadays, typically, even a - big index will be negligible against the total amount of - data on the computer.

    + index size, which means that typically, even a big index + will be negligible against the total amount of data on the + computer.

    The index data directory (xapiandb) only contains data that can be completely rebuilt by an index run (as long as the original @@ -1200,10 +1201,11 @@ alink="#0000FF">

    The Recoll index does - not hold copies of the indexed documents. But it does - hold enough data to allow for an almost complete - reconstruction. If confidential data is indexed, access - to the database directory should be restricted.

    + not hold complete copies of the indexed documents (it + almost does after version 1.24). But it does hold enough + data to allow for an almost complete reconstruction. If + confidential data is indexed, access to the database + directory should be restricted.

    Recoll will create the configuration directory with a mode of 0700 (access by owner only). As the index data directory is by default @@ -1256,8 +1258,7 @@ alink="#0000FF"> "refentrytitle">recoll.conf(5) man page, but the most current information will most likely be the comments inside the sample file. The most immediately - useful variable you may interested in is probably topdirs, which determines what subtrees and files get indexed.

    @@ -1271,9 +1272,8 @@ alink="#0000FF"> Recoll indexes, depending on the treatment of character case and diacritics. A a - further section describes the two types in more - detail.

    + "2.3.2. Index case and diacritics sensitivity">further + section describes the two types in more detail.

    @@ -1317,7 +1317,7 @@ alink="#0000FF"> where narrowing the search can improve the results. You can achieve approximately the same effect with the directory filter in advanced search, but multiple indexes - will have much better performance and may be worth the + will have better performance and may be worth the trouble.

    A recollindex program @@ -1325,7 +1325,7 @@ alink="#0000FF"> only use parameters from a single configuration (no parameters are ever shared between configurations when indexing).

    -

    Multiple indexes can queryied concurrently, either +

    Multiple indexes can be queryied concurrently, either from the GUI or the command line. When doing this, there is always a main configuration, from which both configuration and index data are used. Only the index @@ -2082,68 +2082,6 @@ alink="#0000FF"> "command">recollindex will detach from the terminal and become a daemon, permanently monitoring file changes and updating the index.

    -

    Under KDE, Gnome and some other desktop - environments, the daemon can automatically started when you - log in, by creating a desktop file inside the ~/.config/autostart directory. This can - be done for you by the Recoll GUI. Use the Preferences->Indexing Schedule - menu.

    -

    With older X11 setups, - starting the daemon is normally performed as part of the - user session script.

    -

    The rclmon.sh script can - be used to easily start and stop the daemon. It can be - found in the examples - directory (typically /usr/local/[share/]recoll/examples).

    -

    For example, my out of fashion xdm-based session has a .xsession script with the following lines - at the end:

    -
    recollconf=$HOME/.recoll-home
    -      recolldata=/usr/local/share/recoll
    -      RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh start
    -
    -      fvwm 
    -
    -      
    -

    The indexing daemon gets started, then the window - manager, for which the session waits.

    -

    By default the indexing daemon will monitor the state of - the X11 session, and exit when it finishes, it is not - necessary to kill it explicitly. (The X11 server monitoring can be disabled - with option -x to recollindex).

    -

    If you use the daemon completely out of an X11 session, you need to add option - -x to disable X11 session monitoring (else the - daemon will not start).

    -

    By default, the messages from the indexing daemon will - be sent to the same file as those from the interactive - commands (logfilename). You - may want to change this by setting the daemlogfilename and daemloglevel configuration parameters. - Also the log file will only be truncated when the daemon - starts. If the daemon runs permanently, the log file may - grow quite big, depending on the log level.

    -

    When building Recoll, - the real time indexing support can be customised during - package configuration with the - --with[out]-fam or --with[out]-inotify options. The default is - currently to include inotify monitoring on systems that - support it, and, as of Recoll 1.17, gamin support on FreeBSD.

    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, @@ -2151,68 +2089,149 @@ alink="#0000FF"> system resources. You probably do not want to enable it if your system is short on resources. Periodic indexing is adequate in most cases.

    -

    As of Recoll 1.25, you +

    As of Recoll 1.24, you can set the monitordirs configuration variable to specify that only a subset of your indexed files will be monitored for instant indexing. In this situation, an incremental pass on the full tree can be triggered by either restarting the indexer, or just - running the recollindex, which will notify the running process. The recoll GUI also has a menu entry for this.

    -
    -

    Increasing resources for inotify

    -

    On Linux systems, monitoring a big tree may need - increasing the resources available to inotify, which are - normally defined in /etc/sysctl.conf.

    -
    -        ### inotify
    -        #
    -        # cat  /proc/sys/fs/inotify/max_queued_events   - 16384
    -        # cat  /proc/sys/fs/inotify/max_user_instances  - 128
    -        # cat  /proc/sys/fs/inotify/max_user_watches    - 16384
    -        #
    -        # -- Change to:
    -        #
    -        fs.inotify.max_queued_events=32768
    -        fs.inotify.max_user_instances=256
    -        fs.inotify.max_user_watches=32768
    -      
    -

    Especially, you will need to trim your tree or adjust - the max_user_watches value - if indexing exits with a message about errno ENOSPC (28) from inotify_add_watch.

    +
    +
    +
    +
    +

    2.9.1. Real + time indexing: automatic daemon start

    +
    +
    +
    +

    Under KDE, + Gnome and some other + desktop environments, the daemon can automatically + started when you log in, by creating a desktop file + inside the ~/.config/autostart directory. This can + be done for you by the Recoll GUI. Use the Preferences->Indexing Schedule + menu.

    +

    With older X11 + setups, starting the daemon is normally performed as part + of the user session script.

    +

    The rclmon.sh script can + be used to easily start and stop the daemon. It can be + found in the examples + directory (typically /usr/local/[share/]recoll/examples).

    +

    For example, my out of fashion xdm-based session has a .xsession script with the following + lines at the end:

    +
    recollconf=$HOME/.recoll-home
    +        recolldata=/usr/local/share/recoll
    +        RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh start
    +
    +        fvwm 
    +
    +        
    +

    The indexing daemon gets started, then the window + manager, for which the session waits.

    +

    By default the indexing daemon will monitor the state + of the X11 session, and exit when it finishes, it is not + necessary to kill it explicitly. (The X11 server monitoring can be + disabled with option -x to + recollindex).

    +

    If you use the daemon completely out of an + X11 session, you need to + add option -x to disable + X11 session monitoring + (else the daemon will not start).

    2.9.1. Slowing - down the reindexing rate for fast changing - files

    + "RCL.INDEXING.MONITOR.DETAILS" id= + "RCL.INDEXING.MONITOR.DETAILS">2.9.2. Real + time indexing: miscellaneous details
    -

    When using the real time monitor, it may happen that - some files need to be indexed, but change so often that - they impose an excessive load for the system.

    -

    Recoll provides a - configuration option to specify the minimum time before - which a file, specified by a wildcard pattern, cannot be - reindexed. See the mondelaypatterns parameter in the - configuration - section.

    +

    By default, the messages from the indexing daemon will + be sent to the same file as those from the interactive + commands (logfilename). You + may want to change this by setting the daemlogfilename and daemloglevel configuration parameters. + Also the log file will only be truncated when the daemon + starts. If the daemon runs permanently, the log file may + grow quite big, depending on the log level.

    +

    When building Recoll, + the real time indexing support can be customised during + package configuration + with the --with[out]-fam or + --with[out]-inotify options. + The default is currently to include inotify monitoring on systems that + support it, and, as of Recoll 1.17, gamin support on FreeBSD.

    +
    +

    Increasing resources for inotify

    +

    On Linux systems, monitoring a big tree may need + increasing the resources available to inotify, which + are normally defined in /etc/sysctl.conf.

    +
    +          ### inotify
    +          #
    +          # cat  /proc/sys/fs/inotify/max_queued_events   - 16384
    +          # cat  /proc/sys/fs/inotify/max_user_instances  - 128
    +          # cat  /proc/sys/fs/inotify/max_user_watches    - 16384
    +          #
    +          # -- Change to:
    +          #
    +          fs.inotify.max_queued_events=32768
    +          fs.inotify.max_user_instances=256
    +          fs.inotify.max_user_watches=32768
    +        
    +

    Especially, you will need to trim your tree or + adjust the max_user_watches value if indexing + exits with a message about errno ENOSPC (28) from inotify_add_watch.

    +
    +
    +

    Slowing down the reindexing rate for + fast changing files

    +

    When using the real time monitor, it may happen that + some files need to be indexed, but change so often that + they impose an excessive load for the system.

    +

    Recoll provides a + configuration option to specify the minimum time before + which a file, specified by a wildcard pattern, cannot + be reindexed. See the mondelaypatterns parameter in the + configuration + section.

    +
    diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index 11c2f7ef..21171287 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -25,7 +25,7 @@ - 2005-2015 + 2005-2018 Jean-Francois Dockes @@ -89,7 +89,7 @@ , then adjust the Top directories section). - Also be aware that, on Unix/Linux, you may need to install the + On Unix/Linux, you may need to install the appropriate supporting applications for document types that need them (for example antiword for @@ -175,13 +175,13 @@ In a shorter way, &RCL; does the dirty footwork, &XAP; deals with the intelligent parts of the process. - The &XAP; index can be big (roughly the size of the - original document set), but it is not a document - archive. &RCL; can only display documents that still exist at - the place from which they were indexed. (Actually, there is a - way to reconstruct a document from the information in the - index, but the result is not nice, as all formatting, - punctuation and capitalization are lost). + The &XAP; index can be big (roughly the size of the original + document set), but it is not a document archive. &RCL; can only + display documents that still exist at the place from which they were + indexed. (Actually, there is a way to reconstruct a document from the + information in the index, but only the pure text is saved, possibly + without punctuation and capitalization, depending on &RCL; + version). &RCL; stores all internal data in Unicode UTF-8 format, and it can index files of many types @@ -332,9 +332,8 @@ <link linkend="RCL.INDEXING.PERIODIC"> Periodic (or batch) indexing:</link> - indexing takes place at discrete - times, by executing the recollindex - command. The typical usage is to have a nightly indexing run + recollindex is executed + at discrete times. The typical usage is to have a nightly run programmed into your cron file. @@ -342,12 +341,12 @@ <link linkend="RCL.INDEXING.MONITOR">Real - time indexing:</link> indexing takes place as - soon as a file is created or - changed. recollindex runs as a daemon and - uses a file system alteration monitor + time indexing: + recollindex runs permanently as a + daemon and uses a file system alteration monitor (e.g. inotify) to detect file - changes. + changes. New or updated files are indexed at once. + @@ -359,7 +358,7 @@ directory). Monitoring a big file system tree can consume significant system resources. - With &RCL; 1.25 and newer, it is also possible to set up an + With &RCL; 1.24 and newer, it is also possible to set up an index so that only a subset of the tree will be monitored and the rest will be covered by batch/incremental indexing. (See the details in the Real time @@ -373,7 +372,7 @@ - The File + The GUI File menu also has entries to start or stop the current indexing operation. Stopping indexing is performed by killing the recollindex process, which will @@ -430,10 +429,10 @@ entirely independant (no parameters are ever shared between configurations when indexing). - Multiple indexes can queryied concurrently, either from the - GUI or the command line. When doing this, there is always a main - configuration, from which both configuration and index data are - used. Only the index data from the additional indexes is used + Multiple indexes can be queryied concurrently, either from + the GUI or the command line. When doing this, there is always a + main configuration, from which both configuration and index data + are used. Only the index data from the additional indexes is used (their configuration parameters are ignored). This is important and sometimes confusing, so it will be @@ -464,8 +463,9 @@ document stored as an attachment to an email message inside an email folder archived in a zip file... - &RCL; indexing processes plain text, HTML, OpenDocument - (Open/LibreOffice), email formats, and a few others internally. + recollindex processes plain text, HTML, + OpenDocument (Open/LibreOffice), email formats, and a few others + internally. Other file types (ie: postscript, pdf, ms-word, rtf ...) need external applications for preprocessing. The list is in the @@ -488,14 +488,15 @@ indexed. In the latter case, any type not in the list will be ignored. - Excluding file types can be done by adding wildcard name + Excluding files by name can be done by adding wildcard name patterns to the skippedNames list, which - can be done from the GUI Index configuration menu. For - versions 1.20 and later, you can alternatively set the + can be done from the GUI Index configuration menu. Excluding by + type can be done by setting the - excludedmimetypes list in the configuration file. This + excludedmimetypes list in the configuration file (1.20 + and later). This can be redefined for subdirectories. You can also define an exclusive list of MIME types to be @@ -550,7 +551,7 @@ file because of insufficient disk space). The indexer in &RCL; versions 1.21 and later does not - retry failed file by default. Retrying will only occur if an + retry failed files by default. Retrying will only occur if an explicit option () is set on the recollindex command line, or if a script executed when recollindex starts up says @@ -636,10 +637,9 @@ example being a set of mp3 files where only the tags would be indexed). - Of course, images, sound and video do not increase the - index size, which means that nowadays, typically, even a big - index will be negligible against the total amount of data on the - computer. + Of course, images, sound and video do not increase the index + size, which means that typically, even a big index will be negligible + against the total amount of data on the computer. The index data directory (xapiandb) only contains data that can be completely rebuilt by an index run @@ -669,10 +669,11 @@ Security aspects - The &RCL; index does not hold copies of the indexed - documents. But it does hold enough data to allow for an almost - complete reconstruction. If confidential data is indexed, - access to the database directory should be restricted. + The &RCL; index does not hold complete copies of the indexed + documents (it almost does after version 1.24). But it does + hold enough data to allow for an almost complete reconstruction. If + confidential data is indexed, access to the database directory + should be restricted. &RCL; will create the configuration directory with a mode of 0700 (access by owner only). As the index data directory is by @@ -716,10 +717,9 @@ recoll.conf 5 - man page, but the most - current information will most likely be the comments inside the - sample file. The most immediately useful variable you may - interested in is probably + man page, but the most current information will most likely be the + comments inside the sample file. The most immediately useful variable + is probably topdirs, which determines what subtrees and files get indexed. @@ -731,7 +731,7 @@ As of Recoll 1.18 there are two incompatible types of Recoll indexes, depending on the treatment of character case and - diacritics. A a further + diacritics. A further section describes the two types in more detail. @@ -757,26 +757,25 @@ to avoid mistakenly creating additional directories when an argument is mistyped. - A typical 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 personal data. Of course, there are other - possibilities. There are many cases where you know the subset of - files that should be searched, and where narrowing the search - can improve the results. You can achieve approximately the same - effect with the directory filter in advanced search, but - multiple indexes will have much better performance and may be - worth the trouble. + A typical 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 personal + data. Of course, there are other possibilities. There are many + cases where you know the subset of files that should be searched, + and where narrowing the search can improve the results. You can + achieve approximately the same effect with the directory filter in + advanced search, but multiple indexes will have better performance + and may be worth the trouble. A recollindex program instance can only update one specific index, and it will only use parameters from a single configuration (no parameters are ever shared between configurations when indexing). - Multiple indexes can queryied concurrently, either from the - GUI or the command line. When doing this, there is always a main - configuration, from which both configuration and index data are - used. Only the index data from the additional indexes is used + Multiple indexes can be queryied concurrently, either from + the GUI or the command line. When doing this, there is always a + main configuration, from which both configuration and index data + are used. Only the index data from the additional indexes is used (their configuration parameters are ignored). When searching, the current main index (defined by @@ -1416,68 +1415,6 @@ from the terminal and become a daemon, permanently monitoring file changes and updating the index. - Under KDE, - Gnome and some other desktop - environments, the daemon can automatically started when you log - in, by creating a desktop file inside the - ~/.config/autostart directory. This can be - done for you by the &RCL; GUI. Use the - Preferences->Indexing Schedule menu. - - With older X11 setups, starting - the daemon is normally performed as part of the user session - script. - - The rclmon.sh script can be used to - easily start and stop the daemon. It can be found in the - examples directory (typically - /usr/local/[share/]recoll/examples). - - For example, my out of fashion - xdm-based session has a - .xsession script with the following lines - at the end: - - recollconf=$HOME/.recoll-home - recolldata=/usr/local/share/recoll - RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh start - - fvwm - - - - The indexing daemon gets started, then the window manager, - for which the session waits. By default the - indexing daemon will monitor the state of the X11 session, and - exit when it finishes, it is not necessary to kill it - explicitly. (The X11 server - monitoring can be disabled with option to - recollindex). - - If you use the daemon completely out of an - X11 session, you need to add option - to disable X11 - session monitoring (else the daemon will not start). - - By default, the messages from the indexing daemon will be - sent to the same file as those from the interactive commands - (logfilename). You may want to change this - by setting the daemlogfilename and - daemloglevel configuration parameters. Also - the log file will only be truncated when the daemon starts. If - the daemon runs permanently, the log file may grow quite big, - depending on the log level. - - When building &RCL;, the real time indexing support can be - customised during package configuration with - the or - options. The default is - currently to include inotify - monitoring on systems that support it, and, as of &RCL; 1.17, - gamin support on - FreeBSD. - 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, @@ -1486,44 +1423,112 @@ your system is short on resources. Periodic indexing is adequate in most cases. - As of &RCL; 1.25, you can set the As of &RCL; 1.24, you can set the monitordirs configuration variable to specify that only a subset of your indexed files will be monitored for instant indexing. In this situation, an incremental pass on the full tree can be triggered by either - restarting the indexer, or just running the + restarting the indexer, or just running recollindex, which will notify the running process. The recoll GUI also has a menu entry for this. + + Real time indexing: automatic daemon start - Increasing resources for inotify - On Linux systems, monitoring a big tree may need - increasing the resources available to inotify, which are - normally defined in /etc/sysctl.conf. - - ### inotify - # - # cat /proc/sys/fs/inotify/max_queued_events - 16384 - # cat /proc/sys/fs/inotify/max_user_instances - 128 - # cat /proc/sys/fs/inotify/max_user_watches - 16384 - # - # -- Change to: - # - fs.inotify.max_queued_events=32768 - fs.inotify.max_user_instances=256 - fs.inotify.max_user_watches=32768 - + Under KDE, + Gnome and some other desktop + environments, the daemon can automatically started when you log + in, by creating a desktop file inside the + ~/.config/autostart directory. This can be + done for you by the &RCL; GUI. Use the + Preferences->Indexing Schedule menu. + + With older X11 setups, starting + the daemon is normally performed as part of the user session + script. + + The rclmon.sh script can be used to + easily start and stop the daemon. It can be found in the + examples directory (typically + /usr/local/[share/]recoll/examples). + + For example, my out of fashion + xdm-based session has a + .xsession script with the following lines + at the end: + + recollconf=$HOME/.recoll-home + recolldata=/usr/local/share/recoll + RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh start + + fvwm + + + + The indexing daemon gets started, then the window manager, + for which the session waits. By default the + indexing daemon will monitor the state of the X11 session, and + exit when it finishes, it is not necessary to kill it + explicitly. (The X11 server + monitoring can be disabled with option to + recollindex). + + If you use the daemon completely out of an + X11 session, you need to add option + to disable X11 + session monitoring (else the daemon will not start). + - - Especially, you will need to trim your tree or adjust - the max_user_watches value if indexing exits with - a message about errno ENOSPC (28) from - inotify_add_watch. - + + Real time indexing: miscellaneous details - - Slowing down the reindexing rate for fast changing + <para>By default, the messages from the indexing daemon will be + sent to the same file as those from the interactive commands + (<literal>logfilename</literal>). You may want to change this + by setting the <varname>daemlogfilename</varname> and + <varname>daemloglevel</varname> configuration parameters. Also + the log file will only be truncated when the daemon starts. If + the daemon runs permanently, the log file may grow quite big, + depending on the log level.</para> + + <para>When building &RCL;, the real time indexing support can be + customised during package <link + linkend="RCL.INSTALL.BUILDING">configuration</link> with + the <option>--with[out]-fam</option> or + <option>--with[out]-inotify</option> options. The default is + currently to include <application>inotify</application> + monitoring on systems that support it, and, as of &RCL; 1.17, + <application>gamin</application> support on + <application>FreeBSD</application>.</para> + + <note><title>Increasing resources for inotify + On Linux systems, monitoring a big tree may need + increasing the resources available to inotify, which are + normally defined in /etc/sysctl.conf. + + ### inotify + # + # cat /proc/sys/fs/inotify/max_queued_events - 16384 + # cat /proc/sys/fs/inotify/max_user_instances - 128 + # cat /proc/sys/fs/inotify/max_user_watches - 16384 + # + # -- Change to: + # + fs.inotify.max_queued_events=32768 + fs.inotify.max_user_instances=256 + fs.inotify.max_user_watches=32768 + + + + Especially, you will need to trim your tree or adjust + the max_user_watches value if indexing exits with + a message about errno ENOSPC (28) from + inotify_add_watch. + + + + Slowing down the reindexing rate for fast changing files When using the real time monitor, it may happen that some @@ -1535,8 +1540,10 @@ reindexed. See the mondelaypatterns parameter in the configuration section. - + + +