X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fos-release.xml;h=f85119d26a8024651d4afb662a173bf6926ff5b7;hp=b5f42b2eeccef7092669ec4609f9a32a3b9c94e7;hb=b9b2b042c5564dfff730eeab43db9ac4bbe4c650;hpb=6bd212771129d00cf7b42d6774a6b81547569384

diff --git a/man/os-release.xml b/man/os-release.xml
index b5f42b2ee..f85119d26 100644
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -116,10 +116,12 @@
                                 <term><varname>ID=</varname></term>
 
                                 <listitem><para>A lower-case string
-                                identifying the operating system,
-                                excluding any version information and
-                                suitable for processing by scripts. If
-                                not set defaults to
+                                (no spaces) 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
                                 <literal>linux</literal>. Example:
                                 <literal>ID=fedora</literal>.</para></listitem>
                         </varlistentry>
@@ -128,10 +130,10 @@
                                 <term><varname>VERSION_ID=</varname></term>
 
                                 <listitem><para>A lower-case string
-                                (mostly numeric) identifying the
+                                (mostly numeric, no spaces) identifying the
                                 operating system version, excluding
                                 any name information and suitable for
-                                processing by scripts. Example:
+                                processing by scripts or usage in generated file names. Example:
                                 <literal>VERSION_ID=15</literal>.</para></listitem>
                         </varlistentry>
 
@@ -165,15 +167,15 @@
                         </varlistentry>
                 </variablelist>
 
-                <para>If you interpreting this file from code or a
-                shell script, use the ID and VERSION_ID fields. When
-                looking for an OS identification string for
-                presentation to the user use the PRETTY_STRING
-                field.</para>
+                <para>If you are reading this file from code or a
+                shell script to determine the OS or a specific version
+                of it, use the ID and VERSION_ID fields. When looking
+                for an OS identification string for presentation to
+                the user use the PRETTY_NAME field.</para>
 
                 <para>Note that operating system vendors may choose
                 not to provide version information, for example to
-                accomodate 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.</para>
         </refsect1>
@@ -182,10 +184,10 @@
                 <title>Example</title>
 
                 <programlisting>NAME=Fedora
-VERSION=15 (Rawhide)
+VERSION="15 (Rawhide)"
 ID=fedora
 VERSION_ID=15
-PRETTY_NAME=Fedora 15 (Rawhide)
+PRETTY_NAME="Fedora 15 (Rawhide)"
 ANSI_COLOR=0;34</programlisting>
         </refsect1>
 
@@ -193,7 +195,10 @@ ANSI_COLOR=0;34</programlisting>
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>lsb_release</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                          <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>
                   </para>
         </refsect1>