os-release.xml revision 62ca938d2d217bae94e961be977bbaa2daef3675
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw This file is part of systemd.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Copyright 2010 Lennart Poettering
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw systemd is free software; you can redistribute it and/or modify it
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw under the terms of the GNU General Public License as published by
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw the Free Software Foundation; either version 2 of the License, or
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw (at your option) any later version.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw systemd is distributed in the hope that it will be useful, but
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw WITHOUT ANY WARRANTY; without even the implied warranty of
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw General Public License for more details.
148c5f43199ca0b43fc8e3b643aab11cd66ea327Alan Wright You should have received a copy of the GNU General Public License
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw along with systemd; If not, see <http://www.gnu.org/licenses/>.
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refentryinfo>
bbf6f00c25b6a2bed23c35eac6d62998ecdb338cJordan Brown <authorgroup>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </authorgroup>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refentryinfo>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refnamediv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refpurpose>Operating system identification</refpurpose>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refnamediv>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsynopsisdiv>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States <para><filename>/etc/os-release</filename></para>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States </refsynopsisdiv>
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsect1>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb contains operating system identification data.</para>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <para>The basic file format of
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb list of environment-like shell-compatible variable
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb assignments. It is possible to source the
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb configuration from shell scripts, however, beyond mere
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb variable assignments no shell features are supported
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb (this means variable expansion is explicitly not
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb supported), allowing applications to read the file
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb without implementing a shell compatible execution
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb engine. Variable assignment values should be enclosed
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw in double or single quotes if they include spaces,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw semicolons or other special characters outside of A-Z,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw a-z, 0-9. All strings should be in UTF-8 format, and
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw non-printable characters should not be used. If double
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw or single quotes or backslashes are to be used within
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw variable assignments they should be escaped with
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw backslashes, following shell style. It is not
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw supported to concatenate multiple individually quoted
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw strings. Lines beginning with "#" shall be ignored as
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw comments.</para>
a90cf9f29973990687fa61de9f1f6ea22e924e40Gordon Ross <para><filename>/etc/os-release</filename> contains
a90cf9f29973990687fa61de9f1f6ea22e924e40Gordon Ross data that is defined by the operating system vendor
a90cf9f29973990687fa61de9f1f6ea22e924e40Gordon Ross and should not be changed by the administrator.</para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>As this file only encodes names and identifiers
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw it should not be localized.</para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>For a longer rationale for
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb the <ulink
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw url="http://0pointer.de/blog/projects/os-release">Announcement of <filename>/etc/os-release</filename></ulink>.</para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refsect1>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsect1>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>The following OS identifications parameters may be set using
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <variablelist>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw the operating system, without a
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb version component, and suitable for
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw presentation to the user. If not set
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw defaults to
9fb67ea305c66b6a297583b9b0db6796b0dfe497afshin salek ardakani - Sun Microsystems - Irvine United States <literal>NAME=Linux</literal>. Example:
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <literal>NAME="Debian
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross <varlistentry>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb the operating system version,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw excluding any OS name information,
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross possibly including a release code
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw name, and suitable for presentation to
dc20a3024900c47dd2ee44b9707e6df38f7d62a5as the user. This field is
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb optional. Example:
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross <literal>VERSION="17 (Beefy
dc20a3024900c47dd2ee44b9707e6df38f7d62a5as </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw (no spaces or other characters outside
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw of 0-9, a-z, ".", "_" and "-")
ccc71be50bb49efb4e31004c77fb3e065e9c0596Gordon Ross identifying the operating system,
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb excluding any version information and
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw suitable for processing by scripts or
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw usage in generated file names. If not
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw set defaults to
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw of operating system identifiers in the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw same syntax as the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw list identifiers of operating systems
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw that are closely related to the local
7b59d02d2a384be9a08087b14defadd214b3c1ddjb operating system in regards to
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb packaging and programming interfaces,
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb for example listing one or more
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb OS identifiers the local
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb OS is a derivative from. An
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb OS should generally only list other OS
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb identifiers it itself is a derivative
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb from, and not any OSes that
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb are derived from it, but symmetric
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb relationships are possible. Build
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb scripts and similar should check this
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb variable if they need to identify the
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb local operating system and the value
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb recognized. Operating systems should
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw be listed in order of how closely the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw local operating system relates to the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw listed ones, starting with the
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw closest. This field is
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw optional. Example: for an operating
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw system with
dc20a3024900c47dd2ee44b9707e6df38f7d62a5as assignment of <literal>ID_LIKE="rhel
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb fedora"</literal> would be
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw appropriate. For an operating systemd
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw assignment of
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw (mostly numeric, no spaces or other
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw characters outside of 0-9, a-z, ".",
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw "_" and "-") identifying the operating
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw system version, excluding any OS name
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw information or release code name, and
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw suitable for processing by scripts or
7b59d02d2a384be9a08087b14defadd214b3c1ddjb usage in generated file names. This
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb field is optional. Example:
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross </varlistentry>
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross <varlistentry>
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross system name in a format suitable for
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross presentation to the user. May or may
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross not contain a release code name or OS
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross version of some kind, as suitable. If
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross not set defaults to
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross <literal>PRETTY_NAME="Linux"</literal>. Example:
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross <literal>PRETTY_NAME="Fedora 17 (Beefy
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross </varlistentry>
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross <varlistentry>
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross presentation color when showing the
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross OS name on the console. This
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross should be specified as string suitable
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross for inclusion in the ESC [ m
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross graphical rendition. This field is
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross optional. Example:
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
dc20a3024900c47dd2ee44b9707e6df38f7d62a5as <varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw operating system, following the <ulink
dc20a3024900c47dd2ee44b9707e6df38f7d62a5as Platform Enumeration
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb Specification</ulink> as proposed by
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw the MITRE Corporation. This field
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw is optional. Example:
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <literal>CPE_NAME="cpe:/o:fedoraproject:fedora:17"</literal>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <varlistentry>
7b59d02d2a384be9a08087b14defadd214b3c1ddjb the Internet related the operating
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb should refer to the homepage of the of
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb operating system, or alternatively
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb some homepage of the specific version
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb of the operating
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb should refer to the main support page
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb for the operating system, if there is
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb any. This is primarily intended for
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb operating systems which vendors
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb provide support
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb should refer to the main bug reporting
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb page for the operating system, if
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw there is any. This is primarily
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw intended for operating systems that
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw rely on community QA. These settings
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw are optional, and providing only some
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw of these settings is common. These
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw URLs are intended to be exposed in
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw "About this system" UIs behind links
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw with captions such as "About this
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw Operating System", "Obtain Support"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw resp. "Report a Bug". The values should
7b59d02d2a384be9a08087b14defadd214b3c1ddjb be in <ulink
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw format</ulink>, and should be
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb shall be listed in each setting. If
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw multiple resources need to be
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb referenced it is recommended to
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb provide an online landing page linking
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb all available resources. Examples:
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <literal>BUG_REPORT_URL="https://bugzilla.redhat.com/"</literal></para></listitem>
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb </varlistentry>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </variablelist>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>If you are reading this file from C code or a
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw shell script to determine the OS or a specific version
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw of it, use the ID and VERSION_ID fields, possibly with
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw ID_LIKE as fallback for ID. When looking for an OS
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw identification string for presentation to the user use
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw the PRETTY_NAME field.</para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <para>Note that operating system vendors may choose
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw not to provide version information, for example to
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw accommodate for rolling releases. In this case VERSION
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw and VERSION_ID may be unset. Applications should not
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw rely on these fields to be set.</para>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refsect1>
7b59d02d2a384be9a08087b14defadd214b3c1ddjb <refsect1>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <programlisting>NAME=Fedora
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwVERSION="17 (Beefy Miracle)"
dc20a3024900c47dd2ee44b9707e6df38f7d62a5asVERSION_ID=17
faa1795a28a5c712eed6d0a3f84d98c368a316c6jbPRETTY_NAME="Fedora 17 (Beefy Miracle)"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwANSI_COLOR="0;34"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwCPE_NAME="cpe:/o:fedoraproject:fedora:17"
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amwBUG_REPORT_URL="https://bugzilla.redhat.com/"</programlisting>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw </refsect1>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <refsect1>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
dc20a3024900c47dd2ee44b9707e6df38f7d62a5as <citerefentry><refentrytitle>lsb_release</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
faa1795a28a5c712eed6d0a3f84d98c368a316c6jb <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
7f3ef643e446c82e27a9386991b140b128baf22cGordon Ross <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>
dc20a3024900c47dd2ee44b9707e6df38f7d62a5as </refsect1>
da6c28aaf62fa55f0fdb8004aa40f88f23bf53f0amw</refentry>