doc
This commit is contained in:
Jean-Francois Dockes
parent
9a7561517f
commit
eb96263ab9
@ -8351,38 +8351,69 @@ hasextract = False
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<p>The following prerequisites are described in broad
|
<p>The following prerequisites are described in broad
|
||||||
terms and not as specific package names (which will
|
terms and Debian package names. The dependencies should
|
||||||
depend on the exact platform). The dependencies should be
|
be available as packages on most common Unix derivatives,
|
||||||
available as packages on most common Unix derivatives,
|
|
||||||
and it should be quite uncommon that you would have to
|
and it should be quite uncommon that you would have to
|
||||||
build one of them.</p>
|
build one of them. Finding the right package name for
|
||||||
|
other systems is left to the sagacity of the reader.</p>
|
||||||
<p>If you do not need the GUI, you can avoid all GUI
|
<p>If you do not need the GUI, you can avoid all GUI
|
||||||
dependencies by disabling its build. (See the configure
|
dependencies by disabling its build. (See the configure
|
||||||
section further).</p>
|
section further).</p>
|
||||||
<p>The shopping list:</p>
|
<p>The shopping list follows:</p>
|
||||||
<div class="itemizedlist">
|
<div class="itemizedlist">
|
||||||
<ul class="itemizedlist" style=
|
<ul class="itemizedlist" style=
|
||||||
"list-style-type: disc;">
|
"list-style-type: disc;">
|
||||||
<li class="listitem">
|
<li class="listitem">
|
||||||
<p>If you start from git code, you will need the
|
<p>If you start from git code, you will need the
|
||||||
|
<span class="command"><strong>git</strong></span>
|
||||||
|
command (<code class="literal">git</code>), and the
|
||||||
<span class=
|
<span class=
|
||||||
"command"><strong>autoconf</strong></span>,
|
"command"><strong>autoconf</strong></span>,
|
||||||
<span class=
|
<span class=
|
||||||
"command"><strong>automake</strong></span> and
|
"command"><strong>automake</strong></span> and
|
||||||
<span class=
|
<span class=
|
||||||
"command"><strong>libtool</strong></span> triad.
|
"command"><strong>libtool</strong></span> triad
|
||||||
They are not needed for building from tar
|
(<code class="literal">autoconf</code>,
|
||||||
distributions.</p>
|
<code class="literal">automake</code>, <code class=
|
||||||
|
"literal">libtool</code>). These are not needed for
|
||||||
|
building from tar distributions.</p>
|
||||||
</li>
|
</li>
|
||||||
<li class="listitem">
|
<li class="listitem">
|
||||||
<p>C++ compiler. Recent versions require C++11
|
<p>The pkg-config command and gettext package are
|
||||||
compatibility (1.23 and later).</p>
|
needed for configuring the build (<code class=
|
||||||
|
"literal">pkg-config</code>, <code class=
|
||||||
|
"literal">gettext</code>).</p>
|
||||||
</li>
|
</li>
|
||||||
<li class="listitem">
|
<li class="listitem">
|
||||||
<p><span class=
|
<p>The <span class=
|
||||||
"command"><strong>bison</strong></span> command
|
"command"><strong>make</strong></span> command
|
||||||
(for <span class="application">Recoll</span> 1.21
|
(<code class="literal">make</code> which will
|
||||||
and later).</p>
|
actually install <span class="application">GNU
|
||||||
|
make</span> on Linux). If you get strange error
|
||||||
|
messages about dependency tracking from
|
||||||
|
<span class="command"><strong>configure</strong></span>,
|
||||||
|
you probably forgot to install <span class=
|
||||||
|
"command"><strong>make</strong></span>.</p>
|
||||||
|
</li>
|
||||||
|
<li class="listitem">
|
||||||
|
<p>A C++ compiler with at least C++11 compatibility
|
||||||
|
(<code class="literal">g++</code> or <code class=
|
||||||
|
"literal">clang</code>).</p>
|
||||||
|
</li>
|
||||||
|
<li class="listitem">
|
||||||
|
<p>The <span class=
|
||||||
|
"command"><strong>bison</strong></span> command is
|
||||||
|
not generally needed, but might be if some file
|
||||||
|
modification times are not right.</p>
|
||||||
|
</li>
|
||||||
|
<li class="listitem">
|
||||||
|
<p>If you want to process CHM files, you will need
|
||||||
|
libchm (<code class="literal">libchm-dev</code>),
|
||||||
|
else you can set the <code class=
|
||||||
|
"literal">--disable-python-chm</code> option to the
|
||||||
|
<span class=
|
||||||
|
"command"><strong>configure</strong></span>
|
||||||
|
command</p>
|
||||||
</li>
|
</li>
|
||||||
<li class="listitem">
|
<li class="listitem">
|
||||||
<p>For building the documentation: the <span class=
|
<p>For building the documentation: the <span class=
|
||||||
@ -8397,38 +8428,58 @@ hasextract = False
|
|||||||
<li class="listitem">
|
<li class="listitem">
|
||||||
<p>Development files for <a class="ulink" href=
|
<p>Development files for <a class="ulink" href=
|
||||||
"http://www.xapian.org" target="_top"><span class=
|
"http://www.xapian.org" target="_top"><span class=
|
||||||
"application">Xapian core</span></a>.</p>
|
"application">Xapian core</span></a> (<code class=
|
||||||
|
"literal">libxapian-dev</code>).</p>
|
||||||
<div class="important" style=
|
<div class="important" style=
|
||||||
"margin-left: 0.5in; margin-right: 0.5in;">
|
"margin-left: 0.5in; margin-right: 0.5in;">
|
||||||
<h3 class="title">Important</h3>
|
<h3 class="title">Important</h3>
|
||||||
<p>If you are building Xapian for an older CPU
|
<p>If you are building Xapian for an older CPU
|
||||||
(before Pentium 4 or Athlon 64), you need to add
|
(before Pentium 4 or Athlon 64), you need to add
|
||||||
the <code class="option">--disable-sse</code>
|
the <code class="option">--disable-sse</code>
|
||||||
flag to the configure command. Else all Xapian
|
flag to the <span class=
|
||||||
application will crash with an <code class=
|
"command"><strong>configure</strong></span>
|
||||||
"literal">illegal instruction</code> error.</p>
|
command. Else all Xapian applications will crash
|
||||||
|
with an <code class="literal">illegal
|
||||||
|
instruction</code> error.</p>
|
||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
<li class="listitem">
|
<li class="listitem">
|
||||||
<p>Development files for <a class="ulink" href=
|
<p>Development files for <span class=
|
||||||
|
"application">libxslt</span> (<code class=
|
||||||
|
"literal">libxslt1-dev</code>).</p>
|
||||||
|
</li>
|
||||||
|
<li class="listitem">
|
||||||
|
<p>Development files for <span class=
|
||||||
|
"application">zlib</span> (<code class=
|
||||||
|
"literal">zlib1g-dev</code>).</p>
|
||||||
|
</li>
|
||||||
|
<li class="listitem">
|
||||||
|
<p>If you want to build the GUI: development files
|
||||||
|
for <a class="ulink" href=
|
||||||
"http://qt-project.org/downloads" target=
|
"http://qt-project.org/downloads" target=
|
||||||
"_top"><span class="application">Qt 5</span></a> .
|
"_top"><span class="application">Qt 5</span></a>.
|
||||||
and its own dependencies (X11 etc.)</p>
|
Else give the <code class=
|
||||||
</li>
|
"literal">--disable-qtgui</code> option to the
|
||||||
<li class="listitem">
|
<span class=
|
||||||
<p>Development files for libxslt</p>
|
"command"><strong>configure</strong></span>
|
||||||
|
command. I can never remember what package to
|
||||||
|
install to get this, but installing the Qt5 Webkit,
|
||||||
|
(or Qt5 Webengine if you set <code class=
|
||||||
|
"literal">--enable-webengine</code>) will bring the
|
||||||
|
rest as dependencies (<code class=
|
||||||
|
"literal">libqt5webkit5-dev</code> or <code class=
|
||||||
|
"literal">qtwebengine5dev</code>).</p>
|
||||||
</li>
|
</li>
|
||||||
<li class="listitem">
|
<li class="listitem">
|
||||||
<p>Development files for <span class=
|
<p>Development files for <span class=
|
||||||
"application">zlib</span>.</p>
|
"application">Python</span> (<code class=
|
||||||
</li>
|
"literal">python2-dev</code>, <code class=
|
||||||
<li class="listitem">
|
"literal">python-setuptools</code>, <code class=
|
||||||
<p>Development files for <span class=
|
"literal">python3-all-dev</code>, <code class=
|
||||||
"application">Python</span> (or use <code class=
|
"literal">python3-setuptools</code>). You can use
|
||||||
"literal">--disable-python-module</code>).</p>
|
the <code class=
|
||||||
</li>
|
"literal">--disable-python-module</code> option for
|
||||||
<li class="listitem">
|
disabling the build of the Python extensions).</p>
|
||||||
<p>Development files for libchm</p>
|
|
||||||
</li>
|
</li>
|
||||||
<li class="listitem">
|
<li class="listitem">
|
||||||
<p>You may also need <a class="ulink" href=
|
<p>You may also need <a class="ulink" href=
|
||||||
|
|||||||
@ -6276,68 +6276,90 @@ hasextract = False
|
|||||||
<title>Prerequisites</title>
|
<title>Prerequisites</title>
|
||||||
|
|
||||||
<para>The following prerequisites are described in broad terms and
|
<para>The following prerequisites are described in broad terms and
|
||||||
not as specific package names (which will depend on the exact
|
Debian package names. The dependencies should be available as packages on most common Unix
|
||||||
platform). The dependencies should be available as packages on most
|
derivatives, and it should be quite uncommon that you would have to build one of them.
|
||||||
common Unix derivatives, and it should be quite uncommon that you
|
Finding the right package name for other systems is left to the sagacity of the
|
||||||
would have to build one of them.</para>
|
reader.</para>
|
||||||
|
|
||||||
<para>If you do not need the GUI, you can avoid all GUI
|
<para>If you do not need the GUI, you can avoid all GUI
|
||||||
dependencies by disabling its build. (See the configure section
|
dependencies by disabling its build. (See the configure section
|
||||||
further).</para>
|
further).</para>
|
||||||
|
|
||||||
<para>The shopping list:</para>
|
<para>The shopping list follows:</para>
|
||||||
|
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
|
|
||||||
<listitem><para>If you start from git code, you will need the
|
<listitem><para>If you start from git code, you will need the <command>git</command>
|
||||||
<command>autoconf</command>, <command>automake</command> and
|
command (<literal>git</literal>), and
|
||||||
<command>libtool</command> triad. They are not needed for
|
the <command>autoconf</command>, <command>automake</command>
|
||||||
building from tar distributions.</para></listitem>
|
and <command>libtool</command> triad
|
||||||
|
(<literal>autoconf</literal>, <literal>automake</literal>, <literal>libtool</literal>).
|
||||||
|
These are not needed for building from tar distributions.</para></listitem>
|
||||||
|
|
||||||
<listitem><para>C++ compiler. Recent versions require C++11
|
<listitem><para>The pkg-config command and gettext package are needed for configuring the
|
||||||
compatibility (1.23 and later).</para></listitem>
|
build (<literal>pkg-config</literal>, <literal>gettext</literal>).</para></listitem>
|
||||||
|
|
||||||
<listitem><para><command>bison</command> command (for &RCL; 1.21
|
<listitem><para>The <command>make</command> command (<literal>make</literal> which will
|
||||||
and later).</para></listitem>
|
actually install <application>GNU make</application> on Linux). If you get strange
|
||||||
|
error messages about dependency tracking from <command>configure</command>, you
|
||||||
|
probably forgot to install <command>make</command>.</para></listitem>
|
||||||
|
|
||||||
|
<listitem><para>A C++ compiler with at least C++11 compatibility (<literal>g++</literal>
|
||||||
|
or <literal>clang</literal>).</para></listitem>
|
||||||
|
|
||||||
|
<listitem><para>The <command>bison</command> command is not generally needed, but might be
|
||||||
|
if some file modification times are not right.</para></listitem>
|
||||||
|
|
||||||
|
<listitem><para>If you want to process CHM files, you will need libchm
|
||||||
|
(<literal>libchm-dev</literal>), else you can set
|
||||||
|
the <literal>--disable-python-chm</literal> option to the <command>configure</command>
|
||||||
|
command</para></listitem>
|
||||||
|
|
||||||
<listitem><para>For building the documentation: the
|
<listitem><para>For building the documentation: the
|
||||||
<command>xsltproc</command> command, and the Docbook XML and
|
<command>xsltproc</command> command, and the Docbook XML and
|
||||||
style sheet files. You can avoid this dependency by disabling
|
style sheet files. You can avoid this dependency by disabling
|
||||||
documentation building with the
|
documentation building with the
|
||||||
<literal>--disable-userdoc</literal> <command>configure</command>
|
<literal>--disable-userdoc</literal> <command>configure</command>
|
||||||
option.</para></listitem>
|
option.</para></listitem>
|
||||||
|
|
||||||
<listitem><para>Development files
|
<listitem><para>Development files
|
||||||
for <ulink url="http://www.xapian.org"> <application>Xapian
|
for <ulink url="http://www.xapian.org"> <application>Xapian
|
||||||
core</application></ulink>.</para>
|
core</application></ulink> (<literal>libxapian-dev</literal>).</para>
|
||||||
<important>
|
<important>
|
||||||
<para>If you are building Xapian for an older CPU (before Pentium 4 or Athlon 64), you
|
<para>If you are building Xapian for an older CPU (before Pentium 4 or Athlon 64), you
|
||||||
need to add the <option>--disable-sse</option> flag to the configure command. Else all
|
need to add the <option>--disable-sse</option> flag to
|
||||||
Xapian application will crash with an <literal>illegal instruction</literal>
|
the <command>configure</command> command. Else all Xapian applications will crash with
|
||||||
|
an <literal>illegal instruction</literal>
|
||||||
error.</para>
|
error.</para>
|
||||||
</important>
|
</important>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem> <para>Development files for
|
<listitem><para>Development files for <application>libxslt</application>
|
||||||
<ulink url="http://qt-project.org/downloads"><application>Qt 5</application> </ulink>.
|
(<literal>libxslt1-dev</literal>).</para></listitem>
|
||||||
and its own dependencies (X11 etc.)</para> </listitem>
|
|
||||||
|
|
||||||
<listitem><para>Development files for libxslt</para></listitem>
|
|
||||||
|
|
||||||
<listitem><para>Development files for
|
<listitem><para>Development files for
|
||||||
<application>zlib</application>.</para> </listitem>
|
<application>zlib</application> (<literal>zlib1g-dev</literal>).</para> </listitem>
|
||||||
|
|
||||||
|
<listitem><para>If you want to build the GUI: development files for
|
||||||
|
<ulink url="http://qt-project.org/downloads"><application>Qt 5</application></ulink>.
|
||||||
|
Else give the <literal>--disable-qtgui</literal> option to
|
||||||
|
the <command>configure</command> command. I can never remember what package to install
|
||||||
|
to get this, but installing the Qt5 Webkit, (or Qt5 Webengine if you set
|
||||||
|
<literal>--enable-webengine</literal>) will bring the rest as dependencies
|
||||||
|
(<literal>libqt5webkit5-dev</literal>
|
||||||
|
or <literal>qtwebengine5dev</literal>).</para></listitem>
|
||||||
|
|
||||||
<listitem><para>Development files for
|
<listitem><para>Development files for
|
||||||
<application>Python</application> (or use
|
<application>Python</application>
|
||||||
<literal>--disable-python-module</literal>).</para></listitem>
|
(<literal>python2-dev</literal>, <literal>python-setuptools</literal>,
|
||||||
|
<literal>python3-all-dev</literal>, <literal>python3-setuptools</literal>).
|
||||||
|
You can use the <literal>--disable-python-module</literal> option for disabling the
|
||||||
|
build of the Python extensions).</para></listitem>
|
||||||
|
|
||||||
<listitem><para>Development files for libchm</para></listitem>
|
|
||||||
|
|
||||||
<listitem><para>You may also need
|
<listitem><para>You may also need
|
||||||
<ulink url="http://www.gnu.org/software/libiconv/">libiconv</ulink>.
|
<ulink url="http://www.gnu.org/software/libiconv/">libiconv</ulink>.
|
||||||
|
On <application>Linux</application> systems, the iconv interface is part of libc and you
|
||||||
On <application>Linux</application> systems, the iconv
|
should not need to do anything special.</para></listitem>
|
||||||
interface is part of libc and you should not need to do
|
|
||||||
anything special.</para></listitem>
|
|
||||||
|
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user