glfs/general/sysutils/bluez.xml
Bruce Dubbs 8f29aa2dcb More tags and minor fixes for 7.4
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@11768 af4574ff-66df-0310-9fd7-8a98e5e911e0
2013-09-05 16:23:52 +00:00

542 lines
16 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY bluez-download-http "http://www.kernel.org/pub/linux/bluetooth/bluez-&bluez-version;.tar.xz">
<!ENTITY bluez-download-ftp "ftp://ftp.kernel.org/pub/linux/bluetooth/bluez-&bluez-version;.tar.xz">
<!ENTITY bluez-md5sum "c828c172f01f20c6ecd7f407894956a2">
<!ENTITY bluez-size "868 KB">
<!ENTITY bluez-buildsize "42 MB">
<!ENTITY bluez-time "0.8 SBU">
]>
<sect1 id="bluez" xreflabel="BlueZ-&bluez-version;">
<?dbhtml filename="bluez.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>BlueZ-&bluez-version;</title>
<indexterm zone="bluez">
<primary sortas="a-BlueZ">BlueZ</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to BlueZ</title>
<para>
The <application>BlueZ</application> package contains the
Bluetooth protocol stack for Linux.
</para>
&lfs74_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&bluez-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&bluez-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &bluez-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &bluez-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &bluez-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &bluez-time;
</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">BlueZ Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="dbus"/> and
<xref linkend="glib2"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="alsa-lib"/>,
<xref linkend="check"/>,
<xref linkend="gst-plugins-base"/>,
<xref linkend="libsndfile"/>, and
<xref linkend="libusb-compat"/>
</para>
<para condition="html" role="usernotes">
User Notes: <ulink url="&blfs-wiki;/bluez"/>
</para>
</sect2>
<sect2 role="kernel" id="bluez-kernel">
<title>Kernel Configuration</title>
<para>
Enable the following options in the kernel configuration and recompile the
kernel if necessary:
</para>
<screen><literal>[*] Networking support --->
&lt;*&gt; or &lt;M&gt; Bluetooth subsystem support --->
&lt;*&gt; or &lt;M&gt; RFCOMM protocol support
[*] RFCOMM TTY support
&lt;*&gt; or &lt;M&gt; BNEP protocol support
[*] Multicast filter support
[*] Protocol filter support
&lt;*&gt; or &lt;M&gt; HIDP protocol support
Bluetooth device drivers ---></literal></screen>
<para>
Select the appropriate drivers for your Bluetooth hardware.
</para>
<indexterm zone="bluez bluez-kernel">
<primary sortas="d-bluez">bluez</primary>
</indexterm>
</sect2>
<sect2 role="installation">
<title>Installation of BlueZ</title>
<para>
Install <application>BlueZ</application> by running the following
commands:
</para>
<screen><userinput>
./configure --prefix=/usr \
--sysconfdir=/etc \
--localstatedir=/var \
--libexecdir=/lib \
--enable-bccmd \
--enable-dfutool \
--enable-dund \
--enable-hid2hci \
--enable-hidd \
--enable-pand \
--enable-tools \
--enable-wiimote \
--disable-test \
--without-systemdunitdir &amp;&amp;
make</userinput></screen>
<para>
This package does not come with a test suite.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
<para>
Install required configuration files as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>for CONFFILE in audio input network serial ; do
install -v -m644 ${CONFFILE}/${CONFFILE}.conf /etc/bluetooth/${CONFFILE}.conf
done
unset CONFFILE</userinput></screen>
<para>
If desired, install the API documentation as the
<systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/bluez-&bluez-version; &amp;&amp;
install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<parameter>--enable-bccmd</parameter>: This switch enables building of the BCCMD
interface utility.
</para>
<para>
<parameter>--enable-dfutool</parameter>: This switch enables building of the DFU
firmware upgrade utility.
</para>
<para>
<parameter>--enable-dund</parameter>: This switch enables building of the DUN daemon.
</para>
<para>
<parameter>--enable-hid2hci</parameter>: This switch enables building of the HID
mode switching utility.
</para>
<para>
<parameter>--enable-hidd</parameter>: This switch enables building of the HID daemon.
</para>
<para>
<parameter>--enable-pand</parameter>: This switch enables building of the PAN daemon.
</para>
<para>
<parameter>--enable-tools</parameter>: This switch enables building of the Bluetooth
utilities.
</para>
<para>
<parameter>--enable-wiimote</parameter>: This switch enables building of the Wii
Remote plugin.
</para>
<para>
<parameter>--disable-test</parameter>: This switch disables installation of the
test programs.
</para>
<para>
<parameter>--without-systemdunitdir</parameter>: This switch disables installation
of the systemd units.
</para>
<para>
<option>--enable-cups</option>: This switch enables CUPS backend support. Note
that CUPS does not need to be installed for this support.
</para>
<!-- These options are automatically found and used if the packages are
available. There is no need to use these switches.
<para>
<option>-enable-alsa</option>: This switch enables ALSA support. Use if you
have <xref linkend="alsa-lib"/> installed.
</para>
<para>
<option>-enable-gstreamer</option>: This switch enables GStreamer support. Use
if you have <xref linkend="gst-plugins-base"/> installed.
</para>
<para>
<option>-enable-usb</option>: This switch enables USB support. Use if you have
<xref linkend="libusb-compat"/> installed.
</para> -->
</sect2>
<sect2 role="configuration">
<title>Configuring BlueZ</title>
<sect3 id="bluez-config">
<title>Config Files</title>
<para>
<filename>/etc/bluetooth/audio.conf</filename>,
<filename>/etc/bluetooth/input.conf</filename>,
<filename>/etc/bluetooth/main.conf</filename>,
<filename>/etc/bluetooth/network.conf</filename>,
<filename>/etc/bluetooth/rfcomm.conf</filename> and
<filename>/etc/bluetooth/serial.conf</filename>
</para>
<indexterm zone="bluez bluez-config">
<primary
sortas="e-etc-bluetooth-audio.conf">/etc/bluetooth/audio.conf</primary>
</indexterm>
<indexterm zone="bluez bluez-config">
<primary
sortas="e-etc-bluetooth-input.conf">/etc/bluetooth/input.conf</primary>
</indexterm>
<indexterm zone="bluez bluez-config">
<primary
sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
</indexterm>
<indexterm zone="bluez bluez-config">
<primary
sortas="e-etc-bluetooth-network.conf">/etc/bluetooth/network.conf</primary>
</indexterm>
<indexterm zone="bluez bluez-config">
<primary
sortas="e-etc-bluetooth-rfcomm.conf">/etc/bluetooth/rfcomm.conf</primary>
</indexterm>
<indexterm zone="bluez bluez-config">
<primary
sortas="e-etc-bluetooth-serial.conf">/etc/bluetooth/serial.conf</primary>
</indexterm>
</sect3>
<sect3 id="bluez-init">
<title>Boot Script</title>
<para>
To automatically start the <command>bluetoothd</command> daemon when the
system is rebooted, install the
<filename>/etc/rc.d/init.d/bluetooth</filename> bootscript from the
<xref linkend="bootscripts"/> package.
</para>
<indexterm zone="bluez bluez-init">
<primary sortas="f-bluetooth">bluetooth</primary>
</indexterm>
<screen role="root"><userinput>make install-bluetooth</userinput></screen>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>
bccmd, bluetoothd, ciptool, dfutool, dund, gatttool,
hciattach, hciconfig, hcitool, hid2hci, hidd, l2ping,
pand, rfcomm, and sdptool
</seg>
<seg>
libbluetooth.so
</seg>
<seg>
/etc/bluetooth,
/usr/include/bluetooth,
/usr/lib/bluetooth,
/usr/share/doc/bluez-&bluez-version;, and
/var/lib/bluetooth
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="bccmd">
<term><command>bccmd</command></term>
<listitem>
<para>
is used to issue BlueCore commands to Cambridge Silicon
Radio devices.
</para>
<indexterm zone="bluez bccmd">
<primary sortas="b-bccmd">bccmd</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="bluetoothd">
<term><command>bluetoothd</command></term>
<listitem>
<para>
is the Bluetooth daemon.
</para>
<indexterm zone="bluez bluetoothd">
<primary sortas="b-bluetoothd">bluetoothd</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="ciptool">
<term><command>ciptool</command></term>
<listitem>
<para>
is used to set up, maintain, and inspect the CIP configuration
of the Bluetooth subsystem in the Linux kernel.
</para>
<indexterm zone="bluez ciptool">
<primary sortas="b-ciptool">ciptool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="dfutool">
<term><command>dfutool</command></term>
<listitem>
<para>
is used to verify, archive and upgrade firmware files.
</para>
<indexterm zone="bluez dfutool">
<primary sortas="b-dfutool">dfutool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="dund">
<term><command>dund</command></term>
<listitem>
<para>
is the Bluetooth dial-up networking daemon.
</para>
<indexterm zone="bluez dund">
<primary sortas="b-dund">dund</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="hciattach">
<term><command>hciattach</command></term>
<listitem>
<para>
is used to attach a serial UART to the Bluetooth stack
as HCI transport interface.
</para>
<indexterm zone="bluez hciattach">
<primary sortas="b-hciattach">hciattach</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="hciconfig">
<term><command>hciconfig</command></term>
<listitem>
<para>
is used to configure Bluetooth devices.
</para>
<indexterm zone="bluez hciconfig">
<primary sortas="b-hciconfig">hciconfig</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="hcitool">
<term><command>hcitool</command></term>
<listitem>
<para>
is used to configure Bluetooth connections and send some
special command to Bluetooth devices.
</para>
<indexterm zone="bluez hcitool">
<primary sortas="b-hcitool">hcitool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="hid2hci">
<term><command>hid2hci</command></term>
<listitem>
<para>
is used to set up switch supported Bluetooth devices into
the HCI mode and back.
</para>
<indexterm zone="bluez hid2hci">
<primary sortas="b-hid2hci">hid2hci</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="hidd">
<term><command>hidd</command></term>
<listitem>
<para>
is the Bluetooth HID daemon.
</para>
<indexterm zone="bluez hidd">
<primary sortas="b-hidd">hidd</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="l2ping">
<term><command>l2ping</command></term>
<listitem>
<para>
is used to send a L2CAP echo request to the Bluetooth MAC
address given in dotted hex notation.
</para>
<indexterm zone="bluez l2ping">
<primary sortas="b-l2ping">l2ping</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="pand">
<term><command>pand</command></term>
<listitem>
<para>
is the Bluetooth daemon that allows you to connect to
ethernet networks using Bluetooth.
</para>
<indexterm zone="bluez pand">
<primary sortas="b-pand">pand</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="rfcomm">
<term><command>rfcomm</command></term>
<listitem>
<para>
is used to set up, maintain, and inspect the RFCOMM
configuration of the Bluetooth subsystem in the
Linux kernel.
</para>
<indexterm zone="bluez rfcomm">
<primary sortas="b-rfcomm">rfcomm</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="sdptool">
<term><command>sdptool</command></term>
<listitem>
<para>
is used to perform SDP queries on Bluetooth devices.
</para>
<indexterm zone="bluez sdptool">
<primary sortas="b-sdptool">sdptool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libbluetooth">
<term><filename class="libraryfile">libbluetooth.so</filename></term>
<listitem>
<para>
contains the <application>BlueZ</application> API functions.
</para>
<indexterm zone="bluez libbluetooth">
<primary sortas="c-libbluetooth">libbluetooth.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>