1 <!-- $Id: installation.xml,v 1.35 2007-01-31 15:27:17 adam Exp $ -->
2 <chapter id="installation"><title>Compilation and Installation</title>
4 <sect1 id="installation-introduction"><title>Introduction</title>
6 The latest version of the software will generally be found at:
9 <ulink url="&url.yaz.download;"/>
12 We have tried our best to keep the software portable, and on many
13 platforms, you should be able to compile everything with little or
18 The software is regularly tested on
19 <ulink url="&url.debian;">Debian GNU/Linux</ulink>,
20 <ulink url="&url.redhat;">Redhat Linux</ulink>,
21 <ulink url="&url.gentoo;">Gentoo Linux</ulink>,
22 <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
23 <ulink url="&url.macosx;">MAC OSX</ulink>,
24 <ulink url="&url.solaris;">SunOS 5.8 (sparc)</ulink>,
25 <ulink url="&url.windows2000;">Windows 2000</ulink>,
26 <ulink url="&url.windows2003server;">Windows 2003 server</ulink>.
30 Some versions have be known to work on HP/UX,
31 DEC Unix, <ulink url="&url.netbsd;">NetBSD</ulink>,
32 <ulink url="&url.openbsd;">OpenBSD</ulink>,
34 Data General DG/UX (with some CFLAGS tinkering),
35 SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
36 environment and the GUSI socket libraries),
41 If you move the software to other platforms, we'd be grateful if you'd
42 let us know about it. If you run into difficulties, we will try to help
43 if we can, and if you solve the problems, we would be happy to include
44 your fixes in the next release. So far, we have mostly avoided
45 <literal>#ifdefs</literal> for individual platforms, and we'd
46 like to keep it that way as far as it makes sense.
50 We maintain a mailing-list for the purpose of announcing new releases and
51 bug-fixes, as well as general discussion. Subscribe by
53 <ulink url="&url.yaz.mailinglist;">here</ulink>.
54 General questions and problems can be directed at
55 <ulink url="&url.yaz.mail;"/>, or the address given at the top of
60 <sect1 id="installation.unix"><title>UNIX</title>
64 <ulink url="&url.debian;">Debian GNU/Linux</ulink>
66 <ulink url="&url.redhat;">Redhat</ulink> packages for &yaz;.
67 Only i386 binary packages are available. You should be able to
68 create packages for other CPUs by building them from the source
72 <sect2 id="installation.source.unix">
73 <title>Compiling from source on Unix</title>
76 Note that if your system doesn't have a native ANSI C compiler, you may
77 have to acquire one separately. We recommend
78 <ulink url="&url.gcc;">GCC</ulink>.
82 If you wish to use character set conversion facilities in &yaz; or if you
83 are compiling &yaz; for use with Zebra it is a good idea to ensure that
84 the iconv library is installed. Some Unixes today already have it
86 <ulink url="&url.libiconv;">GNU libiconv</ulink>.
90 The <ulink url="&url.libxslt;">libxslt</ulink>,
91 <ulink url="&url.libxml2;">libxml2</ulink> librararies are required
92 if &yaz; is to support SRU.
93 These libraries are very portable and should compile out-of-the
94 box on virtually all Unix platforms. It is available in binary
95 forms for Linux and others.
100 <ulink url="&url.autoconf;">Autoconf</ulink>,
101 <ulink url="&url.automake;">Automake</ulink> and
102 <ulink url="&url.libtool;">Libtool</ulink>
103 are used to generate Makefiles and configure &yaz; for the system.
104 You do <emphasis>not</emphasis> these tools unless you're using the
105 CVS version of &yaz;.
109 YAZ can optionally be compiled with
110 <ulink url="&url.libpcap;">libpcap</ulink> support. By default,
111 configure enables libpcap if it is available.
112 The libpcap library is required for
113 <link linkend="ziffy">ziffy</link>. And without libpcap,
114 ziffy will not be built.
118 The CQL parser for &yaz; is built using
119 GNU <ulink url="&url.bison;">Bison</ulink>.
120 This tool is only needed if you're using the CVS version of &yaz;.
124 &yaz; includes a tiny ASN.1 compiler. This compiler is
125 written in <ulink url="&url.tcl;">Tcl</ulink>.
126 But as for Bison you do not need it unless you're using CVS
127 version of &yaz; or you're using the compiler to built own codecs
132 Generally it should be sufficient to run configure without options,
141 The configure script attempts to use use the C compiler specified by
142 the <literal>CC</literal> environment variable. If not set, GNU C will be
143 used if it is available. The <literal>CFLAGS</literal> environment
144 variable holds options to be passed to the C compiler. If you're using
145 Bourne-compatible shell you may pass something like this to use a
146 particular C compiler with optimization enabled:
150 CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
154 To customize &yaz;, the configure script also accepts a set of options.
155 The most important are:
159 <literal>--prefix</literal>=<replaceable>prefix</replaceable></term>
160 <listitem><para>Specifies installation prefix for &yaz;. This is
161 only needed if you run <literal>make install</literal> later to
162 perform a "system" installation. The prefix is
163 <literal>/usr/local</literal> if not specified.
166 <varlistentry><term><literal>--enable-tcpd</literal></term>
167 <listitem><para>The front end server will be built using Wietse's
168 <ulink url="&url.tcpwrapper;">TCP wrapper library</ulink>.
169 It allows you to allow/deny clients depending on IP number.
170 The TCP wrapper library is often used in GNU/Linux and
174 <refentrytitle>hosts_access</refentrytitle>
175 <manvolnum>5</manvolnum>
179 <refentrytitle>tcpd</refentrytitle>
180 <manvolnum>8</manvolnum>
185 <varlistentry><term><literal>--enable-threads</literal></term>
186 <listitem><para>&yaz; will be built using POSIX threads.
187 Specifically, <constant>_REENTRANT</constant> will be defined during
192 <varlistentry><term><literal>--disable-shared</literal></term>
193 <listitem><para>The make process will not create shared
194 libraries (also known as shared objects <filename>.so</filename>).
195 By default, shared libraries are created -
196 equivalent to <literal>--enable-shared</literal>.
200 <varlistentry><term><literal>--disable-shared</literal></term>
201 <listitem><para>The make process will not create
202 static libraries (<filename>.a</filename>).
203 By default, static libraries are created -
204 equivalent to <literal>--enable-static</literal>.
209 <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
211 <listitem><para>Compile &yaz; with iconv library in directory
212 <replaceable>prefix</replaceable>. By default configure will
213 search for iconv on the system. Use this option if it
214 doesn't find iconv. Alternatively,
215 <literal>--without-iconv</literal>, can be uset to force &yaz;
221 <literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
223 <listitem><para>Compile &yaz; with
224 <ulink url="&url.libxslt;">libxslt</ulink> in directory
225 <replaceable>prefix</replaceable>.
226 Use this option if you want SRU support.
227 By default, configure will
228 search for libxslt on the system. Use this option if it
229 libxslt is not found automatically. Alternatively,
230 <literal>--without-xslt</literal>, can be used to force &yaz;
236 <literal>--with-openssl</literal>[=<replaceable>prefix</replaceable>]
238 <listitem><para>&yaz; will be linked with the OpenSSL libraries and
239 an SSL COMSTACK will be provided. Note that SSL support is still
245 <literal>--with-libpcap</literal>[=<replaceable>prefix</replaceable>]
247 <listitem><para>Compile &yaz; with
248 <ulink url="&url.libpcap;">libpcap</ulink> support and the
249 <link linkend="ziffy">ziffy</link> utility.
257 When configured, build the software by typing:
264 The following files are generated by the make process:
266 <varlistentry><term><filename>src/libyaz.la</filename></term>
268 Main &yaz; library. This is no ordinary library. It's
270 By default, &yaz; creates a static library in
271 <filename>lib/.libs/libyaz.a</filename>.
275 <varlistentry><term><filename>src/libyazthread.la</filename></term>
277 When threading is supported/enabled by configure this Libtool
278 library is created. It includes functions that allows &yaz;
283 <varlistentry><term><filename>ztest/yaz-ztest</filename></term>
284 <listitem><para>Test Z39.50 server.
288 <varlistentry><term><filename>client/yaz-client</filename></term>
289 <listitem><para>Z39.50 client for testing the protocol.
290 See chapter <link linkend="client">
291 YAZ client</link> for more information.
295 <varlistentry><term><filename>ziffy/ziffy</filename></term>
296 <listitem><para>A promiscuous Z39.50 APDU sniffer.
297 ziffy is only built on systems where libpcap is available.
298 See <xref linkend="ziffy"/> for more information.
302 <varlistentry><term><filename>util/yaz-config</filename></term>
303 <listitem><para>A Bourne-shell script, generated by configure, that
304 specifies how external applications should compile - and link with
309 <varlistentry><term><filename>util/yaz-asncomp</filename></term>
310 <listitem><para>The ASN.1 compiler for &yaz;. Requires the
311 Tcl Shell, <application>tclsh</application>, in
312 <literal>PATH</literal> to operate.
316 <varlistentry><term><filename>util/yaz-iconv</filename></term>
317 <listitem><para>This program converts data in one character set to
318 another. This command exercises the YAZ character set
323 <varlistentry><term><filename>util/yaz-marcdump</filename></term>
324 <listitem><para>This program parses ISO2709 encoded MARC records
325 and prints them in line-format or XML.
329 <varlistentry><term><filename>zoom/zoomsh</filename></term>
331 A simple shell implemented on top of the
332 <link linkend="zoom">ZOOM</link> functions.
333 The shell is a command line application that allows you to enter
334 simple commands to perform ZOOM operations.
338 <varlistentry><term><filename>zoom/zoomtst1</filename>,
339 <filename>zoom/zoomtst2</filename>, ..</term>
341 Several small applications that demonstrates the ZOOM API.
349 If you wish to install &yaz; in system directories
350 <filename>/usr/local/bin</filename>,
351 <filename>/usr/local/lib</filename> .. etc, you can type:
359 You probably need to have root access in order to perform this.
360 You must specify the <literal>--prefix</literal> option for configure if
361 you wish to install &yaz; in other directories than the default
362 <filename>/usr/local/</filename>.
366 If you wish to perform an un-installation of &yaz;, use:
374 This will only work if you haven't reconfigured &yaz; (and therefore
375 changed installation prefix). Note that uninstall will not
376 remove directories created by make install, e.g.
377 <filename>/usr/local/include/yaz</filename>.
381 <sect2 id="installation-linking-yaz-unix">
382 <title>How to make apps using YAZ on UNIX</title>
384 This section describes how to compile - and link your own
385 applications using the &yaz; toolkit.
386 If you're used to Makefiles this shouldn't be hard. As for
387 other libraries you have used before, you have to set a proper include
388 path for your C/C++ compiler and specify the location of
389 &yaz; libraries. You can do it by hand, but generally we suggest
390 you use the <filename>yaz-config</filename> that is generated
391 by <filename>configure</filename>. This is especially
392 important if you're using the threaded version of &yaz; which
393 require you to pass more options to your linker/compiler.
396 The <filename>yaz-config</filename> script accepts command line
397 options that makes the <filename>yaz-config</filename> script print
398 options that you should use in your make process.
399 The most important ones are:
400 <literal>--cflags</literal>, <literal>--libs</literal>
401 which prints C compiler flags, and linker flags respectively.
404 A small and complete <literal>Makefile</literal> for a C
405 application consisting of one source file,
406 <filename>myprog.c</filename>, may look like this:
408 YAZCONFIG=/usr/local/bin/yaz-config
409 CFLAGS=`$(YAZCONFIG) --cflags`
410 LIBS=`$(YAZCONFIG) --libs`
412 $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
416 The CFLAGS variable consists of a C compiler directive that will set
417 the include path to the <emphasis>parent</emphasis> directory
418 of <filename>yaz</filename>. That is, if &yaz; header files were
419 installed in <filename>/usr/local/include/yaz</filename>,
420 then include path is set to <filename>/usr/local/include</filename>.
421 Therefore, in your applications you should use
423 #include <yaz/proto.h>
425 and <emphasis>not</emphasis>
427 #include <proto.h>
431 For Libtool users, the <filename>yaz-config</filename> script provides
432 a different variant of option <literal>--libs</literal>, called
433 <literal>--lalibs</literal> that returns the name of the
434 Libtool acrhive(s) for &yaz; rather than the ordinary ones.
437 For applications using the threaded version of &yaz;,
438 specify <literal>threads</literal> after the
439 other options. When <literal>threads</literal> is given,
440 more flags and linker flags will be printed by
441 <filename>yaz-config</filename>. If our previous example was
442 using threads, you'd have to modify the lines that set
443 <literal>CFLAGS</literal> and <literal>LIBS</literal> as
446 CFLAGS=`$(YAZCONFIG) --cflags threads`
447 LIBS=`$(YAZCONFIG) --libs threads`
449 There is no need specify POSIX thread libraries in your Makefile.
450 The <literal>LIBS</literal> variable includes that as well.
454 <sect1 id="installation.win32"><title>WIN32</title>
456 <para>The easiest way to install YAZ on Windows is by downloading
458 <ulink url="&url.yaz.download.win32;">here</ulink>.
459 The installer comes with source too - in case you wish to
460 compile YAZ with different Compiler options etc.
463 <sect2 id="installation.win32.source">
464 <title>Compiling from Source on WIN32</title>
466 &yaz; is shipped with "makefiles" for the NMAKE tool that comes
467 with <ulink url="&url.vstudio;">
468 Microsoft Visual Studio</ulink>.
469 Version 6 and .NET has been tested. We expect that &yaz; compiles
470 with version 5 as well.
473 Start a command prompt and switch the sub directory
474 <filename>WIN</filename> where the file <filename>makefile</filename>
475 is located. Customize the installation by editing the
476 <filename>makefile</filename> file (for example by using notepad).
478 The following summarizes the most important settings in that file:
481 <varlistentry><term><literal>DEBUG</literal></term>
483 If set to 1, the software is
484 compiled with debugging libraries (code generation is
485 multi-threaded debug DLL).
486 If set to 0, the software is compiled with release libraries
487 (code generation is multi-threaded DLL).
491 <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
493 If <literal>HAVE_TCL</literal> is set to 1, nmake will
494 use the ASN.1 compiler (Tcl based). You must set
495 <literal>TCL</literal> to the full path of the Tcl
499 If you do not have Tcl installed, set
500 <literal>HAVE_TCL</literal> to 0.
505 <term><literal>HAVE_BISON</literal>,
506 <literal>BISON</literal></term>
508 If GNU Bison is present, you might set <literal>HAVE_ICONV</literal>
509 to 1 and specify the Bison executable in <literal>BISON</literal>.
510 Bison is only required if you use the CVS version of
511 YAZ or if you modify the grammar for CQL
512 (<filename>cql.y</filename>).
515 A Windows version of GNU Bison is part of
516 <ulink url="&url.unxutils;">unxutils</ulink>.
521 <term><literal>HAVE_ICONV</literal>,
522 <literal>ICONV_DIR</literal></term>
524 If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
525 with iconv support. In this configuration, set
526 <literal>ICONV_DIR</literal> to the iconv source directory.
531 <term><literal>HAVE_LIBXML2</literal>,
532 <literal>LIBXML2_DIR</literal></term>
535 If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
536 with SRU support. In this configuration, set
537 <literal>LIBXML2_DIR</literal> to the
538 <ulink url="&url.libxml2;">libxml2</ulink> source directory
540 <literal>ZLIB_DIR</literal> to the zlib directory.
544 Windows versions of libxslt, libxml2, zlib and iconv can be found
545 <ulink url="&url.libxml2.download.win32;">
546 Igor Zlatković' site</ulink>.
551 YAZ is not using zlib but libxml2 is depending on it.
558 <term><literal>HAVE_LIBXSLT</literal>,
559 <literal>LIBXSLT_DIR</literal></term>
562 If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
563 with XSLT support. In this configuration, set
564 <literal>LIBXSLT_DIR</literal> to the
565 <ulink url="&url.libxslt;">libxslt</ulink> source directory.
570 libxslt depends libxml2.
580 When satisfied with the settings in the makefile, type
587 If the <filename>nmake</filename> command is not found on your system
588 you probably haven't defined the environment variables required to
589 use that tool. To fix that, find and run the batch file
590 <filename>vcvars32.bat</filename>. You need to run it from within
591 the command prompt or set the environment variables "globally";
592 otherwise it doesn't work.
596 If you wish to recompile &yaz; - for example if you modify
597 settings in the <filename>makefile</filename> you can delete
598 object files, etc by running.
604 The following files are generated upon successful compilation:
607 <varlistentry><term><filename>bin/yaz.dll</filename></term>
609 &yaz; release mode multi-threaded Dynamic Link Library.
610 </para></listitem></varlistentry>
612 <varlistentry><term><filename>lib/yaz.lib</filename></term>
614 Import library for <filename>yaz.dll</filename>.
615 </para></listitem></varlistentry>
617 <varlistentry><term><filename>bin/yazd.dll</filename></term>
619 &yaz; debug mode multi-threaded Dynamic Link Library.
620 </para></listitem></varlistentry>
622 <varlistentry><term><filename>lib/yazd.lib</filename></term>
624 Import library for <filename>yazd.dll</filename>.
625 </para></listitem></varlistentry>
627 <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
629 &yaz; Z39.50 client application. It's a WIN32 console application.
630 See chapter <link linkend="client">YAZ client</link> for more
632 </para></listitem></varlistentry>
634 <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
636 Z39.50 multi-threaded test/example server. It's a WIN32
638 </para></listitem></varlistentry>
640 <varlistentry><term><filename>bin/zoomsh.exe</filename></term>
642 Simple console application implemented on top of the
643 <link linkend="zoom">ZOOM</link> functions.
644 The application is a command line shell that allows you to enter
645 simple commands to perform ZOOM operations.
646 </para></listitem></varlistentry>
648 <varlistentry><term><filename>bin/zoomtst1.exe</filename>,
649 <filename>bin/zoomtst2.exe</filename>, ..</term>
651 Several small applications that demonstrates the ZOOM API.
652 </para></listitem></varlistentry>
659 <sect2 id="installation-linking-yaz-win32">
660 <title>How to make apps using YAZ on WIN32</title>
662 This section will go though the process of linking your WIN32
663 applications with &yaz;.
666 Some people are confused by the fact that we use the nmake
667 tool to build &yaz;. They think they have to do that too - in order
668 to make their WIN32 applications work with &yaz;. The good news is that
669 you don't have to. You can use the integrated environment of
670 Visual Studio if desired for your own application.
673 When setting up a project or Makefile you have to set the following:
675 <varlistentry><term>include path</term><listitem><para>
676 Set it to the <filename>include</filename> directory of &yaz;.
677 </para></listitem></varlistentry>
678 <varlistentry><term>import library <filename>yaz.lib</filename>
679 </term><listitem><para>
680 You must link with this library. It's located in the
681 sub directory <filename>lib</filename> of &yaz;.
682 If you want to link with the debug version of &yaz;, you must
683 link with <filename>yazd.dll</filename> instead.
684 </para></listitem></varlistentry>
685 <varlistentry><term>dynamic link library <filename>yaz.dll</filename>
686 </term><listitem><para>
687 This DLL must be in your execution path when you invoke
688 your application. Specifically, you should distribute this
689 DLL with your application.
690 </para></listitem></varlistentry>
697 <!-- Keep this comment at the end of the file
702 sgml-minimize-attributes:nil
703 sgml-always-quote-attributes:t
706 sgml-parent-document: "yaz.xml"
707 sgml-local-catalogs: nil
708 sgml-namecase-general:t