chiark / gitweb /
Prep v229: Update man pages (fix most inappropriate stuff. Still lots to do...)
[elogind.git] / man / elogind.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 elogind.
7
8   Copyright 2010 Lennart Poettering
9
10   elogind 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   elogind 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 elogind; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="elogind">
25
26   <refentryinfo>
27     <title>elogind</title>
28     <productname>elogind</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>elogind</refentrytitle>
42     <manvolnum>8</manvolnum>
43   </refmeta>
44
45   <refnamediv>
46     <refname>elogind</refname>
47     <refpurpose>Login manager</refpurpose>
48   </refnamediv>
49
50   <refsynopsisdiv>
51     <para><filename>/usr/libexec/elogind/elogind</filename></para>
52   </refsynopsisdiv>
53
54   <refsect1>
55     <title>Description</title>
56
57     <para><command>elogind</command> is a system service that
58     manages user logins. It is responsible for:</para>
59
60     <itemizedlist>
61       <listitem><para>Keeping track of users and sessions, their
62       processes and their idle state</para></listitem>
63
64       <listitem><para>Providing PolicyKit-based access for users to
65       operations such as system shutdown or sleep</para></listitem>
66
67       <listitem><para>Implementing a shutdown/sleep inhibition logic
68       for applications</para></listitem>
69
70       <listitem><para>Handling of power/sleep hardware
71       keys</para></listitem>
72
73       <listitem><para>Multi-seat management</para></listitem>
74
75       <listitem><para>Session switch management</para></listitem>
76
77       <listitem><para>Device access management for
78       users</para></listitem>
79
80     </itemizedlist>
81
82     <para>User sessions are registered in elogind via the
83     <citerefentry><refentrytitle>pam_elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>
84     PAM module.</para>
85
86     <para>See
87     <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
88     for information about the configuration of this service.</para>
89
90     <para>See <ulink
91     url="http://www.freedesktop.org/wiki/Software/systemd/multiseat">Multi-Seat
92     on Linux</ulink> for an introduction into basic concepts of logind
93     such as users, sessions and seats.</para>
94
95     <para>See the <ulink
96     url="http://www.freedesktop.org/wiki/Software/systemd/logind">
97     logind D-Bus API Documentation</ulink> for information about the
98     APIs <filename>logind</filename> provides.</para>
99
100     <para>For more information on the inhibition logic see the <ulink
101     url="http://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor
102     Lock Developer Documentation</ulink>.</para>
103   </refsect1>
104
105   <refsect1>
106     <title>See Also</title>
107     <para>
108       <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
109       <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
110       <citerefentry><refentrytitle>pam_elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>
111     </para>
112   </refsect1>
113
114 </refentry>