Fix leaks

[nbd.git] / nbd-server.5.in

diff --git a/nbd-server.5.in b/nbd-server.5.in
index 5d461ad..46c8183 100644 (file)
--- a/nbd-server.5.in
+++ b/nbd-server.5.in
@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "NBD-SERVER" "5" "17 July 2009" "" ""
+.TH "NBD-SERVER" "5" "01 April 2010" "" ""
 
 .SH NAME
 /etc/nbd-server/config \- configuration file for nbd-server
@@ -109,9 +109,9 @@ command line
 \fBexportname\fR
 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 \fBnbd-server\fR will only try to
 find and open the exported file when a client actually
@@ -143,10 +143,13 @@ third argument.
 Optional; string
 
 If this option is set, it should contain the local IP
-address (in "dotted-quad" notation) on which we should
-listen to \fBnbd-client\fR(8) connections. If
-it is not set, 0.0.0.0 is used (i.e., "listen on all local
-IP addresses")
+address on which we should listen to
+\fBnbd-client\fR(8) connections. If it is not
+set, \fBnbd-server\fR 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.
 .TP
 \fBmultifile\fR
 Optional; boolean.
@@ -156,8 +159,8 @@ If this option is set to true, then
 form
 \fIexportname\fR\&.\fIinteger\fR,
 with \fIexportname\fR 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 \fIinteger\fR an
 integer number, starting with 0 and ending when no more
 files can be found.
@@ -224,7 +227,7 @@ degrade performance. The use of this option isn't always
 necessary; e.g., on ext3 filesystems, it is recommended that
 it is \fBnot\fR enabled, since it seriously
 reduces performance on ext3 filesystems while not
-importantly impacting performance.
+importantly impacting reliability.
 .TP
 \fBsparse_cow\fR
 Optional; boolean.
@@ -276,14 +279,14 @@ name.
 \fBnbd-server\fR will look for the
 literal string '%s' in the
 \fBexportname\fR, 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 \fBnbd-server\fR will attempt to
-open. As an example, if a client connects from
-192.168.1.100 and \fBexportname\fR is
-specified as \fI/export/%s\fR, 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 \fBnbd-server\fR
+will attempt to open. As an example, if a client
+connects from 192.168.1.100 and
+\fBexportname\fR is specified as
+\fI/export/%s\fR, then nbd-server
+will attempt to serve
 \fI/export/192.168.1.100\fR
 .TP
 \fBiphash\fR
@@ -293,6 +296,10 @@ in the IP address by forward slashes ('/'); in the
 same example, \fBnbd-server\fR would
 open \fI/export/192/168/1/100\fR
 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.
 .TP
 \fBcidrhash\fR
 This option requires one to add a space and a number
@@ -307,6 +314,8 @@ if \fBvirtstyle\fR were specified as
 cidrhash 26, then
 \fBnbd-server\fR will try to open
 \fI/export/192.168.1.64/192.168.1.100\fR\&.
+
+This option works as expected for IPv6.
 .RE
 .TP
 \fBprerun\fR