source: general/sysutils/bluez.xml@ 36aff45

systemd-13485
Last change on this file since 36aff45 was 36aff45, checked in by DJ Lucas <dj@…>, 8 years ago

Remove -systemd naming for chapter 12

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

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