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