1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
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 usbutils-download-http "http://ftp.kernel.org/pub/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
|
---|
8 | <!ENTITY usbutils-download-ftp "ftp://ftp.kernel.org/pub/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
|
---|
9 | <!ENTITY usbutils-md5sum "c9aa14ee3d6c991fda183f42cf72a8a8">
|
---|
10 | <!ENTITY usbutils-size "400 KB">
|
---|
11 | <!ENTITY usbutils-buildsize "6.0 MB">
|
---|
12 | <!ENTITY usbutils-time "0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="usbutils" xreflabel="usbutils-&usbutils-version;">
|
---|
16 | <?dbhtml filename="usbutils.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>usbutils-&usbutils-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="usbutils">
|
---|
26 | <primary sortas="a-usbutils">usbutils</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to USB Utils</title>
|
---|
31 |
|
---|
32 | <para>
|
---|
33 | The <application>USB Utils</application> package contains an utility
|
---|
34 | used to display information about USB buses in the system and the
|
---|
35 | devices connected to them.
|
---|
36 | </para>
|
---|
37 |
|
---|
38 | &lfs73_checked;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (HTTP): <ulink url="&usbutils-download-http;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download (FTP): <ulink url="&usbutils-download-ftp;"/>
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download MD5 sum: &usbutils-md5sum;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download size: &usbutils-size;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated disk space required: &usbutils-buildsize;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Estimated build time: &usbutils-time;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">USB Utils Dependencies</bridgehead>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
77 | <para role="required">
|
---|
78 | <xref linkend="libusb"/> and
|
---|
79 | <xref linkend="pkgconfig"/>
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | <para condition="html" role="usernotes">User Notes:
|
---|
83 | <ulink url="&blfs-wiki;/usbutils"/>
|
---|
84 | </para>
|
---|
85 | </sect2>
|
---|
86 |
|
---|
87 | <sect2 role="installation">
|
---|
88 | <title>Installation of USB Utils</title>
|
---|
89 |
|
---|
90 | <para>
|
---|
91 | Install <application>USB Utils</application> by
|
---|
92 | running the following commands:
|
---|
93 | </para>
|
---|
94 |
|
---|
95 | <screen><userinput>./configure --prefix=/usr \
|
---|
96 | --datadir=/usr/share/misc \
|
---|
97 | --disable-zlib &&
|
---|
98 | make</userinput></screen>
|
---|
99 |
|
---|
100 | <para>
|
---|
101 | This package does not come with a test suite.
|
---|
102 | </para>
|
---|
103 |
|
---|
104 | <para>
|
---|
105 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
106 | </para>
|
---|
107 |
|
---|
108 | <screen role="root"><userinput>make install &&
|
---|
109 | mv -v /usr/sbin/update-usbids.sh /usr/sbin/update-usbids</userinput></screen>
|
---|
110 |
|
---|
111 | </sect2>
|
---|
112 |
|
---|
113 | <sect2 role="commands">
|
---|
114 | <title>Command Explanations</title>
|
---|
115 |
|
---|
116 | <para>
|
---|
117 | <option>--disable-zlib</option>: This stops
|
---|
118 | <application>USB Utils</application> from installing a
|
---|
119 | compressed <filename>usb.ids</filename> alongside the
|
---|
120 | uncompressed one.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | </sect2>
|
---|
124 |
|
---|
125 | <sect2 role="configuration">
|
---|
126 | <title>Configuring USB Utils</title>
|
---|
127 |
|
---|
128 | <para>
|
---|
129 | The <filename>usb.ids</filename> data file is constantly being
|
---|
130 | updated. To get a current version of this file, run
|
---|
131 | <command>update-usbids</command> as the <systemitem
|
---|
132 | class="username">root</systemitem> user. This program requires the
|
---|
133 | <xref linkend="which"/> script or program to find <xref linkend="lynx"/>
|
---|
134 | or <xref linkend="wget"/> which are used to download the most current file,
|
---|
135 | and replace the existing file in
|
---|
136 | <filename class="directory">/usr/share/misc</filename>.
|
---|
137 | </para>
|
---|
138 |
|
---|
139 | <para>
|
---|
140 | You may wish to add an entry to
|
---|
141 | <systemitem class="username">root</systemitem>'s (or any other user who has
|
---|
142 | write privilege to <filename class="directory">/usr/share/misc</filename>)
|
---|
143 | crontab to automatically update the <filename>usb.ids</filename> file
|
---|
144 | periodically.
|
---|
145 | </para>
|
---|
146 |
|
---|
147 | </sect2>
|
---|
148 |
|
---|
149 | <sect2 role="content">
|
---|
150 | <title>Contents</title>
|
---|
151 |
|
---|
152 | <segmentedlist>
|
---|
153 | <segtitle>Installed Programs</segtitle>
|
---|
154 | <segtitle>Installed Libraries</segtitle>
|
---|
155 | <segtitle>Installed Directories</segtitle>
|
---|
156 |
|
---|
157 | <seglistitem>
|
---|
158 | <seg>
|
---|
159 | lsusb, update-usbids, usb-devices and usbhid-dump
|
---|
160 | </seg>
|
---|
161 | <seg>
|
---|
162 | None
|
---|
163 | </seg>
|
---|
164 | <seg>
|
---|
165 | None
|
---|
166 | </seg>
|
---|
167 | </seglistitem>
|
---|
168 | </segmentedlist>
|
---|
169 |
|
---|
170 | <variablelist>
|
---|
171 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
172 | <?dbfo list-presentation="list"?>
|
---|
173 | <?dbhtml list-presentation="table"?>
|
---|
174 |
|
---|
175 | <varlistentry id="lsusb">
|
---|
176 | <term><command>lsusb</command></term>
|
---|
177 | <listitem>
|
---|
178 | <para>
|
---|
179 | is an utility for displaying information about all USB buses
|
---|
180 | in the system and all devices connected to them.
|
---|
181 | </para>
|
---|
182 | <indexterm zone="usbutils lsusb">
|
---|
183 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
184 | </indexterm>
|
---|
185 | </listitem>
|
---|
186 | </varlistentry>
|
---|
187 |
|
---|
188 | <varlistentry id="update-usbids">
|
---|
189 | <term><command>update-usbids</command></term>
|
---|
190 | <listitem>
|
---|
191 | <para>
|
---|
192 | downloads the current version of the USB ID list. Requires
|
---|
193 | <xref linkend="lynx"/> or <xref linkend="wget"/>.
|
---|
194 | </para>
|
---|
195 | <indexterm zone="usbutils update-usbids">
|
---|
196 | <primary sortas="b-update-usbids">update-usbids</primary>
|
---|
197 | </indexterm>
|
---|
198 | </listitem>
|
---|
199 | </varlistentry>
|
---|
200 |
|
---|
201 | <varlistentry id="usb-devices">
|
---|
202 | <term><command>usb-devices</command></term>
|
---|
203 | <listitem>
|
---|
204 | <para>
|
---|
205 | is a shell script that displays details of USB buses and devices
|
---|
206 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
207 | is not available on your system.
|
---|
208 | </para>
|
---|
209 | <indexterm zone="usbutils usb-devices">
|
---|
210 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
211 | </indexterm>
|
---|
212 | </listitem>
|
---|
213 | </varlistentry>
|
---|
214 |
|
---|
215 | <varlistentry id="usbhid-dump">
|
---|
216 | <term><command>usbhid-dump</command></term>
|
---|
217 | <listitem>
|
---|
218 | <para>
|
---|
219 | is used to dump report descriptors and streams from HID
|
---|
220 | (human interface device) interfaces of USB devices.
|
---|
221 | </para>
|
---|
222 | <indexterm zone="usbutils usbhid-dump">
|
---|
223 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
224 | </indexterm>
|
---|
225 | </listitem>
|
---|
226 | </varlistentry>
|
---|
227 |
|
---|
228 | </variablelist>
|
---|
229 |
|
---|
230 | </sect2>
|
---|
231 |
|
---|
232 | </sect1>
|
---|