source: general/sysutils/bluez.xml@ 45ab6c7

11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 years ago

more SVN prop clean up

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