source: general/sysutils/bluez.xml

trunk
Last change on this file was 82b5d3cf, checked in by Bruce Dubbs <bdubbs@…>, 9 days ago

Update to libXmu-1.2.1 (Xorg library) and bluez-5.75.

  • Property mode set to 100644
File size: 14.0 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 "&kernel-dl;/linux/bluetooth/bluez-&bluez-version;.tar.xz">
8 <!ENTITY bluez-download-ftp " ">
9 <!ENTITY bluez-md5sum "e6a640a70a808a2dd46b9ad44a888602">
10 <!ENTITY bluez-size "2.3 MB">
11 <!ENTITY bluez-buildsize "167 MB (with tests)">
12 <!ENTITY bluez-time "0.7 SBU (using parallelism=4; with tests)">
13]>
14
15<sect1 id="bluez" xreflabel="BlueZ-&bluez-version;">
16 <?dbhtml filename="bluez.html"?>
17
18
19 <title>BlueZ-&bluez-version;</title>
20
21 <indexterm zone="bluez">
22 <primary sortas="a-BlueZ">BlueZ</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to BlueZ</title>
27
28 <para>
29 The <application>BlueZ</application> package contains the
30 Bluetooth protocol stack for Linux.
31 </para>
32
33 &lfs121_checked;
34
35 <bridgehead renderas="sect3">Package Information</bridgehead>
36 <itemizedlist spacing="compact">
37 <listitem>
38 <para>
39 Download (HTTP): <ulink url="&bluez-download-http;"/>
40 </para>
41 </listitem>
42 <listitem>
43 <para>
44 Download (FTP): <ulink url="&bluez-download-ftp;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download MD5 sum: &bluez-md5sum;
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download size: &bluez-size;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Estimated disk space required: &bluez-buildsize;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated build time: &bluez-time;
65 </para>
66 </listitem>
67 </itemizedlist>
68 <!--
69 <bridgehead renderas="sect3" revision="sysv">Additional Downloads</bridgehead>
70 <itemizedlist spacing="compact" revision="sysv">
71 <listitem>
72 <para>
73 Required patch:
74 <ulink url="&patch-root;/bluez-&bluez-version;-obexd_without_systemd-1.patch"/>
75 </para>
76 </listitem>
77 </itemizedlist>
78 -->
79
80 <bridgehead renderas="sect3">BlueZ Dependencies</bridgehead>
81
82 <bridgehead renderas="sect4">Required</bridgehead>
83 <para role="required">
84 <xref linkend="dbus"/>,
85 <xref linkend="glib2"/>, and
86 <xref linkend="libical"/>
87 </para>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
91 <xref linkend="docutils"/> (to generate man pages)
92 </para>
93
94 </sect2>
95
96
97 <sect2 role="kernel" id="bluez-kernel">
98 <title>Kernel Configuration</title>
99
100 <para>
101 If you are building this package to use bluetooth devices (rather than as a
102 build dependency), enable the following options in the kernel configuration,
103 also the options in the <quote>Cryptographic API</quote> section if
104 you intend to run the tests, and recompile the kernel if necessary:
105 </para>
106
107 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
108 href="bluez-kernel.xml"/>
109
110 <indexterm zone="bluez bluez-kernel">
111 <primary sortas="d-bluez">bluez</primary>
112 </indexterm>
113 </sect2>
114
115 <sect2 role="installation">
116 <title>Installation of BlueZ</title>
117
118<!--
119 <para>
120 At first, fix an issue building the package with Glibc-2.34 or later:
121 </para>
122
123<screen><userinput>sed 's/pause(/bluez_&amp;/' -i profiles/audio/media.c</userinput></screen>
124
125 <para revision="sysv">Now, make some changes needed for SystemV systems:</para>
126
127<screen revision="sysv"><userinput>patch -Np1 -i ../bluez-&bluez-version;-obexd_without_systemd-1.patch</userinput></screen>
128
129-->
130 <para>
131 Install <application>BlueZ</application> by running the following
132 commands:
133 </para>
134
135<screen revision="sysv"><userinput>./configure --prefix=/usr \
136 --sysconfdir=/etc \
137 --localstatedir=/var \
138 --enable-library \
139 --disable-manpages \
140 --disable-systemd &amp;&amp;
141make</userinput></screen>
142
143<screen revision="systemd"><userinput>./configure --prefix=/usr \
144 --sysconfdir=/etc \
145 --localstatedir=/var \
146 --disable-manpages \
147 --enable-library &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 &root; 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 &root; user:
163 </para>
164
165<screen role="root"><userinput>install -v -dm755 /etc/bluetooth &amp;&amp;
166install -v -m644 src/main.conf /etc/bluetooth/main.conf</userinput></screen>
167
168 <para>
169 If desired, install the API documentation as the &root; user:
170 </para>
171
172<screen role="root"><userinput>install -v -dm755 /usr/share/doc/bluez-&bluez-version; &amp;&amp;
173install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
174
175 </sect2>
176
177
178 <sect2 role="commands">
179 <title>Command Explanations</title>
180
181 <para>
182 <parameter>--disable-manpages</parameter>: This switch disables generating
183 the manual pages because of the reliance on 'rst2man' in docutils. Remove
184 this switch if you have <xref role="nodep" linkend="docutils"/> installed
185 and wish to generate the manual pages.
186 </para>
187
188 <para>
189 <parameter>--enable-library</parameter>: This switch enables building the
190 <application>BlueZ</application> 4 compatibility library which is required by
191 some applications.
192 </para>
193
194 <para revision="sysv">
195 <parameter>--disable-systemd</parameter>: This switch is needed because
196 <application>systemd</application> is not part of LFS/BLFS. If you are
197 using systemd, remove this switch.
198 </para>
199
200 <para>
201 <command>ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin</command>:
202 This command makes access to the bluetooth daemon more convenient.
203 </para>
204
205 </sect2>
206
207 <sect2 role="configuration">
208 <title>Configuring BlueZ</title>
209
210 <sect3 id="bluez-config">
211 <title>Configuration Files</title>
212 <para revision="sysv">
213 <filename>/etc/bluetooth/main.conf</filename> is installed automatically
214 during the install. Additionally, there are three supplementary
215 configuration files. /etc/sysconfig/bluetooth is installed as a part
216 of the boot script below. In addition, you optionally can install the
217 following, as the &root; user:
218 </para>
219
220 <para revision="systemd">
221 <filename>/etc/bluetooth/main.conf</filename> is installed automatically
222 during the installation. Additionally, there are two supplementary
223 configuration files. You can optionally install the following files
224 as the &root; user:
225 </para>
226
227<screen role="root"><userinput>cat > /etc/bluetooth/rfcomm.conf &lt;&lt; "EOF"</userinput>
228<literal># Start rfcomm.conf
229# Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
230# Use one line per command
231# See the rfcomm man page for options
232
233
234# End of rfcomm.conf</literal>
235EOF</screen>
236
237<screen role="root"><userinput>cat > /etc/bluetooth/uart.conf &lt;&lt; "EOF"</userinput>
238<literal># Start uart.conf
239# Attach serial devices via UART HCI to BlueZ stack
240# Use one line per device
241# See the hciattach man page for options
242
243# End of uart.conf</literal>
244EOF</screen>
245
246 <indexterm zone="bluez bluez-config">
247 <primary
248 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
249 </indexterm>
250
251 </sect3>
252
253 <sect3 id="bluez-init">
254 <title><phrase revision="sysv">Boot Script</phrase>
255 <phrase revision="systemd">Systemd Bluez Services</phrase></title>
256
257 <para revision="sysv">
258 To automatically start the <command>bluetoothd</command> daemon when the
259 system is rebooted, install the
260 <filename>/etc/rc.d/init.d/bluetooth</filename> bootscript from the
261 <xref linkend="bootscripts"/> package.
262 </para>
263
264 <para revision="systemd">
265 To start the <command>bluetoothd</command> daemon at boot,
266 enable the previously installed systemd unit by
267 running the following command as the &root; user:
268 </para>
269
270<screen role="root" revision="systemd"><userinput>systemctl enable bluetooth</userinput></screen>
271
272 <para revision="systemd">
273 To start the <command>obexd</command> daemon for a user session (to
274 support some Bluetooth programs using it), enable the previously
275 installed systemd unit for all users by running the following command
276 as the &root; user:
277 </para>
278
279<screen role="root" revision="systemd"><userinput>systemctl enable --global obex</userinput></screen>
280
281 <indexterm zone="bluez bluez-init">
282 <primary sortas="f-bluetooth">bluetooth</primary>
283 </indexterm>
284
285<screen role="root" revision="sysv"><userinput>make install-bluetooth</userinput></screen>
286
287
288 <note revision="systemd">
289 <para>
290 <application>Systemd</application> will start the Bluetooth daemon
291 only when a bluetooth device is detected on the system.
292 </para>
293 </note>
294
295 </sect3>
296
297 </sect2>
298
299 <sect2 role="content">
300 <title>Contents</title>
301
302 <segmentedlist>
303 <segtitle>Installed Programs</segtitle>
304 <segtitle>Installed Library</segtitle>
305 <segtitle>Installed Directories</segtitle>
306
307 <seglistitem>
308 <seg>
309 <!--bccmd, -->
310 bluemoon,
311 bluetoothctl,
312 bluetoothd (symlink),
313 btattach,
314 btmon,
315 hex2hcd,
316 l2ping,
317 l2test,
318 mpris-proxy, and
319 rctest
320 </seg>
321 <seg>
322 libbluetooth.so
323 </seg>
324 <seg>
325 /etc/bluetooth,
326 /usr/{include,libexec}/bluetooth, and
327 /usr/share/doc/bluez-&bluez-version;
328 </seg>
329 </seglistitem>
330 </segmentedlist>
331
332 <variablelist>
333 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
334 <?dbfo list-presentation="list"?>
335 <?dbhtml list-presentation="table"?>
336
337 <!--
338 <varlistentry id="bccmd">
339 <term><command>bccmd</command></term>
340 <listitem>
341 <para>
342 is used to issue BlueCore commands to Cambridge Silicon
343 Radio devices
344 </para>
345 <indexterm zone="bluez bccmd">
346 <primary sortas="b-bccmd">bccmd</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350 -->
351
352 <varlistentry id="bluemoon">
353 <term><command>bluemoon</command></term>
354 <listitem>
355 <para>
356 is a Bluemoon configuration utility
357 </para>
358 <indexterm zone="bluez bluemoon">
359 <primary sortas="b-bluemoon">bluemoon</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="bluetoothctl">
365 <term><command>bluetoothctl</command></term>
366 <listitem>
367 <para>
368 is the interactive Bluetooth control program
369 </para>
370 <indexterm zone="bluez bluetoothctl">
371 <primary sortas="b-bluetoothctl">bluetoothctl</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="bluetoothd">
377 <term><command>bluetoothd</command></term>
378 <listitem>
379 <para>
380 is the Bluetooth daemon
381 </para>
382 <indexterm zone="bluez bluetoothd">
383 <primary sortas="b-bluetoothd">bluetoothd</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="btmon">
389 <term><command>btmon</command></term>
390 <listitem>
391 <para>
392 provides access to the Bluetooth subsystem monitor
393 infrastructure for reading HCI traces
394 </para>
395 <indexterm zone="bluez btmon">
396 <primary sortas="b-btmon">btmon</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401
402 <varlistentry id="hex2hcd">
403 <term><command>hex2hcd</command></term>
404 <listitem>
405 <para>
406 is used to convert a file needed by Broadcom devices
407 to hcd (Broadcom bluetooth firmware) format
408 </para>
409 <indexterm zone="bluez hex2hcd">
410 <primary sortas="b-hex2hcd">hex2hcd</primary>
411 </indexterm>
412 </listitem>
413 </varlistentry>
414
415 <varlistentry id="l2ping">
416 <term><command>l2ping</command></term>
417 <listitem>
418 <para>
419 is used to send a L2CAP echo request to the Bluetooth MAC
420 address given in dotted hex notation
421 </para>
422 <indexterm zone="bluez l2ping">
423 <primary sortas="b-l2ping">l2ping</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="l2test">
429 <term><command>l2test</command></term>
430 <listitem>
431 <para>
432 is a L2CAP testing program
433 </para>
434 <indexterm zone="bluez l2test">
435 <primary sortas="b-l2test">l2test</primary>
436 </indexterm>
437 </listitem>
438 </varlistentry>
439
440 <varlistentry id="rctest">
441 <term><command>rctest</command></term>
442 <listitem>
443 <para>
444 is used to test RFCOMM communications on the
445 Bluetooth stack
446 </para>
447 <indexterm zone="bluez rctest">
448 <primary sortas="b-rctest">rctest</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="libbluetooth">
454 <term><filename class="libraryfile">libbluetooth.so</filename></term>
455 <listitem>
456 <para>
457 contains the <application>BlueZ</application> 4 API functions
458 </para>
459 <indexterm zone="bluez libbluetooth">
460 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464 </variablelist>
465
466 </sect2>
467
468</sect1>
Note: See TracBrowser for help on using the repository browser.