xref: /freebsd/usr.bin/usbhidctl/usbhidctl.1 (revision 7aa383846770374466b1dcb2cefd71bde9acf463)
1.\" $NetBSD: usbhidctl.1,v 1.8 1999/05/11 21:03:58 augustss Exp $
2.\" $FreeBSD$
3.\"
4.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
5.\" All rights reserved.
6.\"
7.\" This code is derived from software contributed to The NetBSD Foundation
8.\" by Lennart Augustsson.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29.\" POSSIBILITY OF SUCH DAMAGE.
30.\"
31.Dd November 23, 2006
32.Dt USBHIDCTL 1
33.Os
34.Sh NAME
35.Nm usbhidctl
36.Nd manipulate USB HID devices
37.Sh SYNOPSIS
38.Nm
39.Op Fl a
40.Fl f Ar device
41.Op Fl l
42.Op Fl n
43.Op Fl r
44.Op Fl t Ar table
45.Op Fl v
46.Op Fl x
47.Op Ar item ...
48.Sh DESCRIPTION
49The
50.Nm
51utility can be used to dump the state of a USB HID (Human Interface Device).
52Each named
53.Ar item
54is printed.
55.Pp
56The options are as follows:
57.Bl -tag -width Ds
58.It Fl a
59Show all items.
60.It Fl f Ar device
61Specify a path name for the device to operate on.
62.It Fl l
63Loop and dump the device data every time it changes.
64.It Fl n
65Suppress printing of the item name.
66.It Fl r
67Dump the report descriptor.
68.It Fl t Ar table
69Specify a path name for the HID usage table file.
70.It Fl v
71Be verbose.
72.It Fl x
73Dump data in hexadecimal as well as decimal.
74.El
75.Sh FILES
76.Pa /usr/share/misc/usb_hid_usages
77The default HID usage table.
78.Sh SEE ALSO
79.Xr usbhid 3 ,
80.Xr uhid 4 ,
81.Xr usb 4
82.Sh HISTORY
83The
84.Nm
85command appeared in
86.Nx 1.4 .
87.Sh BUGS
88The
89.Nm
90utility cannot show nor set output and feature items.
91