doc/installation.xml

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