[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 |
|
---|
[51718d1] | 7 | <!ENTITY libusb-download-http "https://github.com/libusb/libusb/releases/download/v&libusb-version;/libusb-&libusb-version;.tar.bz2">
|
---|
[bb30c5b] | 8 | <!ENTITY libusb-download-ftp " ">
|
---|
[5155c4d] | 9 | <!ENTITY libusb-md5sum "9c75660dfe1d659387c37b28c91e3160">
|
---|
| 10 | <!ENTITY libusb-size "608 KB">
|
---|
| 11 | <!ENTITY libusb-buildsize "5.8 MB">
|
---|
[0172b27] | 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 |
|
---|
| 18 |
|
---|
[1f3b7a7] | 19 | <title>libusb-&libusb-version;</title>
|
---|
[4c3474fe] | 20 |
|
---|
[fc3e01f] | 21 | <indexterm zone="libusb">
|
---|
[bb30c5b] | 22 | <primary sortas="a-libusb">libusb</primary>
|
---|
[fc3e01f] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[1f3b7a7] | 26 | <title>Introduction to libusb</title>
|
---|
[4c3474fe] | 27 |
|
---|
[bb30c5b] | 28 | <para>
|
---|
| 29 | The <application>libusb</application> package contains a library
|
---|
| 30 | used by some applications for USB device access.
|
---|
| 31 | </para>
|
---|
[4c3474fe] | 32 |
|
---|
[15445ab] | 33 | &lfs113_checked;
|
---|
[8c15e4c] | 34 |
|
---|
[fc3e01f] | 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
[bb30c5b] | 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&libusb-download-http;"/>
|
---|
| 40 | </para>
|
---|
[fc3e01f] | 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
[bb30c5b] | 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&libusb-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
[fc3e01f] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[bb30c5b] | 48 | <para>
|
---|
| 49 | Download MD5 sum: &libusb-md5sum;
|
---|
| 50 | </para>
|
---|
[fc3e01f] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[bb30c5b] | 53 | <para>
|
---|
| 54 | Download size: &libusb-size;
|
---|
| 55 | </para>
|
---|
[fc3e01f] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[bb30c5b] | 58 | <para>
|
---|
| 59 | Estimated disk space required: &libusb-buildsize;
|
---|
| 60 | </para>
|
---|
[fc3e01f] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[bb30c5b] | 63 | <para>
|
---|
| 64 | Estimated build time: &libusb-time;
|
---|
| 65 | </para>
|
---|
[fc3e01f] | 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
[4c3474fe] | 68 |
|
---|
[1f3b7a7] | 69 | <bridgehead renderas="sect3">libusb Dependencies</bridgehead>
|
---|
[4c3474fe] | 70 |
|
---|
[bb30c5b] | 71 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 72 | <para role="optional">
|
---|
| 73 | <xref linkend="doxygen"/>
|
---|
| 74 | </para>
|
---|
[4c3474fe] | 75 |
|
---|
[fc3e01f] | 76 | </sect2>
|
---|
[4c3474fe] | 77 |
|
---|
[fc3e01f] | 78 | <sect2 role="installation">
|
---|
[1f3b7a7] | 79 | <title>Installation of libusb</title>
|
---|
[fc3e01f] | 80 |
|
---|
[bb30c5b] | 81 | <para>
|
---|
| 82 | Install <application>libusb</application> by running the following
|
---|
| 83 | commands:
|
---|
| 84 | </para>
|
---|
[fc3e01f] | 85 |
|
---|
[6aa48d38] | 86 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
| 87 | make</userinput></screen>
|
---|
[fc3e01f] | 88 |
|
---|
[bb30c5b] | 89 | <para>
|
---|
| 90 | If <application>Doxygen</application> is installed and you wish to
|
---|
[5155c4d] | 91 | build the API documentation, issue the following commands:
|
---|
[bb30c5b] | 92 | </para>
|
---|
[fc3e01f] | 93 |
|
---|
[5155c4d] | 94 | <screen remap="doc"><userinput>pushd doc &&
|
---|
| 95 | doxygen -u doxygen.cfg &&
|
---|
| 96 | make docs &&
|
---|
| 97 | popd</userinput></screen>
|
---|
[4c3474fe] | 98 |
|
---|
[bb30c5b] | 99 | <para>
|
---|
| 100 | This package does not come with a test suite.
|
---|
| 101 | </para>
|
---|
[1f3b7a7] | 102 |
|
---|
[bb30c5b] | 103 | <para>
|
---|
| 104 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 105 | </para>
|
---|
[4c3474fe] | 106 |
|
---|
[fc3e01f] | 107 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 108 |
|
---|
[bb30c5b] | 109 | <para>
|
---|
| 110 | If you built the API documentation, install it using the following
|
---|
| 111 | commands as the <systemitem class="username">root</systemitem> user:
|
---|
| 112 | </para>
|
---|
[fc3e01f] | 113 |
|
---|
[a42c273] | 114 | <screen role="root"
|
---|
| 115 | remap="doc"><userinput>install -v -d -m755 /usr/share/doc/libusb-&libusb-version;/apidocs &&
|
---|
[370e9ba] | 116 | install -v -m644 doc/api-1.0/* \
|
---|
[d6fd371] | 117 | /usr/share/doc/libusb-&libusb-version;/apidocs</userinput></screen>
|
---|
[4c3474fe] | 118 |
|
---|
[fc3e01f] | 119 | </sect2>
|
---|
[5155c4d] | 120 | <!--
|
---|
[0172b27] | 121 | <sect2 role="commands">
|
---|
| 122 | <title>Command Explanations</title>
|
---|
| 123 |
|
---|
| 124 | <para>
|
---|
[8558044] | 125 | <command>sed -i ...</command>: This sed prevents some warnings when
|
---|
[0172b27] | 126 | building the documentation.
|
---|
| 127 | </para>
|
---|
| 128 | </sect2>
|
---|
[5155c4d] | 129 | -->
|
---|
[fc3e01f] | 130 | <sect2 role="configuration">
|
---|
| 131 | <title>Configuring Libusb</title>
|
---|
| 132 |
|
---|
[bb30c5b] | 133 | <para id="libusb-kernel">
|
---|
| 134 | To access raw USB devices (those not treated as a disk by the mass-storage
|
---|
| 135 | driver), appropriate support must be available in the kernel. Check your
|
---|
[38155d1] | 136 | kernel configuration:
|
---|
[bb30c5b] | 137 | </para>
|
---|
[9f12e36] | 138 |
|
---|
[38155d1] | 139 | <screen><literal>Device Drivers --->
|
---|
| 140 | [*] USB support ---> [CONFIG_USB_SUPPORT]
|
---|
| 141 | <*/M> Support for Host-side USB [CONFIG_USB]
|
---|
| 142 | (Select any USB hardware device drivers you may need on the same page)</literal></screen>
|
---|
| 143 |
|
---|
[fc3e01f] | 144 | <indexterm zone="libusb libusb-kernel">
|
---|
[bb30c5b] | 145 | <primary sortas="d-USB-device-filesystem">Support for Host-side USB</primary>
|
---|
[fc3e01f] | 146 | </indexterm>
|
---|
[9f12e36] | 147 |
|
---|
[bb30c5b] | 148 | <para>
|
---|
| 149 | For more details on setting up USB devices, see <xref
|
---|
| 150 | linkend="usb-device-issues"/>.
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
[fc3e01f] | 153 | </sect2>
|
---|
[4c3474fe] | 154 |
|
---|
[fc3e01f] | 155 | <sect2 role="content">
|
---|
| 156 | <title>Contents</title>
|
---|
| 157 |
|
---|
| 158 | <segmentedlist>
|
---|
[c3c56b2] | 159 | <segtitle>Installed Programs</segtitle>
|
---|
[aff3caf0] | 160 | <segtitle>Installed Library</segtitle>
|
---|
[4ee3a30] | 161 | <segtitle>Installed Directories</segtitle>
|
---|
[4c3474fe] | 162 |
|
---|
[fc3e01f] | 163 | <seglistitem>
|
---|
[c3c56b2] | 164 | <seg>
|
---|
| 165 | None
|
---|
| 166 | </seg>
|
---|
[bb30c5b] | 167 | <seg>
|
---|
| 168 | libusb-1.0.so
|
---|
| 169 | </seg>
|
---|
| 170 | <seg>
|
---|
| 171 | /usr/include/libusb-1.0 and
|
---|
| 172 | /usr/share/doc/libusb-&libusb-version;
|
---|
| 173 | </seg>
|
---|
[fc3e01f] | 174 | </seglistitem>
|
---|
| 175 | </segmentedlist>
|
---|
[4c3474fe] | 176 |
|
---|
[fc3e01f] | 177 | <variablelist>
|
---|
| 178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 179 | <?dbfo list-presentation="list"?>
|
---|
| 180 | <?dbhtml list-presentation="table"?>
|
---|
[4c3474fe] | 181 |
|
---|
[fc3e01f] | 182 | <varlistentry id="libusb-lib">
|
---|
[4c24eb0a] | 183 | <term><filename class="libraryfile">libusb-1.0.so</filename></term>
|
---|
[fc3e01f] | 184 | <listitem>
|
---|
[bb30c5b] | 185 | <para>
|
---|
[4c24eb0a] | 186 | contains API functions used for accessing USB hardware
|
---|
[bb30c5b] | 187 | </para>
|
---|
[fc3e01f] | 188 | <indexterm zone="libusb libusb-lib">
|
---|
[bb30c5b] | 189 | <primary sortas="c-libusb">libusb-1.0.so</primary>
|
---|
[fc3e01f] | 190 | </indexterm>
|
---|
| 191 | </listitem>
|
---|
| 192 | </varlistentry>
|
---|
[4c3474fe] | 193 |
|
---|
[fc3e01f] | 194 | </variablelist>
|
---|
| 195 |
|
---|
| 196 | </sect2>
|
---|
[bdf5806e] | 197 |
|
---|
| 198 | </sect1>
|
---|