X-Git-Url: http://git.alex.org.uk
diff --git a/man/nbd-server.5.in.sgml b/man/nbd-server.5.in.sgml
index d36fe01..358b1c3 100644
--- a/man/nbd-server.5.in.sgml
+++ b/man/nbd-server.5.in.sgml
@@ -20,7 +20,7 @@ manpage.1: manpage.sgml
wouter@debian.org">
NBD-SERVER">
-
+
Debian GNU/Linux">
GNU">
@@ -60,11 +60,10 @@ manpage.1: manpage.sgml
DESCRIPTION
- &dhpackage; allows to configure the
- nbd-server.
+ This file allows to configure the nbd-server.While
- @sysconfdir@/nbd-server/config is the default
+ $sysconfdir/nbd-server/config is the default
configuration file, this can be varied with the
option to nbd-server(1).
@@ -209,7 +208,7 @@ manpage.1: manpage.sgml
Optional; string; default
- @sysconfdir@/nbd-server/allow.
+ $sysconfdir/nbd-server/allow.
The name of the authorization file for this export. This
@@ -411,6 +410,64 @@ manpage.1: manpage.sgml
+
+
+ Optional; boolean.
+ When this option is enabled,
+ nbd-server will inform the client that it
+ supports and desires to be sent flush requests when the
+ elevator layer receives them. Receipt of a flush request
+ will cause an fdatasync() (or, if the sync option is set,
+ an fsync()) on the backend storage. This increases
+ reliability in the case of an unclean shutdown at
+ the expense of a degradation of performance. The default
+ state is disabled. This option will have no effect unless
+ supported by the client.
+
+
+
+
+
+
+ Optional; boolean.
+ When this option is enabled,
+ nbd-server will inform the client that it
+ supports and desires to be sent fua (force unit access) commands
+ when the elevator layer receives them. Receipt of a force unit
+ access command will cause the specified command to be synced
+ to backend storage using sync_file_range() if supported, or
+ fdatasync() otherwise. This increases
+ reliability in the case of an unclean shutdown at
+ the expense of a degradation of performance. The default
+ state is disabled. This option will have no effect unless
+ supported by the client.
+
+
+
+
+
+
+ Optional; boolean.
+ When this option is enabled,
+ nbd-server will inform the client that it
+ it would prefer it to send requests in elevator order, perhaps
+ because it has a backing store and no local elevator. By
+ default, the client uses QUEUE_FLAG_NONROT, which effectively
+ restricts the function of the elevator to block merges. By
+ specifying this flag on the server, the client will not use
+ QUEUE_FLAG_NONROT, meaning the client elevator will perform
+ normal elevator ordering of I/O requests. Note that even when
+ the backing store is on rotating media, it is not normally
+ necessary to specify this flag, as the server's elevator
+ algorithm will be used. This flag is only required where
+ the server will not be using an elevator algorithm or where
+ the elevator algorithm is effectively neutered (e.g. with
+ the sync option set). This option will have no effect unless
+ supported by the client.
+
+
+
+ Optional; boolean.
@@ -606,6 +663,30 @@ manpage.1: manpage.sgml
+
+
+
+ Optional; string
+
+ If specified, then this pathname is used to generate a transaction
+ log. A transaction log is a binary file consisting of the requests
+ sent to and the replies received by the server, but excluding any
+ data (so, for a write command, it records the offset and length
+ of the write but not the data written). It is therefore relatively
+ safe to distribute to a third party. Note that the transaction log
+ does not include the negotiation sequence. Transaction logs are
+ mainly useful for debugging. The program
+ nbd-tester-client distributed with the source
+ to this program can reply a transaction log against a server and
+ perform a data integrity test. Note that the transaction log is
+ written to for every client opened. If it is necessary to maintain
+ separate transaction logs for each client, the
+ prerun script should rename the transaction log
+ (which will just have been opened in order to avoid transaction logs
+ overwriting eachother. This action should be race-free.
+
+
+
@@ -656,9 +737,9 @@ manpage.1: manpage.sgml
[export]
exportname = /export/blkdev
port = 12345
- authfile = @sysconfdir@/nbd-server/allow
+ authfile = $sysconfdir/nbd-server/allow
- With @sysconfdir@/nbd-server/allow containing the following:
+ With $sysconfdir/nbd-server/allow containing the following:
127.0.0.1
192.168.0.0/8