man: order fields alphabetically in crypttab(5)
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Tue, 5 Sep 2017 08:25:45 +0000 (10:25 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Tue, 5 Sep 2017 10:06:30 +0000 (12:06 +0200)
They already were mostly ordered alphabetically, but some disorder
snuck in.

Also, fix formatting. Some options were described using "--" prefixes, which
looks like the text was just copied from crypttab(8).

man/crypttab.xml

index 49896a4..5223e16 100644 (file)
@@ -69,8 +69,7 @@
 
     <para>Empty lines and lines starting with the <literal>#</literal>
     character are ignored. Each of the remaining lines describes one
-    encrypted block device, fields on the line are delimited by white
-    space.</para>
+    encrypted block device. Fields are delimited by white space.</para>
 
     <para>Each line is in the form<programlisting><replaceable>name</replaceable> <replaceable>encrypted-device</replaceable> <replaceable>password</replaceable> <replaceable>options</replaceable></programlisting>
     The first two fields are mandatory, the remaining two are
     <variablelist class='fstab-options'>
 
       <varlistentry>
-        <term><option>discard</option></term>
-
-        <listitem><para>Allow discard requests to be passed through
-        the encrypted block device. This improves performance on SSD
-        storage but has security implications.</para></listitem>
-      </varlistentry>
-
-      <varlistentry>
         <term><option>cipher=</option></term>
 
         <listitem><para>Specifies the cipher to use. See
       </varlistentry>
 
       <varlistentry>
+        <term><option>discard</option></term>
+
+        <listitem><para>Allow discard requests to be passed through the encrypted block
+        device. This improves performance on SSD storage but has security implications.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><option>hash=</option></term>
 
         <listitem><para>Specifies the hash to use for password
       </varlistentry>
 
       <varlistentry>
-        <term><option>offset=</option></term>
-
-        <listitem><para>Start offset in the backend device, in 512-byte sectors.
-        This option is only relevant for plain devices.
-        </para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><option>skip=</option></term>
-
-        <listitem><para>How many 512-byte sectors of the encrypted data to skip
-        at the beginning. This is different from the <option>--offset</option>
-        option with respect to the sector numbers used in initialization vector
-        (IV) calculation. Using <option>--offset</option> will shift the IV
-        calculation by the same negative amount.  Hence, if <option>--offset n</option> is given,
-        sector n will  get a sector number of 0 for the IV calculation.
-        Using <option>--skip</option> causes sector n to also be the first
-        sector of the mapped device, but with its number for IV generation being n.</para>
-
-        <para>This option is only relevant for plain devices.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
         <term><option>keyfile-offset=</option></term>
 
         <listitem><para>Specifies the number of bytes to skip at the
       </varlistentry>
 
       <varlistentry>
+        <term><option>offset=</option></term>
+
+        <listitem><para>Start offset in the backend device, in 512-byte sectors. This
+        option is only relevant for plain devices.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><option>plain</option></term>
 
         <listitem><para>Force plain encryption mode.</para></listitem>
       </varlistentry>
 
       <varlistentry>
+        <term><option>skip=</option></term>
+
+        <listitem><para>How many 512-byte sectors of the encrypted data to skip at the
+        beginning. This is different from the <option>offset=</option> option with respect
+        to the sector numbers used in initialization vector (IV) calculation. Using
+        <option>offset=</option> will shift the IV calculation by the same negative
+        amount. Hence, if <option>offset=<replaceable>n</replaceable></option> is given,
+        sector <replaceable>n</replaceable> will get a sector number of 0 for the IV
+        calculation. Using <option>skip=</option> causes sector
+        <replaceable>n</replaceable> to also be the first sector of the mapped device, but
+        with its number for IV generation being <replaceable>n</replaceable>.</para>
+
+        <para>This option is only relevant for plain devices.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><option>size=</option></term>
 
         <listitem><para>Specifies the key size in bits. See
       </varlistentry>
 
       <varlistentry>
-        <term><option>x-systemd.device-timeout=</option></term>
-
-        <listitem><para>Specifies how long systemd should wait for a
-        device to show up before giving up on the entry. The argument
-        is a time in seconds or explicitly specified units of
-        <literal>s</literal>,
-        <literal>min</literal>,
-        <literal>h</literal>,
-        <literal>ms</literal>.
-        </para></listitem>
-      </varlistentry>
-
-      <varlistentry>
         <term><option>tmp</option></term>
 
         <listitem><para>The encrypted block device will be prepared
         typos.</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>x-systemd.device-timeout=</option></term>
+
+        <listitem><para>Specifies how long systemd should wait for a device to show up
+        before giving up on the entry. The argument is a time in seconds or explicitly
+        specified units of
+        <literal>s</literal>,
+        <literal>min</literal>,
+        <literal>h</literal>,
+        <literal>ms</literal>.
+        </para></listitem>
+      </varlistentry>
+
     </variablelist>
 
     <para>At early boot and when the system manager configuration is