xref: /freebsd/usr.sbin/usbconfig/usbconfig.8 (revision 94b7ebd774d11563c9b314fcde5f09f06cb29335)
1.\" $FreeBSD$
2.\"
3.\" Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd November 1, 2009
27.Dt USBCONFIG 8
28.Os
29.Sh NAME
30.Nm usbconfig
31.Nd configure the USB subsystem
32.Sh SYNOPSIS
33.Nm
34.Op Fl u Ar unit
35.Op Fl a Ar addr
36.Op cmds...
37.Sh DESCRIPTION
38The
39.Nm
40utility is used to configure and dump information about the USB subsystem.
41.Pp
42The options are as follows:
43.Bl -tag -width "        "
44.It Fl u Ar unit
45Limit device range to USB devices connected to the given USBUS unit.
46.It Fl a Ar addr
47Limit device range to the given USB device index.
48Should only be used in conjunction with the unit argument.
49.It Fl h
50Show help and available commands.
51.El
52.Pp
53When called without options,
54.Nm
55prints a list of all available USB devices.
56.Sh EXAMPLES
57Show information about the device on USB bus 1 at address 2:
58.Pp
59.Dl usbconfig -u 1 -a 2 dump_info
60.Sh SEE ALSO
61.Xr usb 4
62