From: Adam Dickmeiss <adam@indexdata.dk>
Date: Wed, 13 Dec 2006 09:40:32 +0000 (+0000)
Subject: Added documentation about ziffy.
X-Git-Tag: YAZ.2.1.42~18
X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=2e9966e7b28bef005dadfae9282ffbf912bd7a9f

Added documentation about ziffy.
---

diff --git a/NEWS b/NEWS
index d16008a..d86bad8 100644
--- a/NEWS
+++ b/NEWS
@@ -15,6 +15,10 @@ association is still alive (client is connected); 0 otherwise (client
 closed connection). This allows busy servers to stop working for
 impatient clients.
 
+Added ziffy: the promiscuous Z39.50 APDU sniffer. until now, ziffy has
+been a separate piece of software. This version of ziffy has been modified
+to fit with YAZ. ziffy is copyright Rocco Carbone and covered by GPL v2.
+
 Fixed bug #740: Handle SRU records referring to xmlns's outside recordData.
 
 Fixed bug #722: Allow Z39.50 Init Options to be specified / retrieved.
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 72fb4b7..a342f8a 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-## $Id: Makefile.am,v 1.75 2006-10-24 10:12:36 adam Exp $
+## $Id: Makefile.am,v 1.76 2006-12-13 09:40:32 adam Exp $
 
 docdir=$(datadir)/doc/@PACKAGE@
 
@@ -7,7 +7,7 @@ SUBDIRS = common
 XMLFILES=bookinfo.xml introduction.xml installation.xml \
  indexdata.xml \
  asn.xml tools.xml odr.xml comstack.xml frontend.xml license.xml \
- future.xml client.xml zoom.xml credits.xml gfs-options.xml \
+ future.xml client.xml ziffy.xml zoom.xml credits.xml gfs-options.xml \
  yaz.xml yaz-client-commands.xml soap.xml gfs-virtual.xml gfs-synopsis.xml
 
 HTMLFILES = index.html
diff --git a/doc/entities.ent b/doc/entities.ent
index 2c8471e..9a25e45 100644
--- a/doc/entities.ent
+++ b/doc/entities.ent
@@ -1,10 +1,11 @@
-<!-- $Id: entities.ent,v 1.3 2006-10-05 08:26:58 adam Exp $ -->
+<!-- $Id: entities.ent,v 1.4 2006-12-13 09:40:32 adam Exp $ -->
 <!ENTITY yaz "YAZ">
 <!ENTITY bookinfo SYSTEM "bookinfo.xml">
 <!ENTITY chap-introduction SYSTEM "introduction.xml">
 <!ENTITY chap-installation SYSTEM "installation.xml">
 <!ENTITY chap-zoom SYSTEM "zoom.xml">
 <!ENTITY chap-client SYSTEM "client.xml">
+<!ENTITY chap-ziffy SYSTEM "ziffy.xml">
 <!ENTITY chap-asn SYSTEM "asn.xml">
 <!ENTITY chap-soap SYSTEM "soap.xml">
 <!ENTITY chap-tools SYSTEM "tools.xml">
diff --git a/doc/installation.xml b/doc/installation.xml
index 51ed70b..6ebab64 100644
--- a/doc/installation.xml
+++ b/doc/installation.xml
@@ -1,4 +1,4 @@
-<!-- $Id: installation.xml,v 1.33 2006-09-06 09:27:16 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 id="installation-introduction"><title>Introduction</title>
@@ -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>
      
@@ -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
diff --git a/doc/license.xml b/doc/license.xml
index ad1d208..6a5380e 100644
--- a/doc/license.xml
+++ b/doc/license.xml
@@ -1,4 +1,4 @@
-<!-- $Id: license.xml,v 1.13 2006-10-09 21:02:40 adam Exp $ -->
+<!-- $Id: license.xml,v 1.14 2006-12-13 09:40:32 adam Exp $ -->
  <appendix id="license"><title>License</title>
 
   <sect1 id="license.indexdata"><title>Index Data Copyright</title>
