logind: make sure there's always a getty available on TTY6

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

diff --git a/man/logind.conf.xml b/man/logind.conf.xml
index deca1cdd7f9812048089f281247496cda102db37..304f570b1d5cea669d2470323292f7018d50eff2 100644 (file)
--- a/man/logind.conf.xml
+++ b/man/logind.conf.xml
@@ -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


@@ -151,13 +187,66 @@
                                 <term><varname>InhibitDelayMaxSec=</varname></term>
 
                                 <listitem><para>Specifies the maximum
                                 <term><varname>InhibitDelayMaxSec=</varname></term>
 
                                 <listitem><para>Specifies the maximum

-                                time a suspend or reboot is delayed
-                                due to an inhibitor lock of type
-                                <literal>delay</literal> being taken
-                                before it is ignored and the operation
-                                executed anyway. Defaults to
+                                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>
                                 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>
                         </varlistentry>
 
                 </variablelist>


@@ -181,6 +270,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>