X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fmachine-info.xml;h=c654daa856dd71be8bae4c0cb966075f03f8b210;hp=b310d71334195302b54b0ca05f631dbecabe380c;hb=3bfd4e0c6341b0ef946d2198f089743fa99e0a97;hpb=dbc4fbae58e39cb0d33738f0a4d1e74511ed1fb5 diff --git a/man/machine-info.xml b/man/machine-info.xml index b310d7133..c654daa85 100644 --- a/man/machine-info.xml +++ b/man/machine-info.xml @@ -55,7 +55,7 @@ Description The /etc/machine-info file - contains machine meta data. + contains machine metadata. The basic file format of machine-info is a @@ -68,7 +68,7 @@ execution engine. /etc/machine-info contains - meta data about the machine that is set by the user or + metadata about the machine that is set by the user or administrator. Depending on the operating system other @@ -84,7 +84,7 @@ Options - The following machine meta data parameters may + The following machine metadata parameters may be set using /etc/machine-info: @@ -94,22 +94,22 @@ PRETTY_HOSTNAME= A pretty - human-readable UTF8 machine identifier + human-readable UTF-8 machine identifier string. This should contain a name like Lennart's 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 host name as configured in + 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's Computer - an Internet host name of + an Internet hostname of lennarts-computer might be a good choice. If this - parameter is not set an application + parameter is not set, an application should fall back to the Internet host name for presentation purposes. @@ -122,21 +122,76 @@ this machine according to the XDG Icon Naming Specification. If - this parameter is not set an + this parameter is not set, an application should fall back to computer or a similar icon name. - + + CHASSIS= + + The chassis + type. Currently, the following chassis + types are defined: + desktop, + laptop, + server, + tablet, + handset, + watch, as well as + the special chassis types + vm and + container 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. + + + DEPLOYMENT= + + Describes the system + deployment environment. One of the + following is suggested: + development, + integration, + staging, + production. + + + + + LOCATION= + + 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. + + Example - PRETTY_HOSTNAME="Lennart's Computer" -ICON_NAME=computer-laptop + PRETTY_HOSTNAME="Lennart's Tablet" +ICON_NAME=computer-tablet +CHASSIS=tablet +DEPLOYMENT=production