Documentation updates for new names of dll/so files.

[yaz-moved-to-github.git] / doc / installation.xml

diff --git a/doc/installation.xml b/doc/installation.xml
index 6f0769a..59e7c82 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,7 +1,7 @@
-<!-- $Id: installation.xml,v 1.32 2006-06-27 12:23:12 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.36 2007-05-04 08:03:40 adam Exp $ -->
  <chapter id="installation"><title>Compilation and Installation</title>
   
-  <sect1><title>Introduction</title>
+  <sect1 id="installation-introduction"><title>Introduction</title>
    <para>
     The latest version of the software will generally be found at:
    </para>
@@ -42,7 +42,7 @@
     let us know about it. If you run into difficulties, we will try to help
     if we can, and if you solve the problems, we would be happy to include
     your fixes in the next release. So far, we have mostly avoided
-    <literal>&num;ifdefs</literal> for individual platforms, and we'd
+    <literal>#ifdefs</literal> for individual platforms, and we'd
     like to keep it that way as far as it makes sense.
    </para>
    
@@ -106,6 +106,15 @@
     </para>
 
     <para>
+     YAZ can optionally be compiled with 
+     <ulink url="&url.libpcap;">libpcap</ulink> support. By default,
+     configure enables libpcap if it is available. 
+     The libpcap library is required for
+     <link linkend="ziffy">ziffy</link>. And without libpcap,
+     ziffy will not be built.
+    </para>
+
+    <para>
      The CQL parser for &yaz; is built using
      GNU <ulink url="&url.bison;">Bison</ulink>.
      This tool is only needed if you're using the CVS version of &yaz;.
@@ -231,6 +240,15 @@
          experimental.
         </para></listitem>
       </varlistentry>
+
+      <varlistentry><term>
+        <literal>--with-libpcap</literal>[=<replaceable>prefix</replaceable>]
+       </term>
+       <listitem><para>Compile &yaz; with
+        <ulink url="&url.libpcap;">libpcap</ulink> support and the
+        <link linkend="ziffy">ziffy</link> utility.
+        </para></listitem>
+      </varlistentry>
       
      </variablelist>
      
@@ -254,11 +272,11 @@
         </para></listitem>
       </varlistentry>
       
-      <varlistentry><term><filename>src/libyazthread.la</filename></term>
+      <varlistentry><term><filename>src/libyaz_server.la</filename></term>
        <listitem><para>
-         When threading is supported/enabled by configure this Libtool
-         library is created. It includes functions that allows &yaz;
-         to use threads.
+         Generic Frontend server. This is an add-on for libyaz.la.
+         Code in this library uses POSIX threads functions - if they
+         available on the platform.
         </para></listitem>
       </varlistentry>
       
@@ -273,7 +291,14 @@
           YAZ client</link> for more information.
         </para></listitem>
       </varlistentry>
-      
+
+      <varlistentry><term><filename>ziffy/ziffy</filename></term>
+       <listitem><para>A promiscuous Z39.50 APDU sniffer. 
+         ziffy is only built on systems where libpcap is available.
+        See <xref linkend="ziffy"/> for more information. 
+        </para></listitem>
+      </varlistentry>
+            
       <varlistentry><term><filename>util/yaz-config</filename></term>
        <listitem><para>A Bourne-shell script, generated by configure, that
          specifies how external applications should compile - and link with
@@ -353,7 +378,8 @@
     </para>
    </sect2>
 
-   <sect2><title>How to make apps using YAZ on UNIX</title>
+   <sect2 id="installation-linking-yaz-unix">
+    <title>How to make apps using YAZ on UNIX</title>
     <para>
      This section describes how to compile - and link your own
      applications using the &yaz; toolkit.
@@ -578,24 +604,24 @@
      The following files are generated upon successful compilation:
      
      <variablelist>
-      <varlistentry><term><filename>bin/yaz.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz3.dll</filename></term>
        <listitem><para>
          &yaz; release mode multi-threaded Dynamic Link Library.
         </para></listitem></varlistentry>
       
       <varlistentry><term><filename>lib/yaz.lib</filename></term>
        <listitem><para>
-         Import library for <filename>yaz.dll</filename>.
+         Import library for <filename>yaz3.dll</filename>.
         </para></listitem></varlistentry>
       
-      <varlistentry><term><filename>bin/yazd.dll</filename></term>
+      <varlistentry><term><filename>bin/yaz3d.dll</filename></term>
        <listitem><para>
          &yaz; debug mode multi-threaded Dynamic Link Library.
         </para></listitem></varlistentry>
       
       <varlistentry><term><filename>lib/yazd.lib</filename></term>
        <listitem><para>
-         Import library for <filename>yazd.dll</filename>.
+         Import library for <filename>yaz3d.dll</filename>.
         </para></listitem></varlistentry>
       
       <varlistentry><term><filename>bin/yaz-client.exe</filename></term>
@@ -630,7 +656,8 @@
     </para>
    </sect2>
 
-   <sect2><title>How to make apps using YAZ on WIN32</title>
+   <sect2 id="installation-linking-yaz-win32">
+    <title>How to make apps using YAZ on WIN32</title>
     <para>
      This section will go though the process of linking your WIN32
      applications with &yaz;.
@@ -653,9 +680,9 @@
          You must link with this library. It's located in the 
          sub directory <filename>lib</filename> of &yaz;.
         If you want to link with the debug version of &yaz;, you must
-        link with <filename>yazd.dll</filename> instead.
+        link against <filename>yazd.lib</filename> instead.
         </para></listitem></varlistentry>
-      <varlistentry><term>dynamic link library <filename>yaz.dll</filename>
+      <varlistentry><term>dynamic link library <filename>yaz3.dll</filename>
        </term><listitem><para>
          This DLL must be in your execution path when you invoke
          your application. Specifically, you should distribute this