search-xapian/README

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