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

man: mention that x-systemd.device-timeout is only for fstab 

Reformat fstab options description. Now they are easier to read and
show up in systemd.directives(7).

Use a single sublist for both /etc/fstab and /etc/crypttab options.
Many of them can be used in both places. crypttab(5) is updated to use
the same docbook elements, so formatting is uniform.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2014-06-30 09:27:16 -04:00
parent a17f2dc15b
commit 63b03c0b28
3 changed files with 104 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
man/crypttab.xml
View File

@ -109,10 +109,10 @@
comma-delimited list of options. The following comma-delimited list of options. The following
options are recognized:</para> options are recognized:</para>
<variablelist class='crypttab-options'> <variablelist class='fstab-options'>
<varlistentry> <varlistentry>
<term><varname>discard</varname></term> <term><option>discard</option></term>
<listitem><para>Allow discard requests to be <listitem><para>Allow discard requests to be
passed through the encrypted block device. This passed through the encrypted block device. This
@ -121,7 +121,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>cipher=</varname></term> <term><option>cipher=</option></term>
<listitem><para>Specifies the cipher to use. See <listitem><para>Specifies the cipher to use. See
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
@ -132,7 +132,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>hash=</varname></term> <term><option>hash=</option></term>
<listitem><para>Specifies the hash to use for <listitem><para>Specifies the hash to use for
password hashing. See password hashing. See
@ -142,7 +142,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>keyfile-offset=</varname></term> <term><option>keyfile-offset=</option></term>
<listitem><para>Specifies the number of bytes to <listitem><para>Specifies the number of bytes to
skip at the start of the key file. See skip at the start of the key file. See
@ -152,7 +152,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>keyfile-size=</varname></term> <term><option>keyfile-size=</option></term>
<listitem><para>Specifies the maximum number <listitem><para>Specifies the maximum number
of bytes to read from the key file. See of bytes to read from the key file. See
@ -164,39 +164,39 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>key-slot=</varname></term> <term><option>key-slot=</option></term>
<listitem><para>Specifies the key slot to <listitem><para>Specifies the key slot to
compare the passphrase or key against. compare the passphrase or key against.
If the key slot does not match the given If the key slot does not match the given
passphrase or key, but another would, the passphrase or key, but another would, the
setup of the device will fail regardless. setup of the device will fail regardless.
This option implies <varname>luks</varname>. See This option implies <option>luks</option>. See
<citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for possible values. The default is to try for possible values. The default is to try
all key slots in sequential order.</para></listitem> all key slots in sequential order.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>luks</varname></term> <term><option>luks</option></term>
<listitem><para>Force LUKS mode. When this mode <listitem><para>Force LUKS mode. When this mode
is used, the following options are ignored since is used, the following options are ignored since
they are provided by the LUKS header on the they are provided by the LUKS header on the
device: <varname>cipher=</varname>, device: <option>cipher=</option>,
<varname>hash=</varname>, <option>hash=</option>,
<varname>size=</varname>.</para></listitem> <option>size=</option>.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>noauto</varname></term> <term><option>noauto</option></term>
<listitem><para>This device will not be <listitem><para>This device will not be
automatically unlocked on boot.</para></listitem> automatically unlocked on boot.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>nofail</varname></term> <term><option>nofail</option></term>
<listitem><para>The system will not wait for the <listitem><para>The system will not wait for the
device to show up and be unlocked at boot, and device to show up and be unlocked at boot, and
@ -204,20 +204,20 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>plain</varname></term> <term><option>plain</option></term>
<listitem><para>Force plain encryption mode.</para></listitem> <listitem><para>Force plain encryption mode.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>read-only</varname></term><term><varname>readonly</varname></term> <term><option>read-only</option></term><term><option>readonly</option></term>
<listitem><para>Set up the encrypted block <listitem><para>Set up the encrypted block
device in read-only mode.</para></listitem> device in read-only mode.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>size=</varname></term> <term><option>size=</option></term>
<listitem><para>Specifies the key size <listitem><para>Specifies the key size
in bits. See in bits. See
@ -227,33 +227,33 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>swap</varname></term> <term><option>swap</option></term>
<listitem><para>The encrypted block device will <listitem><para>The encrypted block device will
be used as a swap device, and will be formatted be used as a swap device, and will be formatted
accordingly after setting up the encrypted accordingly after setting up the encrypted
block device, with block device, with
<citerefentry><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>. <citerefentry><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
This option implies <varname>plain</varname>.</para> This option implies <option>plain</option>.</para>
<para>WARNING: Using the <varname>swap</varname> <para>WARNING: Using the <option>swap</option>
option will destroy the contents of the named option will destroy the contents of the named
partition during every boot, so make sure the partition during every boot, so make sure the
underlying block device is specified correctly.</para></listitem> underlying block device is specified correctly.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>tcrypt</varname></term> <term><option>tcrypt</option></term>
<listitem><para>Use TrueCrypt encryption mode. <listitem><para>Use TrueCrypt encryption mode.
When this mode is used, the following options are When this mode is used, the following options are
ignored since they are provided by the TrueCrypt ignored since they are provided by the TrueCrypt
header on the device or do not apply: header on the device or do not apply:
<varname>cipher=</varname>, <option>cipher=</option>,
<varname>hash=</varname>, <option>hash=</option>,
<varname>keyfile-offset=</varname>, <option>keyfile-offset=</option>,
<varname>keyfile-size=</varname>, <option>keyfile-size=</option>,
<varname>size=</varname>.</para> <option>size=</option>.</para>
<para>When this mode is used, the passphrase is <para>When this mode is used, the passphrase is
read from the key file given in the third field. read from the key file given in the third field.
@ -264,7 +264,7 @@
passphrase and key files to derive a password passphrase and key files to derive a password
for the volume. Therefore, the passphrase and for the volume. Therefore, the passphrase and
all key files need to be provided. Use all key files need to be provided. Use
<varname>tcrypt-keyfile=</varname> to provide <option>tcrypt-keyfile=</option> to provide
the absolute path to all key files. When using the absolute path to all key files. When using
an empty passphrase in combination with one or an empty passphrase in combination with one or
more key files, use <literal>/dev/null</literal> more key files, use <literal>/dev/null</literal>
@ -272,10 +272,10 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>tcrypt-hidden</varname></term> <term><option>tcrypt-hidden</option></term>
<listitem><para>Use the hidden TrueCrypt volume. <listitem><para>Use the hidden TrueCrypt volume.
This option implies <varname>tcrypt</varname>.</para> This option implies <option>tcrypt</option>.</para>
<para>This will map the hidden volume that is <para>This will map the hidden volume that is
inside of the volume provided in the second inside of the volume provided in the second
@ -287,29 +287,29 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>tcrypt-keyfile=</varname></term> <term><option>tcrypt-keyfile=</option></term>
<listitem><para>Specifies the absolute path to a <listitem><para>Specifies the absolute path to a
key file to use for a TrueCrypt volume. This key file to use for a TrueCrypt volume. This
implies <varname>tcrypt</varname> and can be implies <option>tcrypt</option> and can be
used more than once to provide several key used more than once to provide several key
files.</para> files.</para>
<para>See the entry for <varname>tcrypt</varname> <para>See the entry for <option>tcrypt</option>
on the behavior of the passphrase and key files on the behavior of the passphrase and key files
when using TrueCrypt encryption mode.</para></listitem> when using TrueCrypt encryption mode.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>tcrypt-system</varname></term> <term><option>tcrypt-system</option></term>
<listitem><para>Use TrueCrypt in system <listitem><para>Use TrueCrypt in system
encryption mode. This option implies encryption mode. This option implies
<varname>tcrypt</varname>.</para></listitem> <option>tcrypt</option>.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>timeout=</varname></term> <term><option>timeout=</option></term>
<listitem><para>Specifies the timeout for <listitem><para>Specifies the timeout for
querying for a password. If no unit is querying for a password. If no unit is
@ -319,22 +319,22 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>tmp</varname></term> <term><option>tmp</option></term>
<listitem><para>The encrypted block device will <listitem><para>The encrypted block device will
be prepared for using it as <filename>/tmp</filename>; be prepared for using it as <filename>/tmp</filename>;
it will be formatted using it will be formatted using
<citerefentry><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry>. <citerefentry><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
This option implies <varname>plain</varname>.</para> This option implies <option>plain</option>.</para>
<para>WARNING: Using the <varname>tmp</varname> <para>WARNING: Using the <option>tmp</option>
option will destroy the contents of the named option will destroy the contents of the named
partition during every boot, so make sure the partition during every boot, so make sure the
underlying block device is specified correctly.</para></listitem> underlying block device is specified correctly.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>tries=</varname></term> <term><option>tries=</option></term>
<listitem><para>Specifies the maximum number of <listitem><para>Specifies the maximum number of
times the user is queried for a password. times the user is queried for a password.
@ -343,7 +343,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>verify</varname></term> <term><option>verify</option></term>
<listitem><para> If the encryption password is <listitem><para> If the encryption password is
read from console, it has to be entered twice to read from console, it has to be entered twice to

