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