helm interface for the recoll desktop search tool.
Switch branches/tags
Clone or download
csantosb Bump to 0.5 stable
This makes is available on melpa

- updated helm version dependency
- updated minimum emacs to 24.4 as we approach 25.1
- link to recoll site
Latest commit cc4c4fa Jul 31, 2016

README.org

Helm-Recoll

http://img.shields.io/badge/license-GNU%20GPLv3-blue.svg http://stable.melpa.org/packages/helm-recoll-badge.svg http://melpa.org/packages/helm-recoll-badge.svg

Helm interface for the recoll desktop search tool.

Table of contents

Commentary

You need to create some helm-recoll sources before you can use them. You can create sources using the helm-recoll-create-source macro, e.g. like this:

(helm-recoll-create-source "docs" "~/.recoll/docs")
(helm-recoll-create-source "progs" "~/.recoll/progs")

helm-recoll-create-source defines a source named helm-source-recoll-NAME and an individual command named helm-recoll-NAME for every defined source. With the above definitions, the commands helm-recoll-docs and helm-recoll-progs would be provided and start a Helm session for the created helm-source-recoll-docs and helm-source-recoll-progs sources respectivly.

In addition, the command helm-recoll lists all currently defined recoll sources, and starts a helm session running the selected ones.

Installation

Add a require statement for the library:

(require 'helm-recoll)

to your init file (typically ~/.emacs) and add your source definitions like shown above.

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.