[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 " ">
|
---|
[66f2fb7] | 9 | <!ENTITY usbutils-md5sum "938e3707593974be99a0dd6d1de76671">
|
---|
[0e463f49] | 10 | <!ENTITY usbutils-size "304 KB">
|
---|
[66f2fb7] | 11 | <!ENTITY usbutils-buildsize "4.1 MB">
|
---|
| 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 | <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 |
|
---|
[9eb7ee7] | 38 | &lfs83_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"/>
|
---|
[eae7f55] | 79 | <phrase revision="systemd">and <xref linkend="wget"/></phrase>
|
---|
| 80 | <!-- In the systemd book, a unit/timer is installed to update the
|
---|
| 81 | usb.ids file automatically. -->
|
---|
[76cfd80] | 82 | </para>
|
---|
[1ed12e2d] | 83 |
|
---|
[f22356bf] | 84 | <bridgehead renderas="sect4">Required Runtime</bridgehead>
|
---|
[1051f94e] | 85 | <para role="required">
|
---|
| 86 | <xref role="runtime" linkend="python2"/>
|
---|
| 87 | </para>
|
---|
[f22356bf] | 88 |
|
---|
[1ed12e2d] | 89 | <para condition="html" role="usernotes">User Notes:
|
---|
[564851b] | 90 | <ulink url="&blfs-wiki;/usbutils"/>
|
---|
| 91 | </para>
|
---|
[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 |
|
---|
[0e463f49] | 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>
|
---|
| 116 | To install the <filename>usb.ids</filename> data file, using
|
---|
| 117 | <xref linkend="wget"/>, run, as the
|
---|
| 118 | <systemitem class="username">root</systemitem> user:
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
| 121 | <screen role="root"><userinput>install -dm755 /usr/share/hwdata/ &&
|
---|
| 122 | wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</userinput></screen>
|
---|
| 123 |
|
---|
[f22356bf] | 124 | <para>
|
---|
| 125 | The script <command>lsusb.py</command> displays information in a more
|
---|
| 126 | easily readable form than <command>lsusb</command>. To find the options,
|
---|
| 127 | use <command>lsusb.py -h</command>. One form of use recommended by the
|
---|
| 128 | developer is <command>lsusb.py -ciu</command>.
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
[1ed12e2d] | 131 | </sect2>
|
---|
[0e463f49] | 132 | <!-- No longer needed
|
---|
[1ed12e2d] | 133 | <sect2 role="commands">
|
---|
| 134 | <title>Command Explanations</title>
|
---|
| 135 |
|
---|
[564851b] | 136 | <para>
|
---|
[2882ec4b] | 137 | <command>sed ... lsusb.py</command>: Instructs lsusb.py where to search
|
---|
| 138 | <filename>usb.ids</filename>.
|
---|
[564851b] | 139 | </para>
|
---|
[1ed12e2d] | 140 |
|
---|
| 141 | </sect2>
|
---|
[0e463f49] | 142 | -->
|
---|
[1ed12e2d] | 143 | <sect2 role="configuration">
|
---|
[564851b] | 144 | <title>Configuring USB Utils</title>
|
---|
| 145 |
|
---|
[ac8c7d4] | 146 | <para revision="sysv">
|
---|
[3c4997d] | 147 | The <filename>usb.ids</filename> data file is constantly being updated.
|
---|
[b1092d9] | 148 | To get a current version of this file, using <xref linkend="wget"/>,
|
---|
| 149 | periodically run again, as the
|
---|
| 150 | <systemitem class="username">root</systemitem> user:
|
---|
| 151 | </para>
|
---|
[838cd0f] | 152 |
|
---|
[ac8c7d4] | 153 | <screen role="root" revision="sysv"><userinput>wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</userinput></screen>
|
---|
[564851b] | 154 |
|
---|
[6d8b45a3] | 155 | <para>
|
---|
[ac8c7d4] | 156 | You should update the <filename>/usr/share/hwdata/usb.ids</filename> file
|
---|
[6d8b45a3] | 157 | periodically. <phrase revision="sysv">If you've installed
|
---|
| 158 | <xref linkend="fcron"/> and completed the section on periodic jobs,
|
---|
| 159 | execute</phrase><phrase revision="systemd">Execute</phrase> the following commands, as the <systemitem class="username">root</systemitem> user,
|
---|
| 160 | to create a <phrase revision="sysv">weekly cron job:</phrase>
|
---|
| 161 | <phrase revision="systemd">systemd timer to update it weekly on Sundays
|
---|
| 162 | at 2:30 A.M. (local time):</phrase>
|
---|
[ac8c7d4] | 163 | </para>
|
---|
| 164 |
|
---|
[6d8b45a3] | 165 | <screen role="root" revision="sysv"><userinput>cat > /etc/cron.weekly/update-
|
---|
| 166 | usbids.sh << "EOF" &&
|
---|
| 167 | <literal>#!/bin/bash
|
---|
| 168 | /usr/bin/wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</literal>
|
---|
| 169 | EOF
|
---|
[8f6f10e] | 170 | chmod 754 /etc/cron.weekly/update-usbids.sh</userinput></screen>
|
---|
[6d8b45a3] | 171 |
|
---|
[ac8c7d4] | 172 | <screen role="root" revision="systemd"><userinput>cat > /lib/systemd/system/update-usbids.service << "EOF" &&
|
---|
| 173 | <literal>[Unit]
|
---|
| 174 | Description=Update usb.ids file
|
---|
[f5a82e9c] | 175 | Documentation=man:lsusb(8)
|
---|
[ac8c7d4] | 176 | DefaultDependencies=no
|
---|
[a5b9f1e] | 177 | After=local-fs.target network-online.target
|
---|
[ac8c7d4] | 178 | Before=shutdown.target
|
---|
| 179 |
|
---|
| 180 | [Service]
|
---|
| 181 | Type=oneshot
|
---|
| 182 | RemainAfterExit=yes
|
---|
| 183 | ExecStart=/usr/bin/wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</literal>
|
---|
| 184 | EOF
|
---|
| 185 | cat > /lib/systemd/system/update-usbids.timer << "EOF" &&
|
---|
| 186 | <literal>[Unit]
|
---|
| 187 | Description=Update usb.ids file weekly
|
---|
| 188 |
|
---|
| 189 | [Timer]
|
---|
| 190 | OnCalendar=Sun 03:00:00
|
---|
| 191 | Persistent=true
|
---|
| 192 |
|
---|
| 193 | [Install]
|
---|
| 194 | WantedBy=timers.target</literal>
|
---|
| 195 | EOF
|
---|
| 196 | systemctl enable update-usbids.timer</userinput></screen>
|
---|
| 197 |
|
---|
[838cd0f] | 198 | </sect2>
|
---|
[1ed12e2d] | 199 |
|
---|
| 200 | <sect2 role="content">
|
---|
| 201 | <title>Contents</title>
|
---|
| 202 |
|
---|
| 203 | <segmentedlist>
|
---|
| 204 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 205 | <segtitle>Installed Libraries</segtitle>
|
---|
| 206 | <segtitle>Installed Directories</segtitle>
|
---|
[1ed12e2d] | 207 |
|
---|
| 208 | <seglistitem>
|
---|
[564851b] | 209 | <seg>
|
---|
[2882ec4b] | 210 | lsusb, lsusb.py, usb-devices, and usbhid-dump
|
---|
[564851b] | 211 | </seg>
|
---|
[c3c56b2] | 212 | <seg>
|
---|
| 213 | None
|
---|
| 214 | </seg>
|
---|
| 215 | <seg>
|
---|
| 216 | None
|
---|
| 217 | </seg>
|
---|
[1ed12e2d] | 218 | </seglistitem>
|
---|
| 219 | </segmentedlist>
|
---|
| 220 |
|
---|
| 221 | <variablelist>
|
---|
| 222 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 223 | <?dbfo list-presentation="list"?>
|
---|
| 224 | <?dbhtml list-presentation="table"?>
|
---|
| 225 |
|
---|
| 226 | <varlistentry id="lsusb">
|
---|
| 227 | <term><command>lsusb</command></term>
|
---|
| 228 | <listitem>
|
---|
[564851b] | 229 | <para>
|
---|
[73fe507] | 230 | is a utility for displaying information about all USB buses
|
---|
[f22356bf] | 231 | in the system and all devices connected to them, but not in human
|
---|
| 232 | friendly form.
|
---|
[564851b] | 233 | </para>
|
---|
[1ed12e2d] | 234 | <indexterm zone="usbutils lsusb">
|
---|
| 235 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
| 236 | </indexterm>
|
---|
| 237 | </listitem>
|
---|
| 238 | </varlistentry>
|
---|
| 239 |
|
---|
[2882ec4b] | 240 | <varlistentry id="lsusb.py">
|
---|
| 241 | <term><command>lsusb.py</command></term>
|
---|
[1ed12e2d] | 242 | <listitem>
|
---|
[564851b] | 243 | <para>
|
---|
[f22356bf] | 244 | displays information about all USB buses in the system and all
|
---|
| 245 | devices connected to them in reasonable human friendly form.
|
---|
[564851b] | 246 | </para>
|
---|
[2882ec4b] | 247 | <indexterm zone="usbutils lsusb.py">
|
---|
| 248 | <primary sortas="b-lsusb.py">lsusb.py</primary>
|
---|
[1ed12e2d] | 249 | </indexterm>
|
---|
| 250 | </listitem>
|
---|
| 251 | </varlistentry>
|
---|
[75c492d] | 252 |
|
---|
| 253 | <varlistentry id="usb-devices">
|
---|
| 254 | <term><command>usb-devices</command></term>
|
---|
| 255 | <listitem>
|
---|
[564851b] | 256 | <para>
|
---|
| 257 | is a shell script that displays details of USB buses and devices
|
---|
| 258 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
| 259 | is not available on your system.
|
---|
| 260 | </para>
|
---|
[75c492d] | 261 | <indexterm zone="usbutils usb-devices">
|
---|
| 262 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
| 263 | </indexterm>
|
---|
| 264 | </listitem>
|
---|
| 265 | </varlistentry>
|
---|
| 266 |
|
---|
[564851b] | 267 | <varlistentry id="usbhid-dump">
|
---|
| 268 | <term><command>usbhid-dump</command></term>
|
---|
| 269 | <listitem>
|
---|
| 270 | <para>
|
---|
| 271 | is used to dump report descriptors and streams from HID
|
---|
| 272 | (human interface device) interfaces of USB devices.
|
---|
| 273 | </para>
|
---|
| 274 | <indexterm zone="usbutils usbhid-dump">
|
---|
| 275 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
| 276 | </indexterm>
|
---|
| 277 | </listitem>
|
---|
| 278 | </varlistentry>
|
---|
| 279 |
|
---|
[1ed12e2d] | 280 | </variablelist>
|
---|
| 281 |
|
---|
| 282 | </sect2>
|
---|
| 283 |
|
---|
| 284 | </sect1>
|
---|