machine-info.xml revision dbc4fbae58e39cb0d33738f0a4d1e74511ed1fb5
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<?xml version='1.0'?> <!--*-nxml-*-->
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
a78048ccbdb6256da15e6b0e7e95355e480c2301nd "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<!--
a78048ccbdb6256da15e6b0e7e95355e480c2301nd This file is part of systemd.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc Copyright 2010 Lennart Poettering
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd systemd is free software; you can redistribute it and/or modify it
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen under the terms of the GNU Lesser General Public License as published by
2e545ce2450a9953665f701bb05350f0d3f26275nd the Free Software Foundation; either version 2.1 of the License, or
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen (at your option) any later version.
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen
a78048ccbdb6256da15e6b0e7e95355e480c2301nd systemd is distributed in the hope that it will be useful, but
a78048ccbdb6256da15e6b0e7e95355e480c2301nd WITHOUT ANY WARRANTY; without even the implied warranty of
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3f08db06526d6901aa08c110b5bc7dde6bc39905nd Lesser General Public License for more details.
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd You should have received a copy of the GNU Lesser General Public License
a78048ccbdb6256da15e6b0e7e95355e480c2301nd along with systemd; If not, see <http://www.gnu.org/licenses/>.
3f08db06526d6901aa08c110b5bc7dde6bc39905nd-->
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<refentry id="machine-info">
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refentryinfo>
0cf3cdbaa1dad11cbf1ce32e48f1b4ec88cf779fnilgun <title>machine-info</title>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung <productname>systemd</productname>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem <authorgroup>
4b575a6b6704b516f22d65a3ad35696d7b9ba372rpluem <author>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <contrib>Developer</contrib>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <firstname>Lennart</firstname>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <surname>Poettering</surname>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <email>lennart@poettering.net</email>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </author>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </authorgroup>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </refentryinfo>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refmeta>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refentrytitle>machine-info</refentrytitle>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <manvolnum>5</manvolnum>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </refmeta>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refnamediv>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refname>machine-info</refname>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refpurpose>Local machine information file</refpurpose>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </refnamediv>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refsynopsisdiv>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <para><filename>/etc/machine-info</filename></para>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak </refsynopsisdiv>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak <refsect1>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak <title>Description</title>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak <para>The <filename>/etc/machine-info</filename> file
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak contains machine meta data.</para>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <para>The basic file format of
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <filename>machine-info</filename> is a
a78048ccbdb6256da15e6b0e7e95355e480c2301nd newline-separated list of environment-like
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh shell-compatible variable assignments. It is possible
a78048ccbdb6256da15e6b0e7e95355e480c2301nd to source the configuration from shell scripts,
a78048ccbdb6256da15e6b0e7e95355e480c2301nd however, beyond mere variable assignments no shell
a78048ccbdb6256da15e6b0e7e95355e480c2301nd features are supported, allowing applications to read
a78048ccbdb6256da15e6b0e7e95355e480c2301nd the file without implementing a shell compatible
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak execution engine.</para>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak <para><filename>/etc/machine-info</filename> contains
a78048ccbdb6256da15e6b0e7e95355e480c2301nd meta data about the machine that is set by the user or
a78048ccbdb6256da15e6b0e7e95355e480c2301nd administrator.</para>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <para>Depending on the operating system other
a78048ccbdb6256da15e6b0e7e95355e480c2301nd configuration files might be checked for machine
a78048ccbdb6256da15e6b0e7e95355e480c2301nd information as well, however only as fallback.</para>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <para>You may use
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak to change the settings of this file from the command
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak line.</para>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak </refsect1>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refsect1>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <title>Options</title>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <para>The following machine meta data parameters may
a78048ccbdb6256da15e6b0e7e95355e480c2301nd be set using
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <filename>/etc/machine-info</filename>:</para>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <variablelist>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <varlistentry>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <term><varname>PRETTY_HOSTNAME=</varname></term>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <listitem><para>A pretty
a78048ccbdb6256da15e6b0e7e95355e480c2301nd human-readable UTF8 machine identifier
a78048ccbdb6256da15e6b0e7e95355e480c2301nd string. This should contain a name
a78048ccbdb6256da15e6b0e7e95355e480c2301nd like <literal>Lennart's
a78048ccbdb6256da15e6b0e7e95355e480c2301nd Laptop</literal> which is useful to
a78048ccbdb6256da15e6b0e7e95355e480c2301nd present to the user and does not
a78048ccbdb6256da15e6b0e7e95355e480c2301nd suffer by the syntax limitations of
a78048ccbdb6256da15e6b0e7e95355e480c2301nd internet domain names. If possible the
a78048ccbdb6256da15e6b0e7e95355e480c2301nd internet host name as configured in
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <filename>/etc/hostname</filename>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd should be kept similar to this
a78048ccbdb6256da15e6b0e7e95355e480c2301nd one. Example: if this value is
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <literal>Lennart's Computer</literal>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd an Internet host name of
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <literal>lennarts-computer</literal>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd might be a good choice. If this
a78048ccbdb6256da15e6b0e7e95355e480c2301nd parameter is not set an application
a78048ccbdb6256da15e6b0e7e95355e480c2301nd should fall back to the Internet host
a78048ccbdb6256da15e6b0e7e95355e480c2301nd name for presentation
a78048ccbdb6256da15e6b0e7e95355e480c2301nd purposes.</para></listitem>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </varlistentry>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <varlistentry>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <term><varname>ICON_NAME=</varname></term>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <listitem><para>An icon identifying
a78048ccbdb6256da15e6b0e7e95355e480c2301nd this machine according to the <ulink
a78048ccbdb6256da15e6b0e7e95355e480c2301nd url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">XDG
a78048ccbdb6256da15e6b0e7e95355e480c2301nd Icon Naming Specification</ulink>. If
a78048ccbdb6256da15e6b0e7e95355e480c2301nd this parameter is not set an
a78048ccbdb6256da15e6b0e7e95355e480c2301nd application should fall back to
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <literal>computer</literal> or a
a78048ccbdb6256da15e6b0e7e95355e480c2301nd similar icon name.</para></listitem>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </varlistentry>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </variablelist>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </refsect1>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refsect1>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <title>Example</title>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <programlisting>PRETTY_HOSTNAME="Lennart's Computer"
a78048ccbdb6256da15e6b0e7e95355e480c2301ndICON_NAME=computer-laptop</programlisting>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd </refsect1>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <refsect1>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <title>See Also</title>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd <para>
0cf3cdbaa1dad11cbf1ce32e48f1b4ec88cf779fnilgun <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
727872d18412fc021f03969b8641810d8896820bhumbedooh <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
0d0ba3a410038e179b695446bb149cce6264e0abnd <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
727872d18412fc021f03969b8641810d8896820bhumbedooh <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
0d0ba3a410038e179b695446bb149cce6264e0abnd </para>
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh </refsect1>
727872d18412fc021f03969b8641810d8896820bhumbedooh
0d0ba3a410038e179b695446bb149cce6264e0abnd</refentry>
0d0ba3a410038e179b695446bb149cce6264e0abnd