]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: make sure credentials properly show up in directives index
authorLennart Poettering <lennart@poettering.net>
Fri, 30 Jun 2023 08:22:35 +0000 (10:22 +0200)
committerLennart Poettering <lennart@poettering.net>
Tue, 4 Jul 2023 20:56:59 +0000 (22:56 +0200)
man/directives-template.xml
man/systemd-firstboot.xml
man/systemd-resolved.service.xml
man/systemd-sysctl.service.xml
man/systemd-sysusers.xml
man/systemd-tmpfiles.xml
man/systemd-vconsole-setup.service.xml
man/systemd.system-credentials.xml
man/systemd.xml
src/firstboot/firstboot.c

index 114707d2d00017ce190ef55a4c59467870847bf1..0b6ee2192935248282e4160bc686a16d1882dde1 100644 (file)
     <variablelist id='environment-variables' />
   </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>
 
index becb5f52ace9c51139ac6bed7daf078182ebc897..192b91c2964d2168690d567f84a3414a6ccafadd 100644 (file)
     (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
       </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
       </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
       </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>
index 05d20bbf35502da8731143aa440bce5ec223eeb0..5a87f04832395e5a00eb33fcd46d471280d61c87 100644 (file)
@@ -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>
index 4174184c152e63ba8e1cf9dff32b481bb4769789..975ffadefa16e15a6ec3bc97b714e541252fd939 100644 (file)
@@ -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
index 34d3cab5c7e6582e913a81bab8afe58d8b04c20b..49f634b18076e2f5f2c1b2ed50c9c40db221e1ce 100644 (file)
     (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
       </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
       </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>
index 3a9699ff4b12e832acfd6e9ac9fee9f8dce43461..decd66d5c66730fbf3d20a12ada020a0a67865f5 100644 (file)
     (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>
index f9f8327a68cdf2566d45ba390edec4b624444cc2..e462ef8f60343f2bb5da8e8345373f757aa2d152 100644 (file)
@@ -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>
index f75a83cc3fb6a63b4adc167e70bd8df7159dbf6e..97507cf25257fd73efd6fc633fb41993ce7129ca 100644 (file)
@@ -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>,
index 3ceac5f9194599c6ebc5b2c8fc9e9a9941579a23..d63e70f0c879cebfd822deb4a4f815f6efba5cd5 100644 (file)
 
     <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>
index 29fc61dd67e2ad6308e997cb9bcebf0d5a22335c..076e06e8215bd1bca81f5c1cc1cf19e3305d6a01 100644 (file)
@@ -334,7 +334,7 @@ static int prompt_locale(int rfd) {
 
         r = read_credential("firstboot.locale-messages", (void**) &arg_locale_messages, NULL);
         if (r < 0)
-                log_debug_errno(r, "Failed to read credential firstboot.locale-message, ignoring: %m");
+                log_debug_errno(r, "Failed to read credential firstboot.locale-messages, ignoring: %m");
         else
                 acquired_from_creds = true;