xapian-core/INSTALL

   1 Welcome to Xapian
   2 =================
   3
   4 Xapian's build system is built using GNU autoconf, automake, and libtool.
   5 If you've installed other Open Source projects from source, you should
   6 find yourself in familiar territory.  Building and installing involves
   7 the following 3 simple steps:
   8
   9  1) Run "./configure", possibly with some extra arguments (see below)
  10  2) Run "make" to build Xapian
  11  3) Run "make install" to install Xapian
  12
  13 Prerequisites
  14 =============
  15
  16 You'll need to have zlib installed (https://www.zlib.net/) before you can build
  17 Xapian.  The zlib library is very widely used, so you'll probably have it
  18 installed already if you're using Linux, FreeBSD, or similar, but you may need
  19 to install a "zlib development" package to get the zlib library headers.
  20
  21 We recommend using zlib 1.2.x as it apparently fixes a memory leak in
  22 deflateInit2 (which Xapian uses) and decompression is supposed to be about 20%
  23 faster than with 1.1.x, but it's pretty unlikely you'll have an older version
  24 installed these days.
  25
  26 Xapian also requires a way to generate UUIDs.  On FreeBSD, NetBSD, OpenBSD,
  27 AIX and Microsoft Windows, Xapian makes use of built-in UUID APIs.  On Linux
  28 and Android, Xapian 1.4.2 and higher can read UUIDs from a special file under
  29 /proc.  Otherwise you need to install libuuid which you can find in
  30 util-linux (https://github.com/karelzak/util-linux).  On Debian and
  31 Ubuntu, the package to install is uuid-dev, while on Fedora, it is
  32 libuuid-devel (on older Fedora versions you instead need e2fsprogs-devel).
  33
  34 Compilers
  35 =========
  36
  37 We aim to support compilation with any C++ compiler which support ISO C++11, or
  38 a reasonable approximation to it.
  39
  40 GCC
  41 ---
  42
  43 If you're using GCC, we currently recommend GCC 4.7 or newer (this is the
  44 oldest version we regularly test with).
  45
  46 The current hard minimum requirement is also GCC 4.7 (due to requiring good
  47 support for C++11, for example non-static data member initializers aren't
  48 supported by earlier versions).
  49
  50 If you really still need to use an older version of GCC, Xapian 1.2.x doesn't
  51 require C++11 support and should build with older versions - probably as far
  52 back as GCC 3.1.
  53
  54 MSVC
  55 ----
  56
  57 If you're using MS Visual C++, you'll need at least MSVS 2015 for C++11
  58 support.
  59
  60 As of Xapian 1.4.6 building using MSVC is supported by the autotools build
  61 system.  You need to install a set of Unix-like tools first - we recommended
  62 MSYS2: https://www.msys2.org/
  63
  64 You also need to have the MSVC command line tools on your PATH.  This is done
  65 by running a batch file in the MSVC install in the terminal before building.
  66 The exact details vary by MSVC version, 32- vs 64-bit, and the directory and
  67 drive where MSVC is installed.  For MSVC 2017 it should be something like::
  68
  69   "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars32.bat"
  70
  71 or::
  72
  73   "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
  74
  75 And for MSVC 2015 32-bit use::
  76
  77   "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x86
  78
  79 MSVC 2015 64-bit isn't currently supported, but would use the above command but
  80 with ``x64`` instead of ``x86``.
  81
  82 Then from a bash shell run configure like so::
  83
  84   ./configure CC="cl -nologo" CXX="$PWD/compile cl -nologo" CXXFLAGS=-EHsc AR=lib
  85
  86 You'll need to have the zlib library available.  You can also specify
  87 ``CPPFLAGS=-I/path/to/zlib LDFLAGS=-L/path/to/zlib`` to tell MSVC where to
  88 find the zlib headers and library.
  89
  90 We support 64-bit compilation with MSVS 2017 and 2019.  With MSVS 2015 a 64-bit
  91 build fails to work - we haven't investigated why.
  92
  93 HP's aCC
  94 --------
  95
  96 When using HP's aCC, Xapian must be compiled with +std=c++11, which
  97 xapian-core's configure automatically detects and passes.  You don't have to
  98 pass this option when building code which uses Xapian, but you can.
  99
 100 Sun C++ Compiler
 101 ----------------
 102
 103 With this compiler, shared library builds fail (tested most recently with
 104 version 12.6).  You can work around this problem by disabling shared libraries
 105 at configure time like so::
 106
 107   ./configure --disable-shared
 108
 109 Multi-Arch
 110 ==========
 111
 112 When using GCC on platforms which support multiple architectures, the simplest
 113 way to select a non-default architecture is to pass a CXX setting to configure
 114 which includes the appropriate -m option - e.g. to build for x86 on x86-64
 115 you would configure with:
 116
 117 ./configure CXX='g++ -m32'
 118
 119 Building in a separate directory
 120 ================================
 121
 122 If you wish to perform your build in a separate directory from the source,
 123 create and change to the build directory, and run the configure script (in
 124 the source directory) from the build directory, like so:
 125
 126   mkdir BUILD
 127   cd BUILD
 128   ../configure
 129
 130 Options to give to configure
 131 ============================
 132
 133 --enable-assertions
 134         You should use this to build a version of Xapian with many internal
 135         consistency checks.  This will run more slowly, but is useful if you
 136         suspect a bug in Xapian.
 137
 138 --enable-backend-chert
 139 --enable-backend-glass
 140 --enable-backend-inmemory
 141 --enable-backend-remote
 142         These options enable (or disable if --disable-backend-XXX is specified)
 143         the compiling of each backend (database access methods).  By default,
 144         all backends for which the appropriate libraries and OS support are
 145         available will be enabled.  Note: Currently disabling the remote
 146         backend also disables replication (because the network code is shared).
 147
 148 _FORTIFY_SOURCE
 149 ---------------
 150
 151 When compiling with GCC, by default Xapian will be built with _FORTIFY_SOURCE
 152 set to 2.  This enables some compile time and runtime checking of values passed
 153 to library functions when building with GCC >= 4.1 and glibc >= 2.34 (some
 154 Linux distros may have backported support to older GCC and/or glibc).  If you
 155 wish to disable this for any reason, you can just configure like so:
 156
 157 ./configure CPPFLAGS=-D_FORTIFY_SOURCE=0
 158
 159 Or you can set the "fortification level" to 1 instead of 2:
 160
 161 ./configure CPPFLAGS=-D_FORTIFY_SOURCE=1
 162
 163 If you're disabling it because it causes problems, please also report this to
 164 us (via the bug tracker or mailing lists).
 165
 166 -Bsymbolic-functions
 167 --------------------
 168
 169 If -Wl,-Bsymbolic-functions is supported (for example it is by GCC with modern
 170 ld) then it will be automatically used when linking the library.  This causes
 171 all references from inside the library to symbols inside the library to be
 172 resolved when the library is created, rather than when the shared library is
 173 loaded, which decreases the time taken to load the library, reduces its size,
 174 and is also likely to make the code run a little faster.
 175
 176 Should you wish to disable this for some reason, you can configure like so
 177 which disables the probe for -Bsymbolic-functions so it won't ever be used:
 178
 179 ./configure xo_cv_symbolic_functions=no
 180
 181 If you're disabling it because it causes problems, please also report this to
 182 us (via the bug tracker or mailing lists).
 183
 184 -fvisibility
 185 ------------
 186
 187 When compiling with GCC >= 4.0 for platforms which support symbol visibility,
 188 we automatically pass -fvisibility=hidden to g++ when building the library, and
 189 mark classes, methods, and functions which need exporting with attributes to
 190 make them visible.
 191
 192 Should you wish to disable this for some reason, you can configure like so:
 193
 194 ./configure --disable-visibility
 195
 196 If you're disabling it because it causes problems, please also report this to
 197 us (via the bug tracker or mailing lists).
 198
 199 Developers
 200 ==========
 201
 202 There are additional scripts and configure options to help people doing
 203 development work on Xapian itself, and people who are building from git.
 204 Read HACKING to find out about them.