[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 |
|
---|
[8dfc5c3] | 7 | <!ENTITY usbutils-download-http "&kernel-dl;/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
|
---|
[faa68e4a] | 8 | <!ENTITY usbutils-download-ftp " ">
|
---|
[0e463f49] | 9 | <!ENTITY usbutils-md5sum "a7cf9e8903041987efa5e5e0080e0b4d">
|
---|
| 10 | <!ENTITY usbutils-size "304 KB">
|
---|
| 11 | <!ENTITY usbutils-buildsize "4.0 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 |
|
---|
[f81d69a2] | 38 | &lfs82_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 |
|
---|
[f22356bf] | 81 | <bridgehead renderas="sect4">Required Runtime</bridgehead>
|
---|
[1051f94e] | 82 | <para role="required">
|
---|
| 83 | <xref role="runtime" linkend="python2"/>
|
---|
| 84 | </para>
|
---|
[f22356bf] | 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 |
|
---|
[0e463f49] | 99 | <screen><userinput>./configure --prefix=/usr --datadir=/usr/share/hwdata &&
|
---|
[1ed12e2d] | 100 | make</userinput></screen>
|
---|
| 101 |
|
---|
[564851b] | 102 | <para>
|
---|
| 103 | This package does not come with a test suite.
|
---|
| 104 | </para>
|
---|
[1ed12e2d] | 105 |
|
---|
[564851b] | 106 | <para>
|
---|
| 107 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 108 | </para>
|
---|
[1ed12e2d] | 109 |
|
---|
[2882ec4b] | 110 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[1ed12e2d] | 111 |
|
---|
[b1092d9] | 112 | <para>
|
---|
| 113 | To install the <filename>usb.ids</filename> data file, using
|
---|
| 114 | <xref linkend="wget"/>, run, as the
|
---|
| 115 | <systemitem class="username">root</systemitem> user:
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
| 118 | <screen role="root"><userinput>install -dm755 /usr/share/hwdata/ &&
|
---|
| 119 | wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</userinput></screen>
|
---|
| 120 |
|
---|
[f22356bf] | 121 | <para>
|
---|
| 122 | The script <command>lsusb.py</command> displays information in a more
|
---|
| 123 | easily readable form than <command>lsusb</command>. To find the options,
|
---|
| 124 | use <command>lsusb.py -h</command>. One form of use recommended by the
|
---|
| 125 | developer is <command>lsusb.py -ciu</command>.
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
[1ed12e2d] | 128 | </sect2>
|
---|
[0e463f49] | 129 | <!-- No longer needed
|
---|
[1ed12e2d] | 130 | <sect2 role="commands">
|
---|
| 131 | <title>Command Explanations</title>
|
---|
| 132 |
|
---|
[564851b] | 133 | <para>
|
---|
[2882ec4b] | 134 | <command>sed ... lsusb.py</command>: Instructs lsusb.py where to search
|
---|
| 135 | <filename>usb.ids</filename>.
|
---|
[564851b] | 136 | </para>
|
---|
[1ed12e2d] | 137 |
|
---|
| 138 | </sect2>
|
---|
[0e463f49] | 139 | -->
|
---|
[1ed12e2d] | 140 | <sect2 role="configuration">
|
---|
[564851b] | 141 | <title>Configuring USB Utils</title>
|
---|
| 142 |
|
---|
[ac8c7d4] | 143 | <para revision="sysv">
|
---|
[3c4997d] | 144 | The <filename>usb.ids</filename> data file is constantly being updated.
|
---|
[b1092d9] | 145 | To get a current version of this file, using <xref linkend="wget"/>,
|
---|
| 146 | periodically run again, as the
|
---|
| 147 | <systemitem class="username">root</systemitem> user:
|
---|
| 148 | </para>
|
---|
[838cd0f] | 149 |
|
---|
[ac8c7d4] | 150 | <screen role="root" revision="sysv"><userinput>wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</userinput></screen>
|
---|
[564851b] | 151 |
|
---|
[ac8c7d4] | 152 | <para revision="sysv">
|
---|
[564851b] | 153 | You may wish to add an entry to
|
---|
| 154 | <systemitem class="username">root</systemitem>'s (or any other user who has
|
---|
[838cd0f] | 155 | write privilege to <filename class="directory">/usr/share/hwdata</filename>)
|
---|
[564851b] | 156 | crontab to automatically update the <filename>usb.ids</filename> file
|
---|
| 157 | periodically.
|
---|
| 158 | </para>
|
---|
[1ed12e2d] | 159 |
|
---|
[ac8c7d4] | 160 | <para revision="systemd">
|
---|
| 161 | You should update the <filename>/usr/share/hwdata/usb.ids</filename> file
|
---|
| 162 | periodically. Execute the following commands, as the
|
---|
| 163 | <systemitem class="username">root</systemitem> user, to create a systemd
|
---|
| 164 | timer to update it weekly on Sundays at 3:00 A.M. (local time):
|
---|
| 165 | </para>
|
---|
| 166 |
|
---|
| 167 | <screen role="root" revision="systemd"><userinput>cat > /lib/systemd/system/update-usbids.service << "EOF" &&
|
---|
| 168 | <literal>[Unit]
|
---|
| 169 | Description=Update usb.ids file
|
---|
| 170 | Documentation=man:lusub(8)
|
---|
| 171 | DefaultDependencies=no
|
---|
| 172 | After=local-fs.target
|
---|
| 173 | Before=shutdown.target
|
---|
| 174 |
|
---|
| 175 | [Service]
|
---|
| 176 | Type=oneshot
|
---|
| 177 | RemainAfterExit=yes
|
---|
| 178 | ExecStart=/usr/bin/wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</literal>
|
---|
| 179 | EOF
|
---|
| 180 | cat > /lib/systemd/system/update-usbids.timer << "EOF" &&
|
---|
| 181 | <literal>[Unit]
|
---|
| 182 | Description=Update usb.ids file weekly
|
---|
| 183 |
|
---|
| 184 | [Timer]
|
---|
| 185 | OnCalendar=Sun 03:00:00
|
---|
| 186 | Persistent=true
|
---|
| 187 |
|
---|
| 188 | [Install]
|
---|
| 189 | WantedBy=timers.target</literal>
|
---|
| 190 | EOF
|
---|
| 191 | systemctl enable update-usbids.timer</userinput></screen>
|
---|
| 192 |
|
---|
[838cd0f] | 193 | </sect2>
|
---|
[1ed12e2d] | 194 |
|
---|
| 195 | <sect2 role="content">
|
---|
| 196 | <title>Contents</title>
|
---|
| 197 |
|
---|
| 198 | <segmentedlist>
|
---|
| 199 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 200 | <segtitle>Installed Libraries</segtitle>
|
---|
| 201 | <segtitle>Installed Directories</segtitle>
|
---|
[1ed12e2d] | 202 |
|
---|
| 203 | <seglistitem>
|
---|
[564851b] | 204 | <seg>
|
---|
[2882ec4b] | 205 | lsusb, lsusb.py, usb-devices, and usbhid-dump
|
---|
[564851b] | 206 | </seg>
|
---|
[c3c56b2] | 207 | <seg>
|
---|
| 208 | None
|
---|
| 209 | </seg>
|
---|
| 210 | <seg>
|
---|
| 211 | None
|
---|
| 212 | </seg>
|
---|
[1ed12e2d] | 213 | </seglistitem>
|
---|
| 214 | </segmentedlist>
|
---|
| 215 |
|
---|
| 216 | <variablelist>
|
---|
| 217 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 218 | <?dbfo list-presentation="list"?>
|
---|
| 219 | <?dbhtml list-presentation="table"?>
|
---|
| 220 |
|
---|
| 221 | <varlistentry id="lsusb">
|
---|
| 222 | <term><command>lsusb</command></term>
|
---|
| 223 | <listitem>
|
---|
[564851b] | 224 | <para>
|
---|
[73fe507] | 225 | is a utility for displaying information about all USB buses
|
---|
[f22356bf] | 226 | in the system and all devices connected to them, but not in human
|
---|
| 227 | friendly form.
|
---|
[564851b] | 228 | </para>
|
---|
[1ed12e2d] | 229 | <indexterm zone="usbutils lsusb">
|
---|
| 230 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
| 231 | </indexterm>
|
---|
| 232 | </listitem>
|
---|
| 233 | </varlistentry>
|
---|
| 234 |
|
---|
[2882ec4b] | 235 | <varlistentry id="lsusb.py">
|
---|
| 236 | <term><command>lsusb.py</command></term>
|
---|
[1ed12e2d] | 237 | <listitem>
|
---|
[564851b] | 238 | <para>
|
---|
[f22356bf] | 239 | displays information about all USB buses in the system and all
|
---|
| 240 | devices connected to them in reasonable human friendly form.
|
---|
[564851b] | 241 | </para>
|
---|
[2882ec4b] | 242 | <indexterm zone="usbutils lsusb.py">
|
---|
| 243 | <primary sortas="b-lsusb.py">lsusb.py</primary>
|
---|
[1ed12e2d] | 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
[75c492d] | 247 |
|
---|
| 248 | <varlistentry id="usb-devices">
|
---|
| 249 | <term><command>usb-devices</command></term>
|
---|
| 250 | <listitem>
|
---|
[564851b] | 251 | <para>
|
---|
| 252 | is a shell script that displays details of USB buses and devices
|
---|
| 253 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
| 254 | is not available on your system.
|
---|
| 255 | </para>
|
---|
[75c492d] | 256 | <indexterm zone="usbutils usb-devices">
|
---|
| 257 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
| 258 | </indexterm>
|
---|
| 259 | </listitem>
|
---|
| 260 | </varlistentry>
|
---|
| 261 |
|
---|
[564851b] | 262 | <varlistentry id="usbhid-dump">
|
---|
| 263 | <term><command>usbhid-dump</command></term>
|
---|
| 264 | <listitem>
|
---|
| 265 | <para>
|
---|
| 266 | is used to dump report descriptors and streams from HID
|
---|
| 267 | (human interface device) interfaces of USB devices.
|
---|
| 268 | </para>
|
---|
| 269 | <indexterm zone="usbutils usbhid-dump">
|
---|
| 270 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
| 271 | </indexterm>
|
---|
| 272 | </listitem>
|
---|
| 273 | </varlistentry>
|
---|
| 274 |
|
---|
[1ed12e2d] | 275 | </variablelist>
|
---|
| 276 |
|
---|
| 277 | </sect2>
|
---|
| 278 |
|
---|
| 279 | </sect1>
|
---|