"Fossies" - the Fresh Open Source Software Archive

Member "xapian-core-1.4.14/docs/index.rst" (23 Nov 2019, 2680 Bytes) of package /linux/www/xapian-core-1.4.14.tar.xz:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "index.rst": 1.4.9_vs_1.4.10.

website | install | overview | sysadmins | scalability | API | deprecated | IR | wiki

Xapian - the open source search engine

Getting Started

There's a new Getting Started with Xapian guide, which is the recommended place to start.


The Omega search application has its own documentation, and there's also separate documentation for the other language bindings.

We suggest you start by reading the Installation Guide, which covers downloading the code, and unpacking, configuring, building and installing it.

The glossary provides definitions for specialized terminology you might encounter while using Xapian.

The Overview explains the API which Xapian provides to programmers. A full API Reference is automatically collated using doxygen from documentation comments in the source code. There's also a list of deprecated features which lists features scheduled for removal, and also features already removed, along with suggestions for replacements.

If you want to learn more about information retrieval, there's a (reasonably mathematical) introduction to the ideas behind Xapian which also suggests some books you might want to read.

There are a number of documents which cover particular features:

For those wishing to do development work on the Xapian library itself, there is documentation of Xapian's internals available.

We also have a wiki for documentation and examples contributed by the Xapian community.