Documentation update

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

diff --git a/nbd-server.5.in b/nbd-server.5.in
index ddcede2..079af82 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" "03 January 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.
@@ -212,6 +215,20 @@ is found in a configuration file and
 then \fBnbd-server\fR will exit with an error
 message.
 .TP
+\fBsync\fR
+Optional; boolean.
+
+When this option is enabled,
+\fBnbd-server\fR 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 \fBnot\fR enabled, since it seriously
+reduces performance on ext3 filesystems while not
+importantly impacting reliability.
+.TP
 \fBsparse_cow\fR
 Optional; boolean.