X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fos-release.xml;h=c1dd62f7156d2c1c978eab7229d522d0681cf565;hp=7d799721de9e4afd4589eeee81c47a24f836dd4f;hb=86198b2788e56fd05959c2dce670d1646bf99bcd;hpb=88ce72297a59e82601c47e00559454f343d7dc56 diff --git a/man/os-release.xml b/man/os-release.xml index 7d799721d..c1dd62f71 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -9,16 +9,16 @@ Copyright 2010 Lennart Poettering systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. systemd is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Lesser General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> @@ -62,7 +62,7 @@ list of environment-like shell-compatible variable assignments. It is possible to source the configuration from shell scripts, however, beyond mere - variable assignments no shell features are supported + variable assignments, no shell features are supported (this means variable expansion is explicitly not supported), allowing applications to read the file without implementing a shell compatible execution @@ -72,7 +72,7 @@ a-z, 0-9. All strings should be in UTF-8 format, and non-printable characters should not be used. If double or single quotes or backslashes are to be used within - variable assignments they should be escaped with + variable assignments, they should be escaped with backslashes, following shell style. It is not supported to concatenate multiple individually quoted strings. Lines beginning with "#" shall be ignored as @@ -85,6 +85,11 @@ As this file only encodes names and identifiers it should not be localized. + The file /etc/os-release might + be a symlink to another file, but it is important that + the file is available from earliest boot on, and hence + must be located on the root file system. + For a longer rationale for /etc/os-release please refer to the A string identifying the operating system, without a version component, and suitable for - presentation to the user. If not set + presentation to the user. If not set, defaults to NAME=Linux. Example: NAME=Fedora or @@ -137,13 +142,53 @@ identifying the operating system, excluding any version information and suitable for processing by scripts or - usage in generated file names. If not - set defaults to + usage in generated filenames. If not + set, defaults to ID=linux. Example: ID=fedora or ID=debian. + + ID_LIKE= + + A space-separated list + of operating system identifiers in the + same syntax as the + ID= setting. It should + list identifiers of operating systems + that are closely related to the local + operating system in regards to + packaging and programming interfaces, + for example listing one or more + OS identifiers the local + OS is a derivative from. An + OS should generally only list other OS + identifiers it itself is a derivative + of, and not any OSes that + are derived from it, though 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 + listed ones, starting with the + closest. This field is + optional. Example: for an operating + system with + ID=centos, an + assignment of ID_LIKE="rhel + fedora" would be + appropriate. For an operating system + with ID=ubuntu, an + assignment of + ID_LIKE=debian is + appropriate. + + VERSION_ID= @@ -154,7 +199,7 @@ system version, excluding any OS name information or release code name, and suitable for processing by scripts or - usage in generated file names. This + usage in generated filenames. This field is optional. Example: VERSION_ID=17 or VERSION_ID=11.04. @@ -168,7 +213,7 @@ presentation to the user. May or may not contain a release code name or OS version of some kind, as suitable. If - not set defaults to + not set, defaults to PRETTY_NAME="Linux". Example: PRETTY_NAME="Fedora 17 (Beefy Miracle)". @@ -179,7 +224,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 @@ -196,7 +241,7 @@ A CPE name for the operating system, following the Common + url="https://cpe.mitre.org/specification/">Common Platform Enumeration Specification as proposed by the MITRE Corporation. This field @@ -204,19 +249,99 @@ 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 + 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", + and "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/" + + + + BUILD_ID= + + A string uniquely + identifying the system image used as + the origin for a distribution (it is + not updated with system updates). The + field can be identical between + different VERSION_IDs as BUILD_ID is + an only a unique identifier to a + specific version. Distributions that + release each update as a new version + would only need to use VERSION_ID as + each build is already distinct based + on the VERSION_ID. This field is + optional. Example: + BUILD_ID="2013-03-20.3" + or + BUILD_ID=201303203. + + + + 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 - accommodate for rolling releases. In this case VERSION + accommodate for rolling releases. In this case, VERSION and VERSION_ID may be unset. Applications should not rely on these fields to be set. + + Operating system vendors may extend the file + format and introduce new fields. It is highly + recommended to prefix new fields with an OS specific + name in order to avoid name clashes. Applications + reading this file must ignore unknown fields. Example: + DEBIAN_BTS="debbugs://bugs.debian.org/" @@ -228,7 +353,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/"