-
Notifications
You must be signed in to change notification settings - Fork 281
/
INSTALL
277 lines (208 loc) · 10.7 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
Xapian-bindings Installation
============================
Known Issues
============
* The bindings fail to link on MacOS X 10.1 and 10.2. Unfortunately we
don't know of a workaround other than to upgrade to MacOS X 10.3 or
higher. If you know of a solution please let us know.
* The bindings glue code generated by SWIG seems to require a lot of memory
to compile and can take several minutes even on a fast machine (at least
with most versions of g++). Some systems (such as OpenBSD) may require
you to increase the amount of memory a process can use (using ulimit is
the simplest way). Alternatively you can compile the bindings without
optimisation using:
make CXXFLAGS=-g
Xapian-bindings version 0.9.3 reduces the compile time by something like a
factor of 3 and probably also reduces memory usage significantly, but you
might still encounter this issue on slower machines with less memory.
Quick Installation Guide
========================
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
You need to make sure that xapian-config from xapian-core is on your path,
or else pass its full path to xapian-bindings's configure script:
./configure XAPIAN_CONFIG=/path/to/xapian-config
By default, configure will enable building of bindings for all languages
which it can find the required tools for. Alternatively you can specify
exactly which bindings you want to build by passing one or more of the
following options to configure:
--with-swig enable all bindings which depend on SWIG
(currently: CSharp PHP Python Ruby Tcl)
--with-python enable Python bindings
--with-php enable PHP bindings
--with-ruby enable Ruby bindings
--with-tcl enable Tcl bindings
--with-java enable Java bindings
--with-csharp enable CSharp bindings
If you've requested particular bindings using these options, then
configure will fail with an error if it is missing the prerequisite
tools, libraries, header files, etc required to build bindings for
any of the specified languages.
Running `configure' takes a while. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package (if you don't have root access
and want to compile any of the bindings other than Java and C#,
read the next section).
3. Optionally, type `make check' to run the self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Installing without root access
==============================
By default the bindings for all languages apart from Java and C# will
automatically detect where the language interpreter expects extension
modules to be installed and try to install there. This is a problem
if you want to install them and don't have root access. In this case
follow the instructions for the particular language below (note: you
still build several at once - just pass the arguments listed below
for each language to "./configure", to "make", and to "make install".)
Note that you also need to pass a "--prefix" option to configure so that
the documentation and examples can be installed.
PHP:
./configure --with-php --prefix=$HOME/install
make phpextdir=$HOME/my_php_extensions
make install phpextdir=$HOME/my_php_extensions
And you'll need to load the Xapian module in your PHP code using something
like:
dl("../../../home/USERNAME/my_php_extensions/xapian.so");
The number of ".."s you need depends on what extension_dir is set to
in php.ini.
Python:
./configure --with-python --prefix=$HOME/install
make pylibdir=$HOME/my_python_modules
make install pylibdir=$HOME/my_python_modules
And then you'll need to tell Python to look for modules in this directory.
Here are two possible ways to do that.
setenv PYTHONPATH=$HOME/my_python_modules python myscript.py
Or you can add this to your Python script:
import sys
sys.path.insert(0, "/home/USERNAME/my_python_modules")
import xapian
Tcl8:
./configure --with-tcl --prefix=$HOME/install
make tcllibdir=$HOME/my_python_modules
make install tcllibdir=$HOME/my_python_modules
And then add the following to the start of your script to load Xapian:
load [file join "/home/USERNAME/my_python_modules" xapian.so]
Compilers and Options
=====================
Some systems may require unusual options for compilation or linking that
the `configure' script does not know about. Run `./configure --help'
for details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure LIBS=-lposix
If your system requires special flags, do let us know. Where possible
we'd prefer configure to determine such flags by itself, but if we can't
then at least we can document the special flags to help other users of
systems like yours.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not support the `VPATH'
variable, you have to compile the package for one architecture at a
time in the source code directory. After you have installed the
package for one architecture, use `make distclean' before reconfiguring
for another architecture.
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out
automatically, but needs to determine by the type of machine the package
will run on. Usually, assuming the package is built to be run on the
_same_ architectures, `configure' can figure that out, but if it prints
a message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CXX', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CXX=/usr/local2/bin/g++
will cause the specified g++ to be used as the C++ compiler (unless it is
overridden in the site shell script).
`configure' Invocation
======================
As well as the options documented in the "Quick Installation Guide",
`configure' recognizes the following standard options to control how it
operates:
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.