diff --git a/src/kde/kioslave/recoll/00README.txt b/src/kde/kioslave/recoll/00README.txt index 642e97b8..981a4cfe 100644 --- a/src/kde/kioslave/recoll/00README.txt +++ b/src/kde/kioslave/recoll/00README.txt @@ -1,52 +1,74 @@ Recoll KIO slave ================ -This is a small experiment with a recoll KIO slave +An experiment with a recoll KIO slave. -It does not appear terribly useful as such, especially because I -couldn't think of a way to get access to email documents from -Konqueror (especially those inside a multi-msg folder file, it's -better with maildir). The Recoll preview feature is actually quite -useful in this case. But anyway, here it is... +Caveat: I am only currently testing this with a production, but very +recent, version of KDE 4.1, and I don't intend to really support +older versions. The most usable aspects work under KDE 4.0 though. As +a reference, my test system is an up to date (2009-01) Kubuntu 8.10. + +Usage +===== + +Depending on the protocol name used, the search results will be +returned either as HTML pages (looking quite like a normal Recoll +result list), or as directory entries. + +The HTML mode only works with Konqueror, not Dolphin. The directory +mode is available with both browsers, and also application open dialog +(ie Kate). + +The HTML mode is much more usable than the directory mode at this point + +More detailed help/explanations can be found a document accessible +from the slave: + +To try things out, after building and installing, enter "recoll:/" in +a Konqueror URL entry. Depending on the KDE version, this will bring +you either to an HTML search form, or to a directory listing, where +you should READ THE HELP FILE. Building and installing: ======================= -This began under KDE3 and might still be made to work, but I only -built with KDE4 and cmake recently. Full functionality is only -available with KDE 4.1 and later. +The directory mode is only available with KDE 4.1 and later. This +began under KDE3 and might still be made to work, but I only built +with KDE4 and cmake recently. The main Recoll installation shares its prefix with the KIO slave, which needs to use the KDE one. This means that, if KDE lives in /usr, Recoll must be configured with --prefix=/usr, not /usr/local. Else you'll have run-time problems, the slave will not be able to find the -recoll configuration. +Recoll configuration. -A kind of recipe: - - You need the KDE4 core devel packages and cmake installed +Recipe: + - Make sure the KDE4 core devel packages and cmake are installed. - - Extract the recoll source, configure recoll with --prefix=/usr - build and install recoll (or use another prefix if KDE lives elsewhere). + - Extract the Recoll source, configure recoll with --prefix=/usr + (or wherever KDE lives), build and install Recoll. - - In the recoll source, go to kde/kioslave/recoll, then execute: + - In the Recoll source, go to kde/kioslave/recoll, then build and + install the kio slave: - mkdir builddir - cd builddir - cmake .. -DCMAKE_INSTALL_PREFIX=/usr - make - sudo make install +mkdir builddir +cd builddir +cmake .. -DCMAKE_INSTALL_PREFIX=/usr +make +sudo make install - You should have a look at where "make install" copies things, - because wrong targets are frequent. Especially, you should check - that kio_recoll.so is copied to the right place, meaning among the - output of "kde4-config --path module". As an additional check, - there should be many other kio_[xxx].so in there. Same for the - protocol file, check that it's not alone in its directory (really, - this sounds strange, but, to this point, I've seen more systems - with broken cmake/KDE configs than correct ones). + because misconfigured distribution, generating wrong targets, are + frequent. Especially, you should check that kio_recoll.so is copied + to the right place, meaning among the output of "kde4-config --path + module". As an additional check, there should be many other + kio_[xxx].so in there. Same for the protocol file, check that it's + not alone in its directory (really, this sounds strange, but, to + this point, I've seen more systems with broken cmake/KDE configs + than correct ones). You need to build/update the index with recollindex, the KIO slave -doesn't deal with it for now. +doesn't deal with indexing for now. Misc build problems: @@ -63,15 +85,3 @@ Found no way to fix this. You need to edit the line and replace the following error message: make[2]: *** No rule to make target `/build/buildd/kde4libs-4.1.2/obj-i486-linux-gnu/lib/libkdecore.so', needed by `lib/kio_recoll.so'. Stop. - - - -Usage -===== -You should then be able to enter "recoll:" in the konqueror URL -entry. Depending on the KDE version, this will bring you either to an -HTML search form, or to a directory listing, where you should read the -help file, which explains how to switch between the HTML and -directory-oriented interfaces. - - diff --git a/src/kde/kioslave/recoll/CMakeLists.txt b/src/kde/kioslave/recoll/CMakeLists.txt index c1e063ea..97017286 100644 --- a/src/kde/kioslave/recoll/CMakeLists.txt +++ b/src/kde/kioslave/recoll/CMakeLists.txt @@ -56,7 +56,6 @@ ${rcltop}/query/plaintorich.cpp ${rcltop}/query/reslistpager.cpp ${rcltop}/query/wasastringtoquery.cpp ${rcltop}/query/wasatorcl.cpp -${rcltop}/rcldb/pathhash.cpp ${rcltop}/rcldb/rcldb.cpp ${rcltop}/rcldb/rcldoc.cpp ${rcltop}/rcldb/rclquery.cpp diff --git a/src/kde/kioslave/recoll/data/help.html b/src/kde/kioslave/recoll/data/help.html index ae2e9b3f..689cbdf8 100644 --- a/src/kde/kioslave/recoll/data/help.html +++ b/src/kde/kioslave/recoll/data/help.html @@ -8,9 +8,7 @@

Recoll kio slave

Use this module to perform Recoll searches from any program with - a KIO interface. kio_recoll is primarily - designed and tested with konqueror, and you will - undoubtedly get even more surprising effects with other tools.

+ a KIO interface.

The module can work in two modes: