r296: Documentation updates

[nbd.git] / nbd-server.1.sgml

diff --git a/nbd-server.1.sgml b/nbd-server.1.sgml
index d79608d..266ae43 100644 (file)
--- a/nbd-server.1.sgml
+++ b/nbd-server.1.sgml
@@ -57,7 +57,7 @@ manpage.1: manpage.sgml
     <cmdsynopsis>
       <command>&dhpackage; </command>
 
-      <arg choice=plain><replaceable>port</replaceable</arg>
+      <arg choice=plain><replaceable>[ip:]port</replaceable</arg>
       <arg choice=plain><replaceable>filename</replaceable></arg>
       <arg><replaceable>size</replaceable></arg>
       <arg><option>-r</option></arg>
@@ -65,6 +65,7 @@ manpage.1: manpage.sgml
       <arg><option>-c</option></arg>
       <arg><option>-a <replaceable>timeout</replaceable></option></arg>
       <arg><option>-l <replaceable>host list</replaceable></option></arg>
+      <arg><option>-o <replaceable>section name</replaceable></option></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
   <refsect1>
@@ -91,6 +92,13 @@ manpage.1: manpage.sgml
     
     <variablelist>
       <varlistentry>
+       <term>ip</term>
+       <listitem>
+         <para>The ip address the server should listen on. If
+         omitted, 0.0.0.0 (aka "any address") is used.</para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
         <term><option>port</option>
         </term>
         <listitem>
@@ -203,6 +211,17 @@ manpage.1: manpage.sgml
            root-directory.</para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><option>section name</option></term>
+       <listitem>
+         <para>If the <option>-o</option> argument is given on the
+         command line, then &dhpackage; will output a configuration
+         file section with this as the header that is functionally
+         equivalent to the other options specified on the command line,
+         and exit. This is useful for migrating pre-2.9 nbd-server
+         initscript configuration files to the new format.</para>
+       </listitem>
+      </varlistentry>
     </variablelist>
     
   </refsect1>