diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2013-12-08 08:16:59 -0500 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2013-12-08 19:26:51 -0500 |
commit | 4f8f66cb4236783cd3cbee97fefc9aaa8469ac08 (patch) | |
tree | 3ad61e72125de1ee3d8197938e69c1959a108c2f /man | |
parent | a6c3d202b14939006f39e22179a058159a8512fb (diff) |
Help output spring cleaning
Use [brackets] only for optional elements.
Use <optional> in XML sources.
Diffstat (limited to 'man')
-rw-r--r-- | man/loginctl.xml | 69 | ||||
-rw-r--r-- | man/machinectl.xml | 10 | ||||
-rw-r--r-- | man/systemctl.xml | 10 |
3 files changed, 45 insertions, 44 deletions
diff --git a/man/loginctl.xml b/man/loginctl.xml index d9e985900..eb4a2fd77 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -201,7 +201,7 @@ </varlistentry> <varlistentry> - <term><command>session-status [ID...]</command></term> + <term><command>session-status</command> <replaceable>ID</replaceable>...</term> <listitem><para>Show terse runtime status information about one or more @@ -214,7 +214,7 @@ </varlistentry> <varlistentry> - <term><command>show-session [ID...]</command></term> + <term><command>show-session</command> <optional><replaceable>ID</replaceable>...</optional></term> <listitem><para>Show properties of one or more sessions or the manager @@ -237,7 +237,7 @@ </varlistentry> <varlistentry> - <term><command>activate [ID...]</command></term> + <term><command>activate</command> <replaceable>ID</replaceable>...</term> <listitem><para>Activate one or more sessions. This brings one or more @@ -248,12 +248,13 @@ </varlistentry> <varlistentry> - <term><command>lock-session [ID...]</command></term> - <term><command>unlock-session [ID...]</command></term> + <term><command>lock-session</command> <replaceable>ID</replaceable>...</term> + <term><command>unlock-session</command> <replaceable>ID</replaceable>...</term> <listitem><para>Activates/deactivates the screen lock on one or more - sessions, if the session supports it.</para></listitem> + sessions, if the session supports it. + </para></listitem> </varlistentry> <varlistentry> @@ -262,22 +263,22 @@ <listitem><para>Activates/deactivates the screen lock on all current - sessions supporting - it.</para></listitem> + sessions supporting it. + </para></listitem> </varlistentry> <varlistentry> - <term><command>terminate-session [ID...]</command></term> + <term><command>terminate-session</command> <replaceable>ID</replaceable>...</term> - <listitem><para>Terminates a - session. This kills all processes of - the session and deallocates all - resources attached to the - session.</para></listitem> + <listitem><para>Terminates a session. + This kills all processes of the + session and deallocates all resources + attached to the session. + </para></listitem> </varlistentry> <varlistentry> - <term><command>kill-session [ID...]</command></term> + <term><command>kill-session</command> <replaceable>ID</replaceable>...</term> <listitem><para>Send a signal to one or more processes of the session. Use @@ -295,7 +296,7 @@ </varlistentry> <varlistentry> - <term><command>user-status [USER...]</command></term> + <term><command>user-status</command> <replaceable>USER</replaceable>...</term> <listitem><para>Show terse runtime status information about one or more @@ -303,14 +304,14 @@ intended to generate human-readable output. If you are looking for computer-parsable output, use - <command>show-user</command> - instead. Users may be specified by - their usernames or numeric user - IDs.</para></listitem> + <command>show-user</command> instead. + Users may be specified by their + usernames or numeric user IDs. + </para></listitem> </varlistentry> <varlistentry> - <term><command>show-user [USER...]</command></term> + <term><command>show-user</command> <optional><replaceable>USER</replaceable>...</optional></term> <listitem><para>Show properties of one or more users or the manager @@ -333,13 +334,13 @@ </varlistentry> <varlistentry> - <term><command>enable-linger [USER...]</command></term> - <term><command>disable-linger [USER...]</command></term> + <term><command>enable-linger</command> <replaceable>USER</replaceable>...</term> + <term><command>disable-linger</command> <replaceable>USER</replaceable>...</term> <listitem><para>Enable/disable user lingering for one or more users. If enabled for a specific user, a user - manager is spawned for him/her at + manager is spawned for the user at boot and kept around after logouts. This allows users who are not logged in to run long-running @@ -347,18 +348,18 @@ </varlistentry> <varlistentry> - <term><command>terminate-user [USER...]</command></term> + <term><command>terminate-user</command> <replaceable>USER</replaceable>...</term> <listitem><para>Terminates all sessions of a user. This kills all processes of all sessions of the user and deallocates all runtime resources - attached to the - user.</para></listitem> + attached to the user. + </para></listitem> </varlistentry> <varlistentry> - <term><command>kill-user [USER...]</command></term> + <term><command>kill-user</command> <replaceable>USER</replaceable>...</term> <listitem><para>Send a signal to all processes of a user. Use @@ -375,7 +376,7 @@ </varlistentry> <varlistentry> - <term><command>seat-status [NAME...]</command></term> + <term><command>seat-status</command> <replaceable>NAME</replaceable>...</term> <listitem><para>Show terse runtime status information about one or more @@ -388,7 +389,7 @@ </varlistentry> <varlistentry> - <term><command>show-seat [NAME...]</command></term> + <term><command>show-seat</command> <replaceable>NAME</replaceable>...</term> <listitem><para>Show properties of one or more seats or the manager @@ -411,7 +412,7 @@ </varlistentry> <varlistentry> - <term><command>attach [NAME] [DEVICE...]</command></term> + <term><command>attach</command> <replaceable>NAME</replaceable> <replaceable>DEVICE</replaceable>...</term> <listitem><para>Persistently attach one or more devices to a seat. The @@ -444,12 +445,12 @@ </varlistentry> <varlistentry> - <term><command>terminate-seat [NAME...]</command></term> + <term><command>terminate-seat</command> <replaceable>NAME</replaceable>...</term> <listitem><para>Terminates all sessions on a seat. This kills all - processes of all sessions on a seat and - deallocates all runtime resources + processes of all sessions on the seat + and deallocates all runtime resources attached to them.</para></listitem> </varlistentry> </variablelist> diff --git a/man/machinectl.xml b/man/machinectl.xml index ec2aaa56d..6e991ee95 100644 --- a/man/machinectl.xml +++ b/man/machinectl.xml @@ -202,7 +202,7 @@ </varlistentry> <varlistentry> - <term><command>status [ID...]</command></term> + <term><command>status</command> <replaceable>ID</replaceable>...</term> <listitem><para>Show terse runtime status information about one or more @@ -215,7 +215,7 @@ </varlistentry> <varlistentry> - <term><command>show [ID...]</command></term> + <term><command>show</command> <replaceable>ID</replaceable>...</term> <listitem><para>Show properties of one or more registered virtual machines or @@ -239,7 +239,7 @@ </varlistentry> <varlistentry> - <term><command>terminate [ID...]</command></term> + <term><command>terminate</command> <replaceable>ID</replaceable>...</term> <listitem><para>Terminates a virtual machine or container. This kills all @@ -250,7 +250,7 @@ </varlistentry> <varlistentry> - <term><command>kill [ID...]</command></term> + <term><command>kill</command> <replaceable>ID</replaceable>...</term> <listitem><para>Send a signal to one or more processes of the virtual @@ -265,7 +265,7 @@ </varlistentry> <varlistentry> - <term><command>login [ID]</command></term> + <term><command>login</command> <replaceable>ID</replaceable>...</term> <listitem><para>Open a terminal login session to a container. This will diff --git a/man/systemctl.xml b/man/systemctl.xml index ce2860259..9cd6e8898 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -526,7 +526,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <variablelist> <varlistentry> - <term><command>list-units <optional><replaceable>PATTERN...</replaceable></optional></command></term> + <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term> <listitem> <para>List known units (subject to limitations specified @@ -539,7 +539,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. </varlistentry> <varlistentry> - <term><command>list-sockets <optional><replaceable>PATTERN...</replaceable></optional></command></term> + <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term> <listitem> <para>List socket units ordered by the listening address. @@ -565,7 +565,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service </varlistentry> <varlistentry> - <term><command>list-timers <optional><replaceable>PATTERN...</replaceable></optional></command></term> + <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term> <listitem> <para>List timer units ordered by the time they elapse @@ -708,7 +708,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service </listitem> </varlistentry> <varlistentry> - <term><command>status [<replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...]</command></term> + <term><command>status</command> <optional><replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...]</optional></term> <listitem> <para>Show terse runtime status information about one or @@ -724,7 +724,7 @@ kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service </listitem> </varlistentry> <varlistentry> - <term><command>show [<replaceable>NAME</replaceable>...|<replaceable>JOB</replaceable>...]</command></term> + <term><command>show</command> <optional><replaceable>NAME</replaceable>...|<replaceable>JOB</replaceable>...</optional></term> <listitem> <para>Show properties of one or more units, jobs, or the |