From 8c147506811280167cc9d5411a6eb8a40afc3a6d Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Mon, 2 Jul 2018 15:50:55 +0200 Subject: [PATCH] doc: update the build instruction, esp. python package --- src/doc/user/usermanual.html | 144 +++++++++++++++++++++-------------- src/doc/user/usermanual.xml | 102 ++++++++++++++----------- 2 files changed, 146 insertions(+), 100 deletions(-) diff --git a/src/doc/user/usermanual.html b/src/doc/user/usermanual.html index bcd911c3..02b6e877 100644 --- a/src/doc/user/usermanual.html +++ b/src/doc/user/usermanual.html @@ -376,9 +376,15 @@ alink="#0000FF">
6.3.1. Prerequisites
6.3.2. Building
+ "#RCL.INSTALL.BUILDING.BUILDING">Building
6.3.3. Installation
+ "#RCL.INSTALL.BUILDING.INSTALL">Installing +
6.3.4. Python API + package
+
6.3.5. Building on + Solaris
6.4. grow quite big, depending on the log level.

When building Recoll, the real time indexing support can be customised during - package configuration with the + package configuration with the --with[out]-fam or --with[out]-inotify options. The default is currently to include -

The Python interface can be found in the source - package, under python/recoll.

-

The python/recoll/ - directory contains the usual setup.py. After configuring the main - Recoll code, you can use - the script to build and install the Python module:

- 
-          cd recoll-xxx/python/recoll
-          python setup.py build
-          python setup.py install
-
-

As of Recoll 1.19, - the module can be compiled for Python3.

-

The normal Recoll - installer installs the Python2 API along with the main - code. The Python3 version must be explicitely built and - installed.

-

When installing from a repository, and depending on - the distribution, the Python API can sometimes be found - in a separate package.

+

There is a good chance that your system repository has + packages for the Recoll Python API, sometimes in a + package separate from the main one (maybe named something + like python-recoll). Else refer to the Building from source + chapter.

As an introduction, the following small sample will run a query and list the title and url for each of the results. It would work with +

You can also take a look at the source for the + Recoll WebUI, or the upmpdcli local media server, which are + both based on the Python API.

@@ -7575,8 +7570,8 @@ for i in range(nres):

6.3.2. Building

+ "RCL.INSTALL.BUILDING.BUILDING" id= + "RCL.INSTALL.BUILDING.BUILDING">6.3.2. Building
@@ -7718,7 +7713,7 @@ for i in range(nres): (practices usual hardship-repelling invocations) -

When building from source cloned from the BitBucket +

When building from source cloned from the git repository, you also need to install autoconf, automake, and sh autogen.sh in the top source directory before running configure.

-
-
-
-
-

6.3.2.1. Building - on Solaris

-
-
-
-

We did not test building the GUI on Solaris for - recent versions. You will need at least Qt 4.4. There - are some hints on an old web site page, they may still be - valid.

-

Someone did test the 1.19 indexer and Python module - build, they do work, with a few minor glitches. Be sure - to use GNU make and install.

-
@@ -7756,7 +7728,7 @@ for i in range(nres):

6.3.3. Installation

+ "RCL.INSTALL.BUILDING.INSTALL">6.3.3. Installing
@@ -7769,6 +7741,66 @@ for i in range(nres): to prefix/share/recoll.

+
+
+
+
+

6.3.4. Python + API package

+
+
+
+

The Python interface can be found in the source tree, + under the python/recoll + directory.

+

As of Recoll 1.19, + the module can be compiled for Python3.

+

The normal Recoll + build procedure (see above) installs the API package for + the default system version (python) along with the main + code. The package for other Python versions (e.g. python3 + if the system default is python2) must be explicitely + built and installed.

+

The python/recoll/ + directory contains the usual setup.py. After configuring and + building the main Recoll + code, you can use the script to build and install the + Python module:

