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 "https://github.com/gregkh/usbutils/archive/v&usbutils-version;/usbutils-&usbutils-version;.tar.gz">
|
---|
8 | <!ENTITY usbutils-download-ftp " ">
|
---|
9 | <!ENTITY usbutils-md5sum "112eafa991e55229b9f48b90c290a0e2">
|
---|
10 | <!ENTITY usbutils-size "120 KB">
|
---|
11 | <!ENTITY usbutils-buildsize "4.3 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 |
|
---|
19 | <title>usbutils-&usbutils-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="usbutils">
|
---|
22 | <primary sortas="a-usbutils">usbutils</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to USB Utils</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>USB Utils</application> package contains utilities
|
---|
30 | used to display information about USB buses in the system and the
|
---|
31 | devices connected to them.
|
---|
32 | </para>
|
---|
33 |
|
---|
34 | &lfs113_checked;
|
---|
35 |
|
---|
36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
37 | <itemizedlist spacing="compact">
|
---|
38 | <listitem>
|
---|
39 | <para>
|
---|
40 | Download (HTTP): <ulink url="&usbutils-download-http;"/>
|
---|
41 | </para>
|
---|
42 | </listitem>
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (FTP): <ulink url="&usbutils-download-ftp;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download MD5 sum: &usbutils-md5sum;
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download size: &usbutils-size;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Estimated disk space required: &usbutils-buildsize;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated build time: &usbutils-time;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | </itemizedlist>
|
---|
69 | <!--
|
---|
70 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
71 | <itemizedlist spacing="compact">
|
---|
72 | <listitem>
|
---|
73 | <para>
|
---|
74 | Required patch:
|
---|
75 | <ulink url="&patch-root;/usbutils-&usbutils-version;-lsusb_bugfixes-1.patch"/>
|
---|
76 | </para>
|
---|
77 | </listitem>
|
---|
78 | </itemizedlist>
|
---|
79 | -->
|
---|
80 | <bridgehead renderas="sect3">USB Utils Dependencies</bridgehead>
|
---|
81 |
|
---|
82 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
83 | <para role="required">
|
---|
84 | <xref linkend="libusb"/>
|
---|
85 | </para>
|
---|
86 |
|
---|
87 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
88 | <para role="recommended">
|
---|
89 | <!-- git is required by autogen.sh. If using the tarball on kernel.org,
|
---|
90 | autogen.sh does not need to be run. If using the github source,
|
---|
91 | autogen.sh needs to be run, and git is used to pull the usbhid-dump
|
---|
92 | submodule. -->
|
---|
93 | <xref linkend="git"/> and
|
---|
94 | <xref linkend="wget"/>
|
---|
95 | <!-- In the systemd book, a unit/timer is installed to update the
|
---|
96 | usb.ids file automatically. wget is used in the instructions below. -->
|
---|
97 | </para>
|
---|
98 |
|
---|
99 | <para condition="html" role="usernotes">User Notes:
|
---|
100 | <ulink url="&blfs-wiki;/usbutils"/>
|
---|
101 | </para>
|
---|
102 | </sect2>
|
---|
103 |
|
---|
104 | <sect2 role="installation">
|
---|
105 | <title>Installation of USB Utils</title>
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | Install <application>USB Utils</application> by
|
---|
109 | running the following commands:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen><userinput>autoreconf -fiv &&
|
---|
113 |
|
---|
114 | ./configure --prefix=/usr --datadir=/usr/share/hwdata &&
|
---|
115 | make</userinput></screen>
|
---|
116 |
|
---|
117 | <para>
|
---|
118 | This package does not come with a test suite.
|
---|
119 | </para>
|
---|
120 |
|
---|
121 | <para>
|
---|
122 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
123 | </para>
|
---|
124 |
|
---|
125 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
126 |
|
---|
127 | <para>
|
---|
128 | To install the <filename>usb.ids</filename> data file, using
|
---|
129 | <xref linkend="wget"/>, run, as the
|
---|
130 | <systemitem class="username">root</systemitem> user:
|
---|
131 | </para>
|
---|
132 |
|
---|
133 | <screen role="root"><userinput>install -dm755 /usr/share/hwdata/ &&
|
---|
134 | wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</userinput></screen>
|
---|
135 |
|
---|
136 | <para>
|
---|
137 | The script <command>lsusb.py</command> displays information in a more
|
---|
138 | easily readable form than <command>lsusb</command>. To find the options,
|
---|
139 | use <command>lsusb.py -h</command>. One form of use recommended by the
|
---|
140 | developer is <command>lsusb.py -ciu</command>.
|
---|
141 | </para>
|
---|
142 |
|
---|
143 | </sect2>
|
---|
144 | <!-- No longer needed
|
---|
145 | <sect2 role="commands">
|
---|
146 | <title>Command Explanations</title>
|
---|
147 |
|
---|
148 | <para>
|
---|
149 | <command>sed ... lsusb.py</command>: Instructs lsusb.py where to search
|
---|
150 | <filename>usb.ids</filename>.
|
---|
151 | </para>
|
---|
152 |
|
---|
153 | </sect2>
|
---|
154 | -->
|
---|
155 | <sect2 role="configuration">
|
---|
156 | <title>Configuring USB Utils</title>
|
---|
157 |
|
---|
158 | <para revision="sysv">
|
---|
159 | The <filename>usb.ids</filename> data file is constantly being updated.
|
---|
160 | To get a current version of this file, using <xref linkend="wget"/>,
|
---|
161 | periodically run again, as the
|
---|
162 | <systemitem class="username">root</systemitem> user:
|
---|
163 | </para>
|
---|
164 |
|
---|
165 | <screen role="root" revision="sysv"><userinput>wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</userinput></screen>
|
---|
166 |
|
---|
167 | <para>
|
---|
168 | You should update the <filename>/usr/share/hwdata/usb.ids</filename> file
|
---|
169 | periodically. <phrase revision="sysv">If you've installed
|
---|
170 | <xref linkend="fcron"/> and completed the section on periodic jobs,
|
---|
171 | execute</phrase><phrase revision="systemd">Execute</phrase> the following commands, as the <systemitem class="username">root</systemitem> user,
|
---|
172 | to create a <phrase revision="sysv">weekly cron job:</phrase>
|
---|
173 | <phrase revision="systemd">systemd timer to update it weekly on Sundays
|
---|
174 | at 2:30 A.M. (local time):</phrase>
|
---|
175 | </para>
|
---|
176 |
|
---|
177 | <screen role="nodump" revision="sysv"><userinput>cat > /etc/cron.weekly/update-usbids.sh << "EOF" &&
|
---|
178 | <literal>#!/bin/bash
|
---|
179 | /usr/bin/wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</literal>
|
---|
180 | EOF
|
---|
181 | chmod 754 /etc/cron.weekly/update-usbids.sh</userinput></screen>
|
---|
182 |
|
---|
183 | <screen role="root" revision="systemd"><userinput>cat > /usr/lib/systemd/system/update-usbids.service << "EOF" &&
|
---|
184 | <literal>[Unit]
|
---|
185 | Description=Update usb.ids file
|
---|
186 | Documentation=man:lsusb(8)
|
---|
187 | DefaultDependencies=no
|
---|
188 | After=local-fs.target network-online.target
|
---|
189 | Before=shutdown.target
|
---|
190 |
|
---|
191 | [Service]
|
---|
192 | Type=oneshot
|
---|
193 | RemainAfterExit=yes
|
---|
194 | ExecStart=/usr/bin/wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</literal>
|
---|
195 | EOF
|
---|
196 | cat > /usr/lib/systemd/system/update-usbids.timer << "EOF" &&
|
---|
197 | <literal>[Unit]
|
---|
198 | Description=Update usb.ids file weekly
|
---|
199 |
|
---|
200 | [Timer]
|
---|
201 | OnCalendar=Sun 03:00:00
|
---|
202 | Persistent=true
|
---|
203 |
|
---|
204 | [Install]
|
---|
205 | WantedBy=timers.target</literal>
|
---|
206 | EOF
|
---|
207 | systemctl enable update-usbids.timer</userinput></screen>
|
---|
208 |
|
---|
209 | </sect2>
|
---|
210 |
|
---|
211 | <sect2 role="content">
|
---|
212 | <title>Contents</title>
|
---|
213 |
|
---|
214 | <segmentedlist>
|
---|
215 | <segtitle>Installed Programs</segtitle>
|
---|
216 | <segtitle>Installed Libraries</segtitle>
|
---|
217 | <segtitle>Installed Directories</segtitle>
|
---|
218 |
|
---|
219 | <seglistitem>
|
---|
220 | <seg>
|
---|
221 | lsusb, lsusb.py, usb-devices, and usbhid-dump
|
---|
222 | </seg>
|
---|
223 | <seg>
|
---|
224 | None
|
---|
225 | </seg>
|
---|
226 | <seg>
|
---|
227 | None
|
---|
228 | </seg>
|
---|
229 | </seglistitem>
|
---|
230 | </segmentedlist>
|
---|
231 |
|
---|
232 | <variablelist>
|
---|
233 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
234 | <?dbfo list-presentation="list"?>
|
---|
235 | <?dbhtml list-presentation="table"?>
|
---|
236 |
|
---|
237 | <varlistentry id="lsusb">
|
---|
238 | <term><command>lsusb</command></term>
|
---|
239 | <listitem>
|
---|
240 | <para>
|
---|
241 | is a utility for displaying information about all USB buses
|
---|
242 | in the system and all devices connected to them, but not in human
|
---|
243 | friendly form
|
---|
244 | </para>
|
---|
245 | <indexterm zone="usbutils lsusb">
|
---|
246 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
247 | </indexterm>
|
---|
248 | </listitem>
|
---|
249 | </varlistentry>
|
---|
250 |
|
---|
251 | <varlistentry id="lsusb.py">
|
---|
252 | <term><command>lsusb.py</command></term>
|
---|
253 | <listitem>
|
---|
254 | <para>
|
---|
255 | displays information about all USB buses in the system and all
|
---|
256 | devices connected to them in reasonable human friendly form
|
---|
257 | </para>
|
---|
258 | <indexterm zone="usbutils lsusb.py">
|
---|
259 | <primary sortas="b-lsusb.py">lsusb.py</primary>
|
---|
260 | </indexterm>
|
---|
261 | </listitem>
|
---|
262 | </varlistentry>
|
---|
263 |
|
---|
264 | <varlistentry id="usb-devices">
|
---|
265 | <term><command>usb-devices</command></term>
|
---|
266 | <listitem>
|
---|
267 | <para>
|
---|
268 | is a shell script that displays details of USB buses and devices
|
---|
269 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
270 | is not available on your system
|
---|
271 | </para>
|
---|
272 | <indexterm zone="usbutils usb-devices">
|
---|
273 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
274 | </indexterm>
|
---|
275 | </listitem>
|
---|
276 | </varlistentry>
|
---|
277 |
|
---|
278 | <varlistentry id="usbhid-dump">
|
---|
279 | <term><command>usbhid-dump</command></term>
|
---|
280 | <listitem>
|
---|
281 | <para>
|
---|
282 | is used to dump report descriptors and streams from HID
|
---|
283 | (human interface device) interfaces of USB devices
|
---|
284 | </para>
|
---|
285 | <indexterm zone="usbutils usbhid-dump">
|
---|
286 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
287 | </indexterm>
|
---|
288 | </listitem>
|
---|
289 | </varlistentry>
|
---|
290 |
|
---|
291 | </variablelist>
|
---|
292 |
|
---|
293 | </sect2>
|
---|
294 |
|
---|
295 | </sect1>
|
---|