diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-10-08 17:58:44 +0200 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-10-08 18:21:26 +0200 |
| commit | e1fac8a68a0d1fe01edf47e149afb3f232bd75b6 (patch) | |
| tree | 1e9913853ee27392dba74ffb491a96cc8c18d5e5 /man/hostnamectl.xml | |
| parent | Merge pull request #13746 from keszybz/tests-reduce-boilerplate (diff) | |
| download | systemd-e1fac8a68a0d1fe01edf47e149afb3f232bd75b6.tar.xz systemd-e1fac8a68a0d1fe01edf47e149afb3f232bd75b6.zip | |
Move the Commands section above Options section
For executables which take a verb, we should list the verbs first, and
then options which modify those verbs second. The general layout of
the man page is from general description to specific details, usually
Overview, Commands, Options, Return Value, Examples, References.
Diffstat (limited to 'man/hostnamectl.xml')
| -rw-r--r-- | man/hostnamectl.xml | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml index ddbeb7e7e6..03293382e6 100644 --- a/man/hostnamectl.xml +++ b/man/hostnamectl.xml @@ -62,39 +62,6 @@ </refsect1> <refsect1> - <title>Options</title> - - <para>The following options are understood:</para> - - <variablelist> - <varlistentry> - <term><option>--no-ask-password</option></term> - - <listitem><para>Do not query the user for authentication for - privileged operations.</para></listitem> - </varlistentry> - - <varlistentry> - <term><option>--static</option></term> - <term><option>--transient</option></term> - <term><option>--pretty</option></term> - - <listitem><para>If <command>status</command> is invoked (or no explicit command is given) and one of these - switches is specified, <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 these switches are specified, all the specified hostnames will be updated. </para></listitem> - </varlistentry> - - <xi:include href="user-system-options.xml" xpointer="host" /> - <xi:include href="user-system-options.xml" xpointer="machine" /> - - <xi:include href="standard-options.xml" xpointer="help" /> - <xi:include href="standard-options.xml" xpointer="version" /> - </variablelist> - </refsect1> - - <refsect1> <title>Commands</title> <para>The following commands are understood:</para> @@ -202,6 +169,39 @@ </refsect1> <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>--no-ask-password</option></term> + + <listitem><para>Do not query the user for authentication for + privileged operations.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--static</option></term> + <term><option>--transient</option></term> + <term><option>--pretty</option></term> + + <listitem><para>If <command>status</command> is invoked (or no explicit command is given) and one of these + switches is specified, <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 these switches are specified, all the specified hostnames will be updated. </para></listitem> + </varlistentry> + + <xi:include href="user-system-options.xml" xpointer="host" /> + <xi:include href="user-system-options.xml" xpointer="machine" /> + + <xi:include href="standard-options.xml" xpointer="help" /> + <xi:include href="standard-options.xml" xpointer="version" /> + </variablelist> + </refsect1> + + <refsect1> <title>Exit status</title> <para>On success, 0 is returned, a non-zero failure code |