1
0
mirror of https://github.com/systemd/systemd synced 2024-07-09 04:26:06 +00:00

man/loginctl: document "self" and "auto" special session IDs

session-status automatically uses "auto" if no ID is specified,
but show-session shows the manager's properties. Let's document
these special values so that users of show-session can benefit too.
This commit is contained in:
Mike Yuan 2024-01-04 19:08:38 +08:00
parent 771240fa3d
commit 5317451f12
No known key found for this signature in database
GPG Key ID: 417471C0A40F58B3

View File

@ -71,16 +71,15 @@
<varlistentry>
<term><command>show-session</command> <optional><replaceable>ID</replaceable></optional></term>
<listitem><para>Show properties of one or more sessions or the
manager itself. If no argument is specified, properties of the
manager will be shown. If a session ID is specified,
properties of the session are shown. By default, empty
properties are suppressed. Use <option>--all</option> to show
those too. To select specific properties to show, use
<option>--property=</option>. This command is intended to be
used whenever computer-parsable output is required. Use
<command>session-status</command> if you are looking for
formatted human-readable output.</para>
<listitem><para>Show properties of one or more sessions or the manager itself. If no argument is
specified, properties of the manager will be shown. If a session ID is specified, properties of
the session are shown. Specially, if the given ID is <literal>self</literal>, the session to which
the <command>loginctl</command> process belongs is used. If <literal>auto</literal>, the current
session is used as with <literal>self</literal> if exists, and falls back to the current user's
graphical session. By default, empty properties are suppressed. Use <option>--all</option> to show
those too. To select specific properties to show, use <option>--property=</option>. This command
is intended to be used whenever computer-parsable output is required. Use <command>session-status</command>
if you are looking for formatted human-readable output.</para>
<xi:include href="version-info.xml" xpointer="v233"/></listitem>
</varlistentry>