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