[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" [
|
---|
[1ed12e2d] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[cb3e56c] | 7 | <!ENTITY usbutils-download-http "https://kernel.org/pub/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
|
---|
[faa68e4a] | 8 | <!ENTITY usbutils-download-ftp " ">
|
---|
[cb3e56c] | 9 | <!ENTITY usbutils-md5sum "8ff21441faf2e8128e4810b3d6e49059">
|
---|
| 10 | <!ENTITY usbutils-size "168 KB">
|
---|
[9149bad] | 11 | <!ENTITY usbutils-buildsize "4.4 MB">
|
---|
[a10e20c] | 12 | <!ENTITY usbutils-time "0.1 SBU">
|
---|
[1ed12e2d] | 13 | ]>
|
---|
| 14 |
|
---|
[4890200] | 15 | <sect1 id="usbutils" xreflabel="usbutils-&usbutils-version;">
|
---|
[1ed12e2d] | 16 | <?dbhtml filename="usbutils.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[4890200] | 19 | <title>usbutils-&usbutils-version;</title>
|
---|
[1ed12e2d] | 20 |
|
---|
| 21 | <indexterm zone="usbutils">
|
---|
[4890200] | 22 | <primary sortas="a-usbutils">usbutils</primary>
|
---|
[1ed12e2d] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[564851b] | 26 | <title>Introduction to USB Utils</title>
|
---|
[1ed12e2d] | 27 |
|
---|
[564851b] | 28 | <para>
|
---|
[2882ec4b] | 29 | The <application>USB Utils</application> package contains utilities
|
---|
[564851b] | 30 | used to display information about USB buses in the system and the
|
---|
| 31 | devices connected to them.
|
---|
| 32 | </para>
|
---|
[1ed12e2d] | 33 |
|
---|
[aa996df1] | 34 | &lfs122_checked;
|
---|
[75c492d] | 35 |
|
---|
[1ed12e2d] | 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
[564851b] | 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&usbutils-download-http;"/>
|
---|
| 41 | </para>
|
---|
[1ed12e2d] | 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
[564851b] | 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&usbutils-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
[1ed12e2d] | 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
[564851b] | 49 | <para>
|
---|
| 50 | Download MD5 sum: &usbutils-md5sum;
|
---|
| 51 | </para>
|
---|
[1ed12e2d] | 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
[564851b] | 54 | <para>
|
---|
| 55 | Download size: &usbutils-size;
|
---|
| 56 | </para>
|
---|
[1ed12e2d] | 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[564851b] | 59 | <para>
|
---|
| 60 | Estimated disk space required: &usbutils-buildsize;
|
---|
| 61 | </para>
|
---|
[1ed12e2d] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[564851b] | 64 | <para>
|
---|
| 65 | Estimated build time: &usbutils-time;
|
---|
| 66 | </para>
|
---|
[1ed12e2d] | 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
[1a424644] | 69 | <!--
|
---|
[194a584] | 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>
|
---|
[1a424644] | 79 | -->
|
---|
[564851b] | 80 | <bridgehead renderas="sect3">USB Utils Dependencies</bridgehead>
|
---|
[9f12e36] | 81 |
|
---|
[deb4808] | 82 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[76cfd80] | 83 | <para role="required">
|
---|
[65164ed] | 84 | <xref linkend="libusb"/>
|
---|
[76cfd80] | 85 | </para>
|
---|
[1ed12e2d] | 86 |
|
---|
[65164ed] | 87 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 88 | <para role="recommended">
|
---|
[7ff7885c] | 89 | <xref role="runtime" linkend="hwdata"/> (runtime)
|
---|
[1051f94e] | 90 | </para>
|
---|
[65164ed] | 91 |
|
---|
[1ed12e2d] | 92 | </sect2>
|
---|
| 93 |
|
---|
| 94 | <sect2 role="installation">
|
---|
[564851b] | 95 | <title>Installation of USB Utils</title>
|
---|
[1ed12e2d] | 96 |
|
---|
[564851b] | 97 | <para>
|
---|
| 98 | Install <application>USB Utils</application> by
|
---|
| 99 | running the following commands:
|
---|
| 100 | </para>
|
---|
[1ed12e2d] | 101 |
|
---|
[cb3e56c] | 102 | <screen><userinput>./configure --prefix=/usr --datadir=/usr/share/hwdata &&
|
---|
[1ed12e2d] | 103 | make</userinput></screen>
|
---|
| 104 |
|
---|
[564851b] | 105 | <para>
|
---|
| 106 | This package does not come with a test suite.
|
---|
| 107 | </para>
|
---|
[1ed12e2d] | 108 |
|
---|
[564851b] | 109 | <para>
|
---|
| 110 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 111 | </para>
|
---|
[1ed12e2d] | 112 |
|
---|
[2882ec4b] | 113 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[1ed12e2d] | 114 |
|
---|
[b1092d9] | 115 | <para>
|
---|
[7ff7885c] | 116 | For the <filename>usb.ids</filename> data file, install the
|
---|
| 117 | <xref linkend='hwdata'/> package.
|
---|
[b1092d9] | 118 | </para>
|
---|
| 119 |
|
---|
[f22356bf] | 120 | <para>
|
---|
| 121 | The script <command>lsusb.py</command> displays information in a more
|
---|
| 122 | easily readable form than <command>lsusb</command>. To find the options,
|
---|
| 123 | use <command>lsusb.py -h</command>. One form of use recommended by the
|
---|
| 124 | developer is <command>lsusb.py -ciu</command>.
|
---|
| 125 | </para>
|
---|
| 126 |
|
---|
[1ed12e2d] | 127 | </sect2>
|
---|
[0e463f49] | 128 | <!-- No longer needed
|
---|
[1ed12e2d] | 129 | <sect2 role="commands">
|
---|
| 130 | <title>Command Explanations</title>
|
---|
| 131 |
|
---|
[564851b] | 132 | <para>
|
---|
[2882ec4b] | 133 | <command>sed ... lsusb.py</command>: Instructs lsusb.py where to search
|
---|
| 134 | <filename>usb.ids</filename>.
|
---|
[564851b] | 135 | </para>
|
---|
[1ed12e2d] | 136 |
|
---|
| 137 | </sect2>
|
---|
[0e463f49] | 138 | -->
|
---|
[1ed12e2d] | 139 |
|
---|
| 140 | <sect2 role="content">
|
---|
| 141 | <title>Contents</title>
|
---|
| 142 |
|
---|
| 143 | <segmentedlist>
|
---|
| 144 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 145 | <segtitle>Installed Libraries</segtitle>
|
---|
| 146 | <segtitle>Installed Directories</segtitle>
|
---|
[1ed12e2d] | 147 |
|
---|
| 148 | <seglistitem>
|
---|
[564851b] | 149 | <seg>
|
---|
[2882ec4b] | 150 | lsusb, lsusb.py, usb-devices, and usbhid-dump
|
---|
[564851b] | 151 | </seg>
|
---|
[c3c56b2] | 152 | <seg>
|
---|
| 153 | None
|
---|
| 154 | </seg>
|
---|
| 155 | <seg>
|
---|
| 156 | None
|
---|
| 157 | </seg>
|
---|
[1ed12e2d] | 158 | </seglistitem>
|
---|
| 159 | </segmentedlist>
|
---|
| 160 |
|
---|
| 161 | <variablelist>
|
---|
| 162 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 163 | <?dbfo list-presentation="list"?>
|
---|
| 164 | <?dbhtml list-presentation="table"?>
|
---|
| 165 |
|
---|
| 166 | <varlistentry id="lsusb">
|
---|
| 167 | <term><command>lsusb</command></term>
|
---|
| 168 | <listitem>
|
---|
[564851b] | 169 | <para>
|
---|
[73fe507] | 170 | is a utility for displaying information about all USB buses
|
---|
[f22356bf] | 171 | in the system and all devices connected to them, but not in human
|
---|
[4c24eb0a] | 172 | friendly form
|
---|
[564851b] | 173 | </para>
|
---|
[1ed12e2d] | 174 | <indexterm zone="usbutils lsusb">
|
---|
| 175 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
| 176 | </indexterm>
|
---|
| 177 | </listitem>
|
---|
| 178 | </varlistentry>
|
---|
| 179 |
|
---|
[2882ec4b] | 180 | <varlistentry id="lsusb.py">
|
---|
| 181 | <term><command>lsusb.py</command></term>
|
---|
[1ed12e2d] | 182 | <listitem>
|
---|
[564851b] | 183 | <para>
|
---|
[f22356bf] | 184 | displays information about all USB buses in the system and all
|
---|
[4c24eb0a] | 185 | devices connected to them in reasonable human friendly form
|
---|
[564851b] | 186 | </para>
|
---|
[2882ec4b] | 187 | <indexterm zone="usbutils lsusb.py">
|
---|
| 188 | <primary sortas="b-lsusb.py">lsusb.py</primary>
|
---|
[1ed12e2d] | 189 | </indexterm>
|
---|
| 190 | </listitem>
|
---|
| 191 | </varlistentry>
|
---|
[75c492d] | 192 |
|
---|
| 193 | <varlistentry id="usb-devices">
|
---|
| 194 | <term><command>usb-devices</command></term>
|
---|
| 195 | <listitem>
|
---|
[564851b] | 196 | <para>
|
---|
| 197 | is a shell script that displays details of USB buses and devices
|
---|
| 198 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
[4c24eb0a] | 199 | is not available on your system
|
---|
[564851b] | 200 | </para>
|
---|
[75c492d] | 201 | <indexterm zone="usbutils usb-devices">
|
---|
| 202 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
| 203 | </indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 |
|
---|
[564851b] | 207 | <varlistentry id="usbhid-dump">
|
---|
| 208 | <term><command>usbhid-dump</command></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>
|
---|
| 211 | is used to dump report descriptors and streams from HID
|
---|
[4c24eb0a] | 212 | (human interface device) interfaces of USB devices
|
---|
[564851b] | 213 | </para>
|
---|
| 214 | <indexterm zone="usbutils usbhid-dump">
|
---|
| 215 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
| 216 | </indexterm>
|
---|
| 217 | </listitem>
|
---|
| 218 | </varlistentry>
|
---|
| 219 |
|
---|
[1ed12e2d] | 220 | </variablelist>
|
---|
| 221 |
|
---|
| 222 | </sect2>
|
---|
| 223 |
|
---|
| 224 | </sect1>
|
---|