|
a/src/INSTALL |
|
b/src/INSTALL |
|
... |
|
... |
| 15 |
|
15 |
|
| 16 |
Table of Contents
|
16 |
Table of Contents
|
| 17 |
|
17 |
|
| 18 |
4.1. Installing a prebuilt copy
|
18 |
4.1. Installing a prebuilt copy
|
| 19 |
|
19 |
|
| 20 |
4.2. Packages needed for external file types
|
20 |
4.2. Supporting packages
|
| 21 |
|
21 |
|
| 22 |
4.3. Building from source
|
22 |
4.3. Building from source
|
| 23 |
|
23 |
|
| 24 |
4.4. Configuration overview
|
24 |
4.4. Configuration overview
|
| 25 |
|
25 |
|
|
... |
|
... |
| 57 |
|
57 |
|
| 58 |
Finally, you may want to have a look at the configuration section.
|
58 |
Finally, you may want to have a look at the configuration section.
|
| 59 |
|
59 |
|
| 60 |
--------------------------------------------------------------------------
|
60 |
--------------------------------------------------------------------------
|
| 61 |
|
61 |
|
| 62 |
Prev Home Next
|
62 |
Prev Home Next
|
| 63 |
Customizing the search interface Packages needed for external file
|
63 |
Customizing the search interface Supporting packages
|
| 64 |
types
|
|
|
| 65 |
Link: HOME
|
64 |
Link: HOME
|
| 66 |
Link: UP
|
65 |
Link: UP
|
| 67 |
Link: PREVIOUS
|
66 |
Link: PREVIOUS
|
| 68 |
Link: NEXT
|
67 |
Link: NEXT
|
| 69 |
|
68 |
|
| 70 |
Recoll user manual
|
69 |
Recoll user manual
|
| 71 |
Prev Chapter 4. Installation Next
|
70 |
Prev Chapter 4. Installation Next
|
| 72 |
|
71 |
|
| 73 |
--------------------------------------------------------------------------
|
72 |
--------------------------------------------------------------------------
|
| 74 |
|
73 |
|
| 75 |
4.2. Packages needed for external file types
|
74 |
4.2. Supporting packages
|
| 76 |
|
75 |
|
| 77 |
Recoll uses external applications to index some file types. You need to
|
76 |
Recoll uses external applications to index some file types. You need to
|
| 78 |
install them for the file types that you wish to have indexed (these are
|
77 |
install them for the file types that you wish to have indexed (these are
|
| 79 |
run-time dependencies. None is needed for building Recoll):
|
78 |
run-time dependencies. None is needed for building Recoll):
|
| 80 |
|
79 |
|
|
... |
|
... |
| 129 |
not be critical). On Linux systems, the iconv interface is part of libc
|
128 |
not be critical). On Linux systems, the iconv interface is part of libc
|
| 130 |
and you should not need to do anything special.
|
129 |
and you should not need to do anything special.
|
| 131 |
|
130 |
|
| 132 |
4.3.2. Building
|
131 |
4.3.2. Building
|
| 133 |
|
132 |
|
| 134 |
Recoll has been built on Linux (redhat7.3, mandriva 2005, Fedora Core 3),
|
133 |
Recoll has been built on Linux (redhat7.3, mandriva 2005/6, Fedora Core
|
| 135 |
FreeBSD and Solaris 8. If you build on another system, I would very much
|
134 |
3/4/5), FreeBSD and Solaris 8. If you build on another system, I would
|
| 136 |
welcome patches.
|
135 |
very much welcome patches.
|
| 137 |
|
136 |
|
| 138 |
Depending on the qt configuration on your system, you may have to set the
|
137 |
Depending on the qt configuration on your system, you may have to set the
|
| 139 |
QTDIR and QMAKESPECS variables in your environment:
|
138 |
QTDIR and QMAKESPECS variables in your environment:
|
| 140 |
|
139 |
|
| 141 |
* QTDIR should point to the directory above the one that holds the qt
|
140 |
* QTDIR should point to the directory above the one that holds the qt
|
| 142 |
include files (ie: qt.h).
|
141 |
include files (ie: if qt.h is /usr/local/qt/include/qt.h, QTDIR should
|
|
|
142 |
be /usr/local/qt).
|
| 143 |
|
143 |
|
| 144 |
* QMAKESPECS should be set to the name of one of the qt mkspecs
|
144 |
* QMAKESPECS should be set to the name of one of the qt mkspecs
|
| 145 |
sub-directories (ie: linux-g++).
|
145 |
sub-directories (ie: linux-g++).
|
| 146 |
|
146 |
|
| 147 |
On many Linux systems, QTDIR is set by the login scripts, and QMAKESPECS
|
147 |
On many Linux systems, QTDIR is set by the login scripts, and QMAKESPECS
|
| 148 |
is not needed because there is a default link in mkspecs/.
|
148 |
is not needed because there is a default link in mkspecs/.
|
| 149 |
|
149 |
|
| 150 |
The Recoll configure script does a better job of checking these variables
|
150 |
Configure options: --without-aspell will disable the code for phonetic
|
| 151 |
after release 1.1.1. Before this, unexplained errors will occur during
|
151 |
matching of search terms. --with-fam or --with-inotify will enable the
|
| 152 |
compilation if the environment is not set up. Also, for 1.1.0 the qmake
|
152 |
code for real time indexing. Refer to configure --help output for details.
|
| 153 |
command should be in your PATH (later releases can also find it in
|
|
|
| 154 |
$QTDIR/bin).
|
|
|
| 155 |
|
153 |
|
| 156 |
Normal procedure:
|
154 |
Normal procedure:
|
| 157 |
|
155 |
|
| 158 |
cd recoll-xxx
|
156 |
cd recoll-xxx
|
| 159 |
configure
|
157 |
configure
|
|
... |
|
... |
| 180 |
|
178 |
|
| 181 |
You can then proceed to configuration.
|
179 |
You can then proceed to configuration.
|
| 182 |
|
180 |
|
| 183 |
--------------------------------------------------------------------------
|
181 |
--------------------------------------------------------------------------
|
| 184 |
|
182 |
|
| 185 |
Prev Home Next
|
183 |
Prev Home Next
|
| 186 |
Packages needed for external file types Up Configuration overview
|
184 |
Supporting packages Up Configuration overview
|
| 187 |
Link: HOME
|
185 |
Link: HOME
|
| 188 |
Link: UP
|
186 |
Link: UP
|
| 189 |
Link: PREVIOUS
|
187 |
Link: PREVIOUS
|
| 190 |
|
188 |
|
| 191 |
Recoll user manual
|
189 |
Recoll user manual
|
| 192 |
Prev Chapter 4. Installation
|
190 |
Prev Chapter 4. Installation
|
| 193 |
|
191 |
|
| 194 |
--------------------------------------------------------------------------
|
192 |
--------------------------------------------------------------------------
|
| 195 |
|
193 |
|
| 196 |
4.4. Configuration overview
|
194 |
4.4. Configuration overview
|
|
|
195 |
|
|
|
196 |
Most of the parameters specific to the recoll GUI are set through the
|
|
|
197 |
Preferences menu and stored in the standard QT place ($HOME/.qt/recollrc).
|
|
|
198 |
You probably do not want to edit this by hand.
|
|
|
199 |
|
|
|
200 |
For other options, Recoll uses text configuration files. You will have to
|
|
|
201 |
edit them by hand for now (there is still some hope for a GUI
|
|
|
202 |
configuration tool in the future). The most accurate documentation for the
|
|
|
203 |
configuration parameters is given by comments inside the default files,
|
|
|
204 |
and we will just give a general overview here.
|
| 197 |
|
205 |
|
| 198 |
There are two sets of configuration files. The system-wide files are kept
|
206 |
There are two sets of configuration files. The system-wide files are kept
|
| 199 |
in a directory named like /usr/[local/]share/recoll/examples, they define
|
207 |
in a directory named like /usr/[local/]share/recoll/examples, they define
|
| 200 |
default values for the system. A parallel set of files exists by default
|
208 |
default values for the system. A parallel set of files exists by default
|
| 201 |
in the .recoll directory in your home. This directory can be changed with
|
209 |
in the .recoll directory in your home. This directory can be changed with
|
|
... |
|
... |
| 205 |
If the .recoll directory does not exist when recoll or recollindex are
|
213 |
If the .recoll directory does not exist when recoll or recollindex are
|
| 206 |
started, it will be created with a set of empty configuration files.
|
214 |
started, it will be created with a set of empty configuration files.
|
| 207 |
recoll will give you a chance to edit the configuration file before
|
215 |
recoll will give you a chance to edit the configuration file before
|
| 208 |
starting indexing. recollindex will proceed immediately.
|
216 |
starting indexing. recollindex will proceed immediately.
|
| 209 |
|
217 |
|
| 210 |
Most of the parameters specific to the recoll GUI are set through the
|
|
|
| 211 |
Preferences menu and stored in the standard QT place ($HOME/.qt/recollrc).
|
|
|
| 212 |
You probably do not want to edit this by hand.
|
|
|
| 213 |
|
|
|
| 214 |
For other options, Recoll uses text configuration files. You will have to
|
|
|
| 215 |
edit them by hand for now (there is still some hope for a GUI
|
|
|
| 216 |
configuration tool in the future). The most accurate documentation for the
|
|
|
| 217 |
configuration parameters is given by comments inside the default files,
|
|
|
| 218 |
and we will just give a general overview here.
|
|
|
| 219 |
|
|
|
| 220 |
All configuration files share the same format. For example, a short
|
218 |
All configuration files share the same format. For example, a short
|
| 221 |
extract of the main configuration file might look as follows:
|
219 |
extract of the main configuration file might look as follows:
|
| 222 |
|
220 |
|
| 223 |
# Space-separated list of directories to index.
|
221 |
# Space-separated list of directories to index.
|
| 224 |
topdirs = ~/docs /usr/share/doc
|
222 |
topdirs = ~/docs /usr/share/doc
|
|
... |
|
... |
| 233 |
|
231 |
|
| 234 |
* Parameter affectation (name = value).
|
232 |
* Parameter affectation (name = value).
|
| 235 |
|
233 |
|
| 236 |
* Section definition ([somedirname]).
|
234 |
* Section definition ([somedirname]).
|
| 237 |
|
235 |
|
| 238 |
Section lines allow redefining some parameters for a directory sub-tree.
|
236 |
Section definitions allow redefining some parameters for a directory
|
| 239 |
Some of the parameters used for indexing are looked up hierarchically from
|
237 |
sub-tree. They stay in effect until another section definition, or the end
|
| 240 |
the more to the less specific. Not all parameters can be meaningfully
|
238 |
of file, is encountered. Some of the parameters used for indexing are
|
| 241 |
redefined, this is specified for each in the next section.
|
239 |
looked up hierarchically from the current directory location upwards. Not
|
|
|
240 |
all parameters can be meaningfully redefined, this is specified for each
|
|
|
241 |
in the next section.
|
| 242 |
|
242 |
|
| 243 |
The tilde character (~) is expanded in file names to the name of the
|
243 |
The tilde character (~) is expanded in file names to the name of the
|
| 244 |
user's home directory.
|
244 |
user's home directory.
|
| 245 |
|
245 |
|
| 246 |
White space is used for separation inside lists. Elements with embedded
|
246 |
White space is used for separation inside lists. Elements with embedded
|
|
... |
|
... |
| 293 |
mail user agents like thunderbird usually store messages in hidden
|
293 |
mail user agents like thunderbird usually store messages in hidden
|
| 294 |
directories, and you probably want this indexed. One possible
|
294 |
directories, and you probably want this indexed. One possible
|
| 295 |
solution is to have .* in skippedNames, and add things like
|
295 |
solution is to have .* in skippedNames, and add things like
|
| 296 |
~/.thunderbird or ~/.evolution in topdirs.
|
296 |
~/.thunderbird or ~/.evolution in topdirs.
|
| 297 |
|
297 |
|
| 298 |
loglevel
|
298 |
loglevel,daemloglevel
|
| 299 |
|
299 |
|
| 300 |
Verbosity level for recoll and recollindex. A value of 4 lists
|
300 |
Verbosity level for recoll and recollindex. A value of 4 lists
|
| 301 |
quite a lot of debug/information messages. 2 only lists errors.
|
301 |
quite a lot of debug/information messages. 2 only lists errors.
|
|
|
302 |
The daemversion is specific to the indexing monitor daemon.
|
| 302 |
|
303 |
|
| 303 |
logfilename
|
304 |
logfilename, daemlogfilename
|
| 304 |
|
305 |
|
| 305 |
Where the messages should go. 'stderr' can be used as a special
|
306 |
Where the messages should go. 'stderr' can be used as a special
|
| 306 |
value, and is the default.
|
307 |
value, and is the default. The daemversion is specific to the
|
|
|
308 |
indexing monitor daemon.
|
| 307 |
|
309 |
|
| 308 |
filtersdir
|
310 |
filtersdir
|
| 309 |
|
311 |
|
| 310 |
A directory to search for the external filter scripts used to
|
312 |
A directory to search for the external filter scripts used to
|
| 311 |
index some types of files. The value should not be changed, except
|
313 |
index some types of files. The value should not be changed, except
|