Search-Xapian  1.2.25.4
About: Search Xapian - Perl XS frontend to the Xapian C++ search library.
  Fossies Dox: Search-Xapian-1.2.25.4.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

Search-Xapian Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. Search-Xapian-1.2.25.4.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README
Search::Xapian version 1.2.25.4
===============================

This is Search::Xapian, a Perl XS interface to the Xapian C++ search library.

We're working to replace these hand-coded XS wrappers with wrappers generated
with SWIG, which will allow new C++ API features to be wrapped for Perl more
quickly and easily than currently.  These new bindings are available in
xapian-bindings 1.4.16 and later.  They are mostly compatible with these
bindings, but there are some differences - see the documentation of the new
bindings for a list of the known differences.

To assist people with migration these XS bindings can also be compiled against
xapian-core 1.4.x, and aim to present the same Perl API as when compiled
against xapian-core 1.2.x.

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

By default, Makefile.PL looks for xapian-config on your PATH.  You can specify
a path for xapian-config by passing XAPIAN_CONFIG=/path/to/xapian-config on
the command line after Makefile.PL.  Similarly, you can specify a C++ compiler
by passing CXX=/usr/local/bin/g++ after Makefile.PL, as well as CXXFLAGS and
CPPFLAGS to add additional compiler flags.  For example:

   perl Makefile.PL XAPIAN_CONFIG=/home/jim/bin/xapian-config CXX=g++-4.3

These values are stored in the generated Makefile and will be used if "make"
causes "perl Makefile.PL" to be automatically rerun (e.g. if you modify
Makefile.PL).

(For compatibility with what Search::Xapian 1.0.3.0 and earlier required,
XAPIAN_CONFIG and CXX can also be specified as environmental variables.
Specifying them on the command line is preferred because it avoids issues
with differing syntax between shells and having to export variables).

DEPENDENCIES

Search::Xapian currently requires Perl >= 5.6.  To work well in a threaded
Perl script (i.e. when "use threads;" is in use), Perl >= 5.8.7 is required.

This module requires these other modules and libraries:

  The Xapian C++ search library, which can be downloaded by following
  the instructions on https://xapian.org/ - versions 1.2.x and 1.4.x
  are supported by Search::Xapian 1.2.24.0 and later.

DOCUMENTATION

Most of the classes have POD documentation, which you can view using perldoc or
man (e.g. perldoc Search::Xapian::Database).  The Perl API closely follows the
C++ API in most places, so the documentation for Xapian itself is generally
applicable: <https://xapian.org/docs/>

The "Getting Started with Xapian" guide is a worthwhile read, especially if
you are new to Xapian: <https://getting-started-with-xapian.readthedocs.org/>

COPYRIGHT AND LICENCE

Please report any bugs/suggestions to <xapian-discuss@lists.xapian.org>
or use the Xapian bug tracker <https://xapian.org/bugs>.  Please do NOT use the
CPAN bug tracker or mail any of the authors individually.

Copyright (c) 2002,2003 Alex Bowley. All rights reserved.
Copyright (c) 2003-2020 Olly Betts. All rights reserved.
Copyright (c) 2010,2012 Adam Sj√łgren

This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.