[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[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 " ">
|
---|
[0ef09874] | 9 | <!ENTITY libusb-md5sum "1fb61afe370e94f902a67e03eb39c51f">
|
---|
| 10 | <!ENTITY libusb-size "632 KB">
|
---|
| 11 | <!ENTITY libusb-buildsize "5.7 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 |
|
---|
[aa996df1] | 33 | &lfs122_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 |
|
---|
[e7cd19a] | 78 | <sect2 role="kernel">
|
---|
| 79 | <title>Configuring Libusb</title>
|
---|
| 80 |
|
---|
| 81 | <para id="libusb-kernel">
|
---|
| 82 | To access raw USB devices (those not treated as a disk by the mass-storage
|
---|
| 83 | driver), appropriate support must be available in the kernel. Check your
|
---|
| 84 | kernel configuration:
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 88 | href="libusb-kernel.xml"/>
|
---|
| 89 |
|
---|
| 90 | <indexterm zone="libusb libusb-kernel">
|
---|
| 91 | <primary sortas="d-USB-device-filesystem">Support for Host-side USB</primary>
|
---|
| 92 | </indexterm>
|
---|
| 93 |
|
---|
| 94 | <para>
|
---|
| 95 | For more details on setting up USB devices, see <xref
|
---|
| 96 | linkend="usb-device-issues"/>.
|
---|
| 97 | </para>
|
---|
| 98 | </sect2>
|
---|
| 99 |
|
---|
[fc3e01f] | 100 | <sect2 role="installation">
|
---|
[1f3b7a7] | 101 | <title>Installation of libusb</title>
|
---|
[fc3e01f] | 102 |
|
---|
[bb30c5b] | 103 | <para>
|
---|
| 104 | Install <application>libusb</application> by running the following
|
---|
| 105 | commands:
|
---|
| 106 | </para>
|
---|
[fc3e01f] | 107 |
|
---|
[6aa48d38] | 108 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
| 109 | make</userinput></screen>
|
---|
[fc3e01f] | 110 |
|
---|
[bb30c5b] | 111 | <para>
|
---|
| 112 | If <application>Doxygen</application> is installed and you wish to
|
---|
[5155c4d] | 113 | build the API documentation, issue the following commands:
|
---|
[bb30c5b] | 114 | </para>
|
---|
[fc3e01f] | 115 |
|
---|
[5155c4d] | 116 | <screen remap="doc"><userinput>pushd doc &&
|
---|
| 117 | doxygen -u doxygen.cfg &&
|
---|
| 118 | make docs &&
|
---|
| 119 | popd</userinput></screen>
|
---|
[4c3474fe] | 120 |
|
---|
[bb30c5b] | 121 | <para>
|
---|
| 122 | This package does not come with a test suite.
|
---|
| 123 | </para>
|
---|
[1f3b7a7] | 124 |
|
---|
[bb30c5b] | 125 | <para>
|
---|
| 126 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 127 | </para>
|
---|
[4c3474fe] | 128 |
|
---|
[fc3e01f] | 129 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 130 |
|
---|
[bb30c5b] | 131 | <para>
|
---|
| 132 | If you built the API documentation, install it using the following
|
---|
| 133 | commands as the <systemitem class="username">root</systemitem> user:
|
---|
| 134 | </para>
|
---|
[fc3e01f] | 135 |
|
---|
[a42c273] | 136 | <screen role="root"
|
---|
| 137 | remap="doc"><userinput>install -v -d -m755 /usr/share/doc/libusb-&libusb-version;/apidocs &&
|
---|
[370e9ba] | 138 | install -v -m644 doc/api-1.0/* \
|
---|
[d6fd371] | 139 | /usr/share/doc/libusb-&libusb-version;/apidocs</userinput></screen>
|
---|
[4c3474fe] | 140 |
|
---|
[fc3e01f] | 141 | </sect2>
|
---|
[5155c4d] | 142 | <!--
|
---|
[0172b27] | 143 | <sect2 role="commands">
|
---|
| 144 | <title>Command Explanations</title>
|
---|
| 145 |
|
---|
| 146 | <para>
|
---|
[8558044] | 147 | <command>sed -i ...</command>: This sed prevents some warnings when
|
---|
[0172b27] | 148 | building the documentation.
|
---|
| 149 | </para>
|
---|
| 150 | </sect2>
|
---|
[5155c4d] | 151 | -->
|
---|
[fc3e01f] | 152 | <sect2 role="content">
|
---|
| 153 | <title>Contents</title>
|
---|
| 154 |
|
---|
| 155 | <segmentedlist>
|
---|
[c3c56b2] | 156 | <segtitle>Installed Programs</segtitle>
|
---|
[aff3caf0] | 157 | <segtitle>Installed Library</segtitle>
|
---|
[4ee3a30] | 158 | <segtitle>Installed Directories</segtitle>
|
---|
[4c3474fe] | 159 |
|
---|
[fc3e01f] | 160 | <seglistitem>
|
---|
[c3c56b2] | 161 | <seg>
|
---|
| 162 | None
|
---|
| 163 | </seg>
|
---|
[bb30c5b] | 164 | <seg>
|
---|
| 165 | libusb-1.0.so
|
---|
| 166 | </seg>
|
---|
| 167 | <seg>
|
---|
| 168 | /usr/include/libusb-1.0 and
|
---|
| 169 | /usr/share/doc/libusb-&libusb-version;
|
---|
| 170 | </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">
|
---|
[4c24eb0a] | 180 | <term><filename class="libraryfile">libusb-1.0.so</filename></term>
|
---|
[fc3e01f] | 181 | <listitem>
|
---|
[bb30c5b] | 182 | <para>
|
---|
[4c24eb0a] | 183 | contains API functions used for accessing USB hardware
|
---|
[bb30c5b] | 184 | </para>
|
---|
[fc3e01f] | 185 | <indexterm zone="libusb libusb-lib">
|
---|
[bb30c5b] | 186 | <primary sortas="c-libusb">libusb-1.0.so</primary>
|
---|
[fc3e01f] | 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
[4c3474fe] | 190 |
|
---|
[fc3e01f] | 191 | </variablelist>
|
---|
| 192 |
|
---|
| 193 | </sect2>
|
---|
[bdf5806e] | 194 |
|
---|
| 195 | </sect1>
|
---|