From: Wouter Verhelst Date: Fri, 27 May 2011 15:51:11 +0000 (+0200) Subject: Re-sort documentation X-Git-Url: http://git.alex.org.uk Re-sort documentation This used to be alphabetically sorted, but wasn't any more. Fix that. --- diff --git a/man/nbd-server.5.in.sgml b/man/nbd-server.5.in.sgml index 8f06f96..32ce37f 100644 --- a/man/nbd-server.5.in.sgml +++ b/man/nbd-server.5.in.sgml @@ -287,6 +287,39 @@ 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. 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. This option + will have no effect unless supported by the client. + + + + listenaddr @@ -301,6 +334,16 @@ manpage.1: manpage.sgml + + + Optional; integer + + If specified, then it limits the number of opened connections for + this export. + + + + Optional; boolean. @@ -354,92 +397,67 @@ manpage.1: manpage.sgml - + - Optional; boolean. + Optional; string - 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. + 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. - Use of this option in conjunction with - is possible, but silly. + 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. - Corresponds to the option on the - command line. - + - Optional; boolean. + Optional; string - 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. + 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. - 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. + 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. - - - - - - 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. + + 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; 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. This option - will have no effect unless supported by the client. + + 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. - - - - - - 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. This option - will have no effect unless supported by the client. + + Use of this option in conjunction with + is possible, but silly. + Corresponds to the option on the + command line. @@ -466,6 +484,28 @@ manpage.1: manpage.sgml + + + 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. @@ -491,6 +531,23 @@ manpage.1: manpage.sgml + + + 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; integer; default 0 @@ -508,6 +565,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. + + + + Optional; string; default "ipliteral" @@ -604,87 +685,6 @@ manpage.1: manpage.sgml - - - - 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. - - - - - - - Optional; integer - - If specified, then it limits the number of opened connections for - this export. - - - - - - - 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. - - -