cryptsetup-generator: Add support for naming luks devices on kernel cmdline

[elogind.git] / man / kernel-command-line.xml

diff --git a/man/kernel-command-line.xml b/man/kernel-command-line.xml
index d5c3f34c6f775a67f8caad7dba2ef37e0ac57c91..e32ed1972e8c908f065a300469cd6f4393a31dbf 100644 (file)
--- a/man/kernel-command-line.xml
+++ b/man/kernel-command-line.xml
@@ -44,7 +44,7 @@
 
         <refnamediv>
                 <refname>kernel-command-line</refname>
-                <refpurpose>Kernel Command Line Parameters</refpurpose>
+                <refpurpose>Kernel command line parameters</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -59,14 +59,14 @@
                 kernel command line arguments.</para>
 
                 <para>For command line parameters understood by the
-                kernel please see <ulink
+                kernel, please see <ulink
                 url="https://www.kernel.org/doc/Documentation/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
                 and
-                <citerefentry><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
+                <citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
 
-                <para>For command line paramaters understood by the
+                <para>For command line parameters understood by the
                 initial RAM disk, please see
-                <citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                <citerefentry project='die-net'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
                 or the documentation of the specific initrd
                 implementation of your installation.</para>
         </refsect1>
@@ -74,7 +74,7 @@
         <refsect1>
                 <title>Core OS Command Line Arguments</title>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>systemd.unit=</varname></term>
                                 <term><varname>rd.systemd.unit=</varname></term>
@@ -93,11 +93,40 @@
                                 <listitem>
                                         <para>Parameters understood by
                                         the system and service manager
-                                        to control system behaviour. For details see
+                                        to control system behavior. For details, see
                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>systemd.mask=</varname></term>
+                                <term><varname>systemd.wants=</varname></term>
+                                <term><varname>systemd.debug-shell</varname></term>
+                                <listitem>
+                                        <para>Additional parameters
+                                        understood by
+                                        <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                                        to mask or start specific
+                                        units at boot, or invoke a
+                                        debug shell on tty9.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>systemd.restore_state=</varname></term>
+                                <listitem>
+                                        <para>This parameter is understood by
+                                        several system tools to control
+                                        whether or not they should restore
+                                        system state from the previous boot.
+                                        For details, see
+                                        <citerefentry><refentrytitle>systemd-backlight@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                                        and
+                                        <citerefentry><refentrytitle>systemd-rfkill@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+                                        </para>
+                                </listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><varname>quiet</varname></term>
                                 <listitem>
@@ -105,13 +134,27 @@
                                         both the kernel and the system
                                         and service manager to control
                                         console log verbosity. For
-                                        details see
+                                        details, see
+                                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>debug</varname></term>
+                                <listitem>
+                                        <para>Parameter understood by
+                                        both the kernel and the system
+                                        and service manager to control
+                                        console log verbosity. For
+                                        details, see
                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
 
                         <varlistentry>
+                                <term><varname>-b</varname></term>
                                 <term><varname>emergency</varname></term>
+                                <term><varname>rescue</varname></term>
                                 <term><varname>single</varname></term>
                                 <term><varname>s</varname></term>
                                 <term><varname>S</varname></term>
@@ -124,7 +167,7 @@
                                         <para>Parameters understood by
                                         the system and service
                                         manager, as compatibility
-                                        options. For details see
+                                        options. For details, see
                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
@@ -148,18 +191,19 @@
                                         <para>Parameters understood by
                                         the system and service manager
                                         to control locale and language
-                                        settings. For details see
+                                        settings. For details, see
                                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><varname>fsck.mode=</varname></term>
+                                <term><varname>fsck.repair=</varname></term>
 
                                 <listitem>
-                                        <para>Parameter understood by
+                                        <para>Parameters understood by
                                         the file system checker
-                                        services. For details see
+                                        services. For details, see
                                         <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
@@ -170,7 +214,7 @@
                                 <listitem>
                                         <para>Parameter understood by
                                         the file quota checker
-                                        service. For details see
+                                        service. For details, see
                                         <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
