source: general/sysutils/usbutils.xml@ 8aeb474

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY usbutils-download-http "http://ftp.kernel.org/pub/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
  <!ENTITY usbutils-download-ftp  "ftp://ftp.kernel.org/pub/linux/utils/usb/usbutils/usbutils-&usbutils-version;.tar.xz">
  <!ENTITY usbutils-md5sum        "c9aa14ee3d6c991fda183f42cf72a8a8">
  <!ENTITY usbutils-size          "400 KB">
  <!ENTITY usbutils-buildsize     "6.0 MB">
  <!ENTITY usbutils-time          "0.1 SBU">
]>

<sect1 id="usbutils" xreflabel="USB Utils-&usbutils-version;">
  <?dbhtml filename="usbutils.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>USB Utils-&usbutils-version;</title>

  <indexterm zone="usbutils">
    <primary sortas="a-USB Utils">USB Utils</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to USB Utils</title>

    <para>
      The <application>USB Utils</application> package contains an utility
      used to display information about USB buses in the system and the
      devices connected to them.
    </para>

    &lfs72_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&usbutils-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&usbutils-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &usbutils-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &usbutils-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &usbutils-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &usbutils-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">USB Utils Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libusb"/> and
      <xref linkend="pkgconfig"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/usbutils"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of USB Utils</title>

    <para>
      Install <application>USB Utils</application> by
      running the following commands:
    </para>

<screen><userinput>./configure --prefix=/usr \
            --datadir=/usr/share/misc \
            --disable-zlib &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install &amp;&amp;
mv -v /usr/sbin/update-usbids.sh /usr/sbin/update-usbids</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <option>--disable-zlib</option>: This stops
      <application>USB Utils</application> from installing a 
      compressed <filename>usb.ids</filename>  alongside the
      uncompressed one.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring USB Utils</title>

    <para>
      The <filename>usb.ids</filename> data file is constantly being
      updated. To get a current version of this file, run
      <command>update-usbids</command> as the <systemitem
      class="username">root</systemitem> user. This program requires the
      <xref linkend="which"/> script or program to find <xref linkend="lynx"/>
      or <xref linkend="wget"/> which are used to download the most current file,
      and replace the existing file in
      <filename class="directory">/usr/share/misc</filename>.
    </para>

    <para>
      You may wish to add an entry to
      <systemitem class="username">root</systemitem>'s (or any other user who has
      write privilege to <filename class="directory">/usr/share/misc</filename>)
      crontab to automatically update the <filename>usb.ids</filename> file
      periodically.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>

      <seglistitem>
        <seg>
          lsusb, update-usbids, usb-devices and usbhid-dump
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="lsusb">
        <term><command>lsusb</command></term>
        <listitem>
          <para>
            is an utility for displaying information about all USB buses
            in the system and all devices connected to them.
          </para>
          <indexterm zone="usbutils lsusb">
            <primary sortas="b-lsusb">lsusb</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="update-usbids">
        <term><command>update-usbids</command></term>
        <listitem>
          <para>
            downloads the current version of the USB ID list. Requires
            <xref linkend="lynx"/> or <xref linkend="wget"/>.
          </para>
          <indexterm zone="usbutils update-usbids">
            <primary sortas="b-update-usbids">update-usbids</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="usb-devices">
        <term><command>usb-devices</command></term>
        <listitem>
          <para>
            is a shell script that displays details of USB buses and devices
            connected to them. It is designed to be used if /proc/bus/usb/devices
            is not available on your system.
          </para>
          <indexterm zone="usbutils usb-devices">
            <primary sortas="b-usb-devices">usb-devices</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="usbhid-dump">
        <term><command>usbhid-dump</command></term>
        <listitem>
          <para>
            is used to dump report descriptors and streams from HID
            (human interface device) interfaces of USB devices.
          </para>
          <indexterm zone="usbutils usbhid-dump">
            <primary sortas="b-usbhid-dump">usbhid-dump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>