From: Laurent Vivier Date: Fri, 27 Aug 2010 18:48:17 +0000 (+0200) Subject: Move man files to man/ X-Git-Url: http://git.alex.org.uk Move man files to man/ Signed-off-by: Laurent Vivier --- diff --git a/Makefile.am b/Makefile.am index fed359c..8baffcb 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,5 @@ -bin_PROGRAMS = nbd-server +SUBDIRS = man +bin_PROGRAMS = nbd-server @NBD_CLIENT_NAME@ EXTRA_PROGRAMS = nbd-client knbd-client TESTS_ENVIRONMENT=$(srcdir)/simple_test TESTS = cmd cfg1 cfgmulti cfgnew @@ -11,18 +12,7 @@ nbd_server_CFLAGS = @CFLAGS@ @GLIB_CFLAGS@ nbd_tester_client_CFLAGS = @CFLAGS@ @GLIB_CFLAGS@ nbd_server_LDADD = @GLIB_LIBS@ nbd_tester_client_LDADD = @GLIB_LIBS@ -man_MANS = nbd-server.1 nbd-server.5 nbd-client.8 -EXTRA_DIST = nbd-client.8.sgml nbd-server.1.sgml nbd-server.5.sgml gznbd simple_test -MAINTAINERCLEANFILES = nbd-client.8 nbd-server.1 nbd-server.5 -nbd-server.1.in: $(srcdir)/nbd-server.1.sgml - LC_ALL=C docbook2man nbd-server.1.sgml - mv NBD-SERVER.1 nbd-server.1.in -nbd-client.8.in: $(srcdir)/nbd-client.8.sgml - LC_ALL=C docbook2man nbd-client.8.sgml - mv NBD-CLIENT.8 nbd-client.8.in -nbd-server.5.in: $(srcdir)/nbd-server.5.sgml - LC_ALL=C docbook2man nbd-server.5.sgml - mv NBD-SERVER.5 nbd-server.5.in +EXTRA_DIST = gznbd simple_test dist-hook: rm -Rf `find $(distdir) -name '.svn' -type d -print` cmd: diff --git a/autogen.sh b/autogen.sh index 7f8a2d3..f18bd5e 100755 --- a/autogen.sh +++ b/autogen.sh @@ -1,4 +1,4 @@ #!/bin/sh set -ex -srcdir=. make -f Makefile.am nbd-server.1.in nbd-server.5.in nbd-client.8.in +make -C man -f Makefile.am infiles exec autoreconf -f -i diff --git a/configure.ac b/configure.ac index 47ac117..78b0fc0 100644 --- a/configure.ac +++ b/configure.ac @@ -98,11 +98,14 @@ AC_FUNC_FORK AC_FUNC_SETVBUF_REVERSED AC_MSG_CHECKING(whether client should be built) case $host_os in - linux*) sbin_PROGRAMS="$sbin_PROGRAMS nbd-client" - AC_MSG_RESULT(yes) - ;; - *) AC_MSG_RESULT(no) ;; + linux*) NBD_CLIENT_NAME="nbd-client" + AC_MSG_RESULT(yes) + ;; + *) NBD_CLIENT_NAME="" + AC_MSG_RESULT(no) + ;; esac +AC_SUBST(NBD_CLIENT_NAME) AC_SEARCH_LIBS(bind, socket,, AC_MSG_ERROR([Could not find an implementation of the bind() system call])) AC_SEARCH_LIBS(inet_ntoa, nsl,, AC_MSG_ERROR([Could not find an implementation of the inet_ntoa() system call])) AC_SEARCH_LIBS(daemon, resolv,, AC_MSG_ERROR([Could not find an implementation of the daemon() system call])) @@ -114,10 +117,9 @@ AM_PATH_GLIB_2_0(2.6.0, [HAVE_GLIB=yes], AC_MSG_ERROR([Missing glib])) AC_HEADER_SYS_WAIT AC_TYPE_OFF_T AC_TYPE_PID_T -AC_SUBST(sbin_PROGRAMS) nbd_server_CPPFLAGS=$nbd_server_CPPFLAGS" -DSYSCONFDIR='\"$sysconfdir\"'" AC_SUBST(nbd_server_CPPFLAGS) AC_CONFIG_HEADERS([config.h]) -AC_CONFIG_FILES([Makefile Doxyfile nbd-server.1 nbd-server.5 nbd-client.8]) +AC_CONFIG_FILES([Makefile Doxyfile man/Makefile man/nbd-client.8 man/nbd-server.5 man/nbd-server.1]) AC_OUTPUT diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..c10ec13 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,16 @@ +man_MANS = nbd-server.1 nbd-server.5 nbd-client.8 +CLEANFILES = manpage.links manpage.refs +MAINTAINERCLEANFILES = nbd-server.1 nbd-client.8 nbd-server.5 +EXTRA_DIST = nbd-server.1.in.sgml nbd-client.8.in.sgml nbd-server.5.in.sgml + +infiles: nbd-server.1.in nbd-client.8.in nbd-server.5.in + +nbd-server.1.in: nbd-server.1.in.sgml + LC_ALL=C docbook2man nbd-server.1.in.sgml + mv NBD-SERVER.1 nbd-server.1.in +nbd-client.8.in: nbd-client.8.in.sgml + LC_ALL=C docbook2man nbd-client.8.in.sgml + mv NBD-CLIENT.8 nbd-client.8.in +nbd-server.5.in: nbd-server.5.in.sgml + LC_ALL=C docbook2man nbd-server.5.in.sgml + mv NBD-SERVER.5 nbd-server.5.in diff --git a/man/nbd-client.8.in.sgml b/man/nbd-client.8.in.sgml new file mode 100644 index 0000000..af19bbc --- /dev/null +++ b/man/nbd-client.8.in.sgml @@ -0,0 +1,271 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + --> + + + Wouter"> + Verhelst"> + + $Date$"> + + 8"> + wouter@debian.org"> + + NBD-CLIENT"> + + + Debian GNU/Linux"> + GNU"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2001 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + connect to a server running nbd-server(1), to use its + exported block device + + + + &dhpackage; + host + port + nbd-device + -sdp + -swap + -persist + -nofork + -block-size block size + -timeout seconds + -name name + + + &dhpackage; + + + + &dhpackage; + + + + + DESCRIPTION + + With &dhpackage;, you can connect to a + server running nbd-server, thus using raw + diskspace from that server as a blockdevice on the local + client. + + To do this, support from the Linux Kernel is necessary, in + the form of the Network Block Device (NBD). When you have that, + either in the kernel, or as a module, you can connect to an NBD + server and use its exported file through a block special file with + major mode 43. + + Optionally, long options can also be specified with two + leading dashes. + + + OPTIONS + + The following options are supported: + + + + + + + Use a blocksize of "block size". Default is 1024; + allowed values are either 512, 1024, 2048 or 4096 + + + + + + The hostname or IP address of the machine running + nbd-server. Since 2.9.15, the NBD + utilities support IPv6. + + + + + + + Set the connection timeout to "seconds". For this to + work, you need a kernel with support for the NBD_SET_TIMEOUT + ioctl; this was introduced into Linus' tree on 2007-10-11, + and will be part of kernel 2.6.24. + + + + + + The TCP port on which nbd-server is + running at the server. + This option is required, unless the -N option is + specified, in which case it is not allowed. + + + + + + The block special file this nbd-client should connect + to. + + + + + + + Check whether the specified nbd device is + connected. + If the device is connected, &dhpackage; will exit + with an exit state of 0 and print the PID of the &dhpackage; + instance that connected it to stdout. + If the device is not + connected or does not exist (for example because the nbd + module was not loaded), &dhpackage; will exit with an exit + state of 1 and not print anything on stdout. + If an error occurred, &dhpackage; will exit with an exit + state of 2, and not print anything on stdout either. + + + + + + + Disconnect the specified nbd device from the + server + + + + + + + When this option is specified, &dhpackage; will + immediately try to reconnect an nbd device if the + connection ever drops unexpectedly due to a lost + server or something similar. + + + + + + + Connect to the server using the Socket Direct Protocol + (SDP), rather than IP. See nbd-server(1) for details. + + + + + + + + Specifies that this NBD device will be used as + swapspace. This option attempts to prevent deadlocks by + performing mlockall() at an appropriate time. It does not + however guarantee that such deadlocks can be avoided. + + + + + + + Specifies that the NBD client should not detach and + daemonize itself. This is mostly useful for debugging. + + Note that nbd-client will still fork once to trigger an + update to the device node's partition table. It is not + possible to disable this. + + + + + + + + + Specifies the name of the export that we want to use. Required if + the port is not specified, not allowed in the other case. + + + + + + + EXAMPLES + + Some examples of nbd-client usage: + + + To connect to a server running on port 2000 at host + "server.domain.com", using the client's block special file + "/dev/nbd0": + nbd-client server.domain.com 2000 + /dev/nbd0 + + + To connect to a server running on port 2001 at host + "swapserver.domain.com", using the client's block special + file "/dev/nbd1", for swap purposes: + nbd-client swapserver.domain.com 2001 /dev/nbd1 + -swap + + + To disconnect the above connection again (after making + sure the block special file is not in use anymore): + nbd-client -d /dev/nbd1 + + + + + SEE ALSO + + nbd-server (1). + + + + AUTHOR + The NBD kernel module and the NBD tools have been written by + Pavel Macheck (pavel@ucw.cz). + + The kernel module is now maintained by Paul Clements + (Paul.Clements@steeleye.com), while the userland tools are maintained by + Wouter Verhelst (wouter@debian.org) + + 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 GNU General Public License, + version 2, as published by the Free Software Foundation. + + + diff --git a/man/nbd-server.1.in.sgml b/man/nbd-server.1.in.sgml new file mode 100644 index 0000000..c9190b0 --- /dev/null +++ b/man/nbd-server.1.in.sgml @@ -0,0 +1,286 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + --> + + + Wouter"> + Verhelst"> + + $Date$"> + + 1"> + wouter@debian.org"> + + NBD-SERVER"> + + + Debian GNU/Linux"> + GNU"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2001 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + serve a file as a block device to other computers + running the &gnu;/Linux(tm) or &gnu;/Hurd Operating + System + + + + &dhpackage; + + [ip@]port + filename + size + + + + + + + + + + DESCRIPTION + + &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 + then be used for whatever purpose a normal block device (harddisk, + CD-ROM, ...) can be used for. + + 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. + + &dhpackage; implements some security + 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 + + + + 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) + + + + + + The filename of the file that should be exported. This + can be any file, including "real" blockdevices (i.e. a file + from /dev). If the filename includes the literal string + "%s", then this %s will be substituded with the IP-address + of the client trying to connect. + + + + + + The size of the block device at the client side. This + 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 + or k) or 1048576 (M or m) + + + + + + Export the file read-only. If a client tries to write + to a read-only exported file, it will receive an error, but + the connection will stay up. + + + + + + Work with multiple files. This can be used to export + blockdevices that are larger than the maximum allowed + filesize on a given filesystem; i.e. when the filesystem + does not allow files larger than 2GB (which is true for + 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. + + + + + + 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. + + + + + + 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 + Some examples of nbd-server usage: + + + To export a file /export/nbd/exp-bl-dev on port 2000: + nbd-server 2000 /export/nbd/exp-bl-dev + + + To export a the same file read-only: + nbd-server 2000 /export/nbd/exp-bl-dev -r + + + To export the same file read-write, but make sure + changes are lost after restarting the client or the + server: + nbd-server 2000 /export/nbd/exp-bl-dev + -c + + + + + SEE ALSO + + 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 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 + the terms of the GNU General Public License, + version 2, as published by the Free Software Foundation. + + + diff --git a/man/nbd-server.5.in.sgml b/man/nbd-server.5.in.sgml new file mode 100644 index 0000000..f0aae0a --- /dev/null +++ b/man/nbd-server.5.in.sgml @@ -0,0 +1,675 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + --> + + + Wouter"> + Verhelst"> + + $Date: 2006-10-18 15:01:57 +0200 (wo, 18 okt 2006) $"> + + 5"> + wouter@debian.org"> + + NBD-SERVER"> + + + Debian GNU/Linux"> + GNU"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2006 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + configuration file for nbd-server + + + + &dhpackage; + + + + + DESCRIPTION + + &dhpackage; allows to configure the + nbd-server. + + While + @sysconfdir@/nbd-server/config is the default + configuration file, this can be varied with the + option to nbd-server(1). + + + The configuration file consists of section header lines, comment + lines, and option lines. + + + A section header is a unique name that + is enclosed in square brackets ("[" and "]"). A section header + denotes the beginning of a section; a section continues until + the next section or the end of the file, whichever is first. The + first section in the configuration file must be called + , and is used for global options that + apply to more than one export. This section must always be + present, even if it holds no options. Every other section + defines one export; the names of these sections are not + important, except that you should take care to make sure that + each section name is unique. The section name is used as the name + for the export in case the client connects with a name rather than + a port to specify an export, and must therefore be unique. + + + A comment line is a line that starts with optional whitespace, + followed by a pound sign ("#"), and continues until the end of + the line. Comments may not be used on + option lines or section header lines. + + + An option line is a line that starts with an option name, + followed by an equals sign ("="), followed by the option + value. An option can be of type string, of type integer, or of + type boolean. The value of a boolean option can be denoted with + either true or false (so not yes, no, on, off, 1, or 0). All + booleans default to false unless specified otherwise. No value + may be quoted; always enter it directly. For a string option, + leading whitespace is stripped (but trailing whitespace is not). + + + + + OPTIONS FOR SECTION [generic] + + + + + + + + Optional; string. + + + The name of the group this server must run as. If this + parameter is not specified, then nbd-server will not + attempt to change its GID (so the GID it runs as will be + the primary group of the user who starts nbd-server). If + it is specified, then nbd-server will change its GID after + opening ports, but before accepting connections or opening + files. + + + + + + + + Optional; string. + + + The name of the user this server must run as. If this + parameter is not specified, then nbd-server will not + attempt to change its UID (so the UID it runs as will be + the user who starts nbd-server). If it is specified, then + nbd-server will change its UID after opening ports, but + before accepting connections or opening files. + + + + + + + + Optional; boolean + + + If this option is set to true, nbd-server will export all + exports on a separate port with the old (pre-2.9.17) + handshake protocol. In that case, the 'port' option for + individual exports is mandatory. + + + If the option is set to false, the 'port' option for + individual exports is optional (and will be ignored if + specified). The server will only export devices on the + standard port. + + + For upgrades from pre-2.9.17 versions of nbd, it may be + appropriate to enable the oldstyle parameter until all + clients have been converted to using name-based exports. + + + Note that exports specified on the command line will + always use the old handshake protocol and will not allow + name-based exports. + + + Also note that even if this parameter is set to true, all + exports will also be made available using the new handshake + protocol; it is not possible to switch that off. The reason + for this is that the old style protocol will eventually be + deprecated, and this option is only available to allow for + smooth upgrades. + + + + + + + + Optional; string + + If this option is set, it should contain the local IP + address on which we should listen to + nbd-client(8) connections. If it is not + set, nbd-server will listen to all + local IPv4 and IPv6 addresses. To limit to IPv6, specify the + address as "::". To limit to IPv4, specify as "0.0.0.0". It + is not possible to specify more than one IP address + here. + + + + + OPTIONS FOR EXPORT SECTIONS + + + + + + + + Optional; string; default + @sysconfdir@/nbd-server/allow. + + + The name of the authorization file for this export. This + file should contain one line per IP-address, or per + network (which must be specified in CIDR-style + ) + and must not contain empty lines. If the file + does not exist, everyone is allowed to connect. If the + file exists but is empty, nobody is allowed to + connect. Otherwise, nbd-server will + only allow clients to connect whose IP-adres is listed in + this file. + + Corresponds to the option on the + command line + + + + + + + Optional; boolean. + + + Whether this is a copy-on-write export. If it is, then any + writes to this export will not be written to the master + file, but to a separate file which will be removed upon + disconnect. The result of using this option is that + nbd-server will be somewhat slower, and that any writes will + be lost upon disconnect. + + Corresponds to the option on the + command line + + + + + + Required; string. + + The name of the file (or block device) that will be + exported. This must be a fully-qualified path and filename; + relative paths are not allowed. + + + Note that nbd-server will only try to + find and open the exported file when a client actually + connects; as a result, nbd-server must + be able to open and read this file + after changing to the user and group + that have been specified by use of the + and options; + also, nbd-server will only detect + errors in this option upon connection of a client. + + When specified on the command line, this should be the + second argument. + + + + + + + Optional; integer; default autodetected. + + Disable autodetection of file or block device size, and + forcibly specify a size. Sizes must be specified in + bytes. If the option is in + effect, this option specifies the size of the + entire export, not of individual + files. + + When specified on the command line, this should be the + third argument. + + + + + listenaddr + + + Optional; string + + + If the 'oldstyle' global parameter is specified, works + similarly to the global listenaddr parameter, but for the + individual port of this particular export. If the 'oldstyle' + parameter is not set, this parameter is ignored. + + + + + + + Optional; boolean. + + If this option is set to true, then + nbd-server will search for files of the + form + exportname.integer, + with exportname being the + filename that would otherwise have been used (after name + transformation for virtualization, if any, has been + performed) and integer an + integer number, starting with 0 and ending when no more + files can be found. + + + The size of the individual files will be autodetected, + even if the + option has been specified. + + + Corresponds to the option on the + command line. + + + + + + + Required if 'oldstyle' global parameter is set; integer. + + The port on which this export is to be served using the + old-style handshake protocol. + + + This parameter only makes sense when the 'oldstyle' + parameter is set to true in the 'generic' section. If that + parameter is not set, but this parameter is found in an + export section, then nbd-server will issue a warning upon + startup but should otherwise continue to function correctly. + + + It is not possible to combine multiple exports on the same + port using the old style handshake. Please use the new style + handshake for that purpose. + + + When specified on the command line, this should be the + first argument. + + + + + + + Optional; boolean. + + Disallow writes to the device. If this option is + specified, nbd-server will issue an + error to any client that tries to write to the device. + + + Use of this option in conjunction with + is possible, but silly. + + Corresponds to the option on the + command line. + + + + + + Optional; boolean. + + When this option is enabled, nbd-server + will use the Socket Direct Protocol (SDP) to serve the + export, rather than just IP. This is faster, but requires + special hardware (usually something like InfiniBand) and + support in the kernel. + + + Additionally, support for this option must be enabled at + compile time, using the option + to the configure script. If this option + is found in a configuration file and + nbd-server does not have support for SDP, + then nbd-server will exit with an error + message. + + + + + + + Optional; boolean. + When this option is enabled, + nbd-server will call an fsync() after every + write to the backend storage. Calling fsync() increases + reliability in case of an unclean shutdown of nbd-server; but, + depending on the file system used on the nbd-server side, may + degrade performance. The use of this option isn't always + necessary; e.g., on ext3 filesystems, it is recommended that + it is not enabled, since it seriously + reduces performance on ext3 filesystems while not + importantly impacting reliability. + + + + + + + Optional; boolean. + + When this option is enabled, nbd-server + will use sparse files to implement the copy-on-write + option; such files take up less space then they appear to, + which allows nbd-server to handle the + file as if it was just as large as the block device it's + for. + + + If this option is disabled, nbd-server + will map every newly written block to the end of the + copy-on-write file, which means that + nbd-server will have to lseek(2) to the + right position after every 4096-byte block. + + + Using this option may be faster when much is being written + during a connection. + + + + + + + Optional; integer; default 0 + + How many seconds a connection may be idle for this + export. When a connection is idle for a longer time, + nbd-server will forcibly disconnect the + connection. If you specify 0 (the default), then a + connection may be idle forever. + + + Corresponds to the option on the + command line + + + + + + + Optional; string; default "ipliteral" + + Defines the style of virtualization. Virtualization allows + one to create one export that will serve a different file + depending on the IP address that is connecting. When + virtualization is active, the + exportname parameter needs to + contain the string '%s'; this will then be replaced by the + IP address of the client connecting, in accordance with the + option selected here. The result of this transformation is + then used as the filename to be opened. + + + There are four types of virtualization that + nbd-server supports: + + + + + + + No virtualization. Will attempt to open the filename + as it was written, even if it contains '%s' in the + name. + + + + + + + + The %s is replaced by the IP address of the connecting + host is used as-is. For IPv4, this is done in + dotted-quad notation; for IPv6, in hexadecimal form + with leading zeros omitted. + + + As an example, if a client connects from 192.168.1.100 + and is specified as + /export/%s, then nbd-server will + attempt to serve + /export/192.168.1.100. For IPv6, + with a client connecting from 2001:6f8:32f::39, the + filename would be + /export/2001:6f8:32f:0:0:0:0:39 + + + + + + + + Same as above, except that + nbd-server will replace the dots + in the IP address by forward slashes ('/'); in the + same example, nbd-server would + open /export/192/168/1/100 + instead. + + + Since there are no dots in most IPv6 addresses, the + effect of using this option when IPv6 is in use is + indistinguishable from the ipliteral option. It was + thought that having to create an eight-deep directory + structure would not be as useful. + + + + + + + + This option requires one to add a space and a number + after it. nbd-server will use the + number as a network mask in CIDR style, and use that + as a hash cutoff point. In the above example, if + has been specified as + cidrhash 16, then + nbd-server will try to open + /export/192.168.0.0/192.168.1.100; + if were specified as + cidrhash 26, then + nbd-server will try to open + /export/192.168.1.64/192.168.1.100. + + For IPv6, in the above example, with + cidrhash 42, the filename would + be + /export/2001:32f:6c0:0:0:0:0:0/2001:32f:6f8:0:0:0:0:39. + + + + + + + + + Optional; string + + If specified, then this command will be ran after a + client has connected to the server (and has been + accepted), but before the server starts serving. If + the command contains the literal string '%s', then + this string will be replaced by the filename of the + file which nbd-server wants to export. + + + This is useful to create export files on the fly, or + to verify that a file can be used for export, to + write something to a log file, or similar. + + + If the command runs with a non-zero exit status, + then nbd-server will assume the export will fail, + and refuse to serve it. + + + + + + + Optional; string + + If specified, then it is assumed to be a command + that will be ran when a client has + disconnected. This can be useful to clean up + whatever has set up, to log + something, or similar. + + + If the literal string '%s' is present in the + command, it will be replaced by the file name that + has just been closed. + + + In contrast to the option, + the exit state of is + ignored. + + + + + + + + SEE ALSO + + nbd-server (1), nbd-client (8), + 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 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 + the terms of the GNU General Public License, + version 2, as published by the Free Software Foundation. + + + + EXAMPLES + A simple nbd-server configuration file + would look like this: + + [generic] + [export] + exportname = /export/blkdev + port = 12345 + + For increased security, one might want to create an + authorization file, and set the UID and GID to run as: + + [generic] + user = nbd + group = nbd + [export] + exportname = /export/blkdev + port = 12345 + authfile = @sysconfdir@/nbd-server/allow + + With @sysconfdir@/nbd-server/allow containing the following: + + 127.0.0.1 + 192.168.0.0/8 + 192.168.1.1 + + + + + diff --git a/nbd-client.8.sgml b/nbd-client.8.sgml deleted file mode 100644 index af19bbc..0000000 --- a/nbd-client.8.sgml +++ /dev/null @@ -1,271 +0,0 @@ - manpage.1'. You may view - the manual page with: `docbook-to-man manpage.sgml | nroff -man | - less'. A typical entry in a Makefile or Makefile.am is: - -manpage.1: manpage.sgml - docbook-to-man $< > $@ - --> - - - Wouter"> - Verhelst"> - - $Date$"> - - 8"> - wouter@debian.org"> - - NBD-CLIENT"> - - - Debian GNU/Linux"> - GNU"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2001 - &dhusername; - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - connect to a server running nbd-server(1), to use its - exported block device - - - - &dhpackage; - host - port - nbd-device - -sdp - -swap - -persist - -nofork - -block-size block size - -timeout seconds - -name name - - - &dhpackage; - - - - &dhpackage; - - - - - DESCRIPTION - - With &dhpackage;, you can connect to a - server running nbd-server, thus using raw - diskspace from that server as a blockdevice on the local - client. - - To do this, support from the Linux Kernel is necessary, in - the form of the Network Block Device (NBD). When you have that, - either in the kernel, or as a module, you can connect to an NBD - server and use its exported file through a block special file with - major mode 43. - - Optionally, long options can also be specified with two - leading dashes. - - - OPTIONS - - The following options are supported: - - - - - - - Use a blocksize of "block size". Default is 1024; - allowed values are either 512, 1024, 2048 or 4096 - - - - - - The hostname or IP address of the machine running - nbd-server. Since 2.9.15, the NBD - utilities support IPv6. - - - - - - - Set the connection timeout to "seconds". For this to - work, you need a kernel with support for the NBD_SET_TIMEOUT - ioctl; this was introduced into Linus' tree on 2007-10-11, - and will be part of kernel 2.6.24. - - - - - - The TCP port on which nbd-server is - running at the server. - This option is required, unless the -N option is - specified, in which case it is not allowed. - - - - - - The block special file this nbd-client should connect - to. - - - - - - - Check whether the specified nbd device is - connected. - If the device is connected, &dhpackage; will exit - with an exit state of 0 and print the PID of the &dhpackage; - instance that connected it to stdout. - If the device is not - connected or does not exist (for example because the nbd - module was not loaded), &dhpackage; will exit with an exit - state of 1 and not print anything on stdout. - If an error occurred, &dhpackage; will exit with an exit - state of 2, and not print anything on stdout either. - - - - - - - Disconnect the specified nbd device from the - server - - - - - - - When this option is specified, &dhpackage; will - immediately try to reconnect an nbd device if the - connection ever drops unexpectedly due to a lost - server or something similar. - - - - - - - Connect to the server using the Socket Direct Protocol - (SDP), rather than IP. See nbd-server(1) for details. - - - - - - - - Specifies that this NBD device will be used as - swapspace. This option attempts to prevent deadlocks by - performing mlockall() at an appropriate time. It does not - however guarantee that such deadlocks can be avoided. - - - - - - - Specifies that the NBD client should not detach and - daemonize itself. This is mostly useful for debugging. - - Note that nbd-client will still fork once to trigger an - update to the device node's partition table. It is not - possible to disable this. - - - - - - - - - Specifies the name of the export that we want to use. Required if - the port is not specified, not allowed in the other case. - - - - - - - EXAMPLES - - Some examples of nbd-client usage: - - - To connect to a server running on port 2000 at host - "server.domain.com", using the client's block special file - "/dev/nbd0": - nbd-client server.domain.com 2000 - /dev/nbd0 - - - To connect to a server running on port 2001 at host - "swapserver.domain.com", using the client's block special - file "/dev/nbd1", for swap purposes: - nbd-client swapserver.domain.com 2001 /dev/nbd1 - -swap - - - To disconnect the above connection again (after making - sure the block special file is not in use anymore): - nbd-client -d /dev/nbd1 - - - - - SEE ALSO - - nbd-server (1). - - - - AUTHOR - The NBD kernel module and the NBD tools have been written by - Pavel Macheck (pavel@ucw.cz). - - The kernel module is now maintained by Paul Clements - (Paul.Clements@steeleye.com), while the userland tools are maintained by - Wouter Verhelst (wouter@debian.org) - - 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 GNU General Public License, - version 2, as published by the Free Software Foundation. - - - diff --git a/nbd-server.1.sgml b/nbd-server.1.sgml deleted file mode 100644 index c9190b0..0000000 --- a/nbd-server.1.sgml +++ /dev/null @@ -1,286 +0,0 @@ - manpage.1'. You may view - the manual page with: `docbook-to-man manpage.sgml | nroff -man | - less'. A typical entry in a Makefile or Makefile.am is: - -manpage.1: manpage.sgml - docbook-to-man $< > $@ - --> - - - Wouter"> - Verhelst"> - - $Date$"> - - 1"> - wouter@debian.org"> - - NBD-SERVER"> - - - Debian GNU/Linux"> - GNU"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2001 - &dhusername; - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - serve a file as a block device to other computers - running the &gnu;/Linux(tm) or &gnu;/Hurd Operating - System - - - - &dhpackage; - - [ip@]port - filename - size - - - - - - - - - - DESCRIPTION - - &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 - then be used for whatever purpose a normal block device (harddisk, - CD-ROM, ...) can be used for. - - 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. - - &dhpackage; implements some security - 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 - - - - 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) - - - - - - The filename of the file that should be exported. This - can be any file, including "real" blockdevices (i.e. a file - from /dev). If the filename includes the literal string - "%s", then this %s will be substituded with the IP-address - of the client trying to connect. - - - - - - The size of the block device at the client side. This - 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 - or k) or 1048576 (M or m) - - - - - - Export the file read-only. If a client tries to write - to a read-only exported file, it will receive an error, but - the connection will stay up. - - - - - - Work with multiple files. This can be used to export - blockdevices that are larger than the maximum allowed - filesize on a given filesystem; i.e. when the filesystem - does not allow files larger than 2GB (which is true for - 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. - - - - - - 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. - - - - - - 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 - Some examples of nbd-server usage: - - - To export a file /export/nbd/exp-bl-dev on port 2000: - nbd-server 2000 /export/nbd/exp-bl-dev - - - To export a the same file read-only: - nbd-server 2000 /export/nbd/exp-bl-dev -r - - - To export the same file read-write, but make sure - changes are lost after restarting the client or the - server: - nbd-server 2000 /export/nbd/exp-bl-dev - -c - - - - - SEE ALSO - - 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 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 - the terms of the GNU General Public License, - version 2, as published by the Free Software Foundation. - - - diff --git a/nbd-server.5.sgml b/nbd-server.5.sgml deleted file mode 100644 index bf245e3..0000000 --- a/nbd-server.5.sgml +++ /dev/null @@ -1,675 +0,0 @@ - manpage.1'. You may view - the manual page with: `docbook-to-man manpage.sgml | nroff -man | - less'. A typical entry in a Makefile or Makefile.am is: - -manpage.1: manpage.sgml - docbook-to-man $< > $@ - --> - - - Wouter"> - Verhelst"> - - $Date: 2006-10-18 15:01:57 +0200 (wo, 18 okt 2006) $"> - - 5"> - wouter@debian.org"> - - NBD-SERVER"> - - - Debian GNU/Linux"> - GNU"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2006 - &dhusername; - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - configuration file for nbd-server - - - - &dhpackage; - - - - - DESCRIPTION - - &dhpackage; allows to configure the - nbd-server. - - While - @sysconfdir@/nbd-server/config is the default - configuration file, this can be varied with the - option to nbd-server(1). - - - The configuration file consists of section header lines, comment - lines, and option lines. - - - A section header is a unique name that - is enclosed in square brackets ("[" and "]"). A section header - denotes the beginning of a section; a section continues until - the next section or the end of the file, whichever is first. The - first section in the configuration file must be called - , and is used for global options that - apply to more than one export. This section must always be - present, even if it holds no options. Every other section - defines one export; the names of these sections are not - important, except that you should take care to make sure that - each section name is unique. The section name is used as the name - for the export in case the client connects with a name rather than - a port to specify an export, and must therefore be unique. - - - A comment line is a line that starts with optional whitespace, - followed by a pound sign ("#"), and continues until the end of - the line. Comments may not be used on - option lines or section header lines. - - - An option line is a line that starts with an option name, - followed by an equals sign ("="), followed by the option - value. An option can be of type string, of type integer, or of - type boolean. The value of a boolean option can be denoted with - either true or false (so not yes, no, on, off, 1, or 0). All - booleans default to false unless specified otherwise. No value - may be quoted; always enter it directly. For a string option, - leading whitespace is stripped (but trailing whitespace is not). - - - - - OPTIONS FOR SECTION [generic] - - - - - - - - Optional; string. - - - The name of the group this server must run as. If this - parameter is not specified, then nbd-server will not - attempt to change its GID (so the GID it runs as will be - the primary group of the user who starts nbd-server). If - it is specified, then nbd-server will change its GID after - opening ports, but before accepting connections or opening - files. - - - - - - - - Optional; string. - - - The name of the user this server must run as. If this - parameter is not specified, then nbd-server will not - attempt to change its UID (so the UID it runs as will be - the user who starts nbd-server). If it is specified, then - nbd-server will change its UID after opening ports, but - before accepting connections or opening files. - - - - - - - - Optional; boolean - - - If this option is set to true, nbd-server will export all - exports on a separate port with the old (pre-2.9.17) - handshake protocol. In that case, the 'port' option for - individual exports is mandatory. - - - If the option is set to false, the 'port' option for - individual exports is optional (and will be ignored if - specified). The server will only export devices on the - standard port. - - - For upgrades from pre-2.9.17 versions of nbd, it may be - appropriate to enable the oldstyle parameter until all - clients have been converted to using name-based exports. - - - Note that exports specified on the command line will - always use the old handshake protocol and will not allow - name-based exports. - - - Also note that even if this parameter is set to true, all - exports will also be made available using the new handshake - protocol; it is not possible to switch that off. The reason - for this is that the old style protocol will eventually be - deprecated, and this option is only available to allow for - smooth upgrades. - - - - - - - - Optional; string - - If this option is set, it should contain the local IP - address on which we should listen to - nbd-client(8) connections. If it is not - set, nbd-server will listen to all - local IPv4 and IPv6 addresses. To limit to IPv6, specify the - address as "::". To limit to IPv4, specify as "0.0.0.0". It - is not possible to specify more than one IP address - here. - - - - - OPTIONS FOR EXPORT SECTIONS - - - - - - - - Optional; string; default - @sysconfdir@/nbd-server/allow. - - - The name of the authorization file for this export. This - file should contain one line per IP-address, or per - network (which must be specified in CIDR-style - ) - and must not contain empty lines. If the file - does not exist, everyone is allowed to connect. If the - file exists but is empty, nobody is allowed to - connect. Otherwise, nbd-server will - only allow clients to connect whose IP-adres is listed in - this file. - - Corresponds to the option on the - command line - - - - - - - Optional; boolean. - - - Whether this is a copy-on-write export. If it is, then any - writes to this export will not be written to the master - file, but to a separate file which will be removed upon - disconnect. The result of using this option is that - nbd-server will be somewhat slower, and that any writes will - be lost upon disconnect. - - Corresponds to the option on the - command line - - - - - - Required; string. - - The name of the file (or block device) that will be - exported. This must be a fully-qualified path and filename; - relative paths are not allowed. - - - Note that nbd-server will only try to - find and open the exported file when a client actually - connects; as a result, nbd-server must - be able to open and read this file - after changing to the user and group - that have been specified by use of the - and options; - also, nbd-server will only detect - errors in this option upon connection of a client. - - When specified on the command line, this should be the - second argument. - - - - - - - Optional; integer; default autodetected. - - Disable autodetection of file or block device size, and - forcibly specify a size. Sizes must be specified in - bytes. If the option is in - effect, this option specifies the size of the - entire export, not of individual - files. - - When specified on the command line, this should be the - third argument. - - - - - listenaddr - - - Optional; string - - - If the 'oldstyle' global parameter is specified, works - similarly to the global listenaddr parameter, but for the - individual port of this particular export. If the 'oldstyle' - parameter is not set, this parameter is ignored. - - - - - - - Optional; boolean. - - If this option is set to true, then - nbd-server will search for files of the - form - exportname.integer, - with exportname being the - filename that would otherwise have been used (after name - transformation for virtualization, if any, has been - performed) and integer an - integer number, starting with 0 and ending when no more - files can be found. - - - The size of the individual files will be autodetected, - even if the - option has been specified. - - - Corresponds to the option on the - command line. - - - - - - - Required if 'oldstyle' global parameter is set; integer. - - The port on which this export is to be served using the - old-style handshake protocol. - - - This parameter only makes sense when the 'oldstyle' - parameter is set to true in the 'generic' section. If that - parameter is not set, but this parameter is found in an - export section, then nbd-server will issue a warning upon - startup but should otherwise continue to function correctly. - - - It is not possible to combine multiple exports on the same - port using the old style handshake. Please use the new style - handshake for that purpose. - - - When specified on the command line, this should be the - first argument. - - - - - - - Optional; boolean. - - Disallow writes to the device. If this option is - specified, nbd-server will issue an - error to any client that tries to write to the device. - - - Use of this option in conjunction with - is possible, but silly. - - Corresponds to the option on the - command line. - - - - - - Optional; boolean. - - When this option is enabled, nbd-server - will use the Socket Direct Protocol (SDP) to serve the - export, rather than just IP. This is faster, but requires - special hardware (usually something like InfiniBand) and - support in the kernel. - - - Additionally, support for this option must be enabled at - compile time, using the option - to the configure script. If this option - is found in a configuration file and - nbd-server does not have support for SDP, - then nbd-server will exit with an error - message. - - - - - - - Optional; boolean. - When this option is enabled, - nbd-server will call an fsync() after every - write to the backend storage. Calling fsync() increases - reliability in case of an unclean shutdown of nbd-server; but, - depending on the file system used on the nbd-server side, may - degrade performance. The use of this option isn't always - necessary; e.g., on ext3 filesystems, it is recommended that - it is not enabled, since it seriously - reduces performance on ext3 filesystems while not - importantly impacting reliability. - - - - - - - Optional; boolean. - - When this option is enabled, nbd-server - will use sparse files to implement the copy-on-write - option; such files take up less space then they appear to, - which allows nbd-server to handle the - file as if it was just as large as the block device it's - for. - - - If this option is disabled, nbd-server - will map every newly written block to the end of the - copy-on-write file, which means that - nbd-server will have to lseek(2) to the - right position after every 4096-byte block. - - - Using this option may be faster when much is being written - during a connection. - - - - - - - Optional; integer; default 0 - - How many seconds a connection may be idle for this - export. When a connection is idle for a longer time, - nbd-server will forcibly disconnect the - connection. If you specify 0 (the default), then a - connection may be idle forever. - - - Corresponds to the option on the - command line - - - - - - - Optional; string; default "ipliteral" - - Defines the style of virtualization. Virtualization allows - one to create one export that will serve a different file - depending on the IP address that is connecting. When - virtualization is active, the - exportname parameter needs to - contain the string '%s'; this will then be replaced by the - IP address of the client connecting, in accordance with the - option selected here. The result of this transformation is - then used as the filename to be opened. - - - There are four types of virtualization that - nbd-server supports: - - - - - - - No virtualization. Will attempt to open the filename - as it was written, even if it contains '%s' in the - name. - - - - - - - - The %s is replaced by the IP address of the connecting - host is used as-is. For IPv4, this is done in - dotted-quad notation; for IPv6, in hexadecimal form - with leading zeros omitted. - - - As an example, if a client connects from 192.168.1.100 - and is specified as - /export/%s, then nbd-server will - attempt to serve - /export/192.168.1.100. For IPv6, - with a client connecting from 2001:6f8:32f::39, the - filename would be - /export/2001:6f8:32f:0:0:0:0:39 - - - - - - - - Same as above, except that - nbd-server will replace the dots - in the IP address by forward slashes ('/'); in the - same example, nbd-server would - open /export/192/168/1/100 - instead. - - - Since there are no dots in most IPv6 addresses, the - effect of using this option when IPv6 is in use is - indistinguishable from the ipliteral option. It was - thought that having to create an eight-deep directory - structure would not be as useful. - - - - - - - - This option requires one to add a space and a number - after it. nbd-server will use the - number as a network mask in CIDR style, and use that - as a hash cutoff point. In the above example, if - has been specified as - cidrhash 16, then - nbd-server will try to open - /export/192.168.0.0/192.168.1.100; - if were specified as - cidrhash 26, then - nbd-server will try to open - /export/192.168.1.64/192.168.1.100. - - For IPv6, in the above example, with - cidrhash 42, the filename would - be - /export/2001:32f:6c0:0:0:0:0:0/2001:32f:6f8:0:0:0:0:39. - - - - - - - - - Optional; string - - If specified, then this command will be ran after a - client has connected to the server (and has been - accepted), but before the server starts serving. If - the command contains the literal string '%s', then - this string will be replaced by the filename of the - file which nbd-server wants to export. - - - This is useful to create export files on the fly, or - to verify that a file can be used for export, to - write something to a log file, or similar. - - - If the command runs with a non-zero exit status, - then nbd-server will assume the export will fail, - and refuse to serve it. - - - - - - - Optional; string - - If specified, then it is assumed to be a command - that will be ran when a client has - disconnected. This can be useful to clean up - whatever has set up, to log - something, or similar. - - - If the literal string '%s' is present in the - command, it will be replaced by the file name that - has just been closed. - - - In contrast to the option, - the exit state of is - ignored. - - - - - - - - SEE ALSO - - nbd-server (1), nbd-client (8), - 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 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 - the terms of the GNU General Public License, - version 2, as published by the Free Software Foundation. - - - - EXAMPLES - A simple nbd-server configuration file - would look like this: - - [generic] - [export] - exportname = /export/blkdev - port = 12345 - - For increased security, one might want to create an - authorization file, and set the UID and GID to run as: - - [generic] - user = nbd - group = nbd - [export] - exportname = /export/blkdev - port = 12345 - authfile = /etc/nbd-server/allow - - With /etc/nbd-server/allow containing the following: - - 127.0.0.1 - 192.168.0.0/8 - 192.168.1.1 - - - - -