along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
-<refentry id="loginctl">
+<refentry id="loginctl" conditional='ENABLE_LOGIND'>
<refentryinfo>
<title>loginctl</title>
<refsynopsisdiv>
<cmdsynopsis>
- <command>loginctl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> <arg choice="opt" rep="repeat">NAME</arg></command>
+ <command>loginctl</command>
+ <arg choice="opt" rep="repeat">OPTIONS</arg>
+ <arg choice="req">COMMAND</arg>
+ <arg choice="opt" rep="repeat">NAME</arg>
</cmdsynopsis>
</refsynopsisdiv>
<variablelist>
<varlistentry>
- <term><option>--help</option></term>
<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>--property=</option></term>
<term><option>-p</option></term>
+ <term><option>--property=</option></term>
<listitem><para>When showing
session/user properties, limit
display to certain properties as
specified as argument. If not
- specified all set properties are
+ specified, all set properties are
shown. The argument should be a
property name, such as
<literal>Sessions</literal>. If
- specified more than once all
+ specified more than once, all
properties with the specified names
are shown.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--all</option></term>
<term><option>-a</option></term>
+ <term><option>--all</option></term>
<listitem><para>When showing
unit/job/manager properties, show all
</varlistentry>
<varlistentry>
+ <term><option>-l</option></term>
<term><option>--full</option></term>
<listitem><para>Do not ellipsize cgroup
<varlistentry>
<term><option>--no-ask-password</option></term>
- <listitem><para>Don't query the user
+ <listitem><para>Do not query the user
for authentication for privileged
operations.</para></listitem>
</varlistentry>
<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
+ session. If omitted, defaults to
<option>all</option>.</para></listitem>
</varlistentry>
<varlistentry>
- <term><option>--signal=</option></term>
<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
- SIGTERM, SIGINT or SIGSTOP. If omitted
- defaults to
- <option>SIGTERM</option>.</para></listitem>
+ 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>
<varlistentry>
<listitem><para>Execute operation
remotely. Specify a hostname, or
- username and hostname separated by @,
+ username and hostname separated by <literal>@</literal>,
to connect to. This will use SSH to
talk to the remote login manager
instance.</para></listitem>
<listitem><para>Show properties of one
or more sessions or the manager
- itself. If no argument is specified
+ itself. If no argument is specified,
properties of the manager will be
- shown. If a session ID is specified
- properties of the session is shown. By
+ 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
+ properties to show, use
<option>--property=</option>. This
command is intended to be used
whenever computer-parsable output is
<listitem><para>Show properties of one
or more users or the manager
- itself. If no argument is specified
+ itself. If no argument is specified,
properties of the manager will be
- shown. If a user is specified
- properties of the user is shown. By
+ 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
+ properties to show, use
<option>--property=</option>. This
command is intended to be used
whenever computer-parsable output is
<listitem><para>Enable/disable user
lingering for one or more users. If
- enabled for a specific user a user
+ enabled for a specific user, a user
manager is spawned for him/her at
- boot, and kept around after
- logouts. This allows users who aren't
+ boot and kept around after
+ logouts. This allows users who are not
logged in to run long-running
services.</para></listitem>
</varlistentry>
<listitem><para>Show properties of one
or more seats or the manager
- itself. If no argument is specified
+ itself. If no argument is specified,
properties of the manager will be
- shown. If a seat is specified
+ 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
+ properties to show, use
<option>--property=</option>. This
command is intended to be used
whenever computer-parsable output is
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
+ 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, "-" and "_" and must be prefixed
- with "seat". 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>
+ 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>
<listitem><para>Removes all device
assignments previously created with
<command>attach</command>. After this
- call only automatically generated
- seats will remain and all seat
+ call, only automatically generated
+ seats will remain, and all seat
hardware is assigned to
them.</para></listitem>
</varlistentry>
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Environment</title>
- <variablelist>
+ <variablelist class='environment-variables'>
<varlistentry>
<term><varname>$SYSTEMD_PAGER</varname></term>
<listitem><para>Pager to use when
~ianmdlvl / elogind.git / blobdiff