[7152faa] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[cba2d4e] | 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 |
|
---|
[35a5259] | 8 | <sect1 id="ch-system-dbus" role="wrap" revision="systemd">
|
---|
[cba2d4e] | 9 | <?dbhtml filename="dbus.html"?>
|
---|
| 10 |
|
---|
| 11 | <sect1info condition="script">
|
---|
| 12 | <productname>dbus</productname>
|
---|
| 13 | <productnumber>&dbus-version;</productnumber>
|
---|
| 14 | <address>&dbus-url;</address>
|
---|
| 15 | </sect1info>
|
---|
| 16 |
|
---|
| 17 | <title>D-Bus-&dbus-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="ch-system-dbus">
|
---|
| 20 | <primary sortas="a-dbus">D-Bus</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect2 role="package">
|
---|
| 24 | <title/>
|
---|
| 25 |
|
---|
| 26 | <para>D-Bus is a message bus system, a simple way for applications to talk
|
---|
| 27 | to one another. D-Bus supplies both a system daemon (for events such as
|
---|
| 28 | "new hardware device added" or "printer queue changed") and a
|
---|
| 29 | per-user-login-session daemon (for general IPC needs among user
|
---|
| 30 | applications). Also, the message bus is built on top of a general one-to-one
|
---|
| 31 | message passing framework, which can be used by any two applications to
|
---|
| 32 | communicate directly (without going through the message bus daemon).</para>
|
---|
| 33 |
|
---|
| 34 | <segmentedlist>
|
---|
| 35 | <segtitle>&buildtime;</segtitle>
|
---|
| 36 | <segtitle>&diskspace;</segtitle>
|
---|
| 37 |
|
---|
| 38 | <seglistitem>
|
---|
[fb386e0] | 39 | <seg>&dbus-fin-sbu;</seg>
|
---|
| 40 | <seg>&dbus-fin-du;</seg>
|
---|
[cba2d4e] | 41 | </seglistitem>
|
---|
| 42 | </segmentedlist>
|
---|
| 43 |
|
---|
| 44 | </sect2>
|
---|
| 45 |
|
---|
| 46 | <sect2 role="installation">
|
---|
| 47 | <title>Installation of D-Bus</title>
|
---|
| 48 |
|
---|
| 49 | <para>Prepare D-Bus for compilation:</para>
|
---|
| 50 |
|
---|
[6e8c493] | 51 | <screen><userinput remap="configure">./configure --prefix=/usr \
|
---|
| 52 | --sysconfdir=/etc \
|
---|
| 53 | --localstatedir=/var \
|
---|
[408f4ae8] | 54 | --runstatedir=/run \
|
---|
[308ec7a] | 55 | --enable-user-session \
|
---|
[6e8c493] | 56 | --disable-static \
|
---|
| 57 | --disable-doxygen-docs \
|
---|
| 58 | --disable-xml-docs \
|
---|
[a19dadf] | 59 | --docdir=/usr/share/doc/dbus-&dbus-version; \
|
---|
[6e8c493] | 60 | --with-system-socket=/run/dbus/system_bus_socket</userinput></screen>
|
---|
[cba2d4e] | 61 |
|
---|
| 62 | <variablelist>
|
---|
| 63 | <title>The meaning of the configure options:</title>
|
---|
| 64 |
|
---|
[6e8c493] | 65 | <varlistentry>
|
---|
| 66 | <term>
|
---|
[408f4ae8] | 67 | <parameter>--runstatedir=/run</parameter> and
|
---|
[6e8c493] | 68 | <parameter>--with-system-socket=/run/dbus/system_bus_socket</parameter>
|
---|
| 69 | </term>
|
---|
| 70 | <listitem>
|
---|
[69854d2a] | 71 | <para>These cause the PID file and the system bus socket
|
---|
[6e8c493] | 72 | to be in <filename class="directory">/run</filename>, instead of
|
---|
[69854d2a] | 73 | the deprecated <filename class="directory">/var/run</filename>.</para>
|
---|
[6e8c493] | 74 | </listitem>
|
---|
| 75 | </varlistentry>
|
---|
| 76 |
|
---|
[308ec7a] | 77 | <varlistentry>
|
---|
| 78 | <term>
|
---|
| 79 | <parameter>--enable-user-session</parameter>
|
---|
| 80 | </term>
|
---|
| 81 | <listitem>
|
---|
[4374af9] | 82 | <para>This ensures the D-Bus per-user service and socket unit
|
---|
[308ec7a] | 83 | files are installed for Systemd. They are not useful (but
|
---|
| 84 | harmless) in a base LFS installation, however they can be used
|
---|
| 85 | once systemd is rebuilt with PAM support in BLFS.</para>
|
---|
| 86 | </listitem>
|
---|
| 87 | </varlistentry>
|
---|
| 88 |
|
---|
[cba2d4e] | 89 | </variablelist>
|
---|
| 90 |
|
---|
| 91 | <para>Compile the package:</para>
|
---|
| 92 |
|
---|
| 93 | <screen><userinput remap="make">make</userinput></screen>
|
---|
| 94 |
|
---|
[d1cbe53] | 95 | <para>To test the results, issue:</para>
|
---|
| 96 |
|
---|
| 97 | <screen><userinput remap="test">make check</userinput></screen>
|
---|
| 98 |
|
---|
| 99 | <para>Many tests are disabled because they require additional
|
---|
[cba2d4e] | 100 | packages that are not included in LFS. Instructions for running the
|
---|
[d1cbe53] | 101 | comprehensive test suite can be found in
|
---|
| 102 | <ulink url="&blfs-book;general/dbus.html">the BLFS book</ulink>.</para>
|
---|
[cba2d4e] | 103 |
|
---|
| 104 | <para>Install the package:</para>
|
---|
| 105 |
|
---|
| 106 | <screen><userinput remap="install">make install</userinput></screen>
|
---|
| 107 |
|
---|
[9e7475a] | 108 | <para>Create a symlink so that D-Bus and systemd can use the same
|
---|
[cba2d4e] | 109 | <filename>machine-id</filename> file:</para>
|
---|
| 110 |
|
---|
[1118b17] | 111 | <screen><userinput remap="install">ln -sfv /etc/machine-id /var/lib/dbus</userinput></screen>
|
---|
[c06f49a] | 112 |
|
---|
[cba2d4e] | 113 | </sect2>
|
---|
| 114 |
|
---|
| 115 | <sect2 id="contents-dbus" role="content">
|
---|
| 116 | <title>Contents of D-Bus</title>
|
---|
| 117 |
|
---|
| 118 | <segmentedlist>
|
---|
| 119 | <segtitle>Installed programs</segtitle>
|
---|
| 120 | <segtitle>Installed libraries</segtitle>
|
---|
| 121 | <segtitle>Installed directories</segtitle>
|
---|
| 122 |
|
---|
| 123 | <seglistitem>
|
---|
| 124 | <seg>dbus-cleanup-sockets, dbus-daemon, dbus-launch, dbus-monitor,
|
---|
[d672ab7] | 125 | dbus-run-session, dbus-send, dbus-test-tool,
|
---|
[201167db] | 126 | dbus-update-activation-environment, and dbus-uuidgen</seg>
|
---|
[d1cbe53] | 127 | <seg>libdbus-1.so</seg>
|
---|
[cba2d4e] | 128 | <seg>/etc/dbus-1, /usr/include/dbus-1.0, /usr/lib/dbus-1.0,
|
---|
| 129 | /usr/share/dbus-1, /usr/share/doc/dbus-&dbus-version;,
|
---|
[1118b17] | 130 | and /var/lib/dbus</seg>
|
---|
[cba2d4e] | 131 | </seglistitem>
|
---|
| 132 | </segmentedlist>
|
---|
| 133 |
|
---|
| 134 | <variablelist>
|
---|
| 135 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 136 | <?dbfo list-presentation="list"?>
|
---|
| 137 | <?dbhtml list-presentation="table"?>
|
---|
| 138 |
|
---|
| 139 | <varlistentry id="dbus-cleanup-sockets">
|
---|
| 140 | <term><command>dbus-cleanup-sockets</command></term>
|
---|
| 141 | <listitem>
|
---|
[9e7475a] | 142 | <para>is used to remove leftover sockets in a directory</para>
|
---|
[cba2d4e] | 143 | <indexterm zone="ch-system-dbus dbus-cleanup-sockets">
|
---|
| 144 | <primary sortas="b-dbus-cleanup-sockets">dbus-cleanup-sockets</primary>
|
---|
| 145 | </indexterm>
|
---|
| 146 | </listitem>
|
---|
| 147 | </varlistentry>
|
---|
| 148 |
|
---|
| 149 | <varlistentry id="dbus-daemon">
|
---|
| 150 | <term><command>dbus-daemon</command></term>
|
---|
| 151 | <listitem>
|
---|
[9e7475a] | 152 | <para>Is the D-Bus message bus daemon</para>
|
---|
[cba2d4e] | 153 | <indexterm zone="ch-system-dbus dbus-daemon">
|
---|
| 154 | <primary sortas="b-dbus-daemon">dbus-daemon</primary>
|
---|
| 155 | </indexterm>
|
---|
| 156 | </listitem>
|
---|
| 157 | </varlistentry>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="dbus-launch">
|
---|
| 160 | <term><command>dbus-launch</command></term>
|
---|
| 161 | <listitem>
|
---|
[0d84af1] | 162 | <para>Starts <command>dbus-daemon</command> from a shell
|
---|
[1118b17] | 163 | script</para>
|
---|
[cba2d4e] | 164 | <indexterm zone="ch-system-dbus dbus-launch">
|
---|
| 165 | <primary sortas="b-dbus-launch">dbus-launch</primary>
|
---|
| 166 | </indexterm>
|
---|
| 167 | </listitem>
|
---|
| 168 | </varlistentry>
|
---|
| 169 |
|
---|
| 170 | <varlistentry id="dbus-monitor">
|
---|
| 171 | <term><command>dbus-monitor</command></term>
|
---|
| 172 | <listitem>
|
---|
[0d84af1] | 173 | <para>Monitors messages passing through a D-Bus message bus</para>
|
---|
[cba2d4e] | 174 | <indexterm zone="ch-system-dbus dbus-monitor">
|
---|
| 175 | <primary sortas="b-dbus-monitor">dbus-monitor</primary>
|
---|
| 176 | </indexterm>
|
---|
| 177 | </listitem>
|
---|
| 178 | </varlistentry>
|
---|
| 179 |
|
---|
[1118b17] | 180 | <varlistentry id="dbus-run-session">
|
---|
| 181 | <term><command>dbus-run-session</command></term>
|
---|
| 182 | <listitem>
|
---|
[0d84af1] | 183 | <para>Starts a session bus instance of <command>dbus-daemon</command>
|
---|
[1118b17] | 184 | from a shell script and starts a specified program in that
|
---|
| 185 | session</para>
|
---|
| 186 | <indexterm zone="ch-system-dbus dbus-run-session">
|
---|
| 187 | <primary sortas="b-dbus-run-session">dbus-run-session</primary>
|
---|
| 188 | </indexterm>
|
---|
| 189 | </listitem>
|
---|
| 190 | </varlistentry>
|
---|
| 191 |
|
---|
[cba2d4e] | 192 | <varlistentry id="dbus-send">
|
---|
| 193 | <term><command>dbus-send</command></term>
|
---|
| 194 | <listitem>
|
---|
[0d84af1] | 195 | <para>Sends a message to a D-Bus message bus</para>
|
---|
[cba2d4e] | 196 | <indexterm zone="ch-system-dbus dbus-send">
|
---|
| 197 | <primary sortas="b-dbus-send">dbus-send</primary>
|
---|
| 198 | </indexterm>
|
---|
| 199 | </listitem>
|
---|
| 200 | </varlistentry>
|
---|
| 201 |
|
---|
[201167db] | 202 | <varlistentry id="dbus-test-tool">
|
---|
| 203 | <term><command>dbus-test-tool</command></term>
|
---|
| 204 | <listitem>
|
---|
[9e7475a] | 205 | <para>Is a tool to help packages test
|
---|
[0d84af1] | 206 | <application>D-Bus</application></para>
|
---|
[201167db] | 207 | <indexterm zone="ch-system-dbus dbus-test-tool">
|
---|
| 208 | <primary sortas="b-dbus-test-tool">dbus-test-tool</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | <!-- This is a very long command name. Excuse the long <primary> statement below. -->
|
---|
| 214 | <varlistentry id="dbus-update-activation-environment">
|
---|
| 215 | <term><command>dbus-update-activation-environment</command></term>
|
---|
| 216 | <listitem>
|
---|
[0d84af1] | 217 | <para>Updates environment variables that will be set for
|
---|
| 218 | <application>D-Bus</application> session services</para>
|
---|
[201167db] | 219 | <indexterm zone="ch-system-dbus dbus-update-activation-environment">
|
---|
| 220 | <primary sortas="b-dbus-update-activation-environment">dbus-update-activation-environment</primary>
|
---|
| 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
| 223 | </varlistentry>
|
---|
| 224 |
|
---|
[cba2d4e] | 225 | <varlistentry id="dbus-uuidgen">
|
---|
| 226 | <term><command>dbus-uuidgen</command></term>
|
---|
| 227 | <listitem>
|
---|
[0d84af1] | 228 | <para>Generates a universally unique ID</para>
|
---|
[cba2d4e] | 229 | <indexterm zone="ch-system-dbus dbus-uuidgen">
|
---|
| 230 | <primary sortas="b-dbus-uuidgen">dbus-uuidgen</primary>
|
---|
| 231 | </indexterm>
|
---|
| 232 | </listitem>
|
---|
| 233 | </varlistentry>
|
---|
| 234 |
|
---|
[1118b17] | 235 | <varlistentry id="libdbus-1">
|
---|
| 236 | <term><filename class="libraryfile">libdbus-1</filename></term>
|
---|
| 237 | <listitem>
|
---|
[0d84af1] | 238 | <para>Contains API functions used to communicate with the D-Bus
|
---|
[1118b17] | 239 | message bus</para>
|
---|
| 240 | <indexterm zone="ch-system-dbus libdbus-1">
|
---|
| 241 | <primary sortas="c-libdbus-1">libdbus-1</primary>
|
---|
| 242 | </indexterm>
|
---|
| 243 | </listitem>
|
---|
| 244 | </varlistentry>
|
---|
| 245 |
|
---|
[cba2d4e] | 246 | </variablelist>
|
---|
| 247 |
|
---|
| 248 | </sect2>
|
---|
| 249 |
|
---|
| 250 | </sect1>
|
---|