man: add man page for systemd-backlight@.service

[elogind.git] / man / hostnamectl.xml

diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml
index 955e79bfd7da3e380e2cc373082029b82b1295ef..f28e430a421bda3b0977982e2e1e883e82c1a627 100644 (file)
--- a/man/hostnamectl.xml
+++ b/man/hostnamectl.xml
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 

-<refentry id="hostnamectl">
+<refentry id="hostnamectl" conditional='ENABLE_HOSTNAMED'>

 
         <refentryinfo>
                 <title>hostnamectl</title>
 
         <refentryinfo>
                 <title>hostnamectl</title>


@@ -58,11 +58,11 @@
 
                 <para><command>hostnamectl</command> may be used to
                 query and change the system hostname and related
 
                 <para><command>hostnamectl</command> may be used to
                 query and change the system hostname and related

-               settings.</para>
+                settings.</para>

 
 

-                <para>This tool distuingishes three different host
-                names: the high-level "pretty" hostname which might
-                include all 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
                 (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 +75,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
                 <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>
                 <filename>/etc/hostname</filename>, see
                 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>

-                for more information. The pretty host name 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>
                 <filename>/etc/machine-info</filename>, see
                 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
         </refsect1>


@@ -93,8 +93,8 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>

-                                <term><option>--help</option></term>

                                 <term><option>-h</option></term>
                                 <term><option>-h</option></term>

+                                <term><option>--help</option></term>

 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>


@@ -110,18 +110,26 @@
                         <varlistentry>
                                 <term><option>--no-ask-password</option></term>
 
                         <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>
 
                                 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>
 
                         <varlistentry>
                                 <term><option>-H</option></term>
                                 <term><option>--host</option></term>
 

-                                <listitem><para>Execute operation
+                                <listitem><para>Execute the operation

                                 remotely. Specify a hostname, or
                                 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>
                                 to connect to. This will use SSH to
                                 talk to a remote
                                 system.</para></listitem>


@@ -135,8 +143,8 @@
                                 <listitem><para>If
                                 <command>set-hostname</command> is
                                 invoked and one or more of these
                                 <listitem><para>If
                                 <command>set-hostname</command> is
                                 invoked and one or more of these

-                                options are passed only the selected
-                                hostnames is
+                                options are passed, only the selected
+                                hostname(s) is/are

                                 updated.</para></listitem>
                         </varlistentry>
                 </variablelist>
                                 updated.</para></listitem>
                         </varlistentry>
                 </variablelist>


@@ -156,34 +164,35 @@
                                 <term><command>set-hostname [NAME]</command></term>
 
                                 <listitem><para>Set the system
                                 <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
                                 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>,
                                 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
                                 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
                                 latter are updated. This is done by

-                                replacing spaces by "-" and removing
+                                replacing spaces with
+                                <literal>-</literal> and removing

                                 special characters. This ensures that
                                 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
                                 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>
                         </varlistentry>
 
                         <varlistentry>


@@ -196,10 +205,36 @@
                                 the <ulink
                                 url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
                                 Naming Specification</ulink>. Pass an
                                 the <ulink
                                 url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
                                 Naming Specification</ulink>. Pass an

-                                empty string to this operatoin to
+                                empty string to this operation to

                                 reset the icon name to the default
                                 reset the icon name to the default

+                                value, which is determined from chassis
+                                type (see below) and possibly other
+                                parameters.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><command>set-chassis [TYPE]</command></term>
+
+                                <listitem><para>Set the chassis
+                                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:
+                                <literal>desktop</literal>,
+                                <literal>laptop</literal>,
+                                <literal>server</literal>,
+                                <literal>tablet</literal>,
+                                <literal>handset</literal>, as well as
+                                the special chassis types
+                                <literal>vm</literal> and
+                                <literal>container</literal> 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
                                 value which is determined from the

-                                system form factor and possibly other
+                                firmware and possibly other

                                 parameters.</para></listitem>
                         </varlistentry>
 
                                 parameters.</para></listitem>
                         </varlistentry>