logind: support for hybrid sleep (i.e. suspend+hibernate at the same time)

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

diff --git a/man/logind.conf.xml b/man/logind.conf.xml
index 950f81fa937072242ca97ab256038d7e7b65c1df..29469d37e178d544aca01717ab2a86eb39933222 100644 (file)
--- a/man/logind.conf.xml
+++ b/man/logind.conf.xml
@@ -9,16 +9,16 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it

-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or

   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

-  General Public License for more details.
+  Lesser General Public License for more details.

 
 

-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License

   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 


@@ -48,13 +48,13 @@
         </refnamediv>
 
         <refsynopsisdiv>
         </refnamediv>
 
         <refsynopsisdiv>

-                <para><filename>logind.conf</filename></para>
+                <para><filename>/etc/systemd/logind.conf</filename></para>

         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
         </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>
 
 
         </refsect1>
 


@@ -70,14 +70,16 @@
                                 <term><varname>NAutoVTs=</varname></term>
 
                                 <listitem><para>Takes a positive
                                 <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 (VTs) to allocate by default
+                                that -- when switched to and
+                                previously unused --
+                                <literal>autovt</literal> services are
+                                automatically spawned on. These
+                                services are instantiated from the
+                                template unit

                                 <filename>autovt@.service</filename>
                                 <filename>autovt@.service</filename>

-                                with the virtual terminal TTY name,
+                                for the respective VT TTY name,

                                 e.g. <filename>autovt@tty4.service</filename>. By
                                 default
                                 <filename>autovt@.service</filename>
                                 e.g. <filename>autovt@tty4.service</filename>. By
                                 default
                                 <filename>autovt@.service</filename>


@@ -85,12 +87,46 @@
                                 <filename>getty@.service</filename>,
                                 i.e. login prompts are started
                                 dynamically as the user switches to
                                 <filename>getty@.service</filename>,
                                 i.e. login prompts are started
                                 dynamically as the user switches to

-                                unused virtual terminals, and this
-                                parameter hence controls how many
-                                gettys are available on the virtual
-                                terminals. Defaults to 6. When set to
+                                unused virtual terminals. Hence, this
+                                parameter controls how many login
+                                <literal>gettys</literal> are
+                                available on the VTs. If a VT is
+                                already used by some other subsystem
+                                (for example a graphical login) this
+                                kind of activation will not be
+                                attempted. Note that the VT configured
+                                in <varname>ReserveVT=</varname> is
+                                always subject to this kind of
+                                activation, even if it is not one of
+                                VTs configured with the
+                                <varname>NAutoVTs=</varname>
+                                directive. Defaults to 6. When set to

                                 0, automatic spawning of
                                 <literal>autovt</literal> services is
                                 0, automatic spawning of
                                 <literal>autovt</literal> services is

+                                disabled. </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>ReserveVT=</varname></term>
+
+                                <listitem><para>Takes a positive
+                                integer. Configures the number of one
+                                virtual terminal that shall
+                                unconditionally be reserved for
+                                <filename>autovt@.service</filename>
+                                activation (see above). The VT
+                                selected with this option will be
+                                marked busy unconditionally so that no
+                                other subsystem will allocate it. This
+                                functionality is useful to ensure that
+                                regardless how many VTs are allocated
+                                by other subsystems one login
+                                <literal>getty</literal> is always
+                                available. Defaults to 6 (with other
+                                words: there'll always be a
+                                <literal>getty</literal> available on
+                                Alt-F6.). When set to 0, VT
+                                reservation is

                                 disabled.</para></listitem>
                         </varlistentry>
 
                                 disabled.</para></listitem>
                         </varlistentry>
 


@@ -133,7 +169,7 @@
 
                                 <listitem><para>These settings control
                                 the default control group hierarchies
 
                                 <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
                                 logging in users will get private
                                 control groups in all hierarchies
                                 listed in


@@ -146,6 +182,88 @@
                                 defaults to
                                 <literal>cpu</literal>.</para></listitem>
                         </varlistentry>
                                 defaults to
                                 <literal>cpu</literal>.</para></listitem>
                         </varlistentry>

+
+                        <varlistentry>
+                                <term><varname>InhibitDelayMaxSec=</varname></term>
+
+                                <listitem><para>Specifies the maximum
+                                time a system shutdown or sleep
+                                request is delayed due to an inhibitor
+                                lock of type <literal>delay</literal>
+                                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>HandleSuspendKey=</varname></term>
+                                <term><varname>HandleHibernateKey=</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 actions such as system
+                                power-off or suspend. Can be one of
+                                <literal>ignore</literal>,
+                                <literal>poweroff</literal>,
+                                <literal>reboot</literal>,
+                                <literal>halt</literal>,
+                                <literal>kexec</literal>,
+                                <literal>hibernate</literal> and
+                                <literal>hybrid-sleep</literal>. If
+                                <literal>ignore</literal> logind will
+                                never handle these keys. Otherwise the
+                                specified action will be taken in the
+                                respective event. Only input devices
+                                with the
+                                <literal>power-switch</literal> udev
+                                tag will be watched for key/lid switch
+                                events. <varname>HandlePowerKey=</varname>
+                                defaults to
+                                <literal>poweroff</literal>.
+                                <varname>HandleSuspendKey=</varname>
+                                and
+                                <varname>HandleLidSwitch=</varname>
+                                default to <literal>suspend</literal>.
+                                <varname>HandleHibernateKey=</varname>
+                                defaults to
+                                <literal>hibernate</literal>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>PowerKeyIgnoreInhibited=</varname></term>
+                                <term><varname>SuspendKeyIgnoreInhibited=</varname></term>
+                                <term><varname>HibernateKeyIgnoreInhibited=</varname></term>
+                                <term><varname>LidSwitchIgnoreInhibited=</varname></term>
+
+                                <listitem><para>Controls whether
+                                actions triggered by the power and
+                                sleep keys and the lid switch are
+                                subject to inhibitor locks. These
+                                settings take boolean arguments. If
+                                <literal>off</literal> the inhibitor
+                                locks taken by applications in order
+                                to block the requested operation are
+                                respected, if <literal>on</literal>
+                                the requested operation is executed in
+                                any
+                                case. <varname>PowerKeyIgnoreInhibited=</varname>,
+                                <varname>SuspendKeyIgnoreInhibited=</varname>
+                                and
+                                <varname>HibernateKeyIgnoreInhibited=</varname>
+                                defaults to <literal>off</literal>,
+                                <varname>LidSwitchIgnoreInhibited=</varname>
+                                defaults to
+                                <literal>yes</literal>. This means
+                                that the lid switch does not respect
+                                suspend blockers by default, but the
+                                power and sleep keys do.
+                                </para></listitem>
+                        </varlistentry>
+

                 </variablelist>
 
                 <para>Note that setting
                 </variablelist>
 
                 <para>Note that setting


@@ -167,6 +285,7 @@
                   <title>See Also</title>
                   <para>
                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                   <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>
                           <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                   </para>