glfs/general/genlib/libusb.xml
Randy McMurchy e95131de34 Updated to libusb-1.0.8
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@8778 af4574ff-66df-0310-9fd7-8a98e5e911e0
2011-01-05 01:46:39 +00:00

191 lines
6.8 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 libusb-download-http "&sourceforge-repo;/libusb/libusb-&libusb-version;.tar.bz2">
<!ENTITY libusb-download-ftp "&sources-anduin-ftp;/l/libusb-&libusb-version;.tar.bz2">
<!ENTITY libusb-md5sum "37d34e6eaa69a4b645a19ff4ca63ceef">
<!ENTITY libusb-size "331 KB">
<!ENTITY libusb-buildsize "5 MB">
<!ENTITY libusb-time "less than 0.1 SBU">
]>
<sect1 id="libusb" xreflabel="libusb-&libusb-version;">
<?dbhtml filename="libusb.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>libusb-&libusb-version;</title>
<indexterm zone="libusb">
<primary sortas="a-Libusb">Libusb</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to libusb</title>
<para>The <application>libusb</application> package contains a library
used by some applications for USB device access.</para>
&lfs65_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&libusb-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&libusb-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &libusb-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &libusb-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &libusb-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &libusb-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">libusb Dependencies</bridgehead>
<bridgehead renderas="sect4">Optional
(Required to Build the API Documentation)</bridgehead>
<para role="optional"><xref linkend="doxygen"/></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/libusb"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of libusb</title>
<para>Install <application>libusb</application> by running the following
commands:</para>
<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>
<para>If <application>Doxygen</application> is installed and you wish to
build the API documentation, issue the following command:</para>
<screen><userinput>make -C doc docs</userinput></screen> <!-- tested with doxygen -->
<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>If you built the API documentation, install it using the following
commands as the <systemitem class="username">root</systemitem> user:</para>
<screen role="root"><userinput>install -v -d -m755 /usr/share/doc/libusb-&libusb-version;/apidocs &amp;&amp;
install -v -m644 doc/html/* \
/usr/share/doc/libusb-&libusb-version;/apidocs</userinput></screen>
</sect2>
<sect2 role="configuration">
<title>Configuring Libusb</title>
<!--
<para><application>libusb</application> requires the
<systemitem class="filesystem">usbfs</systemitem> kernel filesystem
to be mounted on <filename class="directory">/proc/bus/usb</filename>.
Applications require the files in this directory to be accessible to the user,
sometimes for both reading and writing. To restrict access to USB devices,
ensure the <systemitem class="filesystem">usb</systemitem> group exits
on your system. If necessary, create the <systemitem
class="filesystem">usb</systemitem> group using the following command:</para>
<screen role='root'><userinput>groupadd -g 14 usb</userinput></screen>
-->
<para id="libusb-kernel">To access raw USB devices (those not treated as a
disk by the mass-storage driver), appropriate support must be available in
the kernel. Check your kernel configuration for Device Drivers &rArr; USB
support &rArr; Support for Host-side USB. Select any USB hardware device
drivers you may need on the same page.</para>
<indexterm zone="libusb libusb-kernel">
<primary sortas="d-USB-device-filesystem">Support for Host-side USB</primary>
</indexterm>
<para>For more details on setting up USB devices, see <xref
linkend="usb-device-issues"/>. </para>
<!--
<para>Fine-tuning of permissions is also possible by creating extra rules,
matching on something like this (on one line). The vendor and product can
be found by searching the <filename
class='directory'>/sys/devices</filename> directory entries or using
<command>udevinfo</command> after the device has been attached. See the
documentation in the current udev directory of <filename
class='directory'>/usr/share/doc></filename> for details.</para>
<screen><literal>SUBSYSTEM=="usb_device", SYSFS{idVendor}=="05d8",
SYSFS{idProduct}=="4002", GROUP:="scanner"</literal></screen>
<para>Some older applications, such as <application>VMware</application>,
need the following deprecated entry in the <filename>/etc/fstab</filename>
file. This is not normally needed.</para>
<screen><literal>usbfs /proc/bus/usb usbfs devgid=14,devmode=0660 0 0</literal></screen>
-->
<!--
<para>Add any users that need to access raw USB devices to the
<systemitem class="groupname">usb</systemitem> group.</para>
<screen role="root"><userinput>usermod -a -G usb <replaceable>&lt;username&gt;</replaceable></userinput></screen>
-->
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>None</seg>
<seg>libusb-1.0.{so,a}</seg>
<seg>/usr/include/libusb-1.0 and
/usr/share/doc/libusb-&libusb-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="libusb-lib">
<term><filename class='libraryfile'>libusb-1.0.{so,a}</filename></term>
<listitem>
<para> libraries contain C functions for accessing
USB hardware.</para>
<indexterm zone="libusb libusb-lib">
<primary sortas="c-libusb">libusb-1.0.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>