[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 |
|
---|
[564851b] | 7 | <!ENTITY usbutils-download-http "http://ftp.kernel.org/pub/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
|
---|
| 8 | <!ENTITY usbutils-download-ftp "ftp://ftp.kernel.org/pub/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
|
---|
[586b174f] | 9 | <!ENTITY usbutils-md5sum "c9df5107ae9d26b10a1736a261250139">
|
---|
| 10 | <!ENTITY usbutils-size "416 KB">
|
---|
| 11 | <!ENTITY usbutils-buildsize "4.8 MB">
|
---|
| 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>
|
---|
| 33 | The <application>USB Utils</application> package contains an utility
|
---|
| 34 | used to display information about USB buses in the system and the
|
---|
| 35 | devices connected to them.
|
---|
| 36 | </para>
|
---|
[1ed12e2d] | 37 |
|
---|
[405c8dc] | 38 | &lfs73_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">
|
---|
[9ef15dba] | 78 | <xref linkend="libusb"/> and
|
---|
| 79 | <xref linkend="pkgconfig"/>
|
---|
[76cfd80] | 80 | </para>
|
---|
[1ed12e2d] | 81 |
|
---|
| 82 | <para condition="html" role="usernotes">User Notes:
|
---|
[564851b] | 83 | <ulink url="&blfs-wiki;/usbutils"/>
|
---|
| 84 | </para>
|
---|
[1ed12e2d] | 85 | </sect2>
|
---|
| 86 |
|
---|
| 87 | <sect2 role="installation">
|
---|
[564851b] | 88 | <title>Installation of USB Utils</title>
|
---|
[1ed12e2d] | 89 |
|
---|
[564851b] | 90 | <para>
|
---|
| 91 | Install <application>USB Utils</application> by
|
---|
| 92 | running the following commands:
|
---|
| 93 | </para>
|
---|
[1ed12e2d] | 94 |
|
---|
[564851b] | 95 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 96 | --datadir=/usr/share/misc \
|
---|
| 97 | --disable-zlib &&
|
---|
[1ed12e2d] | 98 | make</userinput></screen>
|
---|
| 99 |
|
---|
[564851b] | 100 | <para>
|
---|
| 101 | This package does not come with a test suite.
|
---|
| 102 | </para>
|
---|
[1ed12e2d] | 103 |
|
---|
[564851b] | 104 | <para>
|
---|
| 105 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 106 | </para>
|
---|
[1ed12e2d] | 107 |
|
---|
| 108 | <screen role="root"><userinput>make install &&
|
---|
[75c492d] | 109 | mv -v /usr/sbin/update-usbids.sh /usr/sbin/update-usbids</userinput></screen>
|
---|
[1ed12e2d] | 110 |
|
---|
| 111 | </sect2>
|
---|
| 112 |
|
---|
| 113 | <sect2 role="commands">
|
---|
| 114 | <title>Command Explanations</title>
|
---|
| 115 |
|
---|
[564851b] | 116 | <para>
|
---|
| 117 | <option>--disable-zlib</option>: This stops
|
---|
[0d7900a] | 118 | <application>USB Utils</application> from installing a
|
---|
[564851b] | 119 | compressed <filename>usb.ids</filename> alongside the
|
---|
| 120 | uncompressed one.
|
---|
| 121 | </para>
|
---|
[1ed12e2d] | 122 |
|
---|
| 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 | <sect2 role="configuration">
|
---|
[564851b] | 126 | <title>Configuring USB Utils</title>
|
---|
| 127 |
|
---|
| 128 | <para>
|
---|
| 129 | The <filename>usb.ids</filename> data file is constantly being
|
---|
| 130 | updated. To get a current version of this file, run
|
---|
| 131 | <command>update-usbids</command> as the <systemitem
|
---|
| 132 | class="username">root</systemitem> user. This program requires the
|
---|
| 133 | <xref linkend="which"/> script or program to find <xref linkend="lynx"/>
|
---|
| 134 | or <xref linkend="wget"/> which are used to download the most current file,
|
---|
| 135 | and replace the existing file in
|
---|
| 136 | <filename class="directory">/usr/share/misc</filename>.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
| 140 | You may wish to add an entry to
|
---|
| 141 | <systemitem class="username">root</systemitem>'s (or any other user who has
|
---|
| 142 | write privilege to <filename class="directory">/usr/share/misc</filename>)
|
---|
| 143 | crontab to automatically update the <filename>usb.ids</filename> file
|
---|
| 144 | periodically.
|
---|
| 145 | </para>
|
---|
[1ed12e2d] | 146 |
|
---|
| 147 | </sect2>
|
---|
| 148 |
|
---|
| 149 | <sect2 role="content">
|
---|
| 150 | <title>Contents</title>
|
---|
| 151 |
|
---|
| 152 | <segmentedlist>
|
---|
| 153 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 154 | <segtitle>Installed Libraries</segtitle>
|
---|
| 155 | <segtitle>Installed Directories</segtitle>
|
---|
[1ed12e2d] | 156 |
|
---|
| 157 | <seglistitem>
|
---|
[564851b] | 158 | <seg>
|
---|
[586b174f] | 159 | lsusb, update-usbids, usb-devices, and usbhid-dump
|
---|
[564851b] | 160 | </seg>
|
---|
[c3c56b2] | 161 | <seg>
|
---|
| 162 | None
|
---|
| 163 | </seg>
|
---|
| 164 | <seg>
|
---|
| 165 | None
|
---|
| 166 | </seg>
|
---|
[1ed12e2d] | 167 | </seglistitem>
|
---|
| 168 | </segmentedlist>
|
---|
| 169 |
|
---|
| 170 | <variablelist>
|
---|
| 171 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 172 | <?dbfo list-presentation="list"?>
|
---|
| 173 | <?dbhtml list-presentation="table"?>
|
---|
| 174 |
|
---|
| 175 | <varlistentry id="lsusb">
|
---|
| 176 | <term><command>lsusb</command></term>
|
---|
| 177 | <listitem>
|
---|
[564851b] | 178 | <para>
|
---|
| 179 | is an utility for displaying information about all USB buses
|
---|
| 180 | in the system and all devices connected to them.
|
---|
| 181 | </para>
|
---|
[1ed12e2d] | 182 | <indexterm zone="usbutils lsusb">
|
---|
| 183 | <primary sortas="b-lsusb">lsusb</primary>
|
---|
| 184 | </indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
| 188 | <varlistentry id="update-usbids">
|
---|
| 189 | <term><command>update-usbids</command></term>
|
---|
| 190 | <listitem>
|
---|
[564851b] | 191 | <para>
|
---|
| 192 | downloads the current version of the USB ID list. Requires
|
---|
| 193 | <xref linkend="lynx"/> or <xref linkend="wget"/>.
|
---|
| 194 | </para>
|
---|
[1ed12e2d] | 195 | <indexterm zone="usbutils update-usbids">
|
---|
| 196 | <primary sortas="b-update-usbids">update-usbids</primary>
|
---|
| 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
[75c492d] | 200 |
|
---|
| 201 | <varlistentry id="usb-devices">
|
---|
| 202 | <term><command>usb-devices</command></term>
|
---|
| 203 | <listitem>
|
---|
[564851b] | 204 | <para>
|
---|
| 205 | is a shell script that displays details of USB buses and devices
|
---|
| 206 | connected to them. It is designed to be used if /proc/bus/usb/devices
|
---|
| 207 | is not available on your system.
|
---|
| 208 | </para>
|
---|
[75c492d] | 209 | <indexterm zone="usbutils usb-devices">
|
---|
| 210 | <primary sortas="b-usb-devices">usb-devices</primary>
|
---|
| 211 | </indexterm>
|
---|
| 212 | </listitem>
|
---|
| 213 | </varlistentry>
|
---|
| 214 |
|
---|
[564851b] | 215 | <varlistentry id="usbhid-dump">
|
---|
| 216 | <term><command>usbhid-dump</command></term>
|
---|
| 217 | <listitem>
|
---|
| 218 | <para>
|
---|
| 219 | is used to dump report descriptors and streams from HID
|
---|
| 220 | (human interface device) interfaces of USB devices.
|
---|
| 221 | </para>
|
---|
| 222 | <indexterm zone="usbutils usbhid-dump">
|
---|
| 223 | <primary sortas="b-usbhid-dump">usbhid-dump</primary>
|
---|
| 224 | </indexterm>
|
---|
| 225 | </listitem>
|
---|
| 226 | </varlistentry>
|
---|
| 227 |
|
---|
[1ed12e2d] | 228 | </variablelist>
|
---|
| 229 |
|
---|
| 230 | </sect2>
|
---|
| 231 |
|
---|
| 232 | </sect1>
|
---|