Remove double "it", and redundant information about defaults
[nbd.git] / man / nbd-server.5.in.sgml
index 07ed9fd..2930c2c 100644 (file)
@@ -420,9 +420,8 @@ manpage.1: manpage.sgml
            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.
+           the expense of a degradation of performance. This option
+           will have no effect unless supported by the client.
          </para>
        </listitem>
       </varlistentry>
@@ -438,9 +437,8 @@ manpage.1: manpage.sgml
            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.
+           the expense of a degradation of performance. This option
+           will have no effect unless supported by the client.
          </para>
        </listitem>
       </varlistentry>
@@ -449,7 +447,7 @@ manpage.1: manpage.sgml
        <listitem>
          <para>Optional; boolean.</para>
          <para>When this option is enabled,
-           <command>nbd-server</command> will inform the client that it
+           <command>nbd-server</command> will inform the client that 
            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
@@ -663,6 +661,30 @@ manpage.1: manpage.sgml
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><option>transactionlog</option></term>
+       <listitem>
+         <para>Optional; string</para>
+         <para>
+           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
+           <emphasis>nbd-tester-client</emphasis> 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
+           <emphasis>prerun</emphasis> 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.
+         </para>
+       </listitem>
+      </varlistentry>
     </variablelist>
     
   </refsect1>