From: Lennart Poettering Date: Tue, 6 Mar 2012 16:44:32 +0000 (+0100) Subject: man: add URL field definitions to os-release(5) X-Git-Tag: v44~55 X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=62ca938d2d217bae94e961be977bbaa2daef3675;p=systemd man: add URL field definitions to os-release(5) As requested by Raphaël Hertzog from the Debian project, include information about the home page and support/bug report pages in /etc/os-release. --- diff --git a/man/os-release.xml b/man/os-release.xml index 0d7925f0..8ffb5de4 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -156,13 +156,17 @@ operating system in regards to packaging and programming interfaces, for example listing one or more - distribution identifiers the local - distribution is a derivative - from. Build scripts and similar should - check this variable if they need to - identify the local operating system - and the value of - ID= is not + OS identifiers the local + OS is a derivative from. An + OS should generally only list other OS + identifiers it itself is a derivative + from, and not any OSes that + are derived from it, but symmetric + relationships are possible. Build + scripts and similar should check this + variable if they need to identify the + local operating system and the value + of ID= is not recognized. Operating systems should be listed in order of how closely the local operating system relates to the @@ -215,7 +219,7 @@ A suggested presentation color when showing the - distribution name on the console. This + 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 @@ -240,13 +244,64 @@ CPE_NAME="cpe:/o:fedoraproject:fedora:17" + + + HOME_URL= + SUPPORT_URL= + BUG_REPORT_URL= + + Links to resources on + the Internet related the operating + system. HOME_URL= + should refer to the homepage of the of + operating system, or alternatively + some homepage of the specific version + of the operating + system. SUPPORT_URL= + should refer to the main support page + for the operating system, if there is + any. This is primarily intended for + operating systems which vendors + provide support + for. BUG_REPORT_URL= + should refer to the main bug reporting + page for the operating system, if + there is any. This is primarily + intended for operating systems that + rely on community QA. These settings + are optional, and providing only some + of these settings is common. These + URLs are intended to be exposed in + "About this system" UIs behind links + with captions such as "About this + Operating System", "Obtain Support" + resp. "Report a Bug". The values should + be in RFC3986 + format, and should be + http: or + https: URLs, and + possibly mailto: or + tel:. Only one URL + shall be listed in each setting. If + multiple resources need to be + referenced it is recommended to + provide an online landing page linking + all available resources. Examples: + HOME_URL="https://fedoraproject.org/" + and + BUG_REPORT_URL="https://bugzilla.redhat.com/" + + + If you are reading this file from C code or a shell script to determine the OS or a specific version - of it, use the ID and VERSION_ID fields. When looking - for an OS identification string for presentation to - the user use the PRETTY_NAME field. + of it, use the ID and VERSION_ID fields, possibly with + ID_LIKE as fallback for ID. When looking for an OS + identification string for presentation to the user use + the PRETTY_NAME field. Note that operating system vendors may choose not to provide version information, for example to @@ -264,7 +319,9 @@ ID=fedora VERSION_ID=17 PRETTY_NAME="Fedora 17 (Beefy Miracle)" ANSI_COLOR="0;34" -CPE_NAME="cpe:/o:fedoraproject:fedora:17" +CPE_NAME="cpe:/o:fedoraproject:fedora:17" +HOME_URL="https://fedoraproject.org/" +BUG_REPORT_URL="https://bugzilla.redhat.com/"