Factor ziffy out as a separate package.
[yaz-moved-to-github.git] / doc / installation.xml
index 492fcc0..88be103 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.35 2007-01-31 15:27:17 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.39 2008-01-14 20:34:14 adam Exp $ -->
  <chapter id="installation"><title>Compilation and Installation</title>
   
   <sect1 id="installation-introduction"><title>Introduction</title>
     </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;.
         </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>
      
     </para>
         </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>
       
       
       <varlistentry><term><filename>client/yaz-client</filename></term>
        <listitem><para>Z39.50 client for testing the protocol.
-         See chapter <link linkend="client">
+         See chapter <link linkend="yaz-client">
           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
      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>
+      <varlistentry><term><filename>lib/yaz3.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>
+      <varlistentry><term><filename>lib/yaz3d.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>
        <listitem><para>
          &yaz; Z39.50 client application. It's a WIN32 console application.
-         See chapter <link linkend="client">YAZ client</link> for more
+         See chapter <link linkend="yaz-client">YAZ client</link> for more
          information.
         </para></listitem></varlistentry>
       
       <varlistentry><term>include path</term><listitem><para>
          Set it to the <filename>include</filename> directory of &yaz;.
         </para></listitem></varlistentry>
-      <varlistentry><term>import library <filename>yaz.lib</filename>
+      <varlistentry><term>import library <filename>yaz3.lib</filename>
        </term><listitem><para>
          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>yaz3d.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