1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
8 This file is part of systemd.
10 Copyright 2010 Lennart Poettering
13 <refentry id=
"loginctl" conditional='ENABLE_LOGIND'
14 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
17 <title>loginctl
</title>
18 <productname>systemd
</productname>
22 <contrib>Developer
</contrib>
23 <firstname>Lennart
</firstname>
24 <surname>Poettering
</surname>
25 <email>lennart@poettering.net
</email>
31 <refentrytitle>loginctl
</refentrytitle>
32 <manvolnum>1</manvolnum>
36 <refname>loginctl
</refname>
37 <refpurpose>Control the systemd login manager
</refpurpose>
42 <command>loginctl
</command>
43 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
44 <arg choice=
"req">COMMAND
</arg>
45 <arg choice=
"opt" rep=
"repeat">NAME
</arg>
50 <title>Description
</title>
52 <para><command>loginctl
</command> may be used to introspect and
53 control the state of the
54 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
56 <citerefentry><refentrytitle>systemd-logind.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
60 <title>Options
</title>
62 <para>The following options are understood:
</para>
66 <term><option>--no-ask-password
</option></term>
68 <listitem><para>Do not query the user for authentication for
69 privileged operations.
</para></listitem>
73 <term><option>-p
</option></term>
74 <term><option>--property=
</option></term>
76 <listitem><para>When showing session/user/seat properties,
77 limit display to certain properties as specified as argument.
78 If not specified, all set properties are shown. The argument
79 should be a property name, such as
80 <literal>Sessions
</literal>. If specified more than once, all
81 properties with the specified names are
82 shown.
</para></listitem>
86 <term><option>--value
</option></term>
88 <listitem><para>When showing session/user/seat properties,
89 only print the value, and skip the property name and
90 <literal>=
</literal>.
</para></listitem>
94 <term><option>-a
</option></term>
95 <term><option>--all
</option></term>
97 <listitem><para>When showing session/user/seat properties,
98 show all properties regardless of whether they are set or
99 not.
</para></listitem>
103 <term><option>-l
</option></term>
104 <term><option>--full
</option></term>
106 <listitem><para>Do not ellipsize process tree entries.
</para>
111 <term><option>--kill-who=
</option></term>
113 <listitem><para>When used with
114 <command>kill-session
</command>, choose which processes to
115 kill. Must be one of
<option>leader
</option>, or
116 <option>all
</option> to select whether to kill only the leader
117 process of the session or all processes of the session. If
118 omitted, defaults to
<option>all
</option>.
</para></listitem>
122 <term><option>-s
</option></term>
123 <term><option>--signal=
</option></term>
125 <listitem><para>When used with
<command>kill-session
</command>
126 or
<command>kill-user
</command>, choose which signal to send
127 to selected processes. Must be one of the well known signal
128 specifiers, such as
<constant>SIGTERM
</constant>,
129 <constant>SIGINT
</constant> or
<constant>SIGSTOP
</constant>.
130 If omitted, defaults to
131 <constant>SIGTERM
</constant>.
</para></listitem>
135 <term><option>-n
</option></term>
136 <term><option>--lines=
</option></term>
138 <listitem><para>When used with
<command>user-status
</command>
139 and
<command>session-status
</command>, controls the number of
140 journal lines to show, counting from the most recent ones.
141 Takes a positive integer argument. Defaults to
10.
</para>
146 <term><option>-o
</option></term>
147 <term><option>--output=
</option></term>
149 <listitem><para>When used with
<command>user-status
</command>
150 and
<command>session-status
</command>, controls the formatting
151 of the journal entries that are shown. For the available
153 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
154 Defaults to
<literal>short
</literal>.
</para></listitem>
157 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
158 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
160 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
161 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
162 <xi:include href=
"standard-options.xml" xpointer=
"help" />
163 <xi:include href=
"standard-options.xml" xpointer=
"version" />
168 <title>Commands
</title>
170 <para>The following commands are understood:
</para>
172 <refsect2><title>Session Commands
</title><variablelist>
175 <term><command>list-sessions
</command></term>
177 <listitem><para>List current sessions.
</para></listitem>
181 <term><command>session-status
</command> <optional><replaceable>ID
</replaceable>…
</optional></term>
183 <listitem><para>Show terse runtime status information about
184 one or more sessions, followed by the most recent log data
185 from the journal. Takes one or more session identifiers as
186 parameters. If no session identifiers are passed, the status of
187 the caller's session is shown. This function is intended to
188 generate human-readable output. If you are looking for
189 computer-parsable output, use
<command>show-session
</command>
190 instead.
</para></listitem>
194 <term><command>show-session
</command> <optional><replaceable>ID
</replaceable>…
</optional></term>
196 <listitem><para>Show properties of one or more sessions or the
197 manager itself. If no argument is specified, properties of the
198 manager will be shown. If a session ID is specified,
199 properties of the session are shown. By default, empty
200 properties are suppressed. Use
<option>--all
</option> to show
201 those too. To select specific properties to show, use
202 <option>--property=
</option>. This command is intended to be
203 used whenever computer-parsable output is required. Use
204 <command>session-status
</command> if you are looking for
205 formatted human-readable output.
</para></listitem>
209 <term><command>activate
</command> <optional><replaceable>ID
</replaceable></optional></term>
211 <listitem><para>Activate a session. This brings a session into
212 the foreground if another session is currently in the
213 foreground on the respective seat. Takes a session identifier
214 as argument. If no argument is specified, the session of the
215 caller is put into foreground.
</para></listitem>
219 <term><command>lock-session
</command> <optional><replaceable>ID
</replaceable>…
</optional></term>
220 <term><command>unlock-session
</command> <optional><replaceable>ID
</replaceable>…
</optional></term>
222 <listitem><para>Activates/deactivates the screen lock on one
223 or more sessions, if the session supports it. Takes one or
224 more session identifiers as arguments. If no argument is
225 specified, the session of the caller is locked/unlocked.
230 <term><command>lock-sessions
</command></term>
231 <term><command>unlock-sessions
</command></term>
233 <listitem><para>Activates/deactivates the screen lock on all
234 current sessions supporting it.
</para></listitem>
238 <term><command>terminate-session
</command> <replaceable>ID
</replaceable>…
</term>
240 <listitem><para>Terminates a session. This kills all processes
241 of the session and deallocates all resources attached to the
242 session.
</para></listitem>
246 <term><command>kill-session
</command> <replaceable>ID
</replaceable>…
</term>
248 <listitem><para>Send a signal to one or more processes of the
249 session. Use
<option>--kill-who=
</option> to select which
250 process to kill. Use
<option>--signal=
</option> to select the
251 signal to send.
</para></listitem>
253 </variablelist></refsect2>
255 <refsect2><title>User Commands
</title><variablelist>
257 <term><command>list-users
</command></term>
259 <listitem><para>List currently logged in users.
264 <term><command>user-status
</command> <optional><replaceable>USER
</replaceable>…
</optional></term>
266 <listitem><para>Show terse runtime status information about
267 one or more logged in users, followed by the most recent log
268 data from the journal. Takes one or more user names or numeric
269 user IDs as parameters. If no parameters are passed, the status
270 is shown for the user of the session of the caller. This
271 function is intended to generate human-readable output. If you
272 are looking for computer-parsable output, use
273 <command>show-user
</command> instead.
</para></listitem>
277 <term><command>show-user
</command> <optional><replaceable>USER
</replaceable>…
</optional></term>
279 <listitem><para>Show properties of one or more users or the
280 manager itself. If no argument is specified, properties of the
281 manager will be shown. If a user is specified, properties of
282 the user are shown. By default, empty properties are
283 suppressed. Use
<option>--all
</option> to show those too. To
284 select specific properties to show, use
285 <option>--property=
</option>. This command is intended to be
286 used whenever computer-parsable output is required. Use
287 <command>user-status
</command> if you are looking for
288 formatted human-readable output.
</para></listitem>
292 <term><command>enable-linger
</command> <optional><replaceable>USER
</replaceable>…
</optional></term>
293 <term><command>disable-linger
</command> <optional><replaceable>USER
</replaceable>…
</optional></term>
295 <listitem><para>Enable/disable user lingering for one or more
296 users. If enabled for a specific user, a user manager is
297 spawned for the user at boot and kept around after logouts.
298 This allows users who are not logged in to run long-running
299 services. Takes one or more user names or numeric UIDs as
300 argument. If no argument is specified, enables/disables
301 lingering for the user of the session of the caller.
</para>
303 <para>See also
<varname>KillUserProcesses=
</varname> setting in
304 <citerefentry><refentrytitle>logind.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
309 <term><command>terminate-user
</command> <replaceable>USER
</replaceable>…
</term>
311 <listitem><para>Terminates all sessions of a user. This kills
312 all processes of all sessions of the user and deallocates all
313 runtime resources attached to the user.
</para></listitem>
317 <term><command>kill-user
</command> <replaceable>USER
</replaceable>…
</term>
319 <listitem><para>Send a signal to all processes of a user. Use
320 <option>--signal=
</option> to select the signal to send.
323 </variablelist></refsect2>
325 <refsect2><title>Seat Commands
</title><variablelist>
327 <term><command>list-seats
</command></term>
329 <listitem><para>List currently available seats on the local
330 system.
</para></listitem>
334 <term><command>seat-status
</command> <optional><replaceable>NAME
</replaceable>…
</optional></term>
336 <listitem><para>Show terse runtime status information about
337 one or more seats. Takes one or more seat names as parameters.
338 If no seat names are passed the status of the caller's
339 session's seat is shown. This function is intended to generate
340 human-readable output. If you are looking for
341 computer-parsable output, use
<command>show-seat
</command>
342 instead.
</para></listitem>
346 <term><command>show-seat
</command> <optional><replaceable>NAME
</replaceable>…
</optional></term>
348 <listitem><para>Show properties of one or more seats or the
349 manager itself. If no argument is specified, properties of the
350 manager will be shown. If a seat is specified, properties of
351 the seat are shown. By default, empty properties are
352 suppressed. Use
<option>--all
</option> to show those too. To
353 select specific properties to show, use
354 <option>--property=
</option>. This command is intended to be
355 used whenever computer-parsable output is required. Use
356 <command>seat-status
</command> if you are looking for
357 formatted human-readable output.
</para></listitem>
361 <term><command>attach
</command> <replaceable>NAME
</replaceable> <replaceable>DEVICE
</replaceable>…
</term>
363 <listitem><para>Persistently attach one or more devices to a
364 seat. The devices should be specified via device paths in the
365 <filename>/sys
</filename> file system. To create a new seat,
366 attach at least one graphics card to a previously unused seat
367 name. Seat names may consist only of a–z, A–Z,
0–
9,
368 <literal>-
</literal> and
<literal>_
</literal> and must be
369 prefixed with
<literal>seat
</literal>. To drop assignment of a
370 device to a specific seat, just reassign it to a different
371 seat, or use
<command>flush-devices
</command>.
376 <term><command>flush-devices
</command></term>
378 <listitem><para>Removes all device assignments previously
379 created with
<command>attach
</command>. After this call, only
380 automatically generated seats will remain, and all seat
381 hardware is assigned to them.
</para></listitem>
385 <term><command>terminate-seat
</command> <replaceable>NAME
</replaceable>…
</term>
387 <listitem><para>Terminates all sessions on a seat. This kills
388 all processes of all sessions on the seat and deallocates all
389 runtime resources attached to them.
</para></listitem>
391 </variablelist></refsect2>
396 <title>Exit status
</title>
398 <para>On success,
0 is returned, a non-zero failure code
403 <title>Examples
</title>
406 <title>Querying user status
</title>
408 <programlisting>$ loginctl user-status
410 Since: Sat
2016-
04-
09 14:
23:
31 EDT;
54min ago
413 Unit: user-
1005.slice
419 ├─
3473 login -- fatima
422 Apr
09 14:
40:
30 laptop login[
2325]: pam_unix(login:session):
423 session opened for user fatima by LOGIN(uid=
0)
424 Apr
09 14:
40:
30 laptop login[
2325]: LOGIN ON tty3 BY fatima
427 <para>There are two sessions,
3 and
5. Session
3 is a graphical session,
428 marked with a star. The tree of processing including the two corresponding
429 scope units and the user manager unit are shown.
</para>
433 <xi:include href=
"less-variables.xml" />
436 <title>See Also
</title>
438 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
439 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
440 <citerefentry><refentrytitle>systemd-logind.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
441 <citerefentry><refentrytitle>logind.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>