|
a/src/INSTALL |
|
b/src/INSTALL |
|
... |
|
... |
| 264 |
|
264 |
|
| 265 |
* --with-file-command Specify the version of the 'file' command to use
|
265 |
* --with-file-command Specify the version of the 'file' command to use
|
| 266 |
(ie: --with-file-command=/usr/local/bin/file). Can be useful to enable
|
266 |
(ie: --with-file-command=/usr/local/bin/file). Can be useful to enable
|
| 267 |
the gnu version on systems where the native one is bad.
|
267 |
the gnu version on systems where the native one is bad.
|
| 268 |
|
268 |
|
| 269 |
* --without-gui Disable the Qt interface, and auxiliary uses of X11, and
|
269 |
* --disable-qtgui Disable the Qt interface. Will allow building the
|
| 270 |
compile the command line version.
|
270 |
indexer and the command line search program in absence of a Qt
|
|
|
271 |
environment.
|
|
|
272 |
|
|
|
273 |
* --disable-x11mon Disable X11 connection monitoring inside recollindex.
|
|
|
274 |
Together with --disable-qtgui, this allows building recoll without Qt
|
|
|
275 |
and X11.
|
| 271 |
|
276 |
|
| 272 |
* Of course the usual autoconf configure options, like --prefix apply.
|
277 |
* Of course the usual autoconf configure options, like --prefix apply.
|
| 273 |
|
278 |
|
| 274 |
Normal procedure:
|
279 |
Normal procedure:
|
| 275 |
|
280 |
|
| 276 |
cd recoll-xxx
|
281 |
cd recoll-xxx
|
| 277 |
configure
|
282 |
configure
|
| 278 |
make
|
283 |
make
|
| 279 |
(practices usual hardship-repelling invocations)
|
284 |
(practices usual hardship-repelling invocations)
|
| 280 |
|
285 |
|
| 281 |
|
286 |
|
| 282 |
There is little auto-configuration. The configure script will mainly link
|
287 |
There is little auto-configuration. The configure script will mainly link
|
| 283 |
one of the system-specific files in the mk directory to mk/sysconf. If
|
288 |
one of the system-specific files in the mk directory to mk/sysconf. If
|
| 284 |
your system is not known yet, it will tell you as much, and you may want
|
289 |
your system is not known yet, it will tell you as much, and you may want
|
| 285 |
to manually copy and modify one of the existing files (the new file name
|
290 |
to manually copy and modify one of the existing files (the new file name
|
|
... |
|
... |
| 314 |
--------------------------------------------------------------------------
|
319 |
--------------------------------------------------------------------------
|
| 315 |
|
320 |
|
| 316 |
5.4. Configuration overview
|
321 |
5.4. Configuration overview
|
| 317 |
|
322 |
|
| 318 |
Most of the parameters specific to the recoll GUI are set through the
|
323 |
Most of the parameters specific to the recoll GUI are set through the
|
| 319 |
Preferences menu and stored in the standard Qt place ($HOME/.qt/recollrc).
|
324 |
Preferences menu and stored in the standard Qt place
|
| 320 |
You probably do not want to edit this by hand.
|
325 |
($HOME/.config/Recoll.org/recoll.conf). You probably do not want to edit
|
|
|
326 |
this by hand.
|
| 321 |
|
327 |
|
| 322 |
Recoll indexing options are set inside text configuration files located in
|
328 |
Recoll indexing options are set inside text configuration files located in
|
| 323 |
a configuration directory. There can be several such directories, each of
|
329 |
a configuration directory. There can be several such directories, each of
|
| 324 |
which define the parameters for one index.
|
330 |
which define the parameters for one index.
|
| 325 |
|
331 |
|
|
... |
|
... |
| 359 |
# Space-separated list of directories to index.
|
365 |
# Space-separated list of directories to index.
|
| 360 |
topdirs = ~/docs /usr/share/doc
|
366 |
topdirs = ~/docs /usr/share/doc
|
| 361 |
|
367 |
|
| 362 |
[~/somedirectory-with-utf8-txt-files]
|
368 |
[~/somedirectory-with-utf8-txt-files]
|
| 363 |
defaultcharset = utf-8
|
369 |
defaultcharset = utf-8
|
| 364 |
|
370 |
|
| 365 |
|
371 |
|
| 366 |
There are three kinds of lines:
|
372 |
There are three kinds of lines:
|
| 367 |
|
373 |
|
| 368 |
* Comment (starts with #) or empty.
|
374 |
* Comment (starts with #) or empty.
|
| 369 |
|
375 |
|
|
... |
|
... |
| 414 |
A space-separated list of patterns for names of files or
|
420 |
A space-separated list of patterns for names of files or
|
| 415 |
directories that should be completely ignored. The list defined in
|
421 |
directories that should be completely ignored. The list defined in
|
| 416 |
the default file is:
|
422 |
the default file is:
|
| 417 |
|
423 |
|
| 418 |
skippedNames = #* bin CVS Cache cache* caughtspam tmp .thumbnails .svn \
|
424 |
skippedNames = #* bin CVS Cache cache* caughtspam tmp .thumbnails .svn \
|
| 419 |
*~ .beagle .git .hg .bzr loop.ps .xsession-errors \
|
425 |
*~ .beagle .git .hg .bzr loop.ps .xsession-errors \
|
| 420 |
.recoll* xapiandb recollrc recoll.conf
|
426 |
.recoll* xapiandb recollrc recoll.conf
|
| 421 |
|
427 |
|
| 422 |
The list can be redefined at any sub-directory in the indexed
|
428 |
The list can be redefined at any sub-directory in the indexed
|
| 423 |
area.
|
429 |
area.
|
| 424 |
|
430 |
|
| 425 |
The top-level directories are not affected by this list (that is,
|
431 |
The top-level directories are not affected by this list (that is,
|
|
... |
|
... |
| 449 |
indexed at startup, but not monitored.
|
455 |
indexed at startup, but not monitored.
|
| 450 |
|
456 |
|
| 451 |
Example of use for skipping text files only in a specific
|
457 |
Example of use for skipping text files only in a specific
|
| 452 |
directory:
|
458 |
directory:
|
| 453 |
|
459 |
|
| 454 |
skippedPaths = ~/somedir/*.txt
|
460 |
skippedPaths = ~/somedir/..txt
|
| 455 |
|
461 |
|
|
|
462 |
|
|
|
463 |
skippedPathsFnmPathname
|
|
|
464 |
|
|
|
465 |
The values in the *skippedPaths variables are matched by default
|
|
|
466 |
with fnmatch(3), with the FNM_PATHNAME and FNM_LEADING_DIR flags.
|
|
|
467 |
This means that '/' characters must be matched explicitely. You
|
|
|
468 |
can set skippedPathsFnmPathname to 0 to disable the use of
|
|
|
469 |
FNM_PATHNAME (meaning that /*/dir3 will match /dir1/dir2/dir3).
|
| 456 |
|
470 |
|
| 457 |
followLinks
|
471 |
followLinks
|
| 458 |
|
472 |
|
| 459 |
Specifies if the indexer should follow symbolic links while
|
473 |
Specifies if the indexer should follow symbolic links while
|
| 460 |
walking the file tree. The default is to ignore symbolic links to
|
474 |
walking the file tree. The default is to ignore symbolic links to
|
|
... |
|
... |
| 594 |
needed when the index is initialized. If this is not an absolute
|
608 |
needed when the index is initialized. If this is not an absolute
|
| 595 |
path, it will be interpreted relative to the configuration
|
609 |
path, it will be interpreted relative to the configuration
|
| 596 |
directory. The value can have embedded spaces but starting or
|
610 |
directory. The value can have embedded spaces but starting or
|
| 597 |
trailing spaces will be trimmed. You cannot use quotes here.
|
611 |
trailing spaces will be trimmed. You cannot use quotes here.
|
| 598 |
|
612 |
|
|
|
613 |
idxstatusfile
|
|
|
614 |
|
|
|
615 |
The name of the scratch file where the indexer process updates its
|
|
|
616 |
status. Default: idxstatus.txt inside the configuration directory.
|
|
|
617 |
|
| 599 |
maxfsoccuppc
|
618 |
maxfsoccuppc
|
| 600 |
|
619 |
|
| 601 |
Maximum file system occupation before we stop indexing. The value
|
620 |
Maximum file system occupation before we stop indexing. The value
|
| 602 |
is a percentage, corresponding to what the "Capacity" df output
|
621 |
is a percentage, corresponding to what the "Capacity" df output
|
| 603 |
column shows. The default value is 0, meaning no checking.
|
622 |
column shows. The default value is 0, meaning no checking.
|
|
... |
|
... |
| 657 |
space-separated list, each entry being a pattern and a time in
|
676 |
space-separated list, each entry being a pattern and a time in
|
| 658 |
seconds, separated by a colon. You can use double quotes if a path
|
677 |
seconds, separated by a colon. You can use double quotes if a path
|
| 659 |
entry contains white space. Example:
|
678 |
entry contains white space. Example:
|
| 660 |
|
679 |
|
| 661 |
mondelaypatterns = *.log:20 "this one has spaces*:10"
|
680 |
mondelaypatterns = *.log:20 "this one has spaces*:10"
|
| 662 |
|
681 |
|
| 663 |
|
682 |
|
| 664 |
monixinterval
|
683 |
monixinterval
|
| 665 |
|
684 |
|
| 666 |
Minimum interval (seconds) for processing the indexing queue. The
|
685 |
Minimum interval (seconds) for processing the indexing queue. The
|
| 667 |
real time monitor does not process each event when it comes in,
|
686 |
real time monitor does not process each event when it comes in,
|
|
... |
|
... |
| 888 |
|
907 |
|
| 889 |
.blob = application/x-blobapp
|
908 |
.blob = application/x-blobapp
|
| 890 |
|
909 |
|
| 891 |
Note that the mime type is made up here, and you could call it
|
910 |
Note that the mime type is made up here, and you could call it
|
| 892 |
diesel/oil just the same.
|
911 |
diesel/oil just the same.
|
| 893 |
|
|
|
| 894 |
* In $RECOLL_CONFDIR/mimeview under the [view] section, add:
|
912 |
* In $RECOLL_CONFDIR/mimeview under the [view] section, add:
|
| 895 |
|
913 |
|
| 896 |
application/x-blobapp = blobviewer %f
|
914 |
application/x-blobapp = blobviewer %f
|
| 897 |
|
915 |
|
| 898 |
We are supposing that blobviewer wants a file name parameter here, you
|
916 |
We are supposing that blobviewer wants a file name parameter here, you
|