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