source: general/sysutils/bluez.xml@ 03da570f

10.0 10.1 11.0 11.1 7.10 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus nosym perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 03da570f was 03da570f, checked in by Bruce Dubbs <bdubbs@…>, 7 years ago

Update to openssl-1.0.2d.
Update to bluez-5.32.
Update to poppler-0.34.0.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@16226 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 16.3 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 bluez-download-http "http://www.kernel.org/pub/linux/bluetooth/bluez-&bluez-version;.tar.xz">
8 <!ENTITY bluez-download-ftp "ftp://ftp.kernel.org/pub/linux/bluetooth/bluez-&bluez-version;.tar.xz">
9 <!ENTITY bluez-md5sum "i432b1f292c0b78771818c67140baf3d9">
10 <!ENTITY bluez-size "1.6 MB">
11 <!ENTITY bluez-buildsize "62 MB (additional 8 MB for the tests)">
12 <!ENTITY bluez-time "0.6 SBU (additional 0.6 SBU for the tests)">
13]>
14
15<sect1 id="bluez" xreflabel="BlueZ-&bluez-version;">
16 <?dbhtml filename="bluez.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>BlueZ-&bluez-version;</title>
24
25 <indexterm zone="bluez">
26 <primary sortas="a-BlueZ">BlueZ</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to BlueZ</title>
31
32 <para>
33 The <application>BlueZ</application> package contains the
34 Bluetooth protocol stack for Linux.
35 </para>
36
37 &lfs77_checked; &gcc5_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&bluez-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&bluez-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &bluez-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &bluez-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &bluez-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &bluez-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
74 <itemizedlist spacing="compact">
75 <listitem>
76 <para>
77 Optional patch (required to work properly with gnome-bluetooth
78 and/or kde bluedevil):
79 <ulink url="&patch-root;/bluez-&bluez-version;-obexd_without_systemd-1.patch"/>
80 </para>
81 </listitem>
82 </itemizedlist>
83
84 <bridgehead renderas="sect3">BlueZ Dependencies</bridgehead>
85
86 <bridgehead renderas="sect4">Required</bridgehead>
87 <para role="required">
88 <xref linkend="dbus"/>,
89 <xref linkend="glib2"/>, and
90 <xref linkend="libical"/>
91 </para>
92
93 <para condition="html" role="usernotes">
94 User Notes: <ulink url="&blfs-wiki;/bluez"/>
95 </para>
96 </sect2>
97
98
99 <sect2 role="kernel" id="bluez-kernel">
100 <title>Kernel Configuration</title>
101
102 <para>
103 Enable the following options in the kernel configuration and recompile the
104 kernel if necessary:
105 </para>
106
107<screen><literal>[*] Networking support ---&gt; [CONFIG_NET]
108 &lt;/M&gt; Bluetooth subsystem support ---&gt; [CONFIG_BT]
109 &lt;*/M&gt; RFCOMM protocol support [CONFIG_BT_RFCOMM]
110 [*] RFCOMM TTY support [CONFIG_BT_RFCOMM_TTY]
111 &lt;*/M&gt; BNEP protocol support [CONFIG_BT_BNEP]
112 [*] Multicast filter support [CONFIG_BT_BNEP_MC_FILTER]
113 [*] Protocol filter support [CONFIG_BT_BNEP_PROTO_FILTER]
114 &lt;*/M&gt; HIDP protocol support [CONFIG_BT_HIDP]
115 Bluetooth device drivers ---&gt;
116 (Select the appropriate drivers for your Bluetooth hardware)
117
118 &lt;*/M&gt; RF switch subsystem support ---&gt; [CONFIG_RFKILL]</literal></screen>
119
120 <indexterm zone="bluez bluez-kernel">
121 <primary sortas="d-bluez">bluez</primary>
122 </indexterm>
123 </sect2>
124
125 <sect2 role="installation">
126 <title>Installation of BlueZ</title>
127
128 <para>
129 If you are going to use <application>BlueZ</application> with
130 gnome-bluetooth and/or kde bluedevil, apply the following patch:
131 </para>
132
133<screen><userinput>patch -Np1 -i ../bluez-&bluez-version;-obexd_without_systemd-1.patch</userinput></screen>
134
135 <para>
136 Install <application>BlueZ</application> by running the following
137 commands:
138 </para>
139
140<screen><userinput>./configure --prefix=/usr \
141 --sysconfdir=/etc \
142 --localstatedir=/var \
143 --enable-library \
144 --disable-systemd &amp;&amp;
145make</userinput></screen>
146
147 <para>
148 To test the results, issue: <userinput>make check</userinput>.
149 </para>
150
151 <para>
152 Now, as the <systemitem class="username">root</systemitem> user:
153 </para>
154
155<screen role="root"><userinput>make install &amp;&amp;
156ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin</userinput></screen>
157
158 <para>
159 Install the main configuration file as the
160 <systemitem class="username">root</systemitem> user:
161 </para>
162
163<screen role="root"><userinput>install -v -dm755 /etc/bluetooth &amp;&amp;
164install -v -m644 src/main.conf /etc/bluetooth/main.conf</userinput></screen>
165
166 <para>
167 If desired, install the API documentation as the
168 <systemitem class="username">root</systemitem> user:
169 </para>
170
171<screen role="root"><userinput>install -v -dm755 /usr/share/doc/bluez-&bluez-version; &amp;&amp;
172install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
173
174 </sect2>
175
176
177 <sect2 role="commands">
178 <title>Command Explanations</title>
179
180 <para>
181 <parameter>--enable-library</parameter>: This switch enables building of the
182 <application>BlueZ</application> 4 compatibility library which is required by
183 some applications.
184 </para>
185
186 <para>
187 <parameter>--disable-systemd</parameter>: This switch is needed because
188 <application>systemd</application> is not part of LFS/BLFS. If you are
189 using systemd, remove this switch.
190 </para>
191
192 <para>
193 <command>ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin</command>:
194 This command makes access to the bluetooth daemon more convenient.
195 </para>
196
197 </sect2>
198
199 <sect2 role="configuration">
200 <title>Configuring BlueZ</title>
201
202 <sect3 id="bluez-config">
203 <title>Configuration Files</title>
204 <para>
205 <filename>/etc/bluetooth/main.conf</filename> is installed automatically
206 during the install. Additionally, there are three supplementary
207 configuration files. /etc/sysconfig/bluetooth is installed as a part
208 of the boot script below. In addition, you optionally can install the
209 following, as the <systemitem class="username">root</systemitem> user:
210 </para>
211
212<screen role="root"><userinput>cat > /etc/bluetooth/rfcomm.conf &lt;&lt; "EOF"</userinput>
213<literal># rfcomm.conf
214# Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
215# Use one line per command
216# See the rfcomm man page for options
217
218
219# End of rfcomm.conf</literal>
220EOF</screen>
221
222<screen role="root"><userinput>cat > /etc/bluetooth/uart.conf &lt;&lt; "EOF"</userinput>
223<literal>#uart.conf
224# Attach serial devices via UART HCI to BlueZ stack
225# Use one line per device
226# See the hciattach man page for options
227
228# End of uart.conf</literal>
229EOF</screen>
230
231 <indexterm zone="bluez bluez-config">
232 <primary
233 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
234 </indexterm>
235
236 </sect3>
237
238 <sect3 id="bluez-init">
239 <title>Boot Script</title>
240
241 <para>
242 To automatically start the <command>bluetoothd</command> daemon when the
243 system is rebooted, install the
244 <filename>/etc/rc.d/init.d/bluetooth</filename> bootscript from the
245 <xref linkend="bootscripts"/> package.
246 </para>
247
248 <indexterm zone="bluez bluez-init">
249 <primary sortas="f-bluetooth">bluetooth</primary>
250 </indexterm>
251
252<screen role="root"><userinput>make install-bluetooth</userinput></screen>
253
254 </sect3>
255
256 </sect2>
257
258 <sect2 role="content">
259 <title>Contents</title>
260
261 <segmentedlist>
262 <segtitle>Installed Programs</segtitle>
263 <segtitle>Installed Library</segtitle>
264 <segtitle>Installed Directories</segtitle>
265
266 <seglistitem>
267 <seg>
268 bccmd, bluemoon, bluetoothctl, bluetoothd, btmon, ciptool,
269 hciattach, hciconfig, hcidump, hcitool, hex2hcd, hid2hci, l2ping,
270 l2test, mpris-proxy, obexd, rctest, rfcomm, and sdptool
271 </seg>
272 <seg>
273 libbluetooth.so
274 </seg>
275 <seg>
276 /etc/bluetooth,
277 /usr/include/bluetooth,
278 /usr/libexec/bluetooth, and
279 /usr/share/doc/bluez-&bluez-version;
280 </seg>
281 </seglistitem>
282 </segmentedlist>
283
284 <variablelist>
285 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
286 <?dbfo list-presentation="list"?>
287 <?dbhtml list-presentation="table"?>
288
289 <varlistentry id="bccmd">
290 <term><command>bccmd</command></term>
291 <listitem>
292 <para>
293 is used to issue BlueCore commands to Cambridge Silicon
294 Radio devices.
295 </para>
296 <indexterm zone="bluez bccmd">
297 <primary sortas="b-bccmd">bccmd</primary>
298 </indexterm>
299 </listitem>
300 </varlistentry>
301
302 <varlistentry id="bluemoon">
303 <term><command>bluemoon</command></term>
304 <listitem>
305 <para>
306 is a Bluemoon configuration utility.
307 </para>
308 <indexterm zone="bluez bluemoon">
309 <primary sortas="b-bluemoon">bluemoon</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="bluetoothctl">
315 <term><command>bluetoothctl</command></term>
316 <listitem>
317 <para>
318 is the interactive Bluetooth control program.
319 </para>
320 <indexterm zone="bluez bluetoothctl">
321 <primary sortas="b-bluetoothctl">bluetoothctl</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="bluetoothd">
327 <term><command>bluetoothd</command></term>
328 <listitem>
329 <para>
330 is the Bluetooth daemon.
331 </para>
332 <indexterm zone="bluez bluetoothd">
333 <primary sortas="b-bluetoothd">bluetoothd</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="btmon">
339 <term><command>btmon</command></term>
340 <listitem>
341 <para>
342 provides access to the Bluetooth subsystem monitor
343 infrastructure for reading HCI traces.
344 </para>
345 <indexterm zone="bluez btmon">
346 <primary sortas="b-btmon">btmon</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="ciptool">
352 <term><command>ciptool</command></term>
353 <listitem>
354 <para>
355 is used to set up, maintain, and inspect the CIP configuration
356 of the Bluetooth subsystem in the Linux kernel.
357 </para>
358 <indexterm zone="bluez ciptool">
359 <primary sortas="b-ciptool">ciptool</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="hciattach">
365 <term><command>hciattach</command></term>
366 <listitem>
367 <para>
368 is used to attach a serial UART to the Bluetooth stack
369 as HCI transport interface.
370 </para>
371 <indexterm zone="bluez hciattach">
372 <primary sortas="b-hciattach">hciattach</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="hciconfig">
378 <term><command>hciconfig</command></term>
379 <listitem>
380 <para>
381 is used to configure Bluetooth devices.
382 </para>
383 <indexterm zone="bluez hciconfig">
384 <primary sortas="b-hciconfig">hciconfig</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="hcidump">
390 <term><command>hcidump</command></term>
391 <listitem>
392 <para>
393 reads raw HCI data coming from and going to a Bluetooth
394 device and prints to screen commands, events and data
395 in a human-readable form.
396 </para>
397 <indexterm zone="bluez hcidump">
398 <primary sortas="b-hcidump">hcidump</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403
404 <varlistentry id="hcitool">
405 <term><command>hcitool</command></term>
406 <listitem>
407 <para>
408 is used to configure Bluetooth connections and send some
409 special command to Bluetooth devices.
410 </para>
411 <indexterm zone="bluez hcitool">
412 <primary sortas="b-hcitool">hcitool</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="hex2hcd">
418 <term><command>hex2hcd</command></term>
419 <listitem>
420 <para>
421 is used to convert a file needed by Broadcom devices
422 to hcd (Broadcom bluetooth firmware) format.
423 </para>
424 <indexterm zone="bluez hex2hcd">
425 <primary sortas="b-hex2hcd">hex2hcd</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="hid2hci">
431 <term><command>hid2hci</command></term>
432 <listitem>
433 <para>
434 is used to set up switch supported Bluetooth devices into
435 the HCI mode and back.
436 </para>
437 <indexterm zone="bluez hid2hci">
438 <primary sortas="b-hid2hci">hid2hci</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="l2ping">
444 <term><command>l2ping</command></term>
445 <listitem>
446 <para>
447 is used to send a L2CAP echo request to the Bluetooth MAC
448 address given in dotted hex notation.
449 </para>
450 <indexterm zone="bluez l2ping">
451 <primary sortas="b-l2ping">l2ping</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="l2test">
457 <term><command>l2test</command></term>
458 <listitem>
459 <para>
460 is L2CAP testing program.
461 </para>
462 <indexterm zone="bluez l2test">
463 <primary sortas="b-l2test">l2test</primary>
464 </indexterm>
465 </listitem>
466 </varlistentry>
467
468 <varlistentry id="obexd">
469 <term><command>obexd</command></term>
470 <listitem>
471 <para>
472 is the OBEX daemon.
473 </para>
474 <indexterm zone="bluez obexd">
475 <primary sortas="b-obexd">obexd</primary>
476 </indexterm>
477 </listitem>
478 </varlistentry>
479
480 <varlistentry id="rctest">
481 <term><command>rctest</command></term>
482 <listitem>
483 <para>
484 is used to test RFCOMM communications on the
485 Bluetooth stack.
486 </para>
487 <indexterm zone="bluez rctest">
488 <primary sortas="b-rctest">rctest</primary>
489 </indexterm>
490 </listitem>
491 </varlistentry>
492
493 <varlistentry id="rfcomm">
494 <term><command>rfcomm</command></term>
495 <listitem>
496 <para>
497 is used to set up, maintain, and inspect the RFCOMM
498 configuration of the Bluetooth subsystem in the
499 Linux kernel.
500 </para>
501 <indexterm zone="bluez rfcomm">
502 <primary sortas="b-rfcomm">rfcomm</primary>
503 </indexterm>
504 </listitem>
505 </varlistentry>
506
507 <varlistentry id="sdptool">
508 <term><command>sdptool</command></term>
509 <listitem>
510 <para>
511 is used to perform SDP queries on Bluetooth devices.
512 </para>
513 <indexterm zone="bluez sdptool">
514 <primary sortas="b-sdptool">sdptool</primary>
515 </indexterm>
516 </listitem>
517 </varlistentry>
518
519 <varlistentry id="libbluetooth">
520 <term><filename class="libraryfile">libbluetooth.so</filename></term>
521 <listitem>
522 <para>
523 contains the <application>BlueZ</application> 4 API functions.
524 </para>
525 <indexterm zone="bluez libbluetooth">
526 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
527 </indexterm>
528 </listitem>
529 </varlistentry>
530 </variablelist>
531
532 </sect2>
533
534</sect1>
Note: See TracBrowser for help on using the repository browser.