chiark / gitweb /
man: add missing man page
[elogind.git] / man / os-release.xml
index 8ffb5de48d568e53df82e81902829160e893de28..98320efe31a7a1265ecf0e1265eefabc2e52b8d5 100644 (file)
@@ -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 <http://www.gnu.org/licenses/>.
 -->
 
                 <para>As this file only encodes names and identifiers
                 it should not be localized.</para>
 
+                <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>
+
                 <para>For a longer rationale for
                 <filename>/etc/os-release</filename> please refer to
                 the <ulink
                                 <literal>ID=centos</literal> an
                                 assignment of <literal>ID_LIKE="rhel
                                 fedora"</literal> would be
-                                appropriate. For an operating systemd
+                                appropriate. For an operating system
                                 with <literal>ID=ubuntu</literal> an
                                 assignment of
                                 <literal>ID_LIKE=debian</literal> is
                                 <listitem><para>Links to resources on
                                 the Internet related the operating
                                 system. <varname>HOME_URL=</varname>
-                                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
                                 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 <ulink
                                 url="https://tools.ietf.org/html/rfc3986">RFC3986
                                 format</ulink>, and should be
                 accommodate for rolling releases. In this case VERSION
                 and VERSION_ID may be unset. Applications should not
                 rely on these fields to be set.</para>
+
+                <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
+                name in order to avoid name clashes. Applications
+                reading this file must ignore unknown fields. Example:
+                <literal>DEBIAN_BTS="debbugs://bugs.debian.org/"</literal></para>
         </refsect1>
 
         <refsect1>