X-Git-Url: http://git.alex.org.uk diff --git a/nbd-server.5.sgml b/nbd-server.5.sgml index fa9b321..cfa07f3 100644 --- a/nbd-server.5.sgml +++ b/nbd-server.5.sgml @@ -98,9 +98,9 @@ manpage.1: manpage.sgml 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, + 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). @@ -143,6 +143,52 @@ manpage.1: manpage.sgml + + + + + 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. + + + + + + + + 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. + + @@ -196,9 +242,9 @@ manpage.1: manpage.sgml Required; string. - The name of the file that will be exported. This must be a - fully-qualified path and filename; relative paths are not - allowed. + 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 @@ -236,12 +282,15 @@ manpage.1: manpage.sgml listenaddr - Optional; string - If this option is set, it should contain the local IP - address (in "dotted-quad" notation) on which we should - listen to nbd-client(8) connections. If - it is not set, 0.0.0.0 is used (i.e., "listen on all local - IP addresses") + + 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. + @@ -254,8 +303,8 @@ manpage.1: manpage.sgml form exportname.integer, with exportname being the - filename that would otherwise have been used (after - name transformation for virtualization, if any, has been + 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. @@ -275,7 +324,7 @@ manpage.1: manpage.sgml - Required; integer. + Required if 'oldstyle' global parameter is set; integer. The port on which this export is to be served. Currently it is not possible to export multiple block devices on the @@ -341,7 +390,7 @@ manpage.1: manpage.sgml 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 performance. + importantly impacting reliability. @@ -416,14 +465,14 @@ manpage.1: manpage.sgml nbd-server will look for the literal string '%s' in the , and replace it by the - IP address of the connecting host in dotted-quad - notation. The string that results from this - transformation will be used as an absolute pathname - that nbd-server will attempt to - open. 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 + address of the connecting host. The string that + results from this transformation will be used as an + absolute pathname that nbd-server + will attempt to open. 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 @@ -439,6 +488,11 @@ manpage.1: manpage.sgml 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. + @@ -458,6 +512,7 @@ manpage.1: manpage.sgml nbd-server will try to open /export/192.168.1.64/192.168.1.100. + This option works as expected for IPv6.