loginctl.xml revision f366d58dc1fe51b300167446597750d29687c3c5
3802a3d3d7af51ddff31943d5514382f01265770Lennart Poettering<?xml version='1.0'?> <!--*-nxml-*-->
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
12b42c76672a66c2d4ea7212c14f8f1b5a62b78dTom Gundersen "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering<!--
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek This file is part of systemd.
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek Copyright 2010 Lennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek systemd is free software; you can redistribute it and/or modify it
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek under the terms of the GNU Lesser General Public License as published by
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek the Free Software Foundation; either version 2.1 of the License, or
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek (at your option) any later version.
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek systemd is distributed in the hope that it will be useful, but
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek WITHOUT ANY WARRANTY; without even the implied warranty of
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek Lesser General Public License for more details.
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek You should have received a copy of the GNU Lesser General Public License
b975b0d514321f169b3c4599a8ea92e13741b4e4Zbigniew Jędrzejewski-Szmek along with systemd; If not, see <http://www.gnu.org/licenses/>.
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering-->
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
48f69d8fb4d0cf34d578352572c96d86e13caa79Lennart Poettering<refentry id="loginctl" conditional='ENABLE_LOGIND'>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <refentryinfo>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <title>loginctl</title>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <productname>systemd</productname>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <authorgroup>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <author>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <contrib>Developer</contrib>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <firstname>Lennart</firstname>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <surname>Poettering</surname>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <email>lennart@poettering.net</email>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </author>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </authorgroup>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </refentryinfo>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <refmeta>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <refentrytitle>loginctl</refentrytitle>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <manvolnum>1</manvolnum>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </refmeta>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <refnamediv>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <refname>loginctl</refname>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <refpurpose>Control the systemd login manager</refpurpose>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </refnamediv>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <refsynopsisdiv>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <cmdsynopsis>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <command>loginctl</command>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <arg choice="opt" rep="repeat">OPTIONS</arg>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <arg choice="req">COMMAND</arg>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <arg choice="opt" rep="repeat">NAME</arg>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </cmdsynopsis>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </refsynopsisdiv>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <refsect1>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <title>Description</title>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <para><command>loginctl</command> may be used to
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering introspect and control the state of the
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann </refsect1>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <refsect1>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <title>Options</title>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <para>The following options are understood:</para>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <variablelist>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
53d6837510478e1275b294654663635466cbafc7Tom Gundersen <term><option>-h</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>--help</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <listitem><para>Prints a short help
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann text and exits.</para></listitem>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann </varlistentry>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <varlistentry>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <term><option>--version</option></term>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <listitem><para>Prints a short version
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering string and exits.</para></listitem>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>--no-pager</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <listitem><para>Do not pipe output into a
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering pager.</para></listitem>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>--no-legend</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <listitem>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <para>Do not print the legend,
b8bde11658366290521e3d03316378b482600323Jan Engelhardt i.e. the column headers and
b8bde11658366290521e3d03316378b482600323Jan Engelhardt the footer.</para>
b8bde11658366290521e3d03316378b482600323Jan Engelhardt </listitem>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>--no-ask-password</option></term>
b8bde11658366290521e3d03316378b482600323Jan Engelhardt
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <listitem><para>Do not query the user
b8bde11658366290521e3d03316378b482600323Jan Engelhardt for authentication for privileged
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering operations.</para></listitem>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>-H</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>--host</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <listitem><para>Execute the operation
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering remotely. Specify a hostname, or
b8bde11658366290521e3d03316378b482600323Jan Engelhardt username and hostname separated by <literal>@</literal>,
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering to connect to. This will use SSH to
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering talk to the remote login manager
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering instance.</para></listitem>
dca348bcbb462305864526c587495a14a76bfcdeJan Engelhardt </varlistentry>
b8bde11658366290521e3d03316378b482600323Jan Engelhardt
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>-M</option></term>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <term><option>--machine=</option></term>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <listitem><para>Execute the operation on a
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt local container. Specify a container
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann name to connect to.</para></listitem>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann </varlistentry>
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <varlistentry>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <term><option>-p</option></term>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <term><option>--property=</option></term>
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <listitem><para>When showing
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann session/user/seat properties, limit
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt display to certain properties as
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt specified as argument. If not
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann specified, all set properties are
b938cb902c3b5bca807a94b277672c64d6767886Jan Engelhardt shown. The argument should be a
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann property name, such as
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann <literal>Sessions</literal>. If
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann specified more than once, all
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann properties with the specified names
dfb815c36df6e5f2089672b1d986d38b44c7ad17David Herrmann are shown.</para></listitem>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>-a</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>--all</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <listitem><para>When showing
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering session/user/seat properties, show all
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering properties regardless of whether they are
b8bde11658366290521e3d03316378b482600323Jan Engelhardt set or not.</para></listitem>
b8bde11658366290521e3d03316378b482600323Jan Engelhardt </varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>-l</option></term>
5aded369782f28255bc6b494ca905d7acaea7a56Zbigniew Jędrzejewski-Szmek <term><option>--full</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <listitem><para>Do not ellipsize
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering process tree entries.</para>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </listitem>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>--kill-who=</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
5aded369782f28255bc6b494ca905d7acaea7a56Zbigniew Jędrzejewski-Szmek <listitem><para>When used with
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <command>kill-session</command>,
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering choose which processes to kill. Must
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering be one of <option>leader</option>, or
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <option>all</option> to select whether
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering to kill only the leader process of the
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering session or all processes of the
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering session. If omitted, defaults to
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <option>all</option>.</para></listitem>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering </varlistentry>
5aded369782f28255bc6b494ca905d7acaea7a56Zbigniew Jędrzejewski-Szmek
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <varlistentry>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>-s</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering <term><option>--signal=</option></term>
a6278b88305b237b02eabff0d870b57fe851822dLennart Poettering
<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>
<refsect1>
<title>Environment</title>
<variablelist class='environment-variables'>
<varlistentry>
<term><varname>$SYSTEMD_PAGER</varname></term>
<listitem><para>Pager to use when
<option>--no-pager</option> is not given;
overrides <varname>$PAGER</varname>. Setting
this to an empty string or the value
<literal>cat</literal> is equivalent to passing
<option>--no-pager</option>.</para></listitem>
<term><varname>$SYSTEMD_LESS</varname></term>
<listitem><para><varname>$SYSTEMD_LESS</varname> overrides the
default options passed to <literal>less</literal>
(<literal>FRSXMK</literal>).</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<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>