diff options
author | Lennart Poettering <lennart@poettering.net> | 2023-06-30 10:22:35 +0200 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2023-07-04 22:56:59 +0200 |
commit | 8914f7e8e41c0fcd05d3d8d4fe39ce0e6addac69 (patch) | |
tree | 6ff6ab7847ad73735497edb579a447118aa3a7d6 /man | |
parent | journal-remote: upload journals from namespace (diff) | |
download | systemd-8914f7e8e41c0fcd05d3d8d4fe39ce0e6addac69.tar.xz systemd-8914f7e8e41c0fcd05d3d8d4fe39ce0e6addac69.zip |
man: make sure credentials properly show up in directives index
Diffstat (limited to 'man')
-rw-r--r-- | man/directives-template.xml | 9 | ||||
-rw-r--r-- | man/systemd-firstboot.xml | 18 | ||||
-rw-r--r-- | man/systemd-resolved.service.xml | 2 | ||||
-rw-r--r-- | man/systemd-sysctl.service.xml | 4 | ||||
-rw-r--r-- | man/systemd-sysusers.xml | 10 | ||||
-rw-r--r-- | man/systemd-tmpfiles.xml | 4 | ||||
-rw-r--r-- | man/systemd-vconsole-setup.service.xml | 2 | ||||
-rw-r--r-- | man/systemd.system-credentials.xml | 4 | ||||
-rw-r--r-- | man/systemd.xml | 2 |
9 files changed, 32 insertions, 23 deletions
diff --git a/man/directives-template.xml b/man/directives-template.xml index 114707d2d0..0b6ee21929 100644 --- a/man/directives-template.xml +++ b/man/directives-template.xml @@ -50,6 +50,15 @@ </refsect1> <refsect1> + <title>System Credentials</title> + + <para>System credentials understood by the system and service manager and various other + components:</para> + + <variablelist id='system-credentials' /> + </refsect1> + + <refsect1> <title>EFI variables</title> <para>EFI variables understood by diff --git a/man/systemd-firstboot.xml b/man/systemd-firstboot.xml index becb5f52ac..192b91c296 100644 --- a/man/systemd-firstboot.xml +++ b/man/systemd-firstboot.xml @@ -308,10 +308,10 @@ (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry> for details). The following credentials are used when passed in:</para> - <variablelist> + <variablelist class='system-credentials'> <varlistentry> - <term><literal>passwd.hashed-password.root</literal></term> - <term><literal>passwd.plaintext-password.root</literal></term> + <term><varname>passwd.hashed-password.root</varname></term> + <term><varname>passwd.plaintext-password.root</varname></term> <listitem><para>A hashed or plaintext version of the root password to use, in place of prompting the user. These credentials are equivalent to the same ones defined for the @@ -320,7 +320,7 @@ </varlistentry> <varlistentry> - <term><literal>passwd.shell.root</literal></term> + <term><varname>passwd.shell.root</varname></term> <listitem><para>Specifies the shell binary to use for the specified account. Equivalent to the credential of the same name defined for the @@ -329,20 +329,20 @@ </varlistentry> <varlistentry> - <term><literal>firstboot.locale</literal></term> - <term><literal>firstboot.locale-messages</literal></term> + <term><varname>firstboot.locale</varname></term> + <term><varname>firstboot.locale-messages</varname></term> <listitem><para>These credentials specify the locale settings to set during first boot, in place of prompting the user.</para></listitem> </varlistentry> <varlistentry> - <term><literal>firstboot.keymap</literal></term> + <term><varname>firstboot.keymap</varname></term> <listitem><para>This credential specifies the keyboard setting to set during first boot, in place of prompting the user.</para> - <para>Note the relationship to the <literal>vconsole.keymap</literal> credential understood by + <para>Note the relationship to the <varname>vconsole.keymap</varname> credential understood by <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>: both ultimately affect the same setting, but <varname>firstboot.keymap</varname> is written into <filename>/etc/vconsole.conf</filename> on first boot (if not already configured), and then read from @@ -352,7 +352,7 @@ </varlistentry> <varlistentry> - <term><literal>firstboot.timezone</literal></term> + <term><varname>firstboot.timezone</varname></term> <listitem><para>This credential specifies the system timezone setting to set during first boot, in place of prompting the user.</para></listitem> diff --git a/man/systemd-resolved.service.xml b/man/systemd-resolved.service.xml index 05d20bbf35..5a87f04832 100644 --- a/man/systemd-resolved.service.xml +++ b/man/systemd-resolved.service.xml @@ -407,7 +407,7 @@ search foobar.com barbar.com (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry> for details). The following credentials are used when passed in:</para> - <variablelist> + <variablelist class='system-credentials'> <varlistentry> <term><varname>network.dns</varname></term> <term><varname>network.search_domains</varname></term> diff --git a/man/systemd-sysctl.service.xml b/man/systemd-sysctl.service.xml index 4174184c15..975ffadefa 100644 --- a/man/systemd-sysctl.service.xml +++ b/man/systemd-sysctl.service.xml @@ -89,9 +89,9 @@ (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry> for details). The following credentials are used when passed in:</para> - <variablelist> + <variablelist class='system-credentials'> <varlistentry> - <term><literal>sysctl.extra</literal></term> + <term><varname>sysctl.extra</varname></term> <listitem><para>The contents of this credential may contain additional lines to operate on. The credential contents should follow the same format as any other <filename>sysctl.d/</filename> drop-in diff --git a/man/systemd-sysusers.xml b/man/systemd-sysusers.xml index 34d3cab5c7..49f634b180 100644 --- a/man/systemd-sysusers.xml +++ b/man/systemd-sysusers.xml @@ -143,9 +143,9 @@ (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry> for details). The following credentials are used when passed in:</para> - <variablelist> + <variablelist class='system-credentials'> <varlistentry> - <term><literal>passwd.hashed-password.<replaceable>user</replaceable></literal></term> + <term><varname>passwd.hashed-password.<replaceable>user</replaceable></varname></term> <listitem><para>A UNIX hashed password string to use for the specified user, when creating an entry for it. This is particularly useful for the <literal>root</literal> user as it allows provisioning the default root password to use via a unit file drop-in or from a container manager passing in this @@ -155,7 +155,7 @@ </varlistentry> <varlistentry> - <term><literal>passwd.plaintext-password.<replaceable>user</replaceable></literal></term> + <term><varname>passwd.plaintext-password.<replaceable>user</replaceable></varname></term> <listitem><para>Similar to <literal>passwd.hashed-password.<replaceable>user</replaceable></literal> but expect a literal, plaintext password, which is then automatically hashed before used for the user @@ -166,13 +166,13 @@ </varlistentry> <varlistentry> - <term><literal>passwd.shell.<replaceable>user</replaceable></literal></term> + <term><varname>passwd.shell.<replaceable>user</replaceable></varname></term> <listitem><para>Specifies the shell binary to use for the specified account when creating it.</para></listitem> </varlistentry> <varlistentry> - <term><literal>sysusers.extra</literal></term> + <term><varname>sysusers.extra</varname></term> <listitem><para>The contents of this credential may contain additional lines to operate on. The credential contents should follow the same format as any other <filename>sysusers.d/</filename> diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml index 3a9699ff4b..decd66d5c6 100644 --- a/man/systemd-tmpfiles.xml +++ b/man/systemd-tmpfiles.xml @@ -250,9 +250,9 @@ (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry> for details). The following credentials are used when passed in:</para> - <variablelist> + <variablelist class='system-credentials'> <varlistentry> - <term><literal>tmpfiles.extra</literal></term> + <term><varname>tmpfiles.extra</varname></term> <listitem><para> The contents of this credential may contain additional lines to operate on. The credential contents should follow the same format as any other <filename>tmpfiles.d/</filename> diff --git a/man/systemd-vconsole-setup.service.xml b/man/systemd-vconsole-setup.service.xml index f9f8327a68..e462ef8f60 100644 --- a/man/systemd-vconsole-setup.service.xml +++ b/man/systemd-vconsole-setup.service.xml @@ -57,7 +57,7 @@ (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry> for details). The following credentials are used when passed in:</para> - <variablelist> + <variablelist class='system-credentials'> <varlistentry> <term><varname>vconsole.keymap</varname></term> <term><varname>vconsole.keymap_toggle</varname></term> diff --git a/man/systemd.system-credentials.xml b/man/systemd.system-credentials.xml index f75a83cc3f..97507cf252 100644 --- a/man/systemd.system-credentials.xml +++ b/man/systemd.system-credentials.xml @@ -40,7 +40,7 @@ <refsect1> <title>Well known system credentials</title> - <variablelist> + <variablelist class='system-credentials'> <varlistentry> <term><varname>firstboot.keymap</varname></term> <listitem> @@ -52,7 +52,7 @@ <varlistentry> <term><varname>firstboot.locale</varname></term> - <term><varname>firstboot.locale-message</varname></term> + <term><varname>firstboot.locale-messages</varname></term> <listitem> <para>The system locale to set (e.g. <literal>de_DE.UTF-8</literal>). Read by <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>, diff --git a/man/systemd.xml b/man/systemd.xml index 3ceac5f919..d63e70f0c8 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -1053,7 +1053,7 @@ <para>The service manager when run as PID 1 reads the following system credentials:</para> - <variablelist> + <variablelist class='system-credentials'> <varlistentry> <term><varname>vmm.notify_socket</varname></term> <listitem> |