build-sys: update intructions for Makefile-man.am regeneration

[elogind.git] / man / hostnamectl.xml

diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml
index d7a9e92879b45b042d7a68385dedc1bbf86cbbfa..6746a7042fe4622f149d4a7b27c443657b1ea8f6 100644 (file)
--- a/man/hostnamectl.xml
+++ b/man/hostnamectl.xml
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="hostnamectl" conditional='ENABLE_HOSTNAMED'>
+<refentry id="hostnamectl" conditional='ENABLE_HOSTNAMED'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>hostnamectl</title>
@@ -49,7 +50,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>
 
@@ -75,13 +78,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 hostname is stored in
                 <filename>/etc/hostname</filename>, see
                 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 for more information. The pretty hostname, chassis
-                type and icon name are stored in
+                type, and icon name are stored in
                 <filename>/etc/machine-info</filename>, see
                 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
         </refsect1>
@@ -92,25 +95,10 @@
                 <para>The following options are understood:</para>
 
                 <variablelist>
-                        <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--version</option></term>
-
-                                <listitem><para>Prints a short version
-                                string and exits.</para></listitem>
-                        </varlistentry>
-
                         <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>
@@ -123,30 +111,32 @@
                                 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 @,
-                                to connect to. This will use SSH to
-                                talk to a remote
-                                system.</para></listitem>
-                        </varlistentry>
-
                         <varlistentry>
                                 <term><option>--static</option></term>
                                 <term><option>--transient</option></term>
                                 <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
-                                hostname(s) is/are
-                                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>
+
+                        <xi:include href="user-system-options.xml" xpointer="host" />
+
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
                 </variablelist>
 
                 <para>The following commands are understood:</para>
@@ -178,20 +168,21 @@
                                 hostname will be simplified in regards
                                 to the character set used before the
                                 latter are updated. This is done by
-                                replacing spaces with "-" 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
                                 following the validity rules of the
                                 specific name. This simplification of
                                 the hostname string is not done if
-                                only the transient and/or static
-                                hostnames are set, and the pretty
-                                hostname is left untouched. Pass the
-                                empty string "" as the hostname to
-                                reset the selected hostnames to their
-                                default (usually "localhost").
-                                </para></listitem>
+                                only the transient and/or static host
+                                names are set, and the pretty host
+                                name is left untouched. Pass the empty
+                                string <literal></literal> as the
+                                hostname to reset the selected
+                                hostnames to their default (usually
+                                <literal>localhost</literal>).</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
@@ -243,7 +234,7 @@
         <refsect1>
                 <title>Exit status</title>
 
-                <para>On success 0 is returned, a non-zero failure
+                <para>On success, 0 is returned, a non-zero failure
                 code otherwise.</para>
         </refsect1>