man/logind.conf.xml: Make "man logind.conf.d" work too

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

diff --git a/man/logind.conf.xml b/man/logind.conf.xml
index 7673201664a2e0038e0dcd2da81702b82ea7de81..ca7525f31a3b7ba19715cb1cb2b461162207ec62 100644 (file)
--- a/man/logind.conf.xml
+++ b/man/logind.conf.xml
@@ -44,18 +44,42 @@
 
         <refnamediv>
                 <refname>logind.conf</refname>
 
         <refnamediv>
                 <refname>logind.conf</refname>

-                <refpurpose>Login manager configuration file</refpurpose>
+                <refname>logind.conf.d</refname>
+                <refpurpose>Login manager configuration files</refpurpose>

         </refnamediv>
 
         <refsynopsisdiv>
                 <para><filename>/etc/systemd/logind.conf</filename></para>
         </refnamediv>
 
         <refsynopsisdiv>
                 <para><filename>/etc/systemd/logind.conf</filename></para>

+                <para><filename>/etc/systemd/logind.conf.d/*.conf</filename></para>
+                <para><filename>/run/systemd/logind.conf.d/*.conf</filename></para>
+                <para><filename>/usr/lib/systemd/logind.conf.d/*.conf</filename></para>

         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 

-                <para>This file configures various parameters of the systemd login manager, <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
-
+                <para>These files configure various parameters of the systemd login manager, <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+
+                <para>Each configuration file shall be named in the style of
+                <filename><replaceable>filename</replaceable>.conf</filename>.
+                Files in <filename>/etc/</filename> override files with the
+                same name in <filename>/usr/lib/</filename> and
+                <filename>/run/</filename>.  Files in
+                <filename>/run/</filename> override files with the same name in
+                <filename>/usr/lib/</filename>. Packages should install their
+                configuration files in <filename>/usr/lib/</filename>. Files in
+                <filename>/etc/</filename> are reserved for the local
+                administrator, who may use this logic to override the
+                configuration files installed by vendor packages. All
+                configuration files are sorted by their filename in
+                lexicographic order, regardless of which of the directories
+                they reside in. If multiple files specify the same option, the
+                entry in the file with the lexicographically latest name will
+                be applied; entries in any <filename>logind.conf.d</filename>
+                file override entries in
+                <filename>/etc/systemd/logind.conf</filename>. It is
+                recommended to prefix all filenames with a two-digit number and
+                a dash, to simplify the ordering of the files.</para>

         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>


@@ -80,25 +104,25 @@
                                 template unit
                                 <filename>autovt@.service</filename>
                                 for the respective VT TTY name,
                                 template unit
                                 <filename>autovt@.service</filename>
                                 for the respective VT TTY name,

-                                e.g. <filename>autovt@tty4.service</filename>. By
+                                for example, <filename>autovt@tty4.service</filename>. By

                                 default,
                                 <filename>autovt@.service</filename>
                                 is linked to
                                 default,
                                 <filename>autovt@.service</filename>
                                 is linked to

-                                <filename>getty@.service</filename>,
-                                i.e. login prompts are started
+                                <filename>getty@.service</filename>.
+                                In other words, login prompts are started

                                 dynamically as the user switches 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
                                 dynamically as the user switches 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
+                                (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
                                 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
+                                the VTs configured with the

                                 <varname>NAutoVTs=</varname>
                                 directive. Defaults to 6. When set to
                                 0, automatic spawning of
                                 <varname>NAutoVTs=</varname>
                                 directive. Defaults to 6. When set to
                                 0, automatic spawning of


@@ -110,7 +134,7 @@
                                 <term><varname>ReserveVT=</varname></term>
 
                                 <listitem><para>Takes a positive
                                 <term><varname>ReserveVT=</varname></term>
 
                                 <listitem><para>Takes a positive

-                                integer. Configures the number of one
+                                integer. Identifies one

                                 virtual terminal that shall
                                 unconditionally be reserved for
                                 <filename>autovt@.service</filename>
                                 virtual terminal that shall
                                 unconditionally be reserved for
                                 <filename>autovt@.service</filename>


@@ -118,7 +142,7 @@
                                 selected with this option will be
                                 marked busy unconditionally, so that no
                                 other subsystem will allocate it. This
                                 selected with this option will be
                                 marked busy unconditionally, so that no
                                 other subsystem will allocate it. This

-                                functionality is useful to ensure that
+                                functionality is useful to ensure that,

                                 regardless of how many VTs are allocated
                                 by other subsystems, one login
                                 <literal>getty</literal> is always
                                 regardless of how many VTs are allocated
                                 by other subsystems, one login
                                 <literal>getty</literal> is always


@@ -136,8 +160,8 @@
                                 <listitem><para>Takes a boolean
                                 argument. Configures whether the
                                 processes of a user should be killed
                                 <listitem><para>Takes a boolean
                                 argument. Configures whether the
                                 processes of a user should be killed

-                                when she or he completely logs out (i.e. after
-                                her/his last session ended). Defaults to
+                                when the user completely logs out (i.e. after
+                                the user's last session ended). Defaults to

                                 <literal>no</literal>.</para>
 
                                 <para>Note that setting
                                 <literal>no</literal>.</para>
 
                                 <para>Note that setting


@@ -180,7 +204,7 @@
                                 <literal>kexec</literal>,
                                 <literal>suspend</literal>,
                                 <literal>hibernate</literal>,
                                 <literal>kexec</literal>,
                                 <literal>suspend</literal>,
                                 <literal>hibernate</literal>,

-                                <literal>hybrid-sleep</literal>,
+                                <literal>hybrid-sleep</literal>, and

                                 <literal>lock</literal>. Defaults to
                                 <literal>ignore</literal>.</para>
 
                                 <literal>lock</literal>. Defaults to
                                 <literal>ignore</literal>.</para>
 


@@ -216,7 +240,7 @@
                                 being active before the inhibitor is
                                 ignored and the operation executes
                                 anyway. Defaults to
                                 being active before the inhibitor is
                                 ignored and the operation executes
                                 anyway. Defaults to

-                                5s.</para></listitem>
+                                5.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -224,6 +248,7 @@
                                 <term><varname>HandleSuspendKey=</varname></term>
                                 <term><varname>HandleHibernateKey=</varname></term>
                                 <term><varname>HandleLidSwitch=</varname></term>
                                 <term><varname>HandleSuspendKey=</varname></term>
                                 <term><varname>HandleHibernateKey=</varname></term>
                                 <term><varname>HandleLidSwitch=</varname></term>

+                                <term><varname>HandleLidSwitchDocked=</varname></term>

 
                                 <listitem><para>Controls whether
                                 logind shall handle the system power
 
                                 <listitem><para>Controls whether
                                 logind shall handle the system power


@@ -237,7 +262,7 @@
                                 <literal>kexec</literal>,
                                 <literal>suspend</literal>,
                                 <literal>hibernate</literal>,
                                 <literal>kexec</literal>,
                                 <literal>suspend</literal>,
                                 <literal>hibernate</literal>,

-                                <literal>hybrid-sleep</literal> and
+                                <literal>hybrid-sleep</literal>, and

                                 <literal>lock</literal>. If
                                 <literal>ignore</literal>, logind will
                                 never handle these keys. If
                                 <literal>lock</literal>. If
                                 <literal>ignore</literal>, logind will
                                 never handle these keys. If


@@ -255,13 +280,18 @@
                                 and
                                 <varname>HandleLidSwitch=</varname>
                                 default to <literal>suspend</literal>.
                                 and
                                 <varname>HandleLidSwitch=</varname>
                                 default to <literal>suspend</literal>.

+                                <varname>HandleLidSwitchDocked=</varname>
+                                defaults to <literal>ignore</literal>.

                                 <varname>HandleHibernateKey=</varname>
                                 defaults to
                                 <varname>HandleHibernateKey=</varname>
                                 defaults to

-                                <literal>hibernate</literal>. Note
-                                that the lid switch is ignored if the
-                                system is inserted in a docking
-                                station, or if more than one display
-                                is connected.</para></listitem>
+                                <literal>hibernate</literal>. If the
+                                system is inserted in a docking station,
+                                or if more than one display is connected,
+                                the action specified by
+                                <varname>HandleLidSwitchDocked=</varname>
+                                occurs; otherwise the
+                                <varname>HandleLidSwitch=</varname>
+                                action occurs.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -275,17 +305,17 @@
                                 sleep keys and the lid switch are
                                 subject to inhibitor locks. These
                                 settings take boolean arguments. If
                                 sleep keys and the lid switch are
                                 subject to inhibitor locks. These
                                 settings take boolean arguments. If

-                                <literal>off</literal>, the inhibitor
+                                <literal>no</literal>, the inhibitor

                                 locks taken by applications in order
                                 to block the requested operation are
                                 locks taken by applications in order
                                 to block the requested operation are

-                                respected. If <literal>on</literal>,
+                                respected. If <literal>yes</literal>,

                                 the requested operation is executed in
                                 any
                                 case. <varname>PowerKeyIgnoreInhibited=</varname>,
                                 <varname>SuspendKeyIgnoreInhibited=</varname>
                                 and
                                 <varname>HibernateKeyIgnoreInhibited=</varname>
                                 the requested operation is executed in
                                 any
                                 case. <varname>PowerKeyIgnoreInhibited=</varname>,
                                 <varname>SuspendKeyIgnoreInhibited=</varname>
                                 and
                                 <varname>HibernateKeyIgnoreInhibited=</varname>

-                                default to <literal>off</literal>.
+                                default to <literal>no</literal>.

                                 <varname>LidSwitchIgnoreInhibited=</varname>
                                 defaults to
                                 <literal>yes</literal>. This means
                                 <varname>LidSwitchIgnoreInhibited=</varname>
                                 defaults to
                                 <literal>yes</literal>. This means


@@ -295,6 +325,48 @@
                                 </para></listitem>
                         </varlistentry>
 
                                 </para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><varname>RuntimeDirectorySize=</varname></term>
+
+                                <listitem><para>Sets the size limit on
+                                the
+                                <varname>$XDG_RUNTIME_DIR</varname>
+                                runtime directory for each user who
+                                logs in. Takes a size in bytes,
+                                optionally suffixed with the usual K, G,
+                                M, and T suffixes, to the base 1024
+                                (IEC). Alternatively, a numerical
+                                percentage suffixed by <literal>%</literal>
+                                may be specified, which sets the size
+                                limit relative to the amount of
+                                physical RAM. Defaults to 10%. Note
+                                that this size is a safety limit
+                                only. As each runtime directory is a
+                                tmpfs file system, it will only consume
+                                as much memory as is needed.
+                                </para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>RemoveIPC=</varname></term>
+
+                                <listitem><para>Controls whether
+                                System V and POSIX IPC objects
+                                belonging to the user shall be removed
+                                when the user fully logs out. Takes a
+                                boolean argument. If enabled, the user
+                                may not consume IPC resources after
+                                the last of the user's sessions
+                                terminated. This covers System V
+                                semaphores, shared memory and message
+                                queues, as well as POSIX shared memory
+                                and message queues. Note that IPC
+                                objects of the root user are excluded
+                                from the effect of this
+                                setting. Defaults to
+                                <literal>yes</literal>.</para></listitem>
+                        </varlistentry>
+

                 </variablelist>
         </refsect1>
 
                 </variablelist>
         </refsect1>