source: general/genlib/dbus-bindings.xml@ ca89597d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY dbus-glib-download-http "http://dbus.freedesktop.org/releases/dbus-glib/dbus-glib-&dbus-glib-version;.tar.gz">
  <!ENTITY dbus-glib-download-ftp  " ">
  <!ENTITY dbus-glib-md5sum        "aa2a4517de0e9144be3bce2cf8cdd924">
  <!ENTITY dbus-glib-size          "660 KB">
  <!ENTITY dbus-glib-buildsize     "10 MB">
  <!ENTITY dbus-glib-time          "0.2 SBU">

  <!ENTITY dbus-python-download-http "http://dbus.freedesktop.org/releases/dbus-python/dbus-python-&dbus-python-version;.tar.gz">
  <!ENTITY dbus-python-download-ftp  " ">
  <!ENTITY dbus-python-md5sum        "562c78876219bf458d79a041af18293d">
  <!ENTITY dbus-python-size          "494 KB">
  <!ENTITY dbus-python-buildsize     "12 MB (includes installing all the documentation)">
  <!ENTITY dbus-python-time          "0.3 SBU">

  <!ENTITY dbus-qt3-download-http "&files-anduin;/sources/dbus-qt3-&dbus-qt3-version;.tar.bz2">
  <!ENTITY dbus-qt3-download-ftp  " ">
  <!ENTITY dbus-qt3-md5sum        "307e119f501c207a437d1dd087c9af80">
  <!ENTITY dbus-qt3-size          "390 KB">
  <!ENTITY dbus-qt3-buildsize     "4 MB">
  <!ENTITY dbus-qt3-time          "0.1 SBU">

  <!-- All the other bindings info should be here as well -->
]>

<sect1 id="dbus-bindings" xreflabel="D-Bus Bindings">
  <?dbhtml filename="dbus-bindings.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>D-Bus Bindings</title>

  <indexterm zone="dbus-bindings">
    <primary sortas="a-dbus-bindings">D-Bus Bindings</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to D-Bus Bindings</title>

    <para>The <application>D-Bus Bindings</application> are a group of packages
    that contain programming language and platform interfaces to the D-Bus API.
    This is useful for programmers to easily interface D-Bus with their
    supported platform or language of choice. Some non-D-Bus packages will
    require one or more of the Bindings packages in order to build
    successfully.</para>

    <para>The <application>GLib</application>,
    <application>Python</application> and <application>Qt3</application>
    Bindings are included on this page. Other language bindings will be added
    soon. Until then, see the <ulink
    url="http://www.freedesktop.org/wiki/Software/DBusBindings">D-Bus
    Bindings</ulink> page for information.</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para><xref linkend="dbus-glib"/></para>
      </listitem>
      <listitem>
        <para><xref linkend="dbus-python"/></para>
      </listitem>
      <listitem>
        <para><xref linkend="dbus-qt3"/></para>
      </listitem>
    </itemizedlist>

  </sect2>

  <!-- Below is 111 lines to cut and paste to create a new binding -->
  <!-- Begin D-Bus GLib Bindings -->
  <sect2 id="dbus-glib" xreflabel="D-Bus GLib Bindings-&dbus-glib-version;">
  <title>D-Bus GLib Bindings</title>

  <indexterm zone="dbus-glib">
    <primary sortas="a-dbus-glib">D-Bus GLib Bindings</primary>
  </indexterm>

    &lfs65_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&dbus-glib-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&dbus-glib-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &dbus-glib-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &dbus-glib-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &dbus-glib-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &dbus-glib-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">D-Bus GLib Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="dbus"/>,
    <xref linkend="glib2"/>, and
    <xref linkend="expat"/></para>

    <bridgehead renderas="sect4">Optional to Build the API Documentation</bridgehead>
    <para role="required"><xref linkend="doxygen"/></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/dbus-glib"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of D-Bus GLib Bindings</title>

    <para>Install <application>D-Bus GLib Bindings</application> by
    running the following commands:</para>

<screen><userinput>./configure --prefix=/usr \ 
            --libexecdir=/usr/lib/dbus-1.0/dbus-1 &amp;&amp;
make</userinput></screen>

    <para>The <option>--enable-doxygen-docs</option> parameter does not work
    properly. If you have <application>Doxygen</application> installed and you
    wish to build the API documentation, issue
    <command>doxygen</command>.</para>

    <para>To test the results, issue: <command>make check</command>. Note that
    more comprehensive tests can be run by following the same method used in
    <application>D-BUS</application> instructions, which requires building the
    package twice.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>If you built the API documentation, install it by issuing the
    following commands as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/dbus-glib-&dbus-glib-version;/api \
                    /usr/share/man/man3dbus &amp;&amp;
