man: document systemd-run

[elogind.git] / man / crypttab.xml

diff --git a/man/crypttab.xml b/man/crypttab.xml
index 2a839944dc4d87f8e2eb8e2a0a6cd1f1b29319c1..e52b7e6015b29b92abde16ddc694b5f54861cb5c 100644 (file)
--- a/man/crypttab.xml
+++ b/man/crypttab.xml
@@ -25,7 +25,7 @@
   The Red Hat version has been written by Miloslav Trmac <mitr@redhat.com>.
 
 -->
   The Red Hat version has been written by Miloslav Trmac <mitr@redhat.com>.
 
 -->

-<refentry id="crypttab">
+<refentry id="crypttab" conditional='HAVE_LIBCRYPTSETUP'>

 
         <refentryinfo>
                 <title>crypttab</title>
 
         <refentryinfo>
                 <title>crypttab</title>


@@ -68,7 +68,7 @@
                 describes encrypted block devices that are set up
                 during system boot.</para>
 
                 describes encrypted block devices that are set up
                 during system boot.</para>
 

-                <para>Empty lines and lines starting with the #
+                <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.  The first two
                 character are ignored.  Each of the remaining lines
                 describes one encrypted block device, fields on the
                 line are delimited by white space.  The first two


@@ -83,15 +83,15 @@
                 underlying block device, or a specification of a block
                 device via <literal>UUID=</literal> followed by the
                 UUID.  If the block device contains a LUKS signature,
                 underlying block device, or a specification of a block
                 device via <literal>UUID=</literal> followed by the
                 UUID.  If the block device contains a LUKS signature,

-                it is opened as a LUKS encrypted partition; otherwise
+                it is opened as a LUKS encrypted partition; otherwise,

                 it is assumed to be a raw dm-crypt partition.</para>
 
                 <para>The third field specifies the encryption
                 password.  If the field is not present or the password
                 is set to none, the password has to be manually
                 it is assumed to be a raw dm-crypt partition.</para>
 
                 <para>The third field specifies the encryption
                 password.  If the field is not present or the password
                 is set to none, the password has to be manually

-                entered during system boot.  Otherwise the field is
+                entered during system boot.  Otherwise, the field is

                 interpreted as a path to a file containing the
                 interpreted as a path to a file containing the

-                encryption password.  For swap encryption
+                encryption password.  For swap encryption,

                 <filename>/dev/urandom</filename> or the hardware
                 device <filename>/dev/hw_random</filename> can be used
                 as the password file; using
                 <filename>/dev/urandom</filename> or the hardware
                 device <filename>/dev/hw_random</filename> can be used
                 as the password file; using


@@ -103,7 +103,7 @@
                 comma-delimited list of options.  The following
                 options are recognized:</para>
 
                 comma-delimited list of options.  The following
                 options are recognized:</para>
 

-                <variablelist>
+                <variablelist class='crypttab-options'>

                         <varlistentry>
                                 <term><varname>cipher=</varname></term>
 
                         <varlistentry>
                                 <term><varname>cipher=</varname></term>
 


@@ -182,7 +182,7 @@
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>

-                                <term><varname>read-only</varname></term>
+                                <term><varname>read-only</varname></term><term><varname>readonly</varname></term>

 
                                 <listitem><para>Set up the encrypted
                                 block device in read-only
 
                                 <listitem><para>Set up the encrypted
                                 block device in read-only


@@ -219,8 +219,10 @@
                                 <listitem><para>Specify the timeout
                                 for querying for a password. If no
                                 unit is specified seconds is used.
                                 <listitem><para>Specify the timeout
                                 for querying for a password. If no
                                 unit is specified seconds is used.

-                                Supported units are s, ms,
-                                us, min, h, d.</para></listitem>
+                                Supported units are s, ms, us, min, h,
+                                d. A timeout of 0 waits indefinitely
+                                (which is the
+                                default).</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -237,7 +239,7 @@
                                 <listitem><para>The system will not
                                 wait for the device to show up and be
                                 unlocked at boot, and not fail the
                                 <listitem><para>The system will not
                                 wait for the device to show up and be
                                 unlocked at boot, and not fail the

-                                boot if it doesn't show
+                                boot if it does not show

                                 up.</para></listitem>
                         </varlistentry>
 
                                 up.</para></listitem>
                         </varlistentry>
 


@@ -280,7 +282,7 @@
                 </variablelist>
 
                 <para>At early boot and when the system manager
                 </variablelist>
 
                 <para>At early boot and when the system manager

-                configuration is reloaded this file is translated into
+                configuration is reloaded, this file is translated into

                 native systemd units
                 by <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
         </refsect1>
                 native systemd units
                 by <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
         </refsect1>