<?xml version='1.0'?> <!--*-nxml-*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<!--
- This file is part of systemd.
-
- Copyright 2010 Lennart Poettering
-
- systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU Lesser General Public License as published by
- the Free Software Foundation; either version 2.1 of the License, or
- (at your option) any later version.
-
- systemd is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with systemd; If not, see <http://www.gnu.org/licenses/>.
--->
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
<refentry id="loginctl" conditional='ENABLE_LOGIND'
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>loginctl</title>
<productname>systemd</productname>
-
- <authorgroup>
- <author>
- <contrib>Developer</contrib>
- <firstname>Lennart</firstname>
- <surname>Poettering</surname>
- <email>lennart@poettering.net</email>
- </author>
- </authorgroup>
</refentryinfo>
<refmeta>
shown.</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--value</option></term>
+
+ <listitem><para>When showing session/user/seat properties,
+ only print the value, and skip the property name and
+ <literal>=</literal>.</para></listitem>
+ </varlistentry>
+
<varlistentry>
<term><option>-a</option></term>
<term><option>--all</option></term>
</varlistentry>
<varlistentry>
- <term><command>session-status</command> <optional><replaceable>ID</replaceable>...</optional></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
</varlistentry>
<varlistentry>
- <term><command>show-session</command> <optional><replaceable>ID</replaceable>...</optional></term>
+ <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
</varlistentry>
<varlistentry>
- <term><command>lock-session</command> <optional><replaceable>ID</replaceable>...</optional></term>
- <term><command>unlock-session</command> <optional><replaceable>ID</replaceable>...</optional></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. Takes one or
</varlistentry>
<varlistentry>
- <term><command>terminate-session</command> <replaceable>ID</replaceable>...</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
</varlistentry>
<varlistentry>
- <term><command>kill-session</command> <replaceable>ID</replaceable>...</term>
+ <term><command>kill-session</command> <replaceable>ID</replaceable>…</term>
<listitem><para>Send a signal to one or more processes of the
session. Use <option>--kill-who=</option> to select which
</varlistentry>
<varlistentry>
- <term><command>user-status</command> <optional><replaceable>USER</replaceable>...</optional></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. 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, use <command>show-user</command>
- instead. Users may be specified by their usernames or numeric
- user IDs. </para></listitem>
+ is shown for the user of the session of the caller. This
+ function is intended to generate human-readable output. If you
+ are looking for computer-parsable output, use
+ <command>show-user</command> instead.</para></listitem>
</varlistentry>
<varlistentry>
- <term><command>show-user</command> <optional><replaceable>USER</replaceable>...</optional></term>
+ <term><command>show-user</command> <optional><replaceable>USER</replaceable>…</optional></term>
<listitem><para>Show properties of one or more users or the
manager itself. If no argument is specified, properties of the
</varlistentry>
<varlistentry>
- <term><command>enable-linger</command> <optional><replaceable>USER</replaceable>...</optional></term>
- <term><command>disable-linger</command> <optional><replaceable>USER</replaceable>...</optional></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 enabled for a specific user, a user manager is
This allows users who are not logged in to run long-running
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.
+ lingering for the user of the session of the caller.</para>
+
+ <para>See also <varname>KillUserProcesses=</varname> setting in
+ <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para></listitem>
</varlistentry>
<varlistentry>
- <term><command>terminate-user</command> <replaceable>USER</replaceable>...</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
</varlistentry>
<varlistentry>
- <term><command>kill-user</command> <replaceable>USER</replaceable>...</term>
+ <term><command>kill-user</command> <replaceable>USER</replaceable>…</term>
<listitem><para>Send a signal to all processes of a user. Use
<option>--signal=</option> to select the signal to send.
</varlistentry>
<varlistentry>
- <term><command>seat-status</command> <optional><replaceable>NAME</replaceable>...</optional></term>
+ <term><command>seat-status</command> <optional><replaceable>NAME</replaceable>…</optional></term>
<listitem><para>Show terse runtime status information about
one or more seats. Takes one or more seat names as parameters.
</varlistentry>
<varlistentry>
- <term><command>show-seat</command> <optional><replaceable>NAME</replaceable>...</optional></term>
+ <term><command>show-seat</command> <optional><replaceable>NAME</replaceable>…</optional></term>
<listitem><para>Show properties of one or more seats or the
manager itself. If no argument is specified, properties of the
</varlistentry>
<varlistentry>
- <term><command>attach</command> <replaceable>NAME</replaceable> <replaceable>DEVICE</replaceable>...</term>
+ <term><command>attach</command> <replaceable>NAME</replaceable> <replaceable>DEVICE</replaceable>…</term>
<listitem><para>Persistently attach one or more devices to a
seat. The devices should be specified via device paths in the
</varlistentry>
<varlistentry>
- <term><command>terminate-seat</command> <replaceable>NAME</replaceable>...</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 the seat and deallocates all
otherwise.</para>
</refsect1>
+ <refsect1>
+ <title>Examples</title>
+
+ <example>
+ <title>Querying user status</title>
+
+ <programlisting>$ loginctl user-status
+fatima (1005)
+ Since: Sat 2016-04-09 14:23:31 EDT; 54min ago
+ State: active
+ Sessions: 5 *3
+ Unit: user-1005.slice
+ ├─user@1005.service
+ …
+ ├─session-3.scope
+ …
+ └─session-5.scope
+ ├─3473 login -- fatima
+ └─3515 -zsh
+
+Apr 09 14:40:30 laptop login[2325]: pam_unix(login:session):
+ session opened for user fatima by LOGIN(uid=0)
+Apr 09 14:40:30 laptop login[2325]: LOGIN ON tty3 BY fatima
+</programlisting>
+
+ <para>There are two sessions, 3 and 5. Session 3 is a graphical session,
+ marked with a star. The tree of processing including the two corresponding
+ scope units and the user manager unit are shown.</para>
+ </example>
+ </refsect1>
+
<xi:include href="less-variables.xml" />
<refsect1>
projects / thirdparty / systemd.git / blobdiff