source: general/sysutils/bluez.xml@ c67fbf64

systemd-11177
Last change on this file since c67fbf64 was c67fbf64, checked in by Krejzi <krejzi@…>, 11 years ago

Remove packages that are now in lfs systemd from blfs.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@11302 af4574ff-66df-0310-9fd7-8a98e5e911e0

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