source: general/sysutils/bluez.xml@ 8aeb474

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 8aeb474 was b9b17d1b, checked in by Krejzi <krejzi@…>, 12 years ago

LFS 7.2 checked.

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

  • Property mode set to 100644
File size: 15.5 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 "c828c172f01f20c6ecd7f407894956a2">
10 <!ENTITY bluez-size "868 KB">
11 <!ENTITY bluez-buildsize "42 MB">
12 <!ENTITY bluez-time "0.8 SBU">
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 &lfs72_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">BlueZ Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="dbus"/> and
78 <xref linkend="glib2"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="alsa-lib"/>,
84 <xref linkend="check"/>,
85 <xref linkend="cups"/>,
86 <xref linkend="gst-plugins-base"/>,
87 <xref linkend="libsndfile"/> and
88 <xref linkend="libusb-compat"/>
89 </para>
90
91 <para condition="html" role="usernotes">
92 User Notes: <ulink url="&blfs-wiki;/bluez"/>
93 </para>
94 </sect2>
95
96
97 <sect2 role="kernel" id="bluez-kernel">
98 <title>Kernel Configuration</title>
99
100 <para>
101 Enable the following options in the kernel configuration and recompile the
102 kernel if necessary:
103 </para>
104
105<screen><literal>[*] Networking support --->
106 &lt;*&gt; or &lt;M&gt; Bluetooth subsystem support --->
107 &lt;*&gt; or &lt;M&gt; RFCOMM protocol support
108 [*] RFCOMM TTY support
109 &lt;*&gt; or &lt;M&gt; BNEP protocol support
110 [*] Multicast filter support
111 [*] Protocol filter support
112 &lt;*&gt; or &lt;M&gt; HIDP protocol support
113
114 Bluetooth device drivers ---></literal></screen>
115
116 <para>
117 Select the appropriate drivers for your Bluetooth hardware.
118 </para>
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 Install <application>BlueZ</application> by running the following
130 commands:
131 </para>
132
133<screen><userinput>./configure --prefix=/usr \
134 --sysconfdir=/etc \
135 --localstatedir=/var \
136 --libexecdir=/lib \
137 --enable-bccmd \
138 --enable-dfutool \
139 --enable-dund \
140 --enable-hid2hci \
141 --enable-hidd \
142 --enable-pand \
143 --enable-tools \
144 --enable-wiimote \
145 --disable-test \
146 --without-systemdunitdir &amp;&amp;
147make</userinput></screen>
148
149 <para>
150 This package does not come with a test suite.
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</userinput></screen>
158
159 <para>
160 Install required configuration files as the
161 <systemitem class="username">root</systemitem> user:
162 </para>
163
164<screen role="root"><userinput>for CONFFILE in audio input network serial ; do
165 install -v -m644 ${CONFFILE}/${CONFFILE}.conf /etc/bluetooth/${CONFFILE}.conf
166done</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 -m755 -d /usr/share/doc/bluez-&bluez-version; &amp;&amp;
174install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
175 </sect2>
176
177
178 <sect2 role="commands">
179 <title>Command Explanations</title>
180
181 <para>
182 <option>--enable-bccmd</option>: This switch enables building of the BCCMD
183 interface utility.
184 </para>
185
186 <para>
187 <option>--enable-dfutool</option>: This switch enables building of the DFU
188 firmware upgrade utility.
189 </para>
190
191 <para>
192 <option>--enable-dund</option>: This switch enables building of the DUN daemon.
193 </para>
194
195 <para>
196 <option>--enable-hid2hci</option>: This switch enables building of the HID
197 mode switching utility.
198 </para>
199
200 <para>
201 <option>--enable-hidd</option>: This switch enables building of the HID daemon.
202 </para>
203
204 <para>
205 <option>--enable-pand</option>: This switch enables building of the PAN daemon.
206 </para>
207
208 <para>
209 <option>--enable-tools</option>: This switch enables building of the Bluetooth
210 utilities.
211 </para>
212
213 <para>
214 <option>--enable-wiimote</option>: This switch enables building of the Wii
215 Remote plugin.
216 </para>
217
218 <para>
219 <option>--disable-test</option>: This switch disables installation of the
220 test programs.
221 </para>
222
223 <para>
224 <option>--without-systemdunitdir</option>: This switch disables installation
225 of the systemd units.
226 </para>
227
228 <para>
229 <option>--enable-alsa</option>: This switch enables ALSA support. Use if you
230 have <xref linkend="alsa-lib"/> installed.
231 </para>
232
233 <para>
234 <option>--enable-cups</option>: This switch enables CUPS backend support. Use
235 if you have <xref linkend="cups"/> installed.
236 </para>
237
238 <para>
239 <option>--enable-gstreamer</option>: This switch enables GStreamer support. Use
240 if you have <xref linkend="gst-plugins-base"/> installed.
241 </para>
242
243 <para>
244 <option>--enable-usb</option>: This switch enables USB support. Use if you have
245 <xref linkend="libusb-compat"/> installed.
246 </para>
247
248 </sect2>
249
250 <sect2 role="configuration">
251 <title>Configuring BlueZ</title>
252
253 <sect3 id="bluez-config">
254 <title>Config Files</title>
255 <para>
256 <filename>/etc/bluetooth/audio.conf</filename>,
257 <filename>/etc/bluetooth/input.conf</filename>,
258 <filename>/etc/bluetooth/main.conf</filename>,
259 <filename>/etc/bluetooth/network.conf</filename>,
260 <filename>/etc/bluetooth/rfcomm.conf</filename> and
261 <filename>/etc/bluetooth/serial.conf</filename>
262 </para>
263
264 <indexterm zone="bluez bluez-config">
265 <primary
266 sortas="e-etc-bluetooth-audio.conf">/etc/bluetooth/audio.conf</primary>
267 </indexterm>
268
269 <indexterm zone="bluez bluez-config">
270 <primary
271 sortas="e-etc-bluetooth-input.conf">/etc/bluetooth/input.conf</primary>
272 </indexterm>
273
274 <indexterm zone="bluez bluez-config">
275 <primary
276 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
277 </indexterm>
278
279 <indexterm zone="bluez bluez-config">
280 <primary
281 sortas="e-etc-bluetooth-network.conf">/etc/bluetooth/network.conf</primary>
282 </indexterm>
283
284 <indexterm zone="bluez bluez-config">
285 <primary
286 sortas="e-etc-bluetooth-rfcomm.conf">/etc/bluetooth/rfcomm.conf</primary>
287 </indexterm>
288
289 <indexterm zone="bluez bluez-config">
290 <primary
291 sortas="e-etc-bluetooth-serial.conf">/etc/bluetooth/serial.conf</primary>
292 </indexterm>
293
294 </sect3>
295
296 <sect3 id="bluez-init">
297 <title>Boot Script</title>
298
299 <para>
300 To automatically start the <command>bluetoothd</command> daemon when the
301 system is rebooted, install the
302 <filename>/etc/rc.d/init.d/bluetooth</filename> bootscript from the
303 <xref linkend="bootscripts"/> package.
304 </para>
305
306 <indexterm zone="bluez bluez-init">
307 <primary sortas="f-bluetooth">bluetooth</primary>
308 </indexterm>
309
310<screen role="root"><userinput>make install-bluetooth</userinput></screen>
311 </sect3>
312 </sect2>
313
314 <sect2 role="content">
315 <title>Contents</title>
316
317 <segmentedlist>
318 <segtitle>Installed Programs</segtitle>
319 <segtitle>Installed Library</segtitle>
320 <segtitle>Installed Directories</segtitle>
321
322 <seglistitem>
323 <seg>
324 bccmd, bluetoothd, ciptool, dfutool, dund, gatttool,
325 hciattach, hciconfig, hcitool, hid2hci, hidd, l2ping,
326 pand, rfcomm and sdptool
327 </seg>
328 <seg>
329 libbluetooth.so
330 </seg>
331 <seg>
332 /etc/bluetooth,
333 /usr/include/bluetooth,
334 /usr/lib/bluetooth,
335 /usr/share/doc/bluez-&bluez-version; and
336 /var/lib/bluetooth
337 </seg>
338 </seglistitem>
339 </segmentedlist>
340
341 <variablelist>
342 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
343 <?dbfo list-presentation="list"?>
344 <?dbhtml list-presentation="table"?>
345
346 <varlistentry id="bccmd">
347 <term><command>bccmd</command></term>
348 <listitem>
349 <para>
350 is used to issue BlueCore commands to Cambridge Silicon
351 Radio devices.
352 </para>
353 <indexterm zone="bluez bccmd">
354 <primary sortas="b-bccmd">bccmd</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="bluetoothd">
360 <term><command>bluetoothd</command></term>
361 <listitem>
362 <para>
363 is the Bluetooth daemon.
364 </para>
365 <indexterm zone="bluez bluetoothd">
366 <primary sortas="b-bluetoothd">bluetoothd</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="ciptool">
372 <term><command>ciptool</command></term>
373 <listitem>
374 <para>
375 is used to set up, maintain, and inspect the CIP configuration
376 of the Bluetooth subsystem in the Linux kernel.
377 </para>
378 <indexterm zone="bluez ciptool">
379 <primary sortas="b-ciptool">ciptool</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="dfutool">
385 <term><command>dfutool</command></term>
386 <listitem>
387 <para>
388 is used to verify, archive and upgrade firmware files.
389 </para>
390 <indexterm zone="bluez dfutool">
391 <primary sortas="b-dfutool">dfutool</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="dund">
397 <term><command>dund</command></term>
398 <listitem>
399 <para>
400 is the Bluetooth dial-up networking daemon.
401 </para>
402 <indexterm zone="bluez dund">
403 <primary sortas="b-dund">dund</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="hciattach">
409 <term><command>hciattach</command></term>
410 <listitem>
411 <para>
412 is used to attach a serial UART to the Bluetooth stack
413 as HCI transport interface.
414 </para>
415 <indexterm zone="bluez hciattach">
416 <primary sortas="b-hciattach">hciattach</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="hciconfig">
422 <term><command>hciconfig</command></term>
423 <listitem>
424 <para>
425 is used to configure Bluetooth devices.
426 </para>
427 <indexterm zone="bluez hciconfig">
428 <primary sortas="b-hciconfig">hciconfig</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry id="hcitool">
434 <term><command>hcitool</command></term>
435 <listitem>
436 <para>
437 is used to configure Bluetooth connections and send some
438 special command to Bluetooth devices.
439 </para>
440 <indexterm zone="bluez hcitool">
441 <primary sortas="b-hcitool">hcitool</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="hid2hci">
447 <term><command>hid2hci</command></term>
448 <listitem>
449 <para>
450 is used to set up switch supported Bluetooth devices into
451 the HCI mode and back.
452 </para>
453 <indexterm zone="bluez hid2hci">
454 <primary sortas="b-hid2hci">hid2hci</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="hidd">
460 <term><command>hidd</command></term>
461 <listitem>
462 <para>
463 is the Bluetooth HID daemon.
464 </para>
465 <indexterm zone="bluez hidd">
466 <primary sortas="b-hidd">hidd</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry id="l2ping">
472 <term><command>l2ping</command></term>
473 <listitem>
474 <para>
475 is used to send a L2CAP echo request to the Bluetooth MAC
476 address given in dotted hex notation.
477 </para>
478 <indexterm zone="bluez l2ping">
479 <primary sortas="b-l2ping">l2ping</primary>
480 </indexterm>
481 </listitem>
482 </varlistentry>
483
484 <varlistentry id="pand">
485 <term><command>pand</command></term>
486 <listitem>
487 <para>
488 is the Bluetooth daemon that allows you to connect to
489 ethernet networks using Bluetooth.
490 </para>
491 <indexterm zone="bluez pand">
492 <primary sortas="b-pand">pand</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 <varlistentry id="rfcomm">
498 <term><command>rfcomm</command></term>
499 <listitem>
500 <para>
501 is used to set up, maintain, and inspect the RFCOMM
502 configuration of the Bluetooth subsystem in the
503 Linux kernel.
504 </para>
505 <indexterm zone="bluez rfcomm">
506 <primary sortas="b-rfcomm">rfcomm</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 <varlistentry id="sdptool">
512 <term><command>sdptool</command></term>
513 <listitem>
514 <para>
515 is used to perform SDP queries on Bluetooth devices.
516 </para>
517 <indexterm zone="bluez sdptool">
518 <primary sortas="b-sdptool">sdptool</primary>
519 </indexterm>
520 </listitem>
521 </varlistentry>
522
523 <varlistentry id="libbluetooth">
524 <term><filename class="libraryfile">libbluetooth.so</filename></term>
525 <listitem>
526 <para>
527 contains the <application>BlueZ</application> API functions.
528 </para>
529 <indexterm zone="bluez libbluetooth">
530 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
531 </indexterm>
532 </listitem>
533 </varlistentry>
534 </variablelist>
535
536 </sect2>
537
538</sect1>
Note: See TracBrowser for help on using the repository browser.