source: general/sysutils/usbutils.xml@ a41f643

<?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 "&sourceforge-repo;/linux-usb/usbutils-&usbutils-version;.tar.gz">
  <!ENTITY usbutils-download-ftp  " ">
  <!ENTITY usbutils-md5sum        "34979f675d2bcb3e1b45012fa830a53f">
  <!ENTITY usbutils-size          "246 KB">
  <!ENTITY usbutils-buildsize     "2 MB">
  <!ENTITY usbutils-time          "less than 0.1 SBU">
]>

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

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

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

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

  <sect2 role="package">
    <title>Introduction to usbutils</title>

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

    &lfs65_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">usbutils Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libusb-compat"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of usbutils</title>

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

<screen><userinput>./configure --prefix=/usr --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><parameter>--disable-zlib</parameter>: This stops
    <application>usbutils</application> from installing a compressed usb.ids
    alongside the uncompressed one.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring usbutils</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="wget"/>
    or <xref linkend="lynx"/> which are used to download the most current file,
    and replace the existing file in
    <filename class='directory'>/usr/share</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</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>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>lsusb, update-usbids, and usb-devices</seg>
        <seg>None</seg>
        <seg>None</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 a 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="wget"/> or <xref linkend="lynx"/>.</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>
          <!-- /proc/bus/usb/devices is scheduled to be moved from usbfs to
               debugfs in linux-2.6.31. -->
          <indexterm zone="usbutils usb-devices">
            <primary sortas="b-usb-devices">usb-devices</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>