summaryrefslogtreecommitdiff
path: root/man/systemd-cryptsetup-generator.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-09-15 13:43:59 +0100
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-09-20 16:48:50 +0200
commitb66a6e1a5838b874b789820c090dd6850cf10513 (patch)
treedf30d43665c3bd1e29d6efe294c2c9e5e237dfd0 /man/systemd-cryptsetup-generator.xml
parent483bf5643aa1bdb498d7055ea20f534eac1d1486 (diff)
downloadsystemd-b66a6e1a5838b874b789820c090dd6850cf10513.tar.gz
man: "the initial RAM disk" → "the initrd"
In many places we spelled out the phrase behind "initrd" in full, but this isn't terribly useful. In fact, no "RAM disk" is used, so emphasizing this is just confusing to the reader. Let's just say "initrd" everywhere, people understand what this refers to, and that it's in fact an initramfs image. Also, s/i.e./e.g./ where appropriate. Also, don't say "in RAM", when in fact it's virtual memory, whose pages may or may not be loaded in page frames in RAM, and we have no control over this. Also, add <filename></filename> and other minor cleanups.
Diffstat (limited to 'man/systemd-cryptsetup-generator.xml')
-rw-r--r--man/systemd-cryptsetup-generator.xml67
1 files changed, 27 insertions, 40 deletions
diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml
index e5c193f692..5ba024a866 100644
--- a/man/systemd-cryptsetup-generator.xml
+++ b/man/systemd-cryptsetup-generator.xml
@@ -49,48 +49,40 @@
<term><varname>luks=</varname></term>
<term><varname>rd.luks=</varname></term>
- <listitem><para>Takes a boolean argument. Defaults to
- <literal>yes</literal>. If <literal>no</literal>, disables the
- generator entirely. <varname>rd.luks=</varname> is honored
- only by initial RAM disk (initrd) while
- <varname>luks=</varname> is honored by both the main system
- and the initrd. </para></listitem>
+ <listitem><para>Takes a boolean argument. Defaults to <literal>yes</literal>. If
+ <literal>no</literal>, disables the generator entirely. <varname>rd.luks=</varname> is honored only
+ in the initrd while <varname>luks=</varname> is honored by both the main system and in the initrd.
+ </para></listitem>
</varlistentry>
<varlistentry>
<term><varname>luks.crypttab=</varname></term>
<term><varname>rd.luks.crypttab=</varname></term>
- <listitem><para>Takes a boolean argument. Defaults to
- <literal>yes</literal>. If <literal>no</literal>, causes the
- generator to ignore any devices configured in
- <filename>/etc/crypttab</filename>
- (<varname>luks.uuid=</varname> will still work however).
- <varname>rd.luks.crypttab=</varname> is honored only by
- initial RAM disk (initrd) while
- <varname>luks.crypttab=</varname> is honored by both the main
- system and the initrd. </para></listitem>
+ <listitem><para>Takes a boolean argument. Defaults to <literal>yes</literal>. If
+ <literal>no</literal>, causes the generator to ignore any devices configured in
+ <filename>/etc/crypttab</filename> (<varname>luks.uuid=</varname> will still work however).
+ <varname>rd.luks.crypttab=</varname> is honored only in initrd while
+ <varname>luks.crypttab=</varname> is honored by both the main system and the initrd.
+ </para></listitem>
</varlistentry>
<varlistentry>
<term><varname>luks.uuid=</varname></term>
<term><varname>rd.luks.uuid=</varname></term>
- <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/crypttab</filename>.
- This option may be specified more than once in order to set up
- multiple devices. <varname>rd.luks.uuid=</varname> is honored
- only by initial RAM disk (initrd) while
- <varname>luks.uuid=</varname> is honored by both the main
- system and the initrd.</para>
- <para>If /etc/crypttab contains entries with the same UUID,
- then the name, keyfile and options specified there will be
- used. Otherwise, the device will have the name
+ <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/crypttab</filename>. This option may
+ be specified more than once in order to set up multiple devices. <varname>rd.luks.uuid=</varname> is
+ honored only in the initrd, while <varname>luks.uuid=</varname> is honored by both the main system
+ and the initrd.</para>
+
+ <para>If <filename>/etc/crypttab</filename> contains entries with 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>
+
+ <para>If <filename>/etc/crypttab</filename> exists, only those UUIDs specified on the kernel command
+ line will be activated in the initrd or the real root.</para>
</listitem>
</varlistentry>
@@ -108,9 +100,8 @@
<para>This parameter is the analogue of the first <citerefentry><refentrytitle>crypttab</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> field <replaceable>volume-name</replaceable>.</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>
+ <para><varname>rd.luks.name=</varname> is honored only in the initrd, while
+ <varname>luks.name=</varname> is honored by both the main system and the initrd.</para>
</listitem>
</varlistentry>
@@ -137,8 +128,8 @@
<para>This parameter is the analogue of the second <citerefentry><refentrytitle>crypttab</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> field <replaceable>encrypted-device</replaceable>.</para>
- <para><varname>rd.luks.data=</varname> is honored only by initial RAM disk (initrd) while
- <varname>luks.data=</varname> is honored by both the main system and the initrd.</para>
+ <para><varname>rd.luks.data=</varname> is honored only in the initrd, while
+ <varname>luks.data=</varname> is honored by both the main system and in the initrd.</para>
</listitem>
</varlistentry>
@@ -173,12 +164,8 @@
<para>This parameter is the analogue of the third <citerefentry><refentrytitle>crypttab</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> field <replaceable>key-file</replaceable>.</para>
- <para><varname>rd.luks.key=</varname>
- is honored only by initial RAM disk
- (initrd) while
- <varname>luks.key=</varname> is
- honored by both the main system and
- the initrd.</para>
+ <para><varname>rd.luks.key=</varname> is honored only in the initrd, while
+ <varname>luks.key=</varname> is honored by both the main system and in the initrd.</para>
</listitem>
</varlistentry>