chiark / gitweb /
build-sys: work around automake issue with files with a leading '-'
[elogind.git] / man / loginctl.xml
index 33a369e0da2aaddb80a7de583db6c5198419c32c..790a3e4bf8360975ff4cae8ad048b5d74d900d80 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">
+<refentry id="loginctl" conditional='HAVE_PAM'>
 
         <refentryinfo>
                 <title>loginctl</title>
 
         <refentryinfo>
                 <title>loginctl</title>
@@ -69,8 +69,8 @@
 
                 <variablelist>
                         <varlistentry>
 
                 <variablelist>
                         <varlistentry>
-                                <term><option>--help</option></term>
                                 <term><option>-h</option></term>
                                 <term><option>-h</option></term>
+                                <term><option>--help</option></term>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
 
                                 <listitem><para>Prints a short help
                                 text and exits.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--property=</option></term>
                                 <term><option>-p</option></term>
                                 <term><option>-p</option></term>
+                                <term><option>--property=</option></term>
 
                                 <listitem><para>When showing
 
                                 <listitem><para>When showing
-                                session/user/ properties, limit
+                                session/user properties, limit
                                 display to certain properties as
                                 specified as argument. If not
                                 specified all set properties are
                                 display to certain properties as
                                 specified as argument. If not
                                 specified all set properties are
                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--all</option></term>
                                 <term><option>-a</option></term>
                                 <term><option>-a</option></term>
+                                <term><option>--all</option></term>
 
                                 <listitem><para>When showing
                                 unit/job/manager properties, show all
 
                                 <listitem><para>When showing
                                 unit/job/manager properties, show all
                                 set or not.</para></listitem>
                         </varlistentry>
 
                                 set or not.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><option>-l</option></term>
+                                <term><option>--full</option></term>
+
+                                <listitem><para>Do not ellipsize cgroup
+                                members.</para>
+                                </listitem>
+                        </varlistentry>
 
                         <varlistentry>
                                 <term><option>--no-pager</option></term>
 
 
                         <varlistentry>
                                 <term><option>--no-pager</option></term>
 
-                               <listitem><para>Do not pipe output into a
-                               pager.</para></listitem>
-                       </varlistentry>
+                                <listitem><para>Do not pipe output into a
+                                pager.</para></listitem>
+                        </varlistentry>
 
                         <varlistentry>
                                 <term><option>--no-ask-password</option></term>
 
                         <varlistentry>
                                 <term><option>--no-ask-password</option></term>
                                 <option>all</option> to select whether
                                 to kill only the leader process of the
                                 session or all processes of the
                                 <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>
                                 <option>all</option>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--signal=</option></term>
                                 <term><option>-s</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
 
                                 <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>
                         </varlistentry>
 
                         <varlistentry>
 
                                 <listitem><para>Execute operation
                                 remotely. Specify a hostname, or
 
                                 <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>
                                 to connect to. This will use SSH to
                                 talk to the remote login manager
                                 instance.</para></listitem>
                                 sessions, if the session supports it.</para></listitem>
                         </varlistentry>
 
                                 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 [ID...]</command></term>
 
                         <varlistentry>
                                 <term><command>terminate-session [ID...]</command></term>
 
 
                                 <listitem><para>Show properties of one
                                 or more users or the manager
 
                                 <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
                                 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
                                 default, empty properties are
                                 suppressed. Use <option>--all</option>
                                 to show those too. To select specific
 
                                 <listitem><para>Enable/disable user
                                 lingering for one or more users. If
 
                                 <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
                                 manager is spawned for him/her at
-                                boot, and kept around after
+                                boot and kept around after
                                 logouts. This allows users who aren't
                                 logged in to run long-running
                                 services.</para></listitem>
                                 logouts. This allows users who aren't
                                 logged in to run long-running
                                 services.</para></listitem>
 
                                 <listitem><para>Show properties of one
                                 or more seats or the manager
 
                                 <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
                                 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 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
                                 <option>--property=</option>. This
                                 command is intended to be used
                                 whenever computer-parsable output is
                         <varlistentry>
                                 <term><command>attach [NAME] [DEVICE...]</command></term>
 
                         <varlistentry>
                                 <term><command>attach [NAME] [DEVICE...]</command></term>
 
-                                <listitem><para>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 names. seat
+                                <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,
                                 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>
                                 <listitem><para>Removes all device
                                 assignments previously created with
                                 <command>attach</command>. After this
                                 <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>
                                 hardware is assigned to
                                 them.</para></listitem>
                         </varlistentry>
         <refsect1>
                 <title>Environment</title>
 
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when