.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DUMP_USB 1p"
.TH DUMP_USB 1p 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
dump_usb.pl \- Use Device::USB to list USB devices.
.SH VERSION
.IX Header "VERSION"
Version 0.37
.SH SYNOPSIS
.IX Header "SYNOPSIS"
The \f(CW\*(C`dump_usb.pl\*(C'\fR program provides a relatively crude dump of the information
available from any USB devices installed on the system.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides a Perl interface to the C library libusb. This library
supports a relatively full set of functionality to access a USB device. In
addition to the libusb, functioality, Device::USB provides a few
convenience features that are intended to produce a more Perl-ish interface.
.PP
If called without arguments, the program lists all installed USB devices on
all busses. This is just a Data::Dumper dump of the structures, so it is not
the most user friendly output in the world. (However, the program was only
intended as a \fIquick hack\fR to verify that Device::USB was working.)
.PP
If called with arguments, they are expected to be a vendor id and a product id.
(These arguments can be in hex if you precede them with \f(CW\*(C`0x\*(C'\fR.) The program
searches for a device that matches that vendor id and product id. If it finds
one, the device \fIfilename\fR is printed, along with the vendor and product ids.
.PP
If the program can open the device, it will also print the manufacture name
and product name as reported by the device.
.SH DEPENDENCIES
.IX Header "DEPENDENCIES"
This module depends on the Device::USB and Data::Dumper modules, as
well as the strict and warnings pragmas. Obviously, libusb must be available
for Device::USB to function.
.SH AUTHOR
.IX Header "AUTHOR"
G. Wade Johnson (wade at anomaly dot org)
Paul Archer (paul at paularcher dot org)
.PP
Houston Perl Mongers Group
.SH BUGS
.IX Header "BUGS"
The output format is extremely non-friendly.
.PP
The program only returns the first matching USB device.
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-maze\-svg1@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Device::USB>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
.SH ACKNOWLEDGEMENTS
.IX Header "ACKNOWLEDGEMENTS"
Thanks go to various members of the Houston Perl Mongers group for input
on the module. But thanks mostly go to Paul Archer who proposed the project
and helped with the development.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2006 Houston Perl Mongers
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
