made building user doc optional at configure time

This commit is contained in:
Jean-Francois Dockes 2015-08-23 09:05:05 +02:00
parent 16b3396f12
commit df7ff6aa2c
3 changed files with 53 additions and 18 deletions

View file

@ -552,11 +552,12 @@ install-data-hook:
chmod a+x rcl* ppt-dump.py xls-dump.py xlsxmltocsv.py hotrecoll.py; \ chmod a+x rcl* ppt-dump.py xls-dump.py xlsxmltocsv.py hotrecoll.py; \
chmod 0644 msodump.zip rclexecm.py rcllatinstops.zip rclconfig.py) chmod 0644 msodump.zip rclexecm.py rcllatinstops.zip rclconfig.py)
if MAKEUSERDOC
rdocdir = $(pkgdatadir)/doc rdocdir = $(pkgdatadir)/doc
rdoc_DATA = doc/user/usermanual.html doc/user/docbook-xsl.css rdoc_DATA = doc/user/usermanual.html doc/user/docbook-xsl.css
doc/user/usermanual.html: doc/user/usermanual.xml
doc/user/usermanual.html:
$(MAKE) -C doc/user $(MAKE) -C doc/user
endif
dist_man1_MANS = doc/man/recoll.1 doc/man/recollq.1 doc/man/recollindex.1 dist_man1_MANS = doc/man/recoll.1 doc/man/recollq.1 doc/man/recollindex.1
dist_man5_MANS = doc/man/recoll.conf.5 dist_man5_MANS = doc/man/recoll.conf.5

View file

@ -364,9 +364,17 @@ XAPIANCXXFLAGS=`$XAPIAN_CONFIG --cxxflags`
AC_ARG_ENABLE(xadump, AC_ARG_ENABLE(xadump,
AC_HELP_STRING([--enable-xadump], AC_HELP_STRING([--enable-xadump],
[Enable building the xadump low level Xapian access program.]), [Enable building the xadump low level Xapian access program.]),
enableQT=$enableval, enableXADUMP="no") enableXADUMP=$enableval, enableXADUMP="no")
AM_CONDITIONAL(MAKEXADUMP, [test X$enableXADUMP = Xyes]) AM_CONDITIONAL(MAKEXADUMP, [test X$enableXADUMP = Xyes])
AC_ARG_ENABLE(userdoc,
AC_HELP_STRING([--disable-userdoc],
[Disable building the user manual. (Avoids the need for docbook xml/xsl files and TeX tools.]),
enableUserdoc=$enableval, enableUserdoc="yes")
AM_CONDITIONAL(MAKEUSERDOC, [test X$enableUserdoc = Xyes])
#### QT #### QT
# The way qt and its tools (qmake especially) are installed is very # The way qt and its tools (qmake especially) are installed is very
# different between systems (and maybe qt versions) # different between systems (and maybe qt versions)

View file

@ -4872,11 +4872,28 @@ except:
<para>The shopping list:</para> <para>The shopping list:</para>
<itemizedlist> <itemizedlist>
<listitem><para>The <literal>autoconf</literal>,
<literal>automake</literal> and <literal>libtool</literal>
triad. Only <literal>autoconf</literal> is needed up to &RCL;
1.21.</para></listitem>
<listitem><para>C++ compiler. Up to &RCL; version 1.13.04, <listitem><para>C++ compiler. Up to &RCL; version 1.13.04,
its absence can manifest itself by strange messages its absence can manifest itself by strange messages
about a missing iconv_open.</para> about a missing iconv_open.</para>
</listitem> </listitem>
<listitem><para><command>bison</command> command (for &RCL; 1.21
and later).</para>
</listitem>
<listitem><para><command>xsltproc</command> command. For building
the documentation (for &RCL; 1.21
and later). This sometimes comes with the
<literal>libxslt</literal> package. And also the Docbook XML and
style sheet files.</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>.</para>
@ -4907,6 +4924,11 @@ except:
<application>zlib</application>.</para> <application>zlib</application>.</para>
</listitem> </listitem>
<listitem>
<para>Development files for Python (or use
<literal>--disable-python-module</literal>).</para>
</listitem>
<listitem> <listitem>
<para>You may also need <para>You may also need
<ulink url="http://www.gnu.org/software/libiconv/"> <ulink url="http://www.gnu.org/software/libiconv/">
@ -5009,11 +5031,17 @@ except:
<application>Qt</application> and <application>Qt</application> and
<application>X11</application>.</para> </listitem> <application>X11</application>.</para> </listitem>
<listitem><para><option>--disable-pic</option> will compile <listitem><para><option>--disable-userdoc</option>
&RCL; with position-dependant code. This is incompatible with will avoid building the user manual. This avoids having to
building the KIO or the <application>Python</application> install the Docbook XML/XSL files and the TeX toolchain used for
or <application>PHP</application> extensions, but might translating the manual to PDF.</para></listitem>
yield very marginally faster code.</para></listitem>
<listitem><para><option>--disable-pic</option> (&RCL; versions up
to 1.21 only) will compile
&RCL; with position-dependant code. This is incompatible with
building the KIO or the <application>Python</application>
or <application>PHP</application> extensions, but might
yield very marginally faster code.</para></listitem>
<listitem><para>Of course the usual <listitem><para>Of course the usual
<application>autoconf</application> <command>configure</command> <application>autoconf</application> <command>configure</command>
@ -5023,7 +5051,8 @@ except:
</para> </para>
</formalpara> </formalpara>
<para>Normal procedure:</para> <para>Normal procedure (for source extracted from a tar
distribution):</para>
<screen> <screen>
<userinput>cd recoll-xxx</userinput> <userinput>cd recoll-xxx</userinput>
<userinput>./configure</userinput> <userinput>./configure</userinput>
@ -5031,15 +5060,12 @@ except:
<userinput>(practices usual hardship-repelling invocations)</userinput> <userinput>(practices usual hardship-repelling invocations)</userinput>
</screen> </screen>
<para>When building from source cloned from the BitBucket repository,
<para>There is little auto-configuration. The you also need to install <application>autoconf</application>,
<command>configure</command> script will mainly link one of <application>automake</application>, and
the system-specific files in the <filename>mk</filename> <application>libtool</application> and you must execute <literal>sh
directory to <filename>mk/sysconf</filename>. If your system autogen.sh</literal> in the top source directory before running
is not known yet, it will tell you as much, and you may want <literal>configure</literal>.</para>
to manually copy and modify one of the existing files (the new
file name should be the output of <command>uname</command>
<option>-s</option>).</para>
<sect3 id="RCL.INSTALL.BUILDING.BUILD.SOLARIS"> <sect3 id="RCL.INSTALL.BUILDING.BUILD.SOLARIS">
<title>Building on Solaris</title> <title>Building on Solaris</title>