]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man/loginctl: document "self" and "auto" special session IDs 30736/head
authorMike Yuan <me@yhndnzj.com>
Thu, 4 Jan 2024 11:08:38 +0000 (19:08 +0800)
committerMike Yuan <me@yhndnzj.com>
Thu, 4 Jan 2024 11:26:47 +0000 (19:26 +0800)
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.

man/loginctl.xml

index 46113531b052e8cb203ccfa2e2b2b3df2e61a3c6..8a093c6e2982d71dd4d474973242904a8adeced6 100644 (file)
       <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>