man/loginctl.xml

   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 elogind.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   elogind 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.
  14
  15   elogind 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.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with elogind; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <!-- 0 /// elogind does not need to activate loginctl in configure
  25 <refentry id="loginctl" conditional='ENABLE_LOGIND'
  26     xmlns:xi="http://www.w3.org/2001/XInclude">
  27 else -->
  28 <refentry id="loginctl" xmlns:xi="http://www.w3.org/2001/XInclude">
  29 <!-- // 0 -->
  30
  31   <refentryinfo>
  32     <title>loginctl</title>
  33     <productname>elogind</productname>
  34
  35     <authorgroup>
  36       <author>
  37         <contrib>Developer</contrib>
  38         <firstname>Lennart</firstname>
  39         <surname>Poettering</surname>
  40         <email>lennart@poettering.net</email>
  41       </author>
  42     </authorgroup>
  43   </refentryinfo>
  44
  45   <refmeta>
  46     <refentrytitle>loginctl</refentrytitle>
  47     <manvolnum>1</manvolnum>
  48   </refmeta>
  49
  50   <refnamediv>
  51     <refname>loginctl</refname>
  52     <refpurpose>Control the elogind login manager</refpurpose>
  53   </refnamediv>
  54
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>loginctl</command>
  58       <arg choice="opt" rep="repeat">OPTIONS</arg>
  59       <arg choice="req">COMMAND</arg>
  60       <arg choice="opt" rep="repeat">NAME</arg>
  61     </cmdsynopsis>
  62   </refsynopsisdiv>
  63
  64   <refsect1>
  65     <title>Description</title>
  66
  67     <para><command>loginctl</command> may be used to introspect and
  68     control the state of the
  69     <!-- 0 /// elogind has no services and is in section 8
  70     <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  71     login manager
  72     <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  73     --><!-- else -->
  74     <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  75     login manager</para>
  76     <!-- // 0 -->
  77   </refsect1>
  78
  79   <refsect1>
  80     <title>Options</title>
  81
  82     <para>The following options are understood:</para>
  83
  84     <variablelist>
  85       <varlistentry>
  86         <term><option>--no-ask-password</option></term>
  87
  88         <listitem><para>Do not query the user for authentication for
  89         privileged operations.</para></listitem>
  90       </varlistentry>
  91
  92       <varlistentry>
  93         <term><option>-p</option></term>
  94         <term><option>--property=</option></term>
  95
  96         <listitem><para>When showing session/user/seat properties,
  97         limit display to certain properties as specified as argument.
  98         If not specified, all set properties are shown. The argument
  99         should be a property name, such as
 100         <literal>Sessions</literal>. If specified more than once, all
 101         properties with the specified names are
 102         shown.</para></listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term><option>--value</option></term>
 107
 108         <listitem>
 109           <para>When printing properties with <command>show</command>,
 110           only print the value, and skip the property name and
 111           <literal>=</literal>.</para>
 112         </listitem>
 113       </varlistentry>
 114
 115       <varlistentry>
 116         <term><option>-a</option></term>
 117         <term><option>--all</option></term>
 118
 119         <listitem><para>When showing session/user/seat properties,
 120         show all properties regardless of whether they are set or
 121         not.</para></listitem>
 122       </varlistentry>
 123
 124       <varlistentry>
 125         <term><option>-l</option></term>
 126         <term><option>--full</option></term>
 127
 128         <listitem><para>Do not ellipsize process tree entries.</para>
 129         </listitem>
 130       </varlistentry>
 131
 132       <varlistentry>
 133         <term><option>--kill-who=</option></term>
 134
 135         <listitem><para>When used with
 136         <command>kill-session</command>, choose which processes to
 137         kill. Must be one of <option>leader</option>, or
 138         <option>all</option> to select whether to kill only the leader
 139         process of the session or all processes of the session. If
 140         omitted, defaults to <option>all</option>.</para></listitem>
 141       </varlistentry>
 142
 143       <varlistentry>
 144         <term><option>-s</option></term>
 145         <term><option>--signal=</option></term>
 146
 147         <listitem><para>When used with <command>kill-session</command>
 148         or <command>kill-user</command>, choose which signal to send
 149         to selected processes. Must be one of the well known signal
 150         specifiers, such as <constant>SIGTERM</constant>,
 151         <constant>SIGINT</constant> or <constant>SIGSTOP</constant>.
 152         If omitted, defaults to
 153         <constant>SIGTERM</constant>.</para></listitem>
 154       </varlistentry>
 155
 156       <!-- 0 /// elogind does not support systemd-journal
 157       <varlistentry>
 158         <term><option>-n</option></term>
 159         <term><option>--lines=</option></term>
 160
 161         <listitem><para>When used with <command>user-status</command>
 162         and <command>session-status</command>, controls the number of
 163         journal lines to show, counting from the most recent ones.
 164         Takes a positive integer argument. Defaults to 10.</para>
 165         </listitem>
 166       </varlistentry>
 167
 168       <varlistentry>
 169         <term><option>-o</option></term>
 170         <term><option>--output=</option></term>
 171
 172         <listitem><para>When used with <command>user-status</command>
 173         and <command>session-status</command>, controls the formatting
 174         of the journal entries that are shown. For the available
 175         choices, see
 176         <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 177         Defaults to <literal>short</literal>.</para></listitem>
 178       </varlistentry>
 179       // 0 -->
 180
 181       <xi:include href="user-system-options.xml" xpointer="host" />
 182       <xi:include href="user-system-options.xml" xpointer="machine" />
 183
 184       <xi:include href="standard-options.xml" xpointer="no-pager" />
 185       <xi:include href="standard-options.xml" xpointer="no-legend" />
 186       <xi:include href="standard-options.xml" xpointer="help" />
 187       <xi:include href="standard-options.xml" xpointer="version" />
 188     </variablelist>
 189   </refsect1>
 190
 191   <refsect1>
 192     <title>Commands</title>
 193
 194     <para>The following commands are understood:</para>
 195
 196     <refsect2><title>Session Commands</title><variablelist>
 197
 198       <varlistentry>
 199         <term><command>list-sessions</command></term>
 200
 201         <listitem><para>List current sessions.</para></listitem>
 202       </varlistentry>
 203
 204       <varlistentry>
 205         <term><command>session-status</command> <optional><replaceable>ID</replaceable>…</optional></term>
 206
 207         <listitem><para>Show terse runtime status information about
 208         one or more sessions, followed by the most recent log data
 209         from the journal. Takes one or more session identifiers as
 210         parameters. If no session identifiers are passed, the status of
 211         the caller's session is shown. This function is intended to
 212         generate human-readable output. If you are looking for
 213         computer-parsable output, use <command>show-session</command>
 214         instead.</para></listitem>
 215       </varlistentry>
 216
 217       <varlistentry>
 218         <term><command>show-session</command> <optional><replaceable>ID</replaceable>…</optional></term>
 219
 220         <listitem><para>Show properties of one or more sessions or the
 221         manager itself. If no argument is specified, properties of the
 222         manager will be shown. If a session ID is specified,
 223         properties of the session are shown. By default, empty
 224         properties are suppressed. Use <option>--all</option> to show
 225         those too. To select specific properties to show, use
 226         <option>--property=</option>. This command is intended to be
 227         used whenever computer-parsable output is required. Use
 228         <command>session-status</command> if you are looking for
 229         formatted human-readable output.</para></listitem>
 230       </varlistentry>
 231
 232       <varlistentry>
 233         <term><command>activate</command> <optional><replaceable>ID</replaceable></optional></term>
 234
 235         <listitem><para>Activate a session. This brings a session into
 236         the foreground if another session is currently in the
 237         foreground on the respective seat. Takes a session identifier
 238         as argument. If no argument is specified, the session of the
 239         caller is put into foreground.</para></listitem>
 240       </varlistentry>
 241
 242       <varlistentry>
 243         <term><command>lock-session</command> <optional><replaceable>ID</replaceable>…</optional></term>
 244         <term><command>unlock-session</command> <optional><replaceable>ID</replaceable>…</optional></term>
 245
 246         <listitem><para>Activates/deactivates the screen lock on one
 247         or more sessions, if the session supports it. Takes one or
 248         more session identifiers as arguments. If no argument is
 249         specified, the session of the caller is locked/unlocked.
 250         </para></listitem>
 251       </varlistentry>
 252
 253       <varlistentry>
 254         <term><command>lock-sessions</command></term>
 255         <term><command>unlock-sessions</command></term>
 256
 257         <listitem><para>Activates/deactivates the screen lock on all
 258         current sessions supporting it. </para></listitem>
 259       </varlistentry>
 260
 261       <varlistentry>
 262         <term><command>terminate-session</command> <replaceable>ID</replaceable>…</term>
 263
 264         <listitem><para>Terminates a session. This kills all processes
 265         of the session and deallocates all resources attached to the
 266         session. </para></listitem>
 267       </varlistentry>
 268
 269       <varlistentry>
 270         <term><command>kill-session</command> <replaceable>ID</replaceable>…</term>
 271
 272         <listitem><para>Send a signal to one or more processes of the
 273         session. Use <option>--kill-who=</option> to select which
 274         process to kill. Use <option>--signal=</option> to select the
 275         signal to send.</para></listitem>
 276       </varlistentry>
 277     </variablelist></refsect2>
 278
 279     <refsect2><title>User Commands</title><variablelist>
 280       <varlistentry>
 281         <term><command>list-users</command></term>
 282
 283         <listitem><para>List currently logged in users.
 284         </para></listitem>
 285       </varlistentry>
 286
 287       <varlistentry>
 288         <term><command>user-status</command> <optional><replaceable>USER</replaceable>…</optional></term>
 289
 290         <listitem><para>Show terse runtime status information about
 291         one or more logged in users, followed by the most recent log
 292         data from the journal. Takes one or more user names or numeric
 293         user IDs as parameters. If no parameters are passed, the status
 294         is shown for the user of the session of the caller. This
 295         function is intended to generate human-readable output. If you
 296         are looking for computer-parsable output, use
 297         <command>show-user</command> instead.</para></listitem>
 298       </varlistentry>
 299
 300       <varlistentry>
 301         <term><command>show-user</command> <optional><replaceable>USER</replaceable>…</optional></term>
 302
 303         <listitem><para>Show properties of one or more users or the
 304         manager itself. If no argument is specified, properties of the
 305         manager will be shown. If a user is specified, properties of
 306         the user are shown. By default, empty properties are
 307         suppressed. Use <option>--all</option> to show those too. To
 308         select specific properties to show, use
 309         <option>--property=</option>. This command is intended to be
 310         used whenever computer-parsable output is required. Use
 311         <command>user-status</command> if you are looking for
 312         formatted human-readable output.</para></listitem>
 313       </varlistentry>
 314
 315       <varlistentry>
 316         <term><command>enable-linger</command> <optional><replaceable>USER</replaceable>…</optional></term>
 317         <term><command>disable-linger</command> <optional><replaceable>USER</replaceable>…</optional></term>
 318
 319         <listitem><para>Enable/disable user lingering for one or more
 320         users. If enabled for a specific user, a user manager is
 321         spawned for the user at boot and kept around after logouts.
 322         This allows users who are not logged in to run long-running
 323         services. Takes one or more user names or numeric UIDs as
 324         argument. If no argument is specified, enables/disables
 325         lingering for the user of the session of the caller.</para>
 326
 327         <para>See also <varname>KillUserProcesses=</varname> setting in
 328         <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 329         </para></listitem>
 330       </varlistentry>
 331
 332       <varlistentry>
 333         <term><command>terminate-user</command> <replaceable>USER</replaceable>…</term>
 334
 335         <listitem><para>Terminates all sessions of a user. This kills
 336         all processes of all sessions of the user and deallocates all
 337         runtime resources attached to the user.</para></listitem>
 338       </varlistentry>
 339
 340       <varlistentry>
 341         <term><command>kill-user</command> <replaceable>USER</replaceable>…</term>
 342
 343         <listitem><para>Send a signal to all processes of a user. Use
 344         <option>--signal=</option> to select the signal to send.
 345         </para></listitem>
 346       </varlistentry>
 347     </variablelist></refsect2>
 348
 349     <refsect2><title>Seat Commands</title><variablelist>
 350       <varlistentry>
 351         <term><command>list-seats</command></term>
 352
 353         <listitem><para>List currently available seats on the local
 354         system.</para></listitem>
 355       </varlistentry>
 356
 357       <varlistentry>
 358         <term><command>seat-status</command> <optional><replaceable>NAME</replaceable>…</optional></term>
 359
 360         <listitem><para>Show terse runtime status information about
 361         one or more seats. Takes one or more seat names as parameters.
 362         If no seat names are passed the status of the caller's
 363         session's seat is shown. This function is intended to generate
 364         human-readable output. If you are looking for
 365         computer-parsable output, use <command>show-seat</command>
 366         instead.</para></listitem>
 367       </varlistentry>
 368
 369       <varlistentry>
 370         <term><command>show-seat</command> <optional><replaceable>NAME</replaceable>…</optional></term>
 371
 372         <listitem><para>Show properties of one or more seats or the
 373         manager itself. If no argument is specified, properties of the
 374         manager will be shown. If a seat is specified, properties of
 375         the seat are shown. By default, empty properties are
 376         suppressed. Use <option>--all</option> to show those too. To
 377         select specific properties to show, use
 378         <option>--property=</option>. This command is intended to be
 379         used whenever computer-parsable output is required. Use
 380         <command>seat-status</command> if you are looking for
 381         formatted human-readable output.</para></listitem>
 382       </varlistentry>
 383
 384       <varlistentry>
 385         <term><command>attach</command> <replaceable>NAME</replaceable> <replaceable>DEVICE</replaceable>…</term>
 386
 387         <listitem><para>Persistently attach one or more devices to a
 388         seat. The devices should be specified via device paths in the
 389         <filename>/sys</filename> file system. To create a new seat,
 390         attach at least one graphics card to a previously unused seat
 391         name. Seat names may consist only of a–z, A–Z, 0–9,
 392         <literal>-</literal> and <literal>_</literal> and must be
 393         prefixed with <literal>seat</literal>. To drop assignment of a
 394         device to a specific seat, just reassign it to a different
 395         seat, or use <command>flush-devices</command>.
 396         </para></listitem>
 397       </varlistentry>
 398
 399       <varlistentry>
 400         <term><command>flush-devices</command></term>
 401
 402         <listitem><para>Removes all device assignments previously
 403         created with <command>attach</command>. After this call, only
 404         automatically generated seats will remain, and all seat
 405         hardware is assigned to them.</para></listitem>
 406       </varlistentry>
 407
 408       <varlistentry>
 409         <term><command>terminate-seat</command> <replaceable>NAME</replaceable>…</term>
 410
 411         <listitem><para>Terminates all sessions on a seat. This kills
 412         all processes of all sessions on the seat and deallocates all
 413         runtime resources attached to them.</para></listitem>
 414       </varlistentry>
 415     </variablelist></refsect2>
 416
 417     <!-- 1 /// elogind additionally supports a few systemctl commands. -->
 418     <refsect2><title>System Commands</title><variablelist>
 419       <varlistentry>
 420         <term><command>poweroff</command></term>
 421
 422         <listitem>
 423           <para>Print a wall message to all users, shut down and
 424             power-off the system.</para>
 425         </listitem>
 426       </varlistentry>
 427       <varlistentry>
 428         <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
 429
 430         <listitem>
 431           <para>Print a wall message to all users, shut down and
 432             reboot the system.</para>
 433
 434           <para>If the optional argument
 435           <replaceable>arg</replaceable> is given, it will be passed
 436           as the optional argument to the
 437           <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
 438           system call. The value is architecture and firmware
 439           specific. As an example, <literal>recovery</literal> might
 440           be used to trigger system recovery, and
 441           <literal>fota</literal> might be used to trigger a
 442           <quote>firmware over the air</quote> update.</para>
 443         </listitem>
 444       </varlistentry>
 445
 446       <varlistentry>
 447         <term><command>suspend</command></term>
 448
 449         <listitem>
 450           <para>Suspend the system.
 451           </para>
 452         </listitem>
 453       </varlistentry>
 454
 455       <varlistentry>
 456         <term><command>hibernate</command></term>
 457
 458         <listitem>
 459           <para>Hibernate the system.
 460           </para>
 461         </listitem>
 462       </varlistentry>
 463
 464       <varlistentry>
 465         <term><command>hybrid-sleep</command></term>
 466
 467         <listitem>
 468           <para>Hibernate and suspend the system.</para>
 469         </listitem>
 470       </varlistentry>
 471     </variablelist></refsect2>
 472     <!-- // 1 -->
 473   </refsect1>
 474
 475   <refsect1>
 476     <title>Exit status</title>
 477
 478     <para>On success, 0 is returned, a non-zero failure code
 479     otherwise.</para>
 480   </refsect1>
 481
 482   <refsect1>
 483     <title>Examples</title>
 484
 485     <example>
 486       <title>Querying user status</title>
 487
 488       <programlisting>$ loginctl user-status
 489 fatima (1005)
 490            Since: Sat 2016-04-09 14:23:31 EDT; 54min ago
 491            State: active
 492         Sessions: 5 *3
 493             Unit: user-1005.slice
 494                   ├─user@1005.service
 495                     …
 496                   ├─session-3.scope
 497                     …
 498                   └─session-5.scope
 499                     ├─3473 login -- fatima
 500                     └─3515 -zsh
 501
 502 Apr 09 14:40:30 laptop login[2325]: pam_unix(login:session):
 503                        session opened for user fatima by LOGIN(uid=0)
 504 Apr 09 14:40:30 laptop login[2325]: LOGIN ON tty3 BY fatima
 505 </programlisting>
 506
 507       <para>There are two sessions, 3 and 5. Session 3 is a graphical session,
 508       marked with a star. The tree of processing including the two corresponding
 509       scope units and the user manager unit are shown.</para>
 510     </example>
 511   </refsect1>
 512
 513   <xi:include href="less-variables.xml" />
 514
 515   <refsect1>
 516     <title>See Also</title>
 517     <para>
 518       <!-- 0 /// elogind is in section 8
 519       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 520       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 521       <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 522       --><!-- else -->
 523       <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 524       <!-- // 0 -->
 525       <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 526     </para>
 527   </refsect1>
 528
 529 </refentry>