~ubuntu-branches/ubuntu/precise/nbd/precise-security

« back to all changes in this revision

Viewing changes to man/nbd-trdump.1.in.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Stéphane Graber
  • Date: 2011-06-21 19:17:59 UTC
  • mfrom: (1.1.17 upstream) (21.1.22 sid)
  • Revision ID: james.westby@ubuntu.com-20110621191759-5p1y2yyfat280oni
Tags: 1:2.9.22-1ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Use clean upstream tarball (nbd-2.9.22.tar.gz).
  - Drop /etc/modprobe.d/nbd-client; the kernel default is already
    appropriate. Ubuntu-specific change.
    + Modify debian/nbd-client.dirs
    + Remove debian/nbd-client.modprobe
    + Add debian/nbd-client.preinst

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>H</option></term>
 
91
        <listitem>
 
92
          <para>The handle of the packet.</para>
 
93
        </listitem>
 
94
      </varlistentry>
 
95
      <varlistentry>
 
96
        <term><option>C</option></term>
 
97
        <listitem>
 
98
          <para>The command sent.</para>
 
99
        </listitem>
 
100
      </varlistentry>
 
101
      <varlistentry>
 
102
        <term><option>O</option></term>
 
103
        <listitem>
 
104
          <para>The offet from the start of the disk.</para>
 
105
        </listitem>
 
106
      </varlistentry>
 
107
      <varlistentry>
 
108
        <term><option>L</option></term>
 
109
        <listitem>
 
110
          <para>The length of data.</para>
 
111
        </listitem>
 
112
      </varlistentry>
 
113
      <varlistentry>
 
114
        <term><option>E</option></term>
 
115
        <listitem>
 
116
          <para>The error returned.</para>
 
117
        </listitem>
 
118
      </varlistentry>
 
119
    </variablelist>
 
120
  </refsect1>
 
121
  <refsect1>
 
122
    <title>SEE ALSO</title>
 
123
 
 
124
    <para>nbd-server (1).</para>
 
125
 
 
126
  </refsect1>
 
127
  <refsect1>
 
128
    <title>AUTHOR</title>
 
129
    <para>The NBD kernel module and the NBD tools have been written by
 
130
    Pavel Macheck (pavel@ucw.cz).</para>
 
131
 
 
132
    <para>The kernel module is now maintained by Paul Clements
 
133
    (Paul.Clements@steeleye.com), while the userland tools are maintained by
 
134
    Wouter Verhelst (wouter@debian.org)</para>
 
135
 
 
136
    <para>This manual page was written by &dhusername; (&dhemail;) for
 
137
    the &debian; system (but may be used by others).  Permission is
 
138
    granted to copy, distribute and/or modify this document under the
 
139
    terms of the <acronym>GNU</acronym> General Public License,
 
140
    version 2, as published by the Free Software Foundation.</para>
 
141
 
 
142
  </refsect1>
 
143
</refentry>