|
a/src/README |
|
b/src/README |
|
... |
|
... |
| 384 |
|
384 |
|
| 385 |
2.5. Real time indexing
|
385 |
2.5. Real time indexing
|
| 386 |
|
386 |
|
| 387 |
Real time monitoring/indexing is performed by starting the recollindex -m
|
387 |
Real time monitoring/indexing is performed by starting the recollindex -m
|
| 388 |
command. With this option, recollindex will detach from the terminal and
|
388 |
command. With this option, recollindex will detach from the terminal and
|
| 389 |
become a daemon, forever monitoring file changes and updating the index.
|
389 |
become a daemon, permanently monitoring file changes and updating the
|
|
|
390 |
index.
|
| 390 |
|
391 |
|
| 391 |
The package must have been configured with option --with-fam or
|
392 |
The real time indexing support can be customised during package
|
| 392 |
--with-inotify for the monitoring code and option to be enabled in
|
393 |
configuration with the --with[out]-fam or --with[out]-inotify options. The
|
| 393 |
recollindex. This is not currently the default.
|
394 |
default is currently to include inotify monitoring on systems that support
|
|
|
395 |
it.
|
| 394 |
|
396 |
|
| 395 |
The rclmon.sh script can be used to easily start and stop the daemon. It
|
397 |
The rclmon.sh script can be used to easily start and stop the daemon. It
|
| 396 |
can be found in the examples directory (typically
|
398 |
can be found in the examples directory (typically
|
| 397 |
/usr/local/[share/]recoll/examples).
|
399 |
/usr/local/[share/]recoll/examples).
|
| 398 |
|
400 |
|
| 399 |
Starting and stopping the daemon could be performed, for example, as part
|
401 |
Starting the daemon is normally performed as part of the user session
|
| 400 |
of the user session script. For example, my out of fashion xdm-based
|
402 |
script. For example, my out of fashion xdm-based session has a .xsession
|
| 401 |
session has a .xsession script with the following lines at the end:
|
403 |
script with the following lines at the end:
|
| 402 |
|
404 |
|
| 403 |
recollconf=$HOME/.recoll-home
|
405 |
recollconf=$HOME/.recoll-home
|
| 404 |
recolldata=/usr/local/share/recoll
|
406 |
recolldata=/usr/local/share/recoll
|
| 405 |
RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh start
|
407 |
RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh start
|
| 406 |
|
408 |
|
| 407 |
fvwm
|
409 |
fvwm
|
| 408 |
|
|
|
| 409 |
RECOLL_CONFDIR=$recollconf $recolldata/examples/rclmon.sh stop
|
|
|
| 410 |
|
410 |
|
| 411 |
The indexing daemon gets started, then the window manager, for which the
|
411 |
The indexing daemon gets started, then the window manager, for which the
|
| 412 |
session waits. When the window manager exits, the indexing daemon is
|
412 |
session waits.
|
| 413 |
stopped, then the session ends (at script exit). This should be adjusted
|
413 |
|
| 414 |
for your flavour of session management, and of course, there are other
|
414 |
By default the indexing daemon will monitor the state of the X11 session,
|
| 415 |
possibilities.
|
415 |
and exit when it finishes, it is not necessary to kill it explicitely.
|
|
|
416 |
(The X11 server monitoring can be disabled with option -x to recollindex).
|
| 416 |
|
417 |
|
| 417 |
Under KDE, you can place a small script to start recollindex -m under
|
418 |
Under KDE, you can place a small script to start recollindex -m under
|
| 418 |
$HOME/.kde/Autostart. This will be executed when the session begins, and
|
419 |
$HOME/.kde/Autostart. This will be executed when the session begins.
|
| 419 |
the process seems to get a SIGHUP signal and be terminated when the
|
|
|
| 420 |
session ends.
|
|
|
| 421 |
|
420 |
|
| 422 |
There is a similar mechanism under Gnome (find the session control tool in
|
421 |
There is a similar mechanism under Gnome (find the session control tool in
|
| 423 |
the menus and use the "Startup programs" tab). I could find an easy way to
|
422 |
the menus and use the "Startup programs" tab).
|
| 424 |
stop recollindex at the end of the session though.
|
|
|
| 425 |
|
423 |
|
| 426 |
By default, the indexing daemon will write its messages to a file inside
|
424 |
By default, the indexing daemon will write its messages to a file inside
|
| 427 |
the configuration directory (this is controlled by the daemlogfilename and
|
425 |
the configuration directory (this is controlled by the daemlogfilename and
|
| 428 |
daemloglevel configuration parameters). You may want to change this. Also
|
426 |
daemloglevel configuration parameters). You may want to change this. Also
|
| 429 |
the log file will only be truncated when the daemon starts. If the daemon
|
427 |
the log file will only be truncated when the daemon starts. If the daemon
|
| 430 |
runs permanently, the log file may grow quite big, depending on the log
|
428 |
runs permanently, the log file may grow quite big, depending on the log
|
| 431 |
level.
|
429 |
level.
|
| 432 |
|
430 |
|
| 433 |
The real time indexing code is relatively young, and there are still a few
|
431 |
While it is convenient that data is indexed in real time, repeated
|
| 434 |
quirks. File deletions occurring while the monitor is not running will not
|
432 |
indexing can generate a significant load on the system when files such as
|
| 435 |
be detected. You'll have to run a normal incremental indexing pass from
|
433 |
email folders change. You probably do not want to enable it if your system
|
| 436 |
time to time to purge the database. There may still be other problems.
|
434 |
is short on resources. Periodic indexing is adequate in most cases.
|
| 437 |
|
435 |
|
| 438 |
----------------------------------------------------------------------
|
436 |
----------------------------------------------------------------------
|
| 439 |
|
437 |
|
| 440 |
Chapter 3. Search
|
438 |
Chapter 3. Search
|
| 441 |
|
439 |
|
|
... |
|
... |
| 538 |
|
536 |
|
| 539 |
* Copy Url
|
537 |
* Copy Url
|
| 540 |
|
538 |
|
| 541 |
* Find similar
|
539 |
* Find similar
|
| 542 |
|
540 |
|
|
|
541 |
* Find similar
|
|
|
542 |
|
|
|
543 |
* Parent document
|
|
|
544 |
|
| 543 |
The Preview and Edit entries do the same thing as the corresponding links.
|
545 |
The Preview and Edit entries do the same thing as the corresponding links.
|
| 544 |
The two following entries will copy either an URL or the file path to the
|
546 |
The two following entries will copy either an URL or the file path to the
|
| 545 |
clipboard, for pasting into another application.
|
547 |
clipboard, for pasting into another application.
|
| 546 |
|
548 |
|
| 547 |
The Find similar entry will select a number of relevant term from the
|
549 |
The Find similar entry will select a number of relevant term from the
|
| 548 |
current document and enter them into the simple search field. You can then
|
550 |
current document and enter them into the simple search field. You can then
|
| 549 |
start a simple search, with a good chance of finding documents related to
|
551 |
start a simple search, with a good chance of finding documents related to
|
| 550 |
the current result.
|
552 |
the current result.
|
|
|
553 |
|
|
|
554 |
The Copy File Name and Copy Url copy the relevant data to the clipboard,
|
|
|
555 |
for later pasting.
|
|
|
556 |
|
|
|
557 |
The Parent document entry will appear for documents which are not actually
|
|
|
558 |
files but are part of, or attached to, a higher level document. This entry
|
|
|
559 |
is mainly useful for email attachments and permits viewing the message to
|
|
|
560 |
which the document is attached. Note that the entry will also appear for
|
|
|
561 |
an email which is part of an mbox folder file, but that you can't actually
|
|
|
562 |
visualize the folder (there will be an error dialog if you try). Recoll is
|
|
|
563 |
unfortunately not yet smart enough to disable the entry in this case.
|
| 551 |
|
564 |
|
| 552 |
----------------------------------------------------------------------
|
565 |
----------------------------------------------------------------------
|
| 553 |
|
566 |
|
| 554 |
3.3. The preview window
|
567 |
3.3. The preview window
|
| 555 |
|
568 |
|
|
... |
|
... |
| 1041 |
On many Linux systems, QTDIR is set by the login scripts, and QMAKESPECS
|
1054 |
On many Linux systems, QTDIR is set by the login scripts, and QMAKESPECS
|
| 1042 |
is not needed because there is a default link in mkspecs/.
|
1055 |
is not needed because there is a default link in mkspecs/.
|
| 1043 |
|
1056 |
|
| 1044 |
Configure options: --without-aspell will disable the code for phonetic
|
1057 |
Configure options: --without-aspell will disable the code for phonetic
|
| 1045 |
matching of search terms. --with-fam or --with-inotify will enable the
|
1058 |
matching of search terms. --with-fam or --with-inotify will enable the
|
| 1046 |
code for real time indexing. Refer to configure --help output for details.
|
1059 |
code for real time indexing. Inotify support is enabled by default on
|
|
|
1060 |
recent Linux systems.
|
| 1047 |
|
1061 |
|
| 1048 |
Normal procedure:
|
1062 |
Normal procedure:
|
| 1049 |
|
1063 |
|
| 1050 |
cd recoll-xxx
|
1064 |
cd recoll-xxx
|
| 1051 |
configure
|
1065 |
configure
|