-<!-- $Id: installation.xml,v 1.30 2006-04-30 06:50:09 adam Exp $ -->
- <chapter id="installation"><title>Compilation and Installation</title>
+<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>
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>
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
+ 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.
+ 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></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-xslt</literal>[=<replaceable>prefix</replaceable>]
+ </term>
+ <listitem><para>Compile &yaz; with
+ <ulink url="&url.libxslt;">libxslt</ulink> in directory
+ <replaceable>prefix</replaceable>.
+ 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 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 &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-icu</literal>[=<replaceable>prefix</replaceable>]
+ </term>
+ <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>
</para></listitem>
</varlistentry>
- <varlistentry><term><filename>src/libyazthread.la</filename></term>
+ <varlistentry><term><filename>src/libyaz_server.la</filename></term>
<listitem><para>
- When threading is supported/enabled by configure this Libtool
- library is created. It includes functions that allows &yaz;
- to use threads.
+ Generic Frontend server. This is an add-on for libyaz.la.
+ 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>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
</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.
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;,
<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>
+
+ <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>
+
</variablelist>
</para>
<para>
The following files are generated upon successful compilation:
<variablelist>
- <varlistentry><term><filename>bin/yaz.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/yaz.lib</filename></term>
+ <varlistentry><term><filename>lib/yaz3.lib</filename> /
+ <filename>lib/yaz3d.lib</filename></term>
<listitem><para>
- Import library for <filename>yaz.dll</filename>.
+ Import library for <filename>yaz3.dll</filename> /
+ <filename>yaz3d.dll</filename>.
</para></listitem></varlistentry>
- <varlistentry><term><filename>bin/yazd.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/yazd.lib</filename></term>
+ <varlistentry><term><filename>lib/yaz_icu3.lib</filename> /
+ <filename>lib/yaz_icu3d.lib</filename></term>
+ <listitem><para>
+ 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>
- Import library for <filename>yazd.dll</filename>.
+ 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
</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;.
<varlistentry><term>include path</term><listitem><para>
Set it to the <filename>include</filename> directory of &yaz;.
</para></listitem></varlistentry>
- <varlistentry><term>import library <filename>yaz.lib</filename>
+ <varlistentry><term>import library <filename>yaz3.lib</filename>
</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.
+ link against <filename>yaz3d.lib</filename> instead.
</para></listitem></varlistentry>
- <varlistentry><term>dynamic link library <filename>yaz.dll</filename>
+ <varlistentry><term>dynamic link library <filename>yaz3.dll</filename>
</term><listitem><para>
This DLL must be in your execution path when you invoke
your application. Specifically, you should distribute this
projects / yaz-moved-to-github.git / blobdiff