[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 |
|
---|
[a4682b84] | 7 | <!ENTITY usbutils-download-http "https://github.com/gregkh/usbutils/archive/v&usbutils-version;/usbutils-&usbutils-version;.tar.gz">
|
---|
[faa68e4a] | 8 | <!ENTITY usbutils-download-ftp " ">
|
---|
[a4682b84] | 9 | <!ENTITY usbutils-md5sum "112eafa991e55229b9f48b90c290a0e2">
|
---|
| 10 | <!ENTITY usbutils-size "120 KB">
|
---|
| 11 | <!ENTITY usbutils-buildsize "4.3 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 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
[4890200] | 22 | <title>usbutils-&usbutils-version;</title>
|
---|
[1ed12e2d] | 23 |
|
---|
| 24 | <indexterm zone="usbutils">
|
---|
[4890200] | 25 | <primary sortas="a-usbutils">usbutils</primary>
|
---|
[1ed12e2d] | 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
[564851b] | 29 | <title>Introduction to USB Utils</title>
|
---|
[1ed12e2d] | 30 |
|
---|
[564851b] | 31 | <para>
|
---|
[2882ec4b] | 32 | The <application>USB Utils</application> package contains utilities
|
---|
[564851b] | 33 | used to display information about USB buses in the system and the
|
---|
| 34 | devices connected to them.
|
---|
| 35 | </para>
|
---|
[1ed12e2d] | 36 |
|
---|
[ce1dd9df] | 37 | &lfs112_checked;
|
---|
[75c492d] | 38 |
|
---|
[1ed12e2d] | 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
[564851b] | 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&usbutils-download-http;"/>
|
---|
| 44 | </para>
|
---|
[1ed12e2d] | 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
[564851b] | 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&usbutils-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
[1ed12e2d] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[564851b] | 52 | <para>
|
---|
| 53 | Download MD5 sum: &usbutils-md5sum;
|
---|
| 54 | </para>
|
---|
[1ed12e2d] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[564851b] | 57 | <para>
|
---|
| 58 | Download size: &usbutils-size;
|
---|
| 59 | </para>
|
---|
[1ed12e2d] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[564851b] | 62 | <para>
|
---|
| 63 | Estimated disk space required: &usbutils-buildsize;
|
---|
| 64 | </para>
|
---|
[1ed12e2d] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[564851b] | 67 | <para>
|
---|
| 68 | Estimated build time: &usbutils-time;
|
---|
| 69 | </para>
|
---|
[1ed12e2d] | 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
[1a424644] | 72 | <!--
|
---|
[194a584] | 73 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 74 | <itemizedlist spacing="compact">
|
---|
| 75 | <listitem>
|
---|
| 76 | <para>
|
---|
| 77 | Required patch:
|
---|
| 78 | <ulink url="&patch-root;/usbutils-&usbutils-version;-lsusb_bugfixes-1.patch"/>
|
---|
| 79 | </para>
|
---|
| 80 | </listitem>
|
---|
| 81 | </itemizedlist>
|
---|
[1a424644] | 82 | -->
|
---|
[564851b] | 83 | <bridgehead renderas="sect3">USB Utils Dependencies</bridgehead>
|
---|
[9f12e36] | 84 |
|
---|
[deb4808] | 85 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[76cfd80] | 86 | <para role="required">
|
---|
[195b246] | 87 | <xref linkend="libusb"/> and
|
---|
| 88 | <xref linkend="wget"/>
|
---|
[eae7f55] | 89 | <!-- In the systemd book, a unit/timer is installed to update the
|
---|
[8558044] | 90 | usb.ids file automatically.
|
---|
| 91 |
|
---|
[195b246] | 92 | wget is used in the instructions below.
|
---|
| 93 | -->
|
---|
[76cfd80] | 94 | </para>
|
---|
[1ed12e2d] | 95 |
|
---|
[1a424644] | 96 | <!-- lsusb.py has been ported to Python 3, and it is the only Python user
|
---|
[f22356bf] | 97 | <bridgehead renderas="sect4">Required Runtime</bridgehead>
|
---|
[1051f94e] | 98 | <para role="required">
|
---|
| 99 | <xref role="runtime" linkend="python2"/>
|
---|
| 100 | </para>
|
---|
[5093a1f9] | 101 | -->
|
---|
[1ed12e2d] | 102 | <para condition="html" role="usernotes">User Notes:
|
---|
[564851b] | 103 | <ulink url="&blfs-wiki;/usbutils"/>
|
---|
| 104 | </para>
|
---|
[1ed12e2d] | 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 role="installation">
|
---|
[564851b] | 108 | <title>Installation of USB Utils</title>
|
---|
[1ed12e2d] | 109 |
|
---|
[564851b] | 110 | <para>
|
---|
| 111 | Install <application>USB Utils</application> by
|
---|
| 112 | running the following commands:
|
---|
| 113 | </para>
|
---|
[1ed12e2d] | 114 |
|
---|
[a4682b84] | 115 | <screen><userinput>autoreconf -fiv &&
|
---|
| 116 |
|
---|
| 117 | ./configure --prefix=/usr --datadir=/usr/share/hwdata &&
|
---|
[1ed12e2d] | 118 | make</userinput></screen>
|
---|
| 119 |
|
---|
[564851b] | 120 | <para>
|
---|
| 121 | This package does not come with a test suite.
|
---|
| 122 | </para>
|
---|
[1ed12e2d] | 123 |
|
---|
[564851b] | 124 | <para>
|
---|
| 125 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 126 | </para>
|
---|
[1ed12e2d] | 127 |
|
---|
[2882ec4b] | 128 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[1ed12e2d] | 129 |
|
---|
[b1092d9] | 130 | <para>
|
---|
| 131 | To install the <filename>usb.ids</filename> data file, using
|
---|
| 132 | <xref linkend="wget"/>, run, as the
|
---|
| 133 | <systemitem class="username">root</systemitem> user:
|
---|
| 134 | </para>
|
---|
| 135 |
|
---|
| 136 | <screen role="root"><userinput>install -dm755 /usr/share/hwdata/ &&
|
---|
| 137 | wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</userinput></screen>
|
---|
| 138 |
|
---|
[f22356bf] | 139 | <para>
|
---|
| 140 | The script <command>lsusb.py</command> displays information in a more
|
---|
| 141 | easily readable form than <command>lsusb</command>. To find the options,
|
---|
| 142 | use <command>lsusb.py -h</command>. One form of use recommended by the
|
---|
| 143 | developer is <command>lsusb.py -ciu</command>.
|
---|
| 144 | </para>
|
---|
| 145 |
|
---|
[1ed12e2d] | 146 | </sect2>
|
---|
[0e463f49] | 147 | <!-- No longer needed
|
---|
[1ed12e2d] | 148 | <sect2 role="commands">
|
---|
| 149 | <title>Command Explanations</title>
|
---|
| 150 |
|
---|
[564851b] | 151 | <para>
|
---|
[2882ec4b] | 152 | <command>sed ... lsusb.py</command>: Instructs lsusb.py where to search
|
---|
| 153 | <filename>usb.ids</filename>.
|
---|
[564851b] | 154 | </para>
|
---|
[1ed12e2d] | 155 |
|
---|
| 156 | </sect2>
|
---|
[0e463f49] | 157 | -->
|
---|
[1ed12e2d] | 158 | <sect2 role="configuration">
|
---|
[564851b] | 159 | <title>Configuring USB Utils</title>
|
---|
| 160 |
|
---|
[ac8c7d4] | 161 | <para revision="sysv">
|
---|
[3c4997d] | 162 | The <filename>usb.ids</filename> data file is constantly being updated.
|
---|
[b1092d9] | 163 | To get a current version of this file, using <xref linkend="wget"/>,
|
---|
| 164 | periodically run again, as the
|
---|
| 165 | <systemitem class="username">root</systemitem> user:
|
---|
| 166 | </para>
|
---|
[838cd0f] | 167 |
|
---|
[ac8c7d4] | 168 | <screen role="root" revision="sysv"><userinput>wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</userinput></screen>
|
---|
[564851b] | 169 |
|
---|
[b471f6a] | 170 | <para>
|
---|
[ac8c7d4] | 171 | You should update the <filename>/usr/share/hwdata/usb.ids</filename> file
|
---|
[b471f6a] | 172 | periodically. <phrase revision="sysv">If you've installed
|
---|
| 173 | <xref linkend="fcron"/> and completed the section on periodic jobs,
|
---|
| 174 | execute</phrase><phrase revision="systemd">Execute</phrase> the following commands, as the <systemitem class="username">root</systemitem> user,
|
---|
| 175 | to create a <phrase revision="sysv">weekly cron job:</phrase>
|
---|
| 176 | <phrase revision="systemd">systemd timer to update it weekly on Sundays
|
---|
| 177 | at 2:30 A.M. (local time):</phrase>
|
---|
[ac8c7d4] | 178 | </para>
|
---|
| 179 |
|
---|
[914dd13] | 180 | <screen role="nodump" revision="sysv"><userinput>cat > /etc/cron.weekly/update-usbids.sh << "EOF" &&
|
---|
[b471f6a] | 181 | <literal>#!/bin/bash
|
---|
| 182 | /usr/bin/wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</literal>
|
---|
| 183 | EOF
|
---|
[02e3bbc8] | 184 | chmod 754 /etc/cron.weekly/update-usbids.sh</userinput></screen>
|
---|
[b471f6a] | 185 |
|
---|
[d0d2c85a] | 186 | <screen role="root" revision="systemd"><userinput>cat > /usr/lib/systemd/system/update-usbids.service << "EOF" &&
|
---|
[ac8c7d4] | 187 | <literal>[Unit]
|
---|
| 188 | Description=Update usb.ids file
|
---|
[f5a82e9c] | 189 | Documentation=man:lsusb(8)
|
---|
[ac8c7d4] | 190 | DefaultDependencies=no
|
---|
[a5b9f1e] | 191 | After=local-fs.target network-online.target
|
---|
[ac8c7d4] | 192 | Before=shutdown.target
|
---|
| 193 |
|
---|
| 194 | [Service]
|
---|
| 195 | Type=oneshot
|
---|
| 196 | RemainAfterExit=yes
|
---|
| 197 | ExecStart=/usr/bin/wget http://www.linux-usb.org/usb.ids -O /usr/share/hwdata/usb.ids</literal>
|
---|
| 198 | EOF
|
---|
[d0d2c85a] | 199 | cat > /usr/lib/systemd/system/update-usbids.timer << "EOF" &&
|
---|
[ac8c7d4] | 200 | <literal>[Unit]
|
---|
| 201 | Description=Update usb.ids file weekly
|
---|
| 202 |
|
---|
| 203 | [Timer]
|
---|
| 204 | OnCalendar=Sun 03:00:00
|
---|
| 205 | Persistent=true
|
---|
| 206 |
|
---|
| 207 | [Install]
|
---|
| 208 | WantedBy=timers.target</literal>
|
---|
| 209 | EOF
|
---|
| 210 | systemctl enable update-usbids.timer</userinput></screen>
|
---|
| 211 |
|
---|
[838cd0f] | 212 | </sect2>
|
---|
[1ed12e2d] | 213 |
|
---|
| 214 | <sect2 role="content">
|
---|
| 215 | <title>Contents</title>
|
---|
| 216 |
|
---|
| 217 | <segmentedlist>
|
---|
| 218 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 219 | <segtitle>Installed Libraries</segtitle>
|
---|
| 220 | <segtitle>Installed Directories</segtitle>
|
---|
[1ed12e2d] | 221 |
|
---|
| 222 | <seglistitem>
|
---|
[564851b] | 223 | <seg>
|
---|
[2882ec4b] | 224 | lsusb, lsusb.py, usb-devices, and usbhid-dump
|
---|
[564851b] | 225 | </seg>
|
---|
[c3c56b2] | 226 | <seg>
|
---|
| 227 | None
|
---|
| 228 | </seg>
|
---|
| 229 | <seg>
|
---|
| 230 | None
|
---|
| 231 | </seg>
|
---|
[1ed12e2d] | 232 | </seglistitem>
|
---|
| 233 | </segmentedlist>
|
---|
| 234 |
|
---|
| 235 | <variablelist>
|
---|
| 236 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 237 | <?dbfo list-presentation="list"?>
|
---|
| 238 | <?dbhtml list-presentation="table"?>
|
---|
| 239 |
|
---|
| 240 | <varlistentry id="lsusb">
|
---|
| 241 | <term><command>lsusb</command></term>
|
---|
| 242 | <listitem>
|
---|
[564851b] | 243 | <para>
|
---|
[73fe507] | 244 | is a utility for displaying information about all USB buses
|
---|
[f22356bf] | 245 | in the system and all devices connected to them, but not in human
|
---|
[4c24eb0a] | 246 | friendly form
|
---|
[564851b] | 247 | </para>
|
---|
[1ed12e2d] | 248 | <indexterm zone="usbutils lsusb">
|
---|
| 249 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
| 250 | </indexterm>
|
---|
| 251 | </listitem>
|
---|
| 252 | </varlistentry>
|
---|
| 253 |
|
---|
[2882ec4b] | 254 | <varlistentry id="lsusb.py">
|
---|
| 255 | <term><command>lsusb.py</command></term>
|
---|
[1ed12e2d] | 256 | <listitem>
|
---|
[564851b] | 257 | <para>
|
---|
[f22356bf] | 258 | displays information about all USB buses in the system and all
|
---|
[4c24eb0a] | 259 | devices connected to them in reasonable human friendly form
|
---|
[564851b] | 260 | </para>
|
---|
[2882ec4b] | 261 | <indexterm zone="usbutils lsusb.py">
|
---|
| 262 | <primary sortas="b-lsusb.py">lsusb.py</primary>
|
---|
[1ed12e2d] | 263 | </indexterm>
|
---|
| 264 | </listitem>
|
---|
| 265 | </varlistentry>
|
---|
[75c492d] | 266 |
|
---|
| 267 | <varlistentry id="usb-devices">
|
---|
| 268 | <term><command>usb-devices</command></term>
|
---|
| 269 | <listitem>
|
---|
[564851b] | 270 | <para>
|
---|
| 271 | is a shell script that displays details of USB buses and devices
|
---|
| 272 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
[4c24eb0a] | 273 | is not available on your system
|
---|
[564851b] | 274 | </para>
|
---|
[75c492d] | 275 | <indexterm zone="usbutils usb-devices">
|
---|
| 276 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
| 277 | </indexterm>
|
---|
| 278 | </listitem>
|
---|
| 279 | </varlistentry>
|
---|
| 280 |
|
---|
[564851b] | 281 | <varlistentry id="usbhid-dump">
|
---|
| 282 | <term><command>usbhid-dump</command></term>
|
---|
| 283 | <listitem>
|
---|
| 284 | <para>
|
---|
| 285 | is used to dump report descriptors and streams from HID
|
---|
[4c24eb0a] | 286 | (human interface device) interfaces of USB devices
|
---|
[564851b] | 287 | </para>
|
---|
| 288 | <indexterm zone="usbutils usbhid-dump">
|
---|
| 289 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
| 290 | </indexterm>
|
---|
| 291 | </listitem>
|
---|
| 292 | </varlistentry>
|
---|
| 293 |
|
---|
[1ed12e2d] | 294 | </variablelist>
|
---|
| 295 |
|
---|
| 296 | </sect2>
|
---|
| 297 |
|
---|
| 298 | </sect1>
|
---|