3
.\" Author: Lennart Poettering <lennart@poettering.net>
4
.\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
10
.TH "LOGINCTL" "1" "" "systemd" "loginctl"
11
.\" -----------------------------------------------------------------
12
.\" * Define some portability stuff
13
.\" -----------------------------------------------------------------
14
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15
.\" http://bugs.debian.org/507673
16
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
.\" -----------------------------------------------------------------
21
.\" * set default formatting
22
.\" -----------------------------------------------------------------
23
.\" disable hyphenation
25
.\" disable justification (adjust text to left margin only)
27
.\" -----------------------------------------------------------------
28
.\" * MAIN CONTENT STARTS HERE *
29
.\" -----------------------------------------------------------------
31
loginctl \- Control the systemd login manager
33
.HP \w'\fBloginctl\ \fR\fB[OPTIONS...]\fR\fB\ \fR\fB{COMMAND}\fR\fB\ \fR\fB[NAME...]\fR\ 'u
34
\fBloginctl \fR\fB[OPTIONS...]\fR\fB \fR\fB{COMMAND}\fR\fB \fR\fB[NAME...]\fR
38
may be used to introspect and control the state of the
41
\fBsystemd-logind.service\fR(8)\&.
44
The following options are understood:
46
\fB\-h\fR, \fB\-\-help\fR
48
Prints a short help text and exits\&.
53
Prints a short version string and exits\&.
56
\fB\-p\fR, \fB\-\-property=\fR
58
When showing session/user properties, limit display to certain properties as specified as argument\&. If not specified all set properties are shown\&. The argument should be a property name, such as
59
Sessions\&. If specified more than once all properties with the specified names are shown\&.
62
\fB\-a\fR, \fB\-\-all\fR
64
When showing unit/job/manager properties, show all properties regardless whether they are set or not\&.
69
Do not ellipsize cgroup members\&.
74
Do not pipe output into a pager\&.
77
\fB\-\-no\-ask\-password\fR
79
Don\*(Aqt query the user for authentication for privileged operations\&.
85
\fBkill\-session\fR, choose which processes to kill\&. Must be one of
88
to select whether to kill only the leader process of the session or all processes of the session\&. If omitted defaults to
92
\fB\-s\fR, \fB\-\-signal=\fR
97
\fBkill\-user\fR, choose which signal to send to selected processes\&. Must be one of the well known signal specifiers such as SIGTERM, SIGINT or SIGSTOP\&. If omitted defaults to
101
\fB\-H\fR, \fB\-\-host\fR
103
Execute operation remotely\&. Specify a hostname, or username and hostname separated by @, to connect to\&. This will use SSH to talk to the remote login manager instance\&.
106
\fB\-P\fR, \fB\-\-privileged\fR
108
Acquire privileges via PolicyKit before executing the operation\&.
111
The following commands are understood:
115
List current sessions\&.
118
\fBsession\-status [ID\&.\&.\&.]\fR
120
Show terse runtime status information about one or more sessions\&. This function is intended to generate human\-readable output\&. If you are looking for computer\-parsable output, use
125
\fBshow\-session [ID\&.\&.\&.]\fR
127
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 is shown\&. By default, empty properties are suppressed\&. Use
129
to show those too\&. To select specific properties to show use
130
\fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
131
\fBsession\-status\fR
132
if you are looking for formatted human\-readable output\&.
135
\fBactivate [ID\&.\&.\&.]\fR
137
Activate one or more sessions\&. This brings one or more sessions into the foreground, if another session is currently in the foreground on the respective seat\&.
140
\fBlock\-session [ID\&.\&.\&.]\fR, \fBunlock\-session [ID\&.\&.\&.]\fR
142
Activates/deactivates the screen lock on one or more sessions, if the session supports it\&.
145
\fBlock\-sessions\fR, \fBunlock\-sessions\fR
147
Activates/deactivates the screen lock on all current sessions supporting it\&.
150
\fBterminate\-session [ID\&.\&.\&.]\fR
152
Terminates a session\&. This kills all processes of the session and deallocates all resources attached to the session\&.
155
\fBkill\-session [ID\&.\&.\&.]\fR
157
Send a signal to one or more processes of the session\&. Use
159
to select which process to kill\&. Use
161
to select the signal to send\&.
166
List currently logged in users\&.
169
\fBuser\-status [USER\&.\&.\&.]\fR
171
Show terse runtime status information about one or more logged in users\&. This function is intended to generate human\-readable output\&. If you are looking for computer\-parsable output, use
173
instead\&. Users may be specified by their usernames or numeric user IDs\&.
176
\fBshow\-user [USER\&.\&.\&.]\fR
178
Show properties of one or more users or the manager itself\&. If no argument is specified properties of the manager will be shown\&. If a user is specified properties of the user is shown\&. By default, empty properties are suppressed\&. Use
180
to show those too\&. To select specific properties to show use
181
\fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
183
if you are looking for formatted human\-readable output\&.
186
\fBenable\-linger [USER\&.\&.\&.]\fR, \fBdisable\-linger [USER\&.\&.\&.]\fR
188
Enable/disable user lingering for one or more users\&. If enabled for a specific user a user manager is spawned for him/her at boot, and kept around after logouts\&. This allows users who aren\*(Aqt logged in to run long\-running services\&.
191
\fBterminate\-user [USER\&.\&.\&.]\fR
193
Terminates all sessions of a user\&. This kills all processes of all sessions of the user and deallocates all runtime resources attached to the user\&.
196
\fBkill\-user [USER\&.\&.\&.]\fR
198
Send a signal to all processes of a user\&. Use
200
to select the signal to send\&.
205
List currently available seats on the local system\&.
208
\fBseat\-status [NAME\&.\&.\&.]\fR
210
Show terse runtime status information about one or more seats\&. This function is intended to generate human\-readable output\&. If you are looking for computer\-parsable output, use
215
\fBshow\-seat [NAME\&.\&.\&.]\fR
217
Show properties of one or more seats or the manager itself\&. If no argument is specified properties of the manager will be shown\&. If a seat is specified properties of the seat are shown\&. By default, empty properties are suppressed\&. Use
219
to show those too\&. To select specific properties to show use
220
\fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
222
if you are looking for formatted human\-readable output\&.
225
\fBattach [NAME] [DEVICE\&.\&.\&.]\fR
227
Persistently attach one or more devices to a seat\&. The devices should be specified via device paths in the
229
file system\&. To create a new seat attach at least one graphics card to a previously unused seat name\&. Seat names may consist only of a\-z, A\-Z, 0\-9, "\-" and "_" and must be prefixed with "seat"\&. To drop assignment of a device to a specific seat just reassign it to a different seat, or use
230
\fBflush\-devices\fR\&.
235
Removes all device assignments previously created with
236
\fBattach\fR\&. After this call only automatically generated seats will remain and all seat hardware is assigned to them\&.
239
\fBterminate\-seat [NAME\&.\&.\&.]\fR
241
Terminates all sessions on a seat\&. This kills all processes of all sessions on a seat and deallocates all runtime resources attached to them\&.
245
On success 0 is returned, a non\-zero failure code otherwise\&.
252
is not given; overrides
253
\fI$PAGER\fR\&. Setting this to an empty string or the value
255
is equivalent to passing
256
\fB\-\-no\-pager\fR\&.
263
\fBsystemd-logind.service\fR(8),
added
removed
man/loginctl.1
