doc/installation.xml

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