tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
dockes 2006-12-24 07:53:13 +00:00
parent 2ba0ea3254
commit 40ee0199a9
3 changed files with 63 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/INSTALL
View File

@ -152,7 +152,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Configure options: --without-aspell will disable the code for phonetic Configure options: --without-aspell will disable the code for phonetic
matching of search terms. --with-fam or --with-inotify will enable the matching of search terms. --with-fam or --with-inotify will enable the
code for real time indexing. Refer to configure --help output for details. code for real time indexing. Inotify support is enabled by default on
recent Linux systems.
Normal procedure: Normal procedure:

60
src/README
View File

@ -386,19 +386,21 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Real time monitoring/indexing is performed by starting the recollindex -m Real time monitoring/indexing is performed by starting the recollindex -m
command. With this option, recollindex will detach from the terminal and command. With this option, recollindex will detach from the terminal and
become a daemon, forever monitoring file changes and updating the index. become a daemon, permanently monitoring file changes and updating the
index.
The package must have been configured with option --with-fam or The real time indexing support can be customised during package
--with-inotify for the monitoring code and option to be enabled in configuration with the --with[out]-fam or --with[out]-inotify options. The
recollindex. This is not currently the default. default is currently to include inotify monitoring on systems that support
it.
The rclmon.sh script can be used to easily start and stop the daemon. It The rclmon.sh script can be used to easily start and stop the daemon. It
can be found in the examples directory (typically can be found in the examples directory (typically
/usr/local/[share/]recoll/examples). /usr/local/[share/]recoll/examples).
Starting and stopping the daemon could be performed, for example, as part Starting the daemon is normally performed as part of the user session
of the user session script. For example, my out of fashion xdm-based script. For example, my out of fashion xdm-based session has a .xsession
session has a .xsession script with the following lines at the end: script with the following lines at the end:
recollconf=$HOME/.recoll-home recollconf=$HOME/.recoll-home
recolldata=/usr/local/share/recoll recolldata=/usr/local/share/recoll
@ -406,22 +408,18 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
fvwm fvwm
RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh stop
The indexing daemon gets started, then the window manager, for which the The indexing daemon gets started, then the window manager, for which the
session waits. When the window manager exits, the indexing daemon is session waits.
stopped, then the session ends (at script exit). This should be adjusted
for your flavour of session management, and of course, there are other By default the indexing daemon will monitor the state of the X11 session,
possibilities. and exit when it finishes, it is not necessary to kill it explicitely.
(The X11 server monitoring can be disabled with option -x to recollindex).
Under KDE, you can place a small script to start recollindex -m under Under KDE, you can place a small script to start recollindex -m under
$HOME/.kde/Autostart. This will be executed when the session begins, and $HOME/.kde/Autostart. This will be executed when the session begins.
the process seems to get a SIGHUP signal and be terminated when the
session ends.
There is a similar mechanism under Gnome (find the session control tool in There is a similar mechanism under Gnome (find the session control tool in
the menus and use the "Startup programs" tab). I could find an easy way to the menus and use the "Startup programs" tab).
stop recollindex at the end of the session though.
By default, the indexing daemon will write its messages to a file inside By default, the indexing daemon will write its messages to a file inside
the configuration directory (this is controlled by the daemlogfilename and the configuration directory (this is controlled by the daemlogfilename and
@ -430,10 +428,10 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
runs permanently, the log file may grow quite big, depending on the log runs permanently, the log file may grow quite big, depending on the log
level. level.
The real time indexing code is relatively young, and there are still a few While it is convenient that data is indexed in real time, repeated
quirks. File deletions occurring while the monitor is not running will not indexing can generate a significant load on the system when files such as
be detected. You'll have to run a normal incremental indexing pass from email folders change. You probably do not want to enable it if your system
time to time to purge the database. There may still be other problems. is short on resources. Periodic indexing is adequate in most cases.
---------------------------------------------------------------------- ----------------------------------------------------------------------
@ -540,6 +538,10 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
* Find similar * Find similar
* Find similar
* Parent document
The Preview and Edit entries do the same thing as the corresponding links. The Preview and Edit entries do the same thing as the corresponding links.
The two following entries will copy either an URL or the file path to the The two following entries will copy either an URL or the file path to the
clipboard, for pasting into another application. clipboard, for pasting into another application.
@ -549,6 +551,17 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
start a simple search, with a good chance of finding documents related to start a simple search, with a good chance of finding documents related to
the current result. the current result.
The Copy File Name and Copy Url copy the relevant data to the clipboard,
for later pasting.
The Parent document entry will appear for documents which are not actually
files but are part of, or attached to, a higher level document. This entry
is mainly useful for email attachments and permits viewing the message to
which the document is attached. Note that the entry will also appear for
an email which is part of an mbox folder file, but that you can't actually
visualize the folder (there will be an error dialog if you try). Recoll is
unfortunately not yet smart enough to disable the entry in this case.
---------------------------------------------------------------------- ----------------------------------------------------------------------
3.3. The preview window 3.3. The preview window
@ -1043,7 +1056,8 @@ More documentation can be found in the doc/ directory or at http://www.recoll.or
Configure options: --without-aspell will disable the code for phonetic Configure options: --without-aspell will disable the code for phonetic
matching of search terms. --with-fam or --with-inotify will enable the matching of search terms. --with-fam or --with-inotify will enable the
code for real time indexing. Refer to configure --help output for details. code for real time indexing. Inotify support is enabled by default on
recent Linux systems.
Normal procedure: Normal procedure:

49
src/doc/user/usermanual.sgml
View File

@ -24,7 +24,7 @@
Dockes</holder> Dockes</holder>
</copyright> </copyright>
<releaseinfo>$Id: usermanual.sgml,v 1.33 2006-12-24 07:40:26 dockes Exp $</releaseinfo> <releaseinfo>$Id: usermanual.sgml,v 1.34 2006-12-24 07:52:52 dockes Exp $</releaseinfo>
<abstract> <abstract>
<para>This document introduces full text search notions <para>This document introduces full text search notions
@ -426,20 +426,19 @@ recoll
become a daemon, permanently monitoring file changes and updating become a daemon, permanently monitoring file changes and updating
the index.</para> the index.</para>
<para>The package must have been <para>The real time indexing support can be customised during package
<link linkend="rcl.install.building.build">configured</link> <link linkend="rcl.install.building.build">configuration</link>
with option <literal>--with-fam</literal> or with the <literal>--with[out]-fam</literal> or
<literal>--with-inotify</literal> for the monitoring <literal>--with[out]-inotify</literal> options. The default is
code and option to be enabled in currently to include inotify monitoring on systems that support
<command>recollindex</command>. The default is currently to it.</para>
include inotify monitoring on systems that support it.</para>
<para>The <filename>rclmon.sh</filename> script can be used to <para>The <filename>rclmon.sh</filename> script can be used to
easily start and stop the daemon. It can be found in the easily start and stop the daemon. It can be found in the
<filename>examples</filename> directory (typically <filename>examples</filename> directory (typically
<filename>/usr/local/[share/]recoll/examples</filename>).</para> <filename>/usr/local/[share/]recoll/examples</filename>).</para>
<para>Starting and stopping the daemon can be performed as part <para>Starting the daemon is normally performed as part
of the user session script. For example, my out of fashion of the user session script. For example, my out of fashion
xdm-based session has a <filename>.xsession</filename> script xdm-based session has a <filename>.xsession</filename> script
with the following lines at the end:</para> with the following lines at the end:</para>
@ -450,25 +449,23 @@ RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh start
fvwm fvwm
RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh stop
</programlisting> </programlisting>
<para>The indexing daemon gets started, then the window manager, <para>The indexing daemon gets started, then the window manager,
for which the session waits. When the window manager exits, the for which the session waits.</para> <para>By default the
indexing daemon is stopped, then the session ends (at script indexing daemon will monitor the state of the X11 session, and
exit). This should be adjusted for your flavour of session exit when it finishes, it is not necessary to kill it
management, and of course, there are other possibilities.</para> explicitely. (The X11 server monitoring can be disabled with option
<literal>-x</literal> to <command>recollindex</command>).
</para>
<para>Under KDE, you can place a small script to start <para>Under KDE, you can place a small script to start
<command>recollindex -m</command> under <command>recollindex -m</command> under
<filename>$HOME/.kde/Autostart</filename>. This will be executed <filename>$HOME/.kde/Autostart</filename>. This will be executed
when the session begins, and the process seems to get a SIGHUP when the session begins.</para>
signal and be terminated when the session ends.</para>
<para>There is a similar mechanism under Gnome (find the session <para>There is a similar mechanism under Gnome (find the session
control tool in the menus and use the "Startup programs" tab). I control tool in the menus and use the "Startup programs" tab).</para>
could find an easy way to stop <command>recollindex</command> at
the end of the session though.</para>
<para>By default, the indexing daemon will write its messages to <para>By default, the indexing daemon will write its messages to
a file inside the configuration directory (this is controlled by a file inside the configuration directory (this is controlled by
@ -478,11 +475,11 @@ RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh stop
when the daemon starts. If the daemon runs permanently, the log when the daemon starts. If the daemon runs permanently, the log
file may grow quite big, depending on the log level.</para> file may grow quite big, depending on the log level.</para>
<para>The real time indexing code is relatively young, and there <para>While it is convenient that data is indexed in real time,
are still a few quirks. File deletions occurring while the repeated indexing can generate a significant load on the system
monitor is not running will not be detected. You'll have to run when files such as email folders change. You probably do not
a normal incremental indexing pass from time to time to purge want to enable it if your system is short on resources. Periodic
the database. There may still be other problems.</para> indexing is adequate in most cases.</para>
</sect1> </sect1>
@ -1364,8 +1361,8 @@ RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh stop
will disable the code for phonetic matching of search will disable the code for phonetic matching of search
terms. <literal>--with-fam</literal> or terms. <literal>--with-fam</literal> or
<literal>--with-inotify</literal> will enable the code for <literal>--with-inotify</literal> will enable the code for
real time indexing. Refer to <literal>configure real time indexing. Inotify support is enabled by default on
--help</literal> output for details.</para> recent Linux systems.</para>
<para>Normal procedure:</para> <para>Normal procedure:</para>
<screen> <screen>