Debian Codegraph @

upstream/debian-trixie/man5/machine-info.5

raw
1 '\" t
2 .TH "MACHINE\-INFO" "5" "" "systemd 257.13" "machine-info"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 machine-info \- Local machine information file
24 .SH "SYNOPSIS"
25 .PP
26 /etc/machine\-info
27 .SH "DESCRIPTION"
28 .PP
29 The
30 /etc/machine\-info
31 file contains machine metadata\&.
32 .PP
33 The format of
34 machine\-info
35 is a newline\-separated list of environment\-like shell\-compatible variable assignments, ignoring comments and empty lines\&. 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\&. See
36 \fBos-release\fR(5)
37 for a detailed description of the format\&.
38 .PP
39 /etc/machine\-info
40 contains metadata about the machine that is set by the user or administrator\&. The settings configured here have the highest precedence\&. When not set, appropriate values may be determined automatically, based on the information about the hardware or other configuration files\&. It is thus completely fine for this file to not be present\&.
41 .PP
42 You may use
43 \fBhostnamectl\fR(1)
44 to change the settings of this file from the command line\&.
45 .SH "OPTIONS"
46 .PP
47 The following machine metadata parameters may be set using
48 /etc/machine\-info:
49 .PP
50 \fIPRETTY_HOSTNAME=\fR
51 .RS 4
52 A pretty human\-readable UTF\-8 machine identifier string\&. This should contain a name like
53 "Lennart\*(Aqs Laptop"
54 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
55 /etc/hostname
56 should be kept similar to this one\&. Example: if this value is
57 "Lennart\*(Aqs Computer"
58 an Internet hostname of
59 "lennarts\-computer"
60 might be a good choice\&. If this parameter is not set, an application should fall back to the Internet hostname for presentation purposes\&.
61 .RE
62 .PP
63 \fIICON_NAME=\fR
64 .RS 4
65 An icon identifying this machine according to the
66 \m[blue]\fBXDG Icon Naming Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. If this parameter is not set, an application should fall back to
67 "computer"
68 or a similar icon name\&.
69 .RE
70 .PP
71 \fICHASSIS=\fR
72 .RS 4
73 The chassis type\&. Currently, the following chassis types are defined:
74 "desktop",
75 "laptop",
76 "convertible",
77 "server",
78 "tablet",
79 "handset",
80 "watch", and
81 "embedded", as well as the special chassis types
82 "vm"
83 and
84 "container"
85 for virtualized systems that lack an immediate physical chassis\&.
86 .sp
87 Note that most systems allow detection of the chassis type automatically (based on firmware information or suchlike)\&. This setting should only be used to override a misdetection or to manually configure the chassis type where automatic detection is not available\&.
88 .sp
89 Added in version 197\&.
90 .RE
91 .PP
92 \fIDEPLOYMENT=\fR
93 .RS 4
94 Describes the system deployment environment\&. One of the following is suggested:
95 "development",
96 "integration",
97 "staging",
98 "production"\&.
99 .sp
100 Added in version 216\&.
101 .RE
102 .PP
103 \fILOCATION=\fR
104 .RS 4
105 Describes the system location if applicable and known\&. Takes a human\-friendly, free\-form string\&. This may be as generic as
106 "Berlin, Germany"
107 or as specific as
108 "Left Rack, 2nd Shelf"\&.
109 .sp
110 Added in version 216\&.
111 .RE
112 .PP
113 \fIHARDWARE_VENDOR=\fR
114 .RS 4
115 Specifies the hardware vendor\&. If unspecified, the hardware vendor set in DMI or
116 \fBhwdb\fR(7)
117 will be used\&.
118 .sp
119 Added in version 251\&.
120 .RE
121 .PP
122 \fIHARDWARE_MODEL=\fR
123 .RS 4
124 Specifies the hardware model\&. If unspecified, the hardware model set in DMI or
125 \fBhwdb\fR(7)
126 will be used\&.
127 .sp
128 Added in version 251\&.
129 .RE
130 .SH "EXAMPLE"
131 .sp
132 .if n \{\
133 .RS 4
134 .\}
135 .nf
136 PRETTY_HOSTNAME="Lennart\*(Aqs Tablet"
137 ICON_NAME=computer\-tablet
138 CHASSIS=tablet
139 DEPLOYMENT=production
140 .fi
141 .if n \{\
142 .RE
143 .\}
144 .SH "SEE ALSO"
145 .PP
146 \fBsystemd\fR(1), \fBos-release\fR(5), \fBhostname\fR(5), \fBmachine-id\fR(5), \fBhostnamectl\fR(1), \fBsystemd-hostnamed.service\fR(8)
147 .SH "NOTES"
148 .IP " 1." 4
149 XDG Icon Naming Specification
150 .RS 4
151 \%https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
152 .RE