Recoll user manual i Recoll user manual Recoll user manual ii Copyright © 2005-2013 Jean-Francois Dockes Recoll user manual iii COLLABORATORS TITLE : Recoll user manual ACTION NAME DATE SIGNATURE WRITTEN BY Jean-Francois September 28, 2013 Dockes REVISION HISTORY NUMBER DATE DESCRIPTION NAME Recoll user manual iv Contents 1 Introduction 1 1.1 Giving it a try . .1 1.2 Full text search . .1 1.3 Recoll overview . .1 2 Indexing 3 2.1 Introduction . .3 2.1.1 Indexing modes . .3 2.1.2 Configurations, multiple indexes . .3 2.1.3 Document types . .4 2.1.4 Recovery . .4 2.2 Index storage . .4 2.2.1 Xapian index formats . .5 2.2.2 Security aspects . .5 2.3 Index configuration . .5 2.3.1 Multiple indexes . .6 2.3.2 Index case and diacritics sensitivity . .6 2.3.3 The index configuration GUI . .7 2.4 Indexing WEB pages you wisit . .7 2.5 Extended attributes data . .7 2.6 Importing external tags . .8 2.7 Periodic indexing . .8 2.7.1 Running indexing . .8 2.7.2 Using cron to automate indexing . .8 2.8 Real time indexing . .9 2.8.1 Slowing down the reindexing rate for fast changing files . .9 Recoll user manual v 3 Searching 10 3.1 Searching with the Qt graphical user interface . 10 3.1.1 Simple search . 10 3.1.2 The default result list . 11 3.1.2.1 No results: the spelling suggestions . 12 3.1.2.2 The result list right-click menu . 12 3.1.3 The result table . 13 3.1.4 Displaying thumbnails . 13 3.1.5 The preview window . 13 3.1.5.1 Searching inside the preview . 13 3.1.6 Complex/advanced search . 14 3.1.6.1 Avanced search: the "find" tab . 14 3.1.6.2 Avanced search: the "filter" tab . 15 3.1.6.3 Avanced search history . 15 3.1.7 The term explorer tool . 15 3.1.8 Multiple indexes . 16 3.1.9 Document history . 16 3.1.10 Sorting search results and collapsing duplicates . 16 3.1.11 Search tips, shortcuts . 17 3.1.11.1 Terms and search expansion . 17 3.1.11.2 Working with phrases and proximity . 17 3.1.11.3 Others . 17 3.1.12 Customizing the search interface . 18 3.1.12.1 The result list format . 20 3.1.12.1.1 The paragraph format . 20 3.2 Searching with the KDE KIO slave . 21 3.2.1 What’s this . 21 3.2.2 Searchable documents . 21 3.3 Searching on the command line . 22 3.4 Path translations . 23 3.5 The query language . 23 3.5.1 Modifiers . 25 3.6 Search case and diacritics sensitivity . 26 3.7 Anchored searches and wildcards . 26 3.7.1 More about wildcards . 26 3.7.1.1 Wildcards and path filtering . 27 3.7.2 Anchored searches . 27 3.8 Desktop integration . 27 3.8.1 Hotkeying recoll . 27 3.8.2 The KDE Kicker Recoll applet . 28 Recoll user manual vi 4 Programming interface 29 4.1 Writing a document filter . 29 4.1.1 Simple filters . 30 4.1.2 "Multiple" filters . 30 4.1.3 Telling Recoll about the filter . 30 4.1.4 Filter HTML output . 31 4.1.5 Page numbers . 32 4.2 Field data processing . 32 4.3 API .......................................................... 33 4.3.1 Interface elements . 33 4.3.2 Python interface . 33 4.3.2.1 Introduction . 33 4.3.2.2 Recoll package . ..