source: general/sysutils/elogind.xml@ 45ab6c7

trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 11.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY elogind-download-http "https://github.com/elogind/elogind/archive/v&elogind-version;/elogind-&elogind-version;.tar.gz">
8 <!ENTITY elogind-download-ftp " ">
9 <!ENTITY elogind-md5sum "32ab2201281f14738d9c045f3669c14d">
10 <!ENTITY elogind-size "1.5 MB">
11 <!ENTITY elogind-buildsize "66 MB (with tests)">
12 <!ENTITY elogind-time "0.2 SBU (with parallelism=4)">
13]>
14
15<sect1 id="elogind" revision="sysv" xreflabel="elogind-&elogind-version;">
16 <?dbhtml filename="elogind.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>elogind-&elogind-version;</title>
23
24 <indexterm zone="elogind">
25 <primary sortas="a-elogind">elogind</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to elogind</title>
30
31 <para>
32 <application>elogind</application> is the
33 <application>systemd</application> project's "logind", extracted out to
34 be a standalone daemon. It integrates with <xref linkend="linux-pam"/>
35 to know the set of users that are logged in to a system and whether they
36 are logged in graphically, on the console, or remotely.
37 <application>Elogind</application> exposes this information via the
38 standard org.freedesktop.login1 <application>D-Bus</application>
39 interface, as well as through the file system using systemd's standard
40 <filename class="directory">/run/systemd</filename> layout.
41 </para>
42
43 &lfs101_checked;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>
49 Download (HTTP): <ulink url="&elogind-download-http;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download (FTP): <ulink url="&elogind-download-ftp;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download MD5 sum: &elogind-md5sum;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download size: &elogind-size;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated disk space required: &elogind-buildsize;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated build time: &elogind-time;
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">elogind Dependencies</bridgehead>
80
81 <bridgehead renderas="sect4">Required</bridgehead>
82 <para role="required">
83 <xref role="first" linkend="dbus"/>
84 </para>
85
86 <bridgehead renderas="sect4">Recommended</bridgehead>
87 <para role="recommended">
88 <xref linkend="DocBook"/>,
89 <xref linkend="docbook-xsl"/>, and
90 <xref linkend="libxslt"/> (all three to build the man pages),
91 <xref linkend="linux-pam"/>, and
92 <xref linkend="polkit"/>
93 </para>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 For the tests:
98 <xref linkend="lxml"/>,
99 <xref linkend="gobject-introspection"/>,
100 <xref linkend="zsh"/>,
101 <xref linkend="valgrind"/>,
102 <ulink url="https://github.com/linux-audit/audit-userspace">
103 audit-userspace</ulink>,
104 <ulink url="https://github.com/scop/bash-completion">
105 bash-completion</ulink>,
106 <ulink url="https://mirrors.edge.kernel.org/pub/linux/utils/kernel/kexec/">
107 kexec</ulink>, and
108 <ulink url="http://www.selinuxproject.org/page/Main_Page">
109 SELinux</ulink>
110 </para>
111
112 <para condition="html" role="usernotes">User Notes:
113 <ulink url="&blfs-wiki;/elogind"/>
114 </para>
115 </sect2>
116
117 <sect2 role="kernel" id="elogind-kernel">
118 <title>Kernel Configuration</title>
119
120 <para>
121 Enable the following options in the kernel configuration and recompile the
122 kernel if necessary:
123 </para>
124
125<!-- Spaces are significant in <screen> sections -->
126<screen><literal>General setup ---&gt;
127 [*] Control Group support [CONFIG_CGROUPS]
128File systems ---&gt;
129 [*] Inotify support for userspace [CONFIG_INOTIFY_USER]
130 Pseudo filesystems ---&gt;
131 [*] Tmpfs POSIX Access Control Lists [CONFIG_TMPFS_POSIX_ACL]</literal></screen>
132
133 <para>
134 In addition, some tests need the userspace cryptographic kernel API, which
135 is enabled with:
136 </para>
137
138<screen><literal>-*- Cryptographic API ---&gt; [CONFIG_CRYPTO]
139 &lt;M/*&gt; Userspace cryptographic algorithm configuration [CONFIG_CRYPTO_USER]
140 &lt;M/*&gt; User-space interface for hash algorithms [CONFIG_CRYPTO_USER_API_HASH]</literal></screen>
141
142 <indexterm zone="elogind elogind-kernel">
143 <primary sortas="d-elogind">elogind</primary>
144 </indexterm>
145 </sect2>
146
147 <sect2 role="installation">
148 <title>Installation of elogind</title>
149
150 <para>
151 Install <application>elogind</application> by running the following
152 commands:
153 </para>
154
155<screen><userinput>mkdir build &amp;&amp;
156cd build &amp;&amp;
157
158meson --prefix=/usr \
159 -Dcgroup-controller=elogind \
160 -Ddbuspolicydir=/etc/dbus-1/system.d \
161 -Dman=auto \
162 .. &amp;&amp;
163ninja</userinput></screen>
164
165 <para>
166 To test the results, issue: <command>ninja test</command>. A few tests
167 are skipped if not run with <systemitem class="username">root</systemitem>
168 privileges.
169 </para>
170
171 <para>
172 Now, as the <systemitem class="username">root</systemitem> user:
173 </para>
174
175<screen role="root"><userinput>ninja install &amp;&amp;
176ln -sfv libelogind.pc /usr/lib/pkgconfig/libsystemd.pc &amp;&amp;
177ln -sfvn elogind /usr/include/systemd</userinput></screen>
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para>
185 <parameter>-Dcgroup-controller=elogind</parameter>: This switch ensures
186 that <application>elogind</application> is selected as the cgroup
187 controller, even if booted with another running cgroup controller.
188 </para>
189
190 <para>
191 <parameter>-Ddbuspolicydir=/etc/dbus-1/system.d</parameter>: This switch
192 sets the location of the <application>D-Bus</application> policy
193 directory.
194 </para>
195
196 <para>
197 <parameter>-Dman=auto</parameter>: The default value of this switch is
198 <emphasis>false</emphasis>. Setting it to <emphasis>auto</emphasis>
199 allows building and installing the man pages if the recommended
200 dependencies are installed.
201 </para>
202
203 <para>
204 <option>-Ddefault-kill-user-processes=false</option>: Configure whether
205 the processes of a user should be killed when the user logs out. The
206 default is <emphasis>true</emphasis>, but this defeats the traditional
207 use of <command>screen</command> or <command>tmux</command>. This can
208 also be changed in the configuration file (see below).
209 </para>
210
211 <para>
212 <command>ln -s ...</command>: These commands install symlinks so that
213 software packages find systemd compatible library and headers.
214 </para>
215
216 </sect2>
217
218 <sect2 role="configuration">
219 <title>Configuring elogind</title>
220
221 <sect3 id="elogind-config">
222 <title>Config File</title>
223 <para>
224 <filename>/etc/elogind/logind.conf</filename>
225 </para>
226
227 <indexterm zone="elogind elogind-config">
228 <primary
229 sortas="e-etc-elogind-logind.conf">/etc/elogind/logind.conf</primary>
230 </indexterm>
231 </sect3>
232
233 <sect3><title>Configuration Information</title>
234
235 <para>
236 The installed file <filename>/etc/elogind/logind.conf</filename>
237 contains all the possible options with their defaults, commented
238 out. You may wish to disable killing user processes when the user logs
239 out, by running, as the <systemitem class="username">root</systemitem>
240 user:
241 </para>
242
243<screen role="root"><userinput>sed -e '/\[Login\]/a KillUserProcesses=no' \
244 -i /etc/elogind/logind.conf</userinput></screen>
245
246 <para>
247 Each user will need to register a user session using
248 <application>Linux-PAM</application> at login. The
249 <filename>/etc/pam.d/system-session</filename> file needs to
250 be modified and a new file needs to be created in order for
251 <command>elogind</command> to work correctly. Run the following
252 commands as the <systemitem class="username">root</systemitem> user:
253 </para>
254
255<screen role="root"><userinput>cat &gt;&gt; /etc/pam.d/system-session &lt;&lt; "EOF" &amp;&amp;
256<literal># Begin elogind addition
257
258session required pam_loginuid.so
259session optional pam_elogind.so
260
261# End elogind addition</literal>
262EOF
263cat &gt; /etc/pam.d/elogind-user &lt;&lt; "EOF"
264<literal># Begin /etc/pam.d/elogind-user
265
266account required pam_access.so
267account include system-account
268
269session required pam_env.so
270session required pam_limits.so
271session required pam_unix.so
272session required pam_loginuid.so
273session optional pam_keyinit.so force revoke
274session optional pam_elogind.so
275
276auth required pam_deny.so
277password required pam_deny.so
278
279# End /etc/pam.d/elogind-user</literal>
280EOF</userinput></screen>
281
282 </sect3>
283 </sect2>
284
285 <sect2 role="content" revision="sysv">
286 <title>Contents</title>
287
288 <segmentedlist>
289 <segtitle>Installed Programs</segtitle>
290 <segtitle>Installed Library</segtitle>
291 <segtitle>Installed Directories</segtitle>
292
293 <seglistitem>
294 <seg>
295 busctl,
296 elogind-inhibit, and
297 loginctl
298 </seg>
299 <seg>
300 libelogind.so
301 </seg>
302 <seg>
303 /lib/elogind,
304 /etc/elogind,
305 /usr/include/elogind, and
306 /usr/share/doc/elogind-&elogind-version;
307 </seg>
308 </seglistitem>
309 </segmentedlist>
310
311 <variablelist>
312 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
313 <?dbfo list-presentation="list"?>
314 <?dbhtml list-presentation="table"?>
315
316 <varlistentry id="busctl">
317 <term><command>busctl</command></term>
318 <listitem>
319 <para>
320 is used to introspect and monitor the D-Bus bus
321 </para>
322 <indexterm zone="elogind busctl">
323 <primary sortas="b-busctl">busctl</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="elogind-inhibit">
329 <term><command>elogind-inhibit</command></term>
330 <listitem>
331 <para>
332 is used to execute a program with a shutdown, sleep or idle
333 inhibitor lock taken
334 </para>
335 <indexterm zone="elogind elogind-inhibit">
336 <primary sortas="b-elogind-inhibit">elogind-inhibit</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="loginctl">
342 <term><command>loginctl</command></term>
343 <listitem>
344 <para>
345 is used to introspect and control the state of the elogind Login
346 Manager
347 </para>
348 <indexterm zone="elogind loginctl">
349 <primary sortas="b-loginctl">loginctl</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="libelogind">
355 <term><filename class="libraryfile">libelogind.so</filename></term>
356 <listitem>
357 <para>
358 is the main elogind utility library
359 </para>
360 <indexterm zone="elogind libelogind">
361 <primary sortas="c-libelogind">libelogind.so</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 </variablelist>
367
368 </sect2>
369
370</sect1>
Note: See TracBrowser for help on using the repository browser.