r25: * Added Large File Support to nbd-server.

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

diff --git a/nbd-server.1.sgml b/nbd-server.1.sgml
index efca0d7..3822aaf 100644 (file)
--- a/nbd-server.1.sgml
+++ b/nbd-server.1.sgml
@@ -50,19 +50,20 @@ manpage.1: manpage.sgml
     <refname>&dhpackage;</refname>
 
     <refpurpose>serve a file as a block device to other computers
-    running the Linux(tm) Operating System</refpurpose>
+    running the &gnu;/Linux(tm) or &gnu;/Hurd Operating
+    System</refpurpose>
   </refnamediv>
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>&dhpackage;</command>
 
-      <arg><option>-c <replaceable>this</replaceable></option></arg>
       <arg choice=plain><replaceable>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>
     </cmdsynopsis>
   </refsynopsisdiv>
   <refsect1>
@@ -80,7 +81,7 @@ manpage.1: manpage.sgml
     then be used for whatever purpose a normal block device (harddisk,
     CD-ROM, ...) can be used for.</para>
 
-    <para>NBD can be usefull for diskless clients that need swapspace,
+    <para>NBD can be useful for diskless clients that need swapspace,
     but you can also create a filesystem on it and use it as though it
     were a local filesystem.</para>
 
@@ -158,6 +159,15 @@ manpage.1: manpage.sgml
          lost.</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>
     </variablelist>
   </refsect1>
   <refsect1>
@@ -183,8 +193,18 @@ manpage.1: manpage.sgml
   </refsect1>
   <refsect1>
     <title>FILES</title>
-
-    <para><filename>nbd_server.allow</filename></para>
+    
+    <variablelist>
+      <varlistentry>
+       <term><filename>nbd_server.allow</filename></term>
+       <listitem>
+         <para>This file, which must be in the directory where
+         nbd-server is invoked, can contain a list of IP-addresses
+         for hosts that may connect to the server. Wildcards are
+         <b>not</b> allowed.
+       </listitem>
+      </varlistentry>
+    </variablelist>
 
   </refsect1>
   <refsect1>
@@ -195,6 +215,8 @@ manpage.1: manpage.sgml
   </refsect1>
   <refsect1>
     <title>AUTHOR</title>
+    <para>The NBD kernel module and the NBD tools were written by
+      Pavel Machek (pavel@ucw.cz)</para>
 
     <para>This manual page was written by &dhusername; (&dhemail;) for
       the &debian; system (but may be used by others).  Permission is