projects / thirdparty / systemd.git / blame
| Commit | Line | Data |
|---|---|---|
| a61933ad LP |
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"> | |
| 4 | ||
| 5 | <!-- | |
| 6 | This file is part of systemd. | |
| 7 | ||
| 8 | Copyright 2010 Lennart Poettering | |
| 9 | ||
| 10 | systemd is free software; you can redistribute it and/or modify it | |
| 5430f7f2 LP |
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 | |
| a61933ad LP |
13 | (at your option) any later version. |
| 14 | ||
| 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 | |
| 5430f7f2 | 18 | Lesser General Public License for more details. |
| a61933ad | 19 | |
| 5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
| a61933ad LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
| 22 | --> | |
| 23 | ||
| 56ba3c78 | 24 | <refentry id="loginctl" conditional='HAVE_PAM'> |
| a61933ad LP |
25 | |
| 26 | <refentryinfo> | |
| 169c4f65 | 27 | <title>loginctl</title> |
| a61933ad LP |
28 | <productname>systemd</productname> |
| 29 | ||
| 30 | <authorgroup> | |
| 31 | <author> | |
| 32 | <contrib>Developer</contrib> | |
| 33 | <firstname>Lennart</firstname> | |
| 34 | <surname>Poettering</surname> | |
| 35 | <email>lennart@poettering.net</email> | |
| 36 | </author> | |
| 37 | </authorgroup> | |
| 38 | </refentryinfo> | |
| 39 | ||
| 40 | <refmeta> | |
| 169c4f65 | 41 | <refentrytitle>loginctl</refentrytitle> |
| a61933ad LP |
42 | <manvolnum>1</manvolnum> |
| 43 | </refmeta> | |
| 44 | ||
| 45 | <refnamediv> | |
| 169c4f65 | 46 | <refname>loginctl</refname> |
| a61933ad LP |
47 | <refpurpose>Control the systemd login manager</refpurpose> |
| 48 | </refnamediv> | |
| 49 | ||
| 50 | <refsynopsisdiv> | |
| 51 | <cmdsynopsis> | |
| 169c4f65 | 52 | <command>loginctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">NAME</arg></command> |
| a61933ad LP |
53 | </cmdsynopsis> |
| 54 | </refsynopsisdiv> | |
| 55 | ||
| 56 | <refsect1> | |
| 57 | <title>Description</title> | |
| 58 | ||
| 169c4f65 | 59 | <para><command>loginctl</command> may be used to |
| a61933ad LP |
60 | introspect and control the state of the |
| 61 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
| af3bccd6 | 62 | login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> |
| a61933ad LP |
63 | </refsect1> |
| 64 | ||
| 65 | <refsect1> | |
| 66 | <title>Options</title> | |
| 67 | ||
| 68 | <para>The following options are understood:</para> | |
| 69 | ||
| 70 | <variablelist> | |
| 71 | <varlistentry> | |
| a61933ad | 72 | <term><option>-h</option></term> |
| a7f5bb1e | 73 | <term><option>--help</option></term> |
| a61933ad LP |
74 | |
| 75 | <listitem><para>Prints a short help | |
| 76 | text and exits.</para></listitem> | |
| 77 | </varlistentry> | |
| 78 | ||
| 79 | <varlistentry> | |
| 80 | <term><option>--version</option></term> | |
| 81 | ||
| 82 | <listitem><para>Prints a short version | |
| 83 | string and exits.</para></listitem> | |
| 84 | </varlistentry> | |
| 85 | ||
| 86 | <varlistentry> | |
| a61933ad | 87 | <term><option>-p</option></term> |
| a7f5bb1e | 88 | <term><option>--property=</option></term> |
| a61933ad LP |
89 | |
| 90 | <listitem><para>When showing | |
| 57ccf907 | 91 | session/user properties, limit |
| a61933ad LP |
92 | display to certain properties as |
| 93 | specified as argument. If not | |
| 94 | specified all set properties are | |
| 95 | shown. The argument should be a | |
| 96 | property name, such as | |
| 97 | <literal>Sessions</literal>. If | |
| 98 | specified more than once all | |
| 99 | properties with the specified names | |
| 100 | are shown.</para></listitem> | |
| 101 | </varlistentry> | |
| 102 | ||
| 103 | <varlistentry> | |
| a61933ad | 104 | <term><option>-a</option></term> |
| a7f5bb1e | 105 | <term><option>--all</option></term> |
| a61933ad LP |
106 | |
| 107 | <listitem><para>When showing | |
| 108 | unit/job/manager properties, show all | |
| 109 | properties regardless whether they are | |
| 110 | set or not.</para></listitem> | |
| 111 | </varlistentry> | |
| 112 | ||
| 9bdbc2e2 LN |
113 | <varlistentry> |
| 114 | <term><option>--full</option></term> | |
| 115 | ||
| 116 | <listitem><para>Do not ellipsize cgroup | |
| 117 | members.</para> | |
| 118 | </listitem> | |
| 119 | </varlistentry> | |
| a61933ad LP |
120 | |
| 121 | <varlistentry> | |
| 122 | <term><option>--no-pager</option></term> | |
| 123 | ||
| 0e25e94e KS |
124 | <listitem><para>Do not pipe output into a |
| 125 | pager.</para></listitem> | |
| 126 | </varlistentry> | |
| a61933ad | 127 | |
| 6bb92a16 LP |
128 | <varlistentry> |
| 129 | <term><option>--no-ask-password</option></term> | |
| 130 | ||
| 131 | <listitem><para>Don't query the user | |
| 132 | for authentication for privileged | |
| 133 | operations.</para></listitem> | |
| 134 | </varlistentry> | |
| 135 | ||
| a61933ad LP |
136 | <varlistentry> |
| 137 | <term><option>--kill-who=</option></term> | |
| 138 | ||
| 139 | <listitem><para>When used with | |
| 140 | <command>kill-session</command>, | |
| 141 | choose which processes to kill. Must | |
| 142 | be one of <option>leader</option>, or | |
| 143 | <option>all</option> to select whether | |
| 144 | to kill only the leader process of the | |
| 145 | session or all processes of the | |
| 146 | session. If omitted defaults to | |
| 147 | <option>all</option>.</para></listitem> | |
| 148 | </varlistentry> | |
| 149 | ||
| 150 | <varlistentry> | |
| a61933ad | 151 | <term><option>-s</option></term> |
| a7f5bb1e | 152 | <term><option>--signal=</option></term> |
| a61933ad LP |
153 | |
| 154 | <listitem><para>When used with | |
| 155 | <command>kill-session</command> or | |
| 156 | <command>kill-user</command>, choose | |
| 157 | which signal to send to selected | |
| 158 | processes. Must be one of the well | |
| 159 | known signal specifiers such as | |
| 160 | SIGTERM, SIGINT or SIGSTOP. If omitted | |
| 161 | defaults to | |
| 162 | <option>SIGTERM</option>.</para></listitem> | |
| 163 | </varlistentry> | |
| 164 | ||
| 165 | <varlistentry> | |
| 166 | <term><option>-H</option></term> | |
| 167 | <term><option>--host</option></term> | |
| 168 | ||
| 169 | <listitem><para>Execute operation | |
| 170 | remotely. Specify a hostname, or | |
| 171 | username and hostname separated by @, | |
| 172 | to connect to. This will use SSH to | |
| 173 | talk to the remote login manager | |
| 174 | instance.</para></listitem> | |
| 175 | </varlistentry> | |
| 176 | ||
| 177 | <varlistentry> | |
| 178 | <term><option>-P</option></term> | |
| 179 | <term><option>--privileged</option></term> | |
| 180 | ||
| 181 | <listitem><para>Acquire privileges via | |
| 182 | PolicyKit before executing the | |
| 183 | operation.</para></listitem> | |
| 184 | </varlistentry> | |
| 185 | </variablelist> | |
| 186 | ||
| 187 | <para>The following commands are understood:</para> | |
| 188 | ||
| 189 | <variablelist> | |
| 190 | <varlistentry> | |
| 191 | <term><command>list-sessions</command></term> | |
| 192 | ||
| 193 | <listitem><para>List current sessions.</para></listitem> | |
| 194 | </varlistentry> | |
| 195 | ||
| 196 | <varlistentry> | |
| 197 | <term><command>session-status [ID...]</command></term> | |
| 198 | ||
| 199 | <listitem><para>Show terse runtime | |
| 200 | status information about one or more | |
| 201 | sessions. This function is intended to | |
| 202 | generate human-readable output. If you | |
| 203 | are looking for computer-parsable | |
| 204 | output, use | |
| 205 | <command>show-session</command> | |
| 206 | instead.</para></listitem> | |
| 207 | </varlistentry> | |
| 208 | ||
| 209 | <varlistentry> | |
| 210 | <term><command>show-session [ID...]</command></term> | |
| 211 | ||
| 212 | <listitem><para>Show properties of one | |
| 213 | or more sessions or the manager | |
| 214 | itself. If no argument is specified | |
| 215 | properties of the manager will be | |
| 216 | shown. If a session ID is specified | |
| 217 | properties of the session is shown. By | |
| 218 | default, empty properties are | |
| 219 | suppressed. Use <option>--all</option> | |
| 220 | to show those too. To select specific | |
| 221 | properties to show use | |
| 222 | <option>--property=</option>. This | |
| 223 | command is intended to be used | |
| 224 | whenever computer-parsable output is | |
| 225 | required. Use | |
| 226 | <command>session-status</command> if | |
| 227 | you are looking for formatted | |
| 228 | human-readable | |
| 229 | output.</para></listitem> | |
| 230 | </varlistentry> | |
| 231 | ||
| 232 | <varlistentry> | |
| 233 | <term><command>activate [ID...]</command></term> | |
| 234 | ||
| 235 | <listitem><para>Activate one or more | |
| 236 | sessions. This brings one or more | |
| 237 | sessions into the foreground, if | |
| 238 | another session is currently in the | |
| 239 | foreground on the respective | |
| 240 | seat.</para></listitem> | |
| 241 | </varlistentry> | |
| 242 | ||
| 243 | <varlistentry> | |
| 283ef082 MV |
244 | <term><command>lock-session [ID...]</command></term> |
| 245 | <term><command>unlock-session [ID...]</command></term> | |
| a61933ad LP |
246 | |
| 247 | <listitem><para>Activates/deactivates | |
| 248 | the screen lock on one or more | |
| 249 | sessions, if the session supports it.</para></listitem> | |
| 250 | </varlistentry> | |
| 251 | ||
| 7212a8a9 LP |
252 | <varlistentry> |
| 253 | <term><command>lock-sessions</command></term> | |
| b6160029 | 254 | <term><command>unlock-sessions</command></term> |
| 7212a8a9 | 255 | |
| b6160029 LP |
256 | <listitem><para>Activates/deactivates |
| 257 | the screen lock on all current | |
| 258 | sessions supporting | |
| 259 | it.</para></listitem> | |
| 7212a8a9 LP |
260 | </varlistentry> |
| 261 | ||
| a61933ad LP |
262 | <varlistentry> |
| 263 | <term><command>terminate-session [ID...]</command></term> | |
| 264 | ||
| 265 | <listitem><para>Terminates a | |
| 266 | session. This kills all processes of | |
| 267 | the session and deallocates all | |
| 268 | resources attached to the | |
| 269 | session.</para></listitem> | |
| 270 | </varlistentry> | |
| 271 | ||
| 272 | <varlistentry> | |
| 273 | <term><command>kill-session [ID...]</command></term> | |
| 274 | ||
| 275 | <listitem><para>Send a signal to one | |
| 276 | or more processes of the session. Use | |
| 277 | <option>--kill-who=</option> to select | |
| 278 | which process to kill. Use | |
| 279 | <option>--signal=</option> to select | |
| 280 | the signal to send.</para></listitem> | |
| 281 | </varlistentry> | |
| 282 | ||
| 283 | <varlistentry> | |
| 284 | <term><command>list-users</command></term> | |
| 285 | ||
| 286 | <listitem><para>List currently logged | |
| 287 | in users.</para></listitem> | |
| 288 | </varlistentry> | |
| 289 | ||
| 290 | <varlistentry> | |
| 291 | <term><command>user-status [USER...]</command></term> | |
| 292 | ||
| 293 | <listitem><para>Show terse runtime | |
| 294 | status information about one or more | |
| 295 | logged in users. This function is | |
| 296 | intended to generate human-readable | |
| 297 | output. If you are looking for | |
| 298 | computer-parsable output, use | |
| 299 | <command>show-user</command> | |
| 300 | instead. Users may be specified by | |
| 301 | their usernames or numeric user | |
| 302 | IDs.</para></listitem> | |
| 303 | </varlistentry> | |
| 304 | ||
| 305 | <varlistentry> | |
| 306 | <term><command>show-user [USER...]</command></term> | |
| 307 | ||
| 308 | <listitem><para>Show properties of one | |
| 309 | or more users or the manager | |
| 310 | itself. If no argument is specified | |
| 311 | properties of the manager will be | |
| 312 | shown. If a user is specified | |
| 313 | properties of the user is shown. By | |
| 314 | default, empty properties are | |
| 315 | suppressed. Use <option>--all</option> | |
| 316 | to show those too. To select specific | |
| 317 | properties to show use | |
| 318 | <option>--property=</option>. This | |
| 319 | command is intended to be used | |
| 320 | whenever computer-parsable output is | |
| 321 | required. Use | |
| 322 | <command>user-status</command> if | |
| 323 | you are looking for formatted | |
| 324 | human-readable | |
| 325 | output.</para></listitem> | |
| 326 | </varlistentry> | |
| 327 | ||
| 328 | <varlistentry> | |
| 329 | <term><command>enable-linger [USER...]</command></term> | |
| 330 | <term><command>disable-linger [USER...]</command></term> | |
| 331 | ||
| 332 | <listitem><para>Enable/disable user | |
| 333 | lingering for one or more users. If | |
| 334 | enabled for a specific user a user | |
| 335 | manager is spawned for him/her at | |
| 336 | boot, and kept around after | |
| 337 | logouts. This allows users who aren't | |
| 338 | logged in to run long-running | |
| 339 | services.</para></listitem> | |
| 340 | </varlistentry> | |
| 341 | ||
| 342 | <varlistentry> | |
| 343 | <term><command>terminate-user [USER...]</command></term> | |
| 344 | ||
| 345 | <listitem><para>Terminates all | |
| 346 | sessions of a user. This kills all | |
| 347 | processes of all sessions of the user | |
| 348 | and deallocates all runtime resources | |
| 349 | attached to the | |
| 350 | user.</para></listitem> | |
| 351 | </varlistentry> | |
| 352 | ||
| 353 | <varlistentry> | |
| 354 | <term><command>kill-user [USER...]</command></term> | |
| 355 | ||
| 356 | <listitem><para>Send a signal to all | |
| 357 | processes of a user. Use | |
| 358 | <option>--signal=</option> to select | |
| 359 | the signal to send.</para></listitem> | |
| 360 | </varlistentry> | |
| 361 | ||
| 362 | <varlistentry> | |
| 363 | <term><command>list-seats</command></term> | |
| 364 | ||
| 365 | <listitem><para>List currently | |
| 366 | available seats on the local | |
| 367 | system.</para></listitem> | |
| 368 | </varlistentry> | |
| 369 | ||
| 370 | <varlistentry> | |
| 371 | <term><command>seat-status [NAME...]</command></term> | |
| 372 | ||
| 373 | <listitem><para>Show terse runtime | |
| 374 | status information about one or more | |
| 375 | seats. This function is | |
| 376 | intended to generate human-readable | |
| 377 | output. If you are looking for | |
| 378 | computer-parsable output, use | |
| 379 | <command>show-seat</command> | |
| 380 | instead.</para></listitem> | |
| 381 | </varlistentry> | |
| 382 | ||
| 383 | <varlistentry> | |
| 384 | <term><command>show-seat [NAME...]</command></term> | |
| 385 | ||
| 386 | <listitem><para>Show properties of one | |
| 387 | or more seats or the manager | |
| 388 | itself. If no argument is specified | |
| 389 | properties of the manager will be | |
| 390 | shown. If a seat is specified | |
| 391 | properties of the seat are shown. By | |
| 392 | default, empty properties are | |
| 393 | suppressed. Use <option>--all</option> | |
| 394 | to show those too. To select specific | |
| 395 | properties to show use | |
| 396 | <option>--property=</option>. This | |
| 397 | command is intended to be used | |
| 398 | whenever computer-parsable output is | |
| 399 | required. Use | |
| 400 | <command>seat-status</command> if you | |
| 401 | are looking for formatted | |
| 402 | human-readable | |
| 403 | output.</para></listitem> | |
| 404 | </varlistentry> | |
| 405 | ||
| 406 | <varlistentry> | |
| 407 | <term><command>attach [NAME] [DEVICE...]</command></term> | |
| 408 | ||
| 490d99e9 LP |
409 | <listitem><para>Persistently attach |
| 410 | one or more devices to a seat. The | |
| 411 | devices should be specified via device | |
| 412 | paths in the <filename>/sys</filename> | |
| 413 | file system. To create a new seat | |
| 414 | attach at least one graphics card to a | |
| bb31a4ac | 415 | previously unused seat name. Seat |
| a61933ad LP |
416 | names may consist only of a-z, A-Z, |
| 417 | 0-9, "-" and "_" and must be prefixed | |
| 418 | with "seat". To drop assignment of a | |
| 419 | device to a specific seat just | |
| 420 | reassign it to a different seat, or | |
| 421 | use | |
| 422 | <command>flush-devices</command>.</para></listitem> | |
| 423 | </varlistentry> | |
| 424 | ||
| 425 | <varlistentry> | |
| 426 | <term><command>flush-devices</command></term> | |
| 427 | ||
| 428 | <listitem><para>Removes all device | |
| 429 | assignments previously created with | |
| 430 | <command>attach</command>. After this | |
| 431 | call only automatically generated | |
| 432 | seats will remain and all seat | |
| 433 | hardware is assigned to | |
| 434 | them.</para></listitem> | |
| 435 | </varlistentry> | |
| 436 | ||
| 437 | <varlistentry> | |
| 438 | <term><command>terminate-seat [NAME...]</command></term> | |
| 439 | ||
| 440 | <listitem><para>Terminates all | |
| 441 | sessions on a seat. This kills all | |
| 442 | processes of all sessions on a seat and | |
| 443 | deallocates all runtime resources | |
| 444 | attached to them.</para></listitem> | |
| 445 | </varlistentry> | |
| 446 | </variablelist> | |
| 447 | ||
| 448 | </refsect1> | |
| 449 | ||
| 450 | <refsect1> | |
| 451 | <title>Exit status</title> | |
| 452 | ||
| 453 | <para>On success 0 is returned, a non-zero failure | |
| 454 | code otherwise.</para> | |
| 455 | </refsect1> | |
| 456 | ||
| 457 | <refsect1> | |
| 458 | <title>Environment</title> | |
| 459 | ||
| ccc9a4f9 | 460 | <variablelist class='environment-variables'> |
| a61933ad LP |
461 | <varlistentry> |
| 462 | <term><varname>$SYSTEMD_PAGER</varname></term> | |
| 463 | <listitem><para>Pager to use when | |
| 464 | <option>--no-pager</option> is not given; | |
| 465 | overrides <varname>$PAGER</varname>. Setting | |
| 466 | this to an empty string or the value | |
| 467 | <literal>cat</literal> is equivalent to passing | |
| 468 | <option>--no-pager</option>.</para></listitem> | |
| 469 | </varlistentry> | |
| 470 | </variablelist> | |
| 471 | </refsect1> | |
| 472 | ||
| 473 | <refsect1> | |
| 474 | <title>See Also</title> | |
| 475 | <para> | |
| 476 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
| 4e2d4c08 | 477 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
| af3bccd6 | 478 | <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
| 18b754d3 | 479 | <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
| a61933ad LP |
480 | </para> |
| 481 | </refsect1> | |
| 482 | ||
| 483 | </refentry> |