90
man/systemd.mount.xml
View File

@ -144,38 +144,70 @@
which influence how dependencies are created for mount which influence how dependencies are created for mount
points from <filename>/etc/fstab</filename>. systemd points from <filename>/etc/fstab</filename>. systemd
will create a dependency of type will create a dependency of type
<option>Wants</option> from either <option>Wants</option> or <option>Requires</option>
<filename>local-fs.target</filename> or (see option <option>nofail</option> below), from
either <filename>local-fs.target</filename> or
<filename>remote-fs.target</filename>, depending <filename>remote-fs.target</filename>, depending
whether the file system is local or remote. If whether the file system is local or remote.</para>
<option>x-systemd.automount</option> is set, an
automount unit will be created for the file
system. See
<citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details. If
<option>x-systemd.device-timeout=</option> is
specified, it may be used to configure how long systemd
should wait for a device to show up before giving up
on an entry from
<filename>/etc/fstab</filename>. Specify a time in
seconds or explicitly specify a unit as
<literal>s</literal>, <literal>min</literal>,
<literal>h</literal>, <literal>ms</literal>.</para>
<para>If <option>nofail</option> is given, this mount <variablelist class='fstab-options'>
will be only wanted, not required, by the
<filename>local-fs.target</filename>. This means that
the boot will continue even if this mount point is not
mounted successfully. Option <option>fail</option> has
the opposite meaning and is the default.</para>
<para>If <option>noauto</option> is given, this mount <varlistentry>
will not be added as a dependency for <term><option>x-systemd.automount</option></term>
<filename>local-fs.target</filename>. This means that
it will not be mounted automatically during boot, <listitem><para>An automount unit will be created
unless it is pulled in by some other unit. Option for the file system. See
<option>auto</option> has the opposite meaning and is <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
the default.</para> for details.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>x-systemd.device-timeout=</option></term>
<listitem><para>Configure how long systemd should
wait for a device to show up before giving up on
an entry from
<filename>/etc/fstab</filename>. Specify a time in
seconds or explicitly append a unit as
<literal>s</literal>, <literal>min</literal>,
<literal>h</literal>,
<literal>ms</literal>.</para>
<para>Note that this option can only be used in
<filename>/etc/fstab</filename>, and will be
ignored when part of <varname>Options=</varname>
setting in a unit file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>nofail</option></term>
<term><option>fail</option></term>
<listitem><para>With <option>nofail</option> this
mount will be only wanted, not required, by the
<filename>local-fs.target</filename>. This means
that the boot will continue even if this mount
point is not mounted successfully. Option
<option>fail</option> has the opposite meaning and
is the default.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>noauto</option></term>
<term><option>auto</option></term>
<listitem><para>With <option>noauto</option>, this
mount will not be added as a dependency for
<filename>local-fs.target</filename>. This means
that it will not be mounted automatically during
boot, unless it is pulled in by some other
unit. Option <option>auto</option> has the
opposite meaning and is the default.</para>
</listitem>
</varlistentry>
</variablelist>
<para>If a mount point is configured in both <para>If a mount point is configured in both
<filename>/etc/fstab</filename> and a unit file that <filename>/etc/fstab</filename> and a unit file that

5
tools/make-directive-index.py
View File

@ -113,12 +113,13 @@ TEMPLATE = '''\
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>crypttab options</title> <title><filename>/etc/crypttab</filename> and
<filename>/etc/fstab</filename> options</title>
<para>Options which influence mounted filesystems and <para>Options which influence mounted filesystems and
encrypted volumes.</para> encrypted volumes.</para>
<variablelist id='crypttab-options' /> <variablelist id='fstab-options' />
</refsect1> </refsect1>
<refsect1> <refsect1>