From: Lennart Poettering <lennart@poettering.net>
Date: Thu, 29 Jun 2023 13:57:26 +0000 (+0200)
Subject: man: add brief smbios-type-11 man page
X-Git-Tag: v254-rc1~73
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=eb99c45914fe2883a21879f1490cf4d2ff4fba70;p=thirdparty%2Fsystemd.git

man: add brief smbios-type-11 man page
---

diff --git a/man/directives-template.xml b/man/directives-template.xml
index f28bd98d25f..114707d2d00 100644
--- a/man/directives-template.xml
+++ b/man/directives-template.xml
@@ -32,6 +32,14 @@
     <variablelist id='kernel-commandline-options' />
   </refsect1>
 
+  <refsect1>
+    <title>SMBIOS Type 11 Variables</title>
+
+    <para>Data passed from VMM to system via SMBIOS Type 11.</para>
+
+    <variablelist id='smbios-type-11-options' />
+  </refsect1>
+
   <refsect1>
     <title>Environment variables</title>
 
diff --git a/man/kernel-command-line.xml b/man/kernel-command-line.xml
index eef6db4a5c5..93ed4f6acb5 100644
--- a/man/kernel-command-line.xml
+++ b/man/kernel-command-line.xml
@@ -628,6 +628,8 @@
         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
         <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
         <citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+        <citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+        <citerefentry><refentrytitle>smbios-type-11</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
         <citerefentry project='man-pages'><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>,
diff --git a/man/rules/meson.build b/man/rules/meson.build
index e5a36c43d88..e8c5a967ad9 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -876,6 +876,7 @@ manpages = [
   'HAVE_PAM'],
  ['sd_watchdog_enabled', '3', [], ''],
  ['shutdown', '8', [], ''],
+ ['smbios-type-11', '7', [], ''],
  ['sysctl.d', '5', [], ''],
  ['systemctl', '1', [], ''],
  ['systemd-ac-power', '1', [], ''],
diff --git a/man/smbios-type-11.xml b/man/smbios-type-11.xml
new file mode 100644
index 00000000000..5b8b32b0e99
--- /dev/null
+++ b/man/smbios-type-11.xml
@@ -0,0 +1,75 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
+
+<refentry id="smbios-type-11">
+
+  <refentryinfo>
+    <title>smbios-type-11</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>smbios-type-11</refentrytitle>
+    <manvolnum>7</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>smbios-type-11</refname>
+    <refpurpose>SMBIOS Type 11 strings</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <para><filename>/sys/firmware/dmi/entries/11-*/raw</filename></para>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>Various OS components process SMBIOS Type 11 vendor strings that a virtual machine manager (VMM)
+    may set and a virtual machine (VM) receives. SMBIOS Type 11 vendor strings may play a similar role as
+    <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    parameters but generally are under control of the VMM rather than the boot loader or UKI.</para>
+
+    <para>For details on SMBIOS Type 11 see the <ulink url="https://www.dmtf.org/standards/smbios/">System
+    Management BIOS</ulink> specifications.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Core OS Command Line Arguments</title>
+
+    <para>The following strings are supported:</para>
+
+    <variablelist class='smbios-type-11-options'>
+      <varlistentry>
+        <term><varname>io.systemd.credential:</varname><replaceable>CREDENTIAL=VALUE</replaceable></term>
+        <term><varname>io.systemd.credential.binary:</varname><replaceable>CREDENTIAL=VALUE</replaceable></term>
+
+        <listitem><para>This allows passing additional system credentials into the system, in textual or binary (Base64)
+        form. See
+        <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
+        <ulink url="https://systemd.io/CREDENTIALS">System and Service Credentials</ulink> for
+        details.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>io.systemd.stub.kernel-cmdline-extra=</varname><replaceable>CMDLINE</replaceable></term>
+
+        <listitem><para>This allows configuration of additional kernel command line options, and is read by
+        the kernel UEFI stub. For details see
+        <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+      <title>See Also</title>
+      <para>
+        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+        <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+        <citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+      </para>
+  </refsect1>
+
+</refentry>
diff --git a/man/systemd.system-credentials.xml b/man/systemd.system-credentials.xml
index 62f86d1254e..f75a83cc3fb 100644
--- a/man/systemd.system-credentials.xml
+++ b/man/systemd.system-credentials.xml
@@ -215,7 +215,8 @@
       <title>See Also</title>
       <para>
         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-        <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+        <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+        <citerefentry><refentrytitle>smbios-type-11</refentrytitle><manvolnum>7</manvolnum></citerefentry>
       </para>
   </refsect1>