chiark / gitweb /
man: bring machinectl man page up-to-date
[elogind.git] / man / machine-info.xml
index 7f396aa..4dd3741 100644 (file)
@@ -55,7 +55,7 @@
                 <title>Description</title>
 
                 <para>The <filename>/etc/machine-info</filename> file
-                contains machine meta data.</para>
+                contains machine metadata.</para>
 
                 <para>The basic file format of
                 <filename>machine-info</filename> is a
@@ -68,7 +68,7 @@
                 execution engine.</para>
 
                 <para><filename>/etc/machine-info</filename> contains
-                meta data about the machine that is set by the user or
+                metadata about the machine that is set by the user or
                 administrator.</para>
 
                 <para>Depending on the operating system other
@@ -84,7 +84,7 @@
         <refsect1>
                 <title>Options</title>
 
-                <para>The following machine meta data parameters may
+                <para>The following machine metadata parameters may
                 be set using
                 <filename>/etc/machine-info</filename>:</para>
 
                                 <term><varname>PRETTY_HOSTNAME=</varname></term>
 
                                 <listitem><para>A pretty
-                                human-readable UTF8 machine identifier
+                                human-readable UTF-8 machine identifier
                                 string. This should contain a name
                                 like <literal>Lennart's
                                 Laptop</literal> which is useful to
                                 present to the user and does not
                                 suffer by the syntax limitations of
-                                internet domain names. If possible the
+                                internet domain names. If possible, the
                                 internet hostname as configured in
                                 <filename>/etc/hostname</filename>
                                 should be kept similar to this
                                 an Internet hostname of
                                 <literal>lennarts-computer</literal>
                                 might be a good choice. If this
-                                parameter is not set an application
+                                parameter is not set, an application
                                 should fall back to the Internet host
                                 name for presentation
                                 purposes.</para></listitem>
                                 this machine according to the <ulink
                                 url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">XDG
                                 Icon Naming Specification</ulink>. If
-                                this parameter is not set an
+                                this parameter is not set, an
                                 application should fall back to
                                 <literal>computer</literal> or a
                                 similar icon name.</para></listitem>
                                 <literal>laptop</literal>,
                                 <literal>server</literal>,
                                 <literal>tablet</literal>,
-                                <literal>handset</literal>, as well as
+                                <literal>handset</literal>,
+                                <literal>watch</literal>, and
+                                <literal>embedded</literal> as well as
                                 the special chassis types
                                 <literal>vm</literal> and
                                 <literal>container</literal> for
                                 available.</para></listitem>
                         </varlistentry>
 
-                </variablelist>
+                        <varlistentry>
+                                <term><varname>DEPLOYMENT=</varname></term>
+
+                                <listitem><para>Describes the system
+                                deployment environment. One of the
+                                following is suggested:
+                                <literal>development</literal>,
+                                <literal>integration</literal>,
+                                <literal>staging</literal>,
+                                <literal>production</literal>.
+                                </para></listitem>
+                        </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>LOCATION=</varname></term>
+
+                                <listitem><para>Describes the system
+                                location if applicable and
+                                known. Takes a human-friendly,
+                                free-form string. This may be as
+                                generic as <literal>Berlin,
+                                Germany</literal> or as specific as
+                                <literal>Left Rack, 2nd
+                                Shelf</literal>.</para></listitem>
+                        </varlistentry>
+                </variablelist>
         </refsect1>
 
         <refsect1>
 
                 <programlisting>PRETTY_HOSTNAME="Lennart's Tablet"
 ICON_NAME=computer-tablet
-CHASSIS=tablet</programlisting>
+CHASSIS=tablet
+DEPLOYMENT=production</programlisting>
         </refsect1>
 
         <refsect1>