source: general/sysutils/bluez.xml@ a998e97

gnome
Last change on this file since a998e97 was a998e97, checked in by Christopher Gregory <cjg@…>, 10 years ago

Added systemd notes to acpid at autofs bluez colord and dbus pages

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/gnome@13394 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 14.0 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 "177d4551f76e5933cc467c3abc6d3796">
10 <!ENTITY bluez-size "1.3 MB">
11 <!ENTITY bluez-buildsize "68 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;
108 &lt;*&gt; or &lt;M&gt; Bluetooth subsystem support ---&gt;
109 &lt;*&gt; or &lt;M&gt; RFCOMM protocol support
110 [*] RFCOMM TTY support
111 &lt;*&gt; or &lt;M&gt; BNEP protocol support
112 [*] Multicast filter support
113 [*] Protocol filter support
114 &lt;*&gt; or &lt;M&gt; HIDP protocol support
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 \
147 --disable-systemd &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 <systemitem class="username">root</systemitem> 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
163 <systemitem class="username">root</systemitem> user:
164 </para>
165
166<screen role="root"><userinput>install -v -dm755 /etc/bluetooth &amp;&amp;
167install -v -m644 src/main.conf /etc/bluetooth/main.conf</userinput></screen>
168
169 <para>
170 If desired, install the API documentation as the
171 <systemitem class="username">root</systemitem> user:
172 </para>
173
174<screen role="root"><userinput>install -v -dm755 /usr/share/doc/bluez-&bluez-version; &amp;&amp;
175install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
176
177 </sect2>
178
179
180 <sect2 role="commands">
181 <title>Command Explanations</title>
182
183 <para>
184 <parameter>--enable-library</parameter>: This switch enables building of the
185 <application>BlueZ</application> 4 compatibility library which is required by
186 some applications.
187 </para>
188
189 <para>
190 <parameter>--disable-systemd</parameter>: This switch is needed because
191 <application>systemd</application> is not part of LFS/BLFS. If you are
192 using systemd, remove this switch.
193 </para>
194
195 <para>
196 <command>ln -svf ../libexec/bluetooth/bluetoothd /usr/sbin</command>:
197 This command makes access to the bluetooth daemon more convenient.
198 </para>
199
200 </sect2>
201
202 <sect2 role="configuration">
203 <title>Configuring BlueZ</title>
204
205 <sect3 id="bluez-config">
206 <title>Configuration Files</title>
207 <para>
208 <filename>/etc/bluetooth/main.conf</filename> is installed automatically
209 during the install. Additionally, there are three supplementary
210 configuration files. /etc/sysconfig/bluetooth is
211 installed as a part of the boot script below. In addition
212 you optionally can install the following as the
213 <systemitem class="username">root</systemitem> user:
214 </para>
215
216<screen role="root"><userinput>cat > /etc/bluetooth/rfcomm.conf &lt;&lt; "EOF"</userinput>
217<literal># rfcomm.conf
218# Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
219# Use one line per command
220# See the rfcomm man page for options
221
222
223# End of rfcomm.conf</literal></screen>
224
225<screen role="root"><userinput>cat > /etc/bluetooth/uart.conf &lt;&lt; "EOF"</userinput>
226<literal>#uart.conf
227# Attach serial devices via UART HCI to BlueZ stack
228# Use one line per device
229# See the hciattach man page for options
230
231# End of uart.conf</literal></screen>
232
233 <indexterm zone="bluez bluez-config">
234 <primary
235 sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
236 </indexterm>
237
238 </sect3>
239
240 <sect3 id="bluez-init">
241 <title>Boot Script</title>
242
243 <para>
244 To automatically start the <command>bluetoothd</command> daemon when the
245 system is rebooted, install the
246 <filename>/etc/rc.d/init.d/bluetooth</filename> bootscript from the
247 <xref linkend="bootscripts"/> package.
248 </para>
249
250 <indexterm zone="bluez bluez-init">
251 <primary sortas="f-bluetooth">bluetooth</primary>
252 </indexterm>
253
254<screen role="root"><userinput>make install-bluetooth</userinput></screen>
255
256 </sect3>
257
258 <sect3 id="bluez-init-systemd">
259 <title>Systemd Unit File</title>
260
261 <para>
262 This package will automatically install the systemd unit file if systemd is detected.
263 To enable it, issue the following command as the
264 <systemitem class="username">root</systemitem> user:
265 </para>
266
267 <indexterm zone="bluez bluez-init-systemd">
268 <primary sortas="f-bluetooth">bluetooth</primary>
269 </indexterm>
270
271<screen role="root">
272<userinput>
273systemctl enable bluetooth
274</userinput></screen>
275
276 <note>
277 <para>
278 The bluetooth daemon will only start when a bluetooth device has been detected on the system.
279 </para>
280 </note>
281
282 </sect3>
283
284
285 </sect2>
286
287 <sect2 role="content">
288 <title>Contents</title>
289
290 <segmentedlist>
291 <segtitle>Installed Programs</segtitle>
292 <segtitle>Installed Library</segtitle>
293 <segtitle>Installed Directories</segtitle>
294
295 <seglistitem>
296 <seg>
297 bccmd, bluemoon, bluetoothctl, bluetoothd, btmon, ciptool,
298 hciattach, hciconfig, hcidump, hcitool, hid2hci, l2ping,
299 l2test, obexd, rctest, rfcomm, and sdptool
300 </seg>
301 <seg>
302 libbluetooth.so
303 </seg>
304 <seg>
305 /etc/bluetooth,
306 /usr/include/bluetooth,
307 /usr/libexec/bluetooth, and
308 /usr/share/doc/bluez-&bluez-version;
309 </seg>
310 </seglistitem>
311 </segmentedlist>
312
313 <variablelist>
314 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
315 <?dbfo list-presentation="list"?>
316 <?dbhtml list-presentation="table"?>
317
318 <varlistentry id="bccmd">
319 <term><command>bccmd</command></term>
320 <listitem>
321 <para>
322 is used to issue BlueCore commands to Cambridge Silicon
323 Radio devices.
324 </para>
325 <indexterm zone="bluez bccmd">
326 <primary sortas="b-bccmd">bccmd</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="bluetoothd">
332 <term><command>bluetoothd</command></term>
333 <listitem>
334 <para>
335 is the Bluetooth daemon.
336 </para>
337 <indexterm zone="bluez bluetoothd">
338 <primary sortas="b-bluetoothd">bluetoothd</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342
343 <varlistentry id="ciptool">
344 <term><command>ciptool</command></term>
345 <listitem>
346 <para>
347 is used to set up, maintain, and inspect the CIP configuration
348 of the Bluetooth subsystem in the Linux kernel.
349 </para>
350 <indexterm zone="bluez ciptool">
351 <primary sortas="b-ciptool">ciptool</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355
356 <varlistentry id="hciattach">
357 <term><command>hciattach</command></term>
358 <listitem>
359 <para>
360 is used to attach a serial UART to the Bluetooth stack
361 as HCI transport interface.
362 </para>
363 <indexterm zone="bluez hciattach">
364 <primary sortas="b-hciattach">hciattach</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="hciconfig">
370 <term><command>hciconfig</command></term>
371 <listitem>
372 <para>
373 is used to configure Bluetooth devices.
374 </para>
375 <indexterm zone="bluez hciconfig">
376 <primary sortas="b-hciconfig">hciconfig</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="hcitool">
382 <term><command>hcitool</command></term>
383 <listitem>
384 <para>
385 is used to configure Bluetooth connections and send some
386 special command to Bluetooth devices.
387 </para>
388 <indexterm zone="bluez hcitool">
389 <primary sortas="b-hcitool">hcitool</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="hid2hci">
395 <term><command>hid2hci</command></term>
396 <listitem>
397 <para>
398 is used to set up switch supported Bluetooth devices into
399 the HCI mode and back.
400 </para>
401 <indexterm zone="bluez hid2hci">
402 <primary sortas="b-hid2hci">hid2hci</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="l2ping">
408 <term><command>l2ping</command></term>
409 <listitem>
410 <para>
411 is used to send a L2CAP echo request to the Bluetooth MAC
412 address given in dotted hex notation.
413 </para>
414 <indexterm zone="bluez l2ping">
415 <primary sortas="b-l2ping">l2ping</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="rctest">
421 <term><command>rctest</command></term>
422 <listitem>
423 <para>
424 is used to test RFCOMM communications on the
425 Bluetooth stack.
426 </para>
427 <indexterm zone="bluez rctest">
428 <primary sortas="b-rctest">rctest</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry id="rfcomm">
434 <term><command>rfcomm</command></term>
435 <listitem>
436 <para>
437 is used to set up, maintain, and inspect the RFCOMM
438 configuration of the Bluetooth subsystem in the
439 Linux kernel.
440 </para>
441 <indexterm zone="bluez rfcomm">
442 <primary sortas="b-rfcomm">rfcomm</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="sdptool">
448 <term><command>sdptool</command></term>
449 <listitem>
450 <para>
451 is used to perform SDP queries on Bluetooth devices.
452 </para>
453 <indexterm zone="bluez sdptool">
454 <primary sortas="b-sdptool">sdptool</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="libbluetooth">
460 <term><filename class="libraryfile">libbluetooth.so</filename></term>
461 <listitem>
462 <para>
463 contains the <application>BlueZ</application> 4 API functions.
464 </para>
465 <indexterm zone="bluez libbluetooth">
466 <primary sortas="c-libbluetooth">libbluetooth.so</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470 </variablelist>
471
472 </sect2>
473
474</sect1>
Note: See TracBrowser for help on using the repository browser.