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 dbus-download-http "http://dbus.freedesktop.org/releases/dbus/dbus-&dbus-version;.tar.gz">
|
---|
8 | <!ENTITY dbus-download-ftp " ">
|
---|
9 | <!ENTITY dbus-md5sum "a70edc50524f258eaf5c9a9994ed8748">
|
---|
10 | <!ENTITY dbus-size "1.9 MB">
|
---|
11 | <!ENTITY dbus-buildsize "44 MB">
|
---|
12 | <!ENTITY dbus-time "0.3 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="dbus" xreflabel="D-Bus-&dbus-version;">
|
---|
16 | <?dbhtml filename="dbus.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>D-Bus-&dbus-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="dbus">
|
---|
26 | <primary sortas="a-D-Bus">D-Bus</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to D-Bus</title>
|
---|
31 |
|
---|
32 | <para>
|
---|
33 | <application>D-Bus</application> is a message bus system, a simple
|
---|
34 | way for applications to talk to one another.
|
---|
35 | <application>D-Bus</application> supplies both a system daemon (for events
|
---|
36 | such as <quote>new hardware device added</quote> or <quote>printer queue
|
---|
37 | changed</quote>) and a per-user-login-session daemon (for general IPC needs
|
---|
38 | among user applications). Also, the message bus is built on top of a
|
---|
39 | general one-to-one message passing framework, which can be used by any two
|
---|
40 | applications to communicate directly (without going through the message bus
|
---|
41 | daemon).
|
---|
42 | </para>
|
---|
43 |
|
---|
44 | &lfs73_checked;
|
---|
45 |
|
---|
46 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
47 | <itemizedlist spacing="compact">
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download (HTTP): <ulink url="&dbus-download-http;"/>
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download (FTP): <ulink url="&dbus-download-ftp;"/>
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Download MD5 sum: &dbus-md5sum;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Download size: &dbus-size;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | <listitem>
|
---|
69 | <para>
|
---|
70 | Estimated disk space required: &dbus-buildsize;
|
---|
71 | </para>
|
---|
72 | </listitem>
|
---|
73 | <listitem>
|
---|
74 | <para>
|
---|
75 | Estimated build time: &dbus-time;
|
---|
76 | </para>
|
---|
77 | </listitem>
|
---|
78 | </itemizedlist>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect3">D-Bus Dependencies</bridgehead>
|
---|
81 |
|
---|
82 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
83 | <para role="required">
|
---|
84 | <xref linkend="expat"/> or
|
---|
85 | <xref linkend="libxml2"/>
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
89 | <para role="recommended">
|
---|
90 | <xref linkend="xorg7-lib"/>
|
---|
91 | (for <command>dbus-launch</command> program)
|
---|
92 | </para>
|
---|
93 |
|
---|
94 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
95 | <para role="optional">
|
---|
96 | <xref linkend="dbus-glib"/> (to run tests),
|
---|
97 | <xref linkend="python2"/> (to run tests) and
|
---|
98 | <xref linkend="doxygen"/> (to generate the API documentation)
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | <para>
|
---|
102 | Note that the <command>configure</command> script will look for
|
---|
103 | <xref linkend="xmlto"/> but it does nothing as the XML/HTML documentation is
|
---|
104 | already shipped in the source tree.
|
---|
105 | </para>
|
---|
106 |
|
---|
107 | <para condition="html" role="usernotes">User Notes:
|
---|
108 | <ulink url="&blfs-wiki;/dbus"/>
|
---|
109 | </para>
|
---|
110 | </sect2>
|
---|
111 |
|
---|
112 | <sect2 role="installation">
|
---|
113 | <title>Installation of D-Bus</title>
|
---|
114 |
|
---|
115 | <para>
|
---|
116 | As the <systemitem class="username">root</systemitem> user, create a
|
---|
117 | system user and group to handle the system message bus activity:
|
---|
118 | </para>
|
---|
119 |
|
---|
120 | <screen role="root"><userinput>groupadd -g 18 messagebus &&
|
---|
121 | useradd -c "D-Bus Message Daemon User" -d /var/run/dbus \
|
---|
122 | -u 18 -g messagebus -s /bin/false messagebus</userinput></screen>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | Install <application>D-Bus</application> by running the following
|
---|
126 | commands (you may wish to review the output from
|
---|
127 | <command>./configure --help</command> first and add any desired parameters
|
---|
128 | to the <command>configure</command> command shown below):
|
---|
129 | </para>
|
---|
130 |
|
---|
131 | <screen><userinput>./configure --prefix=/usr \
|
---|
132 | --sysconfdir=/etc \
|
---|
133 | --localstatedir=/var \
|
---|
134 | --libexecdir=/usr/lib/dbus-1.0 \
|
---|
135 | --with-console-auth-dir=/run/console/ \
|
---|
136 | --without-systemdsystemunitdir \
|
---|
137 | --disable-systemd \
|
---|
138 | --disable-static &&
|
---|
139 | make</userinput></screen>
|
---|
140 |
|
---|
141 | <para>
|
---|
142 | See below for test instructions.
|
---|
143 | </para>
|
---|
144 |
|
---|
145 | <para>
|
---|
146 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
147 | </para>
|
---|
148 |
|
---|
149 | <screen role="root"><userinput>make install &&
|
---|
150 | mv -v /usr/share/doc/dbus /usr/share/doc/dbus-&dbus-version;</userinput></screen>
|
---|
151 |
|
---|
152 | <para>
|
---|
153 | If you are still building your system in chroot or you did not start the
|
---|
154 | daemon yet, but you want to compile some packages that require
|
---|
155 | <application>D-Bus</application>, generate
|
---|
156 | <application>D-Bus</application> UUID to avoid warnings when compiling
|
---|
157 | some packages with the following command as the
|
---|
158 | <systemitem class="username">root</systemitem> user:
|
---|
159 | </para>
|
---|
160 |
|
---|
161 | <screen role="root"><userinput>dbus-uuidgen --ensure</userinput></screen>
|
---|
162 |
|
---|
163 | <para>
|
---|
164 | The dbus tests cannot be run until after <xref linkend="dbus-glib"/>
|
---|
165 | has been installed. The tests require passing additional parameters to
|
---|
166 | <command>configure</command> and exposing additional functionality in the
|
---|
167 | binaries. These interfaces are not intended to be used in a production
|
---|
168 | build of <application>D-Bus</application>. If you would like to run the
|
---|
169 | unit tests, issue the following commands:
|
---|
170 | </para>
|
---|
171 |
|
---|
172 | <screen><userinput>make distclean &&
|
---|
173 | ./configure --enable-tests --enable-asserts &&
|
---|
174 | make &&
|
---|
175 | make check &&
|
---|
176 | make distclean</userinput></screen>
|
---|
177 |
|
---|
178 | <para>
|
---|
179 | Note there has been a report that the tests may fail if running
|
---|
180 | inside a Midnight Commander shell.
|
---|
181 | You may get out-of-memory error messages when running the tests.
|
---|
182 | These are normal and can be safely ignored.
|
---|
183 | </para>
|
---|
184 |
|
---|
185 | </sect2>
|
---|
186 |
|
---|
187 | <sect2 role="commands">
|
---|
188 | <title>Command Explanations</title>
|
---|
189 |
|
---|
190 | <para>
|
---|
191 | <parameter>--with-console-auth-dir=/run/console/</parameter>: This
|
---|
192 | parameter specifies location of the
|
---|
193 | <application>ConsoleKit</application> auth dir.
|
---|
194 | </para>
|
---|
195 |
|
---|
196 | <para>
|
---|
197 | <option>--without-systemdsystemunitdir</option>: This switch prevents
|
---|
198 | installation of systemd unit files.
|
---|
199 | </para>
|
---|
200 |
|
---|
201 | <para>
|
---|
202 | <option>--disable-systemd</option>: This switch disables systemd
|
---|
203 | support in <application>D-Bus</application>
|
---|
204 | </para>
|
---|
205 |
|
---|
206 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
207 | href="../../xincludes/static-libraries.xml"/>
|
---|
208 |
|
---|
209 | <para>
|
---|
210 | <option>--enable-tests</option>: Build extra parts of the code to support
|
---|
211 | testing. Configure will end with a NOTE warning about this.
|
---|
212 | </para>
|
---|
213 |
|
---|
214 | <para>
|
---|
215 | <option>--enable-asserts</option>: Enable debugging code to run assertions for
|
---|
216 | statements normally assumed to be true. This prevents a warning that
|
---|
217 | '<parameter>--enable-tests</parameter>' on its own is only useful for profiling
|
---|
218 | and might not give true results for all tests, but adds its own NOTE that this
|
---|
219 | should not be used in a production build.
|
---|
220 | </para>
|
---|
221 |
|
---|
222 | </sect2>
|
---|
223 |
|
---|
224 | <sect2 role="configuration">
|
---|
225 | <title>Configuring dbus</title>
|
---|
226 |
|
---|
227 | <sect3 id="dbus-config">
|
---|
228 | <title>Config Files</title>
|
---|
229 |
|
---|
230 | <para>
|
---|
231 | <filename>/etc/dbus-1/session.conf</filename>,
|
---|
232 | <filename>/etc/dbus-1/system.conf</filename> and
|
---|
233 | <filename>/etc/dbus-1/system.d/*</filename>
|
---|
234 | </para>
|
---|
235 |
|
---|
236 | <indexterm zone="dbus dbus-config">
|
---|
237 | <primary sortas="e-etc-dbus-1-session.conf">/etc/dbus-1/session.conf</primary>
|
---|
238 | </indexterm>
|
---|
239 |
|
---|
240 | <indexterm zone="dbus dbus-config">
|
---|
241 | <primary sortas="e-etc-dbus-1/system.conf">/etc/dbus-1/system.conf</primary>
|
---|
242 | </indexterm>
|
---|
243 |
|
---|
244 | <indexterm zone="dbus dbus-config">
|
---|
245 | <primary sortas="e-etc-dbus-1-system.d-star">/etc/dbus-1/system.d/*</primary>
|
---|
246 | </indexterm>
|
---|
247 |
|
---|
248 | </sect3>
|
---|
249 |
|
---|
250 | <sect3 id="dbus-session-config" xreflabel="D-Bus custom services directory">
|
---|
251 | <title>Configuration Information</title>
|
---|
252 |
|
---|
253 | <para>
|
---|
254 | The configuration files listed above should probably not be
|
---|
255 | modified. If changes are required, you should create
|
---|
256 | <filename>/etc/dbus-1/session-local.conf</filename> and/or
|
---|
257 | <filename>/etc/dbus-1/system-local.conf</filename> and make any
|
---|
258 | desired changes to these files.
|
---|
259 | </para>
|
---|
260 |
|
---|
261 | <para>
|
---|
262 | If any packages install a
|
---|
263 | <application>D-Bus</application> <filename>.service</filename>
|
---|
264 | file outside of the standard <filename
|
---|
265 | class="directory">/usr/share/dbus-1/services</filename> directory,
|
---|
266 | that directory should be added to the local session configuration.
|
---|
267 | For instance, <filename
|
---|
268 | class="directory">/usr/local/share/dbus-1/services</filename> can
|
---|
269 | be added by performing the following commands as the
|
---|
270 | <systemitem class="username">root</systemitem> user:
|
---|
271 | </para>
|
---|
272 |
|
---|
273 | <screen role="root"><userinput>cat > /etc/dbus-1/session-local.conf << "EOF"
|
---|
274 | <literal><!DOCTYPE busconfig PUBLIC
|
---|
275 | "-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN"
|
---|
276 | "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
|
---|
277 | <busconfig>
|
---|
278 |
|
---|
279 | <!-- Search for .service files in /usr/local -->
|
---|
280 | <servicedir>/usr/local/share/dbus-1/services</servicedir>
|
---|
281 |
|
---|
282 | </busconfig></literal>
|
---|
283 | EOF</userinput></screen>
|
---|
284 |
|
---|
285 | </sect3>
|
---|
286 |
|
---|
287 | <sect3 id="dbus-init">
|
---|
288 | <title>Boot Script</title>
|
---|
289 |
|
---|
290 | <para>
|
---|
291 | To automatically start <command>dbus-daemon</command> when the
|
---|
292 | system is rebooted, install the
|
---|
293 | <filename>/etc/rc.d/init.d/dbus</filename> bootscript from the
|
---|
294 | <xref linkend="bootscripts"/> package.
|
---|
295 | </para>
|
---|
296 |
|
---|
297 | <indexterm zone="dbus dbus-init">
|
---|
298 | <primary sortas="f-dbus">dbus</primary>
|
---|
299 | </indexterm>
|
---|
300 |
|
---|
301 | <screen role="root"><userinput>make install-dbus</userinput></screen>
|
---|
302 |
|
---|
303 | <para>
|
---|
304 | Note that this boot script only starts the system-wide
|
---|
305 | <application>D-Bus</application> daemon. Each user requiring access to
|
---|
306 | <application>D-Bus</application> services will also need to run a
|
---|
307 | session daemon as well. There are many methods you can use to start a
|
---|
308 | session daemon using the <command>dbus-launch</command> command. Review
|
---|
309 | the <command>dbus-launch</command> man page for details about the
|
---|
310 | available parameters and options. Here are some suggestions and
|
---|
311 | examples:
|
---|
312 | </para>
|
---|
313 |
|
---|
314 | <itemizedlist spacing="compact">
|
---|
315 | <listitem>
|
---|
316 | <para>
|
---|
317 | Add <command>dbus-launch</command> to the line in the
|
---|
318 | <filename>~/.xinitrc</filename> file that starts your graphical
|
---|
319 | desktop environment.
|
---|
320 | </para>
|
---|
321 | </listitem>
|
---|
322 | <listitem>
|
---|
323 | <para>
|
---|
324 | If you use <command>xdm</command> or some other display manager
|
---|
325 | that calls the <filename>~/.xsession</filename> file, you can add
|
---|
326 | <command>dbus-launch</command> to the line in your
|
---|
327 | <filename>~/.xsession</filename> file that starts your graphical
|
---|
328 | desktop environment. The syntax would be similar to the example in
|
---|
329 | the <filename>~/.xinitrc</filename> file.
|
---|
330 | </para>
|
---|
331 | </listitem>
|
---|
332 | <listitem>
|
---|
333 | <para>
|
---|
334 | The examples shown previously use
|
---|
335 | <command>dbus-launch</command> to specify a program to be run. This
|
---|
336 | has the benefit (when also using the
|
---|
337 | <parameter>--exit-with-session</parameter> parameter) of stopping the
|
---|
338 | session daemon when the specified program is stopped. You can also
|
---|
339 | start the session daemon in your system or personal startup scripts
|
---|
340 | by adding the following lines:
|
---|
341 | </para>
|
---|
342 |
|
---|
343 | <screen><userinput><literal># Start the D-Bus session daemon
|
---|
344 | eval `dbus-launch`
|
---|
345 | export DBUS_SESSION_BUS_ADDRESS</literal></userinput></screen>
|
---|
346 |
|
---|
347 | <para>
|
---|
348 | This method will not stop the session daemon when you exit
|
---|
349 | your shell, therefore you should add the following line to your
|
---|
350 | <filename>~/.bash_logout</filename> file:
|
---|
351 | </para>
|
---|
352 |
|
---|
353 | <screen><userinput><literal># Kill the D-Bus session daemon
|
---|
354 | kill $DBUS_SESSION_BUS_PID</literal></userinput></screen>
|
---|
355 | </listitem>
|
---|
356 |
|
---|
357 | <listitem>
|
---|
358 | <para>
|
---|
359 | A hint has been written that provides ways to start scripts
|
---|
360 | using the KDM session manager of KDE. The concepts in this hint could
|
---|
361 | possibly be used with other session managers as well. The hint is
|
---|
362 | located at <ulink
|
---|
363 | url="&hints-root;/downloads/files/execute-session-scripts-using-kdm.txt"/>.
|
---|
364 | </para>
|
---|
365 | </listitem>
|
---|
366 |
|
---|
367 | </itemizedlist>
|
---|
368 |
|
---|
369 | </sect3>
|
---|
370 |
|
---|
371 | </sect2>
|
---|
372 |
|
---|
373 | <sect2 role="content">
|
---|
374 | <title>Contents</title>
|
---|
375 |
|
---|
376 | <segmentedlist>
|
---|
377 | <segtitle>Installed Programs</segtitle>
|
---|
378 | <segtitle>Installed Library</segtitle>
|
---|
379 | <segtitle>Installed Directories</segtitle>
|
---|
380 |
|
---|
381 | <seglistitem>
|
---|
382 | <seg>
|
---|
383 | dbus-cleanup-sockets, dbus-daemon, dbus-launch, dbus-monitor,
|
---|
384 | dbus-send and dbus-uuidgen
|
---|
385 | </seg>
|
---|
386 | <seg>
|
---|
387 | libdbus-1.so
|
---|
388 | </seg>
|
---|
389 | <seg>
|
---|
390 | /etc/dbus-1,
|
---|
391 | /usr/include/dbus-1.0,
|
---|
392 | /usr/lib/dbus-1.0,
|
---|
393 | /usr/share/dbus-1,
|
---|
394 | /usr/share/doc/dbus-&dbus-version; and
|
---|
395 | /var/lib/dbus
|
---|
396 | </seg>
|
---|
397 | </seglistitem>
|
---|
398 | </segmentedlist>
|
---|
399 |
|
---|
400 | <variablelist>
|
---|
401 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
402 | <?dbfo list-presentation="list"?>
|
---|
403 | <?dbhtml list-presentation="table"?>
|
---|
404 |
|
---|
405 | <varlistentry id="dbus-cleanup-sockets">
|
---|
406 | <term><command>dbus-cleanup-sockets</command></term>
|
---|
407 | <listitem>
|
---|
408 | <para>
|
---|
409 | is used to clean up leftover sockets in a directory.
|
---|
410 | </para>
|
---|
411 | <indexterm zone="dbus dbus-cleanup-sockets">
|
---|
412 | <primary sortas="b-dbus-cleanup-sockets">dbus-cleanup-sockets</primary>
|
---|
413 | </indexterm>
|
---|
414 | </listitem>
|
---|
415 | </varlistentry>
|
---|
416 |
|
---|
417 | <varlistentry id="dbus-daemon">
|
---|
418 | <term><command>dbus-daemon</command></term>
|
---|
419 | <listitem>
|
---|
420 | <para>
|
---|
421 | is the <application>D-Bus</application> message bus daemon.
|
---|
422 | </para>
|
---|
423 | <indexterm zone="dbus dbus-daemon">
|
---|
424 | <primary sortas="b-dbus-daemon">dbus-daemon</primary>
|
---|
425 | </indexterm>
|
---|
426 | </listitem>
|
---|
427 | </varlistentry>
|
---|
428 |
|
---|
429 | <varlistentry id="dbus-launch">
|
---|
430 | <term><command>dbus-launch</command></term>
|
---|
431 | <listitem>
|
---|
432 | <para>
|
---|
433 | is used to start <command>dbus-daemon</command> from a shell
|
---|
434 | script. It would normally be called from a user's login
|
---|
435 | scripts.
|
---|
436 | </para>
|
---|
437 | <indexterm zone="dbus dbus-launch">
|
---|
438 | <primary sortas="b-dbus-launch">dbus-launch</primary>
|
---|
439 | </indexterm>
|
---|
440 | </listitem>
|
---|
441 | </varlistentry>
|
---|
442 |
|
---|
443 | <varlistentry id="dbus-monitor">
|
---|
444 | <term><command>dbus-monitor</command></term>
|
---|
445 | <listitem>
|
---|
446 | <para>
|
---|
447 | is used to monitor messages going through a
|
---|
448 | <application>D-Bus</application> message bus.
|
---|
449 | </para>
|
---|
450 | <indexterm zone="dbus dbus-monitor">
|
---|
451 | <primary sortas="b-dbus-monitor">dbus-monitor</primary>
|
---|
452 | </indexterm>
|
---|
453 | </listitem>
|
---|
454 | </varlistentry>
|
---|
455 |
|
---|
456 | <varlistentry id="dbus-send">
|
---|
457 | <term><command>dbus-send</command></term>
|
---|
458 | <listitem>
|
---|
459 | <para>
|
---|
460 | is used to send a message to a <application>D-Bus</application>
|
---|
461 | message bus.
|
---|
462 | </para>
|
---|
463 | <indexterm zone="dbus dbus-send">
|
---|
464 | <primary sortas="b-dbus-send">dbus-send</primary>
|
---|
465 | </indexterm>
|
---|
466 | </listitem>
|
---|
467 | </varlistentry>
|
---|
468 |
|
---|
469 | <varlistentry id="dbus-uuidgen">
|
---|
470 | <term><command>dbus-uuidgen</command></term>
|
---|
471 | <listitem>
|
---|
472 | <para>
|
---|
473 | is used to generate a universally unique ID.
|
---|
474 | </para>
|
---|
475 | <indexterm zone="dbus dbus-uuidgen">
|
---|
476 | <primary sortas="b-dbus-uuidgen">dbus-uuidgen</primary>
|
---|
477 | </indexterm>
|
---|
478 | </listitem>
|
---|
479 | </varlistentry>
|
---|
480 |
|
---|
481 | <varlistentry id="libdbus-1">
|
---|
482 | <term><filename class="libraryfile">libdbus-1.so</filename></term>
|
---|
483 | <listitem>
|
---|
484 | <para>
|
---|
485 | contains the API functions used by the
|
---|
486 | <application>D-Bus</application> message daemon.
|
---|
487 | <application>D-Bus</application> is first a library that provides
|
---|
488 | one-to-one communication between any two applications;
|
---|
489 | <command>dbus-daemon</command> is an application that uses this
|
---|
490 | library to implement a message bus daemon.
|
---|
491 | </para>
|
---|
492 | <indexterm zone="dbus libdbus-1">
|
---|
493 | <primary sortas="c-libdbus-1">libdbus-1.so</primary>
|
---|
494 | </indexterm>
|
---|
495 | </listitem>
|
---|
496 | </varlistentry>
|
---|
497 |
|
---|
498 | </variablelist>
|
---|
499 |
|
---|
500 | </sect2>
|
---|
501 |
|
---|
502 | </sect1>
|
---|
503 |
|
---|