summaryrefslogtreecommitdiffstats
path: root/man/os-release.xml
diff options
context:
space:
mode:
authorPhilip Withnall <pwithnall@endlessos.org>2023-05-31 16:49:42 +0200
committerLuca Boccassi <luca.boccassi@gmail.com>2023-06-08 19:54:56 +0200
commite6d712430be8d5c073d6a0ff4ec727d43e16ce33 (patch)
treee0c702d5f6747a1cbfe05b88000de8900d1e06ae /man/os-release.xml
parentman: document that "systemctl mask" doesn't work for units whose file is in /etc (diff)
downloadsystemd-e6d712430be8d5c073d6a0ff4ec727d43e16ce33.tar.xz
systemd-e6d712430be8d5c073d6a0ff4ec727d43e16ce33.zip
man/os-release: Add VENDOR_NAME= and VENDOR_URL= keys to os-release
These will be used in UIs to refer to the company or organization which produces the OS separately from referring to the OS itself. Signed-off-by: Philip Withnall <pwithnall@endlessos.org> Fixes: #27777
Diffstat (limited to 'man/os-release.xml')
-rw-r--r--man/os-release.xml29
1 files changed, 29 insertions, 0 deletions
diff --git a/man/os-release.xml b/man/os-release.xml
index 6cc786acf9..8deb12b190 100644
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -392,6 +392,35 @@
for light blue, or <literal>ANSI_COLOR="0;38;2;60;110;180"</literal> for Fedora blue.
</para></listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><varname>VENDOR_NAME=</varname></term>
+
+ <listitem><para>The name of the OS vendor. This is the name of the organization or company which
+ produces the OS. This field is optional.</para>
+
+ <para>This name is intended to be exposed in "About this system" UIs or software update UIs when
+ needed to distinguish the OS vendor from the OS itself. It is intended to be human readable.</para>
+
+ <para>Examples: <literal>VENDOR_NAME="Fedora Project"</literal> for Fedora Linux,
+ <literal>VENDOR_NAME="Canonical"</literal> for Ubuntu.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>VENDOR_URL=</varname></term>
+
+ <listitem><para>The homepage of the OS vendor. This field is optional. The
+ <varname>VENDOR_NAME=</varname> field should be set if this one is, although clients must be
+ robust against either field not being set.</para>
+
+ <para>The value should be in <ulink
+ url="https://tools.ietf.org/html/rfc3986">RFC3986 format</ulink>, and should be
+ <literal>http:</literal> or <literal>https:</literal> URLs. Only one URL shall be listed in the
+ setting.</para>
+
+ <para>Examples: <literal>VENDOR_URL="https://fedoraproject.org/"</literal>,
+ <literal>VENDOR_URL="https://canonical.com/"</literal>.</para></listitem>
+ </varlistentry>
</variablelist>
</refsect2>