From dbc4fbae58e39cb0d33738f0a4d1e74511ed1fb5 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 17 Oct 2012 21:23:30 +0200 Subject: hostname: add new hostnamectl tool as text client for hostnamed --- man/hostname.xml | 9 +- man/hostnamectl.xml | 228 ++++++++++++++++++++++++++++++++++++++ man/localtime.xml | 13 ++- man/machine-info.xml | 9 +- man/systemd-hostnamed.service.xml | 5 +- man/timedatectl.xml | 8 +- 6 files changed, 264 insertions(+), 8 deletions(-) create mode 100644 man/hostnamectl.xml (limited to 'man') diff --git a/man/hostname.xml b/man/hostname.xml index 2ada32ff71..84a2961664 100644 --- a/man/hostname.xml +++ b/man/hostname.xml @@ -70,6 +70,11 @@ Depending on the operating system other configuration files might be checked for configuration of the host name as well, however only as fallback. + + You may use + hostnamectl1 + to change the value of this file from the command + line. @@ -88,7 +93,9 @@ hostname1, hostname7, machine-id5, - machine-info5 + machine-info5, + hostnamectl1, + systemd-hostnamed.service8 diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml new file mode 100644 index 0000000000..955e79bfd7 --- /dev/null +++ b/man/hostnamectl.xml @@ -0,0 +1,228 @@ + + + + + + + + + hostnamectl + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + hostnamectl + 1 + + + + hostnamectl + Control the system hostname + + + + + hostnamectl OPTIONS COMMAND + + + + + Description + + hostnamectl may be used to + query and change the system hostname and related + settings. + + This tool distuingishes three different host + names: the high-level "pretty" hostname which might + include all all kinds of special characters + (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"). + + Note that the pretty hostname has little + restrictions on the characters used, while the static + and transient hostnames are limited to the usually + accepted characters of internet domain names. + + The static host name is stored in + /etc/hostname, see + hostname5 + for more information. The pretty host name and icon + name are stored in + /etc/machine-info, see + machine-id5. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Prints a short version + string and exits. + + + + + + Don't query the user + for authentication for privileged + operations. + + + + + + + Execute 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 + hostnames is + updated. + + + + The following commands are understood: + + + + status + + Show current system + hostname and related + information. + + + + 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 + , + , + are used + only the selected hostnames are + changed. If the pretty hostname is + being set, and static or transient are + being set as well the specified host + name will be simplified in regards to + the character set used before the + latter are updated. This is done by + replacing spaces by "-" and removing + special characters. This ensures that + the pretty and the static hostname + are always closely related while still + following the validity rules of the + specific name. This simplification of + 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 hostname to reset the + selected hostnames to their default + (usually + "localhost"). + + + + 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 Icon + Naming Specification. Pass an + empty string to this operatoin to + reset the icon name to the default + value which is determined from the + system form factor and possibly other + parameters. + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + See Also + + systemd1, + hostname1, + hostname5, + machine-info5, + systemctl1, + systemd-hostnamed.service8 + + + + diff --git a/man/localtime.xml b/man/localtime.xml index c0e87bf78f..88c84a3682 100644 --- a/man/localtime.xml +++ b/man/localtime.xml @@ -82,14 +82,21 @@ The time zone may be overridden for individual programs by using the TZ environment variable. See environ7. + + You may use + timedatectl1 + to change the settings of this file from the command + line. See Also - tzset3 - localtime3 - systemd1 + systemd1, + tzset3, + localtime3, + timedatectl1, + systemd-timedated.service8 diff --git a/man/machine-info.xml b/man/machine-info.xml index e27b600211..b310d71334 100644 --- a/man/machine-info.xml +++ b/man/machine-info.xml @@ -74,6 +74,11 @@ Depending on the operating system other configuration files might be checked for machine information as well, however only as fallback. + + You may use + hostnamectl1 + to change the settings of this file from the command + line. @@ -140,7 +145,9 @@ ICON_NAME=computer-laptop systemd1, os-release5, hostname5, - machine-id5 + machine-id5, + hostnamectl1, + systemd-hostnamed.service8 diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml index 9fee2a096d..555bb7a2df 100644 --- a/man/systemd-hostnamed.service.xml +++ b/man/systemd-hostnamed.service.xml @@ -74,8 +74,9 @@ systemd1, hostname5, - sethostname2, - machine-info5 + machine-info5, + hostnamectl1, + sethostname2 diff --git a/man/timedatectl.xml b/man/timedatectl.xml index 8fb4e38f37..9065577692 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -154,7 +154,12 @@ list-timezones. If the RTC is configured to be in the local time this will also update the - RTC time. + RTC time. This call will alter the + /etc/localtime + symlink. See + localtime5 + for more + information. @@ -235,6 +240,7 @@ systemd1, hwclock8, date1, + localtime5, systemctl1, systemd-timedated.service8 -- cgit v1.2.3-54-g00ecf