r290: Reword a troublesome sentence, and document the sdp support
authoryoe <yoe>
Wed, 17 Oct 2007 09:52:50 +0000 (09:52 +0000)
committeryoe <yoe>
Wed, 17 Oct 2007 09:52:50 +0000 (09:52 +0000)
nbd-client.8.sgml
nbd-server.5.sgml

index 7e18e8b..c5bc30d 100644 (file)
@@ -60,6 +60,7 @@ manpage.1: manpage.sgml
       <arg choice=plain><option><replaceable>host</replaceable></option></arg>
       <arg choice=plain><option><replaceable>port</replaceable></option></arg>
       <arg choice=plain><option><replaceable>nbd-device</replaceable></option></arg>
+      <arg><optoin>-sdp</option></arg>
       <arg><option>-swap</option></arg>
       <arg><option>-persist</option></arg>
     </cmdsynopsis>
@@ -118,6 +119,13 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
+        <term><option>-sdp</option></term>
+       <listitem>
+         <para>Connect to the server using the Socket Direct Protocol
+           (SDP), rather than IP. See nbd-server(1) for details.
+         </para>
+       </listitem>
+      <varlistentry>
        <term><option>-swap</option></term>
        <listitem>
          <para>Specifies that this NBD device will be used as
index d38adc5..fea56cf 100644 (file)
@@ -63,10 +63,10 @@ manpage.1: manpage.sgml
     <para><command>&dhpackage;</command> allows to configure the
     nbd-server.</para>
 
-    <para>The default configuration file is
-      <filename>@sysconfdir@/nbd-server/config</filename>, but this
-      can be varied with the <option>-C</option> option to
-      <command>nbd-server</command>(1).
+    <para>While
+      <filename>@sysconfdir@/nbd-server/config</filename> is the default
+      configuration file, this can be varied with the <option>-C</option>
+      option to <command>nbd-server</command>(1).
     </para>
     <para>
       The configuration file consists of section header lines, comment
@@ -312,6 +312,27 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
+        <term><option>sdp</option></term>
+       <lisitem>
+         <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>
        <term><option>sparse_cow</option></term>
        <listitem>
          <para>Optional; boolean.</para>