1 <chapter id="installation"><title>Compilation and Installation</title>
3 <sect1 id="installation-introduction"><title>Introduction</title>
5 The latest version of the software will generally be found at:
8 <ulink url="&url.yaz.download;"/>
11 We have tried our best to keep the software portable, and on many
12 platforms, you should be able to compile everything with little or
17 The software is regularly tested on
18 <ulink url="&url.debian;">Debian GNU/Linux</ulink>,
19 <ulink url="&url.centos;">CentOS</ulink>,
20 <ulink url="&url.ubuntu;">Ubuntu Linux</ulink>,
21 <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
22 <ulink url="&url.macosx;">MAC OSX</ulink>,
23 <ulink url="&url.solaris;">Solaris</ulink>,
24 Windows 7, Windows Xp.
28 Some versions have be known to work on HP/UX,
29 DEC Unix, <ulink url="&url.netbsd;">NetBSD</ulink>,
30 <ulink url="&url.openbsd;">OpenBSD</ulink>,
32 Data General DG/UX (with some CFLAGS tinkering),
33 SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
34 environment and the GUSI socket libraries),
39 If you move the software to other platforms, we'd be grateful if you'd
40 let us know about it. If you run into difficulties, we will try to help
41 if we can, and if you solve the problems, we would be happy to include
42 your fixes in the next release. So far, we have mostly avoided
43 <literal>#ifdefs</literal> for individual platforms, and we'd
44 like to keep it that way as far as it makes sense.
48 We maintain a mailing-list for the purpose of announcing new releases and
49 bug-fixes, as well as general discussion. Subscribe by
51 <ulink url="&url.yaz.mailinglist;">here</ulink>.
52 General questions and problems can be directed at
53 <ulink url="&url.yaz.mail;"/>, or the address given at the top of
58 <sect1 id="installation.unix"><title>UNIX</title>
62 <ulink url="&url.debian;">Debian GNU/Linux</ulink> (i386 and amd64),
63 <ulink url="&url.ubuntu;">Ubuntu</ulink> (i386 and amd64)
65 <ulink url="&url.centos;">CentOS</ulink> (amd64 only) packages for &yaz;.
66 You should be able to create packages for other CPUs by building
67 them from the source package.
71 YAZ is also part of several packages repositories. Some of them are
77 Solaris CSW: <ulink url="http://www.opencsw.org/packages/yaz/"/>
82 Solaris: <ulink url="http://unixpackages.com"/>
87 FreeBSD: <ulink url="http://www.freshports.org/net/yaz"/>
92 Debian: <ulink url="http://packages.debian.org/search?keywords=yaz"/>
97 Ubuntu: <ulink url="https://launchpad.net/ubuntu/+source/yaz"/>
103 <ulink url="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html"/>
108 <sect2 id="installation.source.unix">
109 <title>Compiling from source on Unix</title>
112 Note that if your system doesn't have a native ANSI C compiler, you may
113 have to acquire one separately. We recommend
114 <ulink url="&url.gcc;">GCC</ulink>.
118 If you wish to use character set conversion facilities in &yaz; or if you
119 are compiling &yaz; for use with Zebra it is a good idea to ensure that
120 the iconv library is installed. Some Unixes today already have it
122 <ulink url="&url.libiconv;">GNU libiconv</ulink>.
126 YAZ 3.0.16 and later includes a wrapper for the
127 <ulink url="&url.icu;">ICU</ulink>
128 (International Components for Unicode).
129 In order to use this, the developer version of the ICU library
134 The <ulink url="&url.libxslt;">libxslt</ulink>,
135 <ulink url="&url.libxml2;">libxml2</ulink> librararies are required
136 if &yaz; is to support SRU.
137 These libraries are very portable and should compile out-of-the
138 box on virtually all Unix platforms. It is available in binary
139 forms for Linux and others.
144 <ulink url="&url.autoconf;">Autoconf</ulink>,
145 <ulink url="&url.automake;">Automake</ulink> and
146 <ulink url="&url.libtool;">Libtool</ulink>
147 are used to generate Makefiles and configure &yaz; for the system.
148 You do <emphasis>not</emphasis> these tools unless you're using the
149 git version of &yaz;.
153 The CQL parser for &yaz; is built using
154 GNU <ulink url="&url.bison;">Bison</ulink>.
155 This tool is only needed if you're using the git version of &yaz;.
159 &yaz; includes a tiny ASN.1 compiler. This compiler is
160 written in <ulink url="&url.tcl;">Tcl</ulink>.
161 But as for Bison you do not need it unless you're using git
162 version of &yaz; or you're using the compiler to built own codecs
167 Generally it should be sufficient to run configure without options,
176 The configure script attempts to use use the C compiler specified by
177 the <literal>CC</literal> environment variable. If not set, GNU C will be
178 used if it is available. The <literal>CFLAGS</literal> environment
179 variable holds options to be passed to the C compiler. If you're using
180 Bourne-compatible shell you may pass something like this to use a
181 particular C compiler with optimization enabled:
185 CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
189 To customize &yaz;, the configure script also accepts a set of options.
190 The most important are:
194 <literal>--prefix</literal>=<replaceable>prefix</replaceable></term>
195 <listitem><para>Specifies installation prefix for &yaz;. This is
196 only needed if you run <literal>make install</literal> later to
197 perform a "system" installation. The prefix is
198 <literal>/usr/local</literal> if not specified.
201 <varlistentry><term><literal>--enable-tcpd</literal></term>
202 <listitem><para>The front end server will be built using Wietse's
203 <ulink url="&url.tcpwrapper;">TCP wrapper library</ulink>.
204 It allows you to allow/deny clients depending on IP number.
205 The TCP wrapper library is often used in GNU/Linux and
209 <refentrytitle>hosts_access</refentrytitle>
210 <manvolnum>5</manvolnum>
214 <refentrytitle>tcpd</refentrytitle>
215 <manvolnum>8</manvolnum>
220 <varlistentry><term><literal>--enable-threads</literal></term>
221 <listitem><para>&yaz; will be built using POSIX threads.
222 Specifically, <constant>_REENTRANT</constant> will be defined during
227 <varlistentry><term><literal>--disable-shared</literal></term>
228 <listitem><para>The make process will not create shared
229 libraries (also known as shared objects <filename>.so</filename>).
230 By default, shared libraries are created -
231 equivalent to <literal>--enable-shared</literal>.
235 <varlistentry><term><literal>--disable-shared</literal></term>
236 <listitem><para>The make process will not create
237 static libraries (<filename>.a</filename>).
238 By default, static libraries are created -
239 equivalent to <literal>--enable-static</literal>.
244 <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
246 <listitem><para>Compile &yaz; with iconv library in directory
247 <replaceable>prefix</replaceable>. By default configure will
248 search for iconv on the system. Use this option if it
249 doesn't find iconv. Alternatively,
250 <literal>--without-iconv</literal>, can be uset to force &yaz;
256 <literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
258 <listitem><para>Compile &yaz; with
259 <ulink url="&url.libxslt;">libxslt</ulink> in directory
260 <replaceable>prefix</replaceable>.
261 Use this option if you want XSLT and XML support.
262 By default, configure will
263 search for libxslt on the system. Use this option if it
264 libxslt is not found automatically. Alternatively,
265 <literal>--without-xslt</literal>, can be used to force &yaz;
272 <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
274 <listitem><para>Compile &yaz; with
275 <ulink url="&url.libxml2;">libxml2</ulink> in directory
276 <replaceable>prefix</replaceable>.
277 Use this option if you want &yaz; to use XML and support SRU.
278 By default, configure will
279 search for libxml2 on the system. Use this option if it
280 libxml2 is not found automatically. Alternatively,
281 <literal>--without-xml2</literal>, can be used to force &yaz;
285 Note that option <literal>--with-xslt</literal>
286 also enables libxml2.
292 <literal>--with-gnutls</literal>[=<replaceable>prefix</replaceable>]
294 <listitem><para>&yaz; will be linked with the GNU TLS libraries and
295 an SSL COMSTACK will be provided. By default configure enables
296 SSL support for YAZ if the GNU TLS development libraries are found
302 <literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]
304 <listitem><para>&yaz; will be linked the
305 <ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
306 If prefix is not given, the libraries exposed by the script
307 <application>icu-config</application> will be used if found.
312 <literal>--with-libgcrypt</literal>[=<replaceable>prefix</replaceable>]
314 <listitem><para>&yaz; will be linked with
315 <ulink url="&url.libgcrypt;">Libgcrypt</ulink> in the prefix if given.
316 If prefix is not given, the libraries exposed by the script
317 <application>libgcrypt-config</application> will be used if found.
322 <literal>--with-memcached</literal>
324 <listitem><para>&yaz; will be linked with
325 <ulink url="&url.libmemcached;">libMemcached</ulink> to allow
326 for result-set caching for ZOOM.
327 The prefix can not be given. Note that YAZ will only search
328 for libMemcached if Libgcrypt is also enabled.
336 When configured, build the software by typing:
343 The following files are generated by the make process:
345 <varlistentry><term><filename>src/libyaz.la</filename></term>
347 Main &yaz; library. This is no ordinary library. It's
349 By default, &yaz; creates a static library in
350 <filename>lib/.libs/libyaz.a</filename>.
354 <varlistentry><term><filename>src/libyaz_server.la</filename></term>
356 Generic Frontend server. This is an add-on for libyaz.la.
357 Code in this library uses POSIX threads functions - if POSIX
358 threads are available on the platform.
362 <varlistentry><term><filename>src/libyaz_icu.la</filename></term>
364 Functions that wrap the ICU library.
368 <varlistentry><term><filename>ztest/yaz-ztest</filename></term>
369 <listitem><para>Test Z39.50 server.
373 <varlistentry><term><filename>client/yaz-client</filename></term>
374 <listitem><para>Z39.50 client for testing the protocol.
375 See chapter <link linkend="yaz-client">
376 YAZ client</link> for more information.
380 <varlistentry><term><filename>util/yaz-config</filename></term>
381 <listitem><para>A Bourne-shell script, generated by configure, that
382 specifies how external applications should compile - and link with
387 <varlistentry><term><filename>util/yaz-asncomp</filename></term>
388 <listitem><para>The ASN.1 compiler for &yaz;. Requires the
389 Tcl Shell, <application>tclsh</application>, in
390 <literal>PATH</literal> to operate.
394 <varlistentry><term><filename>util/yaz-iconv</filename></term>
395 <listitem><para>This program converts data in one character set to
396 another. This command exercises the YAZ character set
401 <varlistentry><term><filename>util/yaz-marcdump</filename></term>
402 <listitem><para>This program parses ISO2709 encoded MARC records
403 and prints them in line-format or XML.
407 <varlistentry><term><filename>util/yaz-icu</filename></term>
408 <listitem><para>This program exposes the ICU wrapper library if that
409 is enabled for YAZ. Only if ICU is available this program is
414 <varlistentry><term><filename>zoom/zoomsh</filename></term>
416 A simple shell implemented on top of the
417 <link linkend="zoom">ZOOM</link> functions.
418 The shell is a command line application that allows you to enter
419 simple commands to perform ZOOM operations.
423 <varlistentry><term><filename>zoom/zoomtst1</filename>,
424 <filename>zoom/zoomtst2</filename>, ..</term>
426 Several small applications that demonstrates the ZOOM API.
434 If you wish to install &yaz; in system directories
435 <filename>/usr/local/bin</filename>,
436 <filename>/usr/local/lib</filename> .. etc, you can type:
444 You probably need to have root access in order to perform this.
445 You must specify the <literal>--prefix</literal> option for configure if
446 you wish to install &yaz; in other directories than the default
447 <filename>/usr/local/</filename>.
451 If you wish to perform an un-installation of &yaz;, use:
459 This will only work if you haven't reconfigured &yaz; (and therefore
460 changed installation prefix). Note that uninstall will not
461 remove directories created by make install, e.g.
462 <filename>/usr/local/include/yaz</filename>.
466 <sect2 id="installation-linking-yaz-unix">
467 <title>How to make apps using YAZ on UNIX</title>
469 This section describes how to compile - and link your own
470 applications using the &yaz; toolkit.
471 If you're used to Makefiles this shouldn't be hard. As for
472 other libraries you have used before, you have to set a proper include
473 path for your C/C++ compiler and specify the location of
474 &yaz; libraries. You can do it by hand, but generally we suggest
475 you use the <filename>yaz-config</filename> that is generated
476 by <filename>configure</filename>. This is especially
477 important if you're using the threaded version of &yaz; which
478 require you to pass more options to your linker/compiler.
481 The <filename>yaz-config</filename> script accepts command line
482 options that makes the <filename>yaz-config</filename> script print
483 options that you should use in your make process.
484 The most important ones are:
485 <literal>--cflags</literal>, <literal>--libs</literal>
486 which prints C compiler flags, and linker flags respectively.
489 A small and complete <literal>Makefile</literal> for a C
490 application consisting of one source file,
491 <filename>myprog.c</filename>, may look like this:
493 YAZCONFIG=/usr/local/bin/yaz-config
494 CFLAGS=`$(YAZCONFIG) --cflags`
495 LIBS=`$(YAZCONFIG) --libs`
497 $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
501 The CFLAGS variable consists of a C compiler directive that will set
502 the include path to the <emphasis>parent</emphasis> directory
503 of <filename>yaz</filename>. That is, if &yaz; header files were
504 installed in <filename>/usr/local/include/yaz</filename>,
505 then include path is set to <filename>/usr/local/include</filename>.
506 Therefore, in your applications you should use
508 #include <yaz/proto.h>
510 and <emphasis>not</emphasis>
512 #include <proto.h>
516 For Libtool users, the <filename>yaz-config</filename> script provides
517 a different variant of option <literal>--libs</literal>, called
518 <literal>--lalibs</literal> that returns the name of the
519 Libtool archive(s) for &yaz; rather than the ordinary ones.
522 For applications using the threaded version of &yaz;,
523 specify <literal>threads</literal> after the
524 other options. When <literal>threads</literal> is given,
525 more flags and linker flags will be printed by
526 <filename>yaz-config</filename>. If our previous example was
527 using threads, you'd have to modify the lines that set
528 <literal>CFLAGS</literal> and <literal>LIBS</literal> as
531 CFLAGS=`$(YAZCONFIG) --cflags threads`
532 LIBS=`$(YAZCONFIG) --libs threads`
534 There is no need specify POSIX thread libraries in your Makefile.
535 The <literal>LIBS</literal> variable includes that as well.
539 <sect1 id="installation.win32"><title>WIN32</title>
541 <para>The easiest way to install YAZ on Windows is by downloading
543 <ulink url="&url.yaz.download.win32;">here</ulink>.
544 The installer comes with source too - in case you wish to
545 compile YAZ with different compiler options, etc.
548 <sect2 id="installation.win32.source">
549 <title>Compiling from Source on WIN32</title>
551 &yaz; is shipped with "makefiles" for the NMAKE tool that comes
552 with <ulink url="&url.vstudio;">
553 Microsoft Visual Studio</ulink>. It has been tested with
554 Microsoft Visual Studio 2003/2005/2008.
557 Start a command prompt and switch the sub directory
558 <filename>WIN</filename> where the file <filename>makefile</filename>
559 is located. Customize the installation by editing the
560 <filename>makefile</filename> file (for example by using notepad).
562 The following summarizes the most important settings in that file:
565 <varlistentry><term><literal>DEBUG</literal></term>
567 If set to 1, the software is
568 compiled with debugging libraries (code generation is
569 multi-threaded debug DLL).
570 If set to 0, the software is compiled with release libraries
571 (code generation is multi-threaded DLL).
575 <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
577 If <literal>HAVE_TCL</literal> is set to 1, nmake will
578 use the ASN.1 compiler (<ulink url="&url.tcl;">Tcl</ulink> based).
579 You must set <literal>TCL</literal> to the full path of the Tcl
580 interpreter. A Windows version of Tcl is part of
581 <ulink url="&url.gitwindows;">Git for Windows</ulink>.
584 If you do not have Tcl installed, set
585 <literal>HAVE_TCL</literal> to 0.
590 <term><literal>HAVE_BISON</literal>,
591 <literal>BISON</literal></term>
593 If GNU Bison is present, you might set <literal>HAVE_BISON</literal>
594 to 1 and specify the Bison executable in <literal>BISON</literal>.
595 Bison is only required if you use the git version of
596 YAZ or if you modify the grammar for CQL
597 (<filename>cql.y</filename>).
600 A Windows version of GNU Bison is part of
601 <ulink url="&url.gitwindows;">Git for Windows</ulink>.
606 <term><literal>HAVE_ICONV</literal>,
607 <literal>ICONV_DIR</literal></term>
609 If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
610 with iconv support. In this configuration, set
611 <literal>ICONV_DIR</literal> to the iconv source directory.
616 <term><literal>HAVE_LIBXML2</literal>,
617 <literal>LIBXML2_DIR</literal></term>
620 If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
621 with SRU support. In this configuration, set
622 <literal>LIBXML2_DIR</literal> to the
623 <ulink url="&url.libxml2;">libxml2</ulink> source directory
625 <literal>ZLIB_DIR</literal> to the zlib directory.
629 Windows versions of libxslt, libxml2, zlib and iconv can be found
630 <ulink url="&url.libxml2.download.win32;">
631 Igor Zlatković' site</ulink>.
636 YAZ is not using zlib but libxml2 is depending on it.
643 <term><literal>HAVE_LIBXSLT</literal>,
644 <literal>LIBXSLT_DIR</literal></term>
647 If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
648 with XSLT support. In this configuration, set
649 <literal>LIBXSLT_DIR</literal> to the
650 <ulink url="&url.libxslt;">libxslt</ulink> source directory.
655 libxslt depends libxml2.
662 <term><literal>HAVE_ICU</literal>,
663 <literal>ICU_DIR</literal></term>
666 If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
667 with <ulink url="&url.icu;">ICU</ulink> support.
668 In this configuration, set
669 <literal>ICU_DIR</literal> to the
670 <ulink url="&url.icu;">ICU</ulink> source directory.
679 When satisfied with the settings in the makefile, type
686 If the <filename>nmake</filename> command is not found on your system
687 you probably haven't defined the environment variables required to
688 use that tool. To fix that, find and run the batch file
689 <filename>vcvars32.bat</filename>. You need to run it from within
690 the command prompt or set the environment variables "globally";
691 otherwise it doesn't work.
695 If you wish to recompile &yaz; - for example if you modify
696 settings in the <filename>makefile</filename> you can delete
697 object files, etc by running.
703 The following files are generated upon successful compilation:
706 <varlistentry><term><filename>bin/yaz5.dll</filename> /
707 <filename>bin/yaz5d.dll</filename></term>
709 &yaz; Release/Debug DLL.
710 </para></listitem></varlistentry>
712 <varlistentry><term><filename>lib/yaz5.lib</filename> /
713 <filename>lib/yaz5d.lib</filename></term>
715 Import library for <filename>yaz5.dll</filename> /
716 <filename>yaz5d.dll</filename>.
717 </para></listitem></varlistentry>
719 <varlistentry><term><filename>bin/yaz_cond5.dll</filename> /
720 <filename>bin/yaz_cond5d.dll</filename></term>
722 Release/Debug DLL for condition variable utilities (condvar.c).
723 </para></listitem></varlistentry>
725 <varlistentry><term><filename>lib/yaz_cond5.lib</filename> /
726 <filename>lib/yaz_cond5d.lib</filename></term>
728 Import library for <filename>yaz_cond5.dll</filename> /
729 <filename>yaz_cond5d.dll</filename>.
730 </para></listitem></varlistentry>
732 <varlistentry><term><filename>bin/yaz_icu5.dll</filename> /
733 <filename>bin/yaz_icu5d.dll</filename></term>
735 Release/Debug DLL for the ICU wrapper utility.
736 Only build if HAVE_ICU is 1.
737 </para></listitem></varlistentry>
739 <varlistentry><term><filename>lib/yaz_icu5.lib</filename> /
740 <filename>lib/yaz_icu5d.lib</filename></term>
742 Import library for <filename>yaz_icu5.dll</filename> /
743 <filename>yaz_icu5d.dll</filename>.
744 </para></listitem></varlistentry>
746 <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
748 Z39.50 multi-threaded test/example server. It's a WIN32
750 </para></listitem></varlistentry>
752 <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
754 &yaz; Z39.50 client application. It's a WIN32 console application.
755 See chapter <link linkend="yaz-client">YAZ client</link> for more
757 </para></listitem></varlistentry>
759 <varlistentry><term><filename>bin/yaz-icu.exe</filename></term>
760 <listitem><para>This program exposes the ICU wrapper library if that
761 is enabled for YAZ. Only if ICU is available this program is
763 </para></listitem></varlistentry>
765 <varlistentry><term><filename>bin/zoomsh.exe</filename></term>
767 Simple console application implemented on top of the
768 <link linkend="zoom">ZOOM</link> functions.
769 The application is a command line shell that allows you to enter
770 simple commands to perform ZOOM operations.
771 </para></listitem></varlistentry>
773 <varlistentry><term><filename>bin/zoomtst1.exe</filename>,
774 <filename>bin/zoomtst2.exe</filename>, ..</term>
776 Several small applications that demonstrates the ZOOM API.
777 </para></listitem></varlistentry>
784 <sect2 id="installation-linking-yaz-win32">
785 <title>How to make apps using YAZ on WIN32</title>
787 This section will go though the process of linking your WIN32
788 applications with &yaz;.
791 Some people are confused by the fact that we use the nmake
792 tool to build &yaz;. They think they have to do that too - in order
793 to make their WIN32 applications work with &yaz;. The good news is that
794 you don't have to. You can use the integrated environment of
795 Visual Studio if desired for your own application.
798 When setting up a project or Makefile you have to set the following:
800 <varlistentry><term>include path</term><listitem><para>
801 Set it to the <filename>include</filename> directory of &yaz;.
802 </para></listitem></varlistentry>
803 <varlistentry><term>import library <filename>yaz5.lib</filename>
804 </term><listitem><para>
805 You must link with this library. It's located in the
806 sub directory <filename>lib</filename> of &yaz;.
807 If you want to link with the debug version of &yaz;, you must
808 link against <filename>yaz5d.lib</filename> instead.
809 </para></listitem></varlistentry>
810 <varlistentry><term>dynamic link library <filename>yaz5.dll</filename>
811 </term><listitem><para>
812 This DLL must be in your execution path when you invoke
813 your application. Specifically, you should distribute this
814 DLL with your application.
815 </para></listitem></varlistentry>
822 <!-- Keep this comment at the end of the file
827 sgml-minimize-attributes:nil
828 sgml-always-quote-attributes:t
831 sgml-parent-document: "yaz.xml"
832 sgml-local-catalogs: nil
833 sgml-namecase-general:t