[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">
|
---|
[2882ec4b] | 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>
|
---|
[2882ec4b] | 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 |
|
---|
[fafbdef] | 38 | &lfs76_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">
|
---|
[f22356bf] | 78 | <xref linkend="hdwids"/> (necessary for <command>lsusb.py</command>) and
|
---|
[adf6dd9a] | 79 | <xref linkend="libusb"/>
|
---|
[76cfd80] | 80 | </para>
|
---|
[1ed12e2d] | 81 |
|
---|
[f22356bf] | 82 | <bridgehead renderas="sect4">Required Runtime</bridgehead>
|
---|
| 83 | <para role="required runtime">
|
---|
| 84 | <xref linkend="python2"/> </para>
|
---|
| 85 |
|
---|
[1ed12e2d] | 86 | <para condition="html" role="usernotes">User Notes:
|
---|
[564851b] | 87 | <ulink url="&blfs-wiki;/usbutils"/>
|
---|
| 88 | </para>
|
---|
[1ed12e2d] | 89 | </sect2>
|
---|
| 90 |
|
---|
| 91 | <sect2 role="installation">
|
---|
[564851b] | 92 | <title>Installation of USB Utils</title>
|
---|
[1ed12e2d] | 93 |
|
---|
[564851b] | 94 | <para>
|
---|
| 95 | Install <application>USB Utils</application> by
|
---|
| 96 | running the following commands:
|
---|
| 97 | </para>
|
---|
[1ed12e2d] | 98 |
|
---|
[2882ec4b] | 99 | <screen><userinput>sed -i '/^usbids/ s:usb.ids:hwdata/&:' lsusb.py &&
|
---|
| 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 |
|
---|
[2882ec4b] | 111 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[1ed12e2d] | 112 |
|
---|
[f22356bf] | 113 | <para>
|
---|
| 114 | The script <command>lsusb.py</command> displays information in a more
|
---|
| 115 | easily readable form than <command>lsusb</command>. To find the options,
|
---|
| 116 | use <command>lsusb.py -h</command>. One form of use recommended by the
|
---|
| 117 | developer is <command>lsusb.py -ciu</command>.
|
---|
| 118 | </para>
|
---|
| 119 |
|
---|
[1ed12e2d] | 120 | </sect2>
|
---|
| 121 |
|
---|
| 122 | <sect2 role="commands">
|
---|
| 123 | <title>Command Explanations</title>
|
---|
| 124 |
|
---|
[564851b] | 125 | <para>
|
---|
[2882ec4b] | 126 | <command>sed ... lsusb.py</command>: Instructs lsusb.py where to search
|
---|
| 127 | <filename>usb.ids</filename>.
|
---|
[564851b] | 128 | </para>
|
---|
[1ed12e2d] | 129 |
|
---|
| 130 | </sect2>
|
---|
[2882ec4b] | 131 | <!--
|
---|
[1ed12e2d] | 132 | <sect2 role="configuration">
|
---|
[564851b] | 133 | <title>Configuring USB Utils</title>
|
---|
| 134 |
|
---|
| 135 | <para>
|
---|
| 136 | The <filename>usb.ids</filename> data file is constantly being
|
---|
| 137 | updated. To get a current version of this file, run
|
---|
| 138 | <command>update-usbids</command> as the <systemitem
|
---|
| 139 | class="username">root</systemitem> user. This program requires the
|
---|
| 140 | <xref linkend="which"/> script or program to find <xref linkend="lynx"/>
|
---|
| 141 | or <xref linkend="wget"/> which are used to download the most current file,
|
---|
| 142 | and replace the existing file in
|
---|
| 143 | <filename class="directory">/usr/share/misc</filename>.
|
---|
| 144 | </para>
|
---|
| 145 |
|
---|
| 146 | <para>
|
---|
| 147 | You may wish to add an entry to
|
---|
| 148 | <systemitem class="username">root</systemitem>'s (or any other user who has
|
---|
| 149 | write privilege to <filename class="directory">/usr/share/misc</filename>)
|
---|
| 150 | crontab to automatically update the <filename>usb.ids</filename> file
|
---|
| 151 | periodically.
|
---|
| 152 | </para>
|
---|
[1ed12e2d] | 153 |
|
---|
[2882ec4b] | 154 | </sect2>-->
|
---|
[1ed12e2d] | 155 |
|
---|
| 156 | <sect2 role="content">
|
---|
| 157 | <title>Contents</title>
|
---|
| 158 |
|
---|
| 159 | <segmentedlist>
|
---|
| 160 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 161 | <segtitle>Installed Libraries</segtitle>
|
---|
| 162 | <segtitle>Installed Directories</segtitle>
|
---|
[1ed12e2d] | 163 |
|
---|
| 164 | <seglistitem>
|
---|
[564851b] | 165 | <seg>
|
---|
[2882ec4b] | 166 | lsusb, lsusb.py, usb-devices, and usbhid-dump
|
---|
[564851b] | 167 | </seg>
|
---|
[c3c56b2] | 168 | <seg>
|
---|
| 169 | None
|
---|
| 170 | </seg>
|
---|
| 171 | <seg>
|
---|
| 172 | None
|
---|
| 173 | </seg>
|
---|
[1ed12e2d] | 174 | </seglistitem>
|
---|
| 175 | </segmentedlist>
|
---|
| 176 |
|
---|
| 177 | <variablelist>
|
---|
| 178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 179 | <?dbfo list-presentation="list"?>
|
---|
| 180 | <?dbhtml list-presentation="table"?>
|
---|
| 181 |
|
---|
| 182 | <varlistentry id="lsusb">
|
---|
| 183 | <term><command>lsusb</command></term>
|
---|
| 184 | <listitem>
|
---|
[564851b] | 185 | <para>
|
---|
| 186 | is an utility for displaying information about all USB buses
|
---|
[f22356bf] | 187 | in the system and all devices connected to them, but not in human
|
---|
| 188 | friendly form.
|
---|
[564851b] | 189 | </para>
|
---|
[1ed12e2d] | 190 | <indexterm zone="usbutils lsusb">
|
---|
| 191 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
[2882ec4b] | 196 | <varlistentry id="lsusb.py">
|
---|
| 197 | <term><command>lsusb.py</command></term>
|
---|
[1ed12e2d] | 198 | <listitem>
|
---|
[564851b] | 199 | <para>
|
---|
[f22356bf] | 200 | displays information about all USB buses in the system and all
|
---|
| 201 | devices connected to them in reasonable human friendly form.
|
---|
[564851b] | 202 | </para>
|
---|
[2882ec4b] | 203 | <indexterm zone="usbutils lsusb.py">
|
---|
| 204 | <primary sortas="b-lsusb.py">lsusb.py</primary>
|
---|
[1ed12e2d] | 205 | </indexterm>
|
---|
| 206 | </listitem>
|
---|
| 207 | </varlistentry>
|
---|
[75c492d] | 208 |
|
---|
| 209 | <varlistentry id="usb-devices">
|
---|
| 210 | <term><command>usb-devices</command></term>
|
---|
| 211 | <listitem>
|
---|
[564851b] | 212 | <para>
|
---|
| 213 | is a shell script that displays details of USB buses and devices
|
---|
| 214 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
| 215 | is not available on your system.
|
---|
| 216 | </para>
|
---|
[75c492d] | 217 | <indexterm zone="usbutils usb-devices">
|
---|
| 218 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
| 219 | </indexterm>
|
---|
| 220 | </listitem>
|
---|
| 221 | </varlistentry>
|
---|
| 222 |
|
---|
[564851b] | 223 | <varlistentry id="usbhid-dump">
|
---|
| 224 | <term><command>usbhid-dump</command></term>
|
---|
| 225 | <listitem>
|
---|
| 226 | <para>
|
---|
| 227 | is used to dump report descriptors and streams from HID
|
---|
| 228 | (human interface device) interfaces of USB devices.
|
---|
| 229 | </para>
|
---|
| 230 | <indexterm zone="usbutils usbhid-dump">
|
---|
| 231 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
| 232 | </indexterm>
|
---|
| 233 | </listitem>
|
---|
| 234 | </varlistentry>
|
---|
| 235 |
|
---|
[1ed12e2d] | 236 | </variablelist>
|
---|
| 237 |
|
---|
| 238 | </sect2>
|
---|
| 239 |
|
---|
| 240 | </sect1>
|
---|