Recoll user manual

Jean-Francois Dockes

This document introduces full text search notions and describes the installation and use of the Recoll application. It currently describes Recoll 1.12.


Table of Contents
1. Introduction
1.1. Giving it a try
1.2. Full text search
1.3. Recoll overview
2. Indexing
2.1. Introduction
2.2. Index storage
2.2.1. Xapian index formats
2.2.2. Security aspects
2.3. Indexing configuration
2.3.1. The indexing configuration GUI
2.4. Periodic indexing
2.4.1. Starting indexing
2.4.2. Using cron to automate indexing
2.5. Real time indexing
3. Searching with the Qt graphical user interface
3.1. Simple search
3.2. The result list
3.2.1. The result list right-click menu
3.3. The preview window
3.4. The query language
3.5. Complex/advanced search
3.6. The term explorer tool
3.7. More about wildcards
3.8. Multiple databases
3.9. Document history
3.10. Sorting search results and collapsing duplicates
3.11. Search tips, shortcuts
3.11.1. Terms and search expansion
3.11.2. Working with phrases and proximity
3.11.3. Others
3.12. Customizing the search interface
4. Searching with the KDE KIO slave
4.1. What's this
4.2. Searchable documents
5. Searching on the command line
6. Programming interface
6.1. Writing a document filter
6.1.1. Filter HTML output
6.2. Field data processing configuration
6.3. API
6.3.1. Interface elements
6.3.2. Python interface
7. Installation
7.1. Installing a prebuilt copy
7.1.1. Installing through a package system
7.1.2. Installing a prebuilt Recoll
7.2. Supporting packages
7.3. Building from source
7.3.1. Prerequisites
7.3.2. Building
7.3.3. Installation
7.4. Configuration overview
7.4.1. Main configuration file
7.4.2. The mimemap file
7.4.3. The mimeconf file
7.4.4. The mimeview file
7.4.5. Examples of configuration adjustments
7.5. The KDE Kicker Recoll applet