picnoir
/
Systemd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

man: order fields alphabetically in crypttab(5) 

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).
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2017-09-05 10:25:45 +02:00
parent 947d21171b
commit ed3657d5db
1 changed files with 46 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
man/crypttab.xml
View 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
@ -108,14 +107,6 @@
<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>
@ -127,6 +118,14 @@
recommended.</para></listitem>
</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>
@ -148,30 +147,6 @@
option.</para></listitem>
</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>
@ -231,6 +206,13 @@
does not show up.</para></listitem>
</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>
@ -244,6 +226,23 @@
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>
@ -349,19 +348,6 @@
indefinitely (which is the default).</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>
<varlistentry>
<term><option>tmp</option></term>
@ -393,6 +379,19 @@
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