Re-sort documentation
authorWouter Verhelst <w@uter.be>
Fri, 27 May 2011 15:51:11 +0000 (17:51 +0200)
committerWouter Verhelst <w@uter.be>
Fri, 27 May 2011 15:51:11 +0000 (17:51 +0200)
This used to be alphabetically sorted, but wasn't any more. Fix that.

man/nbd-server.5.in.sgml

index 8f06f96..32ce37f 100644 (file)
@@ -287,6 +287,39 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
+        <term><option>flush</option></term>
+       <listitem>
+         <para>Optional; boolean.</para>
+         <para>When this option is enabled,
+           <command>nbd-server</command> will inform the client that it
+           supports and desires to be sent flush requests when the
+           elevator layer receives them. Receipt of a flush request
+           will cause an fdatasync() (or, if the sync option is set,
+           an fsync()) on the backend storage. This increases
+           reliability in the case of an unclean shutdown at
+           the expense of a degradation of performance. This option
+           will have no effect unless supported by the client.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>fua</option></term>
+       <listitem>
+         <para>Optional; boolean.</para>
+         <para>When this option is enabled,
+           <command>nbd-server</command> will inform the client that it
+           supports and desires to be sent fua (force unit access) commands
+           when the elevator layer receives them. Receipt of a force unit
+           access command will cause the specified command to be synced
+           to backend storage using sync_file_range() if supported, or
+           fdatasync() otherwise. This increases
+           reliability in the case of an unclean shutdown at
+           the expense of a degradation of performance. This option
+           will have no effect unless supported by the client.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
        <term>listenaddr</term>
        <listitem>
          <para>
@@ -301,6 +334,16 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
+       <term><option>maxconnections</option></term>
+       <listitem>
+         <para>Optional; integer</para>
+         <para>
+           If specified, then it limits the number of opened connections for
+           this export.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
        <term><option>multifile</option></term>
        <listitem>
          <para>Optional; boolean.</para>
@@ -354,92 +397,67 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term><option>readonly</option></term>
+       <term><option>postrun</option></term>
        <listitem>
-         <para>Optional; boolean.</para>
+         <para>Optional; string</para>
          <para>
-           Disallow writes to the device. If this option is
-           specified, <command>nbd-server</command> will issue an
-           error to any client that tries to write to the device.
+           If specified, then it is assumed to be a command
+           that will be ran when a client has
+           disconnected. This can be useful to clean up
+           whatever <option>prerun</option> has set up, to log
+           something, or similar.
          </para>
          <para>
-           Use of this option in conjunction with
-           <option>copyonwrite</option> is possible, but silly.
+           If the literal string '%s' is present in the
+           command, it will be replaced by the file name that
+           has just been closed.
+         </para>
+         <para>
+           In contrast to the <option>prerun</option> option,
+           the exit state of <option>postrun</option> is
+           <emphasis>ignored</emphasis>.
          </para>
-         <para>Corresponds to the <option>-r</option> option on the
-         command line.</para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term><option>sdp</option></term>
+       <term><option>prerun</option></term>
        <listitem>
-         <para>Optional; boolean.</para>
+         <para>Optional; string</para>
          <para>
-           When this option is enabled, <command>nbd-server</command>
-           will use the Socket Direct Protocol (SDP) to serve the
-           export, rather than just IP. This is faster, but requires
-           special hardware (usually something like InfiniBand) and
-           support in the kernel.
+           If specified, then this command will be ran after a
+           client has connected to the server (and has been
+           accepted), but before the server starts serving. If
+           the command contains the literal string '%s', then
+           this string will be replaced by the filename of the
+           file which nbd-server wants to export.
          </para>
          <para>
-           Additionally, support for this option must be enabled at
-           compile time, using the <option>--enable-sdp</option> option
-           to the <command>configure</command> script. If this option
-           is found in a configuration file and
-           <command>nbd-server</command> does not have support for SDP,
-           then <command>nbd-server</command> will exit with an error
-           message.
+           This is useful to create export files on the fly, or
+           to verify that a file can be used for export, to
+           write something to a log file, or similar.
          </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><option>sync</option></term>
