xapian-core/INSTALL

   1 Welcome to Xapian
   2 =================
   3
   4 Xapian uses a standard GNU automake / autoconf / libtool / etc setup.
   5 This means that all you need to do to compile a standard distribution
   6 should be:
   7
   8  1) Run ./configure, possibly with some extra arguments (see below)
   9  2) Run make
  10  3) Run make install to install Xapian
  11
  12
  13 Compilers:
  14 ==========
  15
  16 We aim to support compilation with any C++ compiler which supports ISO C++,
  17 or a reasonable approximation to it.
  18
  19 If you're using GCC, we recommend GCC 3.0 or later rather than GCC 2.95,
  20 as the C++ compiler is much improved in 3.0.  EGCS or any other GCC version
  21 prior to GCC 2.95 is unlikely to work due to lack of support for certain C++
  22 features.
  23
  24 Options to give to configure:
  25 =============================
  26
  27 Note: If you wish to perform your build in a separate directory from the
  28 source, change to the build directory, and run the configure script
  29 (in the source directory) from the build directory.
  30
  31 ie: mkdir BUILD; cd BUILD; ../configure
  32
  33 --enable-debug
  34         You should use this to build a version of Xapian with debugging
  35         symbols and assertions to help with debugging.  Recommended for
  36         initial development with Xapian - this helps to ensure that you
  37         are using the API correctly.
  38
  39 --enable-backend-*
  40         These options enable the compiling of each of the backends.  (Database
  41         access methods.)  Use "./configure --help" to get a full list of
  42         the backends.  By default, all backends for which the appropriate
  43         libraries are available will be enabled.
  44
  45
  46 Compiling with STLport
  47 ======================
  48
  49 If your native C++ standard library and STL is not suitable for your needs,
  50 you should use an alternative library.  For example, you may wish to run
  51 Xapian in a multithreaded situation and have the GNU libstdc++, which
  52 doesn't work properly with multithreaded access.
  53
  54 One freely available option is STLport, downloadable from
  55 http://www.stlport.org/
  56
  57 To compile with STLport:
  58
  59  1) Download, build, and optionally install STLport.
  60  2) Configure Xapian, by running ./configure, supplying the following
  61     arguments:
  62
  63     --with-stlport=<path>, where <path> is the path to the STLport
  64         software.  The directory pointed to by <path> should contain
  65         stlport/ and lib/ subdirectories.
  66
  67     --with-stlport-compiler=<name>, where <name> is the name of the
  68         compiler you are using.  This must correspond to the compiler
  69         name in the name of the STLport library.  For example, with
  70         GCC, the STLport library would be called libstlport_gcc, and
  71         you should give --with-stlport-compiler=gcc.
  72
  73  3) Compile and use Xapian as normal, by running make.
  74
  75 Note that, unless you compile statically, you must make sure that the
  76 STLport library is on the library path at runtime: on Linux you could
  77 do this by setting the LD_LIBRARY_PATH environment variable to point
  78 to the directory containing the library.
  79
  80
  81 Developers:
  82 ===========
  83
  84 There are additional scripts and configure options to help developers and
  85 people who are building from CVS.  Read HACKING to find out about them.
  86
  87 --
  88 James Aylett