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</userinput></screen>
  59
  60     <variablelist>
  61       <title>The meaning of the configure options:</title>
  62
  63       <varlistentry>
  64         <term><parameter>--with-console-auth-dir=/run/console</parameter></term>
  65         <listitem>
  66           <para>This specifies the location of the ConsoleKit authorization
  67           directory.</para>
  68         </listitem>
  69       </varlistentry>
  70
  71     </variablelist>
  72
  73     <para>Compile the package:</para>
  74
  75 <screen><userinput remap="make">make</userinput></screen>
  76
  77     <para>This package does come with a test suite, but it requires several
  78     packages that are not included in LFS. Instructions for running the
  79     test suite can be found in the BLFS book at
  80     <ulink url="&blfs-book;general/dbus.html"/>.</para>
  81
  82     <para>Install the package:</para>
  83
  84 <screen><userinput remap="install">make install</userinput></screen>
  85
  86     <para>The shared library needs to be moved to
  87     <filename class="directory">/lib</filename>, and as a result the
  88     <filename class="extension">.so</filename> file in
  89     <filename class="directory">/usr/lib</filename> will need to be recreated:</para>
  90
  91 <screen><userinput remap="install">mv -v /usr/lib/libdbus-1.so.* /lib
  92 ln -sfv ../../lib/$(readlink /usr/lib/libdbus-1.so) /usr/lib/libdbus-1.so</userinput></screen>
  93
  94     <para>Create a symlink so that D-Bus and systemd can use the same
  95     <filename>machine-id</filename> file:</para>
  96
  97 <screen><userinput remap="install">ln -sfv /etc/machine-id /var/lib/dbus</userinput></screen>
  98
  99     <para>Move the socket file to /run instead of the deprecated
 100     /var/run:</para>
 101
 102  <screen><userinput remap="install">sed -i 's:/var/run:/run:' /lib/systemd/system/dbus.socket</userinput></screen>
 103
 104   </sect2>
 105
 106   <sect2 id="contents-dbus" role="content">
 107     <title>Contents of D-Bus</title>
 108
 109     <segmentedlist>
 110       <segtitle>Installed programs</segtitle>
 111       <segtitle>Installed libraries</segtitle>
 112       <segtitle>Installed directories</segtitle>
 113
 114       <seglistitem>
 115         <seg>dbus-cleanup-sockets, dbus-daemon, dbus-launch, dbus-monitor,
 116         dbus-run-session, dbus-send, dbus-test-tool,
 117         dbus-update-activation-environment, and dbus-uuidgen</seg>
 118         <seg>libdbus-1.{a,so}</seg>
 119         <seg>/etc/dbus-1, /usr/include/dbus-1.0, /usr/lib/dbus-1.0,
 120         /usr/share/dbus-1, /usr/share/doc/dbus-&dbus-version;,
 121         and /var/lib/dbus</seg>
 122       </seglistitem>
 123     </segmentedlist>
 124
 125     <variablelist>
 126       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 127       <?dbfo list-presentation="list"?>
 128       <?dbhtml list-presentation="table"?>
 129
 130       <varlistentry id="dbus-cleanup-sockets">
 131         <term><command>dbus-cleanup-sockets</command></term>
 132         <listitem>
 133           <para>is used to remove leftover sockets in a directory</para>
 134           <indexterm zone="ch-system-dbus dbus-cleanup-sockets">
 135             <primary sortas="b-dbus-cleanup-sockets">dbus-cleanup-sockets</primary>
 136           </indexterm>
 137         </listitem>
 138       </varlistentry>
 139
 140       <varlistentry id="dbus-daemon">
 141         <term><command>dbus-daemon</command></term>
 142         <listitem>
 143           <para>Is the D-Bus message bus daemon</para>
 144           <indexterm zone="ch-system-dbus dbus-daemon">
 145             <primary sortas="b-dbus-daemon">dbus-daemon</primary>
 146           </indexterm>
 147         </listitem>
 148       </varlistentry>
 149
 150       <varlistentry id="dbus-launch">
 151         <term><command>dbus-launch</command></term>
 152         <listitem>
 153           <para>Starts <command>dbus-daemon</command> from a shell
 154           script</para>
 155           <indexterm zone="ch-system-dbus dbus-launch">
 156             <primary sortas="b-dbus-launch">dbus-launch</primary>
 157           </indexterm>
 158         </listitem>
 159       </varlistentry>
 160
 161       <varlistentry id="dbus-monitor">
 162         <term><command>dbus-monitor</command></term>
 163         <listitem>
 164           <para>Monitors messages passing through a D-Bus message bus</para>
 165           <indexterm zone="ch-system-dbus dbus-monitor">
 166             <primary sortas="b-dbus-monitor">dbus-monitor</primary>
 167           </indexterm>
 168         </listitem>
 169       </varlistentry>
 170
 171       <varlistentry id="dbus-run-session">
 172         <term><command>dbus-run-session</command></term>
 173         <listitem>
 174           <para>Starts a session bus instance of <command>dbus-daemon</command>
 175           from a shell script and starts a specified program in that
 176           session</para>
 177           <indexterm zone="ch-system-dbus dbus-run-session">
 178             <primary sortas="b-dbus-run-session">dbus-run-session</primary>
 179           </indexterm>
 180         </listitem>
 181       </varlistentry>
 182
 183       <varlistentry id="dbus-send">
 184         <term><command>dbus-send</command></term>
 185         <listitem>
 186           <para>Sends a message to a D-Bus message bus</para>
 187           <indexterm zone="ch-system-dbus dbus-send">
 188             <primary sortas="b-dbus-send">dbus-send</primary>
 189           </indexterm>
 190         </listitem>
 191       </varlistentry>
 192
 193       <varlistentry id="dbus-test-tool">
 194         <term><command>dbus-test-tool</command></term>
 195         <listitem>
 196           <para>Is a tool to help packages test
 197           <application>D-Bus</application></para>
 198           <indexterm zone="ch-system-dbus dbus-test-tool">
 199             <primary sortas="b-dbus-test-tool">dbus-test-tool</primary>
 200           </indexterm>
 201         </listitem>
 202       </varlistentry>
 203
 204       <!-- This is a very long command name. Excuse the long <primary> statement below. -->
 205       <varlistentry id="dbus-update-activation-environment">
 206         <term><command>dbus-update-activation-environment</command></term>
 207         <listitem>
 208           <para>Updates environment variables that will be set for
 209           <application>D-Bus</application> session services</para>
 210           <indexterm zone="ch-system-dbus dbus-update-activation-environment">
 211             <primary sortas="b-dbus-update-activation-environment">dbus-update-activation-environment</primary>
 212           </indexterm>
 213         </listitem>
 214       </varlistentry>
 215
 216       <varlistentry id="dbus-uuidgen">
 217         <term><command>dbus-uuidgen</command></term>
 218         <listitem>
 219           <para>Generates a universally unique ID</para>
 220           <indexterm zone="ch-system-dbus dbus-uuidgen">
 221             <primary sortas="b-dbus-uuidgen">dbus-uuidgen</primary>
 222           </indexterm>
 223         </listitem>
 224       </varlistentry>
 225
 226       <varlistentry id="libdbus-1">
 227         <term><filename class="libraryfile">libdbus-1</filename></term>
 228         <listitem>
 229           <para>Contains API functions used to communicate with the D-Bus
 230           message bus</para>
 231           <indexterm zone="ch-system-dbus libdbus-1">
 232             <primary sortas="c-libdbus-1">libdbus-1</primary>
 233           </indexterm>
 234         </listitem>
 235       </varlistentry>
 236
 237     </variablelist>
 238
 239   </sect2>
 240
 241 </sect1>