source: general/sysutils/bluez.xml@ 5a464e4

10.0 10.1 11.0 11.1 11.2 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 krejzi/svn lazarus nosym perl-modules plabs/python-mods qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 5a464e4 was 5a464e4, checked in by Randy McMurchy <randy@…>, 10 years ago

Minor changes to various packages

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

  • Property mode set to 100644
File size: 15.8 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
167unset CONFFILE</userinput></screen>
168
169 <para>
170 If desired, install the API documentation as the
171 <systemitem class="username">root</systemitem> user:
172 </para>
173
174<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/bluez-&bluez-version; &amp;&amp;
175install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
176 </sect2>
177
178
179 <sect2 role="commands">
180 <title>Command Explanations</title>
181
182 <para>
183 <parameter>--enable-bccmd</parameter>: This switch enables building of the BCCMD
184 interface utility.
185 </para>
186
187 <para>
188 <parameter>--enable-dfutool</parameter>: This switch enables building of the DFU
189 firmware upgrade utility.
190 </para>
191
192 <para>
193 <parameter>--enable-dund</parameter>: This switch enables building of the DUN daemon.
194 </para>
195
196 <para>
197 <parameter>--enable-hid2hci</parameter>: This switch enables building of the HID
198 mode switching utility.
199 </para>
200
201 <para>
202 <parameter>--enable-hidd</parameter>: This switch enables building of the HID daemon.
203 </para>
204
205 <para>
206 <parameter>--enable-pand</parameter>: This switch enables building of the PAN daemon.
207 </para>
208
209 <para>
210 <parameter>--enable-tools</parameter>: This switch enables building of the Bluetooth
211 utilities.
212 </para>
213
214 <para>
215 <parameter>--enable-wiimote</parameter>: This switch enables building of the Wii
216 Remote plugin.
217 </para>
218
219 <para>
220 <parameter>--disable-test</parameter>: This switch disables installation of the
221 test programs.
222 </para>
223
224 <para>
225 <parameter>--without-systemdunitdir</parameter>: This switch disables installation
226 of the systemd units.
227 </para>
228
229 <para>
230 <option>--enable-cups</option>: This switch enables CUPS backend support. Note
231 that CUPS does not need to be installed for this support.
232 </para>
233
234 <!-- These options are automatically found and used if the packages are
235 available. There is no need to use these switches.
236 <para>
237 <option>-enable-alsa</option>: This switch enables ALSA support. Use if you
238 have <xref linkend="alsa-lib"/> installed.
239 </para>
240
241 <para>
242 <option>-enable-gstreamer</option>: This switch enables GStreamer support. Use
243 if you have <xref linkend="gst-plugins-base"/> installed.
244 </para>
245
246 <para>
247 <option>-enable-usb</option>: This switch enables USB support. Use if you have
248 <xref linkend="libusb-compat"/> installed.
249 </para> -->
250
251 </sect2>
252
253 <sect2 role="configuration">
254 <title>Configuring BlueZ</title>
255
256 <sect3 id="bluez-config">
257 <title>Config Files</title>
258 <para>
259 <filename>/etc/bluetooth/audio.conf</filename>,
260 <filename>/etc/bluetooth/input.conf</filename>,
261 <filename>/etc/bluetooth/main.conf</filename>,
262 <filename>/etc/bluetooth/network.conf</filename>,
263 <filename>/etc/bluetooth/rfcomm.conf</filename> and
264 <filename>/etc/bluetooth/serial.conf</filename>
265 </para>
266
267 <indexterm zone="bluez bluez-config">
268 <primary
269 sortas="e-etc-bluetooth-audio.conf">/etc/bluetooth/audio.conf</primary>
270 </indexterm>
271
272 <indexterm zone="bluez bluez-config">
273 <primary
274 sortas="e-etc-bluetooth-input.conf">/etc/bluetooth/input.conf</primary>
275 </indexterm>
276
277 <indexterm zone="bluez bluez-config">
278 <primary
279 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
280 </indexterm>
281
282 <indexterm zone="bluez bluez-config">
283 <primary
284 sortas="e-etc-bluetooth-network.conf">/etc/bluetooth/network.conf</primary>
285 </indexterm>
286
287 <indexterm zone="bluez bluez-config">
288 <primary
289 sortas="e-etc-bluetooth-rfcomm.conf">/etc/bluetooth/rfcomm.conf</primary>
290 </indexterm>
291
292 <indexterm zone="bluez bluez-config">
293 <primary
294 sortas="e-etc-bluetooth-serial.conf">/etc/bluetooth/serial.conf</primary>
295 </indexterm>
296
297 </sect3>
298
299 <sect3 id="bluez-init">
300 <title>Boot Script</title>
301
302 <para>
303 To automatically start the <command>bluetoothd</command> daemon when the
304 system is rebooted, install the
305 <filename>/etc/rc.d/init.d/bluetooth</filename> bootscript from the
306 <xref linkend="bootscripts"/> package.
307 </para>
308
309 <indexterm zone="bluez bluez-init">
310 <primary sortas="f-bluetooth">bluetooth</primary>
311 </indexterm>
312
313<screen role="root"><userinput>make install-bluetooth</userinput></screen>
314 </sect3>
315 </sect2>
316
317 <sect2 role="content">
318 <title>Contents</title>
319
320 <segmentedlist>
321 <segtitle>Installed Programs</segtitle>
322 <segtitle>Installed Library</segtitle>
323 <segtitle>Installed Directories</segtitle>
324
325 <seglistitem>
326 <seg>
327 bccmd, bluetoothd, ciptool, dfutool, dund, gatttool,
328 hciattach, hciconfig, hcitool, hid2hci, hidd, l2ping,
329 pand, rfcomm and sdptool
330 </seg>
331 <seg>
332 libbluetooth.so
333 </seg>
334 <seg>
335 /etc/bluetooth,
336 /usr/include/bluetooth,
337 /usr/lib/bluetooth,
338 /usr/share/doc/bluez-&bluez-version; and
339 /var/lib/bluetooth
340 </seg>
341 </seglistitem>
342 </segmentedlist>
343
344 <variablelist>
345 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
346 <?dbfo list-presentation="list"?>
347 <?dbhtml list-presentation="table"?>
348
349 <varlistentry id="bccmd">
350 <term><command>bccmd</command></term>
351 <listitem>
352 <para>
353 is used to issue BlueCore commands to Cambridge Silicon
354 Radio devices.
355 </para>
356 <indexterm zone="bluez bccmd">
357 <primary sortas="b-bccmd">bccmd</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="bluetoothd">
363 <term><command>bluetoothd</command></term>
364 <listitem>
365 <para>
366 is the Bluetooth daemon.
367 </para>
368 <indexterm zone="bluez bluetoothd">
369 <primary sortas="b-bluetoothd">bluetoothd</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="ciptool">
375 <term><command>ciptool</command></term>
376 <listitem>
377 <para>
378 is used to set up, maintain, and inspect the CIP configuration
379 of the Bluetooth subsystem in the Linux kernel.
380 </para>
381 <indexterm zone="bluez ciptool">
382 <primary sortas="b-ciptool">ciptool</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="dfutool">
388 <term><command>dfutool</command></term>
389 <listitem>
390 <para>
391 is used to verify, archive and upgrade firmware files.
392 </para>
393 <indexterm zone="bluez dfutool">
394 <primary sortas="b-dfutool">dfutool</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="dund">
400 <term><command>dund</command></term>
401 <listitem>
402 <para>
403 is the Bluetooth dial-up networking daemon.
404 </para>
405 <indexterm zone="bluez dund">
406 <primary sortas="b-dund">dund</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="hciattach">
412 <term><command>hciattach</command></term>
413 <listitem>
414 <para>
415 is used to attach a serial UART to the Bluetooth stack
416 as HCI transport interface.
417 </para>
418 <indexterm zone="bluez hciattach">
419 <primary sortas="b-hciattach">hciattach</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="hciconfig">
425 <term><command>hciconfig</command></term>
426 <listitem>
427 <para>
428 is used to configure Bluetooth devices.
429 </para>
430 <indexterm zone="bluez hciconfig">
431 <primary sortas="b-hciconfig">hciconfig</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="hcitool">
437 <term><command>hcitool</command></term>
438 <listitem>
439 <para>
440 is used to configure Bluetooth connections and send some
441 special command to Bluetooth devices.
442 </para>
443 <indexterm zone="bluez hcitool">
444 <primary sortas="b-hcitool">hcitool</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="hid2hci">
450 <term><command>hid2hci</command></term>
451 <listitem>
452 <para>
453 is used to set up switch supported Bluetooth devices into
454 the HCI mode and back.
455 </para>
456 <indexterm zone="bluez hid2hci">
457 <primary sortas="b-hid2hci">hid2hci</primary>
458 </indexterm>
459 </listitem>
460 </varlistentry>
461
462 <varlistentry id="hidd">
463 <term><command>hidd</command></term>
464 <listitem>
465 <para>
466 is the Bluetooth HID daemon.
467 </para>
468 <indexterm zone="bluez hidd">
469 <primary sortas="b-hidd">hidd</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="l2ping">
475 <term><command>l2ping</command></term>
476 <listitem>
477 <para>
478 is used to send a L2CAP echo request to the Bluetooth MAC
479 address given in dotted hex notation.
480 </para>
481 <indexterm zone="bluez l2ping">
482 <primary sortas="b-l2ping">l2ping</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 <varlistentry id="pand">
488 <term><command>pand</command></term>
489 <listitem>
490 <para>
491 is the Bluetooth daemon that allows you to connect to
492 ethernet networks using Bluetooth.
493 </para>
494 <indexterm zone="bluez pand">
495 <primary sortas="b-pand">pand</primary>
496 </indexterm>
497 </listitem>
498 </varlistentry>
499
500 <varlistentry id="rfcomm">
501 <term><command>rfcomm</command></term>
502 <listitem>
503 <para>
504 is used to set up, maintain, and inspect the RFCOMM
505 configuration of the Bluetooth subsystem in the
506 Linux kernel.
507 </para>
508 <indexterm zone="bluez rfcomm">
509 <primary sortas="b-rfcomm">rfcomm</primary>
510 </indexterm>
511 </listitem>
512 </varlistentry>
513
514 <varlistentry id="sdptool">
515 <term><command>sdptool</command></term>
516 <listitem>
517 <para>
518 is used to perform SDP queries on Bluetooth devices.
519 </para>
520 <indexterm zone="bluez sdptool">
521 <primary sortas="b-sdptool">sdptool</primary>
522 </indexterm>
523 </listitem>
524 </varlistentry>
525
526 <varlistentry id="libbluetooth">
527 <term><filename class="libraryfile">libbluetooth.so</filename></term>
528 <listitem>
529 <para>
530 contains the <application>BlueZ</application> API functions.
531 </para>
532 <indexterm zone="bluez libbluetooth">
533 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
534 </indexterm>
535 </listitem>
536 </varlistentry>
537 </variablelist>
538
539 </sect2>
540
541</sect1>
Note: See TracBrowser for help on using the repository browser.