install -v -m644    doc/api/html/* \
                    /usr/share/doc/dbus-glib-&dbus-glib-version;/api &amp;&amp;
install -v -m644    doc/api/man/man3dbus/* \
                    /usr/share/man/man3dbus</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--libexecdir=/usr/lib/dbus-1.0/dbus-1</parameter>: This
    moves <command>dbus-bash-completion-helper</command> out of <filename
    class="directory">/usr/libexec</filename>.</para>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>dbus-binding-tool</seg>
        <seg>libdbus-glib-1.{so,a}</seg>
        <seg>/etc/bash_completion.d, /usr/share/gtk-doc/html/dbus-glib, and
        optionally /usr/share/doc/dbus-glib-&dbus-glib-version;/api</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="glib-dbus-binding-tool">
        <term><command>dbus-binding-tool</command></term>
        <listitem>
          <para>is a tool used to interface with the D-Bus API.</para>
          <indexterm zone="dbus-glib glib-dbus-binding-tool">
            <primary sortas="b-dbus-binding-tool">dbus-binding-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libdbus-glib-1">
        <term><filename class='libraryfile'>libdbus-glib-1.{so,a}</filename></term>
        <listitem>
          <para>contains <application>GLib</application> interface functions
          to the D-Bus API.</para>
          <indexterm zone="dbus-glib libdbus-glib-1">
            <primary sortas="c-libdbus-glib-1">libdbus-glib-1.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

  <!-- Begin D-Bus Python Bindings -->
  <sect2 id="dbus-python" xreflabel="D-Bus Python Bindings-&dbus-python-version;">
  <title>D-Bus Python Bindings</title>

  <indexterm zone="dbus-python">
    <primary sortas="a-dbus-python">D-Bus Python Bindings</primary>
  </indexterm>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&dbus-python-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&dbus-python-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &dbus-python-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &dbus-python-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &dbus-python-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &dbus-python-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">D-Bus Python Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="python"/> and
    <xref linkend="dbus-glib"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><ulink url="&gnome-download-http;/pygobject">PyGObject</ulink>
    (required to run the test suite)</para>

    <bridgehead renderas="sect4">Optional
    (Required to build the API and HTML Documentation)</bridgehead>
    <para role="optional"><ulink url="http://epydoc.sourceforge.net/">Epydoc</ulink>
    and <ulink url="http://docutils.sourceforge.net/">Docutils</ulink></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/dbus-python"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of D-Bus Python Bindings</title>

    <para>Install <application>D-Bus Python Bindings</application> by
    running the following commands:</para>

<screen><userinput>./configure --prefix=/usr \
            --docdir=/usr/share/doc/dbus-python-&dbus-python-version; &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>. Note you
    must have <application>PyGObject</application> installed.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>If you built the API documentation, install it by issuing the
    following commands as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/dbus-python-&dbus-python-version;/api &amp;&amp;
install -v -m644    api/* \
                    /usr/share/doc/dbus-python-&dbus-python-version;/api</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg><application>Python</application>
        <application>D-Bus</application> modules</seg>
        <seg>/usr/lib/python&python-majorver;/site-packages/dbus and
        /usr/share/doc/dbus-python-&dbus-python-version;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <!-- Begin D-Bus Qt3 Bindings -->
  <sect2 id="dbus-qt3" xreflabel="D-Bus Qt3 Bindings-&dbus-qt3-version;">
  <title>D-Bus Qt3 Bindings</title>

  <indexterm zone="dbus-qt3">
    <primary sortas="a-dbus-qt3">D-Bus Qt3 Bindings</primary>
  </indexterm>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&dbus-qt3-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&dbus-qt3-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &dbus-qt3-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &dbus-qt3-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &dbus-qt3-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &dbus-qt3-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">D-Bus Qt3 Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="dbus"/> and
    <xref linkend="qt"/></para>

    <!-- <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="pkgconfig"/></para> -->

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/dbus-qt3"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of D-Bus Qt3 Bindings</title>

    <para>Install <application>D-Bus Qt3 Bindings</application> by
    running the following commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libdbus-qt-1.so</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libdbus-qt-1">
        <term><filename class='libraryfile'>libdbus-qt-1.{so,a}</filename></term>
        <listitem>
          <para>contains <application>Qt3</application> interface functions
          to the D-Bus API.</para>
          <indexterm zone="dbus-qt3 libdbus-qt-1">
            <primary sortas="c-libdbus-qt-1">libdbus-qt-1.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>