1 <!-- $Id: installation.xml,v 1.22 2004-03-19 21:12:13 adam Exp $ -->
2 <chapter id="installation"><title>Compilation and Installation</title>
4 <sect1><title>Introduction</title>
6 The latest version of the software will generally be found at:
9 <ulink url="http://ftp.indexdata.dk/pub/yaz/">
10 http://ftp.indexdata.dk/pub/yaz/</ulink>
13 We have tried our best to keep the software portable, and on many
14 platforms, you should be able to compile everything with little or
19 The software is regularly tested on
20 <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>,
21 <ulink url="http://www.redhat.com/">Redhat Linux</ulink>,
22 <ulink url="http://www.gentoo.org/">Gentoo Linux</ulink>,
23 <ulink url="http://www.freebsd.org/">FreeBSD (i386)</ulink>,
24 <ulink url="http://www.apple.com/macosx/">MAC OSX</ulink>,
25 <ulink url="http://wwws.sun.com/software/solaris/">
26 SunOS 5.8 (sparc)</ulink>,
27 <ulink url="http://www.microsoft.com/windows2000/">
32 Some versions have be known to work on HP/UX,
33 DEC Unix, <ulink url="http://www.netbsd.org/">NetBSD</ulink>,
34 <ulink url="http://www.openbsd.org/">OpenBSD</ulink>,
36 Data General DG/UX (with some CFLAGS tinkering),
37 SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
38 environment and the GUSI socket libraries),
43 If you move the software to other platforms, we'd be grateful if you'd
44 let us know about it. If you run into difficulties, we will try to help
45 if we can, and if you solve the problems, we would be happy to include
46 your fixes in the next release. So far, we have mostly avoided
47 <literal>#ifdefs</literal> for individual platforms, and we'd
48 like to keep it that way as far as it makes sense.
52 We maintain a mailing-list for the purpose of announcing new releases and
53 bug-fixes, as well as general discussion. Subscribe by sending mail to
54 <ulink url="mailto:yaz-request@indexdata.dk">
55 yaz-request@indexdata.dk
56 </ulink> or fill-in the form
57 <ulink url="http://www.indexdata.dk/mailman/listinfo/yazlist">
59 General questions and problems can be directed at
60 <ulink url="mailto:yaz-help@indexdata.dk">
62 </ulink>, or the address given at the top of this document.
66 <sect1 id="installation.unix"><title>UNIX</title>
70 <ulink url="http://www.debian.org/">Debian GNU/Linux</ulink>
72 <ulink url="http://www.redhat.com/">Redhat</ulink> packages for &yaz;.
73 Only i386 binary packages are available. You should be able to
74 create packages for other CPUs by building them from the source
78 <sect2 id="installation.source.unix">
79 <title>Compiling from source on Unix</title>
82 Note that if your system doesn't have a native ANSI C compiler, you may
83 have to acquire one separately. We recommend
84 <ulink url="http://gcc.gnu.org/">GCC</ulink>.
88 If you wish to use character set conversion facilities in &yaz; or if you
89 are compiling &yaz; for use with Zebra it is a good idea to ensure that
90 the iconv library is installed. Some Unixes today already have it
92 <ulink url="http://www.gnu.org/software/libiconv/">GNU iconv</ulink>.
96 The XML C library <ulink url="http://www.xmlsoft.org/">libxml2</ulink>
97 is required if &yaz; is to support SRW (and SOAP).
98 This library is very portable and should compile out-of-the
99 box on virtually all Unix platforms. It is available in binary
100 forms for Linux and others.
105 <ulink url="http://www.gnu.org/software/autoconf/">Autoconf</ulink>,
106 <ulink url="http://www.gnu.org/software/automake/">Automake</ulink> and
107 <ulink url="http://www.gnu.org/software/libtool/">Libtool</ulink>
108 are used to generate Makefiles and configure &yaz; for the system.
109 You do <emphasis>not</emphasis> these tools unless you're using the
110 CVS version of &yaz;.
114 The CQL parser for &yaz; is built using
115 GNU <ulink url="http://www.gnu.org/software/bison/">Bison</ulink>.
116 This tool is only needed if you're using the CVS version of &yaz;.
120 &yaz; includes a tiny ASN.1 compiler. This compiler is
121 written in <ulink url="http://www.tcl.tk/">Tcl</ulink>.
122 But as for Bison you do not need it unless you're using CVS
123 version of &yaz; or you're using the compiler to built own codecs
128 Generally it should be sufficient to run configure without options,
137 The configure script attempts to use use the C compiler specified by
138 the <literal>CC</literal> environment variable. If not set, GNU C will be
139 used if it is available. The <literal>CFLAGS</literal> environment
140 variable holds options to be passed to the C compiler. If you're using
141 Bourne-compatible shell you may pass something like this to use a
142 particular C compiler with optimization enabled:
146 CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
150 To customize &yaz;, the configure script also accepts a set of options.
151 The most important are:
155 <literal>--prefix</literal>=<replaceable>prefix</replaceable></term>
156 <listitem><para>Specifies installation prefix for &yaz;. This is
157 only needed if you run <literal>make install</literal> later to
158 perform a "system" installation. The prefix is
159 <literal>/usr/local</literal> if not specified.
162 <varlistentry><term><literal>--enable-tcpd</literal></term>
163 <listitem><para>The front end server will be built using Wietse's
164 <ulink url="ftp://ftp.porcupine.org/pub/security/index.html">
165 TCP wrapper library</ulink>. It allows you to allow/deny
166 clients depending on IP number. The TCP wrapper library is
167 often used in Linux/BSD distributions.
170 <refentrytitle>hosts_access</refentrytitle>
171 <manvolnum>5</manvolnum>
175 <refentrytitle>tcpd</refentrytitle>
176 <manvolnum>8</manvolnum>
181 <varlistentry><term><literal>--enable-threads</literal></term>
182 <listitem><para>&yaz; will be built using POSIX threads.
183 Specifically, <constant>_REENTRANT</constant> will be defined during
188 <varlistentry><term><literal>--enable-shared</literal></term>
189 <listitem><para>The make process will create shared
190 libraries (also known as shared objects <filename>.so</filename>).
191 By default, no shared libraries are created -
192 equivalent to <literal>--disable-shared</literal>.
196 <varlistentry><term><literal>--disable-shared</literal></term>
197 <listitem><para>The make process will not create
198 static libraries (<filename>.a</filename>).
199 By default, static libraries are created -
200 equivalent to <literal>--enable-static</literal>.
205 <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
207 <listitem><para>Compile &yaz; with iconv library in directory
208 <replaceable>prefix</replaceable>. By default configure will
209 search for iconv on your system. Use this option if it
210 doesn't find iconv. Alternatively you can use
211 <literal>--without-iconv</literal> to force &yaz; not to use
217 <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
219 <listitem><para>Compile &yaz; with
220 <ulink url="http://www.xmlsoft.org/">libxml2</ulink> in directory
221 <replaceable>prefix</replaceable>.
222 Use this option if you want SOAP support.
223 By default configure will
224 search for libxml2 on your system. Use this option if it
225 doesn't find libxml2. Alternatively you can use
226 <literal>--without-xml2</literal> to force &yaz; not to use
232 <literal>--with-openssl</literal>[=<replaceable>prefix</replaceable>]
234 <listitem><para>&yaz; will be linked with the OpenSSL libraries and
235 an SSL COMSTACK will be provided. Note that SSL support is still
244 When configured, build the software by typing:
251 The following files are generated by the make process:
253 <varlistentry><term><filename>src/libyaz.la</filename></term>
255 Main &yaz; library. This is no ordinary library. It's
257 By default, &yaz; creates a static library in
258 <filename>lib/.libs/libyaz.a</filename>.
262 <varlistentry><term><filename>src/libyazthread.la</filename></term>
264 When threading is supported/enabled by configure this Libtool
265 library is created. It includes functions that allows &yaz;
270 <varlistentry><term><filename>ztest/yaz-ztest</filename></term>
271 <listitem><para>Test Z39.50 server.
275 <varlistentry><term><filename>client/yaz-client</filename></term>
276 <listitem><para>Z39.50 client for testing the protocol.
277 See chapter <link linkend="client">
278 YAZ client</link> for more information.
282 <varlistentry><term><filename>util/yaz-config</filename></term>
283 <listitem><para>A Bourne-shell script, generated by configure, that
284 specifies how external applications should compile - and link with
289 <varlistentry><term><filename>util/yaz-asncomp</filename></term>
290 <listitem><para>The ASN.1 compiler for &yaz;. Requires the
291 Tcl Shell, <application>tclsh</application>, in
292 <literal>PATH</literal> to operate.
296 <varlistentry><term><filename>util/yaz-iconv</filename></term>
297 <listitem><para>This program converts data in one character set to
298 another. This command exercises the YAZ character set
303 <varlistentry><term><filename>util/yaz-marcdump</filename></term>
304 <listitem><para>This program parses ISO2709 encoded MARC records
305 and prints them in line-format or XML.
309 <varlistentry><term><filename>zoom/zoomsh</filename></term>
311 A simple shell implemented on top of the
312 <link linkend="zoom">ZOOM</link> functions.
313 The shell is a command line application that allows you to enter
314 simple commands to perform ZOOM operations.
318 <varlistentry><term><filename>zoom/zoomtst1</filename>,
319 <filename>zoom/zoomtst2</filename>, ..</term>
321 Several small applications that demonstrates the ZOOM API.
329 If you wish to install &yaz; in system directories
330 <filename>/usr/local/bin</filename>,
331 <filename>/usr/local/lib</filename> .. etc, you can type:
339 You probably need to have root access in order to perform this.
340 You must specify the <literal>--prefix</literal> option for configure if
341 you wish to install &yaz; in other directories than the default
342 <filename>/usr/local/</filename>.
346 If you wish to perform an un-installation of &yaz;, use:
354 This will only work if you haven't reconfigured &yaz; (and therefore
355 changed installation prefix). Note that uninstall will not
356 remove directories created by make install, e.g.
357 <filename>/usr/local/include/yaz</filename>.
361 <sect2><title>How to make apps using YAZ on UNIX</title>
363 This section describes how to compile - and link your own
364 applications using the &yaz; toolkit.
365 If you're used to Makefiles this shouldn't be hard. As for
366 other libraries you have used before, you have to set a proper include
367 path for your C/C++ compiler and specify the location of
368 &yaz; libraries. You can do it by hand, but generally we suggest
369 you use the <filename>yaz-config</filename> that is generated
370 by <filename>configure</filename>. This is especially
371 important if you're using the threaded version of &yaz; which
372 require you to pass more options to your linker/compiler.
375 The <filename>yaz-config</filename> script accepts command line
376 options that makes the <filename>yaz-config</filename> script print
377 options that you should use in your make process.
378 The most important ones are:
379 <literal>--cflags</literal>, <literal>--libs</literal>
380 which prints C compiler flags, and linker flags respectively.
383 A small and complete <literal>Makefile</literal> for a C
384 application consisting of one source file,
385 <filename>myprog.c</filename>, may look like this:
387 YAZCONFIG=/usr/local/bin/yaz-config
388 CFLAGS=`$(YAZCONFIG) --cflags`
389 LIBS=`$(YAZCONFIG) --libs`
391 $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
395 The CFLAGS variable consists of a C compiler directive that will set
396 the include path to the <emphasis>parent</emphasis> directory
397 of <filename>yaz</filename>. That is, if &yaz; header files were
398 installed in <filename>/usr/local/include/yaz</filename>,
399 then include path is set to <filename>/usr/local/include</filename>.
400 Therefore, in your applications you should use
402 #include <yaz/proto.h>
404 and <emphasis>not</emphasis>
406 #include <proto.h>
410 For Libtool users, the <filename>yaz-config</filename> script provides
411 a different variant of option <literal>--libs</literal>, called
412 <literal>--lalibs</literal> that returns the name of the
413 Libtool acrhive(s) for &yaz; rather than the ordinary ones.
416 For applications using the threaded version of &yaz;,
417 specify <literal>threads</literal> after the
418 other options. When <literal>threads</literal> is given,
419 more flags and linker flags will be printed by
420 <filename>yaz-config</filename>. If our previous example was
421 using threads, you'd have to modify the lines that set
422 <literal>CFLAGS</literal> and <literal>LIBS</literal> as
425 CFLAGS=`$(YAZCONFIG) --cflags threads`
426 LIBS=`$(YAZCONFIG) --libs threads`
428 There is no need specify POSIX thread libraries in your Makefile.
429 The <literal>LIBS</literal> variable includes that as well.
433 <sect1 id="installation.win32"><title>WIN32</title>
435 <para>The easiest way to install YAZ on Windows is by downloading
437 <ulink url="http://ftp.indexdata.dk/pub/yaz/win32">here</ulink>.
438 The installer comes with source too - in case you wish to
439 compile YAZ with different Compiler options etc.
442 <sect2 id="installation.win32.source">
443 <title>Compiling from Source on WIN32</title>
445 &yaz; is shipped with "makefiles" for the NMAKE tool that comes
446 with <ulink url="http://msdn.microsoft.com/vstudio/">
447 Microsoft Visual Studio</ulink>.
448 Version 6 and .NET has been tested. We expect that &yaz; compiles
449 with version 5 as well.
452 Start a command prompt and switch the sub directory
453 <filename>WIN</filename> where the file <filename>makefile</filename>
454 is located. Customize the installation by editing the
455 <filename>makefile</filename> file (for example by using notepad).
457 The following summarizes the most important settings in that file:
460 <varlistentry><term><literal>DEBUG</literal></term>
462 If set to 1, the software is
463 compiled with debugging libraries (code generation is
464 multi-threaded debug DLL).
465 If set to 0, the software is compiled with release libraries
466 (code generation is multi-threaded DLL).
470 <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
472 If <literal>HAVE_TCL</literal> is set to 1, nmake will
473 use the ASN.1 compiler (Tcl based). You must set
474 <literal>TCL</literal> to the full path of the Tcl
478 If you do not have Tcl installed, set
479 <literal>HAVE_TCL</literal> to 0.
484 <term><literal>HAVE_BISON</literal>,
485 <literal>BISON</literal></term>
487 If GNU Bison is present, you might set <literal>HAVE_ICONV</literal>
488 to 1 and specify the Bison executable in <literal>BISON</literal>.
489 Bison is only required if you use the CVS version of
490 YAZ or if you modify the grammar for CQL
491 (<filename>cql.y</filename>).
494 A Windows version of GNU Bison is part of
495 <ulink url="http://unxutils.sourceforge.net/">unxutils</ulink>.
500 <term><literal>HAVE_ICONV</literal>,
501 <literal>ICONV_DIR</literal></term>
503 If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
504 with iconv support. In this configuration, set
505 <literal>ICONV_DIR</literal> to the iconv source directory.
510 <term><literal>HAVE_LIBXML2</literal>,
511 <literal>LIBXML2_DIR</literal></term>
514 If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
515 with SRW (and SOAP) support. In this configuration, set
516 <literal>LIBXML2_DIR</literal> to the
517 <ulink url="http://www.xmlsoft.org/">libxml2</ulink> source directory
519 <literal>ZLIB_DIR</literal> to the zlib directory.
524 Note that YAZ is not using ZLIB. But libxml2 is.
529 Windows versions of libxml2, zlib and iconv can be found
530 <ulink url="http://www.zlatkovic.com/libxml.en.html">
539 When satisfied with the settings in the makefile, type
546 If the <filename>nmake</filename> command is not found on your system
547 you probably haven't defined the environment variables required to
548 use that tool. To fix that, find and run the batch file
549 <filename>vcvars32.bat</filename>. You need to run it from within
550 the command prompt or set the environment variables "globally";
551 otherwise it doesn't work.
555 If you wish to recompile &yaz; - for example if you modify
556 settings in the <filename>makefile</filename> you can delete
557 object files, etc by running.
563 The following files are generated upon successful compilation:
566 <varlistentry><term><filename>bin/yaz.dll</filename></term>
568 &yaz; multi-threaded Dynamic Link Library.
569 </para></listitem></varlistentry>
571 <varlistentry><term><filename>lib/yaz.lib</filename></term>
573 Import library for <filename>yaz.dll</filename>.
574 </para></listitem></varlistentry>
576 <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
578 &yaz; Z39.50 client application. It's a WIN32 console application.
579 See chapter <link linkend="client">YAZ client</link> for more
581 </para></listitem></varlistentry>
583 <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
585 Z39.50 multi-threaded test/example server. It's a WIN32
587 </para></listitem></varlistentry>
589 <varlistentry><term><filename>bin/zoomsh.exe</filename></term>
591 Simple console application implemented on top of the
592 <link linkend="zoom">ZOOM</link> functions.
593 The application is a command line shell that allows you to enter
594 simple commands to perform ZOOM operations.
595 </para></listitem></varlistentry>
597 <varlistentry><term><filename>bin/zoomtst1.exe</filename>,
598 <filename>bin/zoomtst2.exe</filename>, ..</term>
600 Several small applications that demonstrates the ZOOM API.
601 </para></listitem></varlistentry>
608 <sect2><title>How to make apps using YAZ on WIN32</title>
610 This section will go though the process of linking your WIN32
611 applications with &yaz;.
614 Some people are confused by the fact that we use the nmake
615 tool to build &yaz;. They think they have to do that too - in order
616 to make their WIN32 applications work with &yaz;. The good news is that
617 you don't have to. You can use the integrated environment of
618 Visual Studio if desired for your own application.
621 When setting up a project or Makefile you have to set the following:
623 <varlistentry><term>include path</term><listitem><para>
624 Set it to the <filename>include</filename> directory of &yaz;.
625 </para></listitem></varlistentry>
626 <varlistentry><term>import library <filename>yaz.lib</filename>
627 </term><listitem><para>
628 You must link with this library. It's located in the
629 sub directory <filename>lib</filename> of &yaz;.
630 </para></listitem></varlistentry>
631 <varlistentry><term>dynamic link library <filename>yaz.dll</filename>
632 </term><listitem><para>
633 This DLL must be in your execution path when you invoke
634 your application. Specifically, you should distribute this
635 DLL with your application.
636 </para></listitem></varlistentry>
643 <!-- Keep this comment at the end of the file
648 sgml-minimize-attributes:nil
649 sgml-always-quote-attributes:t
652 sgml-parent-document: "yaz.xml"
653 sgml-local-catalogs: nil
654 sgml-namecase-general:t