source: general/sysutils/bluez.xml@ dd155dde

10.0 10.1 11.0 11.1 7.10 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind krejzi/svn lazarus nosym perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since dd155dde was dd155dde, checked in by Bruce Dubbs <bdubbs@…>, 8 years ago

Update to bluez-5.23
More tags

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

  • Property mode set to 100644
File size: 13.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 "b6ebf545d496087f3bc2b4aa86f89eb4">
10 <!ENTITY bluez-size "1.4 MB">
11 <!ENTITY bluez-buildsize "72 MB (additional 1 MB for the API docs)">
12 <!ENTITY bluez-time "0.6 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 &lfs76_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 Optional patch (required to work properly with gnome-bluetooth
78 and/or kde bluedevil):
79 <ulink url="&patch-root;/bluez-&bluez-version;-obexd_without_systemd-1.patch"/>
80 </para>
81 </listitem>
82 </itemizedlist>
83
84 <bridgehead renderas="sect3">BlueZ Dependencies</bridgehead>
85
86 <bridgehead renderas="sect4">Required</bridgehead>
87 <para role="required">
88 <xref linkend="dbus"/>,
89 <xref linkend="glib2"/>, and
90 <xref linkend="libical"/>
91 </para>
92
93 <para condition="html" role="usernotes">
94 User Notes: <ulink url="&blfs-wiki;/bluez"/>
95 </para>
96 </sect2>
97
98
99 <sect2 role="kernel" id="bluez-kernel">
100 <title>Kernel Configuration</title>
101
102 <para>
103 Enable the following options in the kernel configuration and recompile the
104 kernel if necessary:
105 </para>
106
107<screen><literal>[*] Networking support ---&gt; [CONFIG_NET]
108 &lt;*&gt; or &lt;M&gt; Bluetooth subsystem support ---&gt; [CONFIG_BT]
109 &lt;*&gt; or &lt;M&gt; RFCOMM protocol support [CONFIG_BT_RFCOMM]
110 [*] RFCOMM TTY support [CONFIG_BT_RFCOMM_TTY]
111 &lt;*&gt; or &lt;M&gt; BNEP protocol support [CONFIG_BT_BNEP]
112 [*] Multicast filter support [CONFIG_BT_BNEP_MC_FILTER]
113 [*] Protocol filter support [CONFIG_BT_BNEP_PROTO_FILTER]
114 &lt;*&gt; or &lt;M&gt; HIDP protocol support [CONFIG_BT_HIDP]
115
116 Bluetooth device drivers ---&gt;
117 &lt;*&gt; or &lt;M&gt; RF switch subsystem support</literal></screen>
118
119 <para>
120 Select the appropriate drivers for your Bluetooth hardware.
121 </para>
122
123 <indexterm zone="bluez bluez-kernel">
124 <primary sortas="d-bluez">bluez</primary>
125 </indexterm>
126 </sect2>
127
128 <sect2 role="installation">
129 <title>Installation of BlueZ</title>
130
131 <para>
132 If you are going to use <application>BlueZ</application> with
133 gnome-bluetooth and/or kde bluedevil, apply the following patch:
134 </para>
135
136<screen><userinput>patch -Np1 -i ../bluez-&bluez-version;-obexd_without_systemd-1.patch</userinput></screen>
137
138 <para>
139 Install <application>BlueZ</application> by running the following
140 commands:
141 </para>
142
143<screen><userinput>./configure --prefix=/usr \
144 --sysconfdir=/etc \
145 --localstatedir=/var \
146 --enable-library \
147 --disable-systemd &amp;&amp;
148make</userinput></screen>
149
150 <para>
151 To test the results, issue: <userinput>make check</userinput>.
152 </para>
153
154 <para>
155 Now, as the <systemitem class="username">root</systemitem> user:
156 </para>
157
158<screen role="root"><userinput>make install &amp;&amp;
159ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin</userinput></screen>
160
161 <para>
162 Install the main configuration file as the
163 <systemitem class="username">root</systemitem> user:
164 </para>
165
166<screen role="root"><userinput>install -v -dm755 /etc/bluetooth &amp;&amp;
167install -v -m644 src/main.conf /etc/bluetooth/main.conf</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 -dm755 /usr/share/doc/bluez-&bluez-version; &amp;&amp;
175install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
176
177 </sect2>
178
179
180 <sect2 role="commands">
181 <title>Command Explanations</title>
182
183 <para>
184 <parameter>--enable-library</parameter>: This switch enables building of the
185 <application>BlueZ</application> 4 compatibility library which is required by
186 some applications.
187 </para>
188
189 <para>
190 <parameter>--disable-systemd</parameter>: This switch is needed because
191 <application>systemd</application> is not part of LFS/BLFS. If you are
192 using systemd, remove this switch.
193 </para>
194
195 <para>
196 <command>ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin</command>:
197 This command makes access to the bluetooth daemon more convenient.
198 </para>
199
200 </sect2>
201
202 <sect2 role="configuration">
203 <title>Configuring BlueZ</title>
204
205 <sect3 id="bluez-config">
206 <title>Configuration Files</title>
207 <para>
208 <filename>/etc/bluetooth/main.conf</filename> is installed automatically
209 during the install. Additionally, there are three supplementary
210 configuration files. /etc/sysconfig/bluetooth is installed as a part
211 of the boot script below. In addition, you optionally can install the
212 following, as the <systemitem class="username">root</systemitem> user:
213 </para>
214
215<screen role="root"><userinput>cat > /etc/bluetooth/rfcomm.conf &lt;&lt; "EOF"</userinput>
216<literal># rfcomm.conf
217# Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
218# Use one line per command
219# See the rfcomm man page for options
220
221
222# End of rfcomm.conf</literal>
223EOF</screen>
224
225<screen role="root"><userinput>cat > /etc/bluetooth/uart.conf &lt;&lt; "EOF"</userinput>
226<literal>#uart.conf
227# Attach serial devices via UART HCI to BlueZ stack
228# Use one line per device
229# See the hciattach man page for options
230
231# End of uart.conf</literal>
232EOF</screen>
233
234 <indexterm zone="bluez bluez-config">
235 <primary
236 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
237 </indexterm>
238
239 </sect3>
240
241 <sect3 id="bluez-init">
242 <title>Boot Script</title>
243
244 <para>
245 To automatically start the <command>bluetoothd</command> daemon when the
246 system is rebooted, install the
247 <filename>/etc/rc.d/init.d/bluetooth</filename> bootscript from the
248 <xref linkend="bootscripts"/> package.
249 </para>
250
251 <indexterm zone="bluez bluez-init">
252 <primary sortas="f-bluetooth">bluetooth</primary>
253 </indexterm>
254
255<screen role="root"><userinput>make install-bluetooth</userinput></screen>
256
257 </sect3>
258
259 </sect2>
260
261 <sect2 role="content">
262 <title>Contents</title>
263
264 <segmentedlist>
265 <segtitle>Installed Programs</segtitle>
266 <segtitle>Installed Library</segtitle>
267 <segtitle>Installed Directories</segtitle>
268
269 <seglistitem>
270 <seg>
271 bccmd, bluemoon, bluetoothctl, bluetoothd, btmon, ciptool,
272 hciattach, hciconfig, hcidump, hcitool, hid2hci, l2ping,
273 l2test, mpris-proxy, obexd, rctest, rfcomm, and sdptool
274 </seg>
275 <seg>
276 libbluetooth.so
277 </seg>
278 <seg>
279 /etc/bluetooth,
280 /usr/include/bluetooth,
281 /usr/libexec/bluetooth, and
282 /usr/share/doc/bluez-&bluez-version;
283 </seg>
284 </seglistitem>
285 </segmentedlist>
286
287 <variablelist>
288 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
289 <?dbfo list-presentation="list"?>
290 <?dbhtml list-presentation="table"?>
291
292 <varlistentry id="bccmd">
293 <term><command>bccmd</command></term>
294 <listitem>
295 <para>
296 is used to issue BlueCore commands to Cambridge Silicon
297 Radio devices.
298 </para>
299 <indexterm zone="bluez bccmd">
300 <primary sortas="b-bccmd">bccmd</primary>
301 </indexterm>
302 </listitem>
303 </varlistentry>
304
305 <varlistentry id="bluetoothd">
306 <term><command>bluetoothd</command></term>
307 <listitem>
308 <para>
309 is the Bluetooth daemon.
310 </para>
311 <indexterm zone="bluez bluetoothd">
312 <primary sortas="b-bluetoothd">bluetoothd</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="ciptool">
318 <term><command>ciptool</command></term>
319 <listitem>
320 <para>
321 is used to set up, maintain, and inspect the CIP configuration
322 of the Bluetooth subsystem in the Linux kernel.
323 </para>
324 <indexterm zone="bluez ciptool">
325 <primary sortas="b-ciptool">ciptool</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="hciattach">
331 <term><command>hciattach</command></term>
332 <listitem>
333 <para>
334 is used to attach a serial UART to the Bluetooth stack
335 as HCI transport interface.
336 </para>
337 <indexterm zone="bluez hciattach">
338 <primary sortas="b-hciattach">hciattach</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="hciconfig">
344 <term><command>hciconfig</command></term>
345 <listitem>
346 <para>
347 is used to configure Bluetooth devices.
348 </para>
349 <indexterm zone="bluez hciconfig">
350 <primary sortas="b-hciconfig">hciconfig</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="hcitool">
356 <term><command>hcitool</command></term>
357 <listitem>
358 <para>
359 is used to configure Bluetooth connections and send some
360 special command to Bluetooth devices.
361 </para>
362 <indexterm zone="bluez hcitool">
363 <primary sortas="b-hcitool">hcitool</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="hid2hci">
369 <term><command>hid2hci</command></term>
370 <listitem>
371 <para>
372 is used to set up switch supported Bluetooth devices into
373 the HCI mode and back.
374 </para>
375 <indexterm zone="bluez hid2hci">
376 <primary sortas="b-hid2hci">hid2hci</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="l2ping">
382 <term><command>l2ping</command></term>
383 <listitem>
384 <para>
385 is used to send a L2CAP echo request to the Bluetooth MAC
386 address given in dotted hex notation.
387 </para>
388 <indexterm zone="bluez l2ping">
389 <primary sortas="b-l2ping">l2ping</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="rctest">
395 <term><command>rctest</command></term>
396 <listitem>
397 <para>
398 is used to test RFCOMM communications on the
399 Bluetooth stack.
400 </para>
401 <indexterm zone="bluez rctest">
402 <primary sortas="b-rctest">rctest</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="rfcomm">
408 <term><command>rfcomm</command></term>
409 <listitem>
410 <para>
411 is used to set up, maintain, and inspect the RFCOMM
412 configuration of the Bluetooth subsystem in the
413 Linux kernel.
414 </para>
415 <indexterm zone="bluez rfcomm">
416 <primary sortas="b-rfcomm">rfcomm</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="sdptool">
422 <term><command>sdptool</command></term>
423 <listitem>
424 <para>
425 is used to perform SDP queries on Bluetooth devices.
426 </para>
427 <indexterm zone="bluez sdptool">
428 <primary sortas="b-sdptool">sdptool</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry id="libbluetooth">
434 <term><filename class="libraryfile">libbluetooth.so</filename></term>
435 <listitem>
436 <para>
437 contains the <application>BlueZ</application> 4 API functions.
438 </para>
439 <indexterm zone="bluez libbluetooth">
440 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444 </variablelist>
445
446 </sect2>
447
448</sect1>
Note: See TracBrowser for help on using the repository browser.