man: reword logind.conf.xml a bit

[elogind.git] / man / logind.conf.xml

diff --git a/man/logind.conf.xml b/man/logind.conf.xml
index 166038b383972c06267a31be645b7bfdec51b083..79a8932cea501b6a693817e644af93390c914254 100644 (file)
--- a/man/logind.conf.xml
+++ b/man/logind.conf.xml
@@ -48,13 +48,13 @@
         </refnamediv>
 
         <refsynopsisdiv>
-                <para><filename>logind.conf</filename></para>
+                <para><filename>/etc/systemd/logind.conf</filename></para>
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
-                <para>This files configures various parameters of the systemd login manager.</para>
+                <para>This file configures various parameters of the systemd login manager <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 
         </refsect1>
 
@@ -70,12 +70,13 @@
                                 <term><varname>NAutoVTs=</varname></term>
 
                                 <listitem><para>Takes a positive
-                                integer. How many virtual terminals to
-                                allocate by default and when switched
-                                to autospawn <literal>autovt</literal>
-                                services on (if they are otherwise
-                                unused). These services are
-                                instantiated from a template of
+                                integer. Configures how many virtual
+                                terminals to allocate by default that
+                                -- when switched to --
+                                <literal>autovt</literal> services are
+                                automatically spawned on. These
+                                services are instantiated from the
+                                template
                                 <filename>autovt@.service</filename>
                                 with the virtual terminal TTY name,
                                 e.g. <filename>autovt@tty4.service</filename>. By
@@ -85,7 +86,7 @@
                                 <filename>getty@.service</filename>,
                                 i.e. login prompts are started
                                 dynamically as the user switches to
-                                unused virtual terminals, and this
+                                unused virtual terminals. This
                                 parameter hence controls how many
                                 gettys are available on the virtual
                                 terminals. Defaults to 6. When set to
@@ -133,7 +134,7 @@
 
                                 <listitem><para>These settings control
                                 the default control group hierarchies
-                                users logging are added to. When
+                                users logging in are added to. When
                                 logging in users will get private
                                 control groups in all hierarchies
                                 listed in
@@ -154,11 +155,63 @@
                                 time a system shutdown or sleep
                                 request is delayed due to an inhibitor
                                 lock of type <literal>delay</literal>
-                                being taken before it is ignored and
-                                the operation executed
+                                being active -- before it is ignored
+                                and the operation executed
                                 anyway. Defaults to
                                 5s.</para></listitem>
+                        </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>HandlePowerKey=</varname></term>
+                                <term><varname>HandleSleepKey=</varname></term>
+                                <term><varname>HandleLidSwitch=</varname></term>
+
+                                <listitem><para>Controls whether
+                                logind shall handle the system power
+                                and sleep keys and the lid switch to
+                                trigger system power-off or
+                                suspend. Can be one of
+                                <literal>off</literal>,
+                                <literal>no-session</literal>,
+                                <literal>tty-session</literal>,
+                                <literal>any-session</literal> and
+                                <literal>always</literal>. If
+                                <literal>off</literal> logind will
+                                never handle these keys. If
+                                <literal>no-session</literal> logind
+                                will handle these keys when no user is
+                                logged in and no inhibitor lock is
+                                taken, and trigger a warning beep
+                                otherwise. If set to
+                                <literal>tty-session</literal> logind
+                                will handle these keys if no inhibitor
+                                lock is taken, and either no user is
+                                logged in or the foreground session is
+                                a text login and the only one
+                                existing. If
+                                <literal>any-session</literal> is set
+                                logind will handle these keys if no
+                                inhibitor lock is taken, and either no
+                                user is logged in or the foreground
+                                session is the only one existing
+                                (regardless whether graphical or
+                                text). If set to
+                                <literal>always</literal> logind will
+                                handle these keys in any case, even if
+                                one or more users are logged in or an
+                                inhibitor lock is taken. Only input
+                                devices with the
+                                <literal>power-switch</literal> udev
+                                tag will be watched for key
+                                events. <varname>HandlePowerKey=</varname>
+                                defaults to
+                                <literal>no-session</literal>.
+                                <varname>HandleSleepKey=</varname>
+                                defaults to
+                                <literal>tty-session</literal>,
+                                <varname>HandleLidSwitch=</varname>
+                                defaults to
+                                <literal>off</literal>.</para></listitem>
                         </varlistentry>
 
                 </variablelist>
@@ -182,6 +235,7 @@
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                   </para>