source: general/sysutils/bluez.xml@ 49b241a

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 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 49b241a was 43bb741, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Finish checking KDE.
Tags and text updates.

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