chiark / gitweb /
tree-wide: drop 'This file is part of systemd' blurb
[elogind.git] / man / logind.conf.xml
index 43cb42698b1e309779f4703a16bbb59a519750ca..0b8e4f66a04252262d0e13d6258c5169c3a45232 100644 (file)
@@ -1,37 +1,28 @@
 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY % entities SYSTEM "custom-entities.ent" >
+%entities;
+]>
 
 <!--
   SPDX-License-Identifier: LGPL-2.1+
 
-  This file is part of elogind.
-
   Copyright 2010 Lennart Poettering
-
-  elogind is free software; you can redistribute it and/or modify it
-  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.
-
-  elogind 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
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with elogind; If not, see <http://www.gnu.org/licenses/>.
 -->
 
 <!-- 0 /// elogind does not have to enable itself in configure
 <refentry id="logind.conf" conditional='ENABLE_LOGIND'
     xmlns:xi="http://www.w3.org/2001/XInclude">
+  <refentryinfo>
+    <title>logind.conf</title>
     <productname>systemd</productname>
 --><!-- else -->
 <refentry id="logind.conf" xmlns:xi="http://www.w3.org/2001/XInclude">
-<!-- // 0 -->
   <refentryinfo>
     <title>logind.conf</title>
+    <productname>elogind</productname>
+<!-- // 0 -->
 
     <authorgroup>
       <author>
   <refsect1>
     <title>Description</title>
 
-    <para>These files configure various parameters of the elogind
     <!-- 0 /// elogind does not need a service file.
-    login manager,
-    <citerefentry><refentrytitle>elogind.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>. See
+    <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    for a general description of the syntax.</para>
     --><!-- else -->
     login manager.</para>
     <!-- // 0 -->
         corresponding to the session and all processes inside that scope will be
         terminated. If false, the scope is "abandoned", see
         <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+        and processes are not killed. Defaults to <literal>&KILL_USER_PROCESSES;</literal>,
         --><!-- else -->
         user should be killed when the user logs out. If true, the processes
         listed in their session cgroup will be terminated. If false, the session cgroup
         is ignored
         <!-- // 0 -->
-        and processes are not killed. Defaults to <literal>yes</literal>,
         but see the options <varname>KillOnlyUsers=</varname> and
         <varname>KillExcludeUsers=</varname> below.</para>
 
         <literal>kexec</literal>,
         <literal>suspend</literal>,
         <literal>hibernate</literal>,
-        <literal>hybrid-sleep</literal>, and
+        <literal>hybrid-sleep</literal>,
+        <literal>suspend-then-hibernate</literal>, and
         <literal>lock</literal>.
         Defaults to <literal>ignore</literal>.</para>
 
         <literal>kexec</literal>,
         <literal>suspend</literal>,
         <literal>hibernate</literal>,
-        <literal>hybrid-sleep</literal>, and
+        <literal>hybrid-sleep</literal>,
+        <literal>suspend-then-hibernate</literal>, and
         <literal>lock</literal>.
         If <literal>ignore</literal>, logind will never handle these
         keys. If <literal>lock</literal>, all running sessions will be
         <varname>HandleLidSwitch=</varname> default to
         <literal>suspend</literal>.
         <varname>HandleLidSwitchExternalPower=</varname> is completely
-        ignored by default (for backwards compatibility) &#x2014; an explicit
+        ignored by default (for backwards compatibility)  an explicit
         value must be set before it will be used to determine
-        behaviour.  <varname>HandleLidSwitchDocked=</varname> defaults
+        behaviour. <varname>HandleLidSwitchDocked=</varname> defaults
         to <literal>ignore</literal>.
         <varname>HandleHibernateKey=</varname> defaults to
         <literal>hibernate</literal>. If the system is inserted in a
         <term><varname>HibernateKeyIgnoreInhibited=</varname></term>
         <term><varname>LidSwitchIgnoreInhibited=</varname></term>
 
-        <listitem><para>Controls whether actions that <command>systemd-logind</command>
+        <listitem><para>Controls whether actions that <command>elogind</command>
         takes when the power and sleep keys and the lid switch are triggered are subject
         to high-level inhibitor locks ("shutdown", "sleep", "idle"). Low level inhibitor
         locks (<literal>handle-power-key</literal>, <literal>handle-suspend-key</literal>,
         <varname>SuspendKeyIgnoreInhibited=</varname>, and
         <varname>HibernateKeyIgnoreInhibited=</varname> default to <literal>no</literal>.
         <varname>LidSwitchIgnoreInhibited=</varname> defaults to <literal>yes</literal>.
-        This means that when <command>systemd-logind</command> is handling events by
+        This means that when <command>elogind</command> is handling events by
         itself (no low level inhibitor locks are taken by another application), the lid
         switch does not respect suspend blockers by default, but the power and sleep keys
         do.</para></listitem>
         <listitem><para>Controls the maximum number of concurrent user sessions to manage. Defaults to 8192
         (8K). Depending on how the <filename>pam_systemd.so</filename> module is included in the PAM stack
         configuration, further login sessions will either be refused, or permitted but not tracked by
-        <filename>systemd-logind</filename>.</para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>UserTasksMax=</varname></term>
-
-        <listitem><para>Sets the maximum number of OS tasks each user may run concurrently. This controls the
-        <varname>TasksMax=</varname> setting of the per-user slice unit, see
-        <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-        for details. If assigned the special value <literal>infinity</literal>, no tasks limit is applied.
-        Defaults to 33%, which equals 10813 with the kernel's defaults on the host, but might be smaller in
-        OS containers.</para></listitem>
+        <filename>elogind</filename>.</para></listitem>
       </varlistentry>
 
       <varlistentry>