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