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 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id=
"loginctl" conditional='ENABLE_LOGIND'
25 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
28 <title>loginctl
</title>
29 <productname>systemd
</productname>
33 <contrib>Developer
</contrib>
34 <firstname>Lennart
</firstname>
35 <surname>Poettering
</surname>
36 <email>lennart@poettering.net
</email>
42 <refentrytitle>loginctl
</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>loginctl
</refname>
48 <refpurpose>Control the systemd login manager
</refpurpose>
53 <command>loginctl
</command>
54 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
55 <arg choice=
"req">COMMAND
</arg>
56 <arg choice=
"opt" rep=
"repeat">NAME
</arg>
61 <title>Description
</title>
63 <para><command>loginctl
</command> may be used to introspect and
64 control the state of the
65 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
67 <citerefentry><refentrytitle>systemd-logind.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
71 <title>Options
</title>
73 <para>The following options are understood:
</para>
77 <term><option>--no-ask-password
</option></term>
79 <listitem><para>Do not query the user for authentication for
80 privileged operations.
</para></listitem>
84 <term><option>-p
</option></term>
85 <term><option>--property=
</option></term>
87 <listitem><para>When showing session/user/seat properties,
88 limit display to certain properties as specified as argument.
89 If not specified, all set properties are shown. The argument
90 should be a property name, such as
91 <literal>Sessions
</literal>. If specified more than once, all
92 properties with the specified names are
93 shown.
</para></listitem>
97 <term><option>--value
</option></term>
100 <para>When printing properties with
<command>show
</command>,
101 only print the value, and skip the property name and
102 <literal>=
</literal>.
</para>
107 <term><option>-a
</option></term>
108 <term><option>--all
</option></term>
110 <listitem><para>When showing session/user/seat properties,
111 show all properties regardless of whether they are set or
112 not.
</para></listitem>
116 <term><option>-l
</option></term>
117 <term><option>--full
</option></term>
119 <listitem><para>Do not ellipsize process tree entries.
</para>
124 <term><option>--kill-who=
</option></term>
126 <listitem><para>When used with
127 <command>kill-session
</command>, choose which processes to
128 kill. Must be one of
<option>leader
</option>, or
129 <option>all
</option> to select whether to kill only the leader
130 process of the session or all processes of the session. If
131 omitted, defaults to
<option>all
</option>.
</para></listitem>
135 <term><option>-s
</option></term>
136 <term><option>--signal=
</option></term>
138 <listitem><para>When used with
<command>kill-session
</command>
139 or
<command>kill-user
</command>, choose which signal to send
140 to selected processes. Must be one of the well known signal
141 specifiers, such as
<constant>SIGTERM
</constant>,
142 <constant>SIGINT
</constant> or
<constant>SIGSTOP
</constant>.
143 If omitted, defaults to
144 <constant>SIGTERM
</constant>.
</para></listitem>
148 <term><option>-n
</option></term>
149 <term><option>--lines=
</option></term>
151 <listitem><para>When used with
<command>user-status
</command>
152 and
<command>session-status
</command>, controls the number of
153 journal lines to show, counting from the most recent ones.
154 Takes a positive integer argument. Defaults to
10.
</para>
159 <term><option>-o
</option></term>
160 <term><option>--output=
</option></term>
162 <listitem><para>When used with
<command>user-status
</command>
163 and
<command>session-status
</command>, controls the formatting
164 of the journal entries that are shown. For the available
166 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
167 Defaults to
<literal>short
</literal>.
</para></listitem>
170 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
171 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
173 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
174 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
175 <xi:include href=
"standard-options.xml" xpointer=
"help" />
176 <xi:include href=
"standard-options.xml" xpointer=
"version" />
181 <title>Commands
</title>
183 <para>The following commands are understood:
</para>
185 <refsect2><title>Session Commands
</title><variablelist>
188 <term><command>list-sessions
</command></term>
190 <listitem><para>List current sessions.
</para></listitem>
194 <term><command>session-status
</command> <optional><replaceable>ID
</replaceable>...
</optional></term>
196 <listitem><para>Show terse runtime status information about
197 one or more sessions, followed by the most recent log data
198 from the journal. Takes one or more session identifiers as
199 parameters. If no session identifiers are passed, the status of
200 the caller's session is shown. This function is intended to
201 generate human-readable output. If you are looking for
202 computer-parsable output, use
<command>show-session
</command>
203 instead.
</para></listitem>
207 <term><command>show-session
</command> <optional><replaceable>ID
</replaceable>...
</optional></term>
209 <listitem><para>Show properties of one or more sessions or the
210 manager itself. If no argument is specified, properties of the
211 manager will be shown. If a session ID is specified,
212 properties of the session are shown. By default, empty
213 properties are suppressed. Use
<option>--all
</option> to show
214 those too. To select specific properties to show, use
215 <option>--property=
</option>. This command is intended to be
216 used whenever computer-parsable output is required. Use
217 <command>session-status
</command> if you are looking for
218 formatted human-readable output.
</para></listitem>
222 <term><command>activate
</command> <optional><replaceable>ID
</replaceable></optional></term>
224 <listitem><para>Activate a session. This brings a session into
225 the foreground if another session is currently in the
226 foreground on the respective seat. Takes a session identifier
227 as argument. If no argument is specified, the session of the
228 caller is put into foreground.
</para></listitem>
232 <term><command>lock-session
</command> <optional><replaceable>ID
</replaceable>...
</optional></term>
233 <term><command>unlock-session
</command> <optional><replaceable>ID
</replaceable>...
</optional></term>
235 <listitem><para>Activates/deactivates the screen lock on one
236 or more sessions, if the session supports it. Takes one or
237 more session identifiers as arguments. If no argument is
238 specified, the session of the caller is locked/unlocked.
243 <term><command>lock-sessions
</command></term>
244 <term><command>unlock-sessions
</command></term>
246 <listitem><para>Activates/deactivates the screen lock on all
247 current sessions supporting it.
</para></listitem>
251 <term><command>terminate-session
</command> <replaceable>ID
</replaceable>...
</term>
253 <listitem><para>Terminates a session. This kills all processes
254 of the session and deallocates all resources attached to the
255 session.
</para></listitem>
259 <term><command>kill-session
</command> <replaceable>ID
</replaceable>...
</term>
261 <listitem><para>Send a signal to one or more processes of the
262 session. Use
<option>--kill-who=
</option> to select which
263 process to kill. Use
<option>--signal=
</option> to select the
264 signal to send.
</para></listitem>
266 </variablelist></refsect2>
268 <refsect2><title>User Commands
</title><variablelist>
270 <term><command>list-users
</command></term>
272 <listitem><para>List currently logged in users.
277 <term><command>user-status
</command> <optional><replaceable>USER
</replaceable>...
</optional></term>
279 <listitem><para>Show terse runtime status information about
280 one or more logged in users, followed by the most recent log
281 data from the journal. Takes one or more user names or numeric
282 user IDs as parameters. If no parameters are passed, the status
283 of the caller's user is shown. This function is intended to
284 generate human-readable output. If you are looking for
285 computer-parsable output, use
<command>show-user
</command>
286 instead. Users may be specified by their usernames or numeric
287 user IDs.
</para></listitem>
291 <term><command>show-user
</command> <optional><replaceable>USER
</replaceable>...
</optional></term>
293 <listitem><para>Show properties of one or more users or the
294 manager itself. If no argument is specified, properties of the
295 manager will be shown. If a user is specified, properties of
296 the user are shown. By default, empty properties are
297 suppressed. Use
<option>--all
</option> to show those too. To
298 select specific properties to show, use
299 <option>--property=
</option>. This command is intended to be
300 used whenever computer-parsable output is required. Use
301 <command>user-status
</command> if you are looking for
302 formatted human-readable output.
</para></listitem>
306 <term><command>enable-linger
</command> <optional><replaceable>USER
</replaceable>...
</optional></term>
307 <term><command>disable-linger
</command> <optional><replaceable>USER
</replaceable>...
</optional></term>
309 <listitem><para>Enable/disable user lingering for one or more
310 users. If enabled for a specific user, a user manager is
311 spawned for the user at boot and kept around after logouts.
312 This allows users who are not logged in to run long-running
313 services. Takes one or more user names or numeric UIDs as
314 argument. If no argument is specified, enables/disables
315 lingering for the user of the session of the caller.
320 <term><command>terminate-user
</command> <replaceable>USER
</replaceable>...
</term>
322 <listitem><para>Terminates all sessions of a user. This kills
323 all processes of all sessions of the user and deallocates all
324 runtime resources attached to the user.
</para></listitem>
328 <term><command>kill-user
</command> <replaceable>USER
</replaceable>...
</term>
330 <listitem><para>Send a signal to all processes of a user. Use
331 <option>--signal=
</option> to select the signal to send.
334 </variablelist></refsect2>
336 <refsect2><title>Seat Commands
</title><variablelist>
338 <term><command>list-seats
</command></term>
340 <listitem><para>List currently available seats on the local
341 system.
</para></listitem>
345 <term><command>seat-status
</command> <optional><replaceable>NAME
</replaceable>...
</optional></term>
347 <listitem><para>Show terse runtime status information about
348 one or more seats. Takes one or more seat names as parameters.
349 If no seat names are passed the status of the caller's
350 session's seat is shown. This function is intended to generate
351 human-readable output. If you are looking for
352 computer-parsable output, use
<command>show-seat
</command>
353 instead.
</para></listitem>
357 <term><command>show-seat
</command> <optional><replaceable>NAME
</replaceable>...
</optional></term>
359 <listitem><para>Show properties of one or more seats or the
360 manager itself. If no argument is specified, properties of the
361 manager will be shown. If a seat is specified, properties of
362 the seat are shown. By default, empty properties are
363 suppressed. Use
<option>--all
</option> to show those too. To
364 select specific properties to show, use
365 <option>--property=
</option>. This command is intended to be
366 used whenever computer-parsable output is required. Use
367 <command>seat-status
</command> if you are looking for
368 formatted human-readable output.
</para></listitem>
372 <term><command>attach
</command> <replaceable>NAME
</replaceable> <replaceable>DEVICE
</replaceable>...
</term>
374 <listitem><para>Persistently attach one or more devices to a
375 seat. The devices should be specified via device paths in the
376 <filename>/sys
</filename> file system. To create a new seat,
377 attach at least one graphics card to a previously unused seat
378 name. Seat names may consist only of a–z, A–Z,
0–
9,
379 <literal>-
</literal> and
<literal>_
</literal> and must be
380 prefixed with
<literal>seat
</literal>. To drop assignment of a
381 device to a specific seat, just reassign it to a different
382 seat, or use
<command>flush-devices
</command>.
387 <term><command>flush-devices
</command></term>
389 <listitem><para>Removes all device assignments previously
390 created with
<command>attach
</command>. After this call, only
391 automatically generated seats will remain, and all seat
392 hardware is assigned to them.
</para></listitem>
396 <term><command>terminate-seat
</command> <replaceable>NAME
</replaceable>...
</term>
398 <listitem><para>Terminates all sessions on a seat. This kills
399 all processes of all sessions on the seat and deallocates all
400 runtime resources attached to them.
</para></listitem>
402 </variablelist></refsect2>
407 <title>Exit status
</title>
409 <para>On success,
0 is returned, a non-zero failure code
413 <xi:include href=
"less-variables.xml" />
416 <title>See Also
</title>
418 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
419 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
420 <citerefentry><refentrytitle>systemd-logind.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
421 <citerefentry><refentrytitle>logind.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>