doc/installation.xml

   1 <!-- $Id: installation.xml,v 1.41 2008-01-25 16:28:42 adam Exp $ -->
   2 <chapter id="installation"><title>Compilation and Installation</title>
   3
   4   <sect1 id="installation-introduction"><title>Introduction</title>
   5    <para>
   6     The latest version of the software will generally be found at:
   7    </para>
   8    <para>
   9     <ulink url="&url.yaz.download;"/>
  10    </para>
  11    <para>
  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
  14     no changes.
  15    </para>
  16
  17    <para>
  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.ubuntu;">Ubuntu 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>.
  27    </para>
  28
  29    <para>
  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>,
  33     IBM AIX,
  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),
  37     IBM AS/400 .
  38    </para>
  39
  40    <para>
  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.
  47    </para>
  48
  49    <para>
  50     We maintain a mailing-list for the purpose of announcing new releases and
  51     bug-fixes, as well as general discussion. Subscribe by
  52     filling-in the form
  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
  56      this document.
  57    </para>
  58
  59   </sect1>
  60   <sect1 id="installation.unix"><title>UNIX</title>
  61
  62    <para>
  63     We provide
  64     <ulink url="&url.debian;">Debian GNU/Linux</ulink>
  65     and
  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
  69     package.
  70    </para>
  71
  72    <sect2 id="installation.source.unix">
  73     <title>Compiling from source on Unix</title>
  74
  75     <para>
  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>.
  79     </para>
  80
  81     <para>
  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
  85      - if not, we suggest
  86      <ulink url="&url.libiconv;">GNU libiconv</ulink>.
  87     </para>
  88
  89     <para>
  90      YAZ 3.0.16 and later includes a wrapper for the
  91      <ulink url="%url.icu;">ICU</ulink>
  92      (International Components for Unicode).
  93      In order to use this, the developer version of the ICU library
  94      must be available.
  95     </para>
  96
  97     <para>
  98      The <ulink url="&url.libxslt;">libxslt</ulink>,
  99      <ulink url="&url.libxml2;">libxml2</ulink> librararies are required
 100      if &yaz; is to support SRU.
 101      These libraries are very portable and should compile out-of-the
 102      box on virtually all Unix platforms. It is available in binary
 103      forms for Linux and others.
 104     </para>
 105
 106     <para>
 107      The GNU tools
 108      <ulink url="&url.autoconf;">Autoconf</ulink>,
 109      <ulink url="&url.automake;">Automake</ulink> and
 110      <ulink url="&url.libtool;">Libtool</ulink>
 111      are used to generate Makefiles and configure &yaz; for the system.
 112      You do <emphasis>not</emphasis> these tools unless you're using the
 113      CVS version of &yaz;.
 114     </para>
 115
 116     <para>
 117      The CQL parser for &yaz; is built using
 118      GNU <ulink url="&url.bison;">Bison</ulink>.
 119      This tool is only needed if you're using the CVS version of &yaz;.
 120     </para>
 121
 122     <para>
 123      &yaz; includes a tiny ASN.1 compiler. This compiler is
 124      written in <ulink url="&url.tcl;">Tcl</ulink>.
 125      But as for Bison you do not need it unless you're using CVS
 126      version of &yaz; or you're using the compiler to built own codecs
 127      for private ASN.1.
 128     </para>
 129
 130     <para>
 131      Generally it should be sufficient to run configure without options,
 132      like this:
 133     </para>
 134
 135     <screen>
 136      ./configure
 137     </screen>
 138
 139     <para>
 140      The configure script attempts to use use the C compiler specified by
 141      the <literal>CC</literal> environment variable. If not set, GNU C will be
 142      used if it is available. The <literal>CFLAGS</literal> environment
 143      variable holds options to be passed to the C compiler. If you're using
 144      Bourne-compatible shell you may pass something like this to use a
 145      particular C compiler with optimization enabled:
 146     </para>
 147
 148     <screen>
 149      CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
 150     </screen>
 151
 152     <para>
 153      To customize &yaz;, the configure script also accepts a set of options.
 154      The most important are:
 155
 156      <variablelist>
 157       <varlistentry><term>
 158         <literal>--prefix</literal>=<replaceable>prefix</replaceable></term>
 159        <listitem><para>Specifies installation prefix for &yaz;. This is
 160          only needed if you run <literal>make install</literal> later to
 161          perform a "system" installation. The prefix is
 162          <literal>/usr/local</literal> if not specified.
 163         </para></listitem>
 164       </varlistentry>
 165       <varlistentry><term><literal>--enable-tcpd</literal></term>
 166        <listitem><para>The front end server will be built using Wietse's
 167          <ulink url="&url.tcpwrapper;">TCP wrapper library</ulink>.
 168          It allows you to allow/deny clients depending on IP number.
 169          The TCP wrapper library is often used in GNU/Linux and
 170          BSD distributions.
 171          See
 172          <citerefentry>
 173           <refentrytitle>hosts_access</refentrytitle>
 174           <manvolnum>5</manvolnum>
 175          </citerefentry>
 176          and
 177          <citerefentry>
 178           <refentrytitle>tcpd</refentrytitle>
 179           <manvolnum>8</manvolnum>
 180          </citerefentry>.
 181         </para></listitem>
 182       </varlistentry>
 183
 184       <varlistentry><term><literal>--enable-threads</literal></term>
 185        <listitem><para>&yaz; will be built using POSIX threads.
 186         Specifically, <constant>_REENTRANT</constant> will be defined during
 187          compilation.
 188         </para></listitem>
 189       </varlistentry>
 190
 191       <varlistentry><term><literal>--disable-shared</literal></term>
 192        <listitem><para>The make process will not create shared
 193          libraries (also known as shared objects <filename>.so</filename>).
 194          By default, shared libraries are created -
 195          equivalent to <literal>--enable-shared</literal>.
 196         </para></listitem>
 197       </varlistentry>
 198
 199       <varlistentry><term><literal>--disable-shared</literal></term>
 200        <listitem><para>The make process will not create
 201          static libraries (<filename>.a</filename>).
 202          By default, static libraries are created -
 203          equivalent to <literal>--enable-static</literal>.
 204         </para></listitem>
 205       </varlistentry>
 206
 207       <varlistentry><term>
 208         <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
 209        </term>
 210        <listitem><para>Compile &yaz; with iconv library in directory
 211          <replaceable>prefix</replaceable>. By default configure will
 212          search for iconv on the system. Use this option if it
 213          doesn't find iconv. Alternatively,
 214          <literal>--without-iconv</literal>, can be uset to force &yaz;
 215          not to use iconv.
 216         </para></listitem>
 217       </varlistentry>
 218
 219       <varlistentry><term>
 220         <literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
 221        </term>
 222        <listitem><para>Compile &yaz; with
 223          <ulink url="&url.libxslt;">libxslt</ulink> in directory
 224          <replaceable>prefix</replaceable>.
 225          Use this option if you want XSLT and XML support.
 226          By default, configure will
 227          search for libxslt on the system. Use this option if it
 228          libxslt is not found automatically. Alternatively,
 229          <literal>--without-xslt</literal>, can be used to force &yaz;
 230          not to use libxslt.
 231         </para>
 232        </listitem>
 233       </varlistentry>
 234
 235       <varlistentry><term>
 236         <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
 237        </term>
 238        <listitem><para>Compile &yaz; with
 239          <ulink url="&url.libxml2;">libxml2</ulink> in directory
 240          <replaceable>prefix</replaceable>.
 241          Use this option if you want &yaz; to use XML and support SRU.
 242          By default, configure will
 243          search for libxml2 on the system. Use this option if it
 244          libxml2 is not found automatically. Alternatively,
 245          <literal>--without-xml2</literal>, can be used to force &yaz;
 246          not to use libxml2.
 247          </para>
 248          <para>
 249            Note that option <literal>--with-xslt</literal>
 250            also enables libxml2.
 251          </para>
 252        </listitem>
 253       </varlistentry>
 254
 255       <varlistentry><term>
 256         <literal>--with-openssl</literal>[=<replaceable>prefix</replaceable>]
 257        </term>
 258        <listitem><para>&yaz; will be linked with the OpenSSL libraries and
 259          an SSL COMSTACK will be provided. Note that SSL support is still
 260          experimental.
 261         </para></listitem>
 262       </varlistentry>
 263
 264       <varlistentry><term>
 265         <literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]
 266        </term>
 267        <listitem><para>&yaz; will be linked the
 268         <ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
 269         If prefix is not given, the libraries exposed by the script
 270         <application>icu-config</application> will be used if found.
 271         </para></listitem>
 272       </varlistentry>
 273
 274      </variablelist>
 275
 276     </para>
 277     <para>
 278      When configured, build the software by typing:
 279      <screen>
 280       make
 281      </screen>
 282     </para>
 283
 284     <para>
 285      The following files are generated by the make process:
 286      <variablelist>
 287       <varlistentry><term><filename>src/libyaz.la</filename></term>
 288        <listitem><para>
 289          Main &yaz; library. This is no ordinary library. It's
 290          a Libtool archive.
 291          By default, &yaz; creates a static library in
 292          <filename>lib/.libs/libyaz.a</filename>.
 293         </para></listitem>
 294       </varlistentry>
 295
 296       <varlistentry><term><filename>src/libyaz_server.la</filename></term>
 297        <listitem><para>
 298          Generic Frontend server. This is an add-on for libyaz.la.
 299          Code in this library uses POSIX threads functions - if they
 300          available on the platform.
 301         </para></listitem>
 302       </varlistentry>
 303
 304       <varlistentry><term><filename>ztest/yaz-ztest</filename></term>
 305        <listitem><para>Test Z39.50 server.
 306         </para></listitem>
 307       </varlistentry>
 308
 309       <varlistentry><term><filename>client/yaz-client</filename></term>
 310        <listitem><para>Z39.50 client for testing the protocol.
 311          See chapter <link linkend="yaz-client">
 312           YAZ client</link> for more information.
 313         </para></listitem>
 314       </varlistentry>
 315
 316       <varlistentry><term><filename>util/yaz-config</filename></term>
 317        <listitem><para>A Bourne-shell script, generated by configure, that
 318          specifies how external applications should compile - and link with
 319          &yaz;.
 320         </para></listitem>
 321       </varlistentry>
 322
 323       <varlistentry><term><filename>util/yaz-asncomp</filename></term>
 324        <listitem><para>The ASN.1 compiler for &yaz;. Requires the
 325          Tcl Shell, <application>tclsh</application>, in
 326          <literal>PATH</literal> to operate.
 327         </para></listitem>
 328       </varlistentry>
 329
 330       <varlistentry><term><filename>util/yaz-iconv</filename></term>
 331        <listitem><para>This program converts data in one character set to
 332          another. This command exercises the YAZ character set
 333          conversion API.
 334         </para></listitem>
 335       </varlistentry>
 336
 337       <varlistentry><term><filename>util/yaz-marcdump</filename></term>
 338        <listitem><para>This program parses ISO2709 encoded MARC records
 339          and prints them in line-format or XML.
 340         </para></listitem>
 341       </varlistentry>
 342
 343       <varlistentry><term><filename>util/yaz-icu</filename></term>
 344        <listitem><para>This program exposes the ICU wrapper library if that
 345          is enabled for YAZ. Only if ICU is available this program is
 346          useful.
 347         </para></listitem>
 348       </varlistentry>
 349
 350      <varlistentry><term><filename>zoom/zoomsh</filename></term>
 351        <listitem><para>
 352          A simple shell implemented on top of the
 353          <link linkend="zoom">ZOOM</link> functions.
 354          The shell is a command line application that allows you to enter
 355          simple commands to perform ZOOM operations.
 356         </para></listitem>
 357       </varlistentry>
 358
 359       <varlistentry><term><filename>zoom/zoomtst1</filename>,
 360         <filename>zoom/zoomtst2</filename>, ..</term>
 361        <listitem><para>
 362          Several small applications that demonstrates the ZOOM API.
 363         </para></listitem>
 364       </varlistentry>
 365      </variablelist>
 366
 367     </para>
 368
 369     <para>
 370      If you wish to install &yaz; in system directories
 371      <filename>/usr/local/bin</filename>,
 372      <filename>/usr/local/lib</filename> .. etc, you can type:
 373     </para>
 374
 375     <screen>
 376      make install
 377     </screen>
 378
 379     <para>
 380      You probably need to have root access in order to perform this.
 381      You must specify the <literal>--prefix</literal> option for configure if
 382      you wish to install &yaz; in other directories than the default
 383      <filename>/usr/local/</filename>.
 384     </para>
 385
 386     <para>
 387      If you wish to perform an un-installation of &yaz;, use:
 388     </para>
 389
 390     <screen>
 391      make uninstall
 392     </screen>
 393
 394     <para>
 395      This will only work if you haven't reconfigured &yaz; (and therefore
 396      changed installation prefix). Note that uninstall will not
 397      remove directories created by make install, e.g.
 398      <filename>/usr/local/include/yaz</filename>.
 399     </para>
 400    </sect2>
 401
 402    <sect2 id="installation-linking-yaz-unix">
 403     <title>How to make apps using YAZ on UNIX</title>
 404     <para>
 405      This section describes how to compile - and link your own
 406      applications using the &yaz; toolkit.
 407      If you're used to Makefiles this shouldn't be hard. As for
 408      other libraries you have used before, you have to set a proper include
 409      path for your C/C++ compiler and specify the location of
 410      &yaz; libraries. You can do it by hand, but generally we suggest
 411      you use the <filename>yaz-config</filename> that is generated
 412      by <filename>configure</filename>. This is especially
 413      important if you're using the threaded version of &yaz; which
 414      require you to pass more options to your linker/compiler.
 415     </para>
 416     <para>
 417      The <filename>yaz-config</filename> script accepts command line
 418      options that makes the <filename>yaz-config</filename> script print
 419      options that you should use in your make process.
 420      The most important ones are:
 421      <literal>--cflags</literal>, <literal>--libs</literal>
 422      which prints C compiler flags, and linker flags respectively.
 423      </para>
 424     <para>
 425      A small and complete <literal>Makefile</literal> for a C
 426      application consisting of one source file,
 427      <filename>myprog.c</filename>, may look like this:
 428      <screen>
 429       YAZCONFIG=/usr/local/bin/yaz-config
 430       CFLAGS=`$(YAZCONFIG) --cflags`
 431       LIBS=`$(YAZCONFIG) --libs`
 432       myprog: myprog.o
 433          $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
 434       </screen>
 435      </para>
 436     <para>
 437      The CFLAGS variable consists of a C compiler directive that will set
 438      the include path to the <emphasis>parent</emphasis> directory
 439      of <filename>yaz</filename>. That is, if &yaz; header files were
 440      installed in <filename>/usr/local/include/yaz</filename>,
 441      then include path is set to <filename>/usr/local/include</filename>.
 442      Therefore, in your applications you should use
 443      <screen>
 444       #include &lt;yaz/proto.h>
 445      </screen>
 446      and <emphasis>not</emphasis>
 447      <screen>
 448       #include &lt;proto.h>
 449      </screen>
 450     </para>
 451     <para>
 452      For Libtool users, the <filename>yaz-config</filename> script provides
 453      a different variant of option <literal>--libs</literal>, called
 454      <literal>--lalibs</literal> that returns the name of the
 455      Libtool archive(s) for &yaz; rather than the ordinary ones.
 456     </para>
 457     <para>
 458      For applications using the threaded version of &yaz;,
 459      specify <literal>threads</literal> after the
 460      other options. When <literal>threads</literal> is given,
 461      more flags and linker flags will be printed by
 462      <filename>yaz-config</filename>. If our previous example was
 463       using threads, you'd have to modify the lines that set
 464      <literal>CFLAGS</literal> and <literal>LIBS</literal> as
 465      follows:
 466      <screen>
 467       CFLAGS=`$(YAZCONFIG) --cflags threads`
 468       LIBS=`$(YAZCONFIG) --libs threads`
 469      </screen>
 470      There is no need specify POSIX thread libraries in your Makefile.
 471      The <literal>LIBS</literal> variable includes that as well.
 472     </para>
 473    </sect2>
 474   </sect1>
 475   <sect1 id="installation.win32"><title>WIN32</title>
 476
 477    <para>The easiest way to install YAZ on Windows is by downloading
 478     an installer from
 479     <ulink url="&url.yaz.download.win32;">here</ulink>.
 480     The installer comes with source too - in case you wish to
 481     compile YAZ with different Compiler options etc.
 482    </para>
 483
 484    <sect2 id="installation.win32.source">
 485     <title>Compiling from Source on WIN32</title>
 486     <para>
 487      &yaz; is shipped with "makefiles" for the NMAKE tool that comes
 488      with <ulink url="&url.vstudio;">
 489       Microsoft Visual Studio</ulink>.
 490      Version 6 and .NET has been tested. We expect that &yaz; compiles
 491      with version 5 as well.
 492     </para>
 493     <para>
 494      Start a command prompt and switch the sub directory
 495      <filename>WIN</filename> where the file <filename>makefile</filename>
 496      is located. Customize the installation by editing the
 497      <filename>makefile</filename> file (for example by using notepad).
 498
 499      The following summarizes the most important settings in that file:
 500
 501      <variablelist>
 502       <varlistentry><term><literal>DEBUG</literal></term>
 503        <listitem><para>
 504          If set to 1, the software is
 505          compiled with debugging libraries (code generation is
 506          multi-threaded debug DLL).
 507          If set to 0, the software is compiled with release libraries
 508          (code generation is multi-threaded DLL).
 509         </para></listitem>
 510       </varlistentry>
 511       <varlistentry>
 512        <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
 513        <listitem><para>
 514          If <literal>HAVE_TCL</literal> is set to 1, nmake will
 515          use the ASN.1 compiler (Tcl based). You must set
 516          <literal>TCL</literal> to the full path of the Tcl
 517          interpreter.
 518         </para>
 519         <para>
 520          If you do not have Tcl installed, set
 521          <literal>HAVE_TCL</literal> to 0.
 522         </para></listitem>
 523       </varlistentry>
 524
 525       <varlistentry>
 526        <term><literal>HAVE_BISON</literal>,
 527         <literal>BISON</literal></term>
 528        <listitem><para>
 529          If GNU Bison is present, you might set <literal>HAVE_ICONV</literal>
 530          to 1 and specify the Bison executable in <literal>BISON</literal>.
 531          Bison is only required if you use the CVS version of
 532          YAZ or if you modify the grammar for CQL
 533          (<filename>cql.y</filename>).
 534         </para>
 535         <para>
 536          A Windows version of GNU Bison is part of
 537          <ulink url="&url.unxutils;">unxutils</ulink>.
 538         </para></listitem>
 539       </varlistentry>
 540
 541       <varlistentry>
 542        <term><literal>HAVE_ICONV</literal>,
 543         <literal>ICONV_DIR</literal></term>
 544        <listitem><para>
 545          If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
 546          with iconv support. In this configuration, set
 547          <literal>ICONV_DIR</literal> to the iconv source directory.
 548         </para></listitem>
 549       </varlistentry>
 550
 551       <varlistentry>
 552        <term><literal>HAVE_LIBXML2</literal>,
 553         <literal>LIBXML2_DIR</literal></term>
 554        <listitem>
 555         <para>
 556          If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
 557          with SRU support. In this configuration, set
 558          <literal>LIBXML2_DIR</literal> to the
 559          <ulink url="&url.libxml2;">libxml2</ulink> source directory
 560          and
 561          <literal>ZLIB_DIR</literal> to the zlib directory.
 562         </para>
 563
 564         <para>
 565          Windows versions of libxslt, libxml2, zlib and iconv can be found
 566          <ulink url="&url.libxml2.download.win32;">
 567           Igor Zlatkovi&#x0107;' site</ulink>.
 568         </para>
 569
 570         <note>
 571          <para>
 572           YAZ is not using zlib but libxml2 is depending on it.
 573          </para>
 574         </note>
 575        </listitem>
 576       </varlistentry>
 577
 578       <varlistentry>
 579        <term><literal>HAVE_LIBXSLT</literal>,
 580         <literal>LIBXSLT_DIR</literal></term>
 581        <listitem>
 582         <para>
 583          If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
 584          with XSLT support. In this configuration, set
 585          <literal>LIBXSLT_DIR</literal> to the
 586          <ulink url="&url.libxslt;">libxslt</ulink> source directory.
 587         </para>
 588
 589         <note>
 590          <para>
 591           libxslt depends libxml2.
 592          </para>
 593         </note>
 594        </listitem>
 595       </varlistentry>
 596
 597       <varlistentry>
 598        <term><literal>HAVE_ICU</literal>,
 599         <literal>ICU_DIR</literal></term>
 600        <listitem>
 601         <para>
 602          If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
 603          with <ulink url="&url.icu;">ICU</ulink> support.
 604          In this configuration, set
 605          <literal>ICU_DIR</literal> to the
 606          <ulink url="&url.icu;">ICU</ulink> source directory.
 607         </para>
 608        </listitem>
 609
 610       </varlistentry>
 611
 612      </variablelist>
 613     </para>
 614     <para>
 615      When satisfied with the settings in the makefile, type
 616      <screen>
 617       nmake
 618      </screen>
 619     </para>
 620     <note>
 621      <para>
 622       If the <filename>nmake</filename> command is not found on your system
 623       you probably haven't defined the environment variables required to
 624       use that tool. To fix that, find and run the batch file
 625       <filename>vcvars32.bat</filename>. You need to run it from within
 626       the command prompt or set the environment variables "globally";
 627       otherwise it doesn't work.
 628      </para>
 629     </note>
 630     <para>
 631      If you wish to recompile &yaz; - for example if you modify
 632      settings in the <filename>makefile</filename> you can delete
 633      object files, etc by running.
 634      <screen>
 635       nmake clean
 636      </screen>
 637     </para>
 638     <para>
 639      The following files are generated upon successful compilation:
 640
 641      <variablelist>
 642       <varlistentry><term><filename>bin/yaz3.dll</filename> /
 643           <filename>bin/yaz3d.dll</filename></term>
 644        <listitem><para>
 645          &yaz; Release/Debug DLL.
 646         </para></listitem></varlistentry>
 647
 648       <varlistentry><term><filename>lib/yaz3.lib</filename> /
 649           <filename>lib/yaz3d.lib</filename></term>
 650        <listitem><para>
 651          Import library for <filename>yaz3.dll</filename> /
 652          <filename>yaz3d.dll</filename>.
 653         </para></listitem></varlistentry>
 654
 655       <varlistentry><term><filename>bin/yaz_icu3.dll</filename> /
 656           <filename>bin/yaz_icu3d.dll</filename></term>
 657        <listitem><para>
 658          Release/Debug DLL for the ICU wrapper utility.
 659          Only build if HAVE_ICU is 1.
 660         </para></listitem></varlistentry>
 661
 662       <varlistentry><term><filename>lib/yaz_icu3.lib</filename> /
 663           <filename>lib/yaz_icu3d.lib</filename></term>
 664        <listitem><para>
 665          Import library for <filename>yaz_icu3.dll</filename> /
 666          <filename>yaz_icu3d.dll</filename>.
 667         </para></listitem></varlistentry>
 668
 669       <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
 670        <listitem><para>
 671          Z39.50 multi-threaded test/example server. It's a WIN32
 672          console application.
 673         </para></listitem></varlistentry>
 674
 675       <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
 676        <listitem><para>
 677          &yaz; Z39.50 client application. It's a WIN32 console application.
 678          See chapter <link linkend="yaz-client">YAZ client</link> for more
 679          information.
 680         </para></listitem></varlistentry>
 681
 682       <varlistentry><term><filename>bin/yaz-icu.exe</filename></term>
 683        <listitem><para>This program exposes the ICU wrapper library if that
 684          is enabled for YAZ. Only if ICU is available this program is
 685          build.
 686         </para></listitem></varlistentry>
 687
 688       <varlistentry><term><filename>bin/zoomsh.exe</filename></term>
 689        <listitem><para>
 690          Simple console application implemented on top of the
 691          <link linkend="zoom">ZOOM</link> functions.
 692          The application is a command line shell that allows you to enter
 693          simple commands to perform ZOOM operations.
 694         </para></listitem></varlistentry>
 695
 696       <varlistentry><term><filename>bin/zoomtst1.exe</filename>,
 697         <filename>bin/zoomtst2.exe</filename>, ..</term>
 698        <listitem><para>
 699          Several small applications that demonstrates the ZOOM API.
 700         </para></listitem></varlistentry>
 701
 702      </variablelist>
 703
 704     </para>
 705    </sect2>
 706
 707    <sect2 id="installation-linking-yaz-win32">
 708     <title>How to make apps using YAZ on WIN32</title>
 709     <para>
 710      This section will go though the process of linking your WIN32
 711      applications with &yaz;.
 712     </para>
 713     <para>
 714      Some people are confused by the fact that we use the nmake
 715      tool to build &yaz;. They think they have to do that too - in order
 716      to make their WIN32 applications work with &yaz;. The good news is that
 717      you don't have to. You can use the integrated environment of
 718      Visual Studio if desired for your own application.
 719     </para>
 720     <para>
 721      When setting up a project or Makefile you have to set the following:
 722      <variablelist>
 723       <varlistentry><term>include path</term><listitem><para>
 724          Set it to the <filename>include</filename> directory of &yaz;.
 725         </para></listitem></varlistentry>
 726       <varlistentry><term>import library <filename>yaz3.lib</filename>
 727        </term><listitem><para>
 728          You must link with this library. It's located in the
 729          sub directory <filename>lib</filename> of &yaz;.
 730          If you want to link with the debug version of &yaz;, you must
 731          link against <filename>yaz3d.lib</filename> instead.
 732         </para></listitem></varlistentry>
 733       <varlistentry><term>dynamic link library <filename>yaz3.dll</filename>
 734        </term><listitem><para>
 735          This DLL must be in your execution path when you invoke
 736          your application. Specifically, you should distribute this
 737          DLL with your application.
 738         </para></listitem></varlistentry>
 739      </variablelist>
 740     </para>
 741    </sect2>
 742   </sect1>
 743  </chapter>
 744
 745  <!-- Keep this comment at the end of the file
 746  Local variables:
 747  mode: sgml
 748  sgml-omittag:t
 749  sgml-shorttag:t
 750  sgml-minimize-attributes:nil
 751  sgml-always-quote-attributes:t
 752  sgml-indent-step:1
 753  sgml-indent-data:t
 754  sgml-parent-document: "yaz.xml"
 755  sgml-local-catalogs: nil
 756  sgml-namecase-general:t
 757  End:
 758  -->
 759