<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>
+ <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>
+ <arg><option>-l <replaceable>host list</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
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>
<para><command>&dhpackage;</command> implements some security
- through a file called "nbd_server.allow" in the current directory.
+ through a file called "nbd_server.allow" in the current directory (by default; a different file can be chosen with the '-l' option).
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>
Linux 2.2 and below), you can use this option to store the
data in multiple files and export a larger filesystem, if
needed.</para>
+ <para>
+ To use this option, you must create a number of files
+ with names in the format "name.X", where "name" is given as
+ the filename argument to nbd-server, and "X" is a number
+ 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>
</varlistentry>
<varlistentry>
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>
+ <varlistentry>
+ <term><option>host list</option></term>
+ <listitem>
+ <para>This argument should contain a list of IP-addresses
+ for hosts that may connect to the server. Wildcards are
+ <emphasis>not</emphasis> allowed. If the file does not
+ exist, it is ignored (and any host can connect); If the file
+ does exist, but is empty, no host can connect. By default,
+ the name 'nbd_server.allow' is used, and looked for in the
+ current directory, unless nbd-server is compiled as a
+ daemon, in which case it is looked for in the
+ root-directory.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
+
</refsect1>
<refsect1>
<title>EXAMPLES</title>
</itemizedlist>
</refsect1>
<refsect1>
- <title>FILES</title>
-
- <para><filename>nbd_server.allow</filename></para>
-
- </refsect1>
- <refsect1>
<title>SEE ALSO</title>
- <para>nbd-client (8).</para>
+ <para>nbd-client (8), http://nbd.sourceforge.net/roadmap.html</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
+ <para>The NBD kernel module and the NBD tools were originally
+ written by Pavel Machek (pavel@ucw.cz)</para>
+
+ <para>The kernel module is now maintained by Paul Clements
+ (Paul.Clements@steeleye.com), while the userland tools are
+ maintained by &dhusername; (&dhemail;)</para>
<para>This manual page was written by &dhusername; (&dhemail;) for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
- the terms of the <acronym>GNU</acronym> Free Documentation
- License, Version 1.1 or any later version published by the Free
- Software Foundation; with no Invariant Sections, no Front-Cover
- Texts and no Back-Cover Texts.</para>
+ the terms of the <acronym>GNU</acronym> General Public License,
+ version 2, as published by the Free Software Foundation.</para>
</refsect1>
</refentry>
projects / nbd.git / blobdiff