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 usbutils-download-http "https://kernel.org/pub/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
|
---|
8 | <!ENTITY usbutils-download-ftp " ">
|
---|
9 | <!ENTITY usbutils-md5sum "0a351e2241c50a1f026a455dccf24d73">
|
---|
10 | <!ENTITY usbutils-size "120 KB">
|
---|
11 | <!ENTITY usbutils-buildsize "1.9 MB">
|
---|
12 | <!ENTITY usbutils-time "less than 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 | &lfs122_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">USB Utils Dependencies</bridgehead>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
73 | <para role="required">
|
---|
74 | <xref linkend="libusb"/>
|
---|
75 | </para>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
78 | <para role="recommended">
|
---|
79 | <xref role="runtime" linkend="hwdata"/> (runtime)
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | </sect2>
|
---|
83 |
|
---|
84 | <sect2 role="installation">
|
---|
85 | <title>Installation of USB Utils</title>
|
---|
86 |
|
---|
87 | <para>
|
---|
88 | Install <application>USB Utils</application> by
|
---|
89 | running the following commands:
|
---|
90 | </para>
|
---|
91 |
|
---|
92 | <screen><userinput>mkdir build &&
|
---|
93 | cd build &&
|
---|
94 |
|
---|
95 | meson setup .. \
|
---|
96 | --prefix=/usr \
|
---|
97 | --buildtype=release &&
|
---|
98 |
|
---|
99 | ninja</userinput></screen>
|
---|
100 |
|
---|
101 | <para>
|
---|
102 | This package does not come with a test suite.
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <para>
|
---|
106 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
110 |
|
---|
111 | <para>
|
---|
112 | For the <filename>usb.ids</filename> data file, install the
|
---|
113 | <xref linkend='hwdata'/> package.
|
---|
114 | </para>
|
---|
115 |
|
---|
116 | <para>
|
---|
117 | The script <command>lsusb.py</command> displays information in a more
|
---|
118 | easily readable form than <command>lsusb</command>. To find the options,
|
---|
119 | use <command>lsusb.py -h</command>. One form of use recommended by the
|
---|
120 | developer is <command>lsusb.py -ciu</command>.
|
---|
121 | </para>
|
---|
122 |
|
---|
123 | </sect2>
|
---|
124 |
|
---|
125 | <sect2 role="content">
|
---|
126 | <title>Contents</title>
|
---|
127 |
|
---|
128 | <segmentedlist>
|
---|
129 | <segtitle>Installed Programs</segtitle>
|
---|
130 | <segtitle>Installed Libraries</segtitle>
|
---|
131 | <segtitle>Installed Directories</segtitle>
|
---|
132 |
|
---|
133 | <seglistitem>
|
---|
134 | <seg>
|
---|
135 | lsusb, lsusb.py, usb-devices, and usbhid-dump
|
---|
136 | </seg>
|
---|
137 | <seg>
|
---|
138 | None
|
---|
139 | </seg>
|
---|
140 | <seg>
|
---|
141 | None
|
---|
142 | </seg>
|
---|
143 | </seglistitem>
|
---|
144 | </segmentedlist>
|
---|
145 |
|
---|
146 | <variablelist>
|
---|
147 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
148 | <?dbfo list-presentation="list"?>
|
---|
149 | <?dbhtml list-presentation="table"?>
|
---|
150 |
|
---|
151 | <varlistentry id="lsusb">
|
---|
152 | <term><command>lsusb</command></term>
|
---|
153 | <listitem>
|
---|
154 | <para>
|
---|
155 | is a utility for displaying information about all USB buses
|
---|
156 | in the system and all devices connected to them, but not in human
|
---|
157 | friendly form
|
---|
158 | </para>
|
---|
159 | <indexterm zone="usbutils lsusb">
|
---|
160 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
161 | </indexterm>
|
---|
162 | </listitem>
|
---|
163 | </varlistentry>
|
---|
164 |
|
---|
165 | <varlistentry id="lsusb.py">
|
---|
166 | <term><command>lsusb.py</command></term>
|
---|
167 | <listitem>
|
---|
168 | <para>
|
---|
169 | displays information about all USB buses in the system and all
|
---|
170 | devices connected to them in reasonable human friendly form
|
---|
171 | </para>
|
---|
172 | <indexterm zone="usbutils lsusb.py">
|
---|
173 | <primary sortas="b-lsusb.py">lsusb.py</primary>
|
---|
174 | </indexterm>
|
---|
175 | </listitem>
|
---|
176 | </varlistentry>
|
---|
177 |
|
---|
178 | <varlistentry id="usb-devices">
|
---|
179 | <term><command>usb-devices</command></term>
|
---|
180 | <listitem>
|
---|
181 | <para>
|
---|
182 | is a shell script that displays details of USB buses and devices
|
---|
183 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
184 | is not available on your system
|
---|
185 | </para>
|
---|
186 | <indexterm zone="usbutils usb-devices">
|
---|
187 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
188 | </indexterm>
|
---|
189 | </listitem>
|
---|
190 | </varlistentry>
|
---|
191 |
|
---|
192 | <varlistentry id="usbhid-dump">
|
---|
193 | <term><command>usbhid-dump</command></term>
|
---|
194 | <listitem>
|
---|
195 | <para>
|
---|
196 | is used to dump report descriptors and streams from HID
|
---|
197 | (human interface device) interfaces of USB devices
|
---|
198 | </para>
|
---|
199 | <indexterm zone="usbutils usbhid-dump">
|
---|
200 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
201 | </indexterm>
|
---|
202 | </listitem>
|
---|
203 | </varlistentry>
|
---|
204 |
|
---|
205 | </variablelist>
|
---|
206 |
|
---|
207 | </sect2>
|
---|
208 |
|
---|
209 | </sect1>
|
---|