-<!-- $Id: installation.xml,v 1.24 2004-05-01 23:45:43 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>
<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.ubuntu;">Ubuntu Linux</ulink>,
+ <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
+ <ulink url="&url.macosx;">MAC OSX</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>
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
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>
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
+ 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>
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>
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-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="http://www.xmlsoft.org/">libxml2</ulink> in directory
+ <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;,
<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>
+
+ <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; 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/yaz-client.exe</filename></term>
+ <varlistentry><term><filename>bin/yaz_icu3.dll</filename> /
+ <filename>bin/yaz_icu3d.dll</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
- information.
+ Release/Debug DLL for the ICU wrapper utility.
+ Only build if HAVE_ICU is 1.
+ </para></listitem></varlistentry>
+
+ <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>
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="yaz-client">YAZ client</link> for more
+ information.
+ </para></listitem></varlistentry>
+
+ <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 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