doc: os-release: mention all shell characters that must be escaped

[elogind.git] / man / systemd-cryptsetup-generator.xml

diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml
index d6b7e49f1305b8753474c4e6e7faf560c9f3f3f7..c8753cef37dff7a88214fe98e25f9863750d2803 100644 (file)
--- a/man/systemd-cryptsetup-generator.xml
+++ b/man/systemd-cryptsetup-generator.xml
@@ -115,12 +115,12 @@
                                 <term><varname>luks.uuid=</varname></term>
                                 <term><varname>rd.luks.uuid=</varname></term>
 
-                                <listitem><para>Takes a LUKS super
-                                block UUID as argument. This will
+                                <listitem><para>Takes a LUKS superblock
+                                UUID as argument. This will
                                 activate the specified device as part
                                 of the boot process as if it was
                                 listed in
-                                <filename>/etc/fstab</filename>. This
+                                <filename>/etc/crypttab</filename>. This
                                 option may be specified more than once
                                 in order to set up multiple
                                 devices. <varname>rd.luks.uuid=</varname>
@@ -130,14 +130,34 @@
                                 honored by both the main system and
                                 the initrd.</para>
                                 <para>If /etc/crypttab contains entries with
-                                the same UUID, then the options for this entry
-                                will be used.</para>
-                                <para>If /etc/crypttab exists, only those UUID
+                                the same UUID, then the name, keyfile and options
+                                specified there will be used. Otherwise the device
+                                will have the name <literal>luks-UUID</literal>.</para>
+                                <para>If /etc/crypttab exists, only those UUIDs
                                 specified on the kernel command line
                                 will be activated in the initrd or the real root.</para>
                                 </listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>luks.name=</varname></term>
+                                <term><varname>rd.luks.name=</varname></term>
+
+                                <listitem><para>Takes a LUKS super
+                                block UUID followed by an '=' and a name. This implies
+                                <varname>rd.luks.uuid=</varname> or <varname>luks.uuid=</varname>
+                                and will additionally make the LUKS device given by
+                                the UUID appear under the provided name.</para>
+
+                                <para><varname>rd.luks.name=</varname>
+                                is honored only by initial RAM disk
+                                (initrd) while
+                                <varname>luks.name=</varname> is
+                                honored by both the main system and
+                                the initrd.</para>
+                                </listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><varname>luks.options=</varname></term>
                                 <term><varname>rd.luks.options=</varname></term>
@@ -164,11 +184,16 @@
                                 <term><varname>luks.key=</varname></term>
                                 <term><varname>rd.luks.key=</varname></term>
 
-                                <listitem><para>Takes a password file as argument.</para>
+                                <listitem><para>Takes a password file name as argument or
+                                a LUKS super block UUID followed by a '=' and a password
+                                file name.</para>
+
                                 <para>For those entries specified with
                                 <varname>rd.luks.uuid=</varname> or <varname>luks.uuid=</varname>,
-                                the password file will be set to the password file specified by
-                                <varname>rd.luks.key=</varname> or <varname>luks.key</varname></para>
+                                the password file will be set to the one specified by
+                                <varname>rd.luks.key=</varname> or <varname>luks.key=</varname>
+                                of the corresponding UUID, or the password file that was specified
+                                without a UUID.</para>
                                 <para><varname>rd.luks.key=</varname>
                                 is honored only by initial RAM disk
                                 (initrd) while