summaryrefslogtreecommitdiff
path: root/desktop/recoll/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/recoll/README')
-rw-r--r--desktop/recoll/README28
1 files changed, 28 insertions, 0 deletions
diff --git a/desktop/recoll/README b/desktop/recoll/README
new file mode 100644
index 0000000000..b1312e2f1a
--- /dev/null
+++ b/desktop/recoll/README
@@ -0,0 +1,28 @@
+recoll (personal full text search tool)
+
+Recoll is a personal full text search tool for Unix/Linux.
+It is based on the very strong Xapian backend, for which it
+provides an easy to use, feature-rich, easy administration,
+QT graphical interface.
+
+The homepage of recoll is found at http://www.lesbonscomptes.com/recoll/
+
+recoll depends on some other packages, that are not met by a
+standard Slackware install. All these should be covered by seperate
+build scripts. These dependencies are:
+
+Required:
+ xapian-core (http://www.xapian.org/)
+Optional:
+ antiword (http://www.winfield.demon.nl/)
+ unrtf (http://www.gnu.org/software/unrtf/unrtf.html)
+
+NOTE: As of the time of writing, recoll depends on version 0.9.10 of
+xapian-core, the newer 1.0.0 release does NOT work with this version
+of recoll.
+Else no incompatibilities are known.
+
+After installing the package you should create the file
+$HOME/.recoll/recoll.conf and modify it to your needs, especially the
+"topdirs" where recoll looks for files to index. See "man recoll.conf"
+for details.