chiark / gitweb /
build-sys: update intructions for Makefile-man.am regeneration
[elogind.git] / man / loginctl.xml
index 7d9d8a1..749db92 100644 (file)
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="loginctl">
+<refentry id="loginctl" conditional='ENABLE_LOGIND'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <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>--no-legend</option></term>
 
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
+                                <listitem>
+                                        <para>Do not print the legend,
+                                        i.e. the column headers and
+                                        the footer.</para>
+                                </listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>--version</option></term>
+                                <term><option>--no-ask-password</option></term>
 
-                                <listitem><para>Prints a short version
-                                string and exits.</para></listitem>
+                                <listitem><para>Do not query the user
+                                for authentication for privileged
+                                operations.</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
+                                session/user/seat 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
-                                properties regardless whether they are
+                                session/user/seat properties, show all
+                                properties regardless of whether they are
                                 set or not.</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>
+                                <term><option>-l</option></term>
+                                <term><option>--full</option></term>
 
-                                <listitem><para>Don't query the user
-                                for authentication for privileged
-                                operations.</para></listitem>
+                                <listitem><para>Do not ellipsize
+                                process tree entries.</para>
+                                </listitem>
                         </varlistentry>
 
                         <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>
-                        </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>
+                                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>
-                                <term><option>-P</option></term>
-                                <term><option>--privileged</option></term>
+                        <xi:include href="user-system-options.xml" xpointer="host" />
+                        <xi:include href="user-system-options.xml" xpointer="machine" />
 
-                                <listitem><para>Acquire privileges via
-                                PolicyKit before executing the
-                                operation.</para></listitem>
-                        </varlistentry>
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
+                        <xi:include href="standard-options.xml" xpointer="no-pager" />
                 </variablelist>
 
                 <para>The following commands are understood:</para>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>session-status [ID...]</command></term>
+                                <term><command>session-status</command> <replaceable>ID</replaceable>...</term>
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>show-session [ID...]</command></term>
+                                <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
+                                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
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>activate [ID...]</command></term>
+                                <term><command>activate</command> <replaceable>ID</replaceable>...</term>
 
                                 <listitem><para>Activate one or more
                                 sessions. This brings one or more
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>lock-session [ID...]</command></term>
-                                <term><command>unlock-session [ID...]</command></term>
+                                <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>
+                                sessions, if the session supports it.
+                                </para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><command>lock-sessions</command></term>
+                                <term><command>unlock-sessions</command></term>
 
-                                <listitem><para>Activate the screen
-                                lock on all current sessions
-                                supporting it.</para></listitem>
+                                <listitem><para>Activates/deactivates
+                                the screen lock on all current
+                                sessions supporting it.
+                                </para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>terminate-session [ID...]</command></term>
+                                <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>
+                                <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 [ID...]</command></term>
+                                <term><command>kill-session</command> <replaceable>ID</replaceable>...</term>
 
                                 <listitem><para>Send a signal to one
                                 or more processes of the session. Use
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>user-status [USER...]</command></term>
+                                <term><command>user-status</command> <replaceable>USER</replaceable>...</term>
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more
                                 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>
+                                <command>show-user</command> instead.
+                                Users may be specified by their
+                                usernames or numeric user IDs.
+                                </para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>show-user [USER...]</command></term>
+                                <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
+                                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
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>enable-linger [USER...]</command></term>
-                                <term><command>disable-linger [USER...]</command></term>
+                                <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 him/her at
-                                boot, and kept around after
-                                logouts. This allows users who aren't
+                                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 [USER...]</command></term>
+                                <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>
+                                attached to the user.
+                                </para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>kill-user [USER...]</command></term>
+                                <term><command>kill-user</command> <replaceable>USER</replaceable>...</term>
 
                                 <listitem><para>Send a signal to all
                                 processes of a user. Use
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>seat-status [NAME...]</command></term>
+                                <term><command>seat-status</command> <replaceable>NAME</replaceable>...</term>
 
                                 <listitem><para>Show terse runtime
                                 status information about one or more
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>show-seat [NAME...]</command></term>
+                                <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
+                                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
                         </varlistentry>
 
                         <varlistentry>
-                                <term><command>attach [NAME] [DEVICE...]</command></term>
+                                <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
+                                file system. To create a new seat,
                                 attach at least one graphics card to a
-                                previously unused seat name. seat
+                                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>
 
                         <varlistentry>
-                                <term><command>terminate-seat [NAME...]</command></term>
+                                <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 a seat and
-                                deallocates all runtime resources
+                                processes of all sessions on the seat
+                                and deallocates all runtime resources
                                 attached to them.</para></listitem>
                         </varlistentry>
                 </variablelist>
         <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>
-                        <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>
-                        </varlistentry>
-                </variablelist>
-        </refsect1>
+        <xi:include href="less-variables.xml" />
 
         <refsect1>
                 <title>See Also</title>