[thirdparty/systemd.git] / man / loginctl.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="loginctl" conditional='ENABLE_LOGIND'
          xmlns:xi="http://www.w3.org/2001/XInclude">

        <refentryinfo>
                <title>loginctl</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>loginctl</refentrytitle>
                <manvolnum>1</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>loginctl</refname>
                <refpurpose>Control the systemd login manager</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <cmdsynopsis>
                        <command>loginctl</command>
                        <arg choice="opt" rep="repeat">OPTIONS</arg>
                        <arg choice="req">COMMAND</arg>
                        <arg choice="opt" rep="repeat">NAME</arg>
                </cmdsynopsis>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>loginctl</command> may be used to
                introspect and control the state of the
                <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><option>-h</option></term>
                                <term><option>--help</option></term>

                                <listitem><para>Prints a short help
                                text and exits.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--version</option></term>

                                <listitem><para>Prints a short version
                                string and exits.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--no-pager</option></term>

                                <listitem><para>Do not pipe output into a
                                pager.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--no-legend</option></term>

                                <listitem>
                                        <para>Do not print the legend,
                                        i.e. the column headers and
                                        the footer.</para>
                                </listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--no-ask-password</option></term>

                                <listitem><para>Do not query the user
                                for authentication for privileged
                                operations.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-H</option></term>
                                <term><option>--host</option></term>

                                <listitem><para>Execute the operation
                                remotely. Specify a hostname, or
                                username and hostname separated by <literal>@</literal>,
                                to connect to. This will use SSH to
                                talk to the remote login manager
                                instance.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-M</option></term>
                                <term><option>--machine=</option></term>

                                <listitem><para>Execute the operation on a
                                local container. Specify a container
                                name to connect to.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-p</option></term>
                                <term><option>--property=</option></term>

                                <listitem><para>When showing
                                session/user/seat 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
                                <literal>Sessions</literal>. If
                                specified more than once, all
                                properties with the specified names
                                are shown.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-a</option></term>
                                <term><option>--all</option></term>

                                <listitem><para>When showing
                                session/user/seat properties, show all
                                properties regardless of whether they are
                                set or not.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-l</option></term>
                                <term><option>--full</option></term>

                                <listitem><para>Do not ellipsize
                                process tree entries.</para>
                                </listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>--kill-who=</option></term>

                                <listitem><para>When used with
                                <command>kill-session</command>,
                                choose which processes to kill. Must
                                be one of <option>leader</option>, or
                                <option>all</option> to select whether
                                to kill only the leader process of the
                                session or all processes of the
                                session. If omitted, defaults to
                                <option>all</option>.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>-s</option></term>
                                <term><option>--signal=</option></term>

                                <listitem><para>When used with
                                <command>kill-session</command> or
                                <command>kill-user</command>, choose
                                which signal to send to selected
                                processes. Must be one of the well
                                known signal specifiers, such as
                                <constant>SIGTERM</constant>,
                                <constant>SIGINT</constant> or
                                <constant>SIGSTOP</constant>. If
                                omitted, defaults to
                                <constant>SIGTERM</constant>.</para></listitem>
                        </varlistentry>

                </variablelist>

                <para>The following commands are understood:</para>

                <variablelist>
                        <varlistentry>
                                <term><command>list-sessions</command></term>

                                <listitem><para>List current sessions.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>session-status</command> <replaceable>ID</replaceable>...</term>

                                <listitem><para>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
                                <command>show-session</command>
                                instead.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>show-session</command> <optional><replaceable>ID</replaceable>...</optional></term>

                                <listitem><para>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 are shown. By
                                default, empty properties are
                                suppressed. Use <option>--all</option>
                                to show those too. To select specific
                                properties to show, use
                                <option>--property=</option>. This
                                command is intended to be used
                                whenever computer-parsable output is
                                required. Use
                                <command>session-status</command> if
                                you are looking for formatted
                                human-readable
                                output.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>activate</command> <replaceable>ID</replaceable>...</term>

                                <listitem><para>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.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>lock-session</command> <replaceable>ID</replaceable>...</term>
                                <term><command>unlock-session</command> <replaceable>ID</replaceable>...</term>

                                <listitem><para>Activates/deactivates
                                the screen lock on one or more
                                sessions, if the session supports it.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>lock-sessions</command></term>
                                <term><command>unlock-sessions</command></term>

                                <listitem><para>Activates/deactivates
                                the screen lock on all current
                                sessions supporting it.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>terminate-session</command> <replaceable>ID</replaceable>...</term>

                                <listitem><para>Terminates a session.
                                This kills all processes of the
                                session and deallocates all resources
                                attached to the session.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>kill-session</command> <replaceable>ID</replaceable>...</term>

                                <listitem><para>Send a signal to one
                                or more processes of the session. Use
                                <option>--kill-who=</option> to select
                                which process to kill. Use
                                <option>--signal=</option> to select
                                the signal to send.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>list-users</command></term>

                                <listitem><para>List currently logged
                                in users.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>user-status</command> <replaceable>USER</replaceable>...</term>

                                <listitem><para>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
                                <command>show-user</command> instead.
                                Users may be specified by their
                                usernames or numeric user IDs.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>show-user</command> <optional><replaceable>USER</replaceable>...</optional></term>

                                <listitem><para>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 are shown. By
                                default, empty properties are
                                suppressed. Use <option>--all</option>
                                to show those too. To select specific
                                properties to show, use
                                <option>--property=</option>. This
                                command is intended to be used
                                whenever computer-parsable output is
                                required. Use
                                <command>user-status</command> if
                                you are looking for formatted
                                human-readable
                                output.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>enable-linger</command> <replaceable>USER</replaceable>...</term>
                                <term><command>disable-linger</command> <replaceable>USER</replaceable>...</term>

                                <listitem><para>Enable/disable user
                                lingering for one or more users. If
                                enabled for a specific user, a user
                                manager is spawned for the user at
                                boot and kept around after
                                logouts. This allows users who are not
                                logged in to run long-running
                                services.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>terminate-user</command> <replaceable>USER</replaceable>...</term>

                                <listitem><para>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.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>kill-user</command> <replaceable>USER</replaceable>...</term>

                                <listitem><para>Send a signal to all
                                processes of a user. Use
                                <option>--signal=</option> to select
                                the signal to send.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>list-seats</command></term>

                                <listitem><para>List currently
                                available seats on the local
                                system.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>seat-status</command> <replaceable>NAME</replaceable>...</term>

                                <listitem><para>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
                                <command>show-seat</command>
                                instead.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>show-seat</command> <replaceable>NAME</replaceable>...</term>

                                <listitem><para>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 <option>--all</option>
                                to show those too. To select specific
                                properties to show, use
                                <option>--property=</option>. This
                                command is intended to be used
                                whenever computer-parsable output is
                                required. Use
                                <command>seat-status</command> if you
                                are looking for formatted
                                human-readable
                                output.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>attach</command> <replaceable>NAME</replaceable> <replaceable>DEVICE</replaceable>...</term>

                                <listitem><para>Persistently attach
                                one or more devices to a seat. The
                                devices should be specified via device
                                paths in the <filename>/sys</filename>
                                file system. To create a new seat,
                                attach at least one graphics card to a
                                previously unused seat name. Seat
                                names may consist only of a-z, A-Z,
                                0-9, <literal>-</literal> and
                                <literal>_</literal> and must be
                                prefixed with <literal>seat</literal>.
                                To drop assignment of a device to a
                                specific seat, just reassign it to a
                                different seat, or use
                                <command>flush-devices</command>.
                                </para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>flush-devices</command></term>

                                <listitem><para>Removes all device
                                assignments previously created with
                                <command>attach</command>. After this
                                call, only automatically generated
                                seats will remain, and all seat
                                hardware is assigned to
                                them.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><command>terminate-seat</command> <replaceable>NAME</replaceable>...</term>

                                <listitem><para>Terminates all
                                sessions on a seat. This kills all
                                processes of all sessions on the seat
                                and deallocates all runtime resources
                                attached to them.</para></listitem>
                        </varlistentry>
                </variablelist>

        </refsect1>

        <refsect1>
                <title>Exit status</title>

                <para>On success, 0 is returned, a non-zero failure
                code otherwise.</para>
        </refsect1>

        <xi:include href="less-variables.xml" />

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                </para>
        </refsect1>

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