X-Git-Url: http://git.alex.org.uk diff --git a/nbd-server.1.sgml b/nbd-server.1.sgml index f2de5cf..c9190b0 100644 --- a/nbd-server.1.sgml +++ b/nbd-server.1.sgml @@ -13,7 +13,7 @@ manpage.1: manpage.sgml Wouter"> Verhelst"> - september 19, 2001"> + $Date$"> 1"> @@ -55,27 +55,22 @@ manpage.1: manpage.sgml - &dhpackage; + &dhpackage; - port + [ip@]port filename size - - + + + DESCRIPTION - This manual page documents the - &dhpackage; command. - - This manual page was written for the &debian; distribution - because the original program does not have a manual page. - &dhpackage; is the server for the Linux Network Block Device (NBD). With NBD, a client can use a file, exported over the network from a server, as a block device. It can @@ -87,24 +82,48 @@ manpage.1: manpage.sgml were a local filesystem. &dhpackage; implements some security - through a file called "nbd_server.allow" in the current directory. - 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. + through a file called "@sysconfdir@/nbd-server/allow" (by default; a + different file can be chosen with the '-l' option or through a + config file specification). This file must list the IP-addresses or + network masks 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. + + 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). OPTIONS - - - - The port the server should listen to. A valid port is + ip + + 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. + 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 ::. + + + + + + + The port the server should listen to. A valid port is any number between 1 and 65536; if 0 is used, nbd-server will listen on stdin (so that nbd-server can be ran from inetd) - + @@ -120,7 +139,7 @@ manpage.1: manpage.sgml The size of the block device at the client side. This - is especially usefull in conjunction with the -m + is especially useful in conjunction with the -m option Can optionally be followed by one of K,k,M or m, in which case the size will be multiplied by 1024 (K @@ -145,48 +164,76 @@ manpage.1: manpage.sgml Linux 2.2 and below), you can use this option to store the data in multiple files and export a larger filesystem, if needed. + + 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. + + + Allowing more flexibility for this option is planned for + future versions. Copy on write. When this option is provided, - write-operations are not done to the exported file, but to a - separate file. This separate file is removed when the - connection is closed, which means that serving this way will - make nbd-server slow down (especially on large block devices - with lots of writes), and that after disconnecting and - reconnecting the client or the server, all changes are - lost. + write-operations are not done to the exported file, but to a + separate file. This separate file is removed when the + connection is closed, which means that serving this way will + make nbd-server slow down (especially on large block devices + with lots of writes), and that after disconnecting and + reconnecting the client or the server, all changes are + lost. - + - 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. + Specify configuration file. The default configuration + file, if this parameter is not specified, is + @sysconfdir@/nbd-server/config. + Note that the configuration file is always parsed and + the entries in the file used, even if an extra server is + specified on the command line. To disable the configuration + file entirely, either move it away or use the -C option to + point nbd-server(1) to a non-existing or + empty configuration file. + 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. - + This argument should contain a list of IP-addresses - for hosts that may connect to the server. Wildcards are - not 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. + for hosts that may connect to the server. Wildcards are + not 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. + + + + + + If the 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. - - - + EXAMPLES @@ -205,25 +252,30 @@ manpage.1: manpage.sgml changes are lost after restarting the client or the server: nbd-server 2000 /export/nbd/exp-bl-dev - -c + -c SEE ALSO - - nbd-client (8). - + + nbd-client (8), nbd-server (5), http://nbd.sourceforge.net/roadmap.html + AUTHOR The NBD kernel module and the NBD tools were originally written by Pavel Machek (pavel@ucw.cz) - - The kernel module is now maintained by Paul Clements + + The Linux kernel module is now maintained by Paul Clements (Paul.Clements@steeleye.com), while the userland tools are maintained by &dhusername; (&dhemail;) + On The Hurd there is a regular translator available to perform the + client side of the protocol, and the use of + nbd-client is not required. Please see the + relevant documentation for more information. + 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 @@ -232,20 +284,3 @@ manpage.1: manpage.sgml - -