Case 1: initial configuration (1.0 and higher)
This is the usual case when you install LXR for the first time on a system
without free-text search engine.
Launch script configure-lxr.pl from your LXR root directory.
$ cd /LXR/root/directory
$ ./scripts/configure-lxr.pl --verbose
*** LXR configurator (version: x.y) ***
LXR root directory is /home/myself/lxr
Configuration will be stored in custom.d/lxr.conf
The script proceeds with database configuration,
then discovers it cannot reach any free-text search engine.
This usually means the free-text search engines have been installed
in non-system directories.
The script asks for the location
and puts it into configuration parameters
so that it may later be referenced.
With adequate answers,
the free-text search feature can be disabled without disturbing LXR operation.
Error: neither glimpse nor swish-e found in $PATH!
‣Is your source tree stored in a VCS repository? [yes/NO] > y
Since free-text search is not compatible with VCSes, you can continue
You can safely answer Y in all circumstances:
-
If your tree is indeed in a VCS repository,
this is the expected answer
since free-text search is not compatible with VCS storage.
-
If it is made of plain files,
it is also safe because this answer is independent from the later questions
about your tree characteristics.
No internal inconsistency will result from this apparent contradiction.
But you may also give the real (or default) answer
then confirm the search engine does not exist:
Error: neither glimpse nor swish-e found in $PATH!
‣Is your source tree stored in a VCS repository? [yes/NO] >
‣Does one of them exist in a non standard directory? [YES/no] >n
Sorry: free-text search disabled
Configuration then proceeds as usual.
With such a configuration,
free-text search will always silently return zero results.
"Silently" means you get no warning nor reminder for disabling the engine.
Case 2: later change or previous releases
This manual procedure is used on an active LXR
when you remove the free-text search engine
(because finally you do not need the feature)
or after you reconfigure your computer
(e.g. after a system upgrade without reloading the free-text search engine).
Open configuration file lxr.conf with your favorite editor.
Locate the parameter related to your free-text search engine in
Auxiliary tools subsection
(either 'glimpsebin' or 'swishbin')
and change its value to '/bin/true':
, 'glimpsebin' => '/bin/true'
or
, 'swishbin' => '/bin/true'
If parameters 'glimpsedirbase' or 'swishdirbase'
have not been initialized,
give them a "neutral" value,
an existing write-enabled directory.
For lack of an adequate directory,
you can use /tmp.
But, when installing later a text search engine,
do not forget to give them a real value.
, 'glimpsedirbase' => '/tmp'
or
, 'swishdirbase' => '/tmp'
