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