-<!-- $Id: installation.xml,v 1.37 2007-05-06 20:27:14 adam Exp $ -->
- <chapter id="installation"><title>Compilation and Installation</title>
+<chapter id="installation"><title>Compilation and Installation</title>
<sect1 id="installation-introduction"><title>Introduction</title>
<para>
The software is regularly tested on
<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.ubuntu;">Ubuntu 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.solaris;">SunOS 5.10 (sparc)</ulink>,
<ulink url="&url.windows2000;">Windows 2000</ulink>,
<ulink url="&url.windows2003server;">Windows 2003 server</ulink>.
</para>
</para>
<para>
+ YAZ 3.0.16 and later includes a wrapper for the
+ <ulink url="%url.icu;">ICU</ulink>
+ (International Components for Unicode).
+ In order to use this, the developer version of the ICU library
+ must be available.
+ </para>
+
+ <para>
The <ulink url="&url.libxslt;">libxslt</ulink>,
<ulink url="&url.libxml2;">libxml2</ulink> librararies are required
if &yaz; is to support SRU.
</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;.
<listitem><para>Compile &yaz; with
<ulink url="&url.libxslt;">libxslt</ulink> in directory
<replaceable>prefix</replaceable>.
- Use this option if you want SRU support.
+ Use this option if you want XSLT and XML 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>
+
+ <varlistentry><term>
+ <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
+ </term>
+ <listitem><para>Compile &yaz; with
+ <ulink url="&url.libxml2;">libxml2</ulink> in directory
+ <replaceable>prefix</replaceable>.
+ Use this option if you want &yaz; to use XML and support SRU.
+ By default, configure will
+ search for libxml2 on the system. Use this option if it
+ libxml2 is not found automatically. Alternatively,
+ <literal>--without-xml2</literal>, can be used to force &yaz;
+ not to use libxml2.
+ </para>
+ <para>
+ Note that option <literal>--with-xslt</literal>
+ also enables libxml2.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>
+ <literal>--with-gnutls</literal>[=<replaceable>prefix</replaceable>]
+ </term>
+ <listitem><para>&yaz; will be linked with the GNU TLS libraries and
+ an SSL COMSTACK will be provided. By default configure enables
+ SSL support for YAZ if the GNU TLS development libraries are found
+ on the system.
</para></listitem>
</varlistentry>
<literal>--with-openssl</literal>[=<replaceable>prefix</replaceable>]
</term>
<listitem><para>&yaz; will be linked with the OpenSSL libraries and
- an SSL COMSTACK will be provided. Note that SSL support is still
- experimental.
+ an SSL COMSTACK will be provided. If OpenSSL is enabled, GNU TLS
+ is automatically disabled.
</para></listitem>
</varlistentry>
<varlistentry><term>
- <literal>--with-libpcap</literal>[=<replaceable>prefix</replaceable>]
+ <literal>--with-icu</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.
+ <listitem><para>&yaz; will be linked the
+ <ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
+ If prefix is not given, the libraries exposed by the script
+ <application>icu-config</application> will be used if found.
</para></listitem>
</varlistentry>
-
+
</variablelist>
</para>
<varlistentry><term><filename>src/libyaz_server.la</filename></term>
<listitem><para>
Generic Frontend server. This is an add-on for libyaz.la.
- Code in this library uses POSIX threads functions - if they
- available on the platform.
+ Code in this library uses POSIX threads functions - if POSIX
+ threads are available on the platform.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><filename>src/libyaz_icu.la</filename></term>
+ <listitem><para>
+ Functions that wrap the ICU library.
</para></listitem>
</varlistentry>
<varlistentry><term><filename>client/yaz-client</filename></term>
<listitem><para>Z39.50 client for testing the protocol.
- See chapter <link linkend="client">
+ See chapter <link linkend="yaz-client">
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></listitem>
</varlistentry>
+ <varlistentry><term><filename>util/yaz-icu</filename></term>
+ <listitem><para>This program exposes the ICU wrapper library if that
+ is enabled for YAZ. Only if ICU is available this program is
+ useful.
+ </para></listitem>
+ </varlistentry>
+
<varlistentry><term><filename>zoom/zoomsh</filename></term>
<listitem><para>
A simple shell implemented on top of the
For Libtool users, the <filename>yaz-config</filename> script provides
a different variant of option <literal>--libs</literal>, called
<literal>--lalibs</literal> that returns the name of the
- Libtool acrhive(s) for &yaz; rather than the ordinary ones.
+ Libtool archive(s) for &yaz; rather than the ordinary ones.
</para>
<para>
For applications using the threaded version of &yaz;,
</para>
</note>
</listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>HAVE_ICU</literal>,
+ <literal>ICU_DIR</literal></term>
+ <listitem>
+ <para>
+ If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
+ with <ulink url="&url.icu;">ICU</ulink> support.
+ In this configuration, set
+ <literal>ICU_DIR</literal> to the
+ <ulink url="&url.icu;">ICU</ulink> source directory.
+ </para>
+ </listitem>
</varlistentry>
The following files are generated upon successful compilation:
<variablelist>
- <varlistentry><term><filename>bin/yaz3.dll</filename></term>
+ <varlistentry><term><filename>bin/yaz3.dll</filename> /
+ <filename>bin/yaz3d.dll</filename></term>
<listitem><para>
- &yaz; release mode multi-threaded Dynamic Link Library.
+ &yaz; Release/Debug DLL.
</para></listitem></varlistentry>
- <varlistentry><term><filename>lib/yaz3.lib</filename></term>
+ <varlistentry><term><filename>lib/yaz3.lib</filename> /
+ <filename>lib/yaz3d.lib</filename></term>
<listitem><para>
- Import library for <filename>yaz3.dll</filename>.
+ Import library for <filename>yaz3.dll</filename> /
+ <filename>yaz3d.dll</filename>.
</para></listitem></varlistentry>
- <varlistentry><term><filename>bin/yaz3d.dll</filename></term>
+ <varlistentry><term><filename>bin/yaz_icu3.dll</filename> /
+ <filename>bin/yaz_icu3d.dll</filename></term>
<listitem><para>
- &yaz; debug mode multi-threaded Dynamic Link Library.
+ Release/Debug DLL for the ICU wrapper utility.
+ Only build if HAVE_ICU is 1.
</para></listitem></varlistentry>
- <varlistentry><term><filename>lib/yaz3d.lib</filename></term>
+ <varlistentry><term><filename>lib/yaz_icu3.lib</filename> /
+ <filename>lib/yaz_icu3d.lib</filename></term>
<listitem><para>
- Import library for <filename>yaz3d.dll</filename>.
+ Import library for <filename>yaz_icu3.dll</filename> /
+ <filename>yaz_icu3d.dll</filename>.
+ </para></listitem></varlistentry>
+
+ <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
+ <listitem><para>
+ Z39.50 multi-threaded test/example server. It's a WIN32
+ console application.
</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.
- See chapter <link linkend="client">YAZ client</link> for more
+ See chapter <link linkend="yaz-client">YAZ client</link> for more
information.
</para></listitem></varlistentry>
- <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
- <listitem><para>
- Z39.50 multi-threaded test/example server. It's a WIN32
- console application.
+ <varlistentry><term><filename>bin/yaz-icu.exe</filename></term>
+ <listitem><para>This program exposes the ICU wrapper library if that
+ is enabled for YAZ. Only if ICU is available this program is
+ build.
</para></listitem></varlistentry>
-
+
<varlistentry><term><filename>bin/zoomsh.exe</filename></term>
<listitem><para>
Simple console application implemented on top of the
projects / yaz-moved-to-github.git / blobdiff