chiark / gitweb /
Restore shared XML files.
[elogind.git] / man / logind.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <!--
6   This file is part of systemd.
7
8   Copyright 2010 Lennart Poettering
9
10   systemd is free software; you can redistribute it and/or modify it
11   under the terms of the GNU Lesser General Public License as published by
12   the Free Software Foundation; either version 2.1 of the License, or
13   (at your option) any later version.
14
15   systemd is distributed in the hope that it will be useful, but
16   WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18   Lesser General Public License for more details.
19
20   You should have received a copy of the GNU Lesser General Public License
21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="systemd-logind.service">
25
26   <refentryinfo>
27     <title>systemd-logind.service</title>
28     <productname>systemd</productname>
29
30     <authorgroup>
31       <author>
32         <contrib>Developer</contrib>
33         <firstname>Lennart</firstname>
34         <surname>Poettering</surname>
35         <email>lennart@poettering.net</email>
36       </author>
37     </authorgroup>
38   </refentryinfo>
39
40   <refmeta>
41     <refentrytitle>systemd-logind.service</refentrytitle>
42     <manvolnum>8</manvolnum>
43   </refmeta>
44
45   <refnamediv>
46     <refname>systemd-logind.service</refname>
47     <refname>systemd-logind</refname>
48     <refpurpose>Login manager</refpurpose>
49   </refnamediv>
50
51   <refsynopsisdiv>
52     <para><filename>systemd-logind.service</filename></para>
53     <para><filename>/usr/lib/systemd/systemd-logind</filename></para>
54   </refsynopsisdiv>
55
56   <refsect1>
57     <title>Description</title>
58
59     <para><command>systemd-logind</command> is a system service that
60     manages user logins. It is responsible for:</para>
61
62     <itemizedlist>
63       <listitem><para>Keeping track of users and sessions, their
64       processes and their idle state</para></listitem>
65
66       <listitem><para>Providing PolicyKit-based access for users to
67       operations such as system shutdown or sleep</para></listitem>
68
69       <listitem><para>Implementing a shutdown/sleep inhibition logic
70       for applications</para></listitem>
71
72       <listitem><para>Handling of power/sleep hardware
73       keys</para></listitem>
74
75       <listitem><para>Multi-seat management</para></listitem>
76
77       <listitem><para>Session switch management</para></listitem>
78
79       <listitem><para>Device access management for
80       users</para></listitem>
81
82       <listitem><para>Automatic spawning of text logins (gettys) on
83       virtual console activation and user runtime directory
84       management</para></listitem>
85     </itemizedlist>
86
87     <para>User sessions are registered in logind via the
88     <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
89     PAM module.</para>
90
91     <para>See
92     <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
93     for information about the configuration of this service.</para>
94
95     <para>See <ulink
96     url="http://www.freedesktop.org/wiki/Software/systemd/multiseat">Multi-Seat
97     on Linux</ulink> for an introduction into basic concepts of logind
98     such as users, sessions and seats.</para>
99
100     <para>See the <ulink
101     url="http://www.freedesktop.org/wiki/Software/systemd/logind">
102     logind D-Bus API Documentation</ulink> for information about the
103     APIs <filename>systemd-logind</filename> provides.</para>
104
105     <para>For more information on the inhibition logic see the <ulink
106     url="http://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor
107     Lock Developer Documentation</ulink>.</para>
108   </refsect1>
109
110   <refsect1>
111     <title>See Also</title>
112     <para>
113       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
114       <citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
115       <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
116       <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
117       <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
118     </para>
119   </refsect1>
120
121 </refentry>