@@ -54,6 +54,15 @@
   </sect1>
   <sect1 id="license.other"><title>Additional Copyright Statements</title>
 
+   <sect2 id="license.ziffy"><title>ziffy</title>
+    <para>
+     The software in directory <filename>ziffy</filename> and the
+     <application>ziffy</application> application is copyright
+     Rocco Carbone and covered by the GNU General public license, version 2.
+    </para>
+   </sect2>
+   
+   <sect2 id="license.ccl"><title>CCL</title>
    <para>
     The optional CCL query language interpreter is covered by the following
     license:
@@ -114,6 +123,7 @@
     ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
     USE OR PERFORMANCE OF THIS SOFTWARE.
    </para>
+   </sect2>
   </sect1>
  </appendix>
 
diff --git a/doc/yaz.xml b/doc/yaz.xml
index a106071..0585fcd 100644
--- a/doc/yaz.xml
+++ b/doc/yaz.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" standalone="no"?>
-<!-- $Id: yaz.xml,v 1.21 2006-05-28 19:56:25 adam Exp $ -->
+<!-- $Id: yaz.xml,v 1.22 2006-12-13 09:40:32 adam Exp $ -->
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" 
 [
@@ -17,6 +17,7 @@
  &chap-zoom;
  &chap-frontend;
  &chap-client;
+ &chap-ziffy;
  &chap-asn;
  &chap-soap;
  &chap-tools;
diff --git a/doc/ziffy.xml b/doc/ziffy.xml
new file mode 100644
index 0000000..db05db1
--- /dev/null
+++ b/doc/ziffy.xml
@@ -0,0 +1,55 @@
+<!-- $Id: ziffy.xml,v 1.1 2006-12-13 09:40:32 adam Exp $ -->
+ <chapter id="ziffy"><title>ziffy</title>
+  <sect1 id="ziffy.introduction"><title>Introduction</title>
+   <para>
+    ziffy is a promiscuous Z39.50 APDU sniffer, like the popular tcpdump.
+    ziffy can capture and show all Z39.50 traffic on your LAN segment.
+   </para>
+   <para>
+    ziffy is copyright Rocco Carbone and is covered by the GPL. ziffy
+    uses <ulink url="&url.libpcap;">libpcap</ulink> to capture the packages
+    and is part of YAZ 2.1.42 or later.
+    Source and documentation for the ziffy utility is part of the sub
+    directory <filename>ziffy</filename> in the YAZ source package.
+   </para>
+   <para>
+    The ziffy software is also a standalone piece of software and
+    can be obtained separately. The ziffy as part of YAZ, uses
+    YAZ for decoding Z39.50 packages. The standalone version can
+    use different decoders (SNACC and X/ASN.1)
+   </para>
+  </sect1>
+  <sect1 id="ziffy.using"><title>Using Ziffy</title>
+  <para>
+   ziffy must be executed with root priviledge.
+  </para>
+  <example>
+   <para>
+   In the command below ziffy is started and dumps all Z39.50 traffic
+   on ethernet device <literal>eth0</literal>
+   </para>
+   <screen>
+   # ziffy -i eth0
+   </screen>
+   </example>
+   <para>
+    For more information about ziffy refer to the man page ziffy(1) and
+    the material in sub directory <filename>ziffy</filename>.
+   </para>
+ </sect1>
+ </chapter>
+ 
+ <!-- Keep this comment at the end of the file
+ Local variables:
+ mode: sgml
+ sgml-omittag:t
+ sgml-shorttag:t
+ sgml-minimize-attributes:nil
+ sgml-always-quote-attributes:t
+ sgml-indent-step:1
+ sgml-indent-data:t
+ sgml-parent-document: "yaz.xml"
+ sgml-local-catalogs: nil
+ sgml-namecase-general:t
+ End:
+ -->