Debian Codegraph @

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

raw
1 '\" t
2 .TH "MACHINE\-INFO" "5" "" "systemd 261~rc3" "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 .SS "Machine Information"
50 .PP
51 \fIPRETTY_HOSTNAME=\fR
52 .RS 4
53 A pretty human\-readable UTF\-8 machine identifier string\&. This should contain a name like
54 "Lennart\*(Aqs Laptop"
55 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
56 /etc/hostname
57 should be kept similar to this one\&. Example: if this value is
58 "Lennart\*(Aqs Computer"
59 an Internet hostname of
60 "lennarts\-computer"
61 might be a good choice\&. If this parameter is not set, an application should fall back to the Internet hostname for presentation purposes\&.
62 .RE
63 .PP
64 \fIICON_NAME=\fR
65 .RS 4
66 An icon identifying this machine according to the
67 \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
68 "computer"
69 or a similar icon name\&.
70 .RE
71 .PP
72 \fICHASSIS=\fR
73 .RS 4
74 The chassis type\&. Currently, the following chassis types are defined:
75 "desktop",
76 "laptop",
77 "convertible",
78 "server",
79 "tablet",
80 "handset",
81 "watch", and
82 "embedded", as well as the special chassis types
83 "vm"
84 and
85 "container"
86 for virtualized systems that lack an immediate physical chassis\&.
87 .sp
88 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\&.
89 .sp
90 Added in version 197\&.
91 .RE
92 .PP
93 \fIDEPLOYMENT=\fR
94 .RS 4
95 Describes the system deployment environment\&. One of the following is suggested:
96 "development",
97 "integration",
98 "staging",
99 "testing",
100 "production"\&.
101 .sp
102 Added in version 216\&.
103 .RE
104 .PP
105 \fILOCATION=\fR
106 .RS 4
107 Describes the system location if applicable and known\&. Takes a human\-friendly, free\-form string\&. This may be as generic as
108 "Berlin, Germany"
109 or as specific as
110 "Left Rack, 2nd Shelf"\&.
111 .sp
112 Added in version 216\&.
113 .RE
114 .PP
115 \fITAGS=\fR
116 .RS 4
117 A colon\-separated list of tags attached to this machine\&. Tags are short labels that may be used to classify and group machines for management purposes, for example to identify the role a machine plays in a deployment ("webserver",
118 "database"), the fleet or organizational unit it belongs to, or any other administrator\-defined attribute\&. Example:
119 "TAGS=webserver:frontend:berlin"\&.
120 .sp
121 Each individual tag must be 1\&...255 characters long and may consist only of the ASCII alphanumeric characters,
122 "\-"
123 and
124 "\&."\&.
125 .sp
126 The configured tags may be matched against with the
127 \fIConditionMachineTag=\fR
128 and
129 \fIAssertMachineTag=\fR
130 unit settings, see
131 \fBsystemd.unit\fR(5)
132 for details\&. They may be queried and changed with the
133 \fBtags\fR
134 command of
135 \fBhostnamectl\fR(1)\&.
136 .sp
137 Added in version 261\&.
138 .RE
139 .PP
140 \fIHARDWARE_VENDOR=\fR
141 .RS 4
142 Specifies the hardware vendor\&. If unspecified, the hardware vendor set in DMI or
143 \fBhwdb\fR(7)
144 will be used\&.
145 .sp
146 Added in version 251\&.
147 .RE
148 .PP
149 \fIHARDWARE_MODEL=\fR
150 .RS 4
151 Specifies the hardware model\&. If unspecified, the hardware model set in DMI or
152 \fBhwdb\fR(7)
153 will be used\&.
154 .sp
155 Added in version 251\&.
156 .RE
157 .PP
158 \fIHARDWARE_SKU=\fR
159 .RS 4
160 Specifies the hardware SKU (Stock\-Keeping Unit)\&. If unspecified, the hardware SKU set in DMI will be used\&.
161 .sp
162 Added in version 258\&.
163 .RE
164 .PP
165 \fIHARDWARE_VERSION=\fR
166 .RS 4
167 Specifies the hardware version\&. If unspecified, the hardware version set in DMI will be used\&.
168 .sp
169 Added in version 258\&.
170 .RE
171 .SS "Custom Fields"
172 .PP
173 Operating system vendors and systemd administrators may extend the file format and introduce new fields\&. It is highly recommended to prefix new fields with an OS\-specific name in order to avoid name clashes\&. Applications reading this file must ignore unknown fields\&.
174 .PP
175 Example:
176 "_LOCAL_EMERGENCY_CONTACT="user@example\&.org""\&.
177 .SH "EXAMPLE"
178 .sp
179 .if n \{\
180 .RS 4
181 .\}
182 .nf
183 PRETTY_HOSTNAME="Lennart\*(Aqs Tablet"
184 ICON_NAME=computer\-tablet
185 CHASSIS=tablet
186 DEPLOYMENT=production
187 TAGS=demo:berlin
188 .fi
189 .if n \{\
190 .RE
191 .\}
192 .SH "SEE ALSO"
193 .PP
194 \fBsystemd\fR(1), \fBos-release\fR(5), \fBhostname\fR(5), \fBmachine-id\fR(5), \fBhostnamectl\fR(1), \fBsystemd-hostnamed.service\fR(8)
195 .SH "NOTES"
196 .IP " 1." 4
197 XDG Icon Naming Specification
198 .RS 4
199 \%https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
200 .RE