man: use <constant> for various constants which look ugly with quotes

[elogind.git] / man / crypttab.xml

diff --git a/man/crypttab.xml b/man/crypttab.xml
index d61ec95e4cbaedc49b6f3b3cce760e51d63fca06..1063b46e06c452a8220eff57579fa691731f4af5 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


@@ -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>
 


@@ -130,6 +130,30 @@
                         </varlistentry>
 
 
                         </varlistentry>
 
 

+                        <varlistentry>
+                                <term><varname>keyfile-size=</varname></term>
+
+                                <listitem><para>Specifies the maximum number
+                                of bytes to read from the keyfile; see
+                                <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                                for possible values and the default
+                                value of this option. This option is ignored
+                                in plain encryption mode, as the keyfile-size is then given by the key size.</para></listitem>
+                        </varlistentry>
+
+
+                        <varlistentry>
+                                <term><varname>keyfile-offset=</varname></term>
+
+                                <listitem><para>Specifies the number
+                                of bytes to skip at the start of
+                                the keyfile; see
+                                <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                                for possible values and the default
+                                value of this option.</para></listitem>
+                        </varlistentry>
+
+

                         <varlistentry>
                                 <term><varname>hash=</varname></term>
 
                         <varlistentry>
                                 <term><varname>hash=</varname></term>
 


@@ -151,14 +175,14 @@
                         <varlistentry>
                                 <term><varname>verify</varname></term>
 
                         <varlistentry>
                                 <term><varname>verify</varname></term>
 

-                                <listitem><para> If the the encryption
+                                <listitem><para> If the encryption

                                 password is read from console, it has
                                 to be entered twice (to prevent
                                 typos). </para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 password is read from console, it has
                                 to be entered twice (to prevent
                                 typos). </para></listitem>
                         </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


@@ -193,10 +217,12 @@
                                 <term><varname>timeout=</varname></term>
 
                                 <listitem><para>Specify the timeout
                                 <term><varname>timeout=</varname></term>
 
                                 <listitem><para>Specify the timeout

-                                for querying for a password. If not
-                                unit is specified in
-                                seconds. Supported units are s, ms,
-                                us, min, h, d.</para></listitem>
+                                for querying for a password. If no
+                                unit is specified seconds is used.
+                                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>


@@ -255,6 +281,10 @@
                         </varlistentry>
                 </variablelist>
 
                         </varlistentry>
                 </variablelist>
 

+                <para>At early boot and when the system manager
+                configuration is reloaded this file is translated into
+                native systemd units
+                by <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>

         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>


@@ -275,6 +305,7 @@ swap /dev/sda7 /dev/urandom swap</programlisting>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,

+                        <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,

                         <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                         <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry>