diff options
Diffstat (limited to 'upstream/fedora-40/man5/machine-info.5')
| -rw-r--r-- | upstream/fedora-40/man5/machine-info.5 | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/upstream/fedora-40/man5/machine-info.5 b/upstream/fedora-40/man5/machine-info.5 new file mode 100644 index 00000000..f77dc12b --- /dev/null +++ b/upstream/fedora-40/man5/machine-info.5 @@ -0,0 +1,157 @@ +'\" t +.TH "MACHINE\-INFO" "5" "" "systemd 255" "machine-info" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +machine-info \- Local machine information file +.SH "SYNOPSIS" +.PP +/etc/machine\-info +.SH "DESCRIPTION" +.PP +The +/etc/machine\-info +file contains machine metadata\&. +.PP +The format of +machine\-info +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 +\fBos-release\fR(5) +for a detailed description of the format\&. +.PP +/etc/machine\-info +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\&. +.PP +You may use +\fBhostnamectl\fR(1) +to change the settings of this file from the command line\&. +.SH "OPTIONS" +.PP +The following machine metadata parameters may be set using +/etc/machine\-info: +.PP +\fIPRETTY_HOSTNAME=\fR +.RS 4 +A pretty human\-readable UTF\-8 machine identifier string\&. This should contain a name like +"Lennart\*(Aqs Laptop" +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 +"Lennart\*(Aqs Computer" +an Internet hostname of +"lennarts\-computer" +might be a good choice\&. If this parameter is not set, an application should fall back to the Internet hostname for presentation purposes\&. +.RE +.PP +\fIICON_NAME=\fR +.RS 4 +An icon identifying this machine according to the +\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 +"computer" +or a similar icon name\&. +.RE +.PP +\fICHASSIS=\fR +.RS 4 +The chassis type\&. Currently, the following chassis types are defined: +"desktop", +"laptop", +"convertible", +"server", +"tablet", +"handset", +"watch", and +"embedded", as well as the special chassis types +"vm" +and +"container" +for virtualized systems that lack an immediate physical chassis\&. +.sp +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\&. +.sp +Added in version 197\&. +.RE +.PP +\fIDEPLOYMENT=\fR +.RS 4 +Describes the system deployment environment\&. One of the following is suggested: +"development", +"integration", +"staging", +"production"\&. +.sp +Added in version 216\&. +.RE +.PP +\fILOCATION=\fR +.RS 4 +Describes the system location if applicable and known\&. Takes a human\-friendly, free\-form string\&. This may be as generic as +"Berlin, Germany" +or as specific as +"Left Rack, 2nd Shelf"\&. +.sp +Added in version 216\&. +.RE +.PP +\fIHARDWARE_VENDOR=\fR +.RS 4 +Specifies the hardware vendor\&. If unspecified, the hardware vendor set in DMI or +\fBhwdb\fR(7) +will be used\&. +.sp +Added in version 251\&. +.RE +.PP +\fIHARDWARE_MODEL=\fR +.RS 4 +Specifies the hardware model\&. If unspecified, the hardware model set in DMI or +\fBhwdb\fR(7) +will be used\&. +.sp +Added in version 251\&. +.RE +.SH "EXAMPLE" +.sp +.if n \{\ +.RS 4 +.\} +.nf +PRETTY_HOSTNAME="Lennart\*(Aqs Tablet" +ICON_NAME=computer\-tablet +CHASSIS=tablet +DEPLOYMENT=production +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBos-release\fR(5), +\fBhostname\fR(5), +\fBmachine-id\fR(5), +\fBhostnamectl\fR(1), +\fBsystemd-hostnamed.service\fR(8) +.SH "NOTES" +.IP " 1." 4 +XDG Icon Naming Specification +.RS 4 +\%https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html +.RE |