xref: /freebsd/usr.bin/usbhidctl/usbhidctl.1 (revision 3642298923e528d795e3a30ec165d2b469e28b40)
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.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"        This product includes software developed by the NetBSD
21.\"        Foundation, Inc. and its contributors.
22.\" 4. Neither the name of The NetBSD Foundation nor the names of its
23.\"    contributors may be used to endorse or promote products derived
24.\"    from this software without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36.\" POSSIBILITY OF SUCH DAMAGE.
37.\"
38.Dd July 12, 1998
39.Dt USBHIDCTL 1
40.Os
41.Sh NAME
42.Nm usbhidctl
43.Nd manipulate USB HID devices
44.Sh SYNOPSIS
45.Nm
46.Op Fl a
47.Fl f Ar device
48.Op Fl l
49.Op Fl n
50.Op Fl r
51.Op Fl t Ar table
52.Op Fl v
53.Op Ar item ...
54.Sh DESCRIPTION
55The
56.Nm
57utility can be used to dump the state of a USB HID (Human Interface Device).
58Each named
59.Ar item
60is printed.
61.Pp
62The options are as follows:
63.Bl -tag -width Ds
64.It Fl a
65Show all items.
66.It Fl f Ar device
67Specify a path name for the device to operate on.
68.It Fl l
69Loop and dump the device data every time it changes.
70.It Fl n
71Suppress printing of the item name.
72.It Fl r
73Dump the report descriptor.
74.It Fl t Ar table
75Specify a path name for the HID usage table file.
76.It Fl v
77Be verbose.
78.El
79.Sh FILES
80.Pa /usr/share/misc/usb_hid_usages
81The default HID usage table.
82.Sh SEE ALSO
83.Xr usbhid 3 ,
84.Xr uhid 4 ,
85.Xr usb 4
86.Sh HISTORY
87The
88.Nm
89command appeared in
90.Nx 1.4 .
91.Sh BUGS
92The
93.Nm
94utility cannot show nor set output and feature items.
95