Added documentation about ziffy.
[yaz-moved-to-github.git] / doc / ziffy.xml
1 <!-- $Id: ziffy.xml,v 1.1 2006-12-13 09:40:32 adam Exp $ -->
2  <chapter id="ziffy"><title>ziffy</title>
3   <sect1 id="ziffy.introduction"><title>Introduction</title>
4    <para>
5     ziffy is a promiscuous Z39.50 APDU sniffer, like the popular tcpdump.
6     ziffy can capture and show all Z39.50 traffic on your LAN segment.
7    </para>
8    <para>
9     ziffy is copyright Rocco Carbone and is covered by the GPL. ziffy
10     uses <ulink url="&url.libpcap;">libpcap</ulink> to capture the packages
11     and is part of YAZ 2.1.42 or later.
12     Source and documentation for the ziffy utility is part of the sub
13     directory <filename>ziffy</filename> in the YAZ source package.
14    </para>
15    <para>
16     The ziffy software is also a standalone piece of software and
17     can be obtained separately. The ziffy as part of YAZ, uses
18     YAZ for decoding Z39.50 packages. The standalone version can
19     use different decoders (SNACC and X/ASN.1)
20    </para>
21   </sect1>
22   <sect1 id="ziffy.using"><title>Using Ziffy</title>
23   <para>
24    ziffy must be executed with root priviledge.
25   </para>
26   <example>
27    <para>
28    In the command below ziffy is started and dumps all Z39.50 traffic
29    on ethernet device <literal>eth0</literal>
30    </para>
31    <screen>
32    # ziffy -i eth0
33    </screen>
34    </example>
35    <para>
36     For more information about ziffy refer to the man page ziffy(1) and
37     the material in sub directory <filename>ziffy</filename>.
38    </para>
39  </sect1>
40  </chapter>
41  
42  <!-- Keep this comment at the end of the file
43  Local variables:
44  mode: sgml
45  sgml-omittag:t
46  sgml-shorttag:t
47  sgml-minimize-attributes:nil
48  sgml-always-quote-attributes:t
49  sgml-indent-step:1
50  sgml-indent-data:t
51  sgml-parent-document: "yaz.xml"
52  sgml-local-catalogs: nil
53  sgml-namecase-general:t
54  End:
55  -->