summaryrefslogtreecommitdiff
path: root/man/os-release.xml
diff options
context:
space:
mode:
authorStephen Gallagher <sgallagh@redhat.com>2018-10-04 07:19:18 -0500
committerLennart Poettering <lennart@poettering.net>2018-10-04 21:29:18 +0200
commita3e0bba8a9d032413b8540f169cb83b5fd31fb7c (patch)
tree54969b930cfcdbb08d5254368f8ddf64b3b28609 /man/os-release.xml
parent880512fe6aed8c824c536994d71859ed9a76e5eb (diff)
downloadsystemd-a3e0bba8a9d032413b8540f169cb83b5fd31fb7c.tar.gz
Add DOCUMENTATION_URL as a standard value for /etc/os-release
It is very useful for distributions to be able to set a primary documentation URL in a standard location so that users and applications on the system can identify it. For example, many headless systems these days use the "Cockpit" admin console. It would be ideal if we could specify this location directly in the os-release file so that any application or service could have a well-known location for retrieving this and displaying it appropriately. Users could likewise examine /etc/os-release to learn this location. Related: https://github.com/cockpit-project/cockpit/issues/10198 Signed-off-by: Stephen Gallagher <sgallagh@redhat.com>
Diffstat (limited to 'man/os-release.xml')
-rw-r--r--man/os-release.xml10
1 files changed, 7 insertions, 3 deletions
diff --git a/man/os-release.xml b/man/os-release.xml
index 58b86390da..0efd263841 100644
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -218,14 +218,18 @@
<varlistentry>
<term><varname>HOME_URL=</varname></term>
+ <term><varname>DOCUMENTATION_URL=</varname></term>
<term><varname>SUPPORT_URL=</varname></term>
<term><varname>BUG_REPORT_URL=</varname></term>
<term><varname>PRIVACY_POLICY_URL=</varname></term>
<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 specific version of the operating system.
+ the operating system.
+ <varname>HOME_URL=</varname> should refer to the homepage of
+ the operating system, or alternatively some homepage of the
+ specific version of the operating system.
+ <varname>DOCUMENTATION_URL=</varname> should refer to the main
+ documentation page for this operating system.
<varname>SUPPORT_URL=</varname> should refer to the main
support page for the operating system, if there is any. This
is primarily intended for operating systems which vendors