Oops

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

diff --git a/nbd-server.1.sgml b/nbd-server.1.sgml
index 81b235a..008176d 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>[ip:]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>
@@ -86,6 +86,11 @@ 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>
@@ -94,8 +99,18 @@ manpage.1: manpage.sgml
       <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>
+         <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>
@@ -183,6 +198,11 @@ 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>