man-pages/man5/machine-info.5.html
2021-03-31 01:06:50 +01:00

198 lines
5.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of MACHINE-INFO</TITLE>
</HEAD><BODY>
<H1>MACHINE-INFO</H1>
Section: machine-info (5)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
machine-info - Local machine information file
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
/etc/machine-info
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
The
/etc/machine-info
file contains machine metadata.
<P>
The basic file format of
machine-info
is a newline-separated list of environment-like shell-compatible variable assignments. It is possible to source the configuration from shell scripts, however, beyond mere variable assignments no shell features are supported, allowing applications to read the file without implementing a shell compatible execution engine.
<P>
/etc/machine-info
contains metadata about the machine that is set by the user or administrator.
<P>
Depending on the operating system other configuration files might be checked for machine information as well, however only as fallback.
<P>
You may use
<B><A HREF="/cgi-bin/man/man2html?1+hostnamectl">hostnamectl</A></B>(1)
to change the settings of this file from the command line.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
The following machine metadata parameters may be set using
/etc/machine-info:
<P>
<I>PRETTY_HOSTNAME=</I>
<DL COMPACT><DT id="1"><DD>
A pretty human-readable UTF-8 machine identifier string. This should contain a name like
&quot;Lennart's Laptop&quot;
which is useful to present to the user and does not suffer by the syntax limitations of internet domain names. If possible, the internet hostname as configured in
/etc/hostname
should be kept similar to this one. Example: if this value is
&quot;Lennart's Computer&quot;
an Internet hostname of
&quot;lennarts-computer&quot;
might be a good choice. If this parameter is not set, an application should fall back to the Internet host name for presentation purposes.
</DL>
<P>
<I>ICON_NAME=</I>
<DL COMPACT><DT id="2"><DD>
An icon identifying this machine according to the
m[blue]<B>XDG Icon Naming Specification</B>m[]<FONT SIZE="-2">[1]</FONT>. If this parameter is not set, an application should fall back to
&quot;computer&quot;
or a similar icon name.
</DL>
<P>
<I>CHASSIS=</I>
<DL COMPACT><DT id="3"><DD>
The chassis type. Currently, the following chassis types are defined:
&quot;desktop&quot;,
&quot;laptop&quot;,
&quot;convertible&quot;,
&quot;server&quot;,
&quot;tablet&quot;,
&quot;handset&quot;,
&quot;watch&quot;, and
&quot;embedded&quot;, as well as the special chassis types
&quot;vm&quot;
and
&quot;container&quot;
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.
</DL>
<P>
<I>DEPLOYMENT=</I>
<DL COMPACT><DT id="4"><DD>
Describes the system deployment environment. One of the following is suggested:
&quot;development&quot;,
&quot;integration&quot;,
&quot;staging&quot;,
&quot;production&quot;.
</DL>
<P>
<I>LOCATION=</I>
<DL COMPACT><DT id="5"><DD>
Describes the system location if applicable and known. Takes a human-friendly, free-form string. This may be as generic as
&quot;Berlin, Germany&quot;
or as specific as
&quot;Left Rack, 2nd Shelf&quot;.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>EXAMPLE</H2>
<P>
<DL COMPACT><DT id="6"><DD>
<PRE>
PRETTY_HOSTNAME=&quot;Lennart's Tablet&quot;
ICON_NAME=computer-tablet
CHASSIS=tablet
DEPLOYMENT=production
</PRE>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+systemd">systemd</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?5+os-release">os-release</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?5+hostname">hostname</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?5+machine-id">machine-id</A></B>(5),
<B><A HREF="/cgi-bin/man/man2html?1+hostnamectl">hostnamectl</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?8+systemd-hostnamed.service">systemd-hostnamed.service</A></B>(8)
<A NAME="lbAH">&nbsp;</A>
<H2>NOTES</H2>
<DL COMPACT>
<DT id="7"> 1.<DD>
XDG Icon Naming Specification
<DL COMPACT><DT id="8"><DD>
<A HREF="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html</A>
</DL>
<P>
</DL>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="11"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="13"><A HREF="#lbAF">EXAMPLE</A><DD>
<DT id="14"><A HREF="#lbAG">SEE ALSO</A><DD>
<DT id="15"><A HREF="#lbAH">NOTES</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:03 GMT, March 31, 2021
</BODY>
</HTML>