chiark / gitweb /
man: document that logind's RemoveIPC= option excepts all system users
[elogind.git] / man / logind.conf.xml
index 2b79547275caf7f2b470d1113d807f0a7d552e5c..45d1257ef36994bab3fd6be4641020a1fca54fc1 100644 (file)
@@ -3,29 +3,28 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
-  This file is part of systemd.
+  This file is part of elogind.
 
   Copyright 2010 Lennart Poettering
 
-  systemd is free software; you can redistribute it and/or modify it
+  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.
 
-  systemd is distributed in the hope that it will be useful, but
+  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 systemd; If not, see <http://www.gnu.org/licenses/>.
+  along with elogind; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="logind.conf" conditional='ENABLE_LOGIND'
-    xmlns:xi="http://www.w3.org/2001/XInclude">
+<refentry id="logind.conf" xmlns:xi="http://www.w3.org/2001/XInclude">
   <refentryinfo>
     <title>logind.conf</title>
-    <productname>systemd</productname>
+    <productname>elogind</productname>
 
     <authorgroup>
       <author>
 
   <refnamediv>
     <refname>logind.conf</refname>
-    <refname>logind.conf.d</refname>
     <refpurpose>Login manager configuration files</refpurpose>
   </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>
+    <para><filename>/etc/elogind/logind.conf</filename></para>
   </refsynopsisdiv>
 
   <refsect1>
     <title>Description</title>
 
-    <para>These files configure various parameters of the systemd
+    <para>These files configure various parameters of the elogind
     login manager,
-    <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+    <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
     </para>
   </refsect1>
 
 
     <variablelist>
 
-      <varlistentry>
-        <term><varname>NAutoVTs=</varname></term>
-
-        <listitem><para>Takes a positive integer. Configures how many
-        virtual terminals (VTs) to allocate by default that, when
-        switched to and are previously unused,
-        <literal>autovt</literal> services are automatically spawned
-        on. These services are instantiated from the template unit
-        <filename>autovt@.service</filename> for the respective VT TTY
-        name, for example, <filename>autovt@tty4.service</filename>.
-        By default, <filename>autovt@.service</filename> is linked to
-        <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 (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 the VTs configured
-        with the <varname>NAutoVTs=</varname> directive. Defaults to
-        6. When set to 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. Identifies 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 of how
-        many VTs are allocated by other subsystems, one login
-        <literal>getty</literal> is always available. Defaults to 6
-        (in other words, there will always be a
-        <literal>getty</literal> available on Alt-F6.). When set to 0,
-        VT reservation is disabled.</para></listitem>
-      </varlistentry>
-
       <varlistentry>
         <term><varname>KillUserProcesses=</varname></term>
 
         <term><varname>HoldoffTimeoutSec=</varname></term>
 
         <listitem><para>Specifies the timeout after system startup or
-        system resume in which systemd will hold off on reacting to
+        system resume in which elogind will hold off on reacting to
         LID events. This is required for the system to properly
-        detect any hotplugged devices so systemd can ignore LID events
+        detect any hotplugged devices so elogind can ignore LID events
         if external monitors, or docks, are connected. If set to 0,
-        systemd will always react immediately, possibly before the
+        elogind will always react immediately, possibly before the
         kernel fully probed all hotplugged devices. This is safe, as
-        long as you do not care for systemd to account for devices
+        long as you do not care for elogind to account for devices
         that have been plugged or unplugged while the system was off.
         Defaults to 30s.</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>
+        <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 and other system users
+        are excluded from the effect of this setting. Defaults to <literal>yes</literal>.</para></listitem>
       </varlistentry>
 
     </variablelist>
   <refsect1>
       <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>elogind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+        <citerefentry><refentrytitle>logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
         <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-        <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+        <citerefentry><refentrytitle>elogind-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
       </para>
   </refsect1>