glfs/archive/dbus-bindings.xml
Pierre Labastie 3f2db3a638 Remove sect1info tags
They only contain a date tag that is nowhere used.
2022-11-29 08:58:07 +01:00

333 lines
11 KiB
XML

<?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">
<!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 "742c7432ad0f7c3f98291d58fa2e35dc">
<!ENTITY dbus-python-size "583 KB">
<!ENTITY dbus-python-buildsize "5.7 MB">
<!ENTITY dbus-python-time "0.2 SBU">
<!-- All the other bindings info should be here as well -->
]>
<sect1 id="dbus-bindings" xreflabel="D-Bus Bindings">
<?dbhtml filename="dbus-bindings.html"?>
<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>
<listitem>
<para><xref linkend="dbus-python"/></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="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>
<!-- 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>
<sect3 role="package">
<title>Introduction to D-Bus Python Bindings</title>
&lfs73_checked;
<bridgehead renderas="sect4">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="sect4">D-Bus Python Dependencies</bridgehead>
<bridgehead renderas="sect5">Required</bridgehead>
<para role="required">
<xref linkend="python2"/> and
<xref linkend="dbus-glib"/>
</para>
<bridgehead renderas="sect5">Optional</bridgehead>
<para role="optional">
<xref linkend="pygobject2"/> (required to run the test suite)
</para>
<bridgehead renderas="sect5">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>
</sect3>
<sect3 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>
</sect3>
<sect3 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&python2-majorver;/site-packages/dbus and
/usr/share/doc/dbus-python-&dbus-python-version;</seg>
</seglistitem>
</segmentedlist>
</sect3>
</sect2>
</sect1>