diff --git a/src/kde/kioslave/recoll/CMakeLists.txt b/src/kde/kioslave/recoll/CMakeLists.txt index 20753667..4c5ca150 100644 --- a/src/kde/kioslave/recoll/CMakeLists.txt +++ b/src/kde/kioslave/recoll/CMakeLists.txt @@ -123,5 +123,5 @@ ELSE ("${KDE_VERSION_MAJOR}.${KDE_VERSION_MINOR}" GREATER 4.0) RENAME recoll.protocol) ENDIF ("${KDE_VERSION_MAJOR}.${KDE_VERSION_MINOR}" GREATER 4.0) -install(FILES data/welcome.html +install(FILES data/welcome.html data/help.html DESTINATION ${DATA_INSTALL_DIR}/kio_recoll) diff --git a/src/kde/kioslave/recoll/cleancmakestuff.sh b/src/kde/kioslave/recoll/cleancmakestuff.sh index 180d2eee..fd97efee 100644 --- a/src/kde/kioslave/recoll/cleancmakestuff.sh +++ b/src/kde/kioslave/recoll/cleancmakestuff.sh @@ -1,2 +1,6 @@ #!/bin/sh -rm -rf CMakeCache.txt CMakeFiles cmake_install.cmake CMakeTmp cmake_uninstall.cmake CPackConfig.cmake CPackSourceConfig.cmake DartTestfile.txt install_manifest.txt kio_recoll_automoc.cpp kio_recoll_automoc.cpp.files kio_recoll.la kio_recoll.so lib Makefile +rm -rf CMakeCache.txt CMakeFiles CTestTestfile.cmake \ + cmake_install.cmake CMakeTmp cmake_uninstall.cmake \ + CPackConfig.cmake CPackSourceConfig.cmake DartTestfile.txt \ + install_manifest.txt kio_recoll_automoc.cpp \ + kio_recoll_automoc.cpp.files kio_recoll.la kio_recoll.so lib Makefile diff --git a/src/kde/kioslave/recoll/data/help.html b/src/kde/kioslave/recoll/data/help.html new file mode 100644 index 00000000..c953740b --- /dev/null +++ b/src/kde/kioslave/recoll/data/help.html @@ -0,0 +1,62 @@ + +
+ +Use this module to perform Recoll searches from any program with + a KIO interface (sort of...). kio_recoll is primarily + designed and tested with konqueror, and you will + undoubtedly get even more surprising effects with other tools.
+ +The module can work in two different modes, depending on the form + of the URLS that it is given:
+Please note that this module is still in its infancy and that it + is still more a toy than anything else. The semantics of the + KIO slaves interface is still a bit unstable between KDE releases, + you will certainly get surprising effects from time to time.
+ +This works more or less like the Recoll QT GUI, much + simplified. The + + Recoll manual describes the queries that can be + performed.
+Most pages in the interface should quite self-explanatory.
+ +kio_recoll enters this mode when it receives an URL ending with + a '/', ie:
+recoll:///xapian recoll ext:.html/+ +
The path part of the URI is taken as a Recoll query + language string and executed. The results are displayed as + directory entries.
+ +This works fine with normal documents, very badly with message + inside folders, which Konqueror has no way to access.
+ +As there is no provision to page directory listings, the number + of results returned is limited to a fixed value, 100 by default, + which you can change by setting the kio_max_direntries in your + Recoll configuration file (usually ~/.recoll). + + More information about Recoll configuration.
+ +This interface is very limited, but allows performing multiple + selection, copies, and other file operations on the results, which + may be useful in some cases (or not :))
+ + + diff --git a/src/kde/kioslave/recoll/data/welcome.html b/src/kde/kioslave/recoll/data/welcome.html index b13ff2b7..7bae851b 100644 --- a/src/kde/kioslave/recoll/data/welcome.html +++ b/src/kde/kioslave/recoll/data/welcome.html @@ -7,14 +7,19 @@