man/nbd-trdump.1.sgml.in

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN" [
   2
   3 <!-- Process this file with docbook-to-man to generate an nroff manual
   4      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
   5      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
   6      less'.  A typical entry in a Makefile or Makefile.am is:
   7
   8 manpage.1: manpage.sgml
   9         docbook-to-man $< > $@
  10   -->
  11
  12   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  13   <!ENTITY dhfirstname "<firstname>Wouter</firstname>">
  14   <!ENTITY dhsurname   "<surname>Verhelst</surname>">
  15   <!-- Please adjust the date whenever revising the manpage. -->
  16   <!ENTITY dhdate      "<date>$Date$</date>">
  17   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  18        allowed: see man(7), man(1). -->
  19   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  20   <!ENTITY dhemail     "<email>wouter@debian.org</email>">
  21   <!ENTITY dhusername  "Wouter Verhelst">
  22   <!ENTITY dhucpackage "<refentrytitle>nbd-trdump</refentrytitle>">
  23   <!ENTITY dhpackage   "nbd-trdump">
  24
  25   <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  26   <!ENTITY gnu         "<acronym>GNU</acronym>">
  27 ]>
  28
  29 <refentry>
  30   <refentryinfo>
  31     <address>
  32       &dhemail;
  33     </address>
  34     <author>
  35       &dhfirstname;
  36       &dhsurname;
  37     </author>
  38     <copyright>
  39       <year>2001</year>
  40       <holder>&dhusername;</holder>
  41     </copyright>
  42     &dhdate;
  43   </refentryinfo>
  44   <refmeta>
  45     &dhucpackage;
  46
  47     &dhsection;
  48   </refmeta>
  49   <refnamediv>
  50     <refname>&dhpackage;</refname>
  51
  52     <refpurpose>translate an nbd transaction log into human readable form</refpurpose>
  53   </refnamediv>
  54   <refsynopsisdiv>
  55     <cmdsynopsis>
  56       <command>&dhpackage;</command>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59   <refsect1>
  60     <title>DESCRIPTION</title>
  61
  62     <para><command>&dhpackage;</command> translates
  63     a transaction log produced by <command>nbd-server</command>
  64     (specifically by the <command>transactionlog</command>
  65     configuration directive) into human readable form.</para>
  66
  67     <para>The command acts as a traditional UNIX filter, i.e. the
  68     transaction log must be supplied on standard input, and the
  69     human readable output is sent to standard output.</para>
  70   </refsect1>
  71   <refsect1>
  72     <title>OUTPUT</title>
  73
  74     <para>The following may be output:</para>
  75
  76     <variablelist>
  77       <varlistentry>
  78         <term><option>&gt;</option></term>
  79         <listitem>
  80           <para>A request packet sent from the client to the server.</para>
  81         </listitem>
  82       </varlistentry>
  83       <varlistentry>
  84         <term><option>&lt;</option></term>
  85         <listitem>
  86           <para>A reply packet sent from the server to the client.</para>
  87         </listitem>
  88       </varlistentry>
  89       <varlistentry>
  90         <term><option>&lt;S</option></term>
  91         <listitem>
  92           <para>A structured reply packet sent from the server to the client.</para>
  93          </listitem>
  94       </varlistentry>
  95       <varlistentry>
  96         <term><option>H</option></term>
  97         <listitem>
  98           <para>The cookie of the packet. Note: previous versions of
  99           this man page (and the NBD spec) referred to the cookie as the
 100           "handle".</para>
 101         </listitem>
 102       </varlistentry>
 103       <varlistentry>
 104         <term><option>C</option></term>
 105         <listitem>
 106           <para>The command sent.</para>
 107         </listitem>
 108       </varlistentry>
 109       <varlistentry>
 110         <term><option>O</option></term>
 111         <listitem>
 112           <para>The offet from the start of the disk.</para>
 113         </listitem>
 114       </varlistentry>
 115       <varlistentry>
 116         <term><option>L</option></term>
 117         <listitem>
 118           <para>The length of data.</para>
 119         </listitem>
 120       </varlistentry>
 121       <varlistentry>
 122         <term><option>E</option></term>
 123         <listitem>
 124           <para>The error returned.</para>
 125         </listitem>
 126       </varlistentry>
 127       <varlistentry>
 128         <term><option>T</option></term>
 129         <listitem>
 130           <para>The type of the structured reply message.</para>
 131         </listitem>
 132       </varlistentry>
 133       <varlistentry>
 134         <term><option>F</option></term>
 135         <listitem>
 136           <para>The flags on the structured reply message.</para>
 137         </listitem>
 138       </varlistentry>
 139     </variablelist>
 140   </refsect1>
 141   <refsect1>
 142     <title>SEE ALSO</title>
 143
 144     <para>nbd-server (1).</para>
 145
 146   </refsect1>
 147   <refsect1>
 148     <title>AUTHOR</title>
 149     <para>The NBD kernel module and the NBD tools have been written by
 150     Pavel Macheck (pavel@ucw.cz).</para>
 151
 152     <para>The kernel module is now maintained by Paul Clements
 153     (Paul.Clements@steeleye.com), while the userland tools are maintained by
 154     Wouter Verhelst (wouter@debian.org)</para>
 155
 156     <para>This manual page was written by &dhusername; (&dhemail;) for
 157     the &debian; system (but may be used by others).  Permission is
 158     granted to copy, distribute and/or modify this document under the
 159     terms of the <acronym>GNU</acronym> General Public License,
 160     version 2, as published by the Free Software Foundation.</para>
 161
 162   </refsect1>
 163 </refentry>