chapter06/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-ch6-sbu;</seg>
  40         <seg>&dbus-ch6-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 auth
  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   </sect2>
 100
 101   <sect2 id="contents-dbus" role="content">
 102     <title>Contents of D-Bus</title>
 103
 104     <segmentedlist>
 105       <segtitle>Installed programs</segtitle>
 106       <segtitle>Installed libraries</segtitle>
 107       <segtitle>Installed directories</segtitle>
 108
 109       <seglistitem>
 110         <seg>dbus-cleanup-sockets, dbus-daemon, dbus-launch, dbus-monitor,
 111         dbus-run-session, dbus-send, and dbus-uuidgen</seg>
 112         <seg>libdbus-1.{a,so}</seg>
 113         <seg>/etc/dbus-1, /usr/include/dbus-1.0, /usr/lib/dbus-1.0,
 114         /usr/share/dbus-1, /usr/share/doc/dbus-&dbus-version;,
 115         and /var/lib/dbus</seg>
 116       </seglistitem>
 117     </segmentedlist>
 118
 119     <variablelist>
 120       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 121       <?dbfo list-presentation="list"?>
 122       <?dbhtml list-presentation="table"?>
 123
 124       <varlistentry id="dbus-cleanup-sockets">
 125         <term><command>dbus-cleanup-sockets</command></term>
 126         <listitem>
 127           <para>Used to clean up leftover sockets in a directory</para>
 128           <indexterm zone="ch-system-dbus dbus-cleanup-sockets">
 129             <primary sortas="b-dbus-cleanup-sockets">dbus-cleanup-sockets</primary>
 130           </indexterm>
 131         </listitem>
 132       </varlistentry>
 133
 134       <varlistentry id="dbus-daemon">
 135         <term><command>dbus-daemon</command></term>
 136         <listitem>
 137           <para>The D-Bus message bus daemon</para>
 138           <indexterm zone="ch-system-dbus dbus-daemon">
 139             <primary sortas="b-dbus-daemon">dbus-daemon</primary>
 140           </indexterm>
 141         </listitem>
 142       </varlistentry>
 143
 144       <varlistentry id="dbus-launch">
 145         <term><command>dbus-launch</command></term>
 146         <listitem>
 147           <para>Starts <command>dbus-daemon</command> from a shell
 148           script</para>
 149           <indexterm zone="ch-system-dbus dbus-launch">
 150             <primary sortas="b-dbus-launch">dbus-launch</primary>
 151           </indexterm>
 152         </listitem>
 153       </varlistentry>
 154
 155       <varlistentry id="dbus-monitor">
 156         <term><command>dbus-monitor</command></term>
 157         <listitem>
 158           <para>Monitors messages passing through a D-Bus message bus</para>
 159           <indexterm zone="ch-system-dbus dbus-monitor">
 160             <primary sortas="b-dbus-monitor">dbus-monitor</primary>
 161           </indexterm>
 162         </listitem>
 163       </varlistentry>
 164
 165       <varlistentry id="dbus-run-session">
 166         <term><command>dbus-run-session</command></term>
 167         <listitem>
 168           <para>Starts a session bus instance of <command>dbus-daemon</command>
 169           from a shell script and starts a specified program in that
 170           session</para>
 171           <indexterm zone="ch-system-dbus dbus-run-session">
 172             <primary sortas="b-dbus-run-session">dbus-run-session</primary>
 173           </indexterm>
 174         </listitem>
 175       </varlistentry>
 176
 177       <varlistentry id="dbus-send">
 178         <term><command>dbus-send</command></term>
 179         <listitem>
 180           <para>Sends a message to a D-Bus message bus</para>
 181           <indexterm zone="ch-system-dbus dbus-send">
 182             <primary sortas="b-dbus-send">dbus-send</primary>
 183           </indexterm>
 184         </listitem>
 185       </varlistentry>
 186
 187       <varlistentry id="dbus-uuidgen">
 188         <term><command>dbus-uuidgen</command></term>
 189         <listitem>
 190           <para>Generates a universally unique ID</para>
 191           <indexterm zone="ch-system-dbus dbus-uuidgen">
 192             <primary sortas="b-dbus-uuidgen">dbus-uuidgen</primary>
 193           </indexterm>
 194         </listitem>
 195       </varlistentry>
 196
 197       <varlistentry id="libdbus-1">
 198         <term><filename class="libraryfile">libdbus-1</filename></term>
 199         <listitem>
 200           <para>Contains API functions used to communicate with the D-Bus
 201           message bus</para>
 202           <indexterm zone="ch-system-dbus libdbus-1">
 203             <primary sortas="c-libdbus-1">libdbus-1</primary>
 204           </indexterm>
 205         </listitem>
 206       </varlistentry>
 207
 208     </variablelist>
 209
 210   </sect2>
 211
 212 </sect1>