|
a/src/doc/user/usermanual.xml |
|
b/src/doc/user/usermanual.xml |
|
... |
|
... |
| 3 |
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
3 |
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
| 4 |
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
4 |
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
| 5 |
|
5 |
|
| 6 |
<!ENTITY RCL "<application>Recoll</application>">
|
6 |
<!ENTITY RCL "<application>Recoll</application>">
|
| 7 |
<!ENTITY RCLAPPS "<ulink url='http://www.recoll.org/features.html#doctypes'>http://www.recoll.org/features.html</ulink>">
|
7 |
<!ENTITY RCLAPPS "<ulink url='http://www.recoll.org/features.html#doctypes'>http://www.recoll.org/features.html</ulink>">
|
| 8 |
<!ENTITY RCLVERSION "1.23">
|
8 |
<!ENTITY RCLVERSION "1.24">
|
| 9 |
<!ENTITY XAP "<application>Xapian</application>">
|
9 |
<!ENTITY XAP "<application>Xapian</application>">
|
| 10 |
<!ENTITY WIN "<application>Windows</application>">
|
10 |
<!ENTITY WIN "<application>Windows</application>">
|
| 11 |
<!ENTITY FAQS "https://www.lesbonscomptes.com/recoll/faqsandhowtos/">
|
11 |
<!ENTITY FAQS "https://www.lesbonscomptes.com/recoll/faqsandhowtos/">
|
| 12 |
]>
|
12 |
]>
|
| 13 |
|
13 |
|
|
... |
|
... |
| 1468 |
the daemon runs permanently, the log file may grow quite big,
|
1468 |
the daemon runs permanently, the log file may grow quite big,
|
| 1469 |
depending on the log level.</para>
|
1469 |
depending on the log level.</para>
|
| 1470 |
|
1470 |
|
| 1471 |
<para>When building &RCL;, the real time indexing support can be
|
1471 |
<para>When building &RCL;, the real time indexing support can be
|
| 1472 |
customised during package <link
|
1472 |
customised during package <link
|
| 1473 |
linkend="RCL.INSTALL.BUILDING.BUILD">configuration</link> with
|
1473 |
linkend="RCL.INSTALL.BUILDING">configuration</link> with
|
| 1474 |
the <option>--with[out]-fam</option> or
|
1474 |
the <option>--with[out]-fam</option> or
|
| 1475 |
<option>--with[out]-inotify</option> options. The default is
|
1475 |
<option>--with[out]-inotify</option> options. The default is
|
| 1476 |
currently to include <application>inotify</application>
|
1476 |
currently to include <application>inotify</application>
|
| 1477 |
monitoring on systems that support it, and, as of &RCL; 1.17,
|
1477 |
monitoring on systems that support it, and, as of &RCL; 1.17,
|
| 1478 |
<application>gamin</application> support on
|
1478 |
<application>gamin</application> support on
|
|
... |
|
... |
| 4815 |
|
4815 |
|
| 4816 |
<para>We will describe the new API and package structure here. A
|
4816 |
<para>We will describe the new API and package structure here. A
|
| 4817 |
paragraph at the end of this section will explain a few differences
|
4817 |
paragraph at the end of this section will explain a few differences
|
| 4818 |
and ways to write code compatible with both versions.</para>
|
4818 |
and ways to write code compatible with both versions.</para>
|
| 4819 |
|
4819 |
|
| 4820 |
<para>The Python interface can be found in the source package,
|
4820 |
<para>There is a good chance that your system repository has
|
| 4821 |
under <filename>python/recoll</filename>.</para>
|
4821 |
packages for the Recoll Python API, sometimes in a package separate
|
| 4822 |
|
4822 |
from the main one (maybe named something like python-recoll). Else
|
| 4823 |
<para>The <filename>python/recoll/</filename> directory
|
4823 |
refer to the <link linkend="RCL.INSTALL.BUILDING">Building from
|
| 4824 |
contains the usual <filename>setup.py</filename>. After
|
4824 |
source chapter</link>.</para>
|
| 4825 |
configuring the main &RCL; code, you can use the script to
|
|
|
| 4826 |
build and install the Python module:
|
|
|
| 4827 |
<screen>
|
|
|
| 4828 |
<userinput>cd recoll-xxx/python/recoll</userinput>
|
|
|
| 4829 |
<userinput>python setup.py build</userinput>
|
|
|
| 4830 |
<userinput>python setup.py install</userinput>
|
|
|
| 4831 |
</screen>
|
|
|
| 4832 |
</para>
|
|
|
| 4833 |
|
|
|
| 4834 |
<para>As of &RCL; 1.19, the module can be compiled for
|
|
|
| 4835 |
Python3.</para>
|
|
|
| 4836 |
|
|
|
| 4837 |
<para>The normal &RCL; installer installs the Python2
|
|
|
| 4838 |
API along with the main code. The Python3 version must be
|
|
|
| 4839 |
explicitely built and installed.</para>
|
|
|
| 4840 |
|
|
|
| 4841 |
<para>When installing from a repository, and depending on the
|
|
|
| 4842 |
distribution, the Python API can sometimes be found in a
|
|
|
| 4843 |
separate package.</para>
|
|
|
| 4844 |
|
4825 |
|
| 4845 |
<para>As an introduction, the following small sample will run a
|
4826 |
<para>As an introduction, the following small sample will run a
|
| 4846 |
query and list the title and url for each of the results. It would
|
4827 |
query and list the title and url for each of the results. It would
|
| 4847 |
work with &RCL; 1.19 and later. The
|
4828 |
work with &RCL; 1.19 and later. The
|
| 4848 |
<filename>python/samples</filename> source directory contains
|
4829 |
<filename>python/samples</filename> source directory contains
|
|
... |
|
... |
| 4861 |
results = query.fetchmany(20)
|
4842 |
results = query.fetchmany(20)
|
| 4862 |
for doc in results:
|
4843 |
for doc in results:
|
| 4863 |
print(doc.url, doc.title)
|
4844 |
print(doc.url, doc.title)
|
| 4864 |
]]></programlisting>
|
4845 |
]]></programlisting>
|
| 4865 |
|
4846 |
|
|
|
4847 |
<para>You can also take a look at the source for the <ulink
|
|
|
4848 |
url="https://github.com/koniu/recoll-webui">Recoll
|
|
|
4849 |
WebUI</ulink>, or the <ulink url="https://opensourceprojects.eu/p/upmpdcli/code/ci/c8c8e75bd181ad9db2df14da05934e53ca867a06/tree/src/mediaserver/cdplugins/uprcl/uprclfolders.py">upmpdcli local media server</ulink>, which are both
|
|
|
4850 |
based on the Python API.</para>
|
|
|
4851 |
|
| 4866 |
</sect2>
|
4852 |
</sect2>
|
| 4867 |
|
4853 |
|
| 4868 |
<sect2 id="RCL.PROGRAM.PYTHONAPI.ELEMENTS">
|
4854 |
<sect2 id="RCL.PROGRAM.PYTHONAPI.ELEMENTS">
|
| 4869 |
<title>Interface elements</title>
|
4855 |
<title>Interface elements</title>
|
| 4870 |
|
4856 |
|
|
... |
|
... |
| 5892 |
&RCL; download page</ulink> for up to date version
|
5878 |
&RCL; download page</ulink> for up to date version
|
| 5893 |
information.</para>
|
5879 |
information.</para>
|
| 5894 |
|
5880 |
|
| 5895 |
</sect2>
|
5881 |
</sect2>
|
| 5896 |
|
5882 |
|
| 5897 |
<sect2 id="RCL.INSTALL.BUILDING.BUILD">
|
5883 |
<sect2 id="RCL.INSTALL.BUILDING.BUILDING">
|
| 5898 |
<title>Building</title>
|
5884 |
<title>Building</title>
|
| 5899 |
|
5885 |
|
| 5900 |
<para>&RCL; has been built on Linux, FreeBSD, Mac OS X, and Solaris,
|
5886 |
<para>&RCL; has been built on Linux, FreeBSD, Mac OS X, and Solaris,
|
| 5901 |
most versions after 2005 should be ok, maybe some older ones too
|
5887 |
most versions after 2005 should be ok, maybe some older ones too
|
| 5902 |
(Solaris 8 is ok). If you build on another system, and
|
5888 |
(Solaris 8 is ok). If you build on another system, and
|
|
... |
|
... |
| 6008 |
<userinput>./configure</userinput>
|
5994 |
<userinput>./configure</userinput>
|
| 6009 |
<userinput>make</userinput>
|
5995 |
<userinput>make</userinput>
|
| 6010 |
<userinput>(practices usual hardship-repelling invocations)</userinput>
|
5996 |
<userinput>(practices usual hardship-repelling invocations)</userinput>
|
| 6011 |
</screen>
|
5997 |
</screen>
|
| 6012 |
|
5998 |
|
| 6013 |
<para>When building from source cloned from the BitBucket repository,
|
5999 |
<para>When building from source cloned from the git repository,
|
| 6014 |
you also need to install <application>autoconf</application>,
|
6000 |
you also need to install <application>autoconf</application>,
|
| 6015 |
<application>automake</application>, and
|
6001 |
<application>automake</application>, and
|
| 6016 |
<application>libtool</application> and you must execute <literal>sh
|
6002 |
<application>libtool</application> and you must execute <literal>sh
|
| 6017 |
autogen.sh</literal> in the top source directory before running
|
6003 |
autogen.sh</literal> in the top source directory before running
|
| 6018 |
<literal>configure</literal>.</para>
|
6004 |
<literal>configure</literal>.</para>
|
| 6019 |
|
|
|
| 6020 |
<sect3 id="RCL.INSTALL.BUILDING.BUILD.SOLARIS">
|
|
|
| 6021 |
<title>Building on Solaris</title>
|
|
|
| 6022 |
|
|
|
| 6023 |
<para>We did not test building the GUI on Solaris for recent
|
|
|
| 6024 |
versions. You will need at least Qt 4.4. There are some hints
|
|
|
| 6025 |
on <ulink url="http://www.recoll.org/download-1.14.html">an old
|
|
|
| 6026 |
web site page</ulink>, they may still be valid.</para>
|
|
|
| 6027 |
|
|
|
| 6028 |
<para>Someone did test the 1.19 indexer and Python module build,
|
|
|
| 6029 |
they do work, with a few minor glitches. Be sure to use
|
|
|
| 6030 |
GNU <command>make</command> and <command>install</command>.</para>
|
|
|
| 6031 |
</sect3>
|
|
|
| 6032 |
|
|
|
| 6033 |
</sect2>
|
6005 |
</sect2>
|
| 6034 |
|
6006 |
|
| 6035 |
<sect2 id="RCL.INSTALL.BUILDING.INSTALL">
|
6007 |
<sect2 id="RCL.INSTALL.BUILDING.INSTALL">
|
| 6036 |
<title>Installation</title>
|
6008 |
<title>Installing</title>
|
| 6037 |
|
6009 |
|
| 6038 |
<para>Use <userinput>make install</userinput>
|
6010 |
<para>Use <userinput>make install</userinput>
|
| 6039 |
in the root
|
6011 |
in the root
|
| 6040 |
of the source tree. This will copy the commands to
|
6012 |
of the source tree. This will copy the commands to
|
| 6041 |
<filename><replaceable>prefix</replaceable>/bin</filename>
|
6013 |
<filename><replaceable>prefix</replaceable>/bin</filename>
|
|
... |
|
... |
| 6043 |
data to
|
6015 |
data to
|
| 6044 |
<filename><replaceable>prefix</replaceable>/share/recoll</filename>.
|
6016 |
<filename><replaceable>prefix</replaceable>/share/recoll</filename>.
|
| 6045 |
</para>
|
6017 |
</para>
|
| 6046 |
|
6018 |
|
| 6047 |
</sect2>
|
6019 |
</sect2>
|
|
|
6020 |
|
|
|
6021 |
<sect2 id="RCL.INSTALL.BUILDING.PYTHON">
|
|
|
6022 |
<title>Python API package</title>
|
|
|
6023 |
|
|
|
6024 |
<para>The Python interface can be found in the source tree,
|
|
|
6025 |
under the <filename>python/recoll</filename> directory.</para>
|
|
|
6026 |
|
|
|
6027 |
<para>As of &RCL; 1.19, the module can be compiled for
|
|
|
6028 |
Python3.</para>
|
|
|
6029 |
|
|
|
6030 |
<para>The normal &RCL; build procedure (see above) installs the API
|
|
|
6031 |
package for the default system version (python) along with the main
|
|
|
6032 |
code. The package for other Python versions (e.g. python3 if the
|
|
|
6033 |
system default is python2) must be explicitely built and
|
|
|
6034 |
installed.</para>
|
|
|
6035 |
|
|
|
6036 |
<para>The <filename>python/recoll/</filename> directory contains
|
|
|
6037 |
the usual <filename>setup.py</filename>. After configuring and
|
|
|
6038 |
building the main &RCL; code, you can use the script to build and
|
|
|
6039 |
install the Python module:
|
|
|
6040 |
<screen>
|
|
|
6041 |
<userinput>cd recoll-xxx/python/recoll</userinput>
|
|
|
6042 |
<userinput>pythonX setup.py build</userinput>
|
|
|
6043 |
<userinput>sudo pythonX setup.py install</userinput>
|
|
|
6044 |
</screen>
|
|
|
6045 |
</para>
|
|
|
6046 |
|
|
|
6047 |
</sect2>
|
|
|
6048 |
|
|
|
6049 |
<sect2 id="RCL.INSTALL.BUILDING.SOLARIS">
|
|
|
6050 |
<title>Building on Solaris</title>
|
|
|
6051 |
|
|
|
6052 |
<para>We did not test building the GUI on Solaris for recent
|
|
|
6053 |
versions. You will need at least Qt 4.4. There are some hints
|
|
|
6054 |
on <ulink url="http://www.recoll.org/download-1.14.html">an old
|
|
|
6055 |
web site page</ulink>, they may still be valid.</para>
|
|
|
6056 |
|
|
|
6057 |
<para>Someone did test the 1.19 indexer and Python module build,
|
|
|
6058 |
they do work, with a few minor glitches. Be sure to use
|
|
|
6059 |
GNU <command>make</command> and <command>install</command>.</para>
|
|
|
6060 |
</sect2>
|
|
|
6061 |
|
| 6048 |
</sect1>
|
6062 |
</sect1>
|
| 6049 |
|
6063 |
|
| 6050 |
<sect1 id="RCL.INSTALL.CONFIG">
|
6064 |
<sect1 id="RCL.INSTALL.CONFIG">
|
| 6051 |
<title>Configuration overview</title>
|
6065 |
<title>Configuration overview</title>
|
| 6052 |
|
6066 |
|