[52d29f7] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[52d29f7] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[6d0910f1] | 7 | <!ENTITY libusb-download-http "&sources-anduin-http;/l/libusb-&libusb-version;.tar.bz2">
|
---|
| 8 | <!ENTITY libusb-download-ftp "&sources-anduin-ftp;/l/libusb-&libusb-version;.tar.bz2">
|
---|
[4ee3a30] | 9 | <!ENTITY libusb-md5sum "df2447c23750ef2b4a314200feacc2ee">
|
---|
| 10 | <!ENTITY libusb-size "304 KB">
|
---|
| 11 | <!ENTITY libusb-buildsize "3.3 MB">
|
---|
| 12 | <!ENTITY libusb-time "less than 0.1 SBU">
|
---|
[52d29f7] | 13 | ]>
|
---|
| 14 |
|
---|
[bdf5806e] | 15 | <sect1 id="libusb" xreflabel="libusb-&libusb-version;">
|
---|
[fc3e01f] | 16 | <?dbhtml filename="libusb.html"?>
|
---|
[4c3474fe] | 17 |
|
---|
[fc3e01f] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[4c3474fe] | 22 |
|
---|
[1f3b7a7] | 23 | <title>libusb-&libusb-version;</title>
|
---|
[4c3474fe] | 24 |
|
---|
[fc3e01f] | 25 | <indexterm zone="libusb">
|
---|
| 26 | <primary sortas="a-Libusb">Libusb</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[1f3b7a7] | 30 | <title>Introduction to libusb</title>
|
---|
[4c3474fe] | 31 |
|
---|
[fc3e01f] | 32 | <para>The <application>libusb</application> package contains a library
|
---|
| 33 | used by some applications for USB device access.</para>
|
---|
[4c3474fe] | 34 |
|
---|
[fc3e01f] | 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>Download (HTTP): <ulink url="&libusb-download-http;"/></para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>Download (FTP): <ulink url="&libusb-download-ftp;"/></para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download MD5 sum: &libusb-md5sum;</para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download size: &libusb-size;</para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Estimated disk space required: &libusb-buildsize;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Estimated build time: &libusb-time;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | </itemizedlist>
|
---|
[4c3474fe] | 56 |
|
---|
[1f3b7a7] | 57 | <bridgehead renderas="sect3">libusb Dependencies</bridgehead>
|
---|
[4c3474fe] | 58 |
|
---|
[de49ebd] | 59 | <bridgehead renderas="sect4">Optional
|
---|
| 60 | (Required to Build the API Documentation)</bridgehead>
|
---|
[4ee3a30] | 61 | <para role="optional"><xref linkend="doxygen"/></para>
|
---|
[4c3474fe] | 62 |
|
---|
[1039de3] | 63 | <para condition="html" role="usernotes">User Notes:
|
---|
| 64 | <ulink url="&blfs-wiki;/libusb"/></para>
|
---|
| 65 |
|
---|
[fc3e01f] | 66 | </sect2>
|
---|
[4c3474fe] | 67 |
|
---|
[fc3e01f] | 68 | <sect2 role="installation">
|
---|
[1f3b7a7] | 69 | <title>Installation of libusb</title>
|
---|
[fc3e01f] | 70 |
|
---|
[74390482] | 71 | <para>Install <application>libusb</application> by running the following
|
---|
[fc3e01f] | 72 | commands:</para>
|
---|
| 73 |
|
---|
[4ee3a30] | 74 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[fc3e01f] | 75 | make</userinput></screen>
|
---|
| 76 |
|
---|
[1f3b7a7] | 77 | <para>If you wish to build the API documentation (see the required
|
---|
| 78 | dependencies), issue the following command:</para>
|
---|
[fc3e01f] | 79 |
|
---|
[4ee3a30] | 80 | <screen><userinput>cd doc &&
|
---|
| 81 | make docs &&
|
---|
| 82 | cd ..</userinput></screen>
|
---|
[4c3474fe] | 83 |
|
---|
[4ee3a30] | 84 | <para>This package does not come with a test suite.</para>
|
---|
[1f3b7a7] | 85 |
|
---|
[fc3e01f] | 86 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[4c3474fe] | 87 |
|
---|
[fc3e01f] | 88 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 89 |
|
---|
[1f3b7a7] | 90 | <para>If you built the API documentation, install it using the following
|
---|
| 91 | commands as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[fc3e01f] | 92 |
|
---|
| 93 | <screen role="root"><userinput>install -v -d -m755 /usr/share/doc/libusb-&libusb-version;/apidocs &&
|
---|
[4ee3a30] | 94 | install -v -m644 doc/html/* \
|
---|
[4c288b0] | 95 | /usr/share/doc/libusb-&libusb-version;/apidocs</userinput></screen>
|
---|
[4c3474fe] | 96 |
|
---|
[fc3e01f] | 97 | </sect2>
|
---|
[4c3474fe] | 98 |
|
---|
[fc3e01f] | 99 | <sect2 role="configuration">
|
---|
| 100 | <title>Configuring Libusb</title>
|
---|
| 101 |
|
---|
[33ca2b6] | 102 | <!--
|
---|
[74390482] | 103 | <para><application>libusb</application> requires the
|
---|
| 104 | <systemitem class="filesystem">usbfs</systemitem> kernel filesystem
|
---|
| 105 | to be mounted on <filename class="directory">/proc/bus/usb</filename>.
|
---|
| 106 | Applications require the files in this directory to be accessible to the user,
|
---|
| 107 | sometimes for both reading and writing. To restrict access to USB devices,
|
---|
| 108 | ensure the <systemitem class="filesystem">usb</systemitem> group exits
|
---|
| 109 | on your system. If necessary, create the <systemitem
|
---|
[fc3e01f] | 110 | class="filesystem">usb</systemitem> group using the following command:</para>
|
---|
| 111 |
|
---|
| 112 | <screen role='root'><userinput>groupadd -g 14 usb</userinput></screen>
|
---|
[33ca2b6] | 113 | -->
|
---|
[fc3e01f] | 114 |
|
---|
[7bcc1669] | 115 | <para id="libusb-kernel">To access raw USB devices (those not treated as a
|
---|
| 116 | disk by the mass-storage driver), appropriate support must be available in
|
---|
| 117 | the kernel. Check your kernel configuration for Device Drivers ⇒ USB
|
---|
| 118 | support ⇒ Support for Host-side USB. Select any USB hardware device
|
---|
| 119 | drivers you may need on the same page.</para>
|
---|
[9f12e36] | 120 |
|
---|
[fc3e01f] | 121 | <indexterm zone="libusb libusb-kernel">
|
---|
[7bcc1669] | 122 | <primary sortas="d-USB-device-filesystem">Support for Host-side USB</primary>
|
---|
[fc3e01f] | 123 | </indexterm>
|
---|
[9f12e36] | 124 |
|
---|
| 125 | <para>To have raw USB devices set up properly, add the following
|
---|
[3a79861] | 126 | <application>udev</application> rule.</para>
|
---|
[9f12e36] | 127 |
|
---|
[4e4fa01] | 128 | <screen><literal>cat > /etc/udev/rules.d/23-usb.rules << "EOF"
|
---|
[9f12e36] | 129 | # Set group ownership for raw USB devices
|
---|
[3e50349d] | 130 | SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", GROUP="usb"
|
---|
[7bcc1669] | 131 | EOF</literal></screen>
|
---|
| 132 |
|
---|
[e73e361] | 133 | <!--
|
---|
[531886d] | 134 | <para>Fine-tuning of permissions is also possible by creating extra rules,
|
---|
[7bcc1669] | 135 | matching on something like this (on one line). The vendor and product can
|
---|
| 136 | be found by searchng the <filename
|
---|
[531886d] | 137 | class='directory'>/sys/devices</filename> directory entries or using
|
---|
| 138 | <command>udevinfo</command> after the device has been attached. See the
|
---|
| 139 | documentation in the current udev directory of <filename
|
---|
| 140 | class='directory'>/usr/share/doc></filename> for details.</para>
|
---|
[7bcc1669] | 141 |
|
---|
[9f12e36] | 142 | <screen><literal>SUBSYSTEM=="usb_device", SYSFS{idVendor}=="05d8",
|
---|
[7bcc1669] | 143 | SYSFS{idProduct}=="4002", GROUP:="scanner"</literal></screen>
|
---|
| 144 |
|
---|
[531886d] | 145 | <para>Some older applications, such as <application>VMware</application>,
|
---|
| 146 | need the following deprecated entry in the <filename>/etc/fstab</filename>
|
---|
[93b8f83d] | 147 | file. This is not normally needed.</para>
|
---|
[fc3e01f] | 148 |
|
---|
| 149 | <screen><literal>usbfs /proc/bus/usb usbfs devgid=14,devmode=0660 0 0</literal></screen>
|
---|
[e73e361] | 150 | -->
|
---|
[4c3474fe] | 151 |
|
---|
[410e228b] | 152 | <para>Add any users that need to access raw USB devices to the
|
---|
[3a79861] | 153 | <systemitem class="groupname">usb</systemitem> group.</para>
|
---|
[c5923846] | 154 |
|
---|
[3a79861] | 155 | <screen role="root"><userinput>usermod -a -G usb <replaceable><username></replaceable></userinput></screen>
|
---|
| 156 |
|
---|
[fc3e01f] | 157 | </sect2>
|
---|
[4c3474fe] | 158 |
|
---|
[fc3e01f] | 159 | <sect2 role="content">
|
---|
| 160 | <title>Contents</title>
|
---|
| 161 |
|
---|
| 162 | <segmentedlist>
|
---|
| 163 | <segtitle>Installed Program</segtitle>
|
---|
| 164 | <segtitle>Installed Libraries</segtitle>
|
---|
[4ee3a30] | 165 | <segtitle>Installed Directories</segtitle>
|
---|
[4c3474fe] | 166 |
|
---|
[fc3e01f] | 167 | <seglistitem>
|
---|
[4ee3a30] | 168 | <seg>None</seg>
|
---|
| 169 | <seg>libusb-1.0.{so,a}</seg>
|
---|
| 170 | <seg>/usr/include/libusb-1.0 and /usr/share/doc/libusb-&libusb-version;</seg>
|
---|
[fc3e01f] | 171 | </seglistitem>
|
---|
| 172 | </segmentedlist>
|
---|
[4c3474fe] | 173 |
|
---|
[fc3e01f] | 174 | <variablelist>
|
---|
| 175 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 176 | <?dbfo list-presentation="list"?>
|
---|
| 177 | <?dbhtml list-presentation="table"?>
|
---|
[4c3474fe] | 178 |
|
---|
[fc3e01f] | 179 | <varlistentry id="libusb-lib">
|
---|
[1039de3] | 180 | <term><filename class='libraryfile'>libusb.{so,a}</filename></term>
|
---|
[fc3e01f] | 181 | <listitem>
|
---|
[74390482] | 182 | <para> libraries contain C functions for accessing
|
---|
[fc3e01f] | 183 | USB hardware.</para>
|
---|
| 184 | <indexterm zone="libusb libusb-lib">
|
---|
[4ee3a30] | 185 | <primary sortas="c-libusb">libusb-1.0.{so,a}</primary>
|
---|
[fc3e01f] | 186 | </indexterm>
|
---|
| 187 | </listitem>
|
---|
| 188 | </varlistentry>
|
---|
[4c3474fe] | 189 |
|
---|
[fc3e01f] | 190 | </variablelist>
|
---|
| 191 |
|
---|
| 192 | </sect2>
|
---|
[bdf5806e] | 193 |
|
---|
| 194 | </sect1>
|
---|