source: archive/dbus-bindings.xml@ ae96c4b

<?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        "ad0920c7e3aad669163bb59171cf138e">
  <!ENTITY dbus-glib-size          "732 KB">
  <!ENTITY dbus-glib-buildsize     "12 MB">
  <!ENTITY dbus-glib-time          "0.1 SBU">

]>

<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> and
    <application>Python</application> bindings are included on this page. Other
    language bindings are available at 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>
    </itemizedlist>

  </sect2>

  <!-- 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>

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

      &lfs73_checked;

      <bridgehead renderas="sect4">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="sect4">D-Bus GLib Dependencies</bridgehead>

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

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

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

    <sect3 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 \
            --sysconfdir=/etc \
            --libexecdir=/usr/lib/dbus-1.0 \
            --disable-static &amp;&amp;
make</userinput></screen>

      <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>

    </sect3>

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

      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
        href="../../xincludes/static-libraries.xml"/>

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

    </sect3>

    <sect3 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
          </seg>
          <seg>
            /usr/share/gtk-doc/html/dbus-glib and
            /usr/share/doc/dbus-glib-&dbus-glib-version;
          </seg>
        </seglistitem>
      </segmentedlist>

      <variablelist>
        <bridgehead renderas="sect4">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</filename></term>
          <listitem>
            <para>
              contains <application>GLib</application> interface functions
              to the <application>D-Bus</application> API.
            </para>
            <indexterm zone="dbus-glib libdbus-glib-1">
              <primary sortas="c-libdbus-glib-1">libdbus-glib-1.so</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>

</sect1>