search-xapian/README

   1 Search::Xapian version 1.2.24.0
   2 ===============================
   3
   4 This is Search::Xapian, a Perl XS interface to the Xapian C++ search library.
   5
   6 Xapian 1.4.x aims to replace these hand-coded XS wrappers with wrappers
   7 generated with SWIG, which will allow new C++ API features to be wrapped for
   8 Perl more quickly and easily than currently.  These aren't currently quite
   9 ready, and because of this (and also to assist people with migration) the
  10 XS bindings can also be compiled against xapian-core 1.4.x, and aim to
  11 present the same Perl API as when compiled against xapian-core 1.2.x.
  12
  13 INSTALLATION
  14
  15 To install this module type the following:
  16
  17    perl Makefile.PL
  18    make
  19    make test
  20    make install
  21
  22 By default, Makefile.PL looks for xapian-config on your PATH.  You can specify
  23 a path for xapian-config by passing XAPIAN_CONFIG=/path/to/xapian-config on
  24 the command line after Makefile.PL.  Similarly, you can specify a C++ compiler
  25 by passing CXX=/usr/local/bin/g++ after Makefile.PL, as well as CXXFLAGS and
  26 CPPFLAGS to add additional compiler flags.  For example:
  27
  28    perl Makefile.PL XAPIAN_CONFIG=/home/jim/bin/xapian-config CXX=g++-4.3
  29
  30 These values are stored in the generated Makefile and will be used if "make"
  31 causes "perl Makefile.PL" to be automatically rerun (e.g. if you modify
  32 Makefile.PL).
  33
  34 (For compatibility with what Search::Xapian 1.0.3.0 and earlier required,
  35 XAPIAN_CONFIG and CXX can also be specified as environmental variables.
  36 Specifying them on the command line is preferred because it avoids issues
  37 with differing syntax between shells and having to export variables).
  38
  39 DEPENDENCIES
  40
  41 Search::Xapian currently requires Perl >= 5.6.  To work well in a threaded
  42 Perl script (i.e. when "use threads;" is in use), Perl >= 5.8.7 is required.
  43
  44 This module requires these other modules and libraries:
  45
  46   The Xapian C++ search library, which can be downloaded by following
  47   the instructions on https://xapian.org/ - versions 1.2.x and 1.4.x
  48   are supported by Search::Xapian 1.2.24.0 and later.
  49
  50 DOCUMENTATION
  51
  52 Most of the classes have POD documentation, which you can view using perldoc or
  53 man (e.g. perldoc Search::Xapian::Database).  The Perl API closely follows the
  54 C++ API in most places, so the documentation for Xapian itself is generally
  55 applicable: <https://xapian.org/docs/>
  56
  57 The "Getting Started with Xapian" guide is a worthwhile read, especially if
  58 you are new to Xapian: <https://getting-started-with-xapian.readthedocs.org/>
  59
  60 COPYRIGHT AND LICENCE
  61
  62 Please report any bugs/suggestions to <xapian-discuss@lists.xapian.org>
  63 or use the Xapian bug tracker <https://xapian.org/bugs>.  Please do NOT use the
  64 CPAN bug tracker or mail any of the authors individually.
  65
  66 Copyright (c) 2002,2003 Alex Bowley. All rights reserved.
  67 Copyright (c) 2003,2004,2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Olly Betts. All rights reserved.
  68 Copyright (c) 2010,2012 Adam Sjøgren
  69
  70 This program is free software; you can redistribute it and/or modify
  71 it under the same terms as Perl itself.