+ 
+          cd recoll-xxx/python/recoll
+          pythonX setup.py build
+          sudo pythonX setup.py install
+
+
+
+
+
+
+

6.3.5. Building + on Solaris

+
+
+
+

We did not test building the GUI on Solaris for recent + versions. You will need at least Qt 4.4. There are some + hints on an old web site page, they may still be + valid.

+

Someone did test the 1.19 indexer and Python module + build, they do work, with a few minor glitches. Be sure + to use GNU make and install.

+
diff --git a/src/doc/user/usermanual.xml b/src/doc/user/usermanual.xml index ed15176c..030d2f33 100644 --- a/src/doc/user/usermanual.xml +++ b/src/doc/user/usermanual.xml @@ -5,7 +5,7 @@ Recoll"> http://www.recoll.org/features.html"> - + Xapian"> Windows"> @@ -1470,7 +1470,7 @@ When building &RCL;, the real time indexing support can be customised during package configuration with + linkend="RCL.INSTALL.BUILDING">configuration with the or options. The default is currently to include inotify @@ -4817,30 +4817,11 @@ recollindex -c "$confdir" paragraph at the end of this section will explain a few differences and ways to write code compatible with both versions. - The Python interface can be found in the source package, - under python/recoll. - - The python/recoll/ directory - contains the usual setup.py. After - configuring the main &RCL; code, you can use the script to - build and install the Python module: - - cd recoll-xxx/python/recoll - python setup.py build - python setup.py install - - - - As of &RCL; 1.19, the module can be compiled for - Python3. - - The normal &RCL; installer installs the Python2 - API along with the main code. The Python3 version must be - explicitely built and installed. - - When installing from a repository, and depending on the - distribution, the Python API can sometimes be found in a - separate package. + There is a good chance that your system repository has + packages for the Recoll Python API, sometimes in a package separate + from the main one (maybe named something like python-recoll). Else + refer to the Building from + source chapter. As an introduction, the following small sample will run a query and list the title and url for each of the results. It would @@ -4863,6 +4844,11 @@ recollindex -c "$confdir" print(doc.url, doc.title) ]]> + You can also take a look at the source for the Recoll + WebUI, or the upmpdcli local media server, which are both + based on the Python API. + @@ -5894,7 +5880,7 @@ for i in range(nres): - + Building &RCL; has been built on Linux, FreeBSD, Mac OS X, and Solaris, @@ -6010,30 +5996,16 @@ for i in range(nres): (practices usual hardship-repelling invocations) - When building from source cloned from the BitBucket repository, + When building from source cloned from the git repository, you also need to install autoconf, automake, and libtool and you must execute sh autogen.sh in the top source directory before running configure. - - - Building on Solaris - - We did not test building the GUI on Solaris for recent - versions. You will need at least Qt 4.4. There are some hints - on an old - web site page, they may still be valid. - - Someone did test the 1.19 indexer and Python module build, - they do work, with a few minor glitches. Be sure to use - GNU make and install. - - - + - Installation + Installing Use make install in the root @@ -6045,6 +6017,48 @@ for i in range(nres): + + + Python API package + + The Python interface can be found in the source tree, + under the python/recoll directory. + + As of &RCL; 1.19, the module can be compiled for + Python3. + + The normal &RCL; build procedure (see above) installs the API + package for the default system version (python) along with the main + code. The package for other Python versions (e.g. python3 if the + system default is python2) must be explicitely built and + installed. + + The python/recoll/ directory contains + the usual setup.py. After configuring and + building the main &RCL; code, you can use the script to build and + install the Python module: + + cd recoll-xxx/python/recoll + pythonX setup.py build + sudo pythonX setup.py install + + + + + + + Building on Solaris + + We did not test building the GUI on Solaris for recent + versions. You will need at least Qt 4.4. There are some hints + on an old + web site page, they may still be valid. + + Someone did test the 1.19 indexer and Python module build, + they do work, with a few minor glitches. Be sure to use + GNU make and install. + +