doc/installation.xml

   1 <chapter id="installation"><title>Compilation and Installation</title>
   2
   3   <sect1 id="installation-introduction"><title>Introduction</title>
   4    <para>
   5     The latest version of the software will generally be found at:
   6    </para>
   7    <para>
   8     <ulink url="&url.yaz.download;"/>
   9    </para>
  10    <para>
  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
  13     no changes.
  14    </para>
  15
  16    <para>
  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.
  25    </para>
  26
  27    <para>
  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>,
  31     IBM AIX,
  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),
  35     IBM AS/400 .
  36    </para>
  37
  38    <para>
  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.
  45    </para>
  46
  47    <para>
  48     We maintain a mailing-list for the purpose of announcing new releases and
  49     bug-fixes, as well as general discussion. Subscribe by
  50     filling-in the form
  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
  54      this document.
  55    </para>
  56
  57   </sect1>
  58   <sect1 id="installation.unix"><title>UNIX</title>
  59
  60    <para>
  61     We provide
  62     <ulink url="&url.debian;">Debian GNU/Linux</ulink> (i386 and amd64),
  63     <ulink url="&url.ubuntu;">Ubuntu</ulink> (i386 and amd64)
  64     and
  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.
  68    </para>
  69
  70    <para>
  71     YAZ is also part of several packages repositories. Some of them are
  72    </para>
  73
  74    <itemizedlist>
  75     <listitem>
  76      <para>
  77       Solaris CSW: <ulink url="http://www.opencsw.org/packages/yaz/"/>
  78      </para>
  79     </listitem>
  80     <listitem>
  81      <para>
  82       Solaris: <ulink url="http://unixpackages.com"/>
  83      </para>
  84     </listitem>
  85     <listitem>
  86      <para>
  87       FreeBSD: <ulink url="http://www.freshports.org/net/yaz"/>
  88      </para>
  89     </listitem>
  90     <listitem>
  91      <para>
  92       Debian: <ulink url="http://packages.debian.org/search?keywords=yaz"/>
  93      </para>
  94     </listitem>
  95     <listitem>
  96      <para>
  97       Ubuntu: <ulink url="https://launchpad.net/ubuntu/+source/yaz"/>
  98      </para>
  99     </listitem>
 100     <listitem>
 101      <para>
 102       NetBSD:
 103       <ulink url="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html"/>
 104      </para>
 105     </listitem>
 106    </itemizedlist>
 107
 108    <sect2 id="installation.source.unix">
 109     <title>Compiling from source on Unix</title>
 110
 111     <para>
 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>.
 115     </para>
 116
 117     <para>
 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
 121      - if not, we suggest
 122      <ulink url="&url.libiconv;">GNU libiconv</ulink>.
 123     </para>
 124
 125     <para>
 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
 130      must be available.
 131     </para>
 132
 133     <para>
 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.
 140     </para>
 141
 142     <para>
 143      The GNU tools
 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;.
 150     </para>
 151
 152     <para>
 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;.
 156     </para>
 157
 158     <para>
 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
 163      for private ASN.1.
 164     </para>
 165
 166     <para>
 167      Generally it should be sufficient to run configure without options,
 168      like this:
 169     </para>
 170
 171     <screen>
 172      ./configure
 173     </screen>
 174
 175     <para>
 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:
 182     </para>
 183
 184     <screen>
 185      CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
 186     </screen>
 187
 188     <para>
 189      To customize &yaz;, the configure script also accepts a set of options.
 190      The most important are:
 191
 192      <variablelist>
 193       <varlistentry><term>
 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.
 199         </para></listitem>
 200       </varlistentry>
 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
 206          BSD distributions.
 207          See
 208          <citerefentry>
 209           <refentrytitle>hosts_access</refentrytitle>
 210           <manvolnum>5</manvolnum>
 211          </citerefentry>
 212          and
 213          <citerefentry>
 214           <refentrytitle>tcpd</refentrytitle>
 215           <manvolnum>8</manvolnum>
 216          </citerefentry>.
 217         </para></listitem>
 218       </varlistentry>
 219
 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
 223          compilation.
 224         </para></listitem>
 225       </varlistentry>
 226
 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>.
 232         </para></listitem>
 233       </varlistentry>
 234
 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>.
 240         </para></listitem>
 241       </varlistentry>
 242
 243       <varlistentry><term>
 244         <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
 245        </term>
 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;
 251          not to use iconv.
 252         </para></listitem>
 253       </varlistentry>
 254
 255       <varlistentry><term>
 256         <literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
 257        </term>
 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;
 266          not to use libxslt.
 267         </para>
 268        </listitem>
 269       </varlistentry>
 270
 271       <varlistentry><term>
 272         <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
 273        </term>
 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;
 282          not to use libxml2.
 283          </para>
 284          <para>
 285            Note that option <literal>--with-xslt</literal>
 286            also enables libxml2.
 287          </para>
 288        </listitem>
 289       </varlistentry>
 290
 291       <varlistentry><term>
 292         <literal>--with-gnutls</literal>[=<replaceable>prefix</replaceable>]
 293        </term>
 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
 297          on the system.
 298         </para></listitem>
 299       </varlistentry>
 300
 301       <varlistentry><term>
 302         <literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]
 303        </term>
 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.
 308         </para></listitem>
 309       </varlistentry>
 310
 311      </variablelist>
 312
 313     </para>
 314     <para>
 315      When configured, build the software by typing:
 316      <screen>
 317       make
 318      </screen>
 319     </para>
 320
 321     <para>
 322      The following files are generated by the make process:
 323      <variablelist>
 324       <varlistentry><term><filename>src/libyaz.la</filename></term>
 325        <listitem><para>
 326          Main &yaz; library. This is no ordinary library. It's
 327          a Libtool archive.
 328          By default, &yaz; creates a static library in
 329          <filename>lib/.libs/libyaz.a</filename>.
 330         </para></listitem>
 331       </varlistentry>
 332
 333       <varlistentry><term><filename>src/libyaz_server.la</filename></term>
 334        <listitem><para>
 335          Generic Frontend server. This is an add-on for libyaz.la.
 336          Code in this library uses POSIX threads functions - if POSIX
 337          threads are available on the platform.
 338         </para></listitem>
 339       </varlistentry>
 340
 341       <varlistentry><term><filename>src/libyaz_icu.la</filename></term>
 342        <listitem><para>
 343          Functions that wrap the ICU library.
 344         </para></listitem>
 345       </varlistentry>
 346
 347       <varlistentry><term><filename>ztest/yaz-ztest</filename></term>
 348        <listitem><para>Test Z39.50 server.
 349         </para></listitem>
 350       </varlistentry>
 351
 352       <varlistentry><term><filename>client/yaz-client</filename></term>
 353        <listitem><para>Z39.50 client for testing the protocol.
 354          See chapter <link linkend="yaz-client">
 355           YAZ client</link> for more information.
 356         </para></listitem>
 357       </varlistentry>
 358
 359       <varlistentry><term><filename>util/yaz-config</filename></term>
 360        <listitem><para>A Bourne-shell script, generated by configure, that
 361          specifies how external applications should compile - and link with
 362          &yaz;.
 363         </para></listitem>
 364       </varlistentry>
 365
 366       <varlistentry><term><filename>util/yaz-asncomp</filename></term>
 367        <listitem><para>The ASN.1 compiler for &yaz;. Requires the
 368          Tcl Shell, <application>tclsh</application>, in
 369          <literal>PATH</literal> to operate.
 370         </para></listitem>
 371       </varlistentry>
 372
 373       <varlistentry><term><filename>util/yaz-iconv</filename></term>
 374        <listitem><para>This program converts data in one character set to
 375          another. This command exercises the YAZ character set
 376          conversion API.
 377         </para></listitem>
 378       </varlistentry>
 379
 380       <varlistentry><term><filename>util/yaz-marcdump</filename></term>
 381        <listitem><para>This program parses ISO2709 encoded MARC records
 382          and prints them in line-format or XML.
 383         </para></listitem>
 384       </varlistentry>
 385
 386       <varlistentry><term><filename>util/yaz-icu</filename></term>
 387        <listitem><para>This program exposes the ICU wrapper library if that
 388          is enabled for YAZ. Only if ICU is available this program is
 389          useful.
 390         </para></listitem>
 391       </varlistentry>
 392
 393      <varlistentry><term><filename>zoom/zoomsh</filename></term>
 394        <listitem><para>
 395          A simple shell implemented on top of the
 396          <link linkend="zoom">ZOOM</link> functions.
 397          The shell is a command line application that allows you to enter
 398          simple commands to perform ZOOM operations.
 399         </para></listitem>
 400       </varlistentry>
 401
 402       <varlistentry><term><filename>zoom/zoomtst1</filename>,
 403         <filename>zoom/zoomtst2</filename>, ..</term>
 404        <listitem><para>
 405          Several small applications that demonstrates the ZOOM API.
 406         </para></listitem>
 407       </varlistentry>
 408      </variablelist>
 409
 410     </para>
 411
 412     <para>
 413      If you wish to install &yaz; in system directories
 414      <filename>/usr/local/bin</filename>,
 415      <filename>/usr/local/lib</filename> .. etc, you can type:
 416     </para>
 417
 418     <screen>
 419      make install
 420     </screen>
 421
 422     <para>
 423      You probably need to have root access in order to perform this.
 424      You must specify the <literal>--prefix</literal> option for configure if
 425      you wish to install &yaz; in other directories than the default
 426      <filename>/usr/local/</filename>.
 427     </para>
 428
 429     <para>
 430      If you wish to perform an un-installation of &yaz;, use:
 431     </para>
 432
 433     <screen>
 434      make uninstall
 435     </screen>
 436
 437     <para>
 438      This will only work if you haven't reconfigured &yaz; (and therefore
 439      changed installation prefix). Note that uninstall will not
 440      remove directories created by make install, e.g.
 441      <filename>/usr/local/include/yaz</filename>.
 442     </para>
 443    </sect2>
 444
 445    <sect2 id="installation-linking-yaz-unix">
 446     <title>How to make apps using YAZ on UNIX</title>
 447     <para>
 448      This section describes how to compile - and link your own
 449      applications using the &yaz; toolkit.
 450      If you're used to Makefiles this shouldn't be hard. As for
 451      other libraries you have used before, you have to set a proper include
 452      path for your C/C++ compiler and specify the location of
 453      &yaz; libraries. You can do it by hand, but generally we suggest
 454      you use the <filename>yaz-config</filename> that is generated
 455      by <filename>configure</filename>. This is especially
 456      important if you're using the threaded version of &yaz; which
 457      require you to pass more options to your linker/compiler.
 458     </para>
 459     <para>
 460      The <filename>yaz-config</filename> script accepts command line
 461      options that makes the <filename>yaz-config</filename> script print
 462      options that you should use in your make process.
 463      The most important ones are:
 464      <literal>--cflags</literal>, <literal>--libs</literal>
 465      which prints C compiler flags, and linker flags respectively.
 466      </para>
 467     <para>
 468      A small and complete <literal>Makefile</literal> for a C
 469      application consisting of one source file,
 470      <filename>myprog.c</filename>, may look like this:
 471      <screen>
 472       YAZCONFIG=/usr/local/bin/yaz-config
 473       CFLAGS=`$(YAZCONFIG) --cflags`
 474       LIBS=`$(YAZCONFIG) --libs`
 475       myprog: myprog.o
 476          $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
 477       </screen>
 478      </para>
 479     <para>
 480      The CFLAGS variable consists of a C compiler directive that will set
 481      the include path to the <emphasis>parent</emphasis> directory
 482      of <filename>yaz</filename>. That is, if &yaz; header files were
 483      installed in <filename>/usr/local/include/yaz</filename>,
 484      then include path is set to <filename>/usr/local/include</filename>.
 485      Therefore, in your applications you should use
 486      <screen>
 487       #include &lt;yaz/proto.h>
 488      </screen>
 489      and <emphasis>not</emphasis>
 490      <screen>
 491       #include &lt;proto.h>
 492      </screen>
 493     </para>
 494     <para>
 495      For Libtool users, the <filename>yaz-config</filename> script provides
 496      a different variant of option <literal>--libs</literal>, called
 497      <literal>--lalibs</literal> that returns the name of the
 498      Libtool archive(s) for &yaz; rather than the ordinary ones.
 499     </para>
 500     <para>
 501      For applications using the threaded version of &yaz;,
 502      specify <literal>threads</literal> after the
 503      other options. When <literal>threads</literal> is given,
 504      more flags and linker flags will be printed by
 505      <filename>yaz-config</filename>. If our previous example was
 506       using threads, you'd have to modify the lines that set
 507      <literal>CFLAGS</literal> and <literal>LIBS</literal> as
 508      follows:
 509      <screen>
 510       CFLAGS=`$(YAZCONFIG) --cflags threads`
 511       LIBS=`$(YAZCONFIG) --libs threads`
 512      </screen>
 513      There is no need specify POSIX thread libraries in your Makefile.
 514      The <literal>LIBS</literal> variable includes that as well.
 515     </para>
 516    </sect2>
 517   </sect1>
 518   <sect1 id="installation.win32"><title>WIN32</title>
 519
 520    <para>The easiest way to install YAZ on Windows is by downloading
 521     an installer from
 522     <ulink url="&url.yaz.download.win32;">here</ulink>.
 523     The installer comes with source too - in case you wish to
 524     compile YAZ with different compiler options, etc.
 525    </para>
 526
 527    <sect2 id="installation.win32.source">
 528     <title>Compiling from Source on WIN32</title>
 529     <para>
 530      &yaz; is shipped with "makefiles" for the NMAKE tool that comes
 531      with <ulink url="&url.vstudio;">
 532      Microsoft Visual Studio</ulink>. It has been tested with
 533      Microsoft Visual Studio 2003/2005/2008.
 534     </para>
 535     <para>
 536      Start a command prompt and switch the sub directory
 537      <filename>WIN</filename> where the file <filename>makefile</filename>
 538      is located. Customize the installation by editing the
 539      <filename>makefile</filename> file (for example by using notepad).
 540
 541      The following summarizes the most important settings in that file:
 542
 543      <variablelist>
 544       <varlistentry><term><literal>DEBUG</literal></term>
 545        <listitem><para>
 546          If set to 1, the software is
 547          compiled with debugging libraries (code generation is
 548          multi-threaded debug DLL).
 549          If set to 0, the software is compiled with release libraries
 550          (code generation is multi-threaded DLL).
 551         </para></listitem>
 552       </varlistentry>
 553       <varlistentry>
 554        <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
 555        <listitem><para>
 556          If <literal>HAVE_TCL</literal> is set to 1, nmake will
 557          use the ASN.1 compiler (<ulink url="&url.tcl;">Tcl</ulink> based).
 558          You must set <literal>TCL</literal> to the full path of the Tcl
 559          interpreter. A Windows version of Tcl is part of
 560          <ulink url="&url.gitwindows;">Git for Windows</ulink>.
 561         </para>
 562         <para>
 563          If you do not have Tcl installed, set
 564          <literal>HAVE_TCL</literal> to 0.
 565         </para></listitem>
 566       </varlistentry>
 567
 568       <varlistentry>
 569        <term><literal>HAVE_BISON</literal>,
 570         <literal>BISON</literal></term>
 571        <listitem><para>
 572          If GNU Bison is present, you might set <literal>HAVE_BISON</literal>
 573          to 1 and specify the Bison executable in <literal>BISON</literal>.
 574          Bison is only required if you use the git version of
 575          YAZ or if you modify the grammar for CQL
 576          (<filename>cql.y</filename>).
 577         </para>
 578         <para>
 579          A Windows version of GNU Bison is part of
 580          <ulink url="&url.gitwindows;">Git for Windows</ulink>.
 581         </para></listitem>
 582       </varlistentry>
 583
 584       <varlistentry>
 585        <term><literal>HAVE_ICONV</literal>,
 586         <literal>ICONV_DIR</literal></term>
 587        <listitem><para>
 588          If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
 589          with iconv support. In this configuration, set
 590          <literal>ICONV_DIR</literal> to the iconv source directory.
 591         </para></listitem>
 592       </varlistentry>
 593
 594       <varlistentry>
 595        <term><literal>HAVE_LIBXML2</literal>,
 596         <literal>LIBXML2_DIR</literal></term>
 597        <listitem>
 598         <para>
 599          If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
 600          with SRU support. In this configuration, set
 601          <literal>LIBXML2_DIR</literal> to the
 602          <ulink url="&url.libxml2;">libxml2</ulink> source directory
 603          and
 604          <literal>ZLIB_DIR</literal> to the zlib directory.
 605         </para>
 606
 607         <para>
 608          Windows versions of libxslt, libxml2, zlib and iconv can be found
 609          <ulink url="&url.libxml2.download.win32;">
 610           Igor Zlatkovi&#x0107;' site</ulink>.
 611         </para>
 612
 613         <note>
 614          <para>
 615           YAZ is not using zlib but libxml2 is depending on it.
 616          </para>
 617         </note>
 618        </listitem>
 619       </varlistentry>
 620
 621       <varlistentry>
 622        <term><literal>HAVE_LIBXSLT</literal>,
 623         <literal>LIBXSLT_DIR</literal></term>
 624        <listitem>
 625         <para>
 626          If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
 627          with XSLT support. In this configuration, set
 628          <literal>LIBXSLT_DIR</literal> to the
 629          <ulink url="&url.libxslt;">libxslt</ulink> source directory.
 630         </para>
 631
 632         <note>
 633          <para>
 634           libxslt depends libxml2.
 635          </para>
 636         </note>
 637        </listitem>
 638       </varlistentry>
 639
 640       <varlistentry>
 641        <term><literal>HAVE_ICU</literal>,
 642         <literal>ICU_DIR</literal></term>
 643        <listitem>
 644         <para>
 645          If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
 646          with <ulink url="&url.icu;">ICU</ulink> support.
 647          In this configuration, set
 648          <literal>ICU_DIR</literal> to the
 649          <ulink url="&url.icu;">ICU</ulink> source directory.
 650         </para>
 651        </listitem>
 652
 653       </varlistentry>
 654
 655      </variablelist>
 656     </para>
 657     <para>
 658      When satisfied with the settings in the makefile, type
 659      <screen>
 660       nmake
 661      </screen>
 662     </para>
 663     <note>
 664      <para>
 665       If the <filename>nmake</filename> command is not found on your system
 666       you probably haven't defined the environment variables required to
 667       use that tool. To fix that, find and run the batch file
 668       <filename>vcvars32.bat</filename>. You need to run it from within
 669       the command prompt or set the environment variables "globally";
 670       otherwise it doesn't work.
 671      </para>
 672     </note>
 673     <para>
 674      If you wish to recompile &yaz; - for example if you modify
 675      settings in the <filename>makefile</filename> you can delete
 676      object files, etc by running.
 677      <screen>
 678       nmake clean
 679      </screen>
 680     </para>
 681     <para>
 682      The following files are generated upon successful compilation:
 683
 684      <variablelist>
 685       <varlistentry><term><filename>bin/yaz5.dll</filename> /
 686           <filename>bin/yaz5d.dll</filename></term>
 687        <listitem><para>
 688          &yaz; Release/Debug DLL.
 689         </para></listitem></varlistentry>
 690
 691       <varlistentry><term><filename>lib/yaz5.lib</filename> /
 692           <filename>lib/yaz5d.lib</filename></term>
 693        <listitem><para>
 694          Import library for <filename>yaz5.dll</filename> /
 695          <filename>yaz5d.dll</filename>.
 696         </para></listitem></varlistentry>
 697
 698       <varlistentry><term><filename>bin/yaz_cond5.dll</filename> /
 699           <filename>bin/yaz_cond5d.dll</filename></term>
 700        <listitem><para>
 701          Release/Debug DLL for condition variable utilities (condvar.c).
 702         </para></listitem></varlistentry>
 703
 704       <varlistentry><term><filename>lib/yaz_cond5.lib</filename> /
 705           <filename>lib/yaz_cond5d.lib</filename></term>
 706        <listitem><para>
 707          Import library for <filename>yaz_cond5.dll</filename> /
 708          <filename>yaz_cond5d.dll</filename>.
 709         </para></listitem></varlistentry>
 710
 711       <varlistentry><term><filename>bin/yaz_icu5.dll</filename> /
 712           <filename>bin/yaz_icu5d.dll</filename></term>
 713        <listitem><para>
 714          Release/Debug DLL for the ICU wrapper utility.
 715          Only build if HAVE_ICU is 1.
 716         </para></listitem></varlistentry>
 717
 718       <varlistentry><term><filename>lib/yaz_icu5.lib</filename> /
 719           <filename>lib/yaz_icu5d.lib</filename></term>
 720        <listitem><para>
 721          Import library for <filename>yaz_icu5.dll</filename> /
 722          <filename>yaz_icu5d.dll</filename>.
 723         </para></listitem></varlistentry>
 724
 725       <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
 726        <listitem><para>
 727          Z39.50 multi-threaded test/example server. It's a WIN32
 728          console application.
 729         </para></listitem></varlistentry>
 730
 731       <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
 732        <listitem><para>
 733          &yaz; Z39.50 client application. It's a WIN32 console application.
 734          See chapter <link linkend="yaz-client">YAZ client</link> for more
 735          information.
 736         </para></listitem></varlistentry>
 737
 738       <varlistentry><term><filename>bin/yaz-icu.exe</filename></term>
 739        <listitem><para>This program exposes the ICU wrapper library if that
 740          is enabled for YAZ. Only if ICU is available this program is
 741          build.
 742         </para></listitem></varlistentry>
 743
 744       <varlistentry><term><filename>bin/zoomsh.exe</filename></term>
 745        <listitem><para>
 746          Simple console application implemented on top of the
 747          <link linkend="zoom">ZOOM</link> functions.
 748          The application is a command line shell that allows you to enter
 749          simple commands to perform ZOOM operations.
 750         </para></listitem></varlistentry>
 751
 752       <varlistentry><term><filename>bin/zoomtst1.exe</filename>,
 753         <filename>bin/zoomtst2.exe</filename>, ..</term>
 754        <listitem><para>
 755          Several small applications that demonstrates the ZOOM API.
 756         </para></listitem></varlistentry>
 757
 758      </variablelist>
 759
 760     </para>
 761    </sect2>
 762
 763    <sect2 id="installation-linking-yaz-win32">
 764     <title>How to make apps using YAZ on WIN32</title>
 765     <para>
 766      This section will go though the process of linking your WIN32
 767      applications with &yaz;.
 768     </para>
 769     <para>
 770      Some people are confused by the fact that we use the nmake
 771      tool to build &yaz;. They think they have to do that too - in order
 772      to make their WIN32 applications work with &yaz;. The good news is that
 773      you don't have to. You can use the integrated environment of
 774      Visual Studio if desired for your own application.
 775     </para>
 776     <para>
 777      When setting up a project or Makefile you have to set the following:
 778      <variablelist>
 779       <varlistentry><term>include path</term><listitem><para>
 780          Set it to the <filename>include</filename> directory of &yaz;.
 781         </para></listitem></varlistentry>
 782       <varlistentry><term>import library <filename>yaz5.lib</filename>
 783        </term><listitem><para>
 784          You must link with this library. It's located in the
 785          sub directory <filename>lib</filename> of &yaz;.
 786          If you want to link with the debug version of &yaz;, you must
 787          link against <filename>yaz5d.lib</filename> instead.
 788         </para></listitem></varlistentry>
 789       <varlistentry><term>dynamic link library <filename>yaz5.dll</filename>
 790        </term><listitem><para>
 791          This DLL must be in your execution path when you invoke
 792          your application. Specifically, you should distribute this
 793          DLL with your application.
 794         </para></listitem></varlistentry>
 795      </variablelist>
 796     </para>
 797    </sect2>
 798   </sect1>
 799  </chapter>
 800
 801  <!-- Keep this comment at the end of the file
 802  Local variables:
 803  mode: sgml
 804  sgml-omittag:t
 805  sgml-shorttag:t
 806  sgml-minimize-attributes:nil
 807  sgml-always-quote-attributes:t
 808  sgml-indent-step:1
 809  sgml-indent-data:t
 810  sgml-parent-document: "yaz.xml"
 811  sgml-local-catalogs: nil
 812  sgml-namecase-general:t
 813  End:
 814  -->
 815