diff options
Diffstat (limited to 'man/hostnamectl.xml')
| -rw-r--r-- | man/hostnamectl.xml | 78 |
1 files changed, 49 insertions, 29 deletions
diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml index 9efe220119..b39fb5502b 100644 --- a/man/hostnamectl.xml +++ b/man/hostnamectl.xml @@ -49,7 +49,9 @@ <refsynopsisdiv> <cmdsynopsis> - <command>hostnamectl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command> + <command>hostnamectl</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> + <arg choice="req">COMMAND</arg> </cmdsynopsis> </refsynopsisdiv> @@ -60,9 +62,9 @@ query and change the system hostname and related settings.</para> - <para>This tool distinguishes three different host - names: the high-level "pretty" hostname which might - include all kinds of special characters + <para>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 @@ <para>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.</para> + accepted characters of Internet domain names.</para> - <para>The static host name is stored in + <para>The static hostname is stored in <filename>/etc/hostname</filename>, see <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry> - 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 <filename>/etc/machine-info</filename>, see <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> </refsect1> @@ -110,18 +112,26 @@ <varlistentry> <term><option>--no-ask-password</option></term> - <listitem><para>Don't query the user + <listitem><para>Do not query the user for authentication for privileged operations.</para></listitem> </varlistentry> <varlistentry> + <term><option>-P</option></term> + <term><option>--privileged</option></term> + + <listitem><para>Acquire privileges via PolicyKit + before executing the operation.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>-H</option></term> <term><option>--host</option></term> <listitem><para>Execute the operation remotely. Specify a hostname, or - username and hostname separated by @, + username and hostname separated by <literal>@</literal>, to connect to. This will use SSH to talk to a remote system.</para></listitem> @@ -133,11 +143,20 @@ <term><option>--pretty</option></term> <listitem><para>If - <command>set-hostname</command> is - invoked and one or more of these - options are passed only the selected - hostnames is - updated.</para></listitem> + <command>status</command> is used (or + no explicit command is given) and one + of those fields is given, + <command>hostnamectl</command> will + print out just this selected + hostname.</para> + + <para>If used with + <command>set-hostname</command>, only + the selected hostname(s) will be + updated. When more than one of those + options is used, all the specified + hostnames will be updated. + </para></listitem> </varlistentry> </variablelist> @@ -156,34 +175,35 @@ <term><command>set-hostname [NAME]</command></term> <listitem><para>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 <option>--static</option>, <option>--transient</option>, - <option>--pretty</option> are used + <option>--pretty</option> 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 + <literal>-</literal> 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").</para></listitem> + string <literal></literal> as the + hostname to reset the selected + hostnames to their default (usually + <literal>localhost</literal>).</para></listitem> </varlistentry> <varlistentry> @@ -198,7 +218,7 @@ Naming Specification</ulink>. 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.</para></listitem> </varlistentry> |