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=ff8fdf16be1f30bb88f4dd12dfc135acd470d37c;hb=d86dd07d462fb8502b1c7b4a9a4df4fba8318bdd;hpb=19c5f19d69bb5f520fa7213239490c55de06d99d diff --git a/man/os-release.xml b/man/os-release.xml index ff8fdf16b..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 @@ -110,7 +110,7 @@ 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 @@ -142,8 +142,8 @@ 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. @@ -155,7 +155,7 @@ A space-separated list of operating system identifiers in the same syntax as the - ID= setting. Should + ID= setting. It should list identifiers of operating systems that are closely related to the local operating system in regards to @@ -165,8 +165,8 @@ 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 + 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 @@ -179,11 +179,11 @@ closest. This field is optional. Example: for an operating system with - ID=centos an + ID=centos, an assignment of ID_LIKE="rhel fedora" would be appropriate. For an operating system - with ID=ubuntu an + with ID=ubuntu, an assignment of ID_LIKE=debian is appropriate. @@ -199,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. @@ -213,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)". @@ -241,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 @@ -258,7 +258,7 @@ Links to resources on the Internet related the operating system. HOME_URL= - should refer to the homepage of the of + should refer to the homepage of the operating system, or alternatively some homepage of the specific version of the operating @@ -279,8 +279,8 @@ 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 + Operating System", "Obtain Support", + and "Report a Bug". The values should be in RFC3986 format, and should be @@ -290,7 +290,7 @@ tel:. Only one URL shall be listed in each setting. If multiple resources need to be - referenced it is recommended to + referenced, it is recommended to provide an online landing page linking all available resources. Examples: HOME_URL="https://fedoraproject.org/" @@ -298,6 +298,28 @@ 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. + + + @@ -310,7 +332,7 @@ 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.