X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fhostnamectl.xml;h=de154020d6a29572cf1ff9c2211e0b8b0d302a04;hp=f28e430a421bda3b0977982e2e1e883e82c1a627;hb=a2e0337875addaf08225fbf9b231435ba12a88b5;hpb=409dee2e44e7dc73d6bf00d782938e4cb4105f5b diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml index f28e430a4..de154020d 100644 --- a/man/hostnamectl.xml +++ b/man/hostnamectl.xml @@ -21,7 +21,8 @@ along with systemd; If not, see . --> - + hostnamectl @@ -49,7 +50,9 @@ - hostnamectl OPTIONS COMMAND + hostnamectl + OPTIONS + COMMAND @@ -66,11 +69,9 @@ (e.g. "Lennart's Laptop"), the static hostname which is used to initialize the kernel hostname at boot (e.g. "lennarts-laptop"), and the transient hostname - which might be assigned temporarily due to network - configuration and might revert back to the static - hostname if network connectivity is lost and is only - temporarily written to the kernel hostname - (e.g. "dhcp-47-11"). + which is a default received from network configuration. + If a static hostname is set, and is valid (something other + than localhost), then the transient hostname is not used. Note that the pretty hostname has little restrictions on the characters used, while the static @@ -81,9 +82,14 @@ /etc/hostname, see hostname5 for more information. The pretty hostname, chassis - type and icon name are stored in + type, and icon name are stored in /etc/machine-info, see - machine-id5. + machine-info5. + + Use + systemd-firstboot1 + to initialize the system host name for mounted (but + not booted) system images. @@ -92,21 +98,6 @@ The following options are understood: - - - - - Prints a short help - text and exits. - - - - - - Prints a short version - string and exits. - - @@ -115,38 +106,33 @@ operations. - - - - - Acquire privileges via PolicyKit - before executing the operation. - - - - - - - Execute the operation - remotely. Specify a hostname, or - username and hostname separated by @, - to connect to. This will use SSH to - talk to a remote - system. - - If - set-hostname is - invoked and one or more of these - options are passed, only the selected - hostname(s) is/are - updated. + status is used (or + no explicit command is given) and one + of those fields is given, + hostnamectl will + print out just this selected + hostname. + + If used with + set-hostname, only + the selected hostname(s) will be + updated. When more than one of those + options is used, all the specified + hostnames will be updated. + + + + + + + The following commands are understood: @@ -161,13 +147,14 @@ - set-hostname [NAME] + set-hostname NAME Set the system - hostname. By default, this will alter - the pretty, the static, and the - transient hostname alike; however, if - one or more of + hostname to + NAME. By + default, this will alter the pretty, + the static, and the transient hostname + alike; however, if one or more of , , are used, @@ -188,63 +175,109 @@ the hostname string is not done if only the transient and/or static host names are set, and the pretty host - name is left untouched. Pass the empty - string as the - hostname to reset the selected - hostnames to their default (usually + name is left untouched. + + Pass the empty string + as the hostname to + reset the selected hostnames to their + default (usually localhost). - set-icon-name [NAME] + set-icon-name NAME Set the system icon - name. The icon name is used by some - graphical applications to visualize - this host. The icon name should follow - the NAME. The + icon name is used by some graphical + applications to visualize this host. + The icon name should follow the Icon - Naming Specification. Pass an - empty string to this operation to - reset the icon name to the default - value, which is determined from chassis - type (see below) and possibly other + Naming Specification. + + Pass an empty string to reset + the icon name to the default value, + which is determined from chassis type + (see below) and possibly other parameters. - set-chassis [TYPE] + set-chassis TYPE - Set the chassis - type. The chassis type is used by some + Set the chassis type + to TYPE. + The chassis type is used by some graphical applications to visualize - the host or alter user - interaction. Currently, the following - chassis types are defined: + the host or alter user interaction. + Currently, the following chassis types + are defined: desktop, laptop, server, tablet, - handset, as well as + handset, + watch, + embedded as well as the special chassis types vm and container for virtualized systems that lack an - immediate physical chassis. Pass an - empty string to this operation to - reset the chassis type to the default - value which is determined from the - firmware and possibly other - parameters. + immediate physical chassis. + + Pass an empty string to reset + the chassis type to the default value + which is determined from the firmware + and possibly other parameters. + + + set-deployment ENVIRONMENT + + Set the deployment + environment + description. ENVIRONMENT + must be a single word without any + control characters. One of the + following is suggested: + development, + integration, + staging, + production. + + + Pass an empty string to reset to + the default empty value. + + + + + set-location LOCATION + + Set the location + string for the system, if it is + known. LOCATION + should be a human-friendly, free-form + string describing the physical + location of the system, if it is known + and applicable. This may be as generic + as Berlin, Germany + or as specific as Left Rack, + 2nd Shelf. + + Pass an empty string to reset to + the default empty value. + + Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. @@ -256,7 +289,8 @@ hostname5, machine-info5, systemctl1, - systemd-hostnamed.service8 + systemd-hostnamed.service8, + systemd-firstboot1