chiark / gitweb /
man: mention that x-systemd.device-timeout is only for fstab
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 30 Jun 2014 13:27:16 +0000 (09:27 -0400)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 30 Jun 2014 22:41:17 +0000 (18:41 -0400)
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.

man/crypttab.xml
man/systemd.mount.xml
tools/make-directive-index.py

index 9030015..9dbf154 100644 (file)
                 comma-delimited list of options.  The following
                 options are recognized:</para>
 
-                <variablelist class='crypttab-options'>
+                <variablelist class='fstab-options'>
 
                         <varlistentry>
-                                <term><varname>discard</varname></term>
+                                <term><option>discard</option></term>
 
                                 <listitem><para>Allow discard requests to be
                                 passed through the encrypted block device. This
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>cipher=</varname></term>
+                                <term><option>cipher=</option></term>
 
                                 <listitem><para>Specifies the cipher to use. See
                                 <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>hash=</varname></term>
+                                <term><option>hash=</option></term>
 
                                 <listitem><para>Specifies the hash to use for
                                 password hashing. See
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>keyfile-offset=</varname></term>
+                                <term><option>keyfile-offset=</option></term>
 
                                 <listitem><para>Specifies the number of bytes to
                                 skip at the start of the key file. See
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>keyfile-size=</varname></term>
+                                <term><option>keyfile-size=</option></term>
 
                                 <listitem><para>Specifies the maximum number
                                 of bytes to read from the key file. See
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>key-slot=</varname></term>
+                                <term><option>key-slot=</option></term>
 
                                 <listitem><para>Specifies the key slot to
                                 compare the passphrase or key against.
                                 If the key slot does not match the given
                                 passphrase or key, but another would, the
                                 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>
                                 for possible values. The default is to try
                                 all key slots in sequential order.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>luks</varname></term>
+                                <term><option>luks</option></term>
 
                                 <listitem><para>Force LUKS mode. When this mode
                                 is used, the following options are ignored since
                                 they are provided by the LUKS header on the
-                                device: <varname>cipher=</varname>,
-                                <varname>hash=</varname>,
-                                <varname>size=</varname>.</para></listitem>
+                                device: <option>cipher=</option>,
+                                <option>hash=</option>,
+                                <option>size=</option>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>noauto</varname></term>
+                                <term><option>noauto</option></term>
 
                                 <listitem><para>This device will not be
                                 automatically unlocked on boot.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>nofail</varname></term>
+                                <term><option>nofail</option></term>
 
                                 <listitem><para>The system will not wait for the
                                 device to show up and be unlocked at boot, and
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>plain</varname></term>
+                                <term><option>plain</option></term>
 
                                 <listitem><para>Force plain encryption mode.</para></listitem>
                         </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
                                 device in read-only mode.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>size=</varname></term>
+                                <term><option>size=</option></term>
 
                                 <listitem><para>Specifies the key size
                                 in bits. See
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>swap</varname></term>
+                                <term><option>swap</option></term>
 
                                 <listitem><para>The encrypted block device will
                                 be used as a swap device, and will be formatted
                                 accordingly after setting up the encrypted
                                 block device, with
                                 <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
                                 partition during every boot, so make sure the
                                 underlying block device is specified correctly.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>tcrypt</varname></term>
+                                <term><option>tcrypt</option></term>
 
                                 <listitem><para>Use TrueCrypt encryption mode.
                                 When this mode is used, the following options are
                                 ignored since they are provided by the TrueCrypt
                                 header on the device or do not apply:
-                                <varname>cipher=</varname>,
-                                <varname>hash=</varname>,
-                                <varname>keyfile-offset=</varname>,
-                                <varname>keyfile-size=</varname>,
-                                <varname>size=</varname>.</para>
+                                <option>cipher=</option>,
+                                <option>hash=</option>,
+                                <option>keyfile-offset=</option>,
+                                <option>keyfile-size=</option>,
+                                <option>size=</option>.</para>
 
                                 <para>When this mode is used, the passphrase is
                                 read from the key file given in the third field.
                                 passphrase and key files to derive a password
                                 for the volume. Therefore, the passphrase and
                                 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
                                 an empty passphrase in combination with one or
                                 more key files, use <literal>/dev/null</literal>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>tcrypt-hidden</varname></term>
+                                <term><option>tcrypt-hidden</option></term>
 
                                 <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
                                 inside of the volume provided in the second
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>tcrypt-keyfile=</varname></term>
+                                <term><option>tcrypt-keyfile=</option></term>
 
                                 <listitem><para>Specifies the absolute path to a
                                 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
                                 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
                                 when using TrueCrypt encryption mode.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>tcrypt-system</varname></term>
+                                <term><option>tcrypt-system</option></term>
 
                                 <listitem><para>Use TrueCrypt in system
                                 encryption mode. This option implies
-                                <varname>tcrypt</varname>.</para></listitem>
+                                <option>tcrypt</option>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>timeout=</varname></term>
+                                <term><option>timeout=</option></term>
 
                                 <listitem><para>Specifies the timeout for
                                 querying for a password. If no unit is
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>tmp</varname></term>
+                                <term><option>tmp</option></term>
 
                                 <listitem><para>The encrypted block device will
                                 be prepared for using it as <filename>/tmp</filename>;
                                 it will be formatted using
                                 <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
                                 partition during every boot, so make sure the
                                 underlying block device is specified correctly.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>tries=</varname></term>
+                                <term><option>tries=</option></term>
 
                                 <listitem><para>Specifies the maximum number of
                                 times the user is queried for a password.
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>verify</varname></term>
+                                <term><option>verify</option></term>
 
                                 <listitem><para> If the encryption password is
                                 read from console, it has to be entered twice to
index 126b75c..34a1ac8 100644 (file)
                 which influence how dependencies are created for mount
                 points from <filename>/etc/fstab</filename>. systemd
                 will create a dependency of type
-                <option>Wants</option> from either
-                <filename>local-fs.target</filename> or
+                <option>Wants</option> or <option>Requires</option>
+                (see option <option>nofail</option> below), from
+                either <filename>local-fs.target</filename> or
                 <filename>remote-fs.target</filename>, depending
-                whether the file system is local or remote. If
-                <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
-                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
-                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>
+                whether the file system is local or remote.</para>
+
+                <variablelist class='fstab-options'>
+
+                  <varlistentry>
+                    <term><option>x-systemd.automount</option></term>
+
+                    <listitem><para>An automount unit will be created
+                    for the file system. See
+                    <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                    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
                 <filename>/etc/fstab</filename> and a unit file that
index 2ff304f..5c80a7b 100755 (executable)
@@ -113,12 +113,13 @@ TEMPLATE = '''\
         </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
                 encrypted volumes.</para>
 
-                <variablelist id='crypttab-options' />
+                <variablelist id='fstab-options' />
         </refsect1>
 
         <refsect1>