<para>The following options are understood:</para>
<variablelist>
- <varlistentry>
- <term><option>--no-legend</option></term>
-
- <listitem>
- <para>Do not print the legend,
- i.e. the column headers and
- the footer.</para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term><option>--no-ask-password</option></term>
<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="no-pager" />
+ <xi:include href="standard-options.xml" xpointer="no-legend" />
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
- <xi:include href="standard-options.xml" xpointer="no-pager" />
</variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>Commands</title>
<para>The following commands are understood:</para>
- <variablelist>
+ <refsect2><title>Session Commands</title><variablelist>
+
<varlistentry>
<term><command>list-sessions</command></term>
</varlistentry>
<varlistentry>
- <term><command>session-status</command> <replaceable>ID</replaceable>...</term>
+ <term><command>session-status</command> <optional><replaceable>ID</replaceable>...</optional></term>
<listitem><para>Show terse runtime
status information about one or more
sessions, followed by the most recent
- log data from the journal. This
- function is intended to generate
- human-readable output. If you are
- looking for computer-parsable output,
- use <command>show-session</command>
+ log data from the journal. Takes one
+ or more session identifiers as
+ parameters. If no session identifiers
+ are passed the status of the caller's
+ session is shown. This function is
+ intended to generate human-readable
+ output. If you are looking for
+ computer-parsable output, use
+ <command>show-session</command>
instead.</para></listitem>
</varlistentry>
</varlistentry>
<varlistentry>
- <term><command>activate</command> <replaceable>ID</replaceable>...</term>
-
- <listitem><para>Activate one or more
- sessions. This brings one or more
- sessions into the foreground, if
- another session is currently in the
- foreground on the respective
- seat.</para></listitem>
+ <term><command>activate</command> <optional><replaceable>ID</replaceable></optional></term>
+
+ <listitem><para>Activate a
+ session. This brings a session into
+ the foreground, if another session is
+ currently in the foreground on the
+ respective seat. Takes a session
+ identifier as argument. If no argument
+ is specified the session of the caller
+ is put into
+ foreground.</para></listitem>
</varlistentry>
<varlistentry>
- <term><command>lock-session</command> <replaceable>ID</replaceable>...</term>
- <term><command>unlock-session</command> <replaceable>ID</replaceable>...</term>
+ <term><command>lock-session</command> <optional><replaceable>ID</replaceable>...</optional></term>
+ <term><command>unlock-session</command> <optional><replaceable>ID</replaceable>...</optional></term>
<listitem><para>Activates/deactivates
the screen lock on one or more
- sessions, if the session supports it.
+ sessions, if the session supports
+ it. Takes one or more session
+ identifiers as arguments. If no
+ argument is specified the session of
+ the caller is locked/unlocked.
</para></listitem>
</varlistentry>
<option>--signal=</option> to select
the signal to send.</para></listitem>
</varlistentry>
+ </variablelist></refsect2>
+ <refsect2><title>User Commands</title><variablelist>
<varlistentry>
<term><command>list-users</command></term>
</varlistentry>
<varlistentry>
- <term><command>user-status</command> <replaceable>USER</replaceable>...</term>
+ <term><command>user-status</command> <optional><replaceable>USER</replaceable>...</optional></term>
<listitem><para>Show terse runtime
status information about one or more
logged in users, followed by the most
- recent log data from the journal. This
+ recent log data from the
+ journal. Takes one or more user names
+ or numeric user IDs as parameters. If
+ no parameters are passed the status of
+ the caller's user is shown. This
function is intended to generate
human-readable output. If you are
looking for computer-parsable output,
</varlistentry>
<varlistentry>
- <term><command>enable-linger</command> <replaceable>USER</replaceable>...</term>
- <term><command>disable-linger</command> <replaceable>USER</replaceable>...</term>
+ <term><command>enable-linger</command> <optional><replaceable>USER</replaceable>...</optional></term>
+ <term><command>disable-linger</command> <optional><replaceable>USER</replaceable>...</optional></term>
<listitem><para>Enable/disable user
lingering for one or more users. If
boot and kept around after
logouts. This allows users who are not
logged in to run long-running
- services.</para></listitem>
+ services. Takes one or more user names
+ or numeric UIDs as argument. If no
+ argument is specified enables/disables
+ lingering for the user of the session
+ of the caller.</para></listitem>
</varlistentry>
<varlistentry>
<option>--signal=</option> to select
the signal to send.</para></listitem>
</varlistentry>
+ </variablelist></refsect2>
+ <refsect2><title>Seat Commands</title><variablelist>
<varlistentry>
<term><command>list-seats</command></term>
</varlistentry>
<varlistentry>
- <term><command>seat-status</command> <replaceable>NAME</replaceable>...</term>
+ <term><command>seat-status</command> <optional><replaceable>NAME</replaceable>...</optional></term>
<listitem><para>Show terse runtime
status information about one or more
- seats. This function is
- intended to generate human-readable
+ seats. Takes one or more seat names as
+ parameters. If no seat names are
+ passed the status of the caller's
+ session's seat is shown. This function
+ is intended to generate human-readable
output. If you are looking for
computer-parsable output, use
<command>show-seat</command>
</varlistentry>
<varlistentry>
- <term><command>show-seat</command> <replaceable>NAME</replaceable>...</term>
+ <term><command>show-seat</command> <optional><replaceable>NAME</replaceable>...</optional></term>
<listitem><para>Show properties of one
or more seats or the manager
and deallocates all runtime resources
attached to them.</para></listitem>
</varlistentry>
- </variablelist>
+ </variablelist></refsect2>
</refsect1>