chiark / gitweb /
systemctl: make an always true assert static
[elogind.git] / man / loginctl.xml
index f10ca030c904897fd6410aa6e34f8d51feb29d38..d9e985900175a9645ff5fa98430971d7f89303d3 100644 (file)
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="loginctl" conditional='HAVE_PAM'>
+<refentry id="loginctl" conditional='ENABLE_LOGIND'>
 
         <refentryinfo>
                 <title>loginctl</title>
 
         <refentryinfo>
                 <title>loginctl</title>
 
         <refsynopsisdiv>
                 <cmdsynopsis>
 
         <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>
 
                 </cmdsynopsis>
         </refsynopsisdiv>
 
                                 string and exits.</para></listitem>
                         </varlistentry>
 
                                 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-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
                         <varlistentry>
                                 <term><option>-p</option></term>
                                 <term><option>--property=</option></term>
 
                                 <listitem><para>When showing
-                                session/user properties, limit
+                                session/user/seat properties, limit
                                 display to certain properties as
                                 specified as argument. If not
                                 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
                                 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>
                                 properties with the specified names
                                 are shown.</para></listitem>
                         </varlistentry>
                                 <term><option>--all</option></term>
 
                                 <listitem><para>When showing
                                 <term><option>--all</option></term>
 
                                 <listitem><para>When showing
-                                unit/job/manager properties, show all
+                                session/user/seat properties, show all
                                 properties regardless whether they are
                                 set or not.</para></listitem>
                         </varlistentry>
                                 properties regardless whether they are
                                 set or not.</para></listitem>
                         </varlistentry>
                                 <term><option>-l</option></term>
                                 <term><option>--full</option></term>
 
                                 <term><option>-l</option></term>
                                 <term><option>--full</option></term>
 
-                                <listitem><para>Do not ellipsize cgroup
-                                members.</para>
+                                <listitem><para>Do not ellipsize
+                                process tree entries.</para>
                                 </listitem>
                         </varlistentry>
 
                                 </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-ask-password</option></term>
-
-                                <listitem><para>Don't query the user
-                                for authentication for privileged
-                                operations.</para></listitem>
-                        </varlistentry>
-
                         <varlistentry>
                                 <term><option>--kill-who=</option></term>
 
                         <varlistentry>
                                 <term><option>--kill-who=</option></term>
 
                                 which signal to send to selected
                                 processes. Must be one of the well
                                 known signal specifiers, such as
                                 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>
+                                <constant>SIGTERM</constant>,
+                                <constant>SIGINT</constant> or
+                                <constant>SIGSTOP</constant>. If
+                                omitted, defaults to
+                                <constant>SIGTERM</constant>.</para></listitem>
                         </varlistentry>
 
                         </varlistentry>
 
-                        <varlistentry>
-                                <term><option>-H</option></term>
-                                <term><option>--host</option></term>
-
-                                <listitem><para>Execute operation
-                                remotely. Specify a hostname, or
-                                username and hostname separated by @,
-                                to connect to. This will use SSH to
-                                talk to the remote login manager
-                                instance.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>-P</option></term>
-                                <term><option>--privileged</option></term>
-
-                                <listitem><para>Acquire privileges via
-                                PolicyKit before executing the
-                                operation.</para></listitem>
-                        </varlistentry>
                 </variablelist>
 
                 <para>The following commands are understood:</para>
                 </variablelist>
 
                 <para>The following commands are understood:</para>
 
                                 <listitem><para>Show properties of one
                                 or more sessions or the manager
 
                                 <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
                                 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
                                 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
                                 <option>--property=</option>. This
                                 command is intended to be used
                                 whenever computer-parsable output is
                                 default, empty properties are
                                 suppressed. Use <option>--all</option>
                                 to show those too. To select specific
                                 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
                                 <option>--property=</option>. This
                                 command is intended to be used
                                 whenever computer-parsable output is
                                 enabled for a specific user, a user
                                 manager is spawned for him/her at
                                 boot and kept around after
                                 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
+                                logouts. This allows users who are not
                                 logged in to run long-running
                                 services.</para></listitem>
                         </varlistentry>
                                 logged in to run long-running
                                 services.</para></listitem>
                         </varlistentry>
                                 attach at least one graphics card to a
                                 previously unused seat name. Seat
                                 names may consist only of a-z, A-Z,
                                 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>
                         </varlistentry>
 
                         <varlistentry>
         <refsect1>
                 <title>Exit status</title>
 
         <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>
 
                 code otherwise.</para>
         </refsect1>