source: general/sysutils/bluez-systemd.xml@ 459c449

7.6-blfs 7.6-systemd kde5-14269 kde5-14686 systemd-13485
Last change on this file since 459c449 was 459c449, checked in by Krejzi <krejzi@…>, 10 years ago

Begin merging Christophers work into systemd branch part 3.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@13490 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 "d5a0d05520e013f2394bf1d0bac12889">
10 <!ENTITY bluez-size "1.3 MB">
11 <!ENTITY bluez-buildsize "59 MB">
12 <!ENTITY bluez-time "0.8 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 &lfs75_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 &amp;&amp;
147make</userinput></screen>
148
149 <para>
150 To test the results, issue: <userinput>make check</userinput>.
151 </para>
152
153 <para>
154 Now, as the <systemitem class="username">root</systemitem> user:
155 </para>
156
157<screen role="root"><userinput>make install</userinput></screen>
158
159 <para>
160 Install the main configuration file as the
161 <systemitem class="username">root</systemitem> user:
162 </para>
163
164<screen role="root"><userinput>install -v -dm755 /etc/bluetooth &amp;&amp;
165install -v -m644 src/main.conf /etc/bluetooth/main.conf</userinput></screen>
166
167 <para>
168 If desired, install the API documentation as the
169 <systemitem class="username">root</systemitem> 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>--enable-library</parameter>: This switch enables building of the
183 <application>BlueZ</application> 4 compatibility library which is required by
184 some applications.
185 </para>
186
187 </sect2>
188
189 <sect2 role="configuration">
190 <title>Configuring BlueZ</title>
191
192 <sect3 id="bluez-config">
193 <title>Configuration Files</title>
194 <para>
195 <filename>/etc/bluetooth/main.conf</filename> is installed automatically
196 during the install. Additionally, there are three supplementary
197 configuration files. /etc/sysconfig/bluetooth is
198 installed as a part of the boot script below. In addition
199 you optionally can install the following as the
200 <systemitem class="username">root</systemitem> user:
201 </para>
202
203<screen role="root"><userinput>cat > /etc/bluetooth/rfcomm.conf &lt;&lt; "EOF"</userinput>
204<literal># rfcomm.conf
205# Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
206# Use one line per command
207# See the rfcomm man page for options
208
209
210# End of rfcomm.conf</literal></screen>
211
212<screen role="root"><userinput>cat > /etc/bluetooth/uart.conf &lt;&lt; "EOF"</userinput>
213<literal>#uart.conf
214# Attach serial devices via UART HCI to BlueZ stack
215# Use one line per device
216# See the hciattach man page for options
217
218# End of uart.conf</literal></screen>
219
220 <indexterm zone="bluez bluez-config">
221 <primary
222 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
223 </indexterm>
224
225 </sect3>
226
227 <sect3 id="bluez-init">
228 <title>Boot Script</title>
229
230 <para>
231 To automatically start the <command>bluetoothd</command> daemon when the
232 system is rebooted, enable the previously installed systemd unit by
233 running the following command as the
234 <systemitem class="username">root</systemitem> user:
235 </para>
236
237 <indexterm zone="bluez bluez-init">
238 <primary sortas="f-bluetooth">bluetooth</primary>
239 </indexterm>
240
241<screen role="root"><userinput>systemctl enable bluetooth</userinput></screen>
242
243 <note>
244 <para>
245 The bluetooth daemon will only start when a bluetooth device has been detected
246 on the system.
247 </para>
248 </note>
249
250 </sect3>
251
252 </sect2>
253
254 <sect2 role="content">
255 <title>Contents</title>
256
257 <segmentedlist>
258 <segtitle>Installed Programs</segtitle>
259 <segtitle>Installed Library</segtitle>
260 <segtitle>Installed Directories</segtitle>
261
262 <seglistitem>
263 <seg>
264 bccmd, bluemoon, bluetoothctl, bluetoothd, btmon, ciptool,
265 hciattach, hciconfig, hcidump, hcitool, hid2hci, l2ping,
266 l2test, obexd, rctest, rfcomm, and sdptool
267 </seg>
268 <seg>
269 libbluetooth.so
270 </seg>
271 <seg>
272 /etc/bluetooth,
273 /usr/include/bluetooth,
274 /usr/libexec/bluetooth, and
275 /usr/share/doc/bluez-&bluez-version;
276 </seg>
277 </seglistitem>
278 </segmentedlist>
279
280 <variablelist>
281 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
282 <?dbfo list-presentation="list"?>
283 <?dbhtml list-presentation="table"?>
284
285 <varlistentry id="bccmd">
286 <term><command>bccmd</command></term>
287 <listitem>
288 <para>
289 is used to issue BlueCore commands to Cambridge Silicon
290 Radio devices.
291 </para>
292 <indexterm zone="bluez bccmd">
293 <primary sortas="b-bccmd">bccmd</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="bluetoothd">
299 <term><command>bluetoothd</command></term>
300 <listitem>
301 <para>
302 is the Bluetooth daemon.
303 </para>
304 <indexterm zone="bluez bluetoothd">
305 <primary sortas="b-bluetoothd">bluetoothd</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="ciptool">
311 <term><command>ciptool</command></term>
312 <listitem>
313 <para>
314 is used to set up, maintain, and inspect the CIP configuration
315 of the Bluetooth subsystem in the Linux kernel.
316 </para>
317 <indexterm zone="bluez ciptool">
318 <primary sortas="b-ciptool">ciptool</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="hciattach">
324 <term><command>hciattach</command></term>
325 <listitem>
326 <para>
327 is used to attach a serial UART to the Bluetooth stack
328 as HCI transport interface.
329 </para>
330 <indexterm zone="bluez hciattach">
331 <primary sortas="b-hciattach">hciattach</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="hciconfig">
337 <term><command>hciconfig</command></term>
338 <listitem>
339 <para>
340 is used to configure Bluetooth devices.
341 </para>
342 <indexterm zone="bluez hciconfig">
343 <primary sortas="b-hciconfig">hciconfig</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="hcitool">
349 <term><command>hcitool</command></term>
350 <listitem>
351 <para>
352 is used to configure Bluetooth connections and send some
353 special command to Bluetooth devices.
354 </para>
355 <indexterm zone="bluez hcitool">
356 <primary sortas="b-hcitool">hcitool</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="hid2hci">
362 <term><command>hid2hci</command></term>
363 <listitem>
364 <para>
365 is used to set up switch supported Bluetooth devices into
366 the HCI mode and back.
367 </para>
368 <indexterm zone="bluez hid2hci">
369 <primary sortas="b-hid2hci">hid2hci</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="l2ping">
375 <term><command>l2ping</command></term>
376 <listitem>
377 <para>
378 is used to send a L2CAP echo request to the Bluetooth MAC
379 address given in dotted hex notation.
380 </para>
381 <indexterm zone="bluez l2ping">
382 <primary sortas="b-l2ping">l2ping</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="rctest">
388 <term><command>rctest</command></term>
389 <listitem>
390 <para>
391 is used to test RFCOMM communications on the
392 Bluetooth stack.
393 </para>
394 <indexterm zone="bluez rctest">
395 <primary sortas="b-rctest">rctest</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="rfcomm">
401 <term><command>rfcomm</command></term>
402 <listitem>
403 <para>
404 is used to set up, maintain, and inspect the RFCOMM
405 configuration of the Bluetooth subsystem in the
406 Linux kernel.
407 </para>
408 <indexterm zone="bluez rfcomm">
409 <primary sortas="b-rfcomm">rfcomm</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="sdptool">
415 <term><command>sdptool</command></term>
416 <listitem>
417 <para>
418 is used to perform SDP queries on Bluetooth devices.
419 </para>
420 <indexterm zone="bluez sdptool">
421 <primary sortas="b-sdptool">sdptool</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="libbluetooth">
427 <term><filename class="libraryfile">libbluetooth.so</filename></term>
428 <listitem>
429 <para>
430 contains the <application>BlueZ</application> 4 API functions.
431 </para>
432 <indexterm zone="bluez libbluetooth">
433 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437 </variablelist>
438
439 </sect2>
440
441</sect1>
Note: See TracBrowser for help on using the repository browser.