man/systemd-loginctl.1

   1 '\" t
   2 .\"     Title: systemd-loginctl
   3 .\"    Author: Lennart Poettering <lennart@poettering.net>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/15/2012
   6 .\"    Manual: systemd-loginctl
   7 .\"    Source: systemd
   8 .\"  Language: English
   9 .\"
  10 .TH "SYSTEMD\-LOGINCTL" "1" "02/15/2012" "systemd" "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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 systemd-loginctl \- Control the systemd login manager
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBsystemd\-loginctl\ \fR\fB[OPTIONS...]\fR\fB\ \fR\fB{COMMAND}\fR\fB\ \fR\fB[NAME...]\fR\ 'u
  34 \fBsystemd\-loginctl \fR\fB[OPTIONS...]\fR\fB \fR\fB{COMMAND}\fR\fB \fR\fB[NAME...]\fR
  35 .SH "DESCRIPTION"
  36 .PP
  37 \fBsystemd\-loginctl\fR
  38 may be used to introspect and control the state of the
  39 \fBsystemd\fR(1)
  40 login manager\&.
  41 .SH "OPTIONS"
  42 .PP
  43 The following options are understood:
  44 .PP
  45 \fB\-\-help\fR, \fB\-h\fR
  46 .RS 4
  47 Prints a short help text and exits\&.
  48 .RE
  49 .PP
  50 \fB\-\-version\fR
  51 .RS 4
  52 Prints a short version string and exits\&.
  53 .RE
  54 .PP
  55 \fB\-\-property=\fR, \fB\-p\fR
  56 .RS 4
  57 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
  58 Sessions\&. If specified more than once all properties with the specified names are shown\&.
  59 .RE
  60 .PP
  61 \fB\-\-all\fR, \fB\-a\fR
  62 .RS 4
  63 When showing unit/job/manager properties, show all properties regardless whether they are set or not\&.
  64 .RE
  65 .PP
  66 \fB\-\-no\-pager\fR
  67 .RS 4
  68 Do not pipe output into a pager\&.
  69 .RE
  70 .PP
  71 \fB\-\-kill\-who=\fR
  72 .RS 4
  73 When used with
  74 \fBkill\-session\fR, choose which processes to kill\&. Must be one of
  75 \fBleader\fR, or
  76 \fBall\fR
  77 to select whether to kill only the leader process of the session or all processes of the session\&. If omitted defaults to
  78 \fBall\fR\&.
  79 .RE
  80 .PP
  81 \fB\-\-signal=\fR, \fB\-s\fR
  82 .RS 4
  83 When used with
  84 \fBkill\-session\fR
  85 or
  86 \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
  87 \fBSIGTERM\fR\&.
  88 .RE
  89 .PP
  90 \fB\-H\fR, \fB\-\-host\fR
  91 .RS 4
  92 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\&.
  93 .RE
  94 .PP
  95 \fB\-P\fR, \fB\-\-privileged\fR
  96 .RS 4
  97 Acquire privileges via PolicyKit before executing the operation\&.
  98 .RE
  99 .PP
 100 The following commands are understood:
 101 .PP
 102 \fBlist\-sessions\fR
 103 .RS 4
 104 List current sessions\&.
 105 .RE
 106 .PP
 107 \fBsession\-status [ID\&.\&.\&.]\fR
 108 .RS 4
 109 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
 110 \fBshow\-session\fR
 111 instead\&.
 112 .RE
 113 .PP
 114 \fBshow\-session [ID\&.\&.\&.]\fR
 115 .RS 4
 116 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
 117 \fB\-\-all\fR
 118 to show those too\&. To select specific properties to show use
 119 \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
 120 \fBsession\-status\fR
 121 if you are looking for formatted human\-readable output\&.
 122 .RE
 123 .PP
 124 \fBactivate [ID\&.\&.\&.]\fR
 125 .RS 4
 126 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\&.
 127 .RE
 128 .PP
 129 \fBlock\-session [ID\&.\&.\&.]\fR, \fBunlock\-session [ID\&.\&.\&.]\fR
 130 .RS 4
 131 Activates/deactivates the screen lock on one or more sessions, if the session supports it\&.
 132 .RE
 133 .PP
 134 \fBterminate\-session [ID\&.\&.\&.]\fR
 135 .RS 4
 136 Terminates a session\&. This kills all processes of the session and deallocates all resources attached to the session\&.
 137 .RE
 138 .PP
 139 \fBkill\-session [ID\&.\&.\&.]\fR
 140 .RS 4
 141 Send a signal to one or more processes of the session\&. Use
 142 \fB\-\-kill\-who=\fR
 143 to select which process to kill\&. Use
 144 \fB\-\-signal=\fR
 145 to select the signal to send\&.
 146 .RE
 147 .PP
 148 \fBlist\-users\fR
 149 .RS 4
 150 List currently logged in users\&.
 151 .RE
 152 .PP
 153 \fBuser\-status [USER\&.\&.\&.]\fR
 154 .RS 4
 155 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
 156 \fBshow\-user\fR
 157 instead\&. Users may be specified by their usernames or numeric user IDs\&.
 158 .RE
 159 .PP
 160 \fBshow\-user [USER\&.\&.\&.]\fR
 161 .RS 4
 162 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
 163 \fB\-\-all\fR
 164 to show those too\&. To select specific properties to show use
 165 \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
 166 \fBuser\-status\fR
 167 if you are looking for formatted human\-readable output\&.
 168 .RE
 169 .PP
 170 \fBenable\-linger [USER\&.\&.\&.]\fR, \fBdisable\-linger [USER\&.\&.\&.]\fR
 171 .RS 4
 172 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\&.
 173 .RE
 174 .PP
 175 \fBterminate\-user [USER\&.\&.\&.]\fR
 176 .RS 4
 177 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\&.
 178 .RE
 179 .PP
 180 \fBkill\-user [USER\&.\&.\&.]\fR
 181 .RS 4
 182 Send a signal to all processes of a user\&. Use
 183 \fB\-\-signal=\fR
 184 to select the signal to send\&.
 185 .RE
 186 .PP
 187 \fBlist\-seats\fR
 188 .RS 4
 189 List currently available seats on the local system\&.
 190 .RE
 191 .PP
 192 \fBseat\-status [NAME\&.\&.\&.]\fR
 193 .RS 4
 194 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
 195 \fBshow\-seat\fR
 196 instead\&.
 197 .RE
 198 .PP
 199 \fBshow\-seat [NAME\&.\&.\&.]\fR
 200 .RS 4
 201 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
 202 \fB\-\-all\fR
 203 to show those too\&. To select specific properties to show use
 204 \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
 205 \fBseat\-status\fR
 206 if you are looking for formatted human\-readable output\&.
 207 .RE
 208 .PP
 209 \fBattach [NAME] [DEVICE\&.\&.\&.]\fR
 210 .RS 4
 211 Attach one or more devices to a seat\&. The devices should be specified via device paths in the
 212 /sys
 213 file system\&. To create a new seat attach at least one graphics card to a previously unused seat names\&. 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
 214 \fBflush\-devices\fR\&.
 215 .RE
 216 .PP
 217 \fBflush\-devices\fR
 218 .RS 4
 219 Removes all device assignments previously created with
 220 \fBattach\fR\&. After this call only automatically generated seats will remain and all seat hardware is assigned to them\&.
 221 .RE
 222 .PP
 223 \fBterminate\-seat [NAME\&.\&.\&.]\fR
 224 .RS 4
 225 Terminates all sessions on a seat\&. This kills all processes of all sessions on a seat and deallocates all runtime resources attached to them\&.
 226 .RE
 227 .SH "EXIT STATUS"
 228 .PP
 229 On success 0 is returned, a non\-zero failure code otherwise\&.
 230 .SH "ENVIRONMENT"
 231 .PP
 232 \fI$SYSTEMD_PAGER\fR
 233 .RS 4
 234 Pager to use when
 235 \fB\-\-no\-pager\fR
 236 is not given; overrides
 237 \fI$PAGER\fR\&. Setting this to an empty string or the value
 238 cat
 239 is equivalent to passing
 240 \fB\-\-no\-pager\fR\&.
 241 .RE
 242 .SH "SEE ALSO"
 243 .PP
 244
 245 \fBsystemd\fR(1),
 246 \fBsystemctl\fR(1),
 247 \fBsystemd-logind.conf\fR(5)
 248 .SH "AUTHOR"
 249 .PP
 250 \fBLennart Poettering\fR <\&lennart@poettering\&.net\&>
 251 .RS 4
 252 Developer
 253 .RE