source: archive/consolekit.xml@ c339779

10.1 11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since c339779 was 9014137, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Archive consolkit.
Update to gparted-1.0.0.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21836 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 13.2 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 consolekit-download-http "https://github.com/Consolekit2/ConsoleKit2/releases/download/&consolekit-version;/ConsoleKit2-&consolekit-version;.tar.bz2">
8 <!ENTITY consolekit-download-ftp " ">
9 <!ENTITY consolekit-md5sum "17d31475f9b08969e55ea60750f4f219">
10 <!ENTITY consolekit-size "1.1 MB">
11 <!ENTITY consolekit-buildsize "18 MB">
12 <!ENTITY consolekit-time "0.2 SBU">
13]>
14
15<sect1 id="consolekit" xreflabel="ConsoleKit2-&consolekit-version;">
16 <?dbhtml filename="consolekit.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>ConsoleKit2-&consolekit-version;</title>
24
25 <indexterm zone="consolekit">
26 <primary sortas="a-ConsoleKit">ConsoleKit2</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to ConsoleKit</title>
31
32 <para>
33 The <application>ConsoleKit</application> package is a framework for
34 keeping track of the various users, sessions, and seats present on a system.
35 It provides a mechanism for software to react to changes of any of these
36 items or of any of the metadata associated with them.
37 </para>
38
39 &lfs84_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&consolekit-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&consolekit-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &consolekit-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &consolekit-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &consolekit-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &consolekit-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">ConsoleKit Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="dbus-glib"/> and
80 <xref linkend="xorg7-lib"/>
81 </para>
82
83 <bridgehead renderas="sect4">Recommended</bridgehead>
84 <para role="recommended">
85 <xref linkend="linux-pam"/>,
86 <xref linkend="polkit"/>, and
87 <xref linkend="pm-utils"/> (run-time dependency to allow ConsoleKit2 to
88 put the system in <quote>Suspend</quote> or <quote>Hibernation</quote>
89 mode)
90 </para>
91
92 <warning>
93 <para>
94 If you intend <emphasis role="strong">NOT</emphasis> to install
95 <application>polkit</application>, you will need to manually edit the
96 ConsoleKit.conf file to lock down the service. Failure to do so may be a
97 huge SECURITY HOLE.
98 </para>
99 </warning>
100
101 <bridgehead renderas="sect4">Optional</bridgehead>
102 <para role="optional">
103 <xref linkend="xmlto"/>
104 </para>
105
106 <para condition="html" role="usernotes">User Notes:
107 <ulink url="&blfs-wiki;/consolekit"/>
108 </para>
109 </sect2>
110
111 <sect2 role="installation">
112 <title>Installation of ConsoleKit</title>
113
114 <para>
115 Install <application>ConsoleKit</application> by running the following
116 commands:
117 </para>
118
119<screen><userinput>./configure --prefix=/usr \
120 --sysconfdir=/etc \
121 --localstatedir=/var \
122 --enable-udev-acl \
123 --enable-pam-module \
124 --enable-polkit \
125 --with-xinitrc-dir=/etc/X11/app-defaults/xinitrc.d \
126 --docdir=/usr/share/doc/ConsoleKit-&consolekit-version; \
127 --with-systemdsystemunitdir=no &amp;&amp;
128make</userinput></screen>
129
130 <para>
131 This package does not come with a test suite.
132 </para>
133
134 <para>
135 Now, as the <systemitem class="username">root</systemitem> user:
136 </para>
137
138<screen role="root"><userinput>make install &amp;&amp;
139
140mv -v /etc/X11/app-defaults/xinitrc.d/90-consolekit{,.sh}</userinput></screen>
141
142 </sect2>
143
144 <sect2 role="commands">
145 <title>Command Explanations</title>
146
147 <para>
148 <parameter>--enable-udev-acl</parameter>: This switch enables building of
149 the <command>udev-acl</command> tool, which is used to allow normal users
150 to access device nodes normally only accessible to
151 <systemitem class="username">root</systemitem>.
152 </para>
153
154 <para>
155 <parameter>--enable-pam-module</parameter>: This switch enables building
156 of the <application>ConsoleKit</application>
157 <application>PAM</application> module which is needed for
158 <application>ConsoleKit</application> to work correctly with
159 <application>PAM</application>. Remove if
160 <application>Linux PAM</application> is
161 <emphasis role="strong">NOT</emphasis> installed.
162 </para>
163
164 <para>
165 <parameter>--enable-polkit</parameter>: Enable PolicyKit support.
166 </para>
167
168 <para>
169 <parameter>--with-xinitrc-dir=/etc/X11/app-defaults/xinitrc.d</parameter>:
170 Fix the location of the 90-consolekit.sh script. Notice that the script
171 has been renamed after installation, because xinitrc only sources script
172 names ending with extension <emphasis>.sh</emphasis>.
173 </para>
174
175 <para>
176 <parameter>--with-systemdsystemunitdir=no</parameter>: Disable
177 attempting to build with systemd libraries.
178 </para>
179
180 <para>
181 <option>--enable-docbook-docs</option>: Use this switch if
182 <application>xmlto</application> is installed and you wish to
183 build the user and API documentation.
184 </para>
185
186 </sect2>
187
188 <sect2 role="configuration">
189 <title>Configuring ConsoleKit</title>
190
191 <sect3>
192 <title>PAM Module Configuration</title>
193
194 <para>
195 If you use <application>Linux PAM</application>, it needs to be
196 configured to activate <application>ConsoleKit</application> upon user
197 login. This can be achieved by editing the
198 <filename>/etc/pam.d/system-session</filename> file as the <systemitem
199 class="username">root</systemitem> user:
200 </para>
201
202<screen role="root"><userinput>cat &gt;&gt; /etc/pam.d/system-session &lt;&lt; "EOF"
203<literal># Begin ConsoleKit addition
204
205session optional pam_loginuid.so
206session optional pam_ck_connector.so nox11
207
208# End ConsoleKit addition</literal>
209EOF</userinput></screen>
210
211 <para>
212 You will also need a helper script that creates a file in
213 <filename class="directory">/var/run/console</filename>
214 named as the currently logged in user and that contains the
215 <application>D-Bus</application> address of the session. You
216 can create the script by running the following commands as
217 the <systemitem class="username">root</systemitem> user:
218 </para>
219
220<screen role="root"><userinput>cat &gt; /usr/lib/ConsoleKit/run-session.d/pam-foreground-compat.ck &lt;&lt; "EOF"
221<literal>#!/bin/sh
222TAGDIR=/var/run/console
223
224[ -n "$CK_SESSION_USER_UID" ] || exit 1
225[ "$CK_SESSION_IS_LOCAL" = "true" ] || exit 0
226
227TAGFILE="$TAGDIR/`getent passwd $CK_SESSION_USER_UID | cut -f 1 -d:`"
228
229if [ "$1" = "session_added" ]; then
230 mkdir -p "$TAGDIR"
231 echo "$CK_SESSION_ID" &gt;&gt; "$TAGFILE"
232fi
233
234if [ "$1" = "session_removed" ] &amp;&amp; [ -e "$TAGFILE" ]; then
235 sed -i "\%^$CK_SESSION_ID\$%d" "$TAGFILE"
236 [ -s "$TAGFILE" ] || rm -f "$TAGFILE"
237fi</literal>
238EOF
239chmod -v 755 /usr/lib/ConsoleKit/run-session.d/pam-foreground-compat.ck</userinput></screen>
240
241 <para>
242 See /usr/share/doc/ConsoleKit/spec/ConsoleKit.html for more
243 configuration.
244 </para>
245
246 </sect3>
247
248 </sect2>
249
250 <sect2 role="content">
251 <title>Contents</title>
252
253 <segmentedlist>
254 <segtitle>Installed Programs</segtitle>
255 <segtitle>Installed Libraries</segtitle>
256 <segtitle>Installed Directories</segtitle>
257
258 <seglistitem>
259 <seg>
260 ck-history,
261 ck-launch-session, and
262 ck-list-sessions
263 <!-- Not listing /usr/libexec:
264 ck-collect-session-info ck-get-x11-server-pid udev-acl
265 ck-get-x11-display-device ck-remove-directory -->
266
267 </seg>
268 <seg>
269 libconsolekit.so,
270 libck-connector.so, and
271 pam_ck_connector.so
272 </seg>
273 <seg>
274 /etc/ConsoleKit,
275 /usr/{include,lib}/ConsoleKit,
276 /usr/share/doc/ihtml/ConsoleKit-&consolekit-version;, and
277 /var/{log,run}/ConsoleKit
278 </seg>
279 </seglistitem>
280 </segmentedlist>
281
282 <variablelist>
283 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
284 <?dbfo list-presentation="list"?>
285 <?dbhtml list-presentation="table"?>
286
287 <varlistentry id="ck-history">
288 <term><command>ck-history</command></term>
289 <listitem>
290 <para>is a utility that provides information from the ConsoleKit
291 database about what users have logged into the system.</para>
292 <indexterm zone="consolekit ck-history">
293 <primary sortas="b-ck-history">ck-history</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="ck-launch-session">
299 <term><command>ck-launch-session</command></term>
300 <listitem>
301 <para>is a utility for starting a command in its own ConsoleKit
302 session.
303 </para>
304 <indexterm zone="consolekit ck-launch-session">
305 <primary sortas="b-ck-launch-session">ck-launch-session</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="ck-list-sessions">
311 <term><command>ck-list-sessions</command></term>
312 <listitem>
313 <para>list sessions with respective properties. Also good for
314 debugging purposes.</para>
315 <indexterm zone="consolekit ck-list-sessions">
316 <primary sortas="b-ck-list-sessions">ck-list-sessions</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="ck-log-system-restart">
322 <term><command>ck-log-system-restart</command></term>
323 <listitem>
324 <para>write system restart to log.</para>
325 <indexterm zone="consolekit ck-log-system-restart">
326 <primary sortas="b-ck-log-system-restart">ck-log-system-restart</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="ck-log-system-start">
332 <term><command>ck-log-system-start</command></term>
333 <listitem>
334 <para>write system start to log.</para>
335 <indexterm zone="consolekit ck-log-system-start">
336 <primary sortas="b-ck-log-system-start">ck-log-system-start</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="ck-log-system-stop">
342 <term><command>ck-log-system-stop</command></term>
343 <listitem>
344 <para>write system stop to log.</para>
345 <indexterm zone="consolekit ck-log-system-stop">
346 <primary sortas="b-ck-log-system-stop">ck-log-system-stop</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="console-kit-daemon">
352 <term><command>console-kit-daemon</command></term>
353 <listitem>
354 <para>is the <application>ConsoleKit</application> daemon.</para>
355 <indexterm zone="consolekit console-kit-daemon">
356 <primary sortas="b-console-kit-daemon">console-kit-daemon</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361<!-- Note (Denis): I don't know if theses programs are installed by the
362 current version of consolekit.
363
364 (Bruce) These are in /usr/libexec and we do not document those.
365
366 <varlistentry id="ck-collect-session-info">
367 <term><command>ck-collect-session-info</command></term>
368 <listitem>
369 <para>displays session informations about the current session.</para>
370 <indexterm zone="consolekit ck-collect-session-info">
371 <primary sortas="b-ck-collect-session-info">ck-collect-session-info</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="ck-get-x11-display-device">
377 <term><command>ck-get-x11-display-device</command></term>
378 <listitem>
379 <para>displays the x11 display device of the current session.</para>
380 <indexterm zone="consolekit ck-get-x11-display-device">
381 <primary sortas="b-ck-get-x11-display-device">ck-get-x11-display-device</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="ck-get-x11-server-pid">
387 <term><command>ck-get-x11-server-pid</command></term>
388 <listitem>
389 <para>displays the x11 server pid of the current session.</para>
390 <indexterm zone="consolekit ck-get-x11-server-pid">
391 <primary sortas="b-ck-get-x11-server-pid">ck-get-x11-server-pid</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 also ck-remove-directory udev-acl
397
398-->
399 </variablelist>
400
401 </sect2>
402
403</sect1>
Note: See TracBrowser for help on using the repository browser.