source: general/sysutils/bluez.xml@ 3131ae7

lazarus trunk
Last change on this file since 3131ae7 was 3131ae7, checked in by Rahul Chandra <rahul@…>, 2 months ago

Update to bluez-5.73

  • Property mode set to 100644
File size: 14.3 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 bluez-download-http "&kernel-dl;/linux/bluetooth/bluez-&bluez-version;.tar.xz">
8 <!ENTITY bluez-download-ftp " ">
9 <!ENTITY bluez-md5sum "7812034c8b91bf11e4f1379734756a3b">
10 <!ENTITY bluez-size "2.3 MB">
11 <!ENTITY bluez-buildsize "83 MB (add 84 MB for tests)">
12 <!ENTITY bluez-time "0.4 SBU (using parallelism=4; with tests)">
13]>
14
15<sect1 id="bluez" xreflabel="BlueZ-&bluez-version;">
16 <?dbhtml filename="bluez.html"?>
17
18
19 <title>BlueZ-&bluez-version;</title>
20
21 <indexterm zone="bluez">
22 <primary sortas="a-BlueZ">BlueZ</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to BlueZ</title>
27
28 <para>
29 The <application>BlueZ</application> package contains the
30 Bluetooth protocol stack for Linux.
31 </para>
32
33 &lfs121_checked;
34
35 <bridgehead renderas="sect3">Package Information</bridgehead>
36 <itemizedlist spacing="compact">
37 <listitem>
38 <para>
39 Download (HTTP): <ulink url="&bluez-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&bluez-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &bluez-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &bluez-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &bluez-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &bluez-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68
69 <bridgehead renderas="sect3" revision="sysv">Additional Downloads</bridgehead>
70 <itemizedlist spacing="compact" revision="sysv">
71 <listitem>
72 <para>
73 Required patch:
74 <ulink url="&patch-root;/bluez-&bluez-version;-obexd_without_systemd-1.patch"/>
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">BlueZ Dependencies</bridgehead>
80
81 <bridgehead renderas="sect4">Required</bridgehead>
82 <para role="required">
83 <xref linkend="dbus"/>,
84 <xref linkend="glib2"/>, and
85 <xref linkend="libical"/>
86 </para>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
90 <xref linkend="docutils"/> (to generate man pages)
91 </para>
92
93 </sect2>
94
95
96 <sect2 role="kernel" id="bluez-kernel">
97 <title>Kernel Configuration</title>
98
99 <para>
100 If you are building this package to use bluetooth devices (rather than as a
101 build dependency), enable the following options in the kernel configuration,
102 also the options in the <quote>Cryptographic API</quote> section if
103 you intend to run the tests, and recompile the kernel if necessary:
104 </para>
105
106 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
107 href="bluez-kernel.xml"/>
108
109 <indexterm zone="bluez bluez-kernel">
110 <primary sortas="d-bluez">bluez</primary>
111 </indexterm>
112 </sect2>
113
114 <sect2 role="installation">
115 <title>Installation of BlueZ</title>
116
117<!--
118 <para>
119 At first, fix an issue building the package with Glibc-2.34 or later:
120 </para>
121
122<screen><userinput>sed 's/pause(/bluez_&amp;/' -i profiles/audio/media.c</userinput></screen>
123-->
124
125 <para revision="sysv">Now, make some changes needed for SystemV systems:</para>
126
127<screen revision="sysv"><userinput>patch -Np1 -i ../bluez-&bluez-version;-obexd_without_systemd-1.patch</userinput></screen>
128
129 <para>
130 Install <application>BlueZ</application> by running the following
131 commands:
132 </para>
133
134<screen revision="sysv"><userinput>./configure --prefix=/usr \
135 --sysconfdir=/etc \
136 --localstatedir=/var \
137 --enable-library \
138 --disable-manpages \
139 --disable-systemd &amp;&amp;
140make</userinput></screen>
141
142<screen revision="systemd"><userinput>./configure --prefix=/usr \
143 --sysconfdir=/etc \
144 --localstatedir=/var \
145 --disable-manpages \
146 --enable-library &amp;&amp;
147make</userinput></screen>
148
149 <para>
150 To test the results, issue: <userinput>make check</userinput>.
151 </para>
152
153 <para>
154 Now, as the <systemitem class="username">root</systemitem> user:
155 </para>
156
157<screen role="root"><userinput>make install &amp;&amp;
158ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin</userinput></screen>
159
160 <para>
161 Install the main configuration file as the
162 <systemitem class="username">root</systemitem> user:
163 </para>
164
165<screen role="root"><userinput>install -v -dm755 /etc/bluetooth &amp;&amp;
166install -v -m644 src/main.conf /etc/bluetooth/main.conf</userinput></screen>
167
168 <para>
169 If desired, install the API documentation as the
170 <systemitem class="username">root</systemitem> user:
171 </para>
172
173<screen role="root"><userinput>install -v -dm755 /usr/share/doc/bluez-&bluez-version; &amp;&amp;
174install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
175
176 </sect2>
177
178
179 <sect2 role="commands">
180 <title>Command Explanations</title>
181
182 <para>
183 <parameter>--disable-manpages</parameter>: This switch disables generating
184 the manual pages because of the reliance on 'rst2man' in docutils. Remove
185 this switch if you have <xref role="nodep" linkend="docutils"/> installed
186 and wish to generate the manual pages.
187 </para>
188
189 <para>
190 <parameter>--enable-library</parameter>: This switch enables building the
191 <application>BlueZ</application> 4 compatibility library which is required by
192 some applications.
193 </para>
194
195 <para revision="sysv">
196 <parameter>--disable-systemd</parameter>: This switch is needed because
197 <application>systemd</application> is not part of LFS/BLFS. If you are
198 using systemd, remove this switch.
199 </para>
200
201 <para>
202 <command>ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin</command>:
203 This command makes access to the bluetooth daemon more convenient.
204 </para>
205
206 </sect2>
207
208 <sect2 role="configuration">
209 <title>Configuring BlueZ</title>
210
211 <sect3 id="bluez-config">
212 <title>Configuration Files</title>
213 <para revision="sysv">
214 <filename>/etc/bluetooth/main.conf</filename> is installed automatically
215 during the install. Additionally, there are three supplementary
216 configuration files. /etc/sysconfig/bluetooth is installed as a part
217 of the boot script below. In addition, you optionally can install the
218 following, as the <systemitem class="username">root</systemitem> user:
219 </para>
220
221 <para revision="systemd">
222 <filename>/etc/bluetooth/main.conf</filename> is installed automatically
223 during the installation. Additionally, there are two supplementary
224 configuration files. You can optionally install the following files
225 as the <systemitem class="username">root</systemitem> user:
226 </para>
227
228<screen role="root"><userinput>cat > /etc/bluetooth/rfcomm.conf &lt;&lt; "EOF"</userinput>
229<literal># Start rfcomm.conf
230# Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
231# Use one line per command
232# See the rfcomm man page for options
233
234
235# End of rfcomm.conf</literal>
236EOF</screen>
237
238<screen role="root"><userinput>cat > /etc/bluetooth/uart.conf &lt;&lt; "EOF"</userinput>
239<literal># Start uart.conf
240# Attach serial devices via UART HCI to BlueZ stack
241# Use one line per device
242# See the hciattach man page for options
243
244# End of uart.conf</literal>
245EOF</screen>
246
247 <indexterm zone="bluez bluez-config">
248 <primary
249 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
250 </indexterm>
251
252 </sect3>
253
254 <sect3 id="bluez-init">
255 <title><phrase revision="sysv">Boot Script</phrase>
256 <phrase revision="systemd">Systemd Bluez Services</phrase></title>
257
258 <para revision="sysv">
259 To automatically start the <command>bluetoothd</command> daemon when the
260 system is rebooted, install the
261 <filename>/etc/rc.d/init.d/bluetooth</filename> bootscript from the
262 <xref linkend="bootscripts"/> package.
263 </para>
264
265 <para revision="systemd">
266 To start the <command>bluetoothd</command> daemon at boot,
267 enable the previously installed systemd unit by
268 running the following command as the
269 <systemitem class="username">root</systemitem> user:
270 </para>
271
272<screen role="root" revision="systemd"><userinput>systemctl enable bluetooth</userinput></screen>
273
274 <para revision="systemd">
275 To start the <command>obexd</command> daemon for a user session (to
276 support some Bluetooth programs using it), enable the previously
277 installed systemd unit for all users by running the following command
278 as the <systemitem class="username">root</systemitem> user:
279 </para>
280
281<screen role="root" revision="systemd"><userinput>systemctl enable --global obex</userinput></screen>
282
283 <indexterm zone="bluez bluez-init">
284 <primary sortas="f-bluetooth">bluetooth</primary>
285 </indexterm>
286
287<screen role="root" revision="sysv"><userinput>make install-bluetooth</userinput></screen>
288
289
290 <note revision="systemd">
291 <para>
292 <application>Systemd</application> will start the Bluetooth daemon
293 only when a bluetooth device is detected on the system.
294 </para>
295 </note>
296
297 </sect3>
298
299 </sect2>
300
301 <sect2 role="content">
302 <title>Contents</title>
303
304 <segmentedlist>
305 <segtitle>Installed Programs</segtitle>
306 <segtitle>Installed Library</segtitle>
307 <segtitle>Installed Directories</segtitle>
308
309 <seglistitem>
310 <seg>
311 <!--bccmd, -->
312 bluemoon,
313 bluetoothctl,
314 bluetoothd (symlink),
315 btattach,
316 btmon,
317 hex2hcd,
318 l2ping,
319 l2test,
320 mpris-proxy, and
321 rctest
322 </seg>
323 <seg>
324 libbluetooth.so
325 </seg>
326 <seg>
327 /etc/bluetooth,
328 /usr/{include,libexec}/bluetooth, and
329 /usr/share/doc/bluez-&bluez-version;
330 </seg>
331 </seglistitem>
332 </segmentedlist>
333
334 <variablelist>
335 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
336 <?dbfo list-presentation="list"?>
337 <?dbhtml list-presentation="table"?>
338
339 <!--
340 <varlistentry id="bccmd">
341 <term><command>bccmd</command></term>
342 <listitem>
343 <para>
344 is used to issue BlueCore commands to Cambridge Silicon
345 Radio devices
346 </para>
347 <indexterm zone="bluez bccmd">
348 <primary sortas="b-bccmd">bccmd</primary>
349 </indexterm>
350 </listitem>
351 </varlistentry>
352 -->
353
354 <varlistentry id="bluemoon">
355 <term><command>bluemoon</command></term>
356 <listitem>
357 <para>
358 is a Bluemoon configuration utility
359 </para>
360 <indexterm zone="bluez bluemoon">
361 <primary sortas="b-bluemoon">bluemoon</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="bluetoothctl">
367 <term><command>bluetoothctl</command></term>
368 <listitem>
369 <para>
370 is the interactive Bluetooth control program
371 </para>
372 <indexterm zone="bluez bluetoothctl">
373 <primary sortas="b-bluetoothctl">bluetoothctl</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="bluetoothd">
379 <term><command>bluetoothd</command></term>
380 <listitem>
381 <para>
382 is the Bluetooth daemon
383 </para>
384 <indexterm zone="bluez bluetoothd">
385 <primary sortas="b-bluetoothd">bluetoothd</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="btmon">
391 <term><command>btmon</command></term>
392 <listitem>
393 <para>
394 provides access to the Bluetooth subsystem monitor
395 infrastructure for reading HCI traces
396 </para>
397 <indexterm zone="bluez btmon">
398 <primary sortas="b-btmon">btmon</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403
404 <varlistentry id="hex2hcd">
405 <term><command>hex2hcd</command></term>
406 <listitem>
407 <para>
408 is used to convert a file needed by Broadcom devices
409 to hcd (Broadcom bluetooth firmware) format
410 </para>
411 <indexterm zone="bluez hex2hcd">
412 <primary sortas="b-hex2hcd">hex2hcd</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="l2ping">
418 <term><command>l2ping</command></term>
419 <listitem>
420 <para>
421 is used to send a L2CAP echo request to the Bluetooth MAC
422 address given in dotted hex notation
423 </para>
424 <indexterm zone="bluez l2ping">
425 <primary sortas="b-l2ping">l2ping</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="l2test">
431 <term><command>l2test</command></term>
432 <listitem>
433 <para>
434 is a L2CAP testing program
435 </para>
436 <indexterm zone="bluez l2test">
437 <primary sortas="b-l2test">l2test</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="rctest">
443 <term><command>rctest</command></term>
444 <listitem>
445 <para>
446 is used to test RFCOMM communications on the
447 Bluetooth stack
448 </para>
449 <indexterm zone="bluez rctest">
450 <primary sortas="b-rctest">rctest</primary>
451 </indexterm>
452 </listitem>
453 </varlistentry>
454
455 <varlistentry id="libbluetooth">
456 <term><filename class="libraryfile">libbluetooth.so</filename></term>
457 <listitem>
458 <para>
459 contains the <application>BlueZ</application> 4 API functions
460 </para>
461 <indexterm zone="bluez libbluetooth">
462 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
463 </indexterm>
464 </listitem>
465 </varlistentry>
466 </variablelist>
467
468 </sect2>
469
470</sect1>
Note: See TracBrowser for help on using the repository browser.