From 2e9966e7b28bef005dadfae9282ffbf912bd7a9f Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 13 Dec 2006 09:40:32 +0000 Subject: [PATCH] Added documentation about ziffy. --- NEWS | 4 ++++ doc/Makefile.am | 4 ++-- doc/entities.ent | 3 ++- doc/installation.xml | 29 ++++++++++++++++++++++++-- doc/license.xml | 12 ++++++++++- doc/yaz.xml | 3 ++- doc/ziffy.xml | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 103 insertions(+), 7 deletions(-) create mode 100644 doc/ziffy.xml 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 @@ - + + 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 @@ - + Compilation and Installation Introduction @@ -106,6 +106,15 @@ + YAZ can optionally be compiled with + libpcap support. By default, + configure enables libpcap if it is available. + The libpcap library is required for + ziffy. And without libpcap, + ziffy will not be built. + + + The CQL parser for &yaz; is built using GNU Bison. This tool is only needed if you're using the CVS version of &yaz;. @@ -231,6 +240,15 @@ experimental. + + + --with-libpcap[=prefix] + + Compile &yaz; with + libpcap support and the + ziffy utility. + + @@ -273,7 +291,14 @@ YAZ client for more information. - + + ziffy/ziffy + A promiscuous Z39.50 APDU sniffer. + ziffy is only built on systems where libpcap is available. + See for more information. + + + util/yaz-config 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 @@ - + License Index Data Copyright @@ -54,6 +54,15 @@ Additional Copyright Statements + ziffy + + The software in directory ziffy and the + ziffy application is copyright + Rocco Carbone and covered by the GNU General public license, version 2. + + + + CCL 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. + 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 @@ - + + ziffy + Introduction + + 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. + + + ziffy is copyright Rocco Carbone and is covered by the GPL. ziffy + uses libpcap 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 ziffy in the YAZ source package. + + + 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) + + + Using Ziffy + + ziffy must be executed with root priviledge. + + + + In the command below ziffy is started and dumps all Z39.50 traffic + on ethernet device eth0 + + + # ziffy -i eth0 + + + + For more information about ziffy refer to the man page ziffy(1) and + the material in sub directory ziffy. + + + + + -- 1.7.10.4