man/machine-info.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   4   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5
   6 <!--
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24
  25 <refentry id="machine-info">
  26   <refentryinfo>
  27     <title>machine-info</title>
  28     <productname>systemd</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Lennart</firstname>
  34         <surname>Poettering</surname>
  35         <email>lennart@poettering.net</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>machine-info</refentrytitle>
  42     <manvolnum>5</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>machine-info</refname>
  47     <refpurpose>Local machine information file</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <para><filename>/etc/machine-info</filename></para>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>Description</title>
  56
  57     <para>The <filename>/etc/machine-info</filename> file contains
  58     machine metadata.</para>
  59
  60     <para>The basic file format of <filename>machine-info</filename>
  61     is a newline-separated list of environment-like shell-compatible
  62     variable assignments. It is possible to source the configuration
  63     from shell scripts, however, beyond mere variable assignments no
  64     shell features are supported, allowing applications to read the
  65     file without implementing a shell compatible execution
  66     engine.</para>
  67
  68     <para><filename>/etc/machine-info</filename> contains metadata
  69     about the machine that is set by the user or administrator.</para>
  70
  71     <para>Depending on the operating system other configuration files
  72     might be checked for machine information as well, however only as
  73     fallback.</para>
  74
  75     <para>You may use
  76     <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  77     to change the settings of this file from the command line.</para>
  78   </refsect1>
  79
  80   <refsect1>
  81     <title>Options</title>
  82
  83     <para>The following machine metadata parameters may be set using
  84     <filename>/etc/machine-info</filename>:</para>
  85
  86     <variablelist>
  87
  88       <varlistentry>
  89         <term><varname>PRETTY_HOSTNAME=</varname></term>
  90
  91         <listitem><para>A pretty human-readable UTF-8 machine
  92         identifier string. This should contain a name like
  93         <literal>Lennart's Laptop</literal> which is useful to present
  94         to the user and does not suffer by the syntax limitations of
  95         internet domain names. If possible, the internet hostname as
  96         configured in <filename>/etc/hostname</filename> should be
  97         kept similar to this one. Example: if this value is
  98         <literal>Lennart's Computer</literal> an Internet hostname of
  99         <literal>lennarts-computer</literal> might be a good choice.
 100         If this parameter is not set, an application should fall back
 101         to the Internet host name for presentation
 102         purposes.</para></listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term><varname>ICON_NAME=</varname></term>
 107
 108         <listitem><para>An icon identifying this machine according to
 109         the <ulink
 110         url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">XDG
 111         Icon Naming Specification</ulink>. If this parameter is not
 112         set, an application should fall back to
 113         <literal>computer</literal> or a similar icon
 114         name.</para></listitem>
 115       </varlistentry>
 116
 117       <varlistentry>
 118         <term><varname>CHASSIS=</varname></term>
 119
 120         <listitem><para>The chassis type. Currently, the following
 121         chassis types are defined:
 122         <literal>desktop</literal>,
 123         <literal>laptop</literal>,
 124         <literal>server</literal>,
 125         <literal>tablet</literal>,
 126         <literal>handset</literal>,
 127         <literal>watch</literal>, and
 128         <literal>embedded</literal>
 129         as well as the special chassis types
 130         <literal>vm</literal> and
 131         <literal>container</literal> for
 132         virtualized systems that lack an immediate physical chassis.
 133         Note that many systems allow detection of the chassis type
 134         automatically (based on firmware information or suchlike).
 135         This setting (if set) shall take precedence over automatically
 136         detected information and is useful to override misdetected
 137         configuration or to manually configure the chassis type where
 138         automatic detection is not available.</para></listitem>
 139       </varlistentry>
 140
 141       <varlistentry>
 142         <term><varname>DEPLOYMENT=</varname></term>
 143
 144         <listitem><para>Describes the system deployment environment.
 145         One of the following is suggested:
 146         <literal>development</literal>,
 147         <literal>integration</literal>,
 148         <literal>staging</literal>,
 149         <literal>production</literal>.
 150         </para></listitem>
 151       </varlistentry>
 152
 153       <varlistentry>
 154         <term><varname>LOCATION=</varname></term>
 155
 156         <listitem><para>Describes the system location if applicable
 157         and known. Takes a human-friendly, free-form string. This may
 158         be as generic as <literal>Berlin, Germany</literal> or as
 159         specific as <literal>Left Rack, 2nd Shelf</literal>.
 160         </para></listitem>
 161       </varlistentry>
 162     </variablelist>
 163   </refsect1>
 164
 165   <refsect1>
 166     <title>Example</title>
 167
 168     <programlisting>PRETTY_HOSTNAME="Lennart's Tablet"
 169 ICON_NAME=computer-tablet
 170 CHASSIS=tablet
 171 DEPLOYMENT=production</programlisting>
 172   </refsect1>
 173
 174   <refsect1>
 175       <title>See Also</title>
 176       <para>
 177         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 178         <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 179         <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 180         <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 181         <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 182         <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 183       </para>
 184   </refsect1>
 185
 186 </refentry>