-       <listitem>
-         <para>Optional; boolean.</para>
-         <para>When this option is enabled,
-           <command>nbd-server</command> will call an fsync() after every
-           write to the backend storage. Calling fsync() increases
-           reliability in case of an unclean shutdown of nbd-server; but,
-           depending on the file system used on the nbd-server side, may
-           degrade performance. The use of this option isn't always
-           necessary; e.g., on ext3 filesystems, it is recommended that
-           it is <emphasis>not</emphasis> enabled, since it seriously
-           reduces performance on ext3 filesystems while not
-           importantly impacting reliability.
+         <para>
+           If the command runs with a non-zero exit status,
+           then nbd-server will assume the export will fail,
+           and refuse to serve it.
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
-        <term><option>flush</option></term>
+       <term><option>readonly</option></term>
        <listitem>
          <para>Optional; boolean.</para>
-         <para>When this option is enabled,
-           <command>nbd-server</command> will inform the client that it
-           supports and desires to be sent flush requests when the
-           elevator layer receives them. Receipt of a flush request
-           will cause an fdatasync() (or, if the sync option is set,
-           an fsync()) on the backend storage. This increases
-           reliability in the case of an unclean shutdown at
-           the expense of a degradation of performance. This option
-           will have no effect unless supported by the client.
+         <para>
+           Disallow writes to the device. If this option is
+           specified, <command>nbd-server</command> will issue an
+           error to any client that tries to write to the device.
          </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term><option>fua</option></term>
-       <listitem>
-         <para>Optional; boolean.</para>
-         <para>When this option is enabled,
-           <command>nbd-server</command> will inform the client that it
-           supports and desires to be sent fua (force unit access) commands
-           when the elevator layer receives them. Receipt of a force unit
-           access command will cause the specified command to be synced
-           to backend storage using sync_file_range() if supported, or
-           fdatasync() otherwise. This increases
-           reliability in the case of an unclean shutdown at
-           the expense of a degradation of performance. This option
-           will have no effect unless supported by the client.
+         <para>
+           Use of this option in conjunction with
+           <option>copyonwrite</option> is possible, but silly.
          </para>
+         <para>Corresponds to the <option>-r</option> option on the
+         command line.</para>
        </listitem>
       </varlistentry>
       <varlistentry>
@@ -466,6 +484,28 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
+       <term><option>sdp</option></term>
+       <listitem>
+         <para>Optional; boolean.</para>
+         <para>
+           When this option is enabled, <command>nbd-server</command>
+           will use the Socket Direct Protocol (SDP) to serve the
+           export, rather than just IP. This is faster, but requires
+           special hardware (usually something like InfiniBand) and
+           support in the kernel.
+         </para>
+         <para>
+           Additionally, support for this option must be enabled at
+           compile time, using the <option>--enable-sdp</option> option
+           to the <command>configure</command> script. If this option
+           is found in a configuration file and
+           <command>nbd-server</command> does not have support for SDP,
+           then <command>nbd-server</command> will exit with an error
+           message.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
        <term><option>sparse_cow</option></term>
        <listitem>
          <para>Optional; boolean.</para>
@@ -491,6 +531,23 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
+        <term><option>sync</option></term>
+       <listitem>
+         <para>Optional; boolean.</para>
+         <para>When this option is enabled,
+           <command>nbd-server</command> will call an fsync() after every
+           write to the backend storage. Calling fsync() increases
+           reliability in case of an unclean shutdown of nbd-server; but,
+           depending on the file system used on the nbd-server side, may
+           degrade performance. The use of this option isn't always
+           necessary; e.g., on ext3 filesystems, it is recommended that
+           it is <emphasis>not</emphasis> enabled, since it seriously
+           reduces performance on ext3 filesystems while not
+           importantly impacting reliability.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
        <term><option>timeout</option></term>
        <listitem>
          <para>Optional; integer; default 0</para>
