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 General Public License as published by
  13   the Free Software Foundation; either version 2 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   General Public License for more details.
  20
  21   You should have received a copy of the GNU 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
  58                 contains machine meta data.</para>
  59
  60                 <para>The basic file format of
  61                 <filename>machine-info</filename> is a
  62                 newline-separated list of environment-like
  63                 shell-compatible variable assignments. It is possible
  64                 to source the configuration from shell scripts,
  65                 however, beyond mere variable assignments no shell
  66                 features are supported, allowing applications to read
  67                 the file without implementing a shell compatible
  68                 execution engine.</para>
  69
  70                 <para><filename>/etc/machine-info</filename> contains
  71                 meta data about the machine that is set by the user or
  72                 administrator.</para>
  73
  74                 <para>Depending on the operating system other
  75                 configuration files might be checked for machine
  76                 information as well, however only as fallback.</para>
  77         </refsect1>
  78
  79         <refsect1>
  80                 <title>Options</title>
  81
  82                 <para>The following machine meta data parameters may
  83                 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
  92                                 human-readable UTF8 machine identifier
  93                                 string. This should contain a name
  94                                 like <literal>Lennart's
  95                                 Laptop</literal> which is useful to
  96                                 present to the user and does not
  97                                 suffer by the syntax limitations of
  98                                 internet domain names. If possible the
  99                                 internet host name as configured in
 100                                 <filename>/etc/hostname</filename>
 101                                 should be kept similar to this
 102                                 one. Example: if this value is
 103                                 <literal>Lennart's Computer</literal>
 104                                 an Internet host name of
 105                                 <literal>lennarts-computer</literal>
 106                                 might be a good choice. If this
 107                                 parameter is not set an application
 108                                 should fall back to the Internet host
 109                                 name for presentation
 110                                 purposes.</para></listitem>
 111                         </varlistentry>
 112
 113                         <varlistentry>
 114                                 <term><varname>ICON_NAME=</varname></term>
 115
 116                                 <listitem><para>An icon identifying
 117                                 this machine according to the <ulink
 118                                 url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">XDG
 119                                 Icon Naming Specification</ulink>. If
 120                                 this parameter is not set an
 121                                 application should fall back to
 122                                 <literal>computer</literal> or a
 123                                 similar icon name.</para></listitem>
 124                         </varlistentry>
 125
 126                 </variablelist>
 127
 128         </refsect1>
 129
 130         <refsect1>
 131                 <title>Example</title>
 132
 133                 <programlisting>PRETTY_NAME="Lennart's Computer"
 134 ICON_NAME=computer-laptop</programlisting>
 135         </refsect1>
 136
 137         <refsect1>
 138                   <title>See Also</title>
 139                   <para>
 140                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 141                           <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 142                           <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 143                           <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 144                   </para>
 145         </refsect1>
 146
 147 </refentry>