]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-logind.service.xml
travis: use UBSan checks from OSS-Fuzz
[thirdparty/systemd.git] / man / systemd-logind.service.xml
index ee2e2bbd115348fa0b8668b39ec266b6f9a0ff01..a66c53d076acd252e2ec13e40d84081adf5d02ae 100644 (file)
 <?xml version='1.0'?> <!--*-nxml-*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<!--
-  This file is part of systemd.
-
-  Copyright 2010 Lennart Poettering
-
-  systemd 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
-  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/>.
--->
-
-<refentry id="systemd-logind.service">
-
-        <refentryinfo>
-                <title>systemd-logind.service</title>
-                <productname>systemd</productname>
-
-                <authorgroup>
-                        <author>
-                                <contrib>Developer</contrib>
-                                <firstname>Lennart</firstname>
-                                <surname>Poettering</surname>
-                                <email>lennart@poettering.net</email>
-                        </author>
-                </authorgroup>
-        </refentryinfo>
-
-        <refmeta>
-                <refentrytitle>systemd-logind.service</refentrytitle>
-                <manvolnum>8</manvolnum>
-        </refmeta>
-
-        <refnamediv>
-                <refname>systemd-logind.service</refname>
-                <refname>systemd-logind</refname>
-                <refpurpose>systemd Login Manager</refpurpose>
-        </refnamediv>
-
-        <refsynopsisdiv>
-                <para><filename>systemd-logind.service</filename></para>
-                <para><filename>/usr/lib/systemd/systemd-logind</filename></para>
-        </refsynopsisdiv>
-
-        <refsect1>
-                <title>Description</title>
-
-                <para><filename>systemd-logind</filename> is a system
-                service that manages user logins. It is responsible
-                for:</para>
-
-                <itemizedlist>
-                        <listitem><para>Keeping track of users and sessions, their
-                        processes and their idle state</para></listitem>
-
-                        <listitem><para>Creating control groups for
-                        user processes</para></listitem>
-
-                        <listitem><para>Providing PolicyKit-based access
-                        for users to operations such as system
-                        shutdown or sleep</para></listitem>
-
-                        <listitem><para>Implementing a shutdown/sleep
-                        inhibition logic for
-                        applications</para></listitem>
-
-                        <listitem><para>Handling of power/sleep
-                        hardware keys</para></listitem>
-
-                        <listitem><para>Multi-seat
-                        management</para></listitem>
-
-                        <listitem><para>Session
-                        switch management</para></listitem>
-
-                        <listitem><para>Device access management for
-                        users</para></listitem>
-
-                        <listitem><para>Automatic spawning of text
-                        logins (gettys) on virtual console activation
-                        and user runtime directory
-                        management</para></listitem>
-                </itemizedlist>
-
-                <para>User sessions are registered in logind via the
-                <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-                PAM module.</para>
-
-                <para>See
-                <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-                for information about the configuration of this
-                service.</para>
-
-                <para>See <ulink
-                url="http://www.freedesktop.org/wiki/Software/systemd/multiseat">Multi-Seat
-                on Linux</ulink> for an introduction into basic
-                concepts of logind such as users, sessions and seats.</para>
-        </refsect1>
-
-        <refsect1>
-                <title>See Also</title>
-                <para>
-                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-                </para>
-        </refsect1>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
+
+<refentry id="systemd-logind.service" conditional='ENABLE_LOGIND'>
+
+  <refentryinfo>
+    <title>systemd-logind.service</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>systemd-logind.service</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>systemd-logind.service</refname>
+    <refname>systemd-logind</refname>
+    <refpurpose>Login manager</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <para><filename>systemd-logind.service</filename></para>
+    <para><filename>/usr/lib/systemd/systemd-logind</filename></para>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><command>systemd-logind</command> is a system service that
+    manages user logins. It is responsible for:</para>
+
+    <itemizedlist>
+      <listitem><para>Keeping track of users and sessions, their processes and their idle state. This is implemented by
+      allocating a systemd slice unit for each user below <filename>user.slice</filename>, and a scope unit below it
+      for each concurrent session of a user. Also, a per-user service manager is started as system service instance of
+      <filename>user@.service</filename> for each logged in user.</para></listitem>
+
+      <listitem><para>Generating and managing session IDs. If auditing is available and an audit session ID is already set for
+      a session, then this ID is reused as the session ID. Otherwise, an independent session counter is
+      used.</para></listitem>
+
+      <listitem><para>Providing <ulink
+      url="http://www.freedesktop.org/wiki/Software/polkit">polkit</ulink>-based
+      access for users for operations such as system shutdown or sleep</para>
+      </listitem>
+
+      <listitem><para>Implementing a shutdown/sleep inhibition logic
+      for applications</para></listitem>
+
+      <listitem><para>Handling of power/sleep hardware
+      keys</para></listitem>
+
+      <listitem><para>Multi-seat management</para></listitem>
+
+      <listitem><para>Session switch management</para></listitem>
+
+      <listitem><para>Device access management for
+      users</para></listitem>
+
+      <listitem><para>Automatic spawning of text logins (gettys) on
+      virtual console activation and user runtime directory
+      management</para></listitem>
+    </itemizedlist>
+
+    <para>User sessions are registered with logind via the
+    <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    PAM module.</para>
+
+    <para>See
+    <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    for information about the configuration of this service.</para>
+
+    <para>See
+    <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    for information about the basic concepts of logind
+    such as users, sessions and seats.</para>
+
+    <para>See the <ulink
+    url="https://www.freedesktop.org/wiki/Software/systemd/logind">
+    logind D-Bus API Documentation</ulink> for information about the
+    APIs <filename>systemd-logind</filename> provides.</para>
+
+    <para>For more information on the inhibition logic see the <ulink
+    url="https://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor
+    Lock Developer Documentation</ulink>.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    </para>
+  </refsect1>
 
 </refentry>