loginctl.xml revision 6bb92a169e8a65e7def5545798001e0dbecc7d4f
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen This file is part of systemd.
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen Copyright 2010 Lennart Poettering
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen systemd is free software; you can redistribute it and/or modify it
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen under the terms of the GNU General Public License as published by
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen the Free Software Foundation; either version 2 of the License, or
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen (at your option) any later version.
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen systemd is distributed in the hope that it will be useful, but
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen WITHOUT ANY WARRANTY; without even the implied warranty of
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen General Public License for more details.
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen You should have received a copy of the GNU General Public License
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen along with systemd; If not, see <http://www.gnu.org/licenses/>.
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <refentryinfo>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <authorgroup>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </authorgroup>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </refentryinfo>
aba496a58acf9d9c61314de71353550e579f85eeUmut Tezduyar Lindskog <refpurpose>Control the systemd login manager</refpurpose>
1a436809498faf6486815baa0338fb6b8e5def07Tom Gundersen </refnamediv>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <refsynopsisdiv>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <cmdsynopsis>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <command>loginctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </cmdsynopsis>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering </refsynopsisdiv>
769d324c99aab129148bd25f5f663ef441287d86Lennart Poettering <para><command>loginctl</command> may be used to
769d324c99aab129148bd25f5f663ef441287d86Lennart Poettering introspect and control the state of the
769d324c99aab129148bd25f5f663ef441287d86Lennart Poettering <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
769d324c99aab129148bd25f5f663ef441287d86Lennart Poettering login manager.</para>
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen <para>The following options are understood:</para>
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen <variablelist>
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen <varlistentry>
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta </varlistentry>
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta <varlistentry>
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta </varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen display to certain properties as
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen specified as argument. If not
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen specified all set properties are
edb85f0d8d0a84f27308a3728f3fde3c52b9dce2Susant Sahani shown. The argument should be a
edb85f0d8d0a84f27308a3728f3fde3c52b9dce2Susant Sahani property name, such as
2cc412b59353576cece2d5b30c6a39c70552f0a0Tom Gundersen specified more than once all
2cc412b59353576cece2d5b30c6a39c70552f0a0Tom Gundersen properties with the specified names
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
1a436809498faf6486815baa0338fb6b8e5def07Tom Gundersen <varlistentry>
4f882b2a5007e51032459e29d15a86df6b5ea9f4Tom Gundersen properties regardless whether they are
ad0734e890b25751ef8229e47210ff11ae8fa3f3Tom Gundersen </varlistentry>
eb27aeca247a4cf8816fffc4c0dbcab55ead3864Tom Gundersen <varlistentry>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <listitem><para>Do not pipe output into a
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
dd43110f781a9245ec00531456fee68ed763a179Tom Gundersen <varlistentry>
e1853b00ef7cb56cafd908327dd44b3ab48b402cSusant Sahani <term><option>--no-ask-password</option></term>
5a8bcb674f71a20e95df55319b34c556638378ceLennart Poettering for authentication for privileged
c106cc36b9b8e8998eb95299b02f1db9c1209122Tom Gundersen </varlistentry>
c106cc36b9b8e8998eb95299b02f1db9c1209122Tom Gundersen <varlistentry>
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta choose which processes to kill. Must
6ae115c1fe95611b39d2f20cfcea3d385429f59eTom Gundersen to kill only the leader process of the
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta session or all processes of the
6ae115c1fe95611b39d2f20cfcea3d385429f59eTom Gundersen session. If omitted defaults to
6192b846ca0d15602e94ddb5da4420b7c60d64a5Tom Gundersen </varlistentry>
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen <varlistentry>
16aa63a00b5b1db23a9c0b8de350ebf482d90cd0Tom Gundersen which signal to send to selected
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen processes. Must be one of the well
0dd25fb9f005d8ab7ac4bc10a609d00569f8c56aLennart Poettering known signal specifiers such as
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen SIGTERM, SIGINT or SIGSTOP. If omitted
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
eb0ea358b688a6f83ff305c6b825c61f12b6dcb8Tom Gundersen <varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen remotely. Specify a hostname, or
fd6d906cf46ecef45ebbb5a361e1dc436f031d7aLennart Poettering username and hostname separated by @,
5a8bcb674f71a20e95df55319b34c556638378ceLennart Poettering to connect to. This will use SSH to
3d3d425547a3f38473fcf8737b85dfebb630479dTom Gundersen talk to the remote login manager
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <varlistentry>
9e7e440835c43d81ffdbc299d2c07daaa641ed50Tom Gundersen PolicyKit before executing the
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog </varlistentry>
28cc555d8504c9429776aedbbe1fee7101258578Dan Williams </variablelist>
5d3de3fe9cc452f1bfe3c2dcafecbd7f904da4dcLennart Poettering <para>The following commands are understood:</para>
9e7e440835c43d81ffdbc299d2c07daaa641ed50Tom Gundersen <variablelist>
46b0c76e2c355c0d0cc4792abb98cde07b28bc53Emil Renner Berthing <varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <listitem><para>List current sessions.</para></listitem>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering <varlistentry>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering <term><command>session-status [ID...]</command></term>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering status information about one or more
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering sessions. This function is intended to
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering generate human-readable output. If you
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering are looking for computer-parsable
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
9c0a72f961e00b0447767973e7117e131bea5b5dTom Gundersen <varlistentry>
1346b1f0388f4100bb3c2a2bb23bc881769c020cTom Gundersen <term><command>show-session [ID...]</command></term>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen or more sessions or the manager
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen itself. If no argument is specified
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen properties of the manager will be
6a24f1484fcc1f59f89617afbe4282667a358eabTom Gundersen shown. If a session ID is specified
6a24f1484fcc1f59f89617afbe4282667a358eabTom Gundersen properties of the session is shown. By
bbf7c04821a71fec67eaf0e7a34d17afc5913c13Tom Gundersen default, empty properties are
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen to show those too. To select specific
52433f6b65eccd1c54606dde999610640f3458acTom Gundersen properties to show use
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering command is intended to be used
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen whenever computer-parsable output is
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen required. Use
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen you are looking for formatted
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <term><command>activate [ID...]</command></term>
02b59d57e0c08231645120077f651151f5bb2babTom Gundersen sessions. This brings one or more
02b59d57e0c08231645120077f651151f5bb2babTom Gundersen sessions into the foreground, if
505f8da7325591defe5f751f328bd26915267602Tom Gundersen another session is currently in the
45af44d47da6933b260c734ad9ff721f63f80a4dTom Gundersen foreground on the respective
bbf7c04821a71fec67eaf0e7a34d17afc5913c13Tom Gundersen </varlistentry>
0dd25fb9f005d8ab7ac4bc10a609d00569f8c56aLennart Poettering <varlistentry>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering <term><command>lock-session [ID...]</command></term>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <term><command>unlock-session [ID...]</command></term>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen the screen lock on one or more
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen sessions, if the session supports it.</para></listitem>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <term><command>terminate-session [ID...]</command></term>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen session. This kills all processes of
505f8da7325591defe5f751f328bd26915267602Tom Gundersen the session and deallocates all
505f8da7325591defe5f751f328bd26915267602Tom Gundersen resources attached to the
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
69a93e7db47addc4495a6ec9dc0fc74092a6ebeeTom Gundersen <varlistentry>
02b59d57e0c08231645120077f651151f5bb2babTom Gundersen <term><command>kill-session [ID...]</command></term>
6192b846ca0d15602e94ddb5da4420b7c60d64a5Tom Gundersen or more processes of the session. Use
6192b846ca0d15602e94ddb5da4420b7c60d64a5Tom Gundersen which process to kill. Use
6192b846ca0d15602e94ddb5da4420b7c60d64a5Tom Gundersen </varlistentry>
6192b846ca0d15602e94ddb5da4420b7c60d64a5Tom Gundersen <varlistentry>
7951dea20911969287878e6897b3eca348721adeSusant Sahani </varlistentry>
7951dea20911969287878e6897b3eca348721adeSusant Sahani <varlistentry>
7951dea20911969287878e6897b3eca348721adeSusant Sahani <term><command>user-status [USER...]</command></term>
7951dea20911969287878e6897b3eca348721adeSusant Sahani status information about one or more
7951dea20911969287878e6897b3eca348721adeSusant Sahani logged in users. This function is
7951dea20911969287878e6897b3eca348721adeSusant Sahani intended to generate human-readable
7951dea20911969287878e6897b3eca348721adeSusant Sahani output. If you are looking for
7951dea20911969287878e6897b3eca348721adeSusant Sahani computer-parsable output, use
7951dea20911969287878e6897b3eca348721adeSusant Sahani instead. Users may be specified by
7951dea20911969287878e6897b3eca348721adeSusant Sahani their usernames or numeric user
7951dea20911969287878e6897b3eca348721adeSusant Sahani </varlistentry>
7951dea20911969287878e6897b3eca348721adeSusant Sahani <varlistentry>
7951dea20911969287878e6897b3eca348721adeSusant Sahani <term><command>show-user [USER...]</command></term>
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani or more users or the manager
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani itself. If no argument is specified
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani properties of the manager will be
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani shown. If a user is specified
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani properties of the user is shown. By
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani default, empty properties are
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani to show those too. To select specific
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani properties to show use
85a8eeee36b57c1ab382b0225fa9a87525bbeee9Susant Sahani command is intended to be used
02b59d57e0c08231645120077f651151f5bb2babTom Gundersen whenever computer-parsable output is
c0dda18697e0994272c0c9616d36f6777b60e2c7Tom Gundersen required. Use
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen you are looking for formatted
f048a16b464295a4e0a4f4c1210f06343ad31231Tom Gundersen human-readable
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen </varlistentry>
5c1d3fc93d91384bbac29adf01074fa4375317eaUmut Tezduyar Lindskog <term><command>enable-linger [USER...]</command></term>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <term><command>disable-linger [USER...]</command></term>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen lingering for one or more users. If
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen enabled for a specific user a user
71a6151083d842b2f5bf04e50239f0bf85d34d2eTom Gundersen boot, and kept around after
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen logouts. This allows users who aren't
6ae115c1fe95611b39d2f20cfcea3d385429f59eTom Gundersen logged in to run long-running
6ae115c1fe95611b39d2f20cfcea3d385429f59eTom Gundersen </varlistentry>
5d8e593dce074bff966fc0a46579c61b4f3bc33aSusant Sahani <varlistentry>
5d8e593dce074bff966fc0a46579c61b4f3bc33aSusant Sahani <term><command>terminate-user [USER...]</command></term>
f048a16b464295a4e0a4f4c1210f06343ad31231Tom Gundersen sessions of a user. This kills all
f048a16b464295a4e0a4f4c1210f06343ad31231Tom Gundersen processes of all sessions of the user
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen and deallocates all runtime resources
f882c247ad59776c3a7753bb963c1f8e2386cb79Tom Gundersen attached to the
407fe036a24834203aca6c1eec7d74d9ad3e9ee0Tom Gundersen </varlistentry>
5a8bcb674f71a20e95df55319b34c556638378ceLennart Poettering <varlistentry>
9505d3c6deda0452c22ab2ed47bca74b98d87a17Tom Gundersen <term><command>kill-user [USER...]</command></term>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen processes of a user. Use
71a6151083d842b2f5bf04e50239f0bf85d34d2eTom Gundersen </varlistentry>
f579559b3a14c1f1ef96c372e7626c4733e6ef7dTom Gundersen <varlistentry>
eb0ea358b688a6f83ff305c6b825c61f12b6dcb8Tom Gundersen available seats on the local
6ae115c1fe95611b39d2f20cfcea3d385429f59eTom Gundersen </varlistentry>
6ae115c1fe95611b39d2f20cfcea3d385429f59eTom Gundersen <varlistentry>
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta <term><command>seat-status [NAME...]</command></term>
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta status information about one or more
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta seats. This function is
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta intended to generate human-readable
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta output. If you are looking for
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta computer-parsable output, use
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta </varlistentry>
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta <varlistentry>
b98b483bac585af754e8a22ea890db8486905d8aAlin Rauta <term><command>show-seat [NAME...]</command></term>
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen or more seats or the manager
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen itself. If no argument is specified
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen properties of the manager will be
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen shown. If a seat is specified
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen properties of the seat are shown. By
ed942a9eb22d50f667909ad6184b45015d28d054Tom Gundersen default, empty properties are
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen to show those too. To select specific
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen properties to show use
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen command is intended to be used
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen whenever computer-parsable output is
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen required. Use
bd8f65387673e29f46136a4ed172097035002c23Tom Gundersen are looking for formatted
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering human-readable
0dd25fb9f005d8ab7ac4bc10a609d00569f8c56aLennart Poettering </varlistentry>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering <varlistentry>
11bf3cced13c885ca215c108cb0bdb7a148520d6Lennart Poettering <term><command>attach [NAME] [DEVICE...]</command></term>
cb9fc36a1211967e8c58b0502a26c42552ac8060Lennart Poettering devices to a seat. The devices should
cb9fc36a1211967e8c58b0502a26c42552ac8060Lennart Poettering be specified via device paths in the
769d324c99aab129148bd25f5f663ef441287d86Lennart Poettering system. To create a new seat attach at