Oops

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

diff --git a/nbd-server.1.sgml b/nbd-server.1.sgml
index 95ff412..008176d 100644 (file)
--- a/nbd-server.1.sgml
+++ b/nbd-server.1.sgml
@@ -57,15 +57,15 @@ 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>
       <arg><option>-m</option></arg>
       <arg><option>-c</option></arg>
-      <arg><option>-a <replaceable>timeout</replaceable></option></arg>
-      <arg><option>-l <replaceable>host list</replaceable></option></arg>
+      <arg><option>-l <replaceable>host list filename</replaceable></option></arg>
       <arg><option>-o <replaceable>section name</replaceable></option></arg>
+      <arg><option>-C <replaceable>config file</replaceable></option></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
   <refsect1>
@@ -86,12 +86,34 @@ manpage.1: manpage.sgml
     This file must list the IP-addresses of clients that are allowed
     to connect. If it does not exist, all clients are able to connect.
     If the file is empty, no clients can connect.</para>
+
+    <para>Note that while the command line allows for specifying an
+    export, the use of this option is deprecated. It is preferred to
+    make use of a configuration file instead, the format of which is
+    defined in nbd-server(5).</para>
   </refsect1>
   <refsect1>
     <title>OPTIONS</title>
     
     <variablelist>
       <varlistentry>
+       <term>ip</term>
+       <listitem>
+         <para>The ip address the server should listen on. This may
+         be an IPv4 address, an IPv6 address, or a hostname. In the
+         latter case, nbd-server will do a hostname lookup for the
+         name specified, and will listen on the first address that is
+         returned. For compatibility with past versions of
+         nbd-server, if an IPv4 address is specified, the @ sign that
+         serves as separator between the address and port may be
+         replaced by a colon.</para>
+         <para>If this parameter is not specified, nbd-server will
+         listen on all local addresses on both IPv4 and IPv6. To
+         limit to IPv4, specify the address as 0.0.0.0; to limit to
+         IPv6, specify it as ::.</para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
         <term><option>port</option>
         </term>
         <listitem>
@@ -147,9 +169,6 @@ manpage.1: manpage.sgml
            starting by 0 and going up for each file.
          </para>
          <para>
-           The files must all be 1GB in size.
-         </para>
-         <para>
            Allowing more flexibility for this option is planned for
            future versions.</para>
        </listitem>
@@ -179,19 +198,15 @@ manpage.1: manpage.sgml
            file entirely, either move it away or use the -C option to
            point <command>nbd-server</command>(1) to a non-existing or
            empty configuration file.</para>
+         <para>Also note that if an empty, incomplete, or invalid
+           configuration file is specified, nbd-server will produce a
+           warning about failure to parse the config file. If the
+           command line contains a fully specified configuration, this
+           warning is harmless and may be ignored.</para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term><option>timeout</option></term>
-       <listitem>
-         <para>Maximum number of idle seconds. If a connection is
-           inactive for this amount of time, it is terminated; this is to
-           avoid stale nbd-server processes staying in memory. Use of
-           this option is strongly recommended.</para>
-       </listitem>
-      </varlistentry>
-      <varlistentry>
-       <term><option>host list</option></term>
+       <term><option>host list filename</option></term>
        <listitem>
          <para>This argument should contain a list of IP-addresses
            for hosts that may connect to the server. Wildcards are