BOOK/chapter08/dbus.xml

   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
   8 <sect1 id="ch-system-dbus" role="wrap" revision="systemd">
   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>
  39         <seg>&dbus-fin-sbu;</seg>
  40         <seg>&dbus-fin-du;</seg>
  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
  51 <screen><userinput remap="configure">./configure --prefix=/usr                        \
  52             --sysconfdir=/etc                    \
  53             --localstatedir=/var                 \
  54             --disable-static                     \
  55             --disable-doxygen-docs               \
  56             --disable-xml-docs                   \
  57             --docdir=/usr/share/doc/dbus-&dbus-version; \
  58             --with-console-auth-dir=/run/console \
  59             --with-system-pid-file=/run/dbus/pid \
  60             --with-system-socket=/run/dbus/system_bus_socket</userinput></screen>
  61
  62     <variablelist>
  63       <title>The meaning of the configure options:</title>
  64
  65       <varlistentry>
  66         <term><parameter>--with-console-auth-dir=/run/console</parameter></term>
  67         <listitem>
  68           <para>This specifies the location of the ConsoleKit authorization
  69           directory.</para>
  70         </listitem>
  71       </varlistentry>
  72
  73       <varlistentry>
  74         <term>
  75           <parameter>--with-system-pid-file=/run/dbus/pid</parameter> and
  76           <parameter>--with-system-socket=/run/dbus/system_bus_socket</parameter>
  77         </term>
  78         <listitem>
  79           <para>These set the location of the PID file and the system bus socket
  80           to be in <filename class="directory">/run</filename>, instead of
  81           deprecated <filename class="directory">/var/run</filename>.</para>
  82         </listitem>
  83       </varlistentry>
  84
  85     </variablelist>
  86
  87     <para>Compile the package:</para>
  88
  89 <screen><userinput remap="make">make</userinput></screen>
  90
  91     <para>This package does come with a test suite, but it requires several
  92     packages that are not included in LFS. Instructions for running the
  93     test suite can be found in the BLFS book at
  94     <ulink url="&blfs-book;general/dbus.html"/>.</para>
  95
  96     <para>Install the package:</para>
  97
  98 <screen><userinput remap="install">make install</userinput></screen>
  99
 100     <para>The shared library needs to be moved to
 101     <filename class="directory">/lib</filename>, and as a result the
 102     <filename class="extension">.so</filename> file in
 103     <filename class="directory">/usr/lib</filename> will need to be recreated:</para>
 104
 105 <screen><userinput remap="install">mv -v /usr/lib/libdbus-1.so.* /lib
 106 ln -sfv ../../lib/$(readlink /usr/lib/libdbus-1.so) /usr/lib/libdbus-1.so</userinput></screen>
 107
 108     <para>Create a symlink so that D-Bus and systemd can use the same
 109     <filename>machine-id</filename> file:</para>
 110
 111 <screen><userinput remap="install">ln -sfv /etc/machine-id /var/lib/dbus</userinput></screen>
 112
 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,
 125         dbus-run-session, dbus-send, dbus-test-tool,
 126         dbus-update-activation-environment, and dbus-uuidgen</seg>
 127         <seg>libdbus-1.{a,so}</seg>
 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;,
 130         and /var/lib/dbus</seg>
 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>
 142           <para>is used to remove leftover sockets in a directory</para>
 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>
 152           <para>Is the D-Bus message bus daemon</para>
 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>
 162           <para>Starts <command>dbus-daemon</command> from a shell
 163           script</para>
 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>
 173           <para>Monitors messages passing through a D-Bus message bus</para>
 174           <indexterm zone="ch-system-dbus dbus-monitor">
 175             <primary sortas="b-dbus-monitor">dbus-monitor</primary>
 176           </indexterm>
 177         </listitem>
 178       </varlistentry>
 179
 180       <varlistentry id="dbus-run-session">
 181         <term><command>dbus-run-session</command></term>
 182         <listitem>
 183           <para>Starts a session bus instance of <command>dbus-daemon</command>
 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
 192       <varlistentry id="dbus-send">
 193         <term><command>dbus-send</command></term>
 194         <listitem>
 195           <para>Sends a message to a D-Bus message bus</para>
 196           <indexterm zone="ch-system-dbus dbus-send">
 197             <primary sortas="b-dbus-send">dbus-send</primary>
 198           </indexterm>
 199         </listitem>
 200       </varlistentry>
 201
 202       <varlistentry id="dbus-test-tool">
 203         <term><command>dbus-test-tool</command></term>
 204         <listitem>
 205           <para>Is a tool to help packages test
 206           <application>D-Bus</application></para>
 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>
 217           <para>Updates environment variables that will be set for
 218           <application>D-Bus</application> session services</para>
 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
 225       <varlistentry id="dbus-uuidgen">
 226         <term><command>dbus-uuidgen</command></term>
 227         <listitem>
 228           <para>Generates a universally unique ID</para>
 229           <indexterm zone="ch-system-dbus dbus-uuidgen">
 230             <primary sortas="b-dbus-uuidgen">dbus-uuidgen</primary>
 231           </indexterm>
 232         </listitem>
 233       </varlistentry>
 234
 235       <varlistentry id="libdbus-1">
 236         <term><filename class="libraryfile">libdbus-1</filename></term>
 237         <listitem>
 238           <para>Contains API functions used to communicate with the D-Bus
 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
 246     </variablelist>
 247
 248   </sect2>
 249
 250 </sect1>