For the CQL parser, make boolean node names lowercase.. but this time at

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

diff --git a/doc/installation.xml b/doc/installation.xml
index e07f1c9..6ebab64 100644 (file)
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,7 +1,7 @@
-<!-- $Id: installation.xml,v 1.31 2006-05-03 13:38:12 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.34 2006-12-13 09:40:32 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>
@@ -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;.
@@ -180,11 +189,11 @@
         </para></listitem>
       </varlistentry>
 
-      <varlistentry><term><literal>--enable-shared</literal></term>
-       <listitem><para>The make process will create shared
+      <varlistentry><term><literal>--disable-shared</literal></term>
+       <listitem><para>The make process will not create shared
          libraries (also known as shared objects <filename>.so</filename>).
-         By default, no shared libraries are created -
-         equivalent to <literal>--disable-shared</literal>.
+         By default, shared libraries are created -
+         equivalent to <literal>--enable-shared</literal>.
         </para></listitem>
       </varlistentry>
 
@@ -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>
      
@@ -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.
@@ -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;.