source: general/sysutils/usbutils.xml@ deb4808

trunk
Last change on this file since deb4808 was deb4808, checked in by Douglas R. Reno <renodr@…>, 3 months ago

usbutils: Add missing bridgehead

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