-<!-- $Id: installation.xml,v 1.30 2006-04-30 06:50:09 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.35 2007-01-31 15:27:17 adam Exp $ -->
<chapter id="installation"><title>Compilation and Installation</title>
- <sect1><title>Introduction</title>
+ <sect1 id="installation-introduction"><title>Introduction</title>
<para>
The latest version of the software will generally be found at:
</para>
let us know about it. If you run into difficulties, we will try to help
if we can, and if you solve the problems, we would be happy to include
your fixes in the next release. So far, we have mostly avoided
- <literal>#ifdefs</literal> for individual platforms, and we'd
+ <literal>#ifdefs</literal> for individual platforms, and we'd
like to keep it that way as far as it makes sense.
</para>
</para>
<para>
- The XML C library <ulink url="&url.libxml2;">libxml2</ulink>
- is required if &yaz; is to support SRW and SRU.
- This library is very portable and should compile out-of-the
+ The <ulink url="&url.libxslt;">libxslt</ulink>,
+ <ulink url="&url.libxml2;">libxml2</ulink> librararies are required
+ if &yaz; is to support SRU.
+ These libraries are very portable and should compile out-of-the
box on virtually all Unix platforms. It is available in binary
forms for Linux and others.
</para>
</para>
<para>
+ YAZ can optionally be compiled with
+ <ulink url="&url.libpcap;">libpcap</ulink> support. By default,
+ configure enables libpcap if it is available.
+ The libpcap library is required for
+ <link linkend="ziffy">ziffy</link>. And without libpcap,
+ ziffy will not be built.
+ </para>
+
+ <para>
The CQL parser for &yaz; is built using
GNU <ulink url="&url.bison;">Bison</ulink>.
This tool is only needed if you're using the CVS version of &yaz;.
</para></listitem>
</varlistentry>
- <varlistentry><term><literal>--enable-shared</literal></term>
- <listitem><para>The make process will create shared
+ <varlistentry><term><literal>--disable-shared</literal></term>
+ <listitem><para>The make process will not create shared
libraries (also known as shared objects <filename>.so</filename>).
- By default, no shared libraries are created -
- equivalent to <literal>--disable-shared</literal>.
+ By default, shared libraries are created -
+ equivalent to <literal>--enable-shared</literal>.
</para></listitem>
</varlistentry>
</term>
<listitem><para>Compile &yaz; with iconv library in directory
<replaceable>prefix</replaceable>. By default configure will
- search for iconv on your system. Use this option if it
- doesn't find iconv. Alternatively you can use
- <literal>--without-iconv</literal> to force &yaz; not to use
- iconv.
+ search for iconv on the system. Use this option if it
+ doesn't find iconv. Alternatively,
+ <literal>--without-iconv</literal>, can be uset to force &yaz;
+ not to use iconv.
</para></listitem>
</varlistentry>
<varlistentry><term>
- <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
+ <literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem><para>Compile &yaz; with
- <ulink url="&url.libxml2;">libxml2</ulink> in directory
+ <ulink url="&url.libxslt;">libxslt</ulink> in directory
<replaceable>prefix</replaceable>.
- Use this option if you want SOAP support.
- By default configure will
- search for libxml2 on your system. Use this option if it
- doesn't find libxml2. Alternatively you can use
- <literal>--without-xml2</literal> to force &yaz; not to use
- libxml2.
+ Use this option if you want SRU support.
+ By default, configure will
+ search for libxslt on the system. Use this option if it
+ libxslt is not found automatically. Alternatively,
+ <literal>--without-xslt</literal>, can be used to force &yaz;
+ not to use libxslt.
</para></listitem>
</varlistentry>
experimental.
</para></listitem>
</varlistentry>
+
+ <varlistentry><term>
+ <literal>--with-libpcap</literal>[=<replaceable>prefix</replaceable>]
+ </term>
+ <listitem><para>Compile &yaz; with
+ <ulink url="&url.libpcap;">libpcap</ulink> support and the
+ <link linkend="ziffy">ziffy</link> utility.
+ </para></listitem>
+ </varlistentry>
</variablelist>
YAZ client</link> for more information.
</para></listitem>
</varlistentry>
-
+
+ <varlistentry><term><filename>ziffy/ziffy</filename></term>
+ <listitem><para>A promiscuous Z39.50 APDU sniffer.
+ ziffy is only built on systems where libpcap is available.
+ See <xref linkend="ziffy"/> for more information.
+ </para></listitem>
+ </varlistentry>
+
<varlistentry><term><filename>util/yaz-config</filename></term>
<listitem><para>A Bourne-shell script, generated by configure, that
specifies how external applications should compile - and link with
</para>
</sect2>
- <sect2><title>How to make apps using YAZ on UNIX</title>
+ <sect2 id="installation-linking-yaz-unix">
+ <title>How to make apps using YAZ on UNIX</title>
<para>
This section describes how to compile - and link your own
applications using the &yaz; toolkit.
<listitem>
<para>
If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
- with SRW and SRU support. In this configuration, set
+ with SRU support. In this configuration, set
<literal>LIBXML2_DIR</literal> to the
<ulink url="&url.libxml2;">libxml2</ulink> source directory
and
</para>
<para>
- Windows versions of libxml2, zlib and iconv can be found
+ Windows versions of libxslt, libxml2, zlib and iconv can be found
<ulink url="&url.libxml2.download.win32;">
Igor Zlatković' site</ulink>.
</para>
<note>
<para>
- YAZ is not using ZLIB. But libxml2 is.
+ YAZ is not using zlib but libxml2 is depending on it.
</para>
</note>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal>HAVE_LIBXSLT</literal>,
+ <literal>LIBXSLT_DIR</literal></term>
+ <listitem>
+ <para>
+ If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
+ with XSLT support. In this configuration, set
+ <literal>LIBXSLT_DIR</literal> to the
+ <ulink url="&url.libxslt;">libxslt</ulink> source directory.
+ </para>
+
+ <note>
+ <para>
+ libxslt depends libxml2.
+ </para>
+ </note>
+ </listitem>
+
+ </varlistentry>
+
</variablelist>
</para>
<para>
</para>
</sect2>
- <sect2><title>How to make apps using YAZ on WIN32</title>
+ <sect2 id="installation-linking-yaz-win32">
+ <title>How to make apps using YAZ on WIN32</title>
<para>
This section will go though the process of linking your WIN32
applications with &yaz;.
projects / yaz-moved-to-github.git / blobdiff