Mention libgcrypt in Unix installation of YAZ
[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-icu</literal>[=<replaceable>prefix</replaceable>]
303        </term>
304        <listitem><para>&yaz; will be linked the
305         <ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
306         If prefix is not given, the libraries exposed by the script
307         <application>icu-config</application> will be used if found.
308         </para></listitem>
309       </varlistentry>
310
311       <varlistentry><term>
312         <literal>--with-libgcrypt</literal>[=<replaceable>prefix</replaceable>]
313        </term>
314        <listitem><para>&yaz; will be linked with
315         <ulink url="&url.libgcrypt;">Libgcrypt</ulink> in the prefix if given.
316         If prefix is not given, the libraries exposed by the script
317         <application>libgcrypt-config</application> will be used if found.
318         </para></listitem>
319       </varlistentry>
320
321      </variablelist>
322
323     </para>
324     <para>
325      When configured, build the software by typing:
326      <screen>
327       make
328      </screen>
329     </para>
330
331     <para>
332      The following files are generated by the make process:
333      <variablelist>
334       <varlistentry><term><filename>src/libyaz.la</filename></term>
335        <listitem><para>
336          Main &yaz; library. This is no ordinary library. It's
337          a Libtool archive.
338          By default, &yaz; creates a static library in
339          <filename>lib/.libs/libyaz.a</filename>.
340         </para></listitem>
341       </varlistentry>
342
343       <varlistentry><term><filename>src/libyaz_server.la</filename></term>
344        <listitem><para>
345          Generic Frontend server. This is an add-on for libyaz.la.
346          Code in this library uses POSIX threads functions - if POSIX
347          threads are available on the platform.
348         </para></listitem>
349       </varlistentry>
350
351       <varlistentry><term><filename>src/libyaz_icu.la</filename></term>
352        <listitem><para>
353          Functions that wrap the ICU library.
354         </para></listitem>
355       </varlistentry>
356
357       <varlistentry><term><filename>ztest/yaz-ztest</filename></term>
358        <listitem><para>Test Z39.50 server.
359         </para></listitem>
360       </varlistentry>
361
362       <varlistentry><term><filename>client/yaz-client</filename></term>
363        <listitem><para>Z39.50 client for testing the protocol.
364          See chapter <link linkend="yaz-client">
365           YAZ client</link> for more information.
366         </para></listitem>
367       </varlistentry>
368
369       <varlistentry><term><filename>util/yaz-config</filename></term>
370        <listitem><para>A Bourne-shell script, generated by configure, that
371          specifies how external applications should compile - and link with
372          &yaz;.
373         </para></listitem>
374       </varlistentry>
375
376       <varlistentry><term><filename>util/yaz-asncomp</filename></term>
377        <listitem><para>The ASN.1 compiler for &yaz;. Requires the
378          Tcl Shell, <application>tclsh</application>, in
379          <literal>PATH</literal> to operate.
380         </para></listitem>
381       </varlistentry>
382
383       <varlistentry><term><filename>util/yaz-iconv</filename></term>
384        <listitem><para>This program converts data in one character set to
385          another. This command exercises the YAZ character set
386          conversion API.
387         </para></listitem>
388       </varlistentry>
389
390       <varlistentry><term><filename>util/yaz-marcdump</filename></term>
391        <listitem><para>This program parses ISO2709 encoded MARC records
392          and prints them in line-format or XML.
393         </para></listitem>
394       </varlistentry>
395
396       <varlistentry><term><filename>util/yaz-icu</filename></term>
397        <listitem><para>This program exposes the ICU wrapper library if that
398          is enabled for YAZ. Only if ICU is available this program is
399          useful.
400         </para></listitem>
401       </varlistentry>
402
403      <varlistentry><term><filename>zoom/zoomsh</filename></term>
404        <listitem><para>
405          A simple shell implemented on top of the
406          <link linkend="zoom">ZOOM</link> functions.
407          The shell is a command line application that allows you to enter
408          simple commands to perform ZOOM operations.
409         </para></listitem>
410       </varlistentry>
411
412       <varlistentry><term><filename>zoom/zoomtst1</filename>,
413         <filename>zoom/zoomtst2</filename>, ..</term>
414        <listitem><para>
415          Several small applications that demonstrates the ZOOM API.
416         </para></listitem>
417       </varlistentry>
418      </variablelist>
419
420     </para>
421
422     <para>
423      If you wish to install &yaz; in system directories
424      <filename>/usr/local/bin</filename>,
425      <filename>/usr/local/lib</filename> .. etc, you can type:
426     </para>
427
428     <screen>
429      make install
430     </screen>
431
432     <para>
433      You probably need to have root access in order to perform this.
434      You must specify the <literal>--prefix</literal> option for configure if
435      you wish to install &yaz; in other directories than the default
436      <filename>/usr/local/</filename>.
437     </para>
438
439     <para>
440      If you wish to perform an un-installation of &yaz;, use:
441     </para>
442
443     <screen>
444      make uninstall
445     </screen>
446
447     <para>
448      This will only work if you haven't reconfigured &yaz; (and therefore
449      changed installation prefix). Note that uninstall will not
450      remove directories created by make install, e.g.
451      <filename>/usr/local/include/yaz</filename>.
452     </para>
453    </sect2>
454
455    <sect2 id="installation-linking-yaz-unix">
456     <title>How to make apps using YAZ on UNIX</title>
457     <para>
458      This section describes how to compile - and link your own
459      applications using the &yaz; toolkit.
460      If you're used to Makefiles this shouldn't be hard. As for
461      other libraries you have used before, you have to set a proper include
462      path for your C/C++ compiler and specify the location of
463      &yaz; libraries. You can do it by hand, but generally we suggest
464      you use the <filename>yaz-config</filename> that is generated
465      by <filename>configure</filename>. This is especially
466      important if you're using the threaded version of &yaz; which
467      require you to pass more options to your linker/compiler.
468     </para>
469     <para>
470      The <filename>yaz-config</filename> script accepts command line
471      options that makes the <filename>yaz-config</filename> script print
472      options that you should use in your make process.
473      The most important ones are:
474      <literal>--cflags</literal>, <literal>--libs</literal>
475      which prints C compiler flags, and linker flags respectively.
476      </para>
477     <para>
478      A small and complete <literal>Makefile</literal> for a C
479      application consisting of one source file,
480      <filename>myprog.c</filename>, may look like this:
481      <screen>
482       YAZCONFIG=/usr/local/bin/yaz-config
483       CFLAGS=`$(YAZCONFIG) --cflags`
484       LIBS=`$(YAZCONFIG) --libs`
485       myprog: myprog.o
486          $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
487       </screen>
488      </para>
489     <para>
490      The CFLAGS variable consists of a C compiler directive that will set
491      the include path to the <emphasis>parent</emphasis> directory
492      of <filename>yaz</filename>. That is, if &yaz; header files were
493      installed in <filename>/usr/local/include/yaz</filename>,
494      then include path is set to <filename>/usr/local/include</filename>.
495      Therefore, in your applications you should use
496      <screen>
497       #include &lt;yaz/proto.h>
498      </screen>
499      and <emphasis>not</emphasis>
500      <screen>
501       #include &lt;proto.h>
502      </screen>
503     </para>
504     <para>
505      For Libtool users, the <filename>yaz-config</filename> script provides
506      a different variant of option <literal>--libs</literal>, called
507      <literal>--lalibs</literal> that returns the name of the
508      Libtool archive(s) for &yaz; rather than the ordinary ones.
509     </para>
510     <para>
511      For applications using the threaded version of &yaz;,
512      specify <literal>threads</literal> after the
513      other options. When <literal>threads</literal> is given,
514      more flags and linker flags will be printed by
515      <filename>yaz-config</filename>. If our previous example was
516       using threads, you'd have to modify the lines that set
517      <literal>CFLAGS</literal> and <literal>LIBS</literal> as
518      follows:
519      <screen>
520       CFLAGS=`$(YAZCONFIG) --cflags threads`
521       LIBS=`$(YAZCONFIG) --libs threads`
522      </screen>
523      There is no need specify POSIX thread libraries in your Makefile.
524      The <literal>LIBS</literal> variable includes that as well.
525     </para>
526    </sect2>
527   </sect1>
528   <sect1 id="installation.win32"><title>WIN32</title>
529
530    <para>The easiest way to install YAZ on Windows is by downloading
531     an installer from
532     <ulink url="&url.yaz.download.win32;">here</ulink>.
533     The installer comes with source too - in case you wish to
534     compile YAZ with different compiler options, etc.
535    </para>
536
537    <sect2 id="installation.win32.source">
538     <title>Compiling from Source on WIN32</title>
539     <para>
540      &yaz; is shipped with "makefiles" for the NMAKE tool that comes
541      with <ulink url="&url.vstudio;">
542      Microsoft Visual Studio</ulink>. It has been tested with
543      Microsoft Visual Studio 2003/2005/2008.
544     </para>
545     <para>
546      Start a command prompt and switch the sub directory
547      <filename>WIN</filename> where the file <filename>makefile</filename>
548      is located. Customize the installation by editing the
549      <filename>makefile</filename> file (for example by using notepad).
550
551      The following summarizes the most important settings in that file:
552
553      <variablelist>
554       <varlistentry><term><literal>DEBUG</literal></term>
555        <listitem><para>
556          If set to 1, the software is
557          compiled with debugging libraries (code generation is
558          multi-threaded debug DLL).
559          If set to 0, the software is compiled with release libraries
560          (code generation is multi-threaded DLL).
561         </para></listitem>
562       </varlistentry>
563       <varlistentry>
564        <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
565        <listitem><para>
566          If <literal>HAVE_TCL</literal> is set to 1, nmake will
567          use the ASN.1 compiler (<ulink url="&url.tcl;">Tcl</ulink> based).
568          You must set <literal>TCL</literal> to the full path of the Tcl
569          interpreter. A Windows version of Tcl is part of
570          <ulink url="&url.gitwindows;">Git for Windows</ulink>.
571         </para>
572         <para>
573          If you do not have Tcl installed, set
574          <literal>HAVE_TCL</literal> to 0.
575         </para></listitem>
576       </varlistentry>
577
578       <varlistentry>
579        <term><literal>HAVE_BISON</literal>,
580         <literal>BISON</literal></term>
581        <listitem><para>
582          If GNU Bison is present, you might set <literal>HAVE_BISON</literal>
583          to 1 and specify the Bison executable in <literal>BISON</literal>.
584          Bison is only required if you use the git version of
585          YAZ or if you modify the grammar for CQL
586          (<filename>cql.y</filename>).
587         </para>
588         <para>
589          A Windows version of GNU Bison is part of
590          <ulink url="&url.gitwindows;">Git for Windows</ulink>.
591         </para></listitem>
592       </varlistentry>
593
594       <varlistentry>
595        <term><literal>HAVE_ICONV</literal>,
596         <literal>ICONV_DIR</literal></term>
597        <listitem><para>
598          If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
599          with iconv support. In this configuration, set
600          <literal>ICONV_DIR</literal> to the iconv source directory.
601         </para></listitem>
602       </varlistentry>
603
604       <varlistentry>
605        <term><literal>HAVE_LIBXML2</literal>,
606         <literal>LIBXML2_DIR</literal></term>
607        <listitem>
608         <para>
609          If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
610          with SRU support. In this configuration, set
611          <literal>LIBXML2_DIR</literal> to the
612          <ulink url="&url.libxml2;">libxml2</ulink> source directory
613          and
614          <literal>ZLIB_DIR</literal> to the zlib directory.
615         </para>
616
617         <para>
618          Windows versions of libxslt, libxml2, zlib and iconv can be found
619          <ulink url="&url.libxml2.download.win32;">
620           Igor Zlatkovi&#x0107;' site</ulink>.
621         </para>
622
623         <note>
624          <para>
625           YAZ is not using zlib but libxml2 is depending on it.
626          </para>
627         </note>
628        </listitem>
629       </varlistentry>
630
631       <varlistentry>
632        <term><literal>HAVE_LIBXSLT</literal>,
633         <literal>LIBXSLT_DIR</literal></term>
634        <listitem>
635         <para>
636          If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
637          with XSLT support. In this configuration, set
638          <literal>LIBXSLT_DIR</literal> to the
639          <ulink url="&url.libxslt;">libxslt</ulink> source directory.
640         </para>
641
642         <note>
643          <para>
644           libxslt depends libxml2.
645          </para>
646         </note>
647        </listitem>
648       </varlistentry>
649
650       <varlistentry>
651        <term><literal>HAVE_ICU</literal>,
652         <literal>ICU_DIR</literal></term>
653        <listitem>
654         <para>
655          If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
656          with <ulink url="&url.icu;">ICU</ulink> support.
657          In this configuration, set
658          <literal>ICU_DIR</literal> to the
659          <ulink url="&url.icu;">ICU</ulink> source directory.
660         </para>
661        </listitem>
662
663       </varlistentry>
664
665      </variablelist>
666     </para>
667     <para>
668      When satisfied with the settings in the makefile, type
669      <screen>
670       nmake
671      </screen>
672     </para>
673     <note>
674      <para>
675       If the <filename>nmake</filename> command is not found on your system
676       you probably haven't defined the environment variables required to
677       use that tool. To fix that, find and run the batch file
678       <filename>vcvars32.bat</filename>. You need to run it from within
679       the command prompt or set the environment variables "globally";
680       otherwise it doesn't work.
681      </para>
682     </note>
683     <para>
684      If you wish to recompile &yaz; - for example if you modify
685      settings in the <filename>makefile</filename> you can delete
686      object files, etc by running.
687      <screen>
688       nmake clean
689      </screen>
690     </para>
691     <para>
692      The following files are generated upon successful compilation:
693
694      <variablelist>
695       <varlistentry><term><filename>bin/yaz5.dll</filename> /
696           <filename>bin/yaz5d.dll</filename></term>
697        <listitem><para>
698          &yaz; Release/Debug DLL.
699         </para></listitem></varlistentry>
700
701       <varlistentry><term><filename>lib/yaz5.lib</filename> /
702           <filename>lib/yaz5d.lib</filename></term>
703        <listitem><para>
704          Import library for <filename>yaz5.dll</filename> /
705          <filename>yaz5d.dll</filename>.
706         </para></listitem></varlistentry>
707
708       <varlistentry><term><filename>bin/yaz_cond5.dll</filename> /
709           <filename>bin/yaz_cond5d.dll</filename></term>
710        <listitem><para>
711          Release/Debug DLL for condition variable utilities (condvar.c).
712         </para></listitem></varlistentry>
713
714       <varlistentry><term><filename>lib/yaz_cond5.lib</filename> /
715           <filename>lib/yaz_cond5d.lib</filename></term>
716        <listitem><para>
717          Import library for <filename>yaz_cond5.dll</filename> /
718          <filename>yaz_cond5d.dll</filename>.
719         </para></listitem></varlistentry>
720
721       <varlistentry><term><filename>bin/yaz_icu5.dll</filename> /
722           <filename>bin/yaz_icu5d.dll</filename></term>
723        <listitem><para>
724          Release/Debug DLL for the ICU wrapper utility.
725          Only build if HAVE_ICU is 1.
726         </para></listitem></varlistentry>
727
728       <varlistentry><term><filename>lib/yaz_icu5.lib</filename> /
729           <filename>lib/yaz_icu5d.lib</filename></term>
730        <listitem><para>
731          Import library for <filename>yaz_icu5.dll</filename> /
732          <filename>yaz_icu5d.dll</filename>.
733         </para></listitem></varlistentry>
734
735       <varlistentry><term><filename>bin/yaz-ztest.exe</filename></term>
736        <listitem><para>
737          Z39.50 multi-threaded test/example server. It's a WIN32
738          console application.
739         </para></listitem></varlistentry>
740
741       <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
742        <listitem><para>
743          &yaz; Z39.50 client application. It's a WIN32 console application.
744          See chapter <link linkend="yaz-client">YAZ client</link> for more
745          information.
746         </para></listitem></varlistentry>
747
748       <varlistentry><term><filename>bin/yaz-icu.exe</filename></term>
749        <listitem><para>This program exposes the ICU wrapper library if that
750          is enabled for YAZ. Only if ICU is available this program is
751          build.
752         </para></listitem></varlistentry>
753
754       <varlistentry><term><filename>bin/zoomsh.exe</filename></term>
755        <listitem><para>
756          Simple console application implemented on top of the
757          <link linkend="zoom">ZOOM</link> functions.
758          The application is a command line shell that allows you to enter
759          simple commands to perform ZOOM operations.
760         </para></listitem></varlistentry>
761
762       <varlistentry><term><filename>bin/zoomtst1.exe</filename>,
763         <filename>bin/zoomtst2.exe</filename>, ..</term>
764        <listitem><para>
765          Several small applications that demonstrates the ZOOM API.
766         </para></listitem></varlistentry>
767
768      </variablelist>
769
770     </para>
771    </sect2>
772
773    <sect2 id="installation-linking-yaz-win32">
774     <title>How to make apps using YAZ on WIN32</title>
775     <para>
776      This section will go though the process of linking your WIN32
777      applications with &yaz;.
778     </para>
779     <para>
780      Some people are confused by the fact that we use the nmake
781      tool to build &yaz;. They think they have to do that too - in order
782      to make their WIN32 applications work with &yaz;. The good news is that
783      you don't have to. You can use the integrated environment of
784      Visual Studio if desired for your own application.
785     </para>
786     <para>
787      When setting up a project or Makefile you have to set the following:
788      <variablelist>
789       <varlistentry><term>include path</term><listitem><para>
790          Set it to the <filename>include</filename> directory of &yaz;.
791         </para></listitem></varlistentry>
792       <varlistentry><term>import library <filename>yaz5.lib</filename>
793        </term><listitem><para>
794          You must link with this library. It's located in the
795          sub directory <filename>lib</filename> of &yaz;.
796          If you want to link with the debug version of &yaz;, you must
797          link against <filename>yaz5d.lib</filename> instead.
798         </para></listitem></varlistentry>
799       <varlistentry><term>dynamic link library <filename>yaz5.dll</filename>
800        </term><listitem><para>
801          This DLL must be in your execution path when you invoke
802          your application. Specifically, you should distribute this
803          DLL with your application.
804         </para></listitem></varlistentry>
805      </variablelist>
806     </para>
807    </sect2>
808   </sect1>
809  </chapter>
810
811  <!-- Keep this comment at the end of the file
812  Local variables:
813  mode: sgml
814  sgml-omittag:t
815  sgml-shorttag:t
816  sgml-minimize-attributes:nil
817  sgml-always-quote-attributes:t
818  sgml-indent-step:1
819  sgml-indent-data:t
820  sgml-parent-document: "yaz.xml"
821  sgml-local-catalogs: nil
822  sgml-namecase-general:t
823  End:
824  -->
825