firstboot: Update help string with --root-shell options

[thirdparty/systemd.git] / man / os-release.xml

diff --git a/man/os-release.xml b/man/os-release.xml
index 0efd2638410e4c10145fab6feebf2869a27cc651..a2164436c37502a5ddb8b2fa9040ae8bd10b0590 100644 (file)
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -1,10 +1,7 @@
 <?xml version='1.0'?> <!--*-nxml-*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!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+
--->
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 
 <refentry id="os-release">
   <refentryinfo>
@@ -90,7 +87,7 @@
     <para>The following OS identifications parameters may be set using
     <filename>os-release</filename>:</para>
 
-    <variablelist>
+    <variablelist class='environment-variables'>
 
       <varlistentry>
         <term><varname>NAME=</varname></term>
@@ -195,13 +192,11 @@
       <varlistentry>
         <term><varname>ANSI_COLOR=</varname></term>
 
-        <listitem><para>A suggested presentation color when showing
-        the OS name on the console. This should be specified as string
-        suitable for inclusion in the ESC [ m ANSI/ECMA-48 escape code
-        for setting graphical rendition. This field is optional.
-        Example: <literal>ANSI_COLOR="0;31"</literal> for red, or
-        <literal>ANSI_COLOR="1;34"</literal> for light
-        blue.</para></listitem>
+        <listitem><para>A suggested presentation color when showing the OS name on the console. This should
+        be specified as string suitable for inclusion in the ESC [ m ANSI/ECMA-48 escape code for setting
+        graphical rendition. This field is optional.  Example: <literal>ANSI_COLOR="0;31"</literal> for red,
+        <literal>ANSI_COLOR="1;34"</literal> for light blue, or
+        <literal>ANSI_COLOR="0;38;2;60;110;180"</literal> for Fedora blue.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -223,7 +218,7 @@
         <term><varname>BUG_REPORT_URL=</varname></term>
         <term><varname>PRIVACY_POLICY_URL=</varname></term>
 
-        <listitem><para>Links to resources on the Internet related to 
+        <listitem><para>Links to resources on the Internet related to
         the operating system.
         <varname>HOME_URL=</varname> should refer to the homepage of
         the operating system, or alternatively some homepage of the
@@ -306,6 +301,22 @@
         </para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><varname>LOGO=</varname></term>
+
+        <listitem><para>
+        A string, specifying the name of an icon as defined by <ulink
+        url="http://standards.freedesktop.org/icon-theme-spec/latest">
+        freedesktop.org Icon Theme Specification</ulink>. This can be
+        used by graphical applications to display an operating
+        system's or distributor's logo. This field is optional and
+        may not necessarily be implemented on all systems.
+        Examples:
+        <literal>LOGO=fedora-logo</literal>,
+        <literal>LOGO=distributor-logo-opensuse</literal>
+        </para></listitem>
+      </varlistentry>
+
     </variablelist>
 
     <para>If you are reading this file from C code or a shell script
@@ -328,20 +339,36 @@
     name in order to avoid name clashes. Applications
     reading this file must ignore unknown fields. Example:
     <literal>DEBIAN_BTS="debbugs://bugs.debian.org/"</literal></para>
+
+    <para>Container and sandbox runtime managers may make the host's
+    identification data available to applications by providing the host's
+    <filename>/etc/os-release</filename> (if available, otherwise
+    <filename>/usr/lib/os-release</filename> as a fallback) as
+    <filename>/run/host/os-release</filename>.</para>
   </refsect1>
 
   <refsect1>
     <title>Example</title>
 
     <programlisting>NAME=Fedora
-VERSION="17 (Beefy Miracle)"
+VERSION="32 (Workstation Edition)"
 ID=fedora
-VERSION_ID=17
-PRETTY_NAME="Fedora 17 (Beefy Miracle)"
-ANSI_COLOR="0;34"
-CPE_NAME="cpe:/o:fedoraproject:fedora:17"
+VERSION_ID=32
+PRETTY_NAME="Fedora 32 (Workstation Edition)"
+ANSI_COLOR="0;38;2;60;110;180"
+LOGO=fedora-logo-icon
+CPE_NAME="cpe:/o:fedoraproject:fedora:32"
 HOME_URL="https://fedoraproject.org/"
-BUG_REPORT_URL="https://bugzilla.redhat.com/"</programlisting>
+DOCUMENTATION_URL="https://docs.fedoraproject.org/en-US/fedora/f32/system-administrators-guide/"
+SUPPORT_URL="https://fedoraproject.org/wiki/Communicating_and_getting_help"
+BUG_REPORT_URL="https://bugzilla.redhat.com/"
+REDHAT_BUGZILLA_PRODUCT="Fedora"
+REDHAT_BUGZILLA_PRODUCT_VERSION=32
+REDHAT_SUPPORT_PRODUCT="Fedora"
+REDHAT_SUPPORT_PRODUCT_VERSION=32
+PRIVACY_POLICY_URL="https://fedoraproject.org/wiki/Legal:PrivacyPolicy"
+VARIANT="Workstation Edition"
+VARIANT_ID=workstation</programlisting>
   </refsect1>
 
   <refsect1>