-<!-- $Id: installation.xml,v 1.14 2002-09-25 20:38:36 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.31 2006-05-03 13:38:12 adam Exp $ -->
<chapter id="installation"><title>Compilation and Installation</title>
<sect1><title>Introduction</title>
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
platforms, you should be able to compile everything with little or
- no changes.
- So far, the software has been ported to the following platforms with
- little or no difficulties.
-
- <itemizedlist>
- <listitem><para>Unix systems</para>
- <itemizedlist>
- <listitem><para>HP/UX</para></listitem>
- <listitem><para>SunOS/Solaris</para></listitem>
- <listitem><para>DEC Unix</para></listitem>
- <listitem><para>BSDs: FreeBSD, OpenBSD, NetBSD</para></listitem>
- <listitem><para>MAC OSX</para></listitem>
- <listitem><para>Linux</para></listitem>
- <listitem><para>IBM AIX</para></listitem>
- <listitem><para>Data General DG/UX (with some CFLAGS tinkering)
- </para></listitem>
- <listitem><para>SGI/IRIX</para></listitem>
- <listitem><para>DDE Supermax</para></listitem>
- </itemizedlist></listitem>
- <listitem><para>Non-unix systems</para>
- <itemizedlist>
- <listitem><para>Apple Macintosh (using the Codewarrior programming
- environment and the GUSI socket libraries)</para></listitem>
- <listitem><para>MS Windows 95/98/NT/2K/XP (Win32)</para></listitem>
- <listitem><para>IBM AS/400</para></listitem>
- </itemizedlist></listitem>
- </itemizedlist>
-
+ no changes.
+ </para>
+
+ <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.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="&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
+ environment and the GUSI socket libraries),
+ IBM AS/400 .
</para>
<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>
<sect1 id="installation.unix"><title>UNIX</title>
<para>
- We provide Debian GNU/Linux and Redhat packages for YAZ.
+ We provide
+ <ulink url="&url.debian;">Debian GNU/Linux</ulink>
+ and
+ <ulink url="&url.redhat;">Redhat</ulink> packages for &yaz;.
Only i386 binary packages are available. You should be able to
- create packages for other CPU's by building them from the source
+ create packages for other CPUs by building them from the source
package.
</para>
<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>
+ If you wish to use character set conversion facilities in &yaz; or if you
+ 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="&url.libiconv;">GNU libiconv</ulink>.
+ </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>
- For UNIX, 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>
+ The GNU tools
+ <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>
- If you wish to use character set conversion facilities in YAZ or if you
- are compiling YAZ for use with Zebra it is a good idea to ensure that
- the iconv library is installed. Most Unixes today already have it
- - if not, we suggest
- <ulink url="http://www.gnu.org/software/libiconv/">GNU iconv</ulink>.
+ 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>
-
+
+ <para>
+ &yaz; includes a tiny ASN.1 compiler. This compiler is
+ 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.
+ </para>
+
<para>
Generally it should be sufficient to run configure without options,
like this:
The most important are:
<variablelist>
- <varlistentry><term><literal>--prefix </literal>path</term>
- <listitem><para>Specifies installation prefix. This is
+ <varlistentry><term>
+ <literal>--prefix</literal>=<replaceable>prefix</replaceable></term>
+ <listitem><para>Specifies installation prefix for &yaz;. This is
only needed if you run <literal>make install</literal> later to
perform a "system" installation. The prefix is
<literal>/usr/local</literal> if not specified.
</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>
</citerefentry>.
</para></listitem>
</varlistentry>
+
<varlistentry><term><literal>--enable-threads</literal></term>
<listitem><para>&yaz; will be built using POSIX threads.
Specifically, <constant>_REENTRANT</constant> will be defined during
compilation.
</para></listitem>
</varlistentry>
- <varlistentry><term><literal>--with-openssl</literal></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.
- </para></listitem>
- </varlistentry>
+
<varlistentry><term><literal>--enable-shared</literal></term>
<listitem><para>The make process will create shared
libraries (also known as shared objects <filename>.so</filename>).
equivalent to <literal>--disable-shared</literal>.
</para></listitem>
</varlistentry>
+
<varlistentry><term><literal>--disable-shared</literal></term>
<listitem><para>The make process will not create
static libraries (<filename>.a</filename>).
</varlistentry>
<varlistentry><term>
- <literal>--with-iconv</literal>[=<replaceable>dir</replaceable>]</term>
- <listitem><para>Compile YAZ with iconv library in directory
- <replaceable>dir</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.
+ <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
+ </term>
+ <listitem><para>Compile &yaz; with iconv library in directory
+ <replaceable>prefix</replaceable>. By default configure will
+ 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 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>
+
+ <varlistentry><term>
+ <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.
</para></listitem>
</varlistentry>
<para>
The following files are generated by the make process:
<variablelist>
- <varlistentry><term><filename>lib/libyaz.la</filename></term>
+ <varlistentry><term><filename>src/libyaz.la</filename></term>
<listitem><para>
Main &yaz; library. This is no ordinary library. It's
a Libtool archive.
By default, &yaz; creates a static library in
<filename>lib/.libs/libyaz.a</filename>.
- </para></listitem></varlistentry>
+ </para></listitem>
+ </varlistentry>
- <varlistentry><term><filename>lib/libyazthread.la</filename></term>
+ <varlistentry><term><filename>src/libyazthread.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.
- </para></listitem></varlistentry>
+ </para></listitem>
+ </varlistentry>
<varlistentry><term><filename>ztest/yaz-ztest</filename></term>
<listitem><para>Test Z39.50 server.
- </para></listitem></varlistentry>
+ </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">
YAZ client</link> for more information.
- </para></listitem></varlistentry>
+ </para></listitem>
+ </varlistentry>
- <varlistentry><term><filename>yaz-config</filename></term>
+ <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
&yaz;.
- </para></listitem></varlistentry>
+ </para></listitem>
+ </varlistentry>
- <varlistentry><term><filename>yaz-comp</filename></term>
+ <varlistentry><term><filename>util/yaz-asncomp</filename></term>
<listitem><para>The ASN.1 compiler for &yaz;. Requires the
Tcl Shell, <application>tclsh</application>, in
<literal>PATH</literal> to operate.
- </para></listitem></varlistentry>
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><filename>util/yaz-iconv</filename></term>
+ <listitem><para>This program converts data in one character set to
+ another. This command exercises the YAZ character set
+ conversion API.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry><term><filename>util/yaz-marcdump</filename></term>
+ <listitem><para>This program parses ISO2709 encoded MARC records
+ and prints them in line-format or XML.
+ </para></listitem>
+ </varlistentry>
- <varlistentry><term><filename>zoom/zoomsh</filename></term>
+ <varlistentry><term><filename>zoom/zoomsh</filename></term>
<listitem><para>
A simple shell implemented on top of the
<link linkend="zoom">ZOOM</link> functions.
The shell is a command line application that allows you to enter
simple commands to perform ZOOM operations.
- </para></listitem></varlistentry>
+ </para></listitem>
+ </varlistentry>
<varlistentry><term><filename>zoom/zoomtst1</filename>,
<filename>zoom/zoomtst2</filename>, ..</term>
<listitem><para>
Several small applications that demonstrates the ZOOM API.
- </para></listitem></varlistentry>
+ </para></listitem>
+ </varlistentry>
</variablelist>
</para>
<para>
You probably need to have root access in order to perform this.
You must specify the <literal>--prefix</literal> option for configure if
- you wish to install &yaz; in other directories than the default
+ you wish to install &yaz; in other directories than the default
<filename>/usr/local/</filename>.
</para>
<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 Microsoft Visual C++. Version 6 has been tested. We expect that
- &yaz; should compile with version 5 as well.
+ 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>
Start a command prompt and switch the sub directory
(code generation is multi-threaded DLL).
</para></listitem>
</varlistentry>
- <varlistentry><term><literal>TCL</literal></term>
+ <varlistentry>
+ <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
+ <listitem><para>
+ If <literal>HAVE_TCL</literal> is set to 1, nmake will
+ use the ASN.1 compiler (Tcl based). You must set
+ <literal>TCL</literal> to the full path of the Tcl
+ interpreter.
+ </para>
+ <para>
+ If you do not have Tcl installed, set
+ <literal>HAVE_TCL</literal> to 0.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>HAVE_BISON</literal>,
+ <literal>BISON</literal></term>
<listitem><para>
- Specifies the name of the Tcl shell (EXE-file).
- You do not need setting this or installing Tcl unless you wish
- to change or add ASN.1 for &yaz;.
+ If GNU Bison is present, you might set <literal>HAVE_ICONV</literal>
+ to 1 and specify the Bison executable in <literal>BISON</literal>.
+ Bison is only required if you use the CVS version of
+ YAZ or if you modify the grammar for CQL
+ (<filename>cql.y</filename>).
+ </para>
+ <para>
+ A Windows version of GNU Bison is part of
+ <ulink url="&url.unxutils;">unxutils</ulink>.
</para></listitem>
</varlistentry>
<varlistentry>
- <term><literal>HAVE_ICONV</literal>, <literal>ICONV_DIR</literal></term>
+ <term><literal>HAVE_ICONV</literal>,
+ <literal>ICONV_DIR</literal></term>
<listitem><para>
If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
with iconv support. In this configuration, set
<literal>ICONV_DIR</literal> to the iconv source directory.
</para></listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><literal>HAVE_LIBXML2</literal>,
+ <literal>LIBXML2_DIR</literal></term>
+ <listitem>
+ <para>
+ If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
+ with SRU support. In this configuration, set
+ <literal>LIBXML2_DIR</literal> to the
+ <ulink url="&url.libxml2;">libxml2</ulink> source directory
+ and
+ <literal>ZLIB_DIR</literal> to the zlib directory.
+ </para>
+
+ <para>
+ 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 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>
<screen>
nmake
</screen>
- If command <filename>nmake</filename> is not found on your system
- you probably haven't defined the environment variables required to
- use that tool. To fix that, find and run the batch file
- <filename>vcvars32.bat</filename>. You need to run it from within
- the command prompt or set the environment variables "globally";
- otherwise it doesn't work.
</para>
+ <note>
+ <para>
+ If the <filename>nmake</filename> command is not found on your system
+ you probably haven't defined the environment variables required to
+ use that tool. To fix that, find and run the batch file
+ <filename>vcvars32.bat</filename>. You need to run it from within
+ the command prompt or set the environment variables "globally";
+ otherwise it doesn't work.
+ </para>
+ </note>
<para>
If you wish to recompile &yaz; - for example if you modify
settings in the <filename>makefile</filename> you can delete
<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.
</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>
projects / yaz-moved-to-github.git / blobdiff