source: general/sysutils/bluez-systemd.xml@ 86eabd5a

7.6-blfs 7.6-systemd kde5-14686 systemd-13485
Last change on this file since 86eabd5a was 86eabd5a, checked in by Christopher Gregory <cjg@…>, 10 years ago

Manually merged bluez update from trunk.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@14279 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 13.3 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 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;*&gt; or &lt;M&gt; Bluetooth subsystem support ---&gt; [CONFIG_BT]
108 &lt;*&gt; or &lt;M&gt; RFCOMM protocol support [CONFIG_BT_RFCOMM]
109 [*] RFCOMM TTY support [CONFIG_BT_RFCOMM_TTY]
110 &lt;*&gt; or &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;*&gt; or &lt;M&gt; HIDP protocol support [CONFIG_BT_HIDP]
114
115 Bluetooth device drivers ---&gt;
116 &lt;*&gt; or &lt;M&gt; RF switch subsystem support</literal></screen>
117
118 <para>
119 Select the appropriate drivers for your Bluetooth hardware.
120 </para>
121
122 <indexterm zone="bluez bluez-kernel">
123 <primary sortas="d-bluez">bluez</primary>
124 </indexterm>
125 </sect2>
126
127 <sect2 role="installation">
128 <title>Installation of BlueZ</title>
129
130 <para>
131 Install <application>BlueZ</application> by running the following
132 commands:
133 </para>
134
135<screen><userinput>patch -Np1 -i ../bluez-&bluez-version;-obexd_without_systemd-1.patch &amp;&amp;
136./configure --prefix=/usr \
137 --sysconfdir=/etc \
138 --localstatedir=/var \
139 --enable-library &amp;&amp;
140make</userinput></screen>
141
142 <para>
143 To test the results, issue: <userinput>make check</userinput>.
144 </para>
145
146 <para>
147 Now, as the <systemitem class="username">root</systemitem> user:
148 </para>
149
150<screen role="root"><userinput>make install</userinput></screen>
151
152 <para>
153 Install the main configuration file as the
154 <systemitem class="username">root</systemitem> user:
155 </para>
156
157<screen role="root"><userinput>install -v -dm755 /etc/bluetooth &amp;&amp;
158install -v -m644 src/main.conf /etc/bluetooth/main.conf</userinput></screen>
159
160 <para>
161 If desired, install the API documentation as the
162 <systemitem class="username">root</systemitem> user:
163 </para>
164
165<screen role="root"><userinput>install -v -dm755 /usr/share/doc/bluez-&bluez-version; &amp;&amp;
166install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
167
168 </sect2>
169
170 <sect2 role="commands">
171 <title>Command Explanations</title>
172
173 <para>
174 <parameter>--enable-library</parameter>: This switch enables building of the
175 <application>BlueZ</application> 4 compatibility library which is required by
176 some applications.
177 </para>
178
179 </sect2>
180
181 <sect2 role="configuration">
182 <title>Configuring BlueZ</title>
183
184 <sect3 id="bluez-config">
185 <title>Configuration Files</title>
186 <para>
187 <filename>/etc/bluetooth/main.conf</filename> is installed
188 automatically during the install. Additionally, there are
189 two supplementary configuration files that you can install
190 by running the following commands as the
191 <systemitem class="username">root</systemitem> user:
192 </para>
193
194<screen role="root"><userinput>cat > /etc/bluetooth/rfcomm.conf &lt;&lt; "EOF"</userinput>
195<literal># rfcomm.conf
196# Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
197# Use one line per command
198# See the rfcomm man page for options
199
200# End of rfcomm.conf</literal>
201EOF</screen>
202
203<screen role="root"><userinput>cat > /etc/bluetooth/uart.conf &lt;&lt; "EOF"</userinput>
204<literal>#uart.conf
205# Attach serial devices via UART HCI to BlueZ stack
206# Use one line per device
207# See the hciattach man page for options
208
209# End of uart.conf</literal>
210EOF</screen>
211
212 <indexterm zone="bluez bluez-config">
213 <primary
214 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
215 </indexterm>
216
217 <indexterm zone="bluez bluez-config">
218 <primary
219 sortas="e-etc-bluetooth-rfcomm.conf">/etc/bluetooth/rfcomm.conf</primary>
220 </indexterm>
221
222 <indexterm zone="bluez bluez-config">
223 <primary
224 sortas="e-etc-bluetooth-uart.conf">/etc/bluetooth/uart.conf</primary>
225 </indexterm>
226
227 </sect3>
228
229 <sect3 id="bluez-init">
230 <title>Systemd Units</title>
231
232 <para>
233 To start the <command>bluetoothd</command> daemon at boot,
234 enable the previously installed systemd unit by
235 running the following command as the
236 <systemitem class="username">root</systemitem> user:
237 </para>
238
239 <indexterm zone="bluez bluez-init">
240 <primary sortas="f-bluetooth">bluetooth</primary>
241 </indexterm>
242
243<screen role="root"><userinput>systemctl enable bluetooth</userinput></screen>
244
245 <note>
246 <para>
247 <application>Systemd</application> will start the Bluetooth daemon
248 only when a bluetooth device is detected on the system.
249 </para>
250 </note>
251
252 </sect3>
253
254 </sect2>
255
256 <sect2 role="content">
257 <title>Contents</title>
258
259 <segmentedlist>
260 <segtitle>Installed Programs</segtitle>
261 <segtitle>Installed Library</segtitle>
262 <segtitle>Installed Directories</segtitle>
263
264 <seglistitem>
265 <seg>
266 bccmd, bluemoon, bluetoothctl, bluetoothd, btmon, ciptool,
267 hciattach, hciconfig, hcidump, hcitool, hid2hci, l2ping,
268 l2test, mpris-proxy, obexd, rctest, rfcomm, and sdptool
269 </seg>
270 <seg>
271 libbluetooth.so
272 </seg>
273 <seg>
274 /etc/bluetooth,
275 /usr/include/bluetooth,
276 /usr/libexec/bluetooth, and
277 /usr/share/doc/bluez-&bluez-version;
278 </seg>
279 </seglistitem>
280 </segmentedlist>
281
282 <variablelist>
283 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
284 <?dbfo list-presentation="list"?>
285 <?dbhtml list-presentation="table"?>
286
287 <varlistentry id="bccmd">
288 <term><command>bccmd</command></term>
289 <listitem>
290 <para>
291 is used to issue BlueCore commands to Cambridge Silicon
292 Radio devices.
293 </para>
294 <indexterm zone="bluez bccmd">
295 <primary sortas="b-bccmd">bccmd</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299
300 <varlistentry id="bluetoothd">
301 <term><command>bluetoothd</command></term>
302 <listitem>
303 <para>
304 is the Bluetooth daemon.
305 </para>
306 <indexterm zone="bluez bluetoothd">
307 <primary sortas="b-bluetoothd">bluetoothd</primary>
308 </indexterm>
309 </listitem>
310 </varlistentry>
311
312 <varlistentry id="ciptool">
313 <term><command>ciptool</command></term>
314 <listitem>
315 <para>
316 is used to set up, maintain, and inspect the CIP configuration
317 of the Bluetooth subsystem in the Linux kernel.
318 </para>
319 <indexterm zone="bluez ciptool">
320 <primary sortas="b-ciptool">ciptool</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="hciattach">
326 <term><command>hciattach</command></term>
327 <listitem>
328 <para>
329 is used to attach a serial UART to the Bluetooth stack
330 as HCI transport interface.
331 </para>
332 <indexterm zone="bluez hciattach">
333 <primary sortas="b-hciattach">hciattach</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="hciconfig">
339 <term><command>hciconfig</command></term>
340 <listitem>
341 <para>
342 is used to configure Bluetooth devices.
343 </para>
344 <indexterm zone="bluez hciconfig">
345 <primary sortas="b-hciconfig">hciconfig</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="hcitool">
351 <term><command>hcitool</command></term>
352 <listitem>
353 <para>
354 is used to configure Bluetooth connections and send some
355 special command to Bluetooth devices.
356 </para>
357 <indexterm zone="bluez hcitool">
358 <primary sortas="b-hcitool">hcitool</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="hid2hci">
364 <term><command>hid2hci</command></term>
365 <listitem>
366 <para>
367 is used to set up switch supported Bluetooth devices into
368 the HCI mode and back.
369 </para>
370 <indexterm zone="bluez hid2hci">
371 <primary sortas="b-hid2hci">hid2hci</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="l2ping">
377 <term><command>l2ping</command></term>
378 <listitem>
379 <para>
380 is used to send a L2CAP echo request to the Bluetooth MAC
381 address given in dotted hex notation.
382 </para>
383 <indexterm zone="bluez l2ping">
384 <primary sortas="b-l2ping">l2ping</primary>
385 </indexterm>
386 </listitem>
387 </varlistentry>
388
389 <varlistentry id="rctest">
390 <term><command>rctest</command></term>
391 <listitem>
392 <para>
393 is used to test RFCOMM communications on the
394 Bluetooth stack.
395 </para>
396 <indexterm zone="bluez rctest">
397 <primary sortas="b-rctest">rctest</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="rfcomm">
403 <term><command>rfcomm</command></term>
404 <listitem>
405 <para>
406 is used to set up, maintain, and inspect the RFCOMM
407 configuration of the Bluetooth subsystem in the
408 Linux kernel.
409 </para>
410 <indexterm zone="bluez rfcomm">
411 <primary sortas="b-rfcomm">rfcomm</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry id="sdptool">
417 <term><command>sdptool</command></term>
418 <listitem>
419 <para>
420 is used to perform SDP queries on Bluetooth devices.
421 </para>
422 <indexterm zone="bluez sdptool">
423 <primary sortas="b-sdptool">sdptool</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="libbluetooth">
429 <term><filename class="libraryfile">libbluetooth.so</filename></term>
430 <listitem>
431 <para>
432 contains the <application>BlueZ</application> 4 API functions.
433 </para>
434 <indexterm zone="bluez libbluetooth">
435 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
436 </indexterm>
437 </listitem>
438 </varlistentry>
439 </variablelist>
440
441 </sect2>
442
443</sect1>
Note: See TracBrowser for help on using the repository browser.