Documentation update

[nbd.git] / nbd-client.8.sgml

diff --git a/nbd-client.8.sgml b/nbd-client.8.sgml
index 25c23af..635fc23 100644 (file)
--- a/nbd-client.8.sgml
+++ b/nbd-client.8.sgml
@@ -63,11 +63,16 @@ manpage.1: manpage.sgml
       <arg><option>-sdp</option></arg>
       <arg><option>-swap</option></arg>
       <arg><option>-persist</option></arg>
+      <arg><option>-nofork</option></arg>
     </cmdsynopsis>
     <cmdsynopsis>
       <command>&dhpackage;</command>
       <arg choice=plain><option>-d <replaceable>nbd-device</replaceable></option></arg>
     </cmdsynopsis>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <arg choice="plain"><option>-c <replaceable>nbd-device</replaceable></option></arg>
+    </cmdsynopsis>
   </refsynopsisdiv>
   <refsect1>
     <title>DESCRIPTION</title>
@@ -100,8 +105,9 @@ manpage.1: manpage.sgml
       <varlistentry>
        <term><option>host</option></term>
        <listitem>
-         <para>The hostname of the machine running
-           <command>nbd-server</command>.</para>
+         <para>The hostname or IP address of the machine running
+           <command>nbd-server</command>. Since 2.9.15, the NBD
+           utilities support IPv6.</para>
        </listitem>
       </varlistentry>
       <varlistentry>
@@ -128,6 +134,22 @@ manpage.1: manpage.sgml
        </listitem>
       </varlistentry>
       <varlistentry>
+       <term>-c</term>
+       <listitem>
+         <para>Check whether the specified nbd device is
+         connected.</para>
+         <para>If the device is connected, &dhpackage; will exit
+         with an exit state of 0 and print the PID of the &dhpackage;
+         instance that connected it to stdout.
+         <para>If the device is not
+         connected or does not exist (for example because the nbd
+         module was not loaded), &dhpackage; will exit with an exit
+         state of 1 and not print anything on stdout.</para>
+         <para>If an error occurred, &dhpackage; will exit with an exit
+         state of 2, and not print anything on stdout either.</para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
        <term>-d</term>
        <listitem>
          <para>Disconnect the specified nbd device from the
@@ -155,12 +177,17 @@ manpage.1: manpage.sgml
        <term><option>-swap</option></term>
        <listitem>
          <para>Specifies that this NBD device will be used as
-           swapspace. If you intend to do that, please use this
-           option to prevent deadlocks. You'll need a special kernel
-           patch, available at NBD's homepage:
-           http://atrey.karlin.mff.cuni.cz/~pavel</para>
+         swapspace. This option attempts to prevent deadlocks by
+         performing mlockall() at an appropriate time. It does not
+         however guarantee that such deadlocks can be avoided.</para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>-nofork</option></term>
+       <listitem>
+         <para>Specifies that the NBD client should not detach and
+         daemonize itself. This is mostly useful for debugging.</para>
+      </varlistentry>
     </variablelist>
   </refsect1>
   <refsect1>