@@ -508,6 +565,30 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
+       <term><option>transactionlog</option></term>
+       <listitem>
+         <para>Optional; string</para>
+         <para>
+           If specified, then this pathname is used to generate a transaction
+           log. A transaction log is a binary file consisting of the requests
+           sent to and the replies received by the server, but excluding any
+           data (so, for a write command, it records the offset and length
+           of the write but not the data written). It is therefore relatively
+           safe to distribute to a third party. Note that the transaction log
+           does not include the negotiation sequence. Transaction logs are
+           mainly useful for debugging. The program
+           <emphasis>nbd-tester-client</emphasis> distributed with the source
+           to this program can reply a transaction log against a server and
+           perform a data integrity test. Note that the transaction log is
+           written to for every client opened. If it is necessary to maintain
+           separate transaction logs for each client, the
+           <emphasis>prerun</emphasis> script should rename the transaction log
+           (which will just have been opened in order to avoid transaction logs
+           overwriting eachother. This action should be race-free.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
        <term><option>virtstyle</option></term>
        <listitem>
          <para>Optional; string; default "ipliteral"</para>
@@ -604,87 +685,6 @@ manpage.1: manpage.sgml
          </variablelist>
        </listitem>
       </varlistentry>
-      <varlistentry>
-       <term><option>prerun</option></term>
-       <listitem>
-         <para>Optional; string</para>
-         <para>
-           If specified, then this command will be ran after a
-           client has connected to the server (and has been
-           accepted), but before the server starts serving. If
-           the command contains the literal string '%s', then
-           this string will be replaced by the filename of the
-           file which nbd-server wants to export.
-         </para>
-         <para>
-           This is useful to create export files on the fly, or
-           to verify that a file can be used for export, to
-           write something to a log file, or similar.
-         </para>
-         <para>
-           If the command runs with a non-zero exit status,
-           then nbd-server will assume the export will fail,
-           and refuse to serve it.
-         </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term><option>postrun</option></term>
-       <listitem>
-         <para>Optional; string</para>
-         <para>
-           If specified, then it is assumed to be a command
-           that will be ran when a client has
-           disconnected. This can be useful to clean up
-           whatever <option>prerun</option> has set up, to log
-           something, or similar.
-         </para>
-         <para>
-           If the literal string '%s' is present in the
-           command, it will be replaced by the file name that
-           has just been closed.
-         </para>
-         <para>
-           In contrast to the <option>prerun</option> option,
-           the exit state of <option>postrun</option> is
-           <emphasis>ignored</emphasis>.
-         </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term><option>maxconnections</option></term>
-       <listitem>
-         <para>Optional; integer</para>
-         <para>
-           If specified, then it limits the number of opened connections for
-           this export.
-         </para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term><option>transactionlog</option></term>
-       <listitem>
-         <para>Optional; string</para>
-         <para>
-           If specified, then this pathname is used to generate a transaction
-           log. A transaction log is a binary file consisting of the requests
-           sent to and the replies received by the server, but excluding any
-           data (so, for a write command, it records the offset and length
-           of the write but not the data written). It is therefore relatively
-           safe to distribute to a third party. Note that the transaction log
-           does not include the negotiation sequence. Transaction logs are
-           mainly useful for debugging. The program
-           <emphasis>nbd-tester-client</emphasis> distributed with the source
-           to this program can reply a transaction log against a server and
-           perform a data integrity test. Note that the transaction log is
-           written to for every client opened. If it is necessary to maintain
-           separate transaction logs for each client, the
-           <emphasis>prerun</emphasis> script should rename the transaction log
-           (which will just have been opened in order to avoid transaction logs
-           overwriting eachother. This action should be race-free.
-         </para>
-       </listitem>
-      </varlistentry>
     </variablelist>
     
   </refsect1>