2010-11-21 22:05:51 +03:00
<?xml version='1.0'?> <!-- * - nxml - * -->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
2012-04-12 02:20:58 +04:00
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
2010-11-21 22:05:51 +03:00
(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
2012-04-12 02:20:58 +04:00
Lesser General Public License for more details.
2010-11-21 22:05:51 +03:00
2012-04-12 02:20:58 +04:00
You should have received a copy of the GNU Lesser General Public License
2010-11-21 22:05:51 +03:00
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
<refentry id= "os-release" >
<refentryinfo >
<title > os-release</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Lennart</firstname>
<surname > Poettering</surname>
<email > lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > os-release</refentrytitle>
<manvolnum > 5</manvolnum>
</refmeta>
<refnamediv >
<refname > os-release</refname>
<refpurpose > Operating system identification</refpurpose>
</refnamediv>
<refsynopsisdiv >
<para > <filename > /etc/os-release</filename> </para>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > The <filename > /etc/os-release</filename> file
contains operating system identification data.</para>
<para > The basic file format of
2012-02-14 20:25:55 +04:00
<filename > os-release</filename> is a newline-separated
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
(this means variable expansion is explicitly not
supported), allowing applications to read the file
without implementing a shell compatible execution
engine. Variable assignment values should be enclosed
in double or single quotes if they include spaces,
semicolons or other special characters outside of A-Z,
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
backslashes, following shell style. It is not
supported to concatenate multiple individually quoted
strings. Lines beginning with "#" shall be ignored as
comments.</para>
2010-11-21 22:05:51 +03:00
<para > <filename > /etc/os-release</filename> contains
data that is defined by the operating system vendor
and should not be changed by the administrator.</para>
2012-02-14 20:25:55 +04:00
<para > As this file only encodes names and identifiers
it should not be localized.</para>
2012-03-06 20:52:21 +04:00
<para > The file <filename > /etc/os-release</filename> 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.</para>
2012-02-14 20:25:55 +04:00
<para > For a longer rationale for
<filename > /etc/os-release</filename> please refer to
the <ulink
url="http://0pointer.de/blog/projects/os-release">Announcement of <filename > /etc/os-release</filename> </ulink> .</para>
2010-11-21 22:05:51 +03:00
</refsect1>
<refsect1 >
<title > Options</title>
<para > The following OS identifications parameters may be set using
<filename > /etc/os-release</filename> :</para>
<variablelist >
<varlistentry >
<term > <varname > NAME=</varname> </term>
<listitem > <para > A string identifying
the operating system, without a
2012-02-14 20:01:49 +04:00
version component, and suitable for
presentation to the user. If not set
defaults to
<literal > NAME=Linux</literal> . Example:
2010-11-21 22:05:51 +03:00
<literal > NAME=Fedora</literal> or
<literal > NAME="Debian
GNU/Linux"</literal> .</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > VERSION=</varname> </term>
<listitem > <para > A string identifying
the operating system version,
2012-02-14 20:25:55 +04:00
excluding any OS name information,
possibly including a release code
name, and suitable for presentation to
the user. This field is
optional. Example:
2012-02-14 20:01:49 +04:00
<literal > VERSION=17</literal> or
2012-02-14 20:25:55 +04:00
<literal > VERSION="17 (Beefy
Miracle)"</literal> .</para> </listitem>
2010-11-21 22:05:51 +03:00
</varlistentry>
<varlistentry >
<term > <varname > ID=</varname> </term>
<listitem > <para > A lower-case string
2012-02-14 20:25:55 +04:00
(no spaces or other characters outside
of 0-9, a-z, ".", "_" and "-")
identifying the operating system,
excluding any version information and
suitable for processing by scripts or
2013-06-27 23:51:44 +04:00
usage in generated filenames. If not
2012-02-14 20:25:55 +04:00
set defaults to
2012-02-14 20:01:49 +04:00
<literal > ID=linux</literal> . Example:
2012-02-14 20:25:55 +04:00
<literal > ID=fedora</literal> or
<literal > ID=debian</literal> .</para> </listitem>
2010-11-21 22:05:51 +03:00
</varlistentry>
<varlistentry >
2012-03-06 16:59:12 +04:00
<term > <varname > ID_LIKE=</varname> </term>
<listitem > <para > A space-separated list
of operating system identifiers in the
same syntax as the
<varname > ID=</varname> setting. 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
2012-03-06 20:44:32 +04:00
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 <varname > ID=</varname> is not
2012-03-06 16:59:12 +04:00
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
<literal > ID=centos</literal> an
assignment of <literal > ID_LIKE="rhel
fedora"</literal> would be
2012-03-06 20:58:27 +04:00
appropriate. For an operating system
2012-03-06 16:59:12 +04:00
with <literal > ID=ubuntu</literal> an
assignment of
<literal > ID_LIKE=debian</literal> is
appropriate.</para> </listitem>
</varlistentry>
<varlistentry >
2010-11-21 22:05:51 +03:00
<term > <varname > VERSION_ID=</varname> </term>
<listitem > <para > A lower-case string
2012-02-14 20:01:49 +04:00
(mostly numeric, no spaces or other
characters outside of 0-9, a-z, ".",
"_" and "-") identifying the operating
system version, excluding any OS name
2012-02-14 20:25:55 +04:00
information or release code name, and
2012-02-14 20:01:49 +04:00
suitable for processing by scripts or
2013-06-27 23:51:44 +04:00
usage in generated filenames. This
2012-02-14 20:01:49 +04:00
field is optional. Example:
<literal > VERSION_ID=17</literal> or
<literal > VERSION_ID=11.04</literal> .</para> </listitem>
2010-11-21 22:05:51 +03:00
</varlistentry>
<varlistentry >
<term > <varname > PRETTY_NAME=</varname> </term>
<listitem > <para > A pretty operating
system name in a format suitable for
presentation to the user. May or may
2012-02-14 20:25:55 +04:00
not contain a release code name or OS
version of some kind, as suitable. If
not set defaults to
<literal > PRETTY_NAME="Linux"</literal> . Example:
<literal > PRETTY_NAME="Fedora 17 (Beefy
Miracle)"</literal> .</para> </listitem>
2010-11-21 22:05:51 +03:00
</varlistentry>
<varlistentry >
<term > <varname > ANSI_COLOR=</varname> </term>
<listitem > <para > A suggested
presentation color when showing the
2012-03-06 20:44:32 +04:00
OS name on the console. This
2010-11-21 22:05:51 +03:00
should be specified as string suitable
for inclusion in the ESC [ m
ANSI/ECMA-48 escape code for setting
2012-02-14 20:01:49 +04:00
graphical rendition. This field is
optional. Example:
<literal > ANSI_COLOR="0;31"</literal>
for red, or
<literal > ANSI_COLOR="1;34"</literal>
for light blue.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > CPE_NAME=</varname> </term>
<listitem > <para > A CPE name for the
operating system, following the <ulink
url="http://cpe.mitre.org/specification/">Common
Platform Enumeration
Specification</ulink> as proposed by
the MITRE Corporation. This field
is optional. Example:
<literal > CPE_NAME="cpe:/o:fedoraproject:fedora:17"</literal>
</para> </listitem>
2010-11-21 22:05:51 +03:00
</varlistentry>
2012-03-06 20:44:32 +04:00
<varlistentry >
<term > <varname > HOME_URL=</varname> </term>
<term > <varname > SUPPORT_URL=</varname> </term>
<term > <varname > BUG_REPORT_URL=</varname> </term>
<listitem > <para > Links to resources on
the Internet related the operating
system. <varname > HOME_URL=</varname>
2012-09-10 21:41:37 +04:00
should refer to the homepage of the
2012-03-06 20:44:32 +04:00
operating system, or alternatively
some homepage of the specific version
of the 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
provide support
for. <varname > BUG_REPORT_URL=</varname>
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
Reword sentences that contain psuedo-English "resp."
As you likely know, Arch Linux is in the process of moving to systemd.
So I was reading through the various systemd docs and quickly became
baffled by this new abbreviation "resp.", which I've never seen before
in my English-mother-tongue life.
Some quick Googling turned up a reference:
<http://www.transblawg.eu/index.php?/archives/870-Resp.-and-other-non-existent-English-wordsNicht-existente-englische-Woerter.html>
I guess it's a literal translation of the German "Beziehungsweise", but
English doesn't work the same way. The word "respectively" is used
exclusively to provide an ordering connection between two lists. E.g.
"the prefixes k, M, and G refer to kilo-, mega-, and giga-,
respectively." It is also never abbreviated to "resp." So the sentence
"Sets the default output resp. error output for all services and
sockets" makes no sense to a natural English speaker.
This patch removes all instances of "resp." in the man pages and
replaces them with sentences which are much more clear and, hopefully,
grammatically valid. In almost all instances, it was simply replacing
"resp." with "or," which the original author (Lennart?) could probably
just do in the future.
The only other instances of "resp." are in the src/ subtree, which I
don't feel privileged to correct.
Signed-off-by: Andrew Eikum <aeikum@codeweavers.com>
2012-10-15 22:59:12 +04:00
Operating System", "Obtain Support",
and "Report a Bug". The values should
2012-03-06 20:44:32 +04:00
be in <ulink
url="https://tools.ietf.org/html/rfc3986">RFC3986
format</ulink> , and should be
<literal > http:</literal> or
<literal > https:</literal> URLs, and
possibly <literal > mailto:</literal> or
<literal > tel:</literal> . 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:
<literal > HOME_URL="https://fedoraproject.org/"</literal>
and
<literal > BUG_REPORT_URL="https://bugzilla.redhat.com/"</literal> </para> </listitem>
</varlistentry>
2013-03-26 01:07:49 +04:00
<varlistentry >
<term > <varname > BUILD_ID=</varname> </term>
<listitem > <para > 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:
<literal > BUILD_ID="2013-03-20.3"</literal>
or
<literal > BUILD_ID=201303203</literal> .
</para> </listitem>
</varlistentry>
2012-03-06 20:44:32 +04:00
2010-11-21 22:05:51 +03:00
</variablelist>
2012-02-14 20:01:49 +04:00
<para > If you are reading this file from C code or a
2011-04-21 03:18:23 +04:00
shell script to determine the OS or a specific version
2012-03-06 20:44:32 +04:00
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.</para>
2010-11-22 02:26:08 +03:00
<para > Note that operating system vendors may choose
not to provide version information, for example to
2010-12-18 04:45:12 +03:00
accommodate for rolling releases. In this case VERSION
2010-11-22 02:26:08 +03:00
and VERSION_ID may be unset. Applications should not
rely on these fields to be set.</para>
2012-03-06 21:14:06 +04:00
<para > Operating system vendors may extend the file
format and introduce new fields. It is highly
recommended to prefix new fields with an OS specific
2012-03-06 21:17:07 +04:00
name in order to avoid name clashes. Applications
reading this file must ignore unknown fields. Example:
2012-03-06 21:14:06 +04:00
<literal > DEBIAN_BTS="debbugs://bugs.debian.org/"</literal> </para>
2010-11-21 22:05:51 +03:00
</refsect1>
<refsect1 >
<title > Example</title>
<programlisting > NAME=Fedora
2012-02-14 20:01:49 +04:00
VERSION="17 (Beefy Miracle)"
2010-11-21 22:05:51 +03:00
ID=fedora
2012-02-14 20:25:55 +04:00
VERSION_ID=17
2012-02-14 20:01:49 +04:00
PRETTY_NAME="Fedora 17 (Beefy Miracle)"
ANSI_COLOR="0;34"
2012-03-06 20:44:32 +04:00
CPE_NAME="cpe:/o:fedoraproject:fedora:17"
HOME_URL="https://fedoraproject.org/"
BUG_REPORT_URL="https://bugzilla.redhat.com/"</programlisting>
2010-11-21 22:05:51 +03:00
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2011-04-16 04:02:54 +04:00
<citerefentry > <refentrytitle > lsb_release</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > hostname</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > machine-id</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > machine-info</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
2010-11-21 22:05:51 +03:00
</para>
</refsect1>
</refentry>
