|
a/src/doc/man/recoll.conf.5 |
|
b/src/doc/man/recoll.conf.5 |
| 1 |
.\" $Id: recoll.conf.5,v 1.5 2007-07-13 10:18:49 dockes Exp $ (C) 2005 J.F.Dockes\$
|
1 |
.\" $Id: recoll.conf.5,v 1.5 2007-07-13 10:18:49 dockes Exp $ (C) 2005 J.F.Dockes\$
|
| 2 |
.TH RECOLL.CONF 5 "8 January 2006"
|
2 |
.TH RECOLL.CONF 5 "8 January 2006"
|
| 3 |
.SH NAME
|
3 |
.SH NAME
|
| 4 |
recoll.conf \- main personal configuration file for Recoll
|
4 |
recoll.conf \- main personal configuration file for Recoll
|
| 5 |
.SH DESCRIPTION
|
5 |
.SH DESCRIPTION
|
| 6 |
This file defines the indexation configuration for the full-text search
|
6 |
This file defines the indexation configuration for the Recoll full-text search
|
| 7 |
system Recoll.
|
7 |
system.
|
| 8 |
.LP
|
8 |
.LP
|
| 9 |
The system-wide configuration file is normally located inside
|
9 |
The system-wide configuration file is normally located inside
|
| 10 |
/usr/[local]/share/recoll/examples. Any parameter set in the common file
|
10 |
/usr/[local]/share/recoll/examples. Any parameter set in the common file
|
| 11 |
may be overriden by setting it in the personal configuration file, by default:
|
11 |
may be overriden by setting it in the personal configuration file, by default:
|
| 12 |
.IR $HOME/.recoll/recoll.conf
|
12 |
.IR $HOME/.recoll/recoll.conf
|
|
... |
|
... |
| 56 |
.SH OPTIONS
|
56 |
.SH OPTIONS
|
| 57 |
.TP
|
57 |
.TP
|
| 58 |
.BI "topdirs = " directories
|
58 |
.BI "topdirs = " directories
|
| 59 |
Specifies the list of directories to index (recursively).
|
59 |
Specifies the list of directories to index (recursively).
|
| 60 |
.TP
|
60 |
.TP
|
|
|
61 |
.BI "dbdir = " directory
|
|
|
62 |
The name of the Xapian database directory. It will be created if needed
|
|
|
63 |
when the database is initialized. If this is not an absolute pathname, it
|
|
|
64 |
will be taken relative to the configuration directory.
|
|
|
65 |
.TP
|
| 61 |
.BI "skippedNames = " patterns
|
66 |
.BI "skippedNames = " patterns
|
| 62 |
A space-separated list of patterns for names of files or directories that
|
67 |
A space-separated list of patterns for names of files or directories that
|
| 63 |
should be completely ignored. The list defined in the default file is:
|
68 |
should be completely ignored. The list defined in the default file is:
|
| 64 |
.sp
|
69 |
.sp
|
| 65 |
.nf
|
70 |
.nf
|
|
... |
|
... |
| 74 |
A space-separated list of patterns for paths the indexer should not descend
|
79 |
A space-separated list of patterns for paths the indexer should not descend
|
| 75 |
into. Together with topdirs, this allows pruning the indexed tree to one's
|
80 |
into. Together with topdirs, this allows pruning the indexed tree to one's
|
| 76 |
content. daemSkippedPaths can be used to define a specific value for the
|
81 |
content. daemSkippedPaths can be used to define a specific value for the
|
| 77 |
real time indexing monitor.
|
82 |
real time indexing monitor.
|
| 78 |
.TP
|
83 |
.TP
|
|
|
84 |
.BI "followLinks = " boolean
|
|
|
85 |
Specifies if the indexer should follow
|
|
|
86 |
symbolic links while walking the file tree. The default is
|
|
|
87 |
to ignore symbolic links to avoid multiple indexing of
|
|
|
88 |
linked files. No effort is made to avoid duplication when
|
|
|
89 |
this option is set to true. This option can be set
|
|
|
90 |
individually for each of the
|
|
|
91 |
.I topdirs
|
|
|
92 |
members by using sections. It can not be changed below the
|
|
|
93 |
.I topdirs
|
|
|
94 |
level.
|
|
|
95 |
.TP
|
| 79 |
.BI "loglevel = " value
|
96 |
.BI "loglevel = " value
|
| 80 |
Verbosity level for recoll and recollindex. A value of 4 lists quite a lot of
|
97 |
Verbosity level for recoll and recollindex. A value of 4 lists quite a lot of
|
| 81 |
debug/information messages. 3 lists only errors.
|
98 |
debug/information messages. 3 lists only errors.
|
| 82 |
.B daemloglevel
|
99 |
.B daemloglevel
|
| 83 |
can be used to specify a different value for the real-time indexing daemon.
|
100 |
can be used to specify a different value for the real-time indexing daemon.
|
| 84 |
.TP
|
101 |
.TP
|
| 85 |
.BI "logfilename = " file
|
102 |
.BI "logfilename = " file
|
| 86 |
Where should the messages go. 'stderr' can be used as a special value.
|
103 |
Where should the messages go. 'stderr' can be used as a special value.
|
| 87 |
.B daemlogfilename
|
104 |
.B daemlogfilename
|
| 88 |
can be used to specify a different value for the real-time indexing daemon.
|
105 |
can be used to specify a different value for the real-time indexing daemon.
|
| 89 |
.TP
|
|
|
| 90 |
.BI "dbdir = " directory
|
|
|
| 91 |
The name of the Xapian database directory. It will be created if needed
|
|
|
| 92 |
when the database is initialized. If this is not an absolute pathname, it
|
|
|
| 93 |
will be taken relative to the configuration directory.
|
|
|
| 94 |
.TP
|
106 |
.TP
|
| 95 |
.BI "indexstemminglanguages = " languages
|
107 |
.BI "indexstemminglanguages = " languages
|
| 96 |
A list of languages for which the stem expansion databases will be
|
108 |
A list of languages for which the stem expansion databases will be
|
| 97 |
built. See recollindex(1) for possible values.
|
109 |
built. See recollindex(1) for possible values.
|
| 98 |
.TP
|
110 |
.TP
|
|
... |
|
... |
| 129 |
.TP
|
141 |
.TP
|
| 130 |
.BI "guesscharset = " boolean
|
142 |
.BI "guesscharset = " boolean
|
| 131 |
Try to guess the character set of files if no internal value is available
|
143 |
Try to guess the character set of files if no internal value is available
|
| 132 |
(ie: for plain text files). This does not work well in general, and should
|
144 |
(ie: for plain text files). This does not work well in general, and should
|
| 133 |
probably not be used.
|
145 |
probably not be used.
|
| 134 |
.TP
|
|
|
| 135 |
.BI "indexallfilenames = " boolean
|
|
|
| 136 |
Recoll indexes file names into a special section of the database to allow
|
|
|
| 137 |
specific file names searches using wild cards. This parameter decides if
|
|
|
| 138 |
file name indexing is performed only for files with mime types that would
|
|
|
| 139 |
qualify them for full text indexation, or for all files inside
|
|
|
| 140 |
the selected subtrees, independant of mime type.
|
|
|
| 141 |
.TP
|
146 |
.TP
|
| 142 |
.BI "usesystemfilecommand = " boolean
|
147 |
.BI "usesystemfilecommand = " boolean
|
| 143 |
Decide if we use the
|
148 |
Decide if we use the
|
| 144 |
.B "file -i"
|
149 |
.B "file -i"
|
| 145 |
system command as a final step for determining the mime type for a file
|
150 |
system command as a final step for determining the mime type for a file
|
| 146 |
(the main procedure uses suffix associations as defined in the
|
151 |
(the main procedure uses suffix associations as defined in the
|
| 147 |
.B mimemap
|
152 |
.B mimemap
|
| 148 |
file). This can be useful for files with suffixless names, but it will
|
153 |
file). This can be useful for files with suffixless names, but it will
|
| 149 |
also cause the indexation of many bogus "text" files.
|
154 |
also cause the indexation of many bogus "text" files.
|
|
|
155 |
.TP
|
|
|
156 |
.BI "indexedmimetypes = " list
|
|
|
157 |
Recoll normally indexes any file which it knows how to read. This list lets
|
|
|
158 |
you restrict the indexed mime types to what you specify. If the variable is
|
|
|
159 |
unspecified or the list empty (the default), all supported types are
|
|
|
160 |
processed.
|
|
|
161 |
.TP
|
|
|
162 |
.BI "compressedfilemaxkbs = " value
|
|
|
163 |
Size limit for compressed (.gz or .bz2) files. These need to be
|
|
|
164 |
decompressed in a temporary directory for identification, which can be very
|
|
|
165 |
wasteful if 'uninteresting' big compressed files are present. Negative
|
|
|
166 |
means no limit, 0 means no processing of any compressed file. Defaults
|
|
|
167 |
to -1.
|
|
|
168 |
.TP
|
|
|
169 |
.BI "indexallfilenames = " boolean
|
|
|
170 |
Recoll indexes file names into a special section of the database to allow
|
|
|
171 |
specific file names searches using wild cards. This parameter decides if
|
|
|
172 |
file name indexing is performed only for files with mime types that would
|
|
|
173 |
qualify them for full text indexation, or for all files inside
|
|
|
174 |
the selected subtrees, independant of mime type.
|
|
|
175 |
.TP
|
|
|
176 |
.BI "idxabsmlen = " value
|
|
|
177 |
Recoll stores an abstract for each indexed file inside the database. The
|
|
|
178 |
text can come from an actual 'abstract' section in the document or will
|
|
|
179 |
just be the beginning of the document. It is stored in the index so that it
|
|
|
180 |
can be displayed inside the result lists without decoding the original
|
|
|
181 |
file. The
|
|
|
182 |
.I idxabsmlen
|
|
|
183 |
parameter defines the size of the stored abstract. The default value is 250
|
|
|
184 |
bytes. The search interface gives you the choice to display this stored
|
|
|
185 |
text or a synthetic abstract built by extracting text around the search
|
|
|
186 |
terms. If you always prefer the synthetic abstract, you can reduce this
|
|
|
187 |
value and save a little space.
|
|
|
188 |
.TP
|
|
|
189 |
.BI "aspellLanguage = " lang
|
|
|
190 |
Language definitions to use when creating the aspell dictionary. The value
|
|
|
191 |
must match a set of aspell language definition files. You can type "aspell
|
|
|
192 |
config" to see where these are installed (look for data-dir). The default
|
|
|
193 |
if the variable is not set is to use your desktop national language
|
|
|
194 |
environment to guess the value.
|
|
|
195 |
.TP
|
|
|
196 |
.BI "noaspell = " boolean
|
|
|
197 |
If this is set, the aspell dictionary generation is turned off. Useful for
|
|
|
198 |
cases where you don't need the functionality or when it is unusable because
|
|
|
199 |
aspell crashes during dictionary generation.
|
|
|
200 |
.TP
|
|
|
201 |
.BI "nocjk = " boolean
|
|
|
202 |
If this set to true, specific east asian (Chinese Korean Japanese)
|
|
|
203 |
characters/word splitting is turned off. This will save a small amount of
|
|
|
204 |
cpu if you have no CJK documents. If your document base does include such
|
|
|
205 |
text but you are not interested in searching it, setting
|
|
|
206 |
.I nocjk
|
|
|
207 |
may be a significant time and space saver.
|
|
|
208 |
.TP
|
|
|
209 |
.BI "cjkngramlen = " value
|
|
|
210 |
This lets you adjust the size of n-grams used for indexing CJK text. The
|
|
|
211 |
default value of 2 is probably appropriate in most cases. A value of 3
|
|
|
212 |
would allow more precision and efficiency on longer words, but the index
|
|
|
213 |
will be approximately twice as large.
|
| 150 |
.SH SEE ALSO
|
214 |
.SH SEE ALSO
|
| 151 |
.PP
|
215 |
.PP
|
| 152 |
recollindex(1) recoll(1)
|
216 |
recollindex(1) recoll(1)
|