picnoir/Systemd
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

man: document CPE field in os-release file

Browse source
This commit is contained in:
Lennart Poettering 2012-02-14 17:01:49 +01:00
parent 283b73b3bb
commit f8045772bd
1 changed files with 52 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
man/os-release.xml
View file

@ -85,10 +85,10 @@
<listitem><para>A string identifying <listitem><para>A string identifying
the operating system, without a the operating system, without a
version string, and not necessarily version component, and suitable for
suitable for presentation to the presentation to the user. If not set
user. If not set defaults to defaults to
<literal>Linux</literal>. Example: <literal>NAME=Linux</literal>. Example:
<literal>NAME=Fedora</literal> or <literal>NAME=Fedora</literal> or
<literal>NAME="Debian <literal>NAME="Debian
GNU/Linux"</literal>.</para></listitem> GNU/Linux"</literal>.</para></listitem>
@ -99,25 +99,26 @@
<listitem><para>A string identifying <listitem><para>A string identifying
the operating system version, the operating system version,
excluding any name information and excluding any OS name information, and
suitable for presentation to the suitable for presentation to the
user. Example: user. This field is optional. Example:
<literal>VERSION=15</literal> or <literal>VERSION=17</literal> or
<literal>VERSION="15 <literal>VERSION="17
(Rawhide)"</literal>.</para></listitem> (Beefy Miracle)"</literal>.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>ID=</varname></term> <term><varname>ID=</varname></term>
<listitem><para>A lower-case string <listitem><para>A lower-case string
(no spaces) identifying the operating (no spaces or other characters outside of
system, excluding any version 0-9, a-z, ".", "_" and "-") identifying
information and suitable for the operating system, excluding any
version information and suitable for
processing by scripts or usage in processing by scripts or usage in
generated file names. If not set generated file names. If not set
defaults to defaults to
<literal>linux</literal>. Example: <literal>ID=linux</literal>. Example:
<literal>ID=fedora</literal>.</para></listitem> <literal>ID=fedora</literal>.</para></listitem>
</varlistentry> </varlistentry>
@ -125,11 +126,16 @@
<term><varname>VERSION_ID=</varname></term> <term><varname>VERSION_ID=</varname></term>
<listitem><para>A lower-case string <listitem><para>A lower-case string
(mostly numeric, no spaces) identifying the (mostly numeric, no spaces or other
operating system version, excluding characters outside of 0-9, a-z, ".",
any name information and suitable for "_" and "-") identifying the operating
processing by scripts or usage in generated file names. Example: system version, excluding any OS name
<literal>VERSION_ID=15</literal>.</para></listitem> information or release code names, and
suitable for processing by scripts or
usage in generated file names. This
field is optional. Example:
<literal>VERSION_ID=17</literal> or
<literal>VERSION_ID=11.04</literal>.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -140,9 +146,9 @@
presentation to the user. May or may presentation to the user. May or may
not contain an OS version of some not contain an OS version of some
kind, as suitable. If not set defaults kind, as suitable. If not set defaults
to <literal>Linux</literal>. Example: to <literal>PRETTY_NAME="Linux"</literal>. Example:
<literal>PRETTY_NAME="Fedora 15 <literal>PRETTY_NAME="Fedora 17
(Rawhide)"</literal>.</para></listitem> (Beefy Miracle)"</literal>.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -154,15 +160,30 @@
should be specified as string suitable should be specified as string suitable
for inclusion in the ESC [ m for inclusion in the ESC [ m
ANSI/ECMA-48 escape code for setting ANSI/ECMA-48 escape code for setting
graphical rendition. Example: graphical rendition. This field is
<literal>ANSI_COLOR="0;31"</literal> for optional. Example:
red, or <literal>ANSI_COLOR="0;31"</literal>
<literal>ANSI_COLOR="1;34"</literal> for for red, or
light blue.</para></listitem> <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>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>If you are reading this file from code or a <para>If you are reading this file from C code or a
shell script to determine the OS or a specific version shell script to determine the OS or a specific version
of it, use the ID and VERSION_ID fields. When looking of it, use the ID and VERSION_ID fields. When looking
for an OS identification string for presentation to for an OS identification string for presentation to
@ -179,11 +200,12 @@
<title>Example</title> <title>Example</title>
<programlisting>NAME=Fedora <programlisting>NAME=Fedora
VERSION="15 (Rawhide)" VERSION="17 (Beefy Miracle)"
ID=fedora ID=fedora
VERSION_ID=15 VERSION_ID=15
PRETTY_NAME="Fedora 15 (Rawhide)" PRETTY_NAME="Fedora 17 (Beefy Miracle)"
ANSI_COLOR="0;34"</programlisting> ANSI_COLOR="0;34"
CPE_NAME="cpe:/o:fedoraproject:fedora:17"</programlisting>
</refsect1> </refsect1>
<refsect1> <refsect1>