website | install | quickstart | 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.

## Documentation

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.

For a quick introduction to our software, including a walk-through example of an application for searching through some data, read the Quickstart document.

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 (PDF) 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 probabilistic 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:

- BM25 Weighting Scheme
- Collapsing
- Database Replication
- Faceting
- Indexing
- PostingSource
- Query Parser
- Remote Backend
- Serialising Queries and Documents
- Sorting Results
- Spelling Correction
- Stemming Algorithms
- Synonym Support
- Value Ranges

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.