1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY libusb-download-http "https://github.com/libusb/libusb/releases/download/v&libusb-version;/libusb-&libusb-version;.tar.bz2">
|
---|
8 | <!ENTITY libusb-download-ftp " ">
|
---|
9 | <!ENTITY libusb-md5sum "1fb61afe370e94f902a67e03eb39c51f">
|
---|
10 | <!ENTITY libusb-size "632 KB">
|
---|
11 | <!ENTITY libusb-buildsize "5.7 MB">
|
---|
12 | <!ENTITY libusb-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libusb" xreflabel="libusb-&libusb-version;">
|
---|
16 | <?dbhtml filename="libusb.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>libusb-&libusb-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="libusb">
|
---|
22 | <primary sortas="a-libusb">libusb</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to libusb</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>libusb</application> package contains a library
|
---|
30 | used by some applications for USB device access.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs122_checked;
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>
|
---|
39 | Download (HTTP): <ulink url="&libusb-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&libusb-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &libusb-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &libusb-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &libusb-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &libusb-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect3">libusb Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
72 | <para role="optional">
|
---|
73 | <xref linkend="doxygen"/>
|
---|
74 | </para>
|
---|
75 |
|
---|
76 | </sect2>
|
---|
77 |
|
---|
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 |
|
---|
100 | <sect2 role="installation">
|
---|
101 | <title>Installation of libusb</title>
|
---|
102 |
|
---|
103 | <para>
|
---|
104 | Install <application>libusb</application> by running the following
|
---|
105 | commands:
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
109 | make</userinput></screen>
|
---|
110 |
|
---|
111 | <para>
|
---|
112 | If <application>Doxygen</application> is installed and you wish to
|
---|
113 | build the API documentation, issue the following commands:
|
---|
114 | </para>
|
---|
115 |
|
---|
116 | <screen remap="doc"><userinput>pushd doc &&
|
---|
117 | doxygen -u doxygen.cfg &&
|
---|
118 | make docs &&
|
---|
119 | popd</userinput></screen>
|
---|
120 |
|
---|
121 | <para>
|
---|
122 | This package does not come with a test suite.
|
---|
123 | </para>
|
---|
124 |
|
---|
125 | <para>
|
---|
126 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
127 | </para>
|
---|
128 |
|
---|
129 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
130 |
|
---|
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>
|
---|
135 |
|
---|
136 | <screen role="root"
|
---|
137 | remap="doc"><userinput>install -v -d -m755 /usr/share/doc/libusb-&libusb-version;/apidocs &&
|
---|
138 | install -v -m644 doc/api-1.0/* \
|
---|
139 | /usr/share/doc/libusb-&libusb-version;/apidocs</userinput></screen>
|
---|
140 |
|
---|
141 | </sect2>
|
---|
142 | <!--
|
---|
143 | <sect2 role="commands">
|
---|
144 | <title>Command Explanations</title>
|
---|
145 |
|
---|
146 | <para>
|
---|
147 | <command>sed -i ...</command>: This sed prevents some warnings when
|
---|
148 | building the documentation.
|
---|
149 | </para>
|
---|
150 | </sect2>
|
---|
151 | -->
|
---|
152 | <sect2 role="content">
|
---|
153 | <title>Contents</title>
|
---|
154 |
|
---|
155 | <segmentedlist>
|
---|
156 | <segtitle>Installed Programs</segtitle>
|
---|
157 | <segtitle>Installed Library</segtitle>
|
---|
158 | <segtitle>Installed Directories</segtitle>
|
---|
159 |
|
---|
160 | <seglistitem>
|
---|
161 | <seg>
|
---|
162 | None
|
---|
163 | </seg>
|
---|
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>
|
---|
171 | </seglistitem>
|
---|
172 | </segmentedlist>
|
---|
173 |
|
---|
174 | <variablelist>
|
---|
175 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
176 | <?dbfo list-presentation="list"?>
|
---|
177 | <?dbhtml list-presentation="table"?>
|
---|
178 |
|
---|
179 | <varlistentry id="libusb-lib">
|
---|
180 | <term><filename class="libraryfile">libusb-1.0.so</filename></term>
|
---|
181 | <listitem>
|
---|
182 | <para>
|
---|
183 | contains API functions used for accessing USB hardware
|
---|
184 | </para>
|
---|
185 | <indexterm zone="libusb libusb-lib">
|
---|
186 | <primary sortas="c-libusb">libusb-1.0.so</primary>
|
---|
187 | </indexterm>
|
---|
188 | </listitem>
|
---|
189 | </varlistentry>
|
---|
190 |
|
---|
191 | </variablelist>
|
---|
192 |
|
---|
193 | </sect2>
|
---|
194 |
|
---|
195 | </sect1>
|
---|