1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
6 <refentry id=
"loginctl" conditional='ENABLE_LOGIND'
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>loginctl
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>loginctl
</refentrytitle>
16 <manvolnum>1</manvolnum>
20 <refname>loginctl
</refname>
21 <refpurpose>Control the systemd login manager
</refpurpose>
26 <command>loginctl
</command>
27 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
28 <arg choice=
"req">COMMAND
</arg>
29 <arg choice=
"opt" rep=
"repeat">NAME
</arg>
34 <title>Description
</title>
36 <para><command>loginctl
</command> may be used to introspect and
37 control the state of the
38 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
40 <citerefentry><refentrytitle>systemd-logind.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
44 <title>Commands
</title>
46 <para>The following commands are understood:
</para>
48 <refsect2><title>Session Commands
</title><variablelist>
51 <term><command>list-sessions
</command></term>
53 <listitem><para>List current sessions.
</para></listitem>
57 <term><command>session-status
</command> <optional><replaceable>ID
</replaceable>…
</optional></term>
59 <listitem><para>Show terse runtime status information about
60 one or more sessions, followed by the most recent log data
61 from the journal. Takes one or more session identifiers as
62 parameters. If no session identifiers are passed, the status of
63 the caller's session is shown. This function is intended to
64 generate human-readable output. If you are looking for
65 computer-parsable output, use
<command>show-session
</command>
68 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
72 <term><command>show-session
</command> <optional><replaceable>ID
</replaceable>…
</optional></term>
74 <listitem><para>Show properties of one or more sessions or the
75 manager itself. If no argument is specified, properties of the
76 manager will be shown. If a session ID is specified,
77 properties of the session are shown. By default, empty
78 properties are suppressed. Use
<option>--all
</option> to show
79 those too. To select specific properties to show, use
80 <option>--property=
</option>. This command is intended to be
81 used whenever computer-parsable output is required. Use
82 <command>session-status
</command> if you are looking for
83 formatted human-readable output.
</para>
85 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
89 <term><command>activate
</command> <optional><replaceable>ID
</replaceable></optional></term>
91 <listitem><para>Activate a session. This brings a session into
92 the foreground if another session is currently in the
93 foreground on the respective seat. Takes a session identifier
94 as argument. If no argument is specified, the session of the
95 caller is put into foreground.
</para>
97 <xi:include href=
"version-info.xml" xpointer=
"v219"/></listitem>
101 <term><command>lock-session
</command> <optional><replaceable>ID
</replaceable>…
</optional></term>
102 <term><command>unlock-session
</command> <optional><replaceable>ID
</replaceable>…
</optional></term>
104 <listitem><para>Activates/deactivates the screen lock on one
105 or more sessions, if the session supports it. Takes one or
106 more session identifiers as arguments. If no argument is
107 specified, the session of the caller is locked/unlocked.
110 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
114 <term><command>lock-sessions
</command></term>
115 <term><command>unlock-sessions
</command></term>
117 <listitem><para>Activates/deactivates the screen lock on all
118 current sessions supporting it.
</para>
120 <xi:include href=
"version-info.xml" xpointer=
"v188"/></listitem>
124 <term><command>terminate-session
</command> <replaceable>ID
</replaceable>…
</term>
126 <listitem><para>Terminates a session. This kills all processes of the session and deallocates all
127 resources attached to the session. If the argument is specified as empty string the session invoking
128 the command is terminated.
</para>
130 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
134 <term><command>kill-session
</command> <replaceable>ID
</replaceable>…
</term>
136 <listitem><para>Send a signal to one or more processes of the session. Use
137 <option>--kill-whom=
</option> to select which process to kill. Use
<option>--signal=
</option> to
138 select the signal to send. If the argument is specified as empty string the signal is sent to the
139 session invoking the command.
</para>
141 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
143 </variablelist></refsect2>
145 <refsect2><title>User Commands
</title><variablelist>
147 <term><command>list-users
</command></term>
149 <listitem><para>List currently logged in users.
154 <term><command>user-status
</command> <optional><replaceable>USER
</replaceable>…
</optional></term>
156 <listitem><para>Show terse runtime status information about
157 one or more logged in users, followed by the most recent log
158 data from the journal. Takes one or more user names or numeric
159 user IDs as parameters. If no parameters are passed, the status
160 is shown for the user of the session of the caller. This
161 function is intended to generate human-readable output. If you
162 are looking for computer-parsable output, use
163 <command>show-user
</command> instead.
</para>
165 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
169 <term><command>show-user
</command> <optional><replaceable>USER
</replaceable>…
</optional></term>
171 <listitem><para>Show properties of one or more users or the
172 manager itself. If no argument is specified, properties of the
173 manager will be shown. If a user is specified, properties of
174 the user are shown. By default, empty properties are
175 suppressed. Use
<option>--all
</option> to show those too. To
176 select specific properties to show, use
177 <option>--property=
</option>. This command is intended to be
178 used whenever computer-parsable output is required. Use
179 <command>user-status
</command> if you are looking for
180 formatted human-readable output.
</para>
182 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
186 <term><command>enable-linger
</command> <optional><replaceable>USER
</replaceable>…
</optional></term>
187 <term><command>disable-linger
</command> <optional><replaceable>USER
</replaceable>…
</optional></term>
189 <listitem><para>Enable/disable user lingering for one or more
190 users. If enabled for a specific user, a user manager is
191 spawned for the user at boot and kept around after logouts.
192 This allows users who are not logged in to run long-running
193 services. Takes one or more user names or numeric UIDs as
194 argument. If no argument is specified, enables/disables
195 lingering for the user of the session of the caller.
</para>
197 <para>See also
<varname>KillUserProcesses=
</varname> setting in
198 <citerefentry><refentrytitle>logind.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
201 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
205 <term><command>terminate-user
</command> <replaceable>USER
</replaceable>…
</term>
207 <listitem><para>Terminates all sessions of a user. This kills all processes of all sessions of the
208 user and deallocates all runtime resources attached to the user. If the argument is specified as
209 empty string the sessions of the user invoking the command are terminated.
</para>
211 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
215 <term><command>kill-user
</command> <replaceable>USER
</replaceable>…
</term>
217 <listitem><para>Send a signal to all processes of a user. Use
<option>--signal=
</option> to select
218 the signal to send. If the argument is specified as empty string the signal is sent to the sessions
219 of the user invoking the command.
</para>
221 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
223 </variablelist></refsect2>
225 <refsect2><title>Seat Commands
</title><variablelist>
227 <term><command>list-seats
</command></term>
229 <listitem><para>List currently available seats on the local
230 system.
</para></listitem>
234 <term><command>seat-status
</command> <optional><replaceable>NAME
</replaceable>…
</optional></term>
236 <listitem><para>Show terse runtime status information about
237 one or more seats. Takes one or more seat names as parameters.
238 If no seat names are passed the status of the caller's
239 session's seat is shown. This function is intended to generate
240 human-readable output. If you are looking for
241 computer-parsable output, use
<command>show-seat
</command>
244 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
248 <term><command>show-seat
</command> <optional><replaceable>NAME
</replaceable>…
</optional></term>
250 <listitem><para>Show properties of one or more seats or the
251 manager itself. If no argument is specified, properties of the
252 manager will be shown. If a seat is specified, properties of
253 the seat are shown. By default, empty properties are
254 suppressed. Use
<option>--all
</option> to show those too. To
255 select specific properties to show, use
256 <option>--property=
</option>. This command is intended to be
257 used whenever computer-parsable output is required. Use
258 <command>seat-status
</command> if you are looking for
259 formatted human-readable output.
</para>
261 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
265 <term><command>attach
</command> <replaceable>NAME
</replaceable> <replaceable>DEVICE
</replaceable>…
</term>
267 <listitem><para>Persistently attach one or more devices to a
268 seat. The devices should be specified via device paths in the
269 <filename>/sys/
</filename> file system. To create a new seat,
270 attach at least one graphics card to a previously unused seat
271 name. Seat names may consist only of a–z, A–Z,
0–
9,
272 <literal>-
</literal> and
<literal>_
</literal> and must be
273 prefixed with
<literal>seat
</literal>. To drop assignment of a
274 device to a specific seat, just reassign it to a different
275 seat, or use
<command>flush-devices
</command>.
278 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
282 <term><command>flush-devices
</command></term>
284 <listitem><para>Removes all device assignments previously
285 created with
<command>attach
</command>. After this call, only
286 automatically generated seats will remain, and all seat
287 hardware is assigned to them.
</para></listitem>
291 <term><command>terminate-seat
</command> <replaceable>NAME
</replaceable>…
</term>
293 <listitem><para>Terminates all sessions on a seat. This kills
294 all processes of all sessions on the seat and deallocates all
295 runtime resources attached to them.
</para>
297 <xi:include href=
"version-info.xml" xpointer=
"v233"/></listitem>
299 </variablelist></refsect2>
304 <title>Options
</title>
306 <para>The following options are understood:
</para>
310 <term><option>--no-ask-password
</option></term>
312 <listitem><para>Do not query the user for authentication for
313 privileged operations.
</para></listitem>
317 <term><option>-p
</option></term>
318 <term><option>--property=
</option></term>
320 <listitem><para>When showing session/user/seat properties,
321 limit display to certain properties as specified as argument.
322 If not specified, all set properties are shown. The argument
323 should be a property name, such as
324 <literal>Sessions
</literal>. If specified more than once, all
325 properties with the specified names are
326 shown.
</para></listitem>
330 <term><option>--value
</option></term>
332 <listitem><para>When showing session/user/seat properties,
333 only print the value, and skip the property name and
334 <literal>=
</literal>.
</para>
336 <xi:include href=
"version-info.xml" xpointer=
"v230"/></listitem>
340 <term><option>-a
</option></term>
341 <term><option>--all
</option></term>
343 <listitem><para>When showing session/user/seat properties,
344 show all properties regardless of whether they are set or
345 not.
</para></listitem>
349 <term><option>-l
</option></term>
350 <term><option>--full
</option></term>
352 <listitem><para>Do not ellipsize process tree entries.
</para>
354 <xi:include href=
"version-info.xml" xpointer=
"v198"/>
359 <term><option>--kill-whom=
</option></term>
361 <listitem><para>When used with
362 <command>kill-session
</command>, choose which processes to
363 kill. Must be one of
<option>leader
</option>, or
364 <option>all
</option> to select whether to kill only the leader
365 process of the session or all processes of the session. If
366 omitted, defaults to
<option>all
</option>.
</para>
368 <xi:include href=
"version-info.xml" xpointer=
"v252"/></listitem>
372 <term><option>-s
</option></term>
373 <term><option>--signal=
</option></term>
375 <listitem><para>When used with
<command>kill-session
</command> or
<command>kill-user
</command>,
376 choose which signal to send to selected processes. Must be one of the well known signal specifiers,
377 such as
<constant>SIGTERM
</constant>,
<constant>SIGINT
</constant> or
<constant>SIGSTOP
</constant>.
378 If omitted, defaults to
<constant>SIGTERM
</constant>.
</para>
380 <para>The special value
<literal>help
</literal> will list the known values and the program will exit
381 immediately, and the special value
<literal>list
</literal> will list known values along with the
382 numerical signal numbers and the program will exit immediately.
</para></listitem>
386 <term><option>-n
</option></term>
387 <term><option>--lines=
</option></term>
389 <listitem><para>When used with
<command>user-status
</command>
390 and
<command>session-status
</command>, controls the number of
391 journal lines to show, counting from the most recent ones.
392 Takes a positive integer argument. Defaults to
10.
</para>
394 <xi:include href=
"version-info.xml" xpointer=
"v219"/>
399 <term><option>-o
</option></term>
400 <term><option>--output=
</option></term>
402 <listitem><para>When used with
<command>user-status
</command>
403 and
<command>session-status
</command>, controls the formatting
404 of the journal entries that are shown. For the available
406 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
407 Defaults to
<literal>short
</literal>.
</para>
409 <xi:include href=
"version-info.xml" xpointer=
"v219"/></listitem>
412 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
413 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
415 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
416 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
417 <xi:include href=
"standard-options.xml" xpointer=
"help" />
418 <xi:include href=
"standard-options.xml" xpointer=
"version" />
423 <title>Exit status
</title>
425 <para>On success,
0 is returned, a non-zero failure code
430 <title>Examples
</title>
433 <title>Querying user status
</title>
435 <programlisting>$ loginctl user-status
437 Since: Sat
2016-
04-
09 14:
23:
31 EDT;
54min ago
440 Unit: user-
1005.slice
446 ├─
3473 login -- fatima
449 Apr
09 14:
40:
30 laptop login[
2325]: pam_unix(login:session):
450 session opened for user fatima by LOGIN(uid=
0)
451 Apr
09 14:
40:
30 laptop login[
2325]: LOGIN ON tty3 BY fatima
454 <para>There are two sessions,
3 and
5. Session
3 is a graphical session,
455 marked with a star. The tree of processing including the two corresponding
456 scope units and the user manager unit are shown.
</para>
460 <xi:include href=
"common-variables.xml" />
463 <title>See Also
</title>
465 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
466 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
467 <citerefentry><refentrytitle>systemd-logind.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
468 <citerefentry><refentrytitle>logind.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>