Recoll user manual

Jean-Francois Dockes

<jfd@recoll.org>

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

[ Split HTML / Single HTML ]

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. Using Beagle WEB browser plugins

2.5. Periodic indexing

2.5.1. Running indexing
2.5.2. Using cron to automate indexing

2.6. Real time indexing

2.6.1. Slowing down the reindexing rate for fast changing files

3. Searching

3.1. Searching with the Qt graphical user interface

3.1.1. Simple search
3.1.2. The default result list
3.1.3. The result table
3.1.4. The preview window
3.1.5. Complex/advanced search
3.1.6. The term explorer tool
3.1.7. Multiple databases
3.1.8. Document history
3.1.9. Sorting search results and collapsing duplicates
3.1.10. Search tips, shortcuts
3.1.11. Customizing the search interface

3.2. Searching with the KDE KIO slave

3.2.1. What's this
3.2.2. Searchable documents

3.3. Searching on the command line

3.4. The query language

3.4.1. Modifiers

3.5. Anchored searches and wildcards

3.5.1. More about wildcards
3.5.2. Anchored searches

3.6. Desktop integration

3.6.1. Hotkeying recoll
3.6.2. The KDE Kicker Recoll applet

4. Programming interface

4.1. Writing a document filter

4.1.1. Simple filters
4.1.2. Telling Recoll about the filter
4.1.3. Filter HTML output

4.2. Field data processing

4.3. API

4.3.1. Interface elements
4.3.2. Python interface

5. Installation and configuration

5.1. Installing a binary copy

5.1.1. Installing through a package system
5.1.2. Installing a prebuilt Recoll

5.2. Supporting packages

5.3. Building from source

5.3.1. Prerequisites
5.3.2. Building
5.3.3. Installation

5.4. Configuration overview

5.4.1. Main configuration file
5.4.2. The fields file
5.4.3. The mimemap file
5.4.4. The mimeconf file
5.4.5. The mimeview file
5.4.6. Examples of configuration adjustments

		Next
		Introduction