@@ -179,11 +223,12 @@
                                 <term><varname>systemd.journald.forward_to_syslog=</varname></term>
                                 <term><varname>systemd.journald.forward_to_kmsg=</varname></term>
                                 <term><varname>systemd.journald.forward_to_console=</varname></term>
+                                <term><varname>systemd.journald.forward_to_wall=</varname></term>
 
                                 <listitem>
                                         <para>Parameters understood by
                                         the journal service. For
-                                        details see
+                                        details, see
                                         <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
@@ -198,7 +243,7 @@
                                 <listitem>
                                         <para>Parameters understood by
                                         the virtual console setup logic. For
-                                        details see
+                                        details, see
                                         <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
@@ -210,11 +255,14 @@
                                 <term><varname>rd.udev.children-max=</varname></term>
                                 <term><varname>udev.exec-delay=</varname></term>
                                 <term><varname>rd.udev.exec-delay=</varname></term>
+                                <term><varname>udev.event-timeout=</varname></term>
+                                <term><varname>rd.udev.event-timeout=</varname></term>
+                                <term><varname>net.ifnames=</varname></term>
 
                                 <listitem>
                                         <para>Parameters understood by
                                         the device event managing daemon. For
-                                        details see
+                                        details, see
                                         <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
@@ -225,8 +273,8 @@
                                 <listitem>
                                         <para>May be used to disable
                                         the Plymouth boot splash. For
-                                        details see
-                                        <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+                                        details, see
+                                        <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
 
@@ -235,13 +283,19 @@
                                 <term><varname>rd.luks=</varname></term>
                                 <term><varname>luks.crypttab=</varname></term>
                                 <term><varname>rd.luks.crypttab=</varname></term>
+                                <term><varname>luks.name=</varname></term>
+                                <term><varname>rd.luks.name=</varname></term>
                                 <term><varname>luks.uuid=</varname></term>
                                 <term><varname>rd.luks.uuid=</varname></term>
+                                <term><varname>luks.options=</varname></term>
+                                <term><varname>rd.luks.options=</varname></term>
+                                <term><varname>luks.key=</varname></term>
+                                <term><varname>rd.luks.key=</varname></term>
 
                                 <listitem>
                                         <para>Configures the LUKS
                                         full-disk encryption logic at
-                                        boot. For details see
+                                        boot. For details, see
                                         <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
@@ -253,23 +307,66 @@
                                 <listitem>
                                         <para>Configures the
                                         <filename>/etc/fstab</filename>
-                                        logic at boot. For details see
+                                        logic at boot. For details, see
+                                        <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+                                </listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>root=</varname></term>
+                                <term><varname>rootfstype=</varname></term>
+                                <term><varname>rootfsflags=</varname></term>
+                                <term><varname>ro</varname></term>
+                                <term><varname>rw</varname></term>
+
+                                <listitem>
+                                        <para>Configures the root file
+                                        system and its file system
+                                        type and mount options, as
+                                        well as whether it shall be
+                                        mounted read-only or
+                                        read-writable initially. For
+                                        details, see
                                         <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>systemd.gpt_auto=</varname></term>
+                                <term><varname>rd.systemd.gpt_auto=</varname></term>
+
+                                <listitem>
+                                        <para>Configures whether GPT
+                                        based partition auto-discovery
+                                        shall be attempted. For
+                                        details, see
+                                        <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+                                </listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><varname>modules-load=</varname></term>
                                 <term><varname>rd.modules-load=</varname></term>
 
                                 <listitem>
                                         <para>Load a specific kernel
-                                        boot early at boot. For
-                                        details see
+                                        module early at boot. For
+                                        details, see
                                         <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
                                 </listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>resume=</varname></term>
+
+                                <listitem>
+                                        <para>Enables resume from hibernation
+                                        using the specified device.
+                                        All <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-like
+                                        paths are supported. For details, see
+                                        <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+                                </listitem>
+                        </varlistentry>
                 </variablelist>
 
         </refsect1>
@@ -278,17 +375,22 @@
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                          <citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                          <citerefentry project='die-net'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-backlight@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-rfkill@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                   </para>
         </refsect1>