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