Open Source Projects Europe

[~/somedirectory-with-utf8-txt-files]

[~/somedirectory-with-utf8-txt-files]

defaultcharset = utf-8

defaultcharset = utf-8

.fi

.fi

.LP

.LP

There are three kinds of lines:

.RS

.RS

.IP \(bu

.IP \(bu

Comment or empty

Comment or empty

.IP \(bu

.IP \(bu

Parameter affectation

Parameter affectation

.TP

.TP

.BI "topdirs = "string

.BI "topdirs = "string

Space-separated list of files or

Space-separated list of files or

directories to recursively index. Default to ~ (indexes

directories to recursively index. Default to ~ (indexes

$HOME). You can use symbolic links in the list, they will be followed,

$HOME). You can use symbolic links in the list, they will be followed,

.TP

.TP

.BI "skippedNames = "string

.BI "skippedNames = "string

Files and directories which should be ignored.

White space separated list of wildcard patterns (simple ones, not paths,

White space separated list of wildcard patterns (simple ones, not paths,

must contain no / ), which will be tested against file and directory

must contain no / ), which will be tested against file and directory

names.  The list in the default configuration does not exclude hidden

names.  The list in the default configuration does not exclude hidden

directories (names beginning with a dot), which means that it may index

directories (names beginning with a dot), which means that it may index

quite a few things that you do not want. On the other hand, email user

quite a few things that you do not want. On the other hand, email user

agents like Thunderbird usually store messages in hidden directories, and

agents like Thunderbird usually store messages in hidden directories, and

you probably want this indexed. One possible solution is to have '.*'

'topdirs'.  Not even the file names are indexed for patterns in this

list, see the 'noContentSuffixes' variable for an alternative approach

list, see the 'noContentSuffixes' variable for an alternative approach

which indexes the file names. Can be redefined for any

which indexes the file names. Can be redefined for any

subtree.

subtree.

.TP

.TP

.BI "noContentSuffixes = "string

.BI "noContentSuffixes = "string

Paths we should not go into. Space-separated list of

Paths we should not go into. Space-separated list of

wildcard expressions for filesystem paths. Can contain files and

wildcard expressions for filesystem paths. Can contain files and

directories. The database and configuration directories will

directories. The database and configuration directories will

automatically be added. The expressions are matched using 'fnmatch(3)'

automatically be added. The expressions are matched using 'fnmatch(3)'

with the FNM_PATHNAME flag set by default. This means that '/' characters

with the FNM_PATHNAME flag set by default. This means that '/' characters

must be matched explicitly. You can set 'skippedPathsFnmPathname' to 0

to disable the use of FNM_PATHNAME (meaning that '/*/dir3' will

removable media to remind you that it is a bad idea to have Recoll work

on these (esp. with the monitor: media gets indexed on mount, all data

on these (esp. with the monitor: media gets indexed on mount, all data

gets erased on unmount).  Explicitly adding '/media/xxx' to the topdirs

will override this.

will override this.

.TP

.TP

.BI "skippedPathsFnmPathname = "bool

.BI "skippedPathsFnmPathname = "bool

Set to 0 to

Set to 0 to

override use of FNM_PATHNAME for matching skipped

override use of FNM_PATHNAME for matching skipped

paths.

.TP

.TP

.BI "daemSkippedPaths = "string

.BI "daemSkippedPaths = "string

skippedPaths equivalent specific to

skippedPaths equivalent specific to

real time indexing. This enables having parts of the tree

real time indexing. This enables having parts of the tree

which are initially indexed but not monitored. If daemSkippedPaths is

which are initially indexed but not monitored. If daemSkippedPaths is

.TP

.TP

.BI "zipSkippedNames = "string

.BI "zipSkippedNames = "string

Space-separated list of wildcard expressions for names that should

Space-separated list of wildcard expressions for names that should

be ignored inside zip archives. This is used directly by

be ignored inside zip archives. This is used directly by

the zip handler, and has a function similar to skippedNames, but works

the zip handler, and has a function similar to skippedNames, but works

1.20 and newer. See

1.20 and newer. See

https://bitbucket.org/medoc/recoll/wiki/Filtering%20out%20Zip%20archive%20members

https://bitbucket.org/medoc/recoll/wiki/Filtering%20out%20Zip%20archive%20members

.TP

.TP

.BI "followLinks = "bool

.BI "followLinks = "bool

.BI "systemfilecommand = "string

.BI "systemfilecommand = "string

Command used to guess

Command used to guess

MIME types if the internal methods fails This should be a

MIME types if the internal methods fails This should be a

"file -i" workalike.  The file path will be added as a last parameter to

"file -i" workalike.  The file path will be added as a last parameter to

the command line. 'xdg-mime' works better than the traditional 'file'

the command line. 'xdg-mime' works better than the traditional 'file'

command, and is now the configured default (with a hard-coded fallback

'file')

.TP

.TP

.BI "processwebqueue = "bool

.BI "processwebqueue = "bool

Decide if we process the

Decide if we process the

Web queue. The queue is a directory where the Recoll Web

Web queue. The queue is a directory where the Recoll Web

browser plugins create the copies of visited pages.

browser plugins create the copies of visited pages.

documents with huge amounts of numbers in them, where setting nonumbers

documents with huge amounts of numbers in them, where setting nonumbers

will reduce the index size. This can only be set for a whole index, not

will reduce the index size. This can only be set for a whole index, not

for a subtree.

for a subtree.

.TP

.TP

.BI "dehyphenate = "bool

.BI "dehyphenate = "bool

restoring the previous behaviour.

.TP

.TP

.BI "nocjk = "bool

.BI "nocjk = "bool

Decides if specific East Asian

Decides if specific East Asian

(Chinese Korean Japanese) characters/word splitting is turned

(Chinese Korean Japanese) characters/word splitting is turned

off. This will save a small amount of CPU if you have no CJK

off. This will save a small amount of CPU if you have no CJK

conversion to metadata fields. This probably needs to be

conversion to metadata fields. This probably needs to be

set if testmodifusemtime is set.

set if testmodifusemtime is set.

.TP

.TP

.BI "metadatacmds = "string

.BI "metadatacmds = "string

Define commands to

Define commands to

gather external metadata, e.g. tmsu tags.

There can be several entries, separated by semi-colons, each defining

There can be several entries, separated by semi-colons, each defining

which field name the data goes into and the command to use. Don't forget the

which field name the data goes into and the command to use. Don't forget the

initial semi-colon. All the field names must be different. You can use

initial semi-colon. All the field names must be different. You can use

aliases in the "field" file if necessary.

aliases in the "field" file if necessary.

As a not too pretty hack conceded to convenience, any field name

As a not too pretty hack conceded to convenience, any field name

only errors and warnings. 3 will print information like document updates,

only errors and warnings. 3 will print information like document updates,

4 is quite verbose and 6 very verbose.

4 is quite verbose and 6 very verbose.

.TP

.TP

.BI "logfilename = "fn

.BI "logfilename = "fn

Log file destination. Use 'stderr' (default) to write to the

Log file destination. Use 'stderr' (default) to write to the

console.

.TP

.TP

.BI "idxloglevel = "int

.BI "idxloglevel = "int

Override loglevel for the indexer.

.TP

.TP

.BI "idxlogfilename = "fn

.BI "idxlogfilename = "fn

Override logfilename for the indexer.

.TP

.TP

.BI "daemloglevel = "int

.BI "daemloglevel = "int

Override loglevel for the indexer in real time

Override loglevel for the indexer in real time

mode. The default is to use the idx... values if set, else

mode. The default is to use the idx... values if set, else

the log... values.

the log... values.

.BI "mhmboxquirks = "string

.BI "mhmboxquirks = "string

Enable thunderbird/mozilla-seamonkey mbox format quirks Set this for the directory where the email mbox files are

Enable thunderbird/mozilla-seamonkey mbox format quirks Set this for the directory where the email mbox files are

stored.

stored.

.SH SEE ALSO

.SH SEE ALSO

.PP

recollindex(1) recoll(1)

recollindex(1) recoll(1)