chiark / gitweb /
Merge patches from Hleb Valoshka
[elogind.git] / man / elogind.xml
1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
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     xmlns:xi="http://www.w3.org/2001/XInclude">
26
27   <refentryinfo>
28     <title>elogind</title>
29     <productname>elogind</productname>
30
31     <authorgroup>
32       <author>
33         <contrib>Developer</contrib>
34         <firstname>Lennart</firstname>
35         <surname>Poettering</surname>
36         <email>lennart@poettering.net</email>
37       </author>
38     </authorgroup>
39   </refentryinfo>
40
41   <refmeta>
42     <refentrytitle>elogind</refentrytitle>
43     <manvolnum>8</manvolnum>
44   </refmeta>
45
46   <refnamediv>
47     <refname>elogind</refname>
48     <refpurpose>Login manager</refpurpose>
49   </refnamediv>
50
51   <refsynopsisdiv>
52     <para><filename>/usr/libexec/elogind/elogind</filename></para>
53   </refsynopsisdiv>
54
55   <refsect1>
56     <title>Description</title>
57
58     <para><command>elogind</command> is a system service that
59     manages user logins. It is responsible for:</para>
60
61     <itemizedlist>
62       <listitem><para>Keeping track of users and sessions, their
63       processes and their idle state</para></listitem>
64
65       <listitem><para>Providing PolicyKit-based access for users to
66       operations such as system shutdown or sleep</para></listitem>
67
68       <listitem><para>Implementing a shutdown/sleep inhibition logic
69       for applications</para></listitem>
70
71       <listitem><para>Handling of power/sleep hardware
72       keys</para></listitem>
73
74       <listitem><para>Multi-seat management</para></listitem>
75
76       <listitem><para>Session switch management</para></listitem>
77
78       <listitem><para>Device access management for
79       users</para></listitem>
80
81     </itemizedlist>
82
83     <para>User sessions are registered in elogind via the
84     <citerefentry><refentrytitle>pam_elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>
85     PAM module.</para>
86
87     <para>See
88     <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
89     for information about the configuration of this service.</para>
90
91     <para>See <ulink
92     url="http://www.freedesktop.org/wiki/Software/systemd/multiseat">Multi-Seat
93     on Linux</ulink> for an introduction into basic concepts of logind
94     such as users, sessions and seats.</para>
95
96     <para>See the <ulink
97     url="http://www.freedesktop.org/wiki/Software/systemd/logind">
98     logind D-Bus API Documentation</ulink> for information about the
99     APIs <filename>logind</filename> provides.</para>
100
101     <para>For more information on the inhibition logic see the <ulink
102     url="http://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor
103     Lock Developer Documentation</ulink>.</para>
104   </refsect1>
105
106   <refsect1>
107     <title>See Also</title>
108     <para>
109       <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
110       <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
111       <citerefentry><refentrytitle>pam_elogind</refentrytitle><manvolnum>8</manvolnum></citerefentry>
112     </para>
113   </refsect1>
114
115 </refentry>