[e8e3312d] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/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-version;.tar.gz">
|
---|
| 8 | <!ENTITY dbus-download-ftp " ">
|
---|
| 9 | <!ENTITY dbus-md5sum "1addd5b600a8a4550766005d1f59401b">
|
---|
| 10 | <!ENTITY dbus-size "1.6 MB">
|
---|
| 11 | <!ENTITY dbus-buildsize "34.6 MB">
|
---|
| 12 | <!ENTITY dbus-time "0.9 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><application>D-BUS</application> is a message bus system, a simple
|
---|
| 33 | way for applications to talk to one another.
|
---|
| 34 | <application>D-BUS</application> supplies both a system daemon (for events
|
---|
| 35 | such as <quote>new hardware device added</quote> or <quote>printer queue
|
---|
| 36 | changed</quote>) and a per-user-login-session daemon (for general IPC needs
|
---|
| 37 | among user applications). Also, the message bus is built on top of a
|
---|
| 38 | general one-to-one message passing framework, which can be used by any two
|
---|
| 39 | applications to communicate directly (without going through the message bus
|
---|
| 40 | daemon).</para>
|
---|
| 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download (HTTP): <ulink url="&dbus-download-http;"/></para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download (FTP): <ulink url="&dbus-download-ftp;"/></para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Download MD5 sum: &dbus-md5sum;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Download size: &dbus-size;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Estimated disk space required: &dbus-buildsize;</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>Estimated build time: &dbus-time;</para>
|
---|
| 61 | </listitem>
|
---|
| 62 | </itemizedlist>
|
---|
| 63 |
|
---|
| 64 | <bridgehead renderas="sect3">D-BUS Dependencies</bridgehead>
|
---|
| 65 |
|
---|
| 66 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 67 | <para><xref linkend="pkgconfig"/>,
|
---|
| 68 | <xref linkend="expat"/> or <xref linkend="libxml2"/>,
|
---|
| 69 | <xref linkend="glib2"/>,
|
---|
| 70 | <xref linkend="gtk2"/>,
|
---|
| 71 | <xref linkend="qt"/>,
|
---|
| 72 | X (<xref linkend="xorg"/> or <xref linkend="xfree86"/>),
|
---|
| 73 | <xref linkend="gcc"/> (for the Java compiler and tools),
|
---|
| 74 | <ulink url="http://nz.cosc.canterbury.ac.nz/~greg/python/Pyrex/">Pyrex</ulink>,
|
---|
| 75 | <ulink url="http://go-mono.org">Mono</ulink>,
|
---|
| 76 | <xref linkend="doxygen"/> and
|
---|
| 77 | <ulink url="http://cyberelk.net/tim/xmlto/">xmlto</ulink></para>
|
---|
| 78 |
|
---|
| 79 | </sect2>
|
---|
| 80 |
|
---|
| 81 | <sect2 role="kernel" id='dbus-kernel'>
|
---|
| 82 | <title>Kernel Configuration</title>
|
---|
| 83 |
|
---|
| 84 | <para>Ensure the following option is enabled in the kernel configuration
|
---|
| 85 | and recompile the kernel if necessary:</para>
|
---|
| 86 |
|
---|
| 87 | <screen><literal>General Setup
|
---|
| 88 | System V IPC</literal></screen>
|
---|
| 89 |
|
---|
| 90 | <indexterm zone="dbus dbus-kernel">
|
---|
| 91 | <primary sortas="d-dbus">dbus</primary>
|
---|
| 92 | </indexterm>
|
---|
| 93 |
|
---|
| 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2 role="installation">
|
---|
| 97 | <title>Installation of D-BUS</title>
|
---|
| 98 |
|
---|
| 99 | <para>As the <systemitem class="username">root</systemitem> user, create a
|
---|
| 100 | system user and group to handle the system message bus activity:</para>
|
---|
| 101 |
|
---|
[36c03b1] | 102 | <screen role="root"><userinput>groupadd -g 18 messagebus &&
|
---|
[ccc93e7] | 103 | useradd -c "D-BUS Message Daemon User" -d /dev/null \
|
---|
[36c03b1] | 104 | -u 18 -g messagebus -s /bin/false messagebus</userinput></screen>
|
---|
[e8e3312d] | 105 |
|
---|
| 106 | <para>Install <application>D-BUS</application> by running the following
|
---|
| 107 | commands (you may wish to review the output from
|
---|
| 108 | <command>./configure --help</command> first and add any desired parameters
|
---|
| 109 | to the <command>configure</command> command shown below):</para>
|
---|
| 110 |
|
---|
| 111 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 112 | --sysconfdir=/etc \
|
---|
| 113 | --localstatedir=/var &&
|
---|
| 114 | make</userinput></screen>
|
---|
| 115 |
|
---|
| 116 | <para>This package does not come with a test suite.</para>
|
---|
| 117 |
|
---|
| 118 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 119 |
|
---|
| 120 | <screen role="root"><userinput>make install &&
|
---|
| 121 | install -v -m755 -d /usr/share/doc/dbus-0.50 &&
|
---|
| 122 | install -v -m644 doc/{TODO,*.{dtd,xml,xsl,html,txt,c}} \
|
---|
| 123 | /usr/share/doc/dbus-0.50</userinput></screen>
|
---|
| 124 |
|
---|
| 125 | </sect2>
|
---|
| 126 |
|
---|
| 127 | <sect2 role="commands">
|
---|
| 128 | <title>Command Explanations</title>
|
---|
| 129 |
|
---|
| 130 | <para><parameter>--localstatedir=/var</parameter>: This parameter causes
|
---|
| 131 | the daemon PID file to be created in
|
---|
| 132 | <filename class="directory">/var/run/dbus</filename> instead of
|
---|
| 133 | <filename class="directory">/usr/var/run/dbus</filename>.</para>
|
---|
| 134 |
|
---|
| 135 | </sect2>
|
---|
| 136 |
|
---|
| 137 | <sect2 role="configuration">
|
---|
| 138 | <title>Configuring dbus</title>
|
---|
| 139 |
|
---|
| 140 | <sect3 id="dbus-config">
|
---|
| 141 | <title>Config Files</title>
|
---|
| 142 | <para><filename>/etc/dbus-1/session.conf</filename>,
|
---|
| 143 | <filename>/etc/dbus-1/system.conf</filename> and
|
---|
| 144 | <filename>/etc/system.d/*</filename></para>
|
---|
| 145 |
|
---|
| 146 | <indexterm zone="dbus dbus-config">
|
---|
| 147 | <primary sortas="e-etc-dbus-1-session.conf">/etc/dbus-1/session.conf</primary>
|
---|
| 148 | </indexterm>
|
---|
| 149 |
|
---|
| 150 | <indexterm zone="dbus dbus-config">
|
---|
| 151 | <primary sortas="e-etc-dbus-1/system.conf">/etc/dbus-1/system.conf</primary>
|
---|
| 152 | </indexterm>
|
---|
| 153 |
|
---|
| 154 | <indexterm zone="dbus dbus-config">
|
---|
| 155 | <primary sortas="e-etc-system.d-star">/etc/system.d/*</primary>
|
---|
| 156 | </indexterm>
|
---|
| 157 |
|
---|
| 158 | </sect3>
|
---|
| 159 |
|
---|
| 160 | <sect3><title>Configuration Information</title>
|
---|
| 161 |
|
---|
| 162 | <para>The configuration files listed above should probably not be
|
---|
| 163 | modified. If changes are required, you should create
|
---|
| 164 | <filename>/etc/dbus-1/session-local.conf</filename> and/or
|
---|
| 165 | <filename>/etc/dbus-1/system-local.conf</filename> and make any
|
---|
| 166 | desired changes to these files.</para>
|
---|
| 167 |
|
---|
| 168 | </sect3>
|
---|
| 169 |
|
---|
| 170 | <sect3 id="dbus-init">
|
---|
| 171 | <title>Boot Script</title>
|
---|
| 172 |
|
---|
| 173 | <para>To automatically start <command>dbus-daemon</command> when the
|
---|
| 174 | system is rebooted, install the
|
---|
| 175 | <filename>/etc/rc.d/init.d/dbus</filename> bootscript from the
|
---|
| 176 | <xref linkend="intro-important-bootscripts"/> package.</para>
|
---|
| 177 |
|
---|
| 178 | <indexterm zone="dbus dbus-init">
|
---|
| 179 | <primary sortas="f-dbus">dbus</primary>
|
---|
| 180 | </indexterm>
|
---|
| 181 |
|
---|
| 182 | <screen role="root"><userinput>make install-dbus</userinput></screen>
|
---|
| 183 |
|
---|
| 184 | </sect3>
|
---|
| 185 |
|
---|
| 186 | </sect2>
|
---|
| 187 |
|
---|
| 188 | <sect2 role="content">
|
---|
| 189 | <title>Contents</title>
|
---|
| 190 |
|
---|
| 191 | <segmentedlist>
|
---|
| 192 | <segtitle>Installed Programs</segtitle>
|
---|
| 193 | <segtitle>Installed Libraries</segtitle>
|
---|
| 194 | <segtitle>Installed Directories</segtitle>
|
---|
| 195 |
|
---|
| 196 | <seglistitem>
|
---|
| 197 | <seg>dbus-binding-tool, dbus-cleanup-sockets, dbus-daemon, dbus-launch,
|
---|
| 198 | dbus-monitor, dbus-send and dbus-viewer</seg>
|
---|
| 199 | <seg>libdbus-1.[so,a] and optionally, dbus-1.jar, libdbus-gcj-1.[so,a],
|
---|
| 200 | libdbus-glib-1.[so,a], libdbus-qt-1.[so,a] and
|
---|
| 201 | <application>Python</application> modules</seg>
|
---|
| 202 | <seg>/etc/dbus-1, /usr/include/dbus-1.0, /usr/lib/dbus-1.0,
|
---|
| 203 | /usr/lib/python2.4/site-packages/dbus, /usr/share/dbus-1,
|
---|
| 204 | /usr/share/doc/dbus-&dbus-version; and /var/run/dbus</seg>
|
---|
| 205 | </seglistitem>
|
---|
| 206 | </segmentedlist>
|
---|
| 207 |
|
---|
| 208 | <variablelist>
|
---|
| 209 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 210 | <?dbfo list-presentation="list"?>
|
---|
| 211 | <?dbhtml list-presentation="table"?>
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="dbus-binding-tool">
|
---|
| 214 | <term><command>dbus-binding-tool</command></term>
|
---|
| 215 | <listitem>
|
---|
| 216 | <para>is used to create header files from
|
---|
| 217 | <application>GLib</application> object files.</para>
|
---|
| 218 | <indexterm zone="dbus dbus-binding-tool">
|
---|
| 219 | <primary sortas="b-dbus-binding-tool">dbus-binding-tool</primary>
|
---|
| 220 | </indexterm>
|
---|
| 221 | </listitem>
|
---|
| 222 | </varlistentry>
|
---|
| 223 |
|
---|
| 224 | <varlistentry id="dbus-cleanup-sockets">
|
---|
| 225 | <term><command>dbus-cleanup-sockets</command></term>
|
---|
| 226 | <listitem>
|
---|
| 227 | <para>is used to clean up leftover sockets in a directory.</para>
|
---|
| 228 | <indexterm zone="dbus dbus-cleanup-sockets">
|
---|
| 229 | <primary sortas="b-dbus-cleanup-sockets">dbus-cleanup-sockets</primary>
|
---|
| 230 | </indexterm>
|
---|
| 231 | </listitem>
|
---|
| 232 | </varlistentry>
|
---|
| 233 |
|
---|
| 234 | <varlistentry id="dbus-daemon">
|
---|
| 235 | <term><command>dbus-daemon</command></term>
|
---|
| 236 | <listitem>
|
---|
| 237 | <para>is the <application>D-BUS</application> message bus
|
---|
| 238 | daemon.</para>
|
---|
| 239 | <indexterm zone="dbus dbus-daemon">
|
---|
| 240 | <primary sortas="b-dbus-daemon">dbus-daemon</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
| 245 | <varlistentry id="dbus-launch">
|
---|
| 246 | <term><command>dbus-launch</command></term>
|
---|
| 247 | <listitem>
|
---|
| 248 | <para>is used to start <command>dbus-daemon</command> from a shell
|
---|
| 249 | script. It would normally be called from a user's login
|
---|
| 250 | scripts.</para>
|
---|
| 251 | <indexterm zone="dbus dbus-launch">
|
---|
| 252 | <primary sortas="b-dbus-launch">dbus-launch</primary>
|
---|
| 253 | </indexterm>
|
---|
| 254 | </listitem>
|
---|
| 255 | </varlistentry>
|
---|
| 256 |
|
---|
| 257 | <varlistentry id="dbus-monitor">
|
---|
| 258 | <term><command>dbus-monitor</command></term>
|
---|
| 259 | <listitem>
|
---|
| 260 | <para>is used to monitor messages going through a
|
---|
| 261 | <application>D-BUS</application> message bus.</para>
|
---|
| 262 | <indexterm zone="dbus dbus-monitor">
|
---|
| 263 | <primary sortas="b-dbus-monitor">dbus-monitor</primary>
|
---|
| 264 | </indexterm>
|
---|
| 265 | </listitem>
|
---|
| 266 | </varlistentry>
|
---|
| 267 |
|
---|
| 268 | <varlistentry id="dbus-send">
|
---|
| 269 | <term><command>dbus-send</command></term>
|
---|
| 270 | <listitem>
|
---|
| 271 | <para>is used to send a message to a <application>D-BUS</application>
|
---|
| 272 | message bus.</para>
|
---|
| 273 | <indexterm zone="dbus dbus-send">
|
---|
| 274 | <primary sortas="b-dbus-send">dbus-send</primary>
|
---|
| 275 | </indexterm>
|
---|
| 276 | </listitem>
|
---|
| 277 | </varlistentry>
|
---|
| 278 |
|
---|
| 279 | <varlistentry id="dbus-viewer">
|
---|
| 280 | <term><command>dbus-viewer</command></term>
|
---|
| 281 | <listitem>
|
---|
| 282 | <para>is a graphical <application>D-BUS</application> frontend
|
---|
| 283 | utility.</para>
|
---|
| 284 | <indexterm zone="dbus dbus-viewer">
|
---|
| 285 | <primary sortas="b-dbus-viewer">dbus-viewer</primary>
|
---|
| 286 | </indexterm>
|
---|
| 287 | </listitem>
|
---|
| 288 | </varlistentry>
|
---|
| 289 |
|
---|
| 290 | <varlistentry id="libdbus-1">
|
---|
| 291 | <term><filename class='libraryfile'>libdbus-1.[so,a]</filename></term>
|
---|
| 292 | <listitem>
|
---|
| 293 | <para>contains the API functions used by the
|
---|
| 294 | <application>D-BUS</application> message daemon.
|
---|
| 295 | <application>D-BUS</application> is first a library that provides
|
---|
| 296 | one-to-one communication between any two applications;
|
---|
| 297 | <command>dbus-daemon</command> is an application that uses this
|
---|
| 298 | library to implement a message bus daemon.</para>
|
---|
| 299 | <indexterm zone="dbus libdbus-1">
|
---|
| 300 | <primary sortas="c-libdbus-1">libdbus-1.[so,a]</primary>
|
---|
| 301 | </indexterm>
|
---|
| 302 | </listitem>
|
---|
| 303 | </varlistentry>
|
---|
| 304 |
|
---|
| 305 | </variablelist>
|
---|
| 306 |
|
---|
| 307 | </sect2>
|
---|
| 308 |
|
---|
| 309 | </sect1>
|
---|