source: general/sysutils/bluez-systemd.xml@ 0c74e1f9

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

typo.

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