chiark / gitweb /
man: bring machinectl man page up-to-date
[elogind.git] / man / machine-info.xml
index 240da25..4dd3741 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/>.
 -->
 
@@ -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
                 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
                 configuration files might be checked for machine
                 information as well, however only as fallback.</para>
+
+                <para>You may use
+                <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                to change the settings of this file from the command
+                line.</para>
         </refsect1>
 
         <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 host name as configured in
+                                internet domain names. If possible, the
+                                internet hostname as configured in
                                 <filename>/etc/hostname</filename>
                                 should be kept similar to this
                                 one. Example: if this value is
                                 <literal>Lennart's Computer</literal>
-                                an Internet host name of
+                                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>
                         </varlistentry>
 
-                </variablelist>
+                        <varlistentry>
+                                <term><varname>CHASSIS=</varname></term>
+
+                                <listitem><para>The chassis
+                                type. Currently, the following chassis
+                                types are defined:
+                                <literal>desktop</literal>,
+                                <literal>laptop</literal>,
+                                <literal>server</literal>,
+                                <literal>tablet</literal>,
+                                <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
+                                virtualized systems that lack an
+                                immediate physical chassis. Note that
+                                many systems allow detection of the
+                                chassis type automatically (based on
+                                firmware information or
+                                suchlike). This setting (if set) shall
+                                take precedence over automatically
+                                detected information and is useful to
+                                override misdetected configuration or
+                                to manually configure the chassis type
+                                where automatic detection is not
+                                available.</para></listitem>
+                        </varlistentry>
+
+                        <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>
                 <title>Example</title>
 
-                <programlisting>PRETTY_HOSTNAME="Lennart's Computer"
-ICON_NAME=computer-laptop</programlisting>
+                <programlisting>PRETTY_HOSTNAME="Lennart's Tablet"
+ICON_NAME=computer-tablet
+CHASSIS=tablet
+DEPLOYMENT=production</programlisting>
         </refsect1>
 
         <refsect1>
@@ -140,7 +201,9 @@ ICON_NAME=computer-laptop</programlisting>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-                          <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                   </para>
         </refsect1>