|
a/src/INSTALL |
|
b/src/INSTALL |
|
... |
|
... |
| 292 |
one of the system-specific files in the mk directory to mk/sysconf. If
|
292 |
one of the system-specific files in the mk directory to mk/sysconf. If
|
| 293 |
your system is not known yet, it will tell you as much, and you may want
|
293 |
your system is not known yet, it will tell you as much, and you may want
|
| 294 |
to manually copy and modify one of the existing files (the new file name
|
294 |
to manually copy and modify one of the existing files (the new file name
|
| 295 |
should be the output of uname -s).
|
295 |
should be the output of uname -s).
|
| 296 |
|
296 |
|
|
|
297 |
5.3.2.1. Building on Solaris
|
|
|
298 |
|
|
|
299 |
We did not test building the GUI on Solaris for recent versions. You will
|
|
|
300 |
need at least Qt 4.4. There are some hints on an old web site page, they
|
|
|
301 |
may still be valid.
|
|
|
302 |
|
|
|
303 |
Someone did test the 1.19 indexer and Python module build, they do work,
|
|
|
304 |
with a few minor glitches. Be sure to use GNU make and install.
|
|
|
305 |
|
| 297 |
5.3.3. Installation
|
306 |
5.3.3. Installation
|
| 298 |
|
307 |
|
| 299 |
Either type make install or execute recollinstall prefix, in the root of
|
308 |
Either type make install or execute recollinstall prefix, in the root of
|
| 300 |
the source tree. This will copy the commands to prefix/bin and the sample
|
309 |
the source tree. This will copy the commands to prefix/bin and the sample
|
| 301 |
configuration files, scripts and other shared data to prefix/share/recoll.
|
310 |
configuration files, scripts and other shared data to prefix/share/recoll.
|
|
... |
|
... |
| 340 |
|
349 |
|
| 341 |
The most accurate documentation for the configuration parameters is given
|
350 |
The most accurate documentation for the configuration parameters is given
|
| 342 |
by comments inside the default files, and we will just give a general
|
351 |
by comments inside the default files, and we will just give a general
|
| 343 |
overview here.
|
352 |
overview here.
|
| 344 |
|
353 |
|
| 345 |
For each index, there are two sets of configuration files. System-wide
|
354 |
By default, for each index, there are two sets of configuration files.
|
| 346 |
configuration files are kept in a directory named like
|
355 |
System-wide configuration files are kept in a directory named like
|
| 347 |
/usr/[local/]share/recoll/examples, and define default values, shared by
|
356 |
/usr/[local/]share/recoll/examples, and define default values, shared by
|
| 348 |
all indexes. For each index, a parallel set of files defines the
|
357 |
all indexes. For each index, a parallel set of files defines the
|
| 349 |
customized parameters.
|
358 |
customized parameters.
|
|
|
359 |
|
|
|
360 |
In addition (as of Recoll version 1.19.7), it is possible to specify two
|
|
|
361 |
additional configuration directories which will be stacked before and
|
|
|
362 |
after the user configuration directory. These are defined by the
|
|
|
363 |
RECOLL_CONFTOP and RECOLL_CONFMID environment variables. Values from
|
|
|
364 |
configuration files inside the top directory will override user ones,
|
|
|
365 |
values from configuration files inside the middle directory will override
|
|
|
366 |
system ones and be overriden by user ones. These two variables may be of
|
|
|
367 |
use to applications which augment Recoll functionality, and need to add
|
|
|
368 |
configuration data without disturbing the user's files. Please note that
|
|
|
369 |
the two, currently single, values will probably be interpreted as
|
|
|
370 |
colon-separated lists in the future: do not use colon characters inside
|
|
|
371 |
the directory paths.
|
| 350 |
|
372 |
|
| 351 |
The default location of the configuration is the .recoll directory in your
|
373 |
The default location of the configuration is the .recoll directory in your
|
| 352 |
home. Most people will only use this directory.
|
374 |
home. Most people will only use this directory.
|
| 353 |
|
375 |
|
| 354 |
This location can be changed, or others can be added with the
|
376 |
This location can be changed, or others can be added with the
|
|
... |
|
... |
| 409 |
handle multiple encodings in a single file. In this relatively
|
431 |
handle multiple encodings in a single file. In this relatively
|
| 410 |
unlikely case, you can edit the configuration file as two separate
|
432 |
unlikely case, you can edit the configuration file as two separate
|
| 411 |
text files with appropriate encodings, and concatenate them to create
|
433 |
text files with appropriate encodings, and concatenate them to create
|
| 412 |
the complete configuration.
|
434 |
the complete configuration.
|
| 413 |
|
435 |
|
| 414 |
5.4.1. Main configuration file
|
436 |
5.4.1. The main configuration file, recoll.conf
|
| 415 |
|
437 |
|
| 416 |
recoll.conf is the main configuration file. It defines things like what to
|
438 |
recoll.conf is the main configuration file. It defines things like what to
|
| 417 |
index (top directories and things to ignore), and the default character
|
439 |
index (top directories and things to ignore), and the default character
|
| 418 |
set to use for document types which do not specify it internally.
|
440 |
set to use for document types which do not specify it internally.
|
| 419 |
|
441 |
|
|
... |
|
... |
| 435 |
list. See the followLinks option about following symbolic links
|
457 |
list. See the followLinks option about following symbolic links
|
| 436 |
found under the top elements (not followed by default).
|
458 |
found under the top elements (not followed by default).
|
| 437 |
|
459 |
|
| 438 |
skippedNames
|
460 |
skippedNames
|
| 439 |
|
461 |
|
| 440 |
A space-separated list of patterns for names of files or
|
462 |
A space-separated list of wilcard patterns for names of files or
|
| 441 |
directories that should be completely ignored. The list defined in
|
463 |
directories that should be completely ignored. The list defined in
|
| 442 |
the default file is:
|
464 |
the default file is:
|
| 443 |
|
465 |
|
| 444 |
skippedNames = #* bin CVS Cache cache* caughtspam tmp .thumbnails .svn \
|
466 |
skippedNames = #* bin CVS Cache cache* caughtspam tmp .thumbnails .svn \
|
| 445 |
*~ .beagle .git .hg .bzr loop.ps .xsession-errors \
|
467 |
*~ .beagle .git .hg .bzr loop.ps .xsession-errors \
|
|
... |
|
... |
| 485 |
The values in the *skippedPaths variables are matched by default
|
507 |
The values in the *skippedPaths variables are matched by default
|
| 486 |
with fnmatch(3), with the FNM_PATHNAME and FNM_LEADING_DIR flags.
|
508 |
with fnmatch(3), with the FNM_PATHNAME and FNM_LEADING_DIR flags.
|
| 487 |
This means that '/' characters must be matched explicitely. You
|
509 |
This means that '/' characters must be matched explicitely. You
|
| 488 |
can set skippedPathsFnmPathname to 0 to disable the use of
|
510 |
can set skippedPathsFnmPathname to 0 to disable the use of
|
| 489 |
FNM_PATHNAME (meaning that /*/dir3 will match /dir1/dir2/dir3).
|
511 |
FNM_PATHNAME (meaning that /*/dir3 will match /dir1/dir2/dir3).
|
|
|
512 |
|
|
|
513 |
zipSkippedNames
|
|
|
514 |
|
|
|
515 |
A space-separated list of patterns for names of files or
|
|
|
516 |
directories that should be ignored inside zip archives. This is
|
|
|
517 |
used directly by the zip filter, and has a function similar to
|
|
|
518 |
skippedNames, but works independantly. Can be redefined for
|
|
|
519 |
filesystem subdirectories. For versions up to 1.19, you will need
|
|
|
520 |
to update the Zip filter and install a supplementary Python
|
|
|
521 |
module. The details are described on the Recoll wiki.
|
| 490 |
|
522 |
|
| 491 |
followLinks
|
523 |
followLinks
|
| 492 |
|
524 |
|
| 493 |
Specifies if the indexer should follow symbolic links while
|
525 |
Specifies if the indexer should follow symbolic links while
|
| 494 |
walking the file tree. The default is to ignore symbolic links to
|
526 |
walking the file tree. The default is to ignore symbolic links to
|
|
... |
|
... |
| 677 |
character, which there is currently no way to escape. Also note
|
709 |
character, which there is currently no way to escape. Also note
|
| 678 |
the initial semi-colon. Example: localfields= ;rclaptg=gnus;other
|
710 |
the initial semi-colon. Example: localfields= ;rclaptg=gnus;other
|
| 679 |
= val, then select specifier viewer with mimetype|tag=... in
|
711 |
= val, then select specifier viewer with mimetype|tag=... in
|
| 680 |
mimeview.
|
712 |
mimeview.
|
| 681 |
|
713 |
|
|
|
714 |
noxattrfields
|
|
|
715 |
|
|
|
716 |
Recoll versions 1.19 and later automatically translate file
|
|
|
717 |
extended attributes into document fields (to be processed
|
|
|
718 |
according to the parameters from the fields file). Setting this
|
|
|
719 |
variable to 1 will disable the behaviour.
|
|
|
720 |
|
| 682 |
metadatacmds
|
721 |
metadatacmds
|
| 683 |
|
722 |
|
| 684 |
This allows executing external commands for each file and storing
|
723 |
This allows executing external commands for each file and storing
|
| 685 |
the output in a Recoll field. This could be used for example to
|
724 |
the output in Recoll document fields. This could be used for
|
| 686 |
index external tag data. The value is a list of field names and
|
725 |
example to index external tag data. The value is a list of field
|
| 687 |
commands, don't forget an initial semi-colon. Example:
|
726 |
names and commands, don't forget an initial semi-colon. Example:
|
| 688 |
|
727 |
|
| 689 |
[/some/area/of/the/fs]
|
728 |
[/some/area/of/the/fs]
|
| 690 |
metadatacmds = ; tags = tmsu tags %f; otherfield = somecmd -xx %f
|
729 |
metadatacmds = ; tags = tmsu tags %f; otherfield = somecmd -xx %f
|
| 691 |
|
730 |
|
|
|
731 |
|
|
|
732 |
As a specially disgusting hack brought by Recoll 1.19.7, if a
|
|
|
733 |
"field name" begins with rclmulti, the data returned by the
|
|
|
734 |
command is expected to contain multiple field values, in
|
|
|
735 |
configuration file format. This allows setting several fields by
|
|
|
736 |
executing a single command. Example:
|
|
|
737 |
|
|
|
738 |
metadatacmds = ; rclmulti1 = somecmd %f
|
|
|
739 |
|
|
|
740 |
|
|
|
741 |
If somecmd returns data in the form of:
|
|
|
742 |
|
|
|
743 |
field1 = value1
|
|
|
744 |
field2 = value for field2
|
|
|
745 |
|
|
|
746 |
|
|
|
747 |
field1 and field2 will be set inside the document metadata.
|
| 692 |
|
748 |
|
| 693 |
5.4.1.3. Parameters affecting where and how we store things:
|
749 |
5.4.1.3. Parameters affecting where and how we store things:
|
| 694 |
|
750 |
|
| 695 |
dbdir
|
751 |
dbdir
|
| 696 |
|
752 |
|
|
... |
|
... |
| 744 |
usage also depends on average document size. The default value is
|
800 |
usage also depends on average document size. The default value is
|
| 745 |
10, and it is probably a bit low. If your system usually has free
|
801 |
10, and it is probably a bit low. If your system usually has free
|
| 746 |
memory, you can try higher values between 20 and 80. In my
|
802 |
memory, you can try higher values between 20 and 80. In my
|
| 747 |
experience, values beyond 100 are always counterproductive.
|
803 |
experience, values beyond 100 are always counterproductive.
|
| 748 |
|
804 |
|
| 749 |
5.4.1.4. Indexing parallelism configuration
|
805 |
5.4.1.4. Parameters affecting multithread processing
|
| 750 |
|
806 |
|
| 751 |
The Recoll indexing process recollindex can use multiple threads to speed
|
807 |
The Recoll indexing process recollindex can use multiple threads to speed
|
| 752 |
up indexing on multiprocessor systems. The work done to index files is
|
808 |
up indexing on multiprocessor systems. The work done to index files is
|
| 753 |
divided in several stages and some of the stages can be executed by
|
809 |
divided in several stages and some of the stages can be executed by
|
| 754 |
multiple threads. The stages are:
|
810 |
multiple threads. The stages are:
|
|
... |
|
... |
| 772 |
integer values). If a value of -1 is used for a given stage, no
|
828 |
integer values). If a value of -1 is used for a given stage, no
|
| 773 |
queue is used, and the thread will go on performing the next
|
829 |
queue is used, and the thread will go on performing the next
|
| 774 |
stage. In practise, deep queues have not been shown to increase
|
830 |
stage. In practise, deep queues have not been shown to increase
|
| 775 |
performance. A value of 0 for the first queue tells Recoll to
|
831 |
performance. A value of 0 for the first queue tells Recoll to
|
| 776 |
perform autoconfiguration (no need for the two other values in
|
832 |
perform autoconfiguration (no need for the two other values in
|
| 777 |
this case)- this is the default configuration.
|
833 |
this case) - this is the default configuration.
|
| 778 |
|
834 |
|
| 779 |
thrTCounts
|
835 |
thrTCounts
|
| 780 |
|
836 |
|
| 781 |
This defines the number of threads used for each stage. If a value
|
837 |
This defines the number of threads used for each stage. If a value
|
| 782 |
of -1 is used for one of the queue depths, the corresponding
|
838 |
of -1 is used for one of the queue depths, the corresponding
|
|
... |
|
... |
| 801 |
sequentially), so the previous approach is preferred. YMMV... The 2 last
|
857 |
sequentially), so the previous approach is preferred. YMMV... The 2 last
|
| 802 |
values for thrTCounts are ignored.
|
858 |
values for thrTCounts are ignored.
|
| 803 |
|
859 |
|
| 804 |
thrQSizes = 2 -1 -1
|
860 |
thrQSizes = 2 -1 -1
|
| 805 |
thrTCounts = 6 1 1
|
861 |
thrTCounts = 6 1 1
|
|
|
862 |
|
|
|
863 |
The following example would disable multithreading. Indexing will be
|
|
|
864 |
performed by a single thread.
|
|
|
865 |
|
|
|
866 |
thrQSizes = -1 -1 -1
|
| 806 |
|
867 |
|
| 807 |
5.4.1.5. Miscellaneous parameters:
|
868 |
5.4.1.5. Miscellaneous parameters:
|
| 808 |
|
869 |
|
| 809 |
autodiacsens
|
870 |
autodiacsens
|
| 810 |
|
871 |
|