[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[e8e3312d] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[996f3953] | 7 | <!ENTITY dbus-download-http "https://dbus.freedesktop.org/releases/dbus/dbus-&dbus-version;.tar.xz">
|
---|
[30d0aef] | 8 | <!ENTITY dbus-download-ftp " ">
|
---|
[128bc41c] | 9 | <!ENTITY dbus-md5sum "46070a3487817ff690981f8cd2ba9376">
|
---|
[996f3953] | 10 | <!ENTITY dbus-size "1.3 MB">
|
---|
[128bc41c] | 11 | <!ENTITY dbus-buildsize "23 MB (add 25 MB for tests)">
|
---|
| 12 | <!ENTITY dbus-time "0.2 SBU (add 1.5 SBU for tests)">
|
---|
[819a4c7] | 13 | <!-- The former value was 0.8 SBU, which was far more sensible. -->
|
---|
[b66e67e0] | 14 | <!-- I got 'real 0m14.355s' for make check at -j1; bdubbs dbus-1.14.2 -->
|
---|
[e440af5] | 15 | <!-- Now 'real 2m51.642ss' for make check at -j1; bdubbs dbus-1.14.6
|
---|
[404943c6] | 16 | # TOTAL: 217
|
---|
| 17 | # PASS: 217
|
---|
[d241861] | 18 |
|
---|
[128bc41c] | 19 | Sane test results for 1.14.8. -bdubbs
|
---|
| 20 |
|
---|
| 21 | For 1.14.10:
|
---|
| 22 | # TOTAL: 219
|
---|
| 23 | # PASS: 218
|
---|
| 24 | # FAIL: 1
|
---|
| 25 |
|
---|
| 26 | not ok 2 test-autolaunch
|
---|
[404943c6] | 27 | -->
|
---|
[e8e3312d] | 28 | ]>
|
---|
| 29 |
|
---|
[fdaae04] | 30 | <sect1 id="dbus" xreflabel="dbus-&dbus-version;">
|
---|
[e8e3312d] | 31 | <?dbhtml filename="dbus.html"?>
|
---|
| 32 |
|
---|
| 33 |
|
---|
[53375fc] | 34 | <title>dbus-&dbus-version;</title>
|
---|
[e8e3312d] | 35 |
|
---|
[54666831] | 36 | <indexterm zone="dbus">
|
---|
| 37 | <primary sortas="a-D-Bus">D-Bus</primary>
|
---|
[e8e3312d] | 38 | </indexterm>
|
---|
| 39 |
|
---|
| 40 | <sect2 role="package">
|
---|
[54666831] | 41 | <title>Introduction to D-Bus</title>
|
---|
[e8e3312d] | 42 |
|
---|
[5c9e998] | 43 | <para revision="sysv">
|
---|
[108beaf] | 44 | <application>D-Bus</application> is a message bus system, a simple way
|
---|
| 45 | for applications to talk to one another.
|
---|
| 46 | <application>D-Bus</application> supplies both a system daemon (for
|
---|
| 47 | events such as <quote>new hardware device added</quote> or <quote>printer
|
---|
| 48 | queue changed</quote>) and a per-user-login-session daemon (for general
|
---|
| 49 | IPC needs among user applications). Also, the message bus is built on top
|
---|
| 50 | of a general one-to-one message passing framework, which can be used by
|
---|
| 51 | any two applications to communicate directly (without going through the
|
---|
| 52 | message bus daemon).
|
---|
[0b83a69] | 53 | </para>
|
---|
[e8e3312d] | 54 |
|
---|
[5c9e998] | 55 | <para revision="systemd">
|
---|
| 56 | Even though <application>D-Bus</application> was built in LFS, there are
|
---|
| 57 | some features provided by the package that other BLFS packages need, but
|
---|
| 58 | their dependencies didn't fit into LFS.
|
---|
| 59 | </para>
|
---|
| 60 |
|
---|
[d4dc5bae] | 61 | &lfs122_checked;
|
---|
[482477c] | 62 |
|
---|
[e8e3312d] | 63 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 64 | <itemizedlist spacing="compact">
|
---|
| 65 | <listitem>
|
---|
[0b83a69] | 66 | <para>
|
---|
| 67 | Download (HTTP): <ulink url="&dbus-download-http;"/>
|
---|
| 68 | </para>
|
---|
[e8e3312d] | 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
[0b83a69] | 71 | <para>
|
---|
| 72 | Download (FTP): <ulink url="&dbus-download-ftp;"/>
|
---|
| 73 | </para>
|
---|
[e8e3312d] | 74 | </listitem>
|
---|
| 75 | <listitem>
|
---|
[0b83a69] | 76 | <para>
|
---|
| 77 | Download MD5 sum: &dbus-md5sum;
|
---|
| 78 | </para>
|
---|
[e8e3312d] | 79 | </listitem>
|
---|
| 80 | <listitem>
|
---|
[0b83a69] | 81 | <para>
|
---|
| 82 | Download size: &dbus-size;
|
---|
| 83 | </para>
|
---|
[e8e3312d] | 84 | </listitem>
|
---|
| 85 | <listitem>
|
---|
[0b83a69] | 86 | <para>
|
---|
| 87 | Estimated disk space required: &dbus-buildsize;
|
---|
| 88 | </para>
|
---|
[e8e3312d] | 89 | </listitem>
|
---|
| 90 | <listitem>
|
---|
[0b83a69] | 91 | <para>
|
---|
| 92 | Estimated build time: &dbus-time;
|
---|
| 93 | </para>
|
---|
[e8e3312d] | 94 | </listitem>
|
---|
| 95 | </itemizedlist>
|
---|
| 96 |
|
---|
[02e742b] | 97 | <bridgehead renderas="sect3">D-Bus Dependencies</bridgehead>
|
---|
[e8e3312d] | 98 |
|
---|
[54666831] | 99 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 100 | <para role="recommended">
|
---|
[8558044] | 101 | <xref linkend="xorg7-lib"/> (for <command>dbus-launch</command> program)
|
---|
[70d6ea4] | 102 | <!-- elogind cannot be used by dbus: dbus only uses the systemd service,
|
---|
| 103 | not the logind one
|
---|
[bc3bb455] | 104 | <phrase revision="sysv">and <xref linkend="elogind"/> (These are
|
---|
[8558044] | 105 | circular dependencies. First build without them, and then again after
|
---|
[70d6ea4] | 106 | both packages are installed.)</phrase>-->
|
---|
[0b83a69] | 107 | </para>
|
---|
[adfdc8b] | 108 |
|
---|
[e8e3312d] | 109 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b6a2a0e] | 110 | <para role="optional">
|
---|
[30b01dbd] | 111 | <phrase revision="systemd"><xref role="runtime" linkend="systemd"/>
|
---|
[948a362] | 112 | (runtime, for registering services launched by D-Bus session daemon as
|
---|
| 113 | systemd user services);</phrase>
|
---|
[f1d25d2] | 114 | For the tests:
|
---|
[c358685] | 115 | <xref linkend="dbus-python"/>,
|
---|
[1665413] | 116 | <xref linkend="pygobject3"/>,
|
---|
[48b0ed4] | 117 | and <xref linkend="valgrind"/>;
|
---|
[c358685] | 118 |
|
---|
| 119 | for documentation:
|
---|
| 120 | <xref linkend="doxygen"/>,
|
---|
| 121 | <xref linkend="xmlto"/>,
|
---|
| 122 | <ulink url="https://pypi.python.org/pypi/mallard-ducktype">Ducktype</ulink>,
|
---|
| 123 | and
|
---|
[01701da9] | 124 | <ulink url="&gnome-download-http;/yelp-tools/">Yelp Tools</ulink>
|
---|
[0b83a69] | 125 | </para>
|
---|
[c45cb57] | 126 |
|
---|
[e8e3312d] | 127 | </sect2>
|
---|
| 128 |
|
---|
| 129 | <sect2 role="installation">
|
---|
[02e742b] | 130 | <title>Installation of D-Bus</title>
|
---|
[2543b8af] | 131 | <!--
|
---|
[670d3f8] | 132 | <para revision="sysv">
|
---|
[ef52ec2] | 133 | If they do not already exist,
|
---|
| 134 | as the <systemitem class="username">root</systemitem> user, create a
|
---|
[54666831] | 135 | system user and group to handle the system message bus activity:
|
---|
| 136 | </para>
|
---|
| 137 |
|
---|
[670d3f8] | 138 | <screen role="root" revision="sysv"><userinput>groupadd -g 18 messagebus &&
|
---|
[54666831] | 139 | useradd -c "D-Bus Message Daemon User" -d /var/run/dbus \
|
---|
| 140 | -u 18 -g messagebus -s /bin/false messagebus</userinput></screen>
|
---|
[2543b8af] | 141 | -->
|
---|
[54666831] | 142 |
|
---|
| 143 | <para>
|
---|
| 144 | Install <application>D-Bus</application> by running the following
|
---|
[108beaf] | 145 | commands (you may wish to review the output from <command>./configure
|
---|
| 146 | --help</command> first and add any desired parameters to the
|
---|
| 147 | <command>configure</command> command shown below):
|
---|
[0b83a69] | 148 | </para>
|
---|
[e8e3312d] | 149 |
|
---|
[70d6ea4] | 150 | <!-- Only usefull for systemd: it installs the services files in the
|
---|
| 151 | systemd/user
|
---|
| 152 | - -enable-user-session \ -->
|
---|
[9eb7ee7] | 153 | <screen revision="sysv"><userinput>./configure --prefix=/usr \
|
---|
[f29eb8a] | 154 | --sysconfdir=/etc \
|
---|
| 155 | --localstatedir=/var \
|
---|
[86b410e3] | 156 | --runstatedir=/run \
|
---|
[f29eb8a] | 157 | --disable-doxygen-docs \
|
---|
| 158 | --disable-xml-docs \
|
---|
| 159 | --disable-static \
|
---|
[51dfb3e] | 160 | --with-systemduserunitdir=no \
|
---|
| 161 | --with-systemdsystemunitdir=no \
|
---|
[0075912] | 162 | --docdir=/usr/share/doc/dbus-&dbus-version; \
|
---|
[f29eb8a] | 163 | --with-system-socket=/run/dbus/system_bus_socket &&
|
---|
[e8e3312d] | 164 | make</userinput></screen>
|
---|
| 165 |
|
---|
[f29eb8a] | 166 | <screen revision="systemd"><userinput>./configure --prefix=/usr \
|
---|
| 167 | --sysconfdir=/etc \
|
---|
| 168 | --localstatedir=/var \
|
---|
[86b410e3] | 169 | --runstatedir=/run \
|
---|
[f29eb8a] | 170 | --enable-user-session \
|
---|
| 171 | --disable-doxygen-docs \
|
---|
| 172 | --disable-xml-docs \
|
---|
| 173 | --disable-static \
|
---|
[0075912] | 174 | --docdir=/usr/share/doc/dbus-&dbus-version; \
|
---|
[f29eb8a] | 175 | --with-system-socket=/run/dbus/system_bus_socket &&
|
---|
[5c9e998] | 176 | make</userinput></screen>
|
---|
| 177 |
|
---|
[0b83a69] | 178 | <para>
|
---|
| 179 | See below for test instructions.
|
---|
| 180 | </para>
|
---|
[c45cb57] | 181 |
|
---|
[a761478] | 182 | <!--
|
---|
[5c9e998] | 183 | <warning revision="systemd">
|
---|
| 184 | <para>
|
---|
| 185 | Installing the package will override all files installed by
|
---|
| 186 | <application>D-Bus</application> in LFS. It is critical that
|
---|
| 187 | nothing uses <application>D-Bus</application> libraries or
|
---|
[670d3f8] | 188 | programs during the installation. The best way to ensure that these
|
---|
| 189 | libraries are not being used is to run the installation in rescue mode.
|
---|
| 190 | To switch to rescue mode, run the following command as the
|
---|
| 191 | <systemitem class="username">root</systemitem> user (from a TTY):
|
---|
[5c9e998] | 192 | </para>
|
---|
[670d3f8] | 193 |
|
---|
| 194 | <screen role="root"><userinput>systemctl start rescue.target</userinput></screen>
|
---|
| 195 |
|
---|
[5c9e998] | 196 | </warning>
|
---|
[a761478] | 197 | -->
|
---|
[5c9e998] | 198 |
|
---|
[0b83a69] | 199 | <para>
|
---|
| 200 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 201 | </para>
|
---|
[e8e3312d] | 202 |
|
---|
[108beaf] | 203 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[b6a2a0e] | 204 |
|
---|
[d4eefa36] | 205 | <!-- FIXME: No longer needed with usr merge
|
---|
[51dfb3e] | 206 | <para>
|
---|
[787a2e75] | 207 | The shared library needs to be moved to
|
---|
| 208 | <filename class="directory">/lib</filename>, and as a result the
|
---|
| 209 | <filename class="extension">.so</filename> file in
|
---|
| 210 | <filename class="directory">/usr/lib</filename> will need to be
|
---|
| 211 | recreated. Run the following command as the
|
---|
| 212 | <systemitem class="username">root</systemitem> user:
|
---|
| 213 | </para>
|
---|
| 214 |
|
---|
[51dfb3e] | 215 | <screen role="root"><userinput>mv -v /usr/lib/libdbus-1.so.* /lib &&
|
---|
[787a2e75] | 216 | ln -sfv ../../lib/$(readlink /usr/lib/libdbus-1.so) /usr/lib/libdbus-1.so</userinput></screen>
|
---|
[d4eefa36] | 217 | -->
|
---|
[787a2e75] | 218 |
|
---|
[bf8eb65] | 219 | <para>
|
---|
| 220 | If you are using a DESTDIR install,
|
---|
| 221 | <command>dbus-daemon-launch-helper</command> needs to be fixed
|
---|
| 222 | afterwards. Issue, as <systemitem class="username">root</systemitem>
|
---|
| 223 | user:
|
---|
| 224 | </para>
|
---|
| 225 |
|
---|
| 226 | <screen role="root"><userinput>chown -v root:messagebus /usr/libexec/dbus-daemon-launch-helper &&
|
---|
| 227 | chmod -v 4750 /usr/libexec/dbus-daemon-launch-helper</userinput></screen>
|
---|
| 228 |
|
---|
[787a2e75] | 229 | <para revision="sysv">
|
---|
[54666831] | 230 | If you are still building your system in chroot or you did not start the
|
---|
| 231 | daemon yet, but you want to compile some packages that require
|
---|
[8558044] | 232 | <application>D-Bus</application>, generate the
|
---|
[54666831] | 233 | <application>D-Bus</application> UUID to avoid warnings when compiling
|
---|
| 234 | some packages with the following command as the
|
---|
[3bbf74c5] | 235 | <systemitem class="username">root</systemitem> user:
|
---|
| 236 | </para>
|
---|
| 237 |
|
---|
[787a2e75] | 238 | <screen role="root" revision="sysv"><userinput>dbus-uuidgen --ensure</userinput></screen>
|
---|
[54666831] | 239 |
|
---|
[51dfb3e] | 240 | <para revision="sysv">
|
---|
| 241 | If using <xref linkend="elogind"/>, create a symlink to the
|
---|
| 242 | <filename>/var/lib/dbus/machine-id</filename> file:
|
---|
| 243 | </para>
|
---|
| 244 |
|
---|
[4365e4d1] | 245 | <screen role="root" revision="sysv"><userinput>ln -sfv /var/lib/dbus/machine-id /etc</userinput></screen>
|
---|
[51dfb3e] | 246 |
|
---|
[a761478] | 247 | <!--
|
---|
[5c9e998] | 248 | <para revision="systemd">
|
---|
| 249 | If not in chroot, at this point, you should reload the systemd daemon,
|
---|
| 250 | and reenter multi-user mode with the following commands (as the
|
---|
| 251 | <systemitem class="username">root</systemitem> user):
|
---|
| 252 | </para>
|
---|
| 253 |
|
---|
| 254 | <screen role="root" revision="systemd"><userinput>systemctl daemon-reload
|
---|
| 255 | systemctl start multi-user.target</userinput></screen>
|
---|
[a761478] | 256 | -->
|
---|
[5c9e998] | 257 |
|
---|
[66e22c9b] | 258 | <!-- Without dbus-python and pygobject3, only 39 tests are run and
|
---|
| 259 | 11 out of 39 are skipped. With dbus-python and pygobject3
|
---|
| 260 | installed, 238 tests are run and 37 out of 238 are skipped. -->
|
---|
| 261 |
|
---|
[3bbf74c5] | 262 | <para>
|
---|
[66e22c9b] | 263 | Many tests are disabled unless both <xref linkend="dbus-python"/>
|
---|
| 264 | and <xref linkend="pygobject3"/> have been installed. They must be
|
---|
| 265 | run as an unprivileged user from a local session with bus address.
|
---|
| 266 | To run the standard tests issue <command>make check</command>.
|
---|
[1665413] | 267 | </para>
|
---|
| 268 |
|
---|
[66e22c9b] | 269 | <!-- With dbus-python and pygobject3 installed and these additional
|
---|
| 270 | debug options, 347 tests are run and 21 out of 347 are skipped.
|
---|
| 271 | Additionally, 217 tests in the "name-test" directory are run
|
---|
| 272 | and none is skipped. -->
|
---|
[1665413] | 273 | <para>
|
---|
| 274 | If you want to run the unit regression tests, configure requires
|
---|
| 275 | additional parameters which expose additional functionality in the
|
---|
| 276 | binaries that are not intended to be used in a production build of
|
---|
[108beaf] | 277 | <application>D-Bus</application>. If you would like to run the tests,
|
---|
[6092d19] | 278 | issue the following commands (for the tests, you don't need to build the
|
---|
| 279 | docs):
|
---|
[0b83a69] | 280 | </para>
|
---|
[0d7900a] | 281 |
|
---|
[e532fc22] | 282 | <screen remap="test"><userinput>make distclean &&
|
---|
| 283 | PYTHON=python3 ./configure --enable-tests \
|
---|
| 284 | --enable-asserts \
|
---|
| 285 | --disable-doxygen-docs \
|
---|
| 286 | --disable-xml-docs &&
|
---|
| 287 | make &&
|
---|
[02fc2ae] | 288 | make check</userinput></screen>
|
---|
[c45cb57] | 289 |
|
---|
[53dd18f1] | 290 | <para>
|
---|
[128bc41c] | 291 | One test, test-autolaunch, is known to fail.
|
---|
| 292 | There have also been reports that the tests may fail if running inside a
|
---|
[8558044] | 293 | Midnight Commander shell. You may get out-of-memory error messages when
|
---|
[9e2a8bab] | 294 | running the tests. These are normal and can be safely ignored.
|
---|
[54666831] | 295 | </para>
|
---|
[e8e3312d] | 296 |
|
---|
| 297 | </sect2>
|
---|
| 298 |
|
---|
| 299 | <sect2 role="commands">
|
---|
| 300 | <title>Command Explanations</title>
|
---|
| 301 |
|
---|
[108beaf] | 302 | <para>
|
---|
| 303 | <parameter>--disable-doxygen-docs</parameter>: This switch disables
|
---|
[6092d19] | 304 | doxygen documentation build and install, if you have
|
---|
[670d3f8] | 305 | <application>doxygen</application> installed. If
|
---|
| 306 | <application>doxygen</application> is installed, and you wish to build
|
---|
| 307 | them, remove this parameter.
|
---|
[108beaf] | 308 | </para>
|
---|
| 309 |
|
---|
[6092d19] | 310 | <para>
|
---|
| 311 | <parameter>--disable-xml-docs</parameter>: This switch disables html
|
---|
| 312 | documentation build and install, if you have
|
---|
[670d3f8] | 313 | <application>xmlto</application> installed. If
|
---|
| 314 | <application>xmlto</application> is installed, and you wish to build
|
---|
| 315 | them, remove this parameter.
|
---|
[6092d19] | 316 | </para>
|
---|
| 317 |
|
---|
[4532b2f] | 318 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 319 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 320 |
|
---|
[6b86812e] | 321 | <para revision="systemd">
|
---|
[51dfb3e] | 322 | <parameter>--enable-user-session</parameter>: This parameter enables
|
---|
| 323 | per-user DBus sessions with
|
---|
[6b86812e] | 324 | <application>systemd</application>.
|
---|
[54666831] | 325 | </para>
|
---|
| 326 |
|
---|
[5c9e998] | 327 | <para revision="sysv">
|
---|
[aa41434] | 328 | <parameter>--with-systemd{user,system}unitdir=no</parameter>: These
|
---|
[51dfb3e] | 329 | switches disable installation of systemd units on elogind based systems.
|
---|
[f29eb8a] | 330 | </para>
|
---|
[875b3b57] | 331 | <!-- not in instructions anymore
|
---|
[f29eb8a] | 332 | <para>
|
---|
[875b3b57] | 333 | <parameter>- -with-system-pid-file=/run/dbus/pid</parameter>: This
|
---|
[f29eb8a] | 334 | parameter specifies the location of the PID file.
|
---|
| 335 | </para>
|
---|
[875b3b57] | 336 | -->
|
---|
[f29eb8a] | 337 | <para>
|
---|
| 338 | <parameter>--with-system-socket=/run/dbus/system_bus_socket</parameter>:
|
---|
| 339 | This parameter specifies the location of the system bus socket.
|
---|
| 340 | </para>
|
---|
| 341 |
|
---|
[0b83a69] | 342 | <para>
|
---|
[9e2a8bab] | 343 | <parameter>--enable-tests</parameter>: Builds extra parts of the code to
|
---|
[1665413] | 344 | support all tests. Do not use on a production build.
|
---|
[4947a7a] | 345 | </para>
|
---|
| 346 |
|
---|
| 347 | <para>
|
---|
[9e2a8bab] | 348 | <option>--enable-embedded-tests</option>: Builds extra parts of the
|
---|
[1665413] | 349 | code to support only unit tests. Do not use on a production build.
|
---|
[0b83a69] | 350 | </para>
|
---|
| 351 |
|
---|
| 352 | <para>
|
---|
[9e2a8bab] | 353 | <parameter>--enable-asserts</parameter>: Enables debugging code to run
|
---|
[e5347c36] | 354 | assertions for statements normally assumed to be true. This prevents a
|
---|
| 355 | warning that '<parameter>--enable-tests</parameter>' on its own is only
|
---|
| 356 | useful for profiling and might not give true results for all tests, but
|
---|
| 357 | adds its own NOTE that this should not be used in a production build.
|
---|
[0b83a69] | 358 | </para>
|
---|
[30d0aef] | 359 |
|
---|
[e8e3312d] | 360 | </sect2>
|
---|
| 361 |
|
---|
| 362 | <sect2 role="configuration">
|
---|
[670d3f8] | 363 | <title>Configuring D-Bus</title>
|
---|
[e8e3312d] | 364 |
|
---|
| 365 | <sect3 id="dbus-config">
|
---|
| 366 | <title>Config Files</title>
|
---|
[0b83a69] | 367 |
|
---|
| 368 | <para>
|
---|
| 369 | <filename>/etc/dbus-1/session.conf</filename>,
|
---|
| 370 | <filename>/etc/dbus-1/system.conf</filename> and
|
---|
| 371 | <filename>/etc/dbus-1/system.d/*</filename>
|
---|
| 372 | </para>
|
---|
[e8e3312d] | 373 |
|
---|
[54666831] | 374 | <indexterm zone="dbus dbus-config">
|
---|
[e8e3312d] | 375 | <primary sortas="e-etc-dbus-1-session.conf">/etc/dbus-1/session.conf</primary>
|
---|
| 376 | </indexterm>
|
---|
| 377 |
|
---|
[54666831] | 378 | <indexterm zone="dbus dbus-config">
|
---|
[e8e3312d] | 379 | <primary sortas="e-etc-dbus-1/system.conf">/etc/dbus-1/system.conf</primary>
|
---|
| 380 | </indexterm>
|
---|
| 381 |
|
---|
[54666831] | 382 | <indexterm zone="dbus dbus-config">
|
---|
[c45cb57] | 383 | <primary sortas="e-etc-dbus-1-system.d-star">/etc/dbus-1/system.d/*</primary>
|
---|
[e8e3312d] | 384 | </indexterm>
|
---|
| 385 |
|
---|
| 386 | </sect3>
|
---|
| 387 |
|
---|
[e9efab0b] | 388 | <sect3 id="dbus-session-config" xreflabel="D-Bus custom services directory">
|
---|
| 389 | <title>Configuration Information</title>
|
---|
[e8e3312d] | 390 |
|
---|
[0b83a69] | 391 | <para>
|
---|
| 392 | The configuration files listed above should probably not be
|
---|
| 393 | modified. If changes are required, you should create
|
---|
| 394 | <filename>/etc/dbus-1/session-local.conf</filename> and/or
|
---|
| 395 | <filename>/etc/dbus-1/system-local.conf</filename> and make any
|
---|
| 396 | desired changes to these files.
|
---|
| 397 | </para>
|
---|
| 398 |
|
---|
| 399 | <para>
|
---|
| 400 | If any packages install a
|
---|
| 401 | <application>D-Bus</application> <filename>.service</filename>
|
---|
| 402 | file outside of the standard <filename
|
---|
| 403 | class="directory">/usr/share/dbus-1/services</filename> directory,
|
---|
| 404 | that directory should be added to the local session configuration.
|
---|
| 405 | For instance, <filename
|
---|
| 406 | class="directory">/usr/local/share/dbus-1/services</filename> can
|
---|
| 407 | be added by performing the following commands as the
|
---|
| 408 | <systemitem class="username">root</systemitem> user:
|
---|
| 409 | </para>
|
---|
[57aa7a28] | 410 |
|
---|
| 411 | <screen role="root"><userinput>cat > /etc/dbus-1/session-local.conf << "EOF"
|
---|
| 412 | <literal><!DOCTYPE busconfig PUBLIC
|
---|
| 413 | "-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN"
|
---|
| 414 | "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd">
|
---|
| 415 | <busconfig>
|
---|
| 416 |
|
---|
| 417 | <!-- Search for .service files in /usr/local -->
|
---|
| 418 | <servicedir>/usr/local/share/dbus-1/services</servicedir>
|
---|
| 419 |
|
---|
| 420 | </busconfig></literal>
|
---|
| 421 | EOF</userinput></screen>
|
---|
| 422 |
|
---|
[e8e3312d] | 423 | </sect3>
|
---|
| 424 |
|
---|
[670d3f8] | 425 | <sect3 id="dbus-session">
|
---|
[5c9e998] | 426 | <title>D-Bus Session Daemon</title>
|
---|
[e8e3312d] | 427 |
|
---|
[5c9e998] | 428 | <para revision="sysv">
|
---|
[54666831] | 429 | To automatically start <command>dbus-daemon</command> when the
|
---|
| 430 | system is rebooted, install the
|
---|
| 431 | <filename>/etc/rc.d/init.d/dbus</filename> bootscript from the
|
---|
| 432 | <xref linkend="bootscripts"/> package.
|
---|
| 433 | </para>
|
---|
| 434 |
|
---|
[670d3f8] | 435 | <indexterm zone="dbus dbus-session" revision="sysv">
|
---|
[54666831] | 436 | <primary sortas="f-dbus">dbus</primary>
|
---|
| 437 | </indexterm>
|
---|
| 438 |
|
---|
[5c9e998] | 439 | <screen role="root" revision="sysv"><userinput>make install-dbus</userinput></screen>
|
---|
[54666831] | 440 |
|
---|
[06a0a0a8] | 441 | <para revision="sysv">
|
---|
| 442 | If this is the first time to install
|
---|
| 443 | <application>D-Bus</application> on the system and you are not
|
---|
| 444 | operating in a chroot environment, you can immediately start
|
---|
| 445 | <command>dbus-daemon</command> without rebooting the system:
|
---|
| 446 | </para>
|
---|
| 447 |
|
---|
| 448 | <!-- nodump because maybe the user is building in chroot -->
|
---|
| 449 | <screen role="nodump" revision="sysv"><userinput>/etc/init.d/dbus start</userinput></screen>
|
---|
| 450 |
|
---|
[5c9e998] | 451 | <para revision="sysv">
|
---|
[54666831] | 452 | Note that this boot script only starts the system-wide
|
---|
| 453 | <application>D-Bus</application> daemon. Each user requiring access to
|
---|
| 454 | <application>D-Bus</application> services will also need to run a
|
---|
| 455 | session daemon as well. There are many methods you can use to start a
|
---|
[0b83a69] | 456 | session daemon using the <command>dbus-launch</command> command. Review
|
---|
| 457 | the <command>dbus-launch</command> man page for details about the
|
---|
| 458 | available parameters and options. Here are some suggestions and
|
---|
| 459 | examples:
|
---|
| 460 | </para>
|
---|
[3565e02] | 461 |
|
---|
[5c9e998] | 462 | <para revision="systemd">
|
---|
| 463 | There are many methods you can use to start a session daemon
|
---|
| 464 | using the <command>dbus-launch</command> command. Review the
|
---|
| 465 | <command>dbus-launch</command> man page for details about the
|
---|
| 466 | available parameters and options. Here are some suggestions and
|
---|
| 467 | examples:
|
---|
| 468 | </para>
|
---|
| 469 |
|
---|
| 470 |
|
---|
[3565e02] | 471 | <itemizedlist spacing="compact">
|
---|
| 472 | <listitem>
|
---|
[0b83a69] | 473 | <para>
|
---|
| 474 | Add <command>dbus-launch</command> to the line in the
|
---|
| 475 | <filename>~/.xinitrc</filename> file that starts your graphical
|
---|
| 476 | desktop environment.
|
---|
| 477 | </para>
|
---|
[3565e02] | 478 | </listitem>
|
---|
| 479 | <listitem>
|
---|
[0b83a69] | 480 | <para>
|
---|
[9e2a8bab] | 481 | If you use <command>gdm</command> or some other display manager
|
---|
[0b83a69] | 482 | that calls the <filename>~/.xsession</filename> file, you can add
|
---|
| 483 | <command>dbus-launch</command> to the line in your
|
---|
| 484 | <filename>~/.xsession</filename> file that starts your graphical
|
---|
| 485 | desktop environment. The syntax would be similar to the example in
|
---|
| 486 | the <filename>~/.xinitrc</filename> file.
|
---|
| 487 | </para>
|
---|
[3565e02] | 488 | </listitem>
|
---|
| 489 | <listitem>
|
---|
[0b83a69] | 490 | <para>
|
---|
| 491 | The examples shown previously use
|
---|
| 492 | <command>dbus-launch</command> to specify a program to be run. This
|
---|
| 493 | has the benefit (when also using the
|
---|
[ae20e9a] | 494 | <parameter>--exit-with-x11</parameter> parameter) of stopping the
|
---|
[0b83a69] | 495 | session daemon when the specified program is stopped. You can also
|
---|
| 496 | start the session daemon in your system or personal startup scripts
|
---|
| 497 | by adding the following lines:
|
---|
| 498 | </para>
|
---|
[3565e02] | 499 |
|
---|
[dac5077] | 500 | <screen role="nodump"><userinput><literal># Start the D-Bus session daemon
|
---|
[3565e02] | 501 | eval `dbus-launch`
|
---|
| 502 | export DBUS_SESSION_BUS_ADDRESS</literal></userinput></screen>
|
---|
| 503 |
|
---|
[0b83a69] | 504 | <para>
|
---|
| 505 | This method will not stop the session daemon when you exit
|
---|
| 506 | your shell, therefore you should add the following line to your
|
---|
| 507 | <filename>~/.bash_logout</filename> file:
|
---|
| 508 | </para>
|
---|
[3565e02] | 509 |
|
---|
[dac5077] | 510 | <screen role="nodump"><userinput><literal># Kill the D-Bus session daemon
|
---|
[3565e02] | 511 | kill $DBUS_SESSION_BUS_PID</literal></userinput></screen>
|
---|
[bccbdaea] | 512 | </listitem>
|
---|
[4ec808b] | 513 |
|
---|
[9e2a8bab] | 514 | <!-- KDM is no longer usable, SDDM is it's replacement
|
---|
[3565e02] | 515 | <listitem>
|
---|
[0b83a69] | 516 | <para>
|
---|
| 517 | A hint has been written that provides ways to start scripts
|
---|
| 518 | using the KDM session manager of KDE. The concepts in this hint could
|
---|
| 519 | possibly be used with other session managers as well. The hint is
|
---|
| 520 | located at <ulink
|
---|
| 521 | url="&hints-root;/downloads/files/execute-session-scripts-using-kdm.txt"/>.
|
---|
[c45cb57] | 522 | </para>
|
---|
[3565e02] | 523 | </listitem>
|
---|
[9e2a8bab] | 524 | -->
|
---|
[c45cb57] | 525 |
|
---|
[3565e02] | 526 | </itemizedlist>
|
---|
| 527 |
|
---|
[e8e3312d] | 528 | </sect3>
|
---|
| 529 |
|
---|
| 530 | </sect2>
|
---|
| 531 |
|
---|
[5c9e998] | 532 | <sect2 role="content" revision="sysv">
|
---|
[e8e3312d] | 533 | <title>Contents</title>
|
---|
| 534 |
|
---|
| 535 | <segmentedlist>
|
---|
| 536 | <segtitle>Installed Programs</segtitle>
|
---|
[54666831] | 537 | <segtitle>Installed Library</segtitle>
|
---|
[e8e3312d] | 538 | <segtitle>Installed Directories</segtitle>
|
---|
| 539 |
|
---|
| 540 | <seglistitem>
|
---|
[0b83a69] | 541 | <seg>
|
---|
[54666831] | 542 | dbus-cleanup-sockets, dbus-daemon, dbus-launch, dbus-monitor,
|
---|
[c358685] | 543 | dbus-run-session, dbus-send, dbus-test-tool,
|
---|
[2cd6717] | 544 | dbus-update-activation-environment, and dbus-uuidgen
|
---|
[0b83a69] | 545 | </seg>
|
---|
| 546 | <seg>
|
---|
[54666831] | 547 | libdbus-1.so
|
---|
[0b83a69] | 548 | </seg>
|
---|
| 549 | <seg>
|
---|
[e20b59be] | 550 | /etc/dbus-1,
|
---|
[79ba2ea] | 551 | /usr/{include,lib}/dbus-1.0,
|
---|
[819a4c7] | 552 | /usr/lib/cmake/DBus1,
|
---|
[e20b59be] | 553 | /usr/share/dbus-1,
|
---|
[819a4c7] | 554 | /usr/share/xml/dbus-1,
|
---|
[e20b59be] | 555 | /usr/share/doc/dbus-&dbus-version;, and
|
---|
[79ba2ea] | 556 | /var/{lib,run}/dbus
|
---|
[0b83a69] | 557 | </seg>
|
---|
[e8e3312d] | 558 | </seglistitem>
|
---|
| 559 | </segmentedlist>
|
---|
| 560 |
|
---|
| 561 | <variablelist>
|
---|
| 562 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 563 | <?dbfo list-presentation="list"?>
|
---|
| 564 | <?dbhtml list-presentation="table"?>
|
---|
| 565 |
|
---|
[54666831] | 566 | <varlistentry id="dbus-cleanup-sockets">
|
---|
| 567 | <term><command>dbus-cleanup-sockets</command></term>
|
---|
| 568 | <listitem>
|
---|
| 569 | <para>
|
---|
[4c24eb0a] | 570 | is used to clean up leftover sockets in a directory
|
---|
[54666831] | 571 | </para>
|
---|
| 572 | <indexterm zone="dbus dbus-cleanup-sockets">
|
---|
| 573 | <primary sortas="b-dbus-cleanup-sockets">dbus-cleanup-sockets</primary>
|
---|
| 574 | </indexterm>
|
---|
| 575 | </listitem>
|
---|
| 576 | </varlistentry>
|
---|
| 577 |
|
---|
| 578 | <varlistentry id="dbus-daemon">
|
---|
| 579 | <term><command>dbus-daemon</command></term>
|
---|
| 580 | <listitem>
|
---|
| 581 | <para>
|
---|
[4c24eb0a] | 582 | is the <application>D-Bus</application> message bus daemon
|
---|
[54666831] | 583 | </para>
|
---|
| 584 | <indexterm zone="dbus dbus-daemon">
|
---|
| 585 | <primary sortas="b-dbus-daemon">dbus-daemon</primary>
|
---|
| 586 | </indexterm>
|
---|
| 587 | </listitem>
|
---|
| 588 | </varlistentry>
|
---|
| 589 |
|
---|
| 590 | <varlistentry id="dbus-launch">
|
---|
[e8e3312d] | 591 | <term><command>dbus-launch</command></term>
|
---|
| 592 | <listitem>
|
---|
[0b83a69] | 593 | <para>
|
---|
| 594 | is used to start <command>dbus-daemon</command> from a shell
|
---|
| 595 | script. It would normally be called from a user's login
|
---|
[4c24eb0a] | 596 | scripts
|
---|
[0b83a69] | 597 | </para>
|
---|
[54666831] | 598 | <indexterm zone="dbus dbus-launch">
|
---|
| 599 | <primary sortas="b-dbus-launch">dbus-launch</primary>
|
---|
| 600 | </indexterm>
|
---|
| 601 | </listitem>
|
---|
| 602 | </varlistentry>
|
---|
| 603 |
|
---|
| 604 | <varlistentry id="dbus-monitor">
|
---|
| 605 | <term><command>dbus-monitor</command></term>
|
---|
| 606 | <listitem>
|
---|
| 607 | <para>
|
---|
| 608 | is used to monitor messages going through a
|
---|
[4c24eb0a] | 609 | <application>D-Bus</application> message bus
|
---|
[54666831] | 610 | </para>
|
---|
| 611 | <indexterm zone="dbus dbus-monitor">
|
---|
| 612 | <primary sortas="b-dbus-monitor">dbus-monitor</primary>
|
---|
| 613 | </indexterm>
|
---|
| 614 | </listitem>
|
---|
| 615 | </varlistentry>
|
---|
| 616 |
|
---|
| 617 | <varlistentry id="dbus-run-session">
|
---|
| 618 | <term><command>dbus-run-session</command></term>
|
---|
| 619 | <listitem>
|
---|
| 620 | <para>
|
---|
[4c24eb0a] | 621 | starts a process as a new <application>D-Bus</application> session
|
---|
[54666831] | 622 | </para>
|
---|
| 623 | <indexterm zone="dbus dbus-run-session">
|
---|
| 624 | <primary sortas="b-dbus-run-session">dbus-run-session</primary>
|
---|
| 625 | </indexterm>
|
---|
| 626 | </listitem>
|
---|
| 627 | </varlistentry>
|
---|
| 628 |
|
---|
| 629 | <varlistentry id="dbus-send">
|
---|
| 630 | <term><command>dbus-send</command></term>
|
---|
| 631 | <listitem>
|
---|
| 632 | <para>
|
---|
| 633 | is used to send a message to a <application>D-Bus</application>
|
---|
[4c24eb0a] | 634 | message bus
|
---|
[54666831] | 635 | </para>
|
---|
| 636 | <indexterm zone="dbus dbus-send">
|
---|
| 637 | <primary sortas="b-dbus-send">dbus-send</primary>
|
---|
| 638 | </indexterm>
|
---|
| 639 | </listitem>
|
---|
| 640 | </varlistentry>
|
---|
| 641 |
|
---|
[c358685] | 642 | <varlistentry id="dbus-test-tool">
|
---|
| 643 | <term><command>dbus-test-tool</command></term>
|
---|
| 644 | <listitem>
|
---|
| 645 | <para>
|
---|
[8558044] | 646 | is a <application>D-Bus</application> traffic generator and test
|
---|
[11d14a27] | 647 | tool; it is a multi-purpose tool for debugging and profiling
|
---|
[4c24eb0a] | 648 | <application>D-Bus</application>
|
---|
[c358685] | 649 | </para>
|
---|
| 650 | <indexterm zone="dbus dbus-test-tool">
|
---|
| 651 | <primary sortas="b-dbus-test-tool">dbus-test-tool</primary>
|
---|
| 652 | </indexterm>
|
---|
| 653 | </listitem>
|
---|
| 654 | </varlistentry>
|
---|
| 655 |
|
---|
| 656 | <varlistentry id="dbus-update-activation-environment">
|
---|
| 657 | <term><command>dbus-update-activation-environment</command></term>
|
---|
| 658 | <listitem>
|
---|
| 659 | <para>
|
---|
[8558044] | 660 | is used to update the environment used for
|
---|
| 661 | <application>D-Bus</application> session services;
|
---|
[11d14a27] | 662 | it updates the list of environment variables used by
|
---|
[c358685] | 663 | <command>dbus-daemon --session</command> when it activates session
|
---|
[4c24eb0a] | 664 | services without using systemd
|
---|
[c358685] | 665 | </para>
|
---|
| 666 | <indexterm zone="dbus dbus-update-activation-environment">
|
---|
| 667 | <primary sortas="b-dbus-update-activation-environment">
|
---|
| 668 | dbus-update-activation-environment</primary>
|
---|
| 669 | </indexterm>
|
---|
| 670 | </listitem>
|
---|
| 671 | </varlistentry>
|
---|
| 672 |
|
---|
[54666831] | 673 | <varlistentry id="dbus-uuidgen">
|
---|
| 674 | <term><command>dbus-uuidgen</command></term>
|
---|
| 675 | <listitem>
|
---|
| 676 | <para>
|
---|
[4c24eb0a] | 677 | is used to generate a universally unique ID
|
---|
[54666831] | 678 | </para>
|
---|
| 679 | <indexterm zone="dbus dbus-uuidgen">
|
---|
| 680 | <primary sortas="b-dbus-uuidgen">dbus-uuidgen</primary>
|
---|
| 681 | </indexterm>
|
---|
| 682 | </listitem>
|
---|
| 683 | </varlistentry>
|
---|
| 684 |
|
---|
| 685 | <varlistentry id="libdbus-1">
|
---|
| 686 | <term><filename class="libraryfile">libdbus-1.so</filename></term>
|
---|
| 687 | <listitem>
|
---|
| 688 | <para>
|
---|
| 689 | contains the API functions used by the
|
---|
| 690 | <application>D-Bus</application> message daemon.
|
---|
| 691 | <application>D-Bus</application> is first a library that provides
|
---|
| 692 | one-to-one communication between any two applications;
|
---|
| 693 | <command>dbus-daemon</command> is an application that uses this
|
---|
[4c24eb0a] | 694 | library to implement a message bus daemon
|
---|
[54666831] | 695 | </para>
|
---|
| 696 | <indexterm zone="dbus libdbus-1">
|
---|
| 697 | <primary sortas="c-libdbus-1">libdbus-1.so</primary>
|
---|
[e8e3312d] | 698 | </indexterm>
|
---|
| 699 | </listitem>
|
---|
| 700 | </varlistentry>
|
---|
| 701 |
|
---|
| 702 | </variablelist>
|
---|
| 703 |
|
---|
| 704 | </sect2>
|
---|
[4c24eb0a] | 705 |
|
---|
[5c9e998] | 706 | <sect2 role="content" revision="systemd">
|
---|
| 707 | <title>Contents</title>
|
---|
| 708 |
|
---|
| 709 | <para>
|
---|
| 710 | A list of the installed files, along with their short
|
---|
| 711 | descriptions can be found at
|
---|
[50836740] | 712 | <ulink url="&lfs-root;/chapter08/dbus.html#contents-dbus"/>.
|
---|
[5c9e998] | 713 | </para>
|
---|
| 714 |
|
---|
| 715 | </sect2>
|
---|
| 716 |
|
---|
[e8e3312d] | 717 | </sect1>
|
---|