1 Xapian-bindings Installation
2 ============================
4 Originally based on automake's generic "Installation Instructions" which are:
6 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
7 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
9 Copying and distribution of this file, with or without modification,
10 are permitted in any medium without royalty provided the copyright
11 notice and this notice are preserved. This file is offered as-is,
12 without warranty of any kind.
17 * The bindings glue code generated by SWIG seems to require a lot of memory
18 to compile and can take several minutes even on a fast machine (at least
19 with most versions of g++). Some systems (such as OpenBSD) may require
20 you to increase the amount of memory a process can use (using ulimit is
21 the simplest way). Alternatively you can compile the bindings without
26 Xapian-bindings version 0.9.3 reduced the compile time by something like a
27 factor of 3 and probably also reduced memory usage significantly, but you
28 might still encounter this issue on slower machines with less memory.
30 Quick Installation Guide
31 ========================
33 The simplest way to compile this package is:
35 0. Make sure you have the required tools installed for the languages you
36 want to build the bindings for. Package systems often separate the
37 files you need to build the bindings into a separate package with a
38 `-dev` or `-devel` suffix. Additional per-language dependencies are:
41 - Sphinx Documentation Generator: http://www.sphinx-doc.org/
42 The package you want might be python-sphinx.
44 - Sphinx Documentation Generator: http://www.sphinx-doc.org/
45 The package you want might be python3-sphinx.
47 1. 'cd' to the directory containing the package's source code and type
48 './configure' to configure the package for your system.
50 You need to make sure that xapian-config from xapian-core is on your path,
51 or else pass its full path to xapian-bindings's configure script:
53 ./configure XAPIAN_CONFIG=/path/to/xapian-config
55 By default, configure will enable building of bindings for all languages
56 which it can find the required tools for. Alternatively you can specify
57 exactly which bindings you want to build by passing one or more of the
58 following options to configure:
60 --with-csharp enable CSharp bindings
61 --with-java enable Java bindings
62 --with-lua enable Lua bindings
63 --with-perl enable Perl bindings
64 --with-php enable PHP bindings
65 --with-python enable Python 2 bindings
66 --with-python3 enable Python 3 bindings
67 --with-ruby enable Ruby bindings
68 --with-tcl enable Tcl bindings
70 If you've requested particular bindings using these options, then
71 configure will fail with an error if it is missing the prerequisite
72 tools, libraries, header files, etc required to build bindings for
73 any of the specified languages.
75 If you have more than one version of a particular language installed
76 you can tell configure which to build the bindings for by setting
77 variables on the configure command line. For a full list of such
78 variables, see the output of 'configure --help' - for example, for
81 ./configure PYTHON=/opt/bin/python2.6
83 If you don't have root access and want to compile any of the bindings
84 other than C#, Java and PHP, read the next section: "Installing without
87 Running 'configure' might take a while. While running, it prints
88 some messages telling which features it is checking for.
90 2. Type 'make' to compile the package.
92 3. Optionally, type 'make check' to run the self-tests that come with
93 the package, using the just-built uninstalled binaries.
95 4. Type 'make install' to install the programs and any data files and
96 documentation. When installing into a prefix owned by root, it is
97 recommended that the package be configured and built as a regular
98 user, and only the 'make install' phase executed with root
101 5. You can remove the program binaries and object files from the
102 source code directory by typing 'make clean'. To also remove the
103 files that 'configure' created (so you can compile the package for
104 a different kind of computer), type 'make distclean'. There is
105 also a 'make maintainer-clean' target, but that is intended mainly
106 for the package's developers. If you use it, you may have to get
107 all sorts of other programs in order to regenerate files that came
108 with the distribution.
110 6. You can also type 'make uninstall' to remove the installed files
113 Installing without root access
114 ==============================
116 By default the bindings for all languages apart from Java and C# will
117 automatically detect where the language interpreter expects extension
118 modules to be installed and try to install there. This is a problem
119 if you want to install them and don't have root access. In this case
120 follow the instructions for the particular language below (note: you
121 still build several at once - just pass the arguments listed below
122 for each language to "./configure", to "make", and to "make install".)
123 Note that you also need to pass a "--prefix" option to configure so that
124 the documentation and examples can be installed.
128 With current releases of PHP, there doesn't seem to be a good way to
129 install the PHP bindings without root access such that they can be used
130 from PHP run from a webserver, which is what most users want to do.
132 If you're only interested in running code from the command line (via PHP's
133 CLI SAPI) then the following will work:
135 ./configure --with-php --prefix=$HOME/install PHP_EXTENSION_DIR=$HOME/my_php_extensions
139 Then tell the PHP interpreter to load extensions from there:
141 php -d extension_dir="$HOME/my_php_extensions" myscript.php
143 However, this will stop PHP from looking in the default place for
144 extensions! It doesn't seem to be possible to specify more than one
145 directory, but you can copy or symlink system installed extensions
146 from the default extension directory to $HOME/my_php_extensions like
149 ln -s "`php -r 'print PHP_EXTENSION_DIR;'`"/* "$HOME/my_php_extensions"
151 This will symlink all of them, but you only actually need those that
156 ./configure --with-python --prefix=$HOME/install PYTHON_LIB=$HOME/.local
160 Python 2.6 and later will look in ~/.local for packages automatically
161 so the above is all that is required.
163 For older Python versions, or if you set PYTHON_LIB to a different
164 directory, you'll need to tell Python to look for modules in that
165 directory. Here are two possible ways to do that:
167 setenv PYTHONPATH=$HOME/.local python myscript.py
169 Or you can add this to the start of your Python scripts:
173 sys.path.insert(0, os.environ['HOME'] + "/.local")
178 ./configure --with-python3 --prefix=$HOME/install PYTHON3_LIB=$HOME/.local
182 Python 3 looks in ~/.local for packages automatically, so you don't need
183 to do anything special to use bindings installed there.
187 ./configure --with-ruby --prefix=$HOME/install RUBY_LIB=$HOME/my_ruby_modules RUBY_LIB_ARCH=$HOME/my_ruby_modules
191 And then you'll need to tell Ruby to look for modules in this directory:
193 ruby -I$HOME/my_ruby_modules myscript.rb
197 ./configure --with-tcl --prefix=$HOME/install TCL_LIB=$HOME/my_tcl_modules
201 And then add the following to the start of your script to load Xapian:
203 load [file join "/home/USERNAME/my_tcl_modules" xapian.so]
207 ./configure --with-perl --prefix=$HOME/install PERL_LIB=$HOME/my_perl_modules
211 And then you'll need to tell Perl to look for modules in this directory:
213 perl -I$HOME/my_perl_modules myscript.pl
215 Compilers and Options
216 =====================
218 Some systems may require unusual options for compilation or linking that
219 the 'configure' script does not know about. Run './configure --help'
220 for details on some of the pertinent environment variables.
222 You can give 'configure' initial values for configuration parameters
223 by setting variables in the command line or in the environment. Here
226 ./configure LIBS=-lposix
228 If your system requires special flags, do let us know. Where possible
229 we'd prefer configure to determine such flags by itself, but if we can't
230 then at least we can document the special flags to help other users of
233 Compiling For Multiple Architectures
234 ====================================
236 When using GCC on platforms which support multiple architecture, the simplest
237 way to select a non-default architecture is to pass a CXX setting to configure
238 which includes the appropriate -m option - e.g. to build for x86 on x86-64
239 you would configure with:
241 ./configure CXX='g++ -m32'
243 On Mac OS X 10.5 and later systems, you can create libraries and
244 executables that work on multiple system types--known as "fat" or
245 "universal" binaries--by specifying multiple '-arch' options to the
246 compiler but only a single '-arch' option to the preprocessor. Like
249 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
250 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
251 CPP="gcc -E" CXXCPP="g++ -E"
253 Building in a separate directory
254 ================================
256 If you wish to perform your build in a separate directory from the source,
257 create and change to the build directory, and run the configure script (in
258 the source directory) from the build directory, like so:
267 By default, 'make install' installs the package's commands under
268 '/usr/local/bin', include files under '/usr/local/include', etc. You
269 can specify an installation prefix other than '/usr/local' by giving
270 'configure' the option '--prefix=PREFIX', where PREFIX must be an
273 You can specify separate installation prefixes for
274 architecture-specific files and architecture-independent files. If you
275 pass the option '--exec-prefix=PREFIX' to 'configure', the package uses
276 PREFIX as the prefix for installing programs and libraries.
277 Documentation and other data files still use the regular prefix.
279 In addition, if you use an unusual directory layout you can give
280 options like '--bindir=DIR' to specify different values for particular
281 kinds of files. Run 'configure --help' for a list of the directories
282 you can set and what kinds of files go in them.
284 Specifying the System Type
285 ==========================
287 There may be some features 'configure' cannot figure out
288 automatically, but needs to determine by the type of machine the package
289 will run on. Usually, assuming the package is built to be run on the
290 _same_ architectures, 'configure' can figure that out, but if it prints
291 a message saying it cannot guess the machine type, give it the
292 '--build=TYPE' option. TYPE can either be a short name for the system
293 type, such as 'sun4', or a canonical name which has the form:
297 where SYSTEM can have one of these forms:
302 See the file 'config.sub' for the possible values of each field. If
303 'config.sub' isn't included in this package, then this package doesn't
304 need to know the machine type.
306 If you want to _use_ a cross compiler, that generates code for a
307 platform different from the build platform, you should specify the
308 "host" platform (i.e., that on which the generated programs will
309 eventually be run) with '--host=TYPE'.
314 If you want to set default values for 'configure' scripts to share,
315 you can create a site shell script called 'config.site' that gives
316 default values for variables like 'CXX', 'cache_file', and 'prefix'.
317 'configure' looks for 'PREFIX/share/config.site' if it exists, then
318 'PREFIX/etc/config.site' if it exists. Or, you can set the
319 'CONFIG_SITE' environment variable to the location of the site script.
320 A warning: not all 'configure' scripts look for a site script.
325 Variables not defined in a site shell script can be set in the
326 environment passed to 'configure'. However, some packages may run
327 configure again during the build, and the customized values of these
328 variables may be lost. In order to avoid this problem, you should set
329 them in the 'configure' command line, using 'VAR=value'. For example:
331 ./configure CXX=/usr/local2/bin/g++
333 causes the specified 'g++' to be used as the C++ compiler (unless it is
334 overridden in the site shell script).
336 'configure' Invocation
337 ======================
339 As well as the options documented in the "Quick Installation Guide",
340 'configure' recognizes the following standard options to control how it
345 Print a summary of all of the options to 'configure', and exit.
349 Print the version of Autoconf used to generate the 'configure'
353 Enable the cache: use and save the results of the tests in FILE,
354 traditionally 'config.cache'. FILE defaults to '/dev/null' to
359 Alias for '--cache-file=config.cache'.
364 Do not print messages saying which checks are being made. To
365 suppress all normal output, redirect it to '/dev/null' (any error
366 messages will still be shown).
369 Look for the package's source code in directory DIR. Usually
370 'configure' can determine that directory automatically.
372 'configure' also accepts some other, not widely useful, options. Run
373 'configure --help' for more details.