-<!-- $Id: installation.xml,v 1.24 2004-05-01 23:45:43 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.34 2006-12-13 09:40:32 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>
<para>
- <ulink url="http://ftp.indexdata.dk/pub/yaz/">
- http://ftp.indexdata.dk/pub/yaz/</ulink>
+ <ulink url="&url.yaz.download;"/>
</para>
<para>
We have tried our best to keep the software portable, and on many
<para>
The software is regularly tested on
- <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>,
- <ulink url="http://www.redhat.com/">Redhat Linux</ulink>,
- <ulink url="http://www.gentoo.org/">Gentoo Linux</ulink>,
- <ulink url="http://www.freebsd.org/">FreeBSD (i386)</ulink>,
- <ulink url="http://www.apple.com/macosx/">MAC OSX</ulink>,
- <ulink url="http://wwws.sun.com/software/solaris/">
- SunOS 5.8 (sparc)</ulink>,
- <ulink url="http://www.microsoft.com/windows2000/">
- Windows 2000</ulink>.
+ <ulink url="&url.debian;">Debian GNU/Linux</ulink>,
+ <ulink url="&url.redhat;">Redhat Linux</ulink>,
+ <ulink url="&url.gentoo;">Gentoo Linux</ulink>,
+ <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
+ <ulink url="&url.macosx;">MAC OSX</ulink>,
+ <ulink url="&url.solaris;">SunOS 5.8 (sparc)</ulink>,
+ <ulink url="&url.windows2000;">Windows 2000</ulink>,
+ <ulink url="&url.windows2003server;">Windows 2003 server</ulink>.
</para>
<para>
Some versions have be known to work on HP/UX,
- DEC Unix, <ulink url="http://www.netbsd.org/">NetBSD</ulink>,
- <ulink url="http://www.openbsd.org/">OpenBSD</ulink>,
+ DEC Unix, <ulink url="&url.netbsd;">NetBSD</ulink>,
+ <ulink url="&url.openbsd;">OpenBSD</ulink>,
IBM AIX,
Data General DG/UX (with some CFLAGS tinkering),
SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
<para>
We maintain a mailing-list for the purpose of announcing new releases and
- bug-fixes, as well as general discussion. Subscribe by sending mail to
- <ulink url="mailto:yaz-request@indexdata.dk">
- yaz-request@indexdata.dk
- </ulink> or fill-in the form
- <ulink url="http://www.indexdata.dk/mailman/listinfo/yazlist">
- here</ulink>.
+ bug-fixes, as well as general discussion. Subscribe by
+ filling-in the form
+ <ulink url="&url.yaz.mailinglist;">here</ulink>.
General questions and problems can be directed at
- <ulink url="mailto:yaz-help@indexdata.dk">
- yaz-help@indexdata.dk
- </ulink>, or the address given at the top of this document.
+ <ulink url="&url.yaz.mail;"/>, or the address given at the top of
+ this document.
</para>
</sect1>
<para>
We provide
- <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>
+ <ulink url="&url.debian;">Debian GNU/Linux</ulink>
and
- <ulink url="http://www.redhat.com/">Redhat</ulink> packages for &yaz;.
+ <ulink url="&url.redhat;">Redhat</ulink> packages for &yaz;.
Only i386 binary packages are available. You should be able to
create packages for other CPUs by building them from the source
package.
<para>
Note that if your system doesn't have a native ANSI C compiler, you may
have to acquire one separately. We recommend
- <ulink url="http://gcc.gnu.org/">GCC</ulink>.
+ <ulink url="&url.gcc;">GCC</ulink>.
</para>
<para>
are compiling &yaz; for use with Zebra it is a good idea to ensure that
the iconv library is installed. Some Unixes today already have it
- if not, we suggest
- <ulink url="http://www.gnu.org/software/libiconv/">GNU iconv</ulink>.
+ <ulink url="&url.libiconv;">GNU libiconv</ulink>.
</para>
<para>
- The XML C library <ulink url="http://www.xmlsoft.org/">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>
The GNU tools
- <ulink url="http://www.gnu.org/software/autoconf/">Autoconf</ulink>,
- <ulink url="http://www.gnu.org/software/automake/">Automake</ulink> and
- <ulink url="http://www.gnu.org/software/libtool/">Libtool</ulink>
+ <ulink url="&url.autoconf;">Autoconf</ulink>,
+ <ulink url="&url.automake;">Automake</ulink> and
+ <ulink url="&url.libtool;">Libtool</ulink>
are used to generate Makefiles and configure &yaz; for the system.
You do <emphasis>not</emphasis> these tools unless you're using the
CVS version of &yaz;.
</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="http://www.gnu.org/software/bison/">Bison</ulink>.
+ GNU <ulink url="&url.bison;">Bison</ulink>.
This tool is only needed if you're using the CVS version of &yaz;.
</para>
<para>
&yaz; includes a tiny ASN.1 compiler. This compiler is
- written in <ulink url="http://www.tcl.tk/">Tcl</ulink>.
+ written in <ulink url="&url.tcl;">Tcl</ulink>.
But as for Bison you do not need it unless you're using CVS
version of &yaz; or you're using the compiler to built own codecs
for private ASN.1.
</varlistentry>
<varlistentry><term><literal>--enable-tcpd</literal></term>
<listitem><para>The front end server will be built using Wietse's
- <ulink url="ftp://ftp.porcupine.org/pub/security/index.html">
- TCP wrapper library</ulink>. It allows you to allow/deny
- clients depending on IP number. The TCP wrapper library is
- often used in Linux/BSD distributions.
+ <ulink url="&url.tcpwrapper;">TCP wrapper library</ulink>.
+ It allows you to allow/deny clients depending on IP number.
+ The TCP wrapper library is often used in GNU/Linux and
+ BSD distributions.
See
<citerefentry>
<refentrytitle>hosts_access</refentrytitle>
</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="http://www.xmlsoft.org/">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.
<para>The easiest way to install YAZ on Windows is by downloading
an installer from
- <ulink url="http://ftp.indexdata.dk/pub/yaz/win32">here</ulink>.
+ <ulink url="&url.yaz.download.win32;">here</ulink>.
The installer comes with source too - in case you wish to
compile YAZ with different Compiler options etc.
</para>
<title>Compiling from Source on WIN32</title>
<para>
&yaz; is shipped with "makefiles" for the NMAKE tool that comes
- with <ulink url="http://msdn.microsoft.com/vstudio/">
+ with <ulink url="&url.vstudio;">
Microsoft Visual Studio</ulink>.
Version 6 and .NET has been tested. We expect that &yaz; compiles
with version 5 as well.
</para>
<para>
A Windows version of GNU Bison is part of
- <ulink url="http://unxutils.sourceforge.net/">unxutils</ulink>.
+ <ulink url="&url.unxutils;">unxutils</ulink>.
</para></listitem>
</varlistentry>
<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="http://www.xmlsoft.org/">libxml2</ulink> source directory
+ <ulink url="&url.libxml2;">libxml2</ulink> source directory
and
<literal>ZLIB_DIR</literal> to the zlib directory.
</para>
<para>
- Windows versions of libxml2, zlib and iconv can be found
- <ulink url="http://www.zlatkovic.com/libxml.en.html">
+ 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>
<variablelist>
<varlistentry><term><filename>bin/yaz.dll</filename></term>
<listitem><para>
- &yaz; multi-threaded Dynamic Link Library.
+ &yaz; release mode multi-threaded Dynamic Link Library.
</para></listitem></varlistentry>
<varlistentry><term><filename>lib/yaz.lib</filename></term>
Import library for <filename>yaz.dll</filename>.
</para></listitem></varlistentry>
+ <varlistentry><term><filename>bin/yazd.dll</filename></term>
+ <listitem><para>
+ &yaz; debug mode multi-threaded Dynamic Link Library.
+ </para></listitem></varlistentry>
+
+ <varlistentry><term><filename>lib/yazd.lib</filename></term>
+ <listitem><para>
+ Import library for <filename>yazd.dll</filename>.
+ </para></listitem></varlistentry>
+
<varlistentry><term><filename>bin/yaz-client.exe</filename></term>
<listitem><para>
&yaz; Z39.50 client application. It's a WIN32 console application.
</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;.
</term><listitem><para>
You must link with this library. It's located in the
sub directory <filename>lib</filename> of &yaz;.
+ If you want to link with the debug version of &yaz;, you must
+ link with <filename>yazd.dll</filename> instead.
</para></listitem></varlistentry>
<varlistentry><term>dynamic link library <filename>yaz.dll</filename>
</term><listitem><para>