source: archive/dbus-bindings.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 10.6 KB
Line 
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 <!ENTITY dbus-glib-download-http "http://dbus.freedesktop.org/releases/dbus-glib/dbus-glib-&dbus-glib-version;.tar.gz">
8 <!ENTITY dbus-glib-download-ftp " ">
9 <!ENTITY dbus-glib-md5sum "ad0920c7e3aad669163bb59171cf138e">
10 <!ENTITY dbus-glib-size "732 KB">
11 <!ENTITY dbus-glib-buildsize "12 MB">
12 <!ENTITY dbus-glib-time "0.1 SBU">
13
14 <!ENTITY dbus-python-download-http "http://dbus.freedesktop.org/releases/dbus-python/dbus-python-&dbus-python-version;.tar.gz">
15 <!ENTITY dbus-python-download-ftp " ">
16 <!ENTITY dbus-python-md5sum "742c7432ad0f7c3f98291d58fa2e35dc">
17 <!ENTITY dbus-python-size "583 KB">
18 <!ENTITY dbus-python-buildsize "5.7 MB">
19 <!ENTITY dbus-python-time "0.2 SBU">
20
21 <!-- All the other bindings info should be here as well -->
22]>
23
24<sect1 id="dbus-bindings" xreflabel="D-Bus Bindings">
25 <?dbhtml filename="dbus-bindings.html"?>
26
27
28 <title>D-Bus Bindings</title>
29
30 <indexterm zone="dbus-bindings">
31 <primary sortas="a-dbus-bindings">D-Bus Bindings</primary>
32 </indexterm>
33
34 <sect2 role="package">
35 <title>Introduction to D-Bus Bindings</title>
36
37 <para>The <application>D-Bus Bindings</application> are a group of packages
38 that contain programming language and platform interfaces to the D-Bus API.
39 This is useful for programmers to easily interface D-Bus with their
40 supported platform or language of choice. Some non-D-Bus packages will
41 require one or more of the Bindings packages in order to build
42 successfully.</para>
43
44 <para>The <application>GLib</application> and
45 <application>Python</application> bindings are included on this page. Other
46 language bindings are available at the <ulink
47 url="http://www.freedesktop.org/wiki/Software/DBusBindings">D-Bus
48 Bindings</ulink> page for information.</para>
49
50 <itemizedlist spacing="compact">
51 <listitem>
52 <para><xref linkend="dbus-glib"/></para>
53 </listitem>
54 <listitem>
55 <para><xref linkend="dbus-python"/></para>
56 </listitem>
57 </itemizedlist>
58
59 </sect2>
60
61 <!-- Begin D-Bus GLib Bindings -->
62 <sect2 id="dbus-glib" xreflabel="D-Bus GLib Bindings-&dbus-glib-version;">
63 <title>D-Bus GLib Bindings</title>
64
65 <indexterm zone="dbus-glib">
66 <primary sortas="a-dbus-glib">D-Bus GLib Bindings</primary>
67 </indexterm>
68
69 <sect3 role="package">
70 <title>Introduction to D-Bus GLib Bindings</title>
71
72 &lfs73_checked;
73
74 <bridgehead renderas="sect4">Package Information</bridgehead>
75 <itemizedlist spacing="compact">
76 <listitem>
77 <para>
78 Download (HTTP): <ulink url="&dbus-glib-download-http;"/>
79 </para>
80 </listitem>
81 <listitem>
82 <para>
83 Download (FTP): <ulink url="&dbus-glib-download-ftp;"/>
84 </para>
85 </listitem>
86 <listitem>
87 <para>
88 Download MD5 sum: &dbus-glib-md5sum;
89 </para>
90 </listitem>
91 <listitem>
92 <para>
93 Download size: &dbus-glib-size;
94 </para>
95 </listitem>
96 <listitem>
97 <para>
98 Estimated disk space required: &dbus-glib-buildsize;
99 </para>
100 </listitem>
101 <listitem>
102 <para>
103 Estimated build time: &dbus-glib-time;
104 </para>
105 </listitem>
106 </itemizedlist>
107
108 <bridgehead renderas="sect4">D-Bus GLib Dependencies</bridgehead>
109
110 <bridgehead renderas="sect5">Required</bridgehead>
111 <para role="required">
112 <xref linkend="expat"/> and
113 <xref linkend="glib2"/>
114 </para>
115
116 <bridgehead renderas="sect5">Optional to Build the API Documentation</bridgehead>
117 <para role="optional">
118 <xref linkend="doxygen"/>
119 </para>
120
121 <para condition="html" role="usernotes">User Notes:
122 <ulink url="&blfs-wiki;/dbus-glib"/>
123 </para>
124 </sect3>
125
126 <sect3 role="installation">
127 <title>Installation of D-Bus GLib Bindings</title>
128
129 <para>
130 Install <application>D-Bus GLib Bindings</application> by
131 running the following commands:
132 </para>
133
134<screen><userinput>./configure --prefix=/usr \
135 --sysconfdir=/etc \
136 --libexecdir=/usr/lib/dbus-1.0 \
137 --disable-static &amp;&amp;
138make</userinput></screen>
139
140 <para>
141 To test the results, issue: <command>make check</command>. Note that
142 more comprehensive tests can be run by following the same method used in
143 <application>D-Bus</application> instructions, which requires building the
144 package twice.
145 </para>
146
147 <para>
148 Now, as the <systemitem class="username">root</systemitem> user:
149 </para>
150
151<screen role="root"><userinput>make install</userinput></screen>
152
153 </sect3>
154
155 <sect3 role="commands">
156 <title>Command Explanations</title>
157
158 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
159 href="../../xincludes/static-libraries.xml"/>
160
161 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
162 href="../../xincludes/gtk-doc-rebuild.xml"/>
163
164 </sect3>
165
166 <sect3 role="content">
167 <title>Contents</title>
168
169 <segmentedlist>
170 <segtitle>Installed Program</segtitle>
171 <segtitle>Installed Library</segtitle>
172 <segtitle>Installed Directories</segtitle>
173
174 <seglistitem>
175 <seg>
176 dbus-binding-tool
177 </seg>
178 <seg>
179 libdbus-glib-1.so
180 </seg>
181 <seg>
182 /usr/share/gtk-doc/html/dbus-glib and
183 /usr/share/doc/dbus-glib-&dbus-glib-version;
184 </seg>
185 </seglistitem>
186 </segmentedlist>
187
188 <variablelist>
189 <bridgehead renderas="sect4">Short Descriptions</bridgehead>
190 <?dbfo list-presentation="list"?>
191 <?dbhtml list-presentation="table"?>
192
193 <varlistentry id="glib-dbus-binding-tool">
194 <term><command>dbus-binding-tool</command></term>
195 <listitem>
196 <para>
197 is a tool used to interface with the D-Bus API.
198 </para>
199 <indexterm zone="dbus-glib glib-dbus-binding-tool">
200 <primary sortas="b-dbus-binding-tool">dbus-binding-tool</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="libdbus-glib-1">
206 <term><filename class="libraryfile">libdbus-glib-1.so</filename></term>
207 <listitem>
208 <para>
209 contains <application>GLib</application> interface functions
210 to the <application>D-Bus</application> API.
211 </para>
212 <indexterm zone="dbus-glib libdbus-glib-1">
213 <primary sortas="c-libdbus-glib-1">libdbus-glib-1.so</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 </variablelist>
219
220 </sect3>
221
222 </sect2>
223
224 <!-- Begin D-Bus Python Bindings -->
225 <sect2 id="dbus-python" xreflabel="D-Bus Python Bindings-&dbus-python-version;">
226 <title>D-Bus Python Bindings</title>
227
228 <indexterm zone="dbus-python">
229 <primary sortas="a-dbus-python">D-Bus Python Bindings</primary>
230 </indexterm>
231
232 <sect3 role="package">
233 <title>Introduction to D-Bus Python Bindings</title>
234
235 &lfs73_checked;
236
237 <bridgehead renderas="sect4">Package Information</bridgehead>
238 <itemizedlist spacing="compact">
239 <listitem>
240 <para>Download (HTTP): <ulink url="&dbus-python-download-http;"/></para>
241 </listitem>
242 <listitem>
243 <para>Download (FTP): <ulink url="&dbus-python-download-ftp;"/></para>
244 </listitem>
245 <listitem>
246 <para>Download MD5 sum: &dbus-python-md5sum;</para>
247 </listitem>
248 <listitem>
249 <para>Download size: &dbus-python-size;</para>
250 </listitem>
251 <listitem>
252 <para>Estimated disk space required: &dbus-python-buildsize;</para>
253 </listitem>
254 <listitem>
255 <para>Estimated build time: &dbus-python-time;</para>
256 </listitem>
257 </itemizedlist>
258
259 <bridgehead renderas="sect4">D-Bus Python Dependencies</bridgehead>
260
261 <bridgehead renderas="sect5">Required</bridgehead>
262 <para role="required">
263 <xref linkend="python2"/> and
264 <xref linkend="dbus-glib"/>
265 </para>
266
267 <bridgehead renderas="sect5">Optional</bridgehead>
268 <para role="optional">
269 <xref linkend="pygobject2"/> (required to run the test suite)
270 </para>
271
272 <bridgehead renderas="sect5">Optional
273 (Required to build the API and HTML Documentation)</bridgehead>
274 <para role="optional">
275 <ulink url="http://epydoc.sourceforge.net/">Epydoc</ulink> and
276 <ulink url="http://docutils.sourceforge.net/">Docutils</ulink>
277 </para>
278
279 <para condition="html" role="usernotes">User Notes:
280 <ulink url="&blfs-wiki;/dbus-python"/></para>
281
282 </sect3>
283
284 <sect3 role="installation">
285 <title>Installation of D-Bus Python Bindings</title>
286
287 <para>Install <application>D-Bus Python Bindings</application> by
288 running the following commands:</para>
289
290<screen><userinput>./configure --prefix=/usr \
291 --docdir=/usr/share/doc/dbus-python-&dbus-python-version; &amp;&amp;
292make</userinput></screen>
293
294 <para>To test the results, issue: <command>make check</command>. Note you
295 must have <application>PyGObject</application> installed.</para>
296
297 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
298
299<screen role="root"><userinput>make install</userinput></screen>
300
301 <para>If you built the API documentation, install it by issuing the
302 following commands as the <systemitem class="username">root</systemitem>
303 user:</para>
304
305<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/dbus-python-&dbus-python-version;/api &amp;&amp;
306install -v -m644 api/* \
307 /usr/share/doc/dbus-python-&dbus-python-version;/api</userinput></screen>
308
309 </sect3>
310
311 <sect3 role="content">
312 <title>Contents</title>
313
314 <segmentedlist>
315 <segtitle>Installed Programs</segtitle>
316 <segtitle>Installed Libraries</segtitle>
317 <segtitle>Installed Directories</segtitle>
318
319 <seglistitem>
320 <seg>none</seg>
321 <seg><application>Python</application>
322 <application>D-Bus</application> modules</seg>
323 <seg>/usr/lib/python&python2-majorver;/site-packages/dbus and
324 /usr/share/doc/dbus-python-&dbus-python-version;</seg>
325 </seglistitem>
326 </segmentedlist>
327
328 </sect3>
329
330 </sect2>
331
332</sect1>
Note: See TracBrowser for help on using the repository browser.