X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fhostnamectl.xml;h=4bc05f52ce79cc4e1088c817eea4903b9c2e2c1c;hb=0349c608c839e728e15a37b2317c3f332c8a2a36;hp=801ab3a7bf54106c900f35fa3710d2569f253009;hpb=2927b326ccf67236e148444679f582ea1437ef5a;p=elogind.git
diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml
index 801ab3a7b..4bc05f52c 100644
--- a/man/hostnamectl.xml
+++ b/man/hostnamectl.xml
@@ -49,7 +49,9 @@
- hostnamectl OPTIONSCOMMAND
+ hostnamectl
+ OPTIONS
+ COMMAND
@@ -60,9 +62,9 @@
query and change the system hostname and related
settings.
- This tool distinguishes three different host
- names: the high-level "pretty" hostname which might
- include all kinds of special characters
+ This tool distinguishes three different
+ hostnames: the high-level "pretty" hostname which
+ might include 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
@@ -75,13 +77,13 @@
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.
+ accepted characters of Internet domain names.
- The static host name is stored in
+ The static hostname is stored in
/etc/hostname, see
hostname5
- for more information. The pretty host name, chassis
- type and icon name are stored in
+ for more information. The pretty hostname, chassis
+ type, and icon name are stored in
/etc/machine-info, see
machine-id5.
@@ -110,7 +112,7 @@
- Don't query the user
+ Do not query the user
for authentication for privileged
operations.
@@ -129,9 +131,9 @@
Execute the operation
remotely. Specify a hostname, or
- username and hostname separated by @,
+ username and hostname separated by @,
to connect to. This will use SSH to
- talk to a remote
+ talk to the remote
system.
@@ -141,11 +143,20 @@
If
- set-hostname is
- invoked and one or more of these
- options are passed only the selected
- hostnames is
- 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.
+
@@ -164,34 +175,35 @@
set-hostname [NAME]Set the system
- hostname. By default this will alter
+ hostname. By default, this will alter
the pretty, the static, and the
- transient hostname alike, however if
+ transient hostname alike; however, if
one or more of
,
,
- are used
+ 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
+ being set as well, the specified
+ hostname will be simplified in regards
+ to the character set used before the
latter are updated. This is done by
- replacing spaces by "-" and removing
+ replacing spaces with
+ - and removing
special characters. This ensures that
- the pretty and the static hostname
- are always closely related while still
+ 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").
+ string as the
+ hostname to reset the selected
+ hostnames to their default (usually
+ localhost).
@@ -206,7 +218,7 @@
Naming Specification. Pass an
empty string to this operation to
reset the icon name to the default
- value which is determined from chassis
+ value, which is determined from chassis
type (see below) and possibly other
parameters.
@@ -243,7 +255,7 @@
Exit status
- On success 0 is returned, a non-zero failure
+ On success, 0 is returned, a non-zero failure
code otherwise.