Return to usbhidctl.1 CVS log

Up to [local] / src / usr.bin / usbhidctl

Annotation of src/usr.bin/usbhidctl/usbhidctl.1, Revision 1.3

1.3     ! pvalchev    1: .\" $OpenBSD: usbhidctl.1,v 1.2 2001/09/02 18:16:37 jakob Exp $
1.1       pvalchev    2: .\" $NetBSD: usbhidctl.1,v 1.10 2000/09/24 02:27:12 augustss Exp $
                      3: .\"
                      4: .\" Copyright (c) 2000 The NetBSD Foundation, Inc.
                      5: .\" All rights reserved.
                      6: .\"
                      7: .\" This code is derived from software contributed to The NetBSD Foundation
                      8: .\" by David Sainty <David.Sainty@dtsp.co.nz>
                      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 August 27, 2000
                     39: .Dt USBHIDCTL 1
                     40: .Os
                     41: .Sh NAME
                     42: .Nm usbhidctl
                     43: .Nd manipulate USB HID devices
                     44: .Sh SYNOPSIS
1.2       jakob      45: .Nm
1.1       pvalchev   46: .Fl f Ar device
                     47: .Op Fl t Ar table
                     48: .Op Fl l
                     49: .Op Fl v
                     50: .Fl a
1.2       jakob      51: .Pp
                     52: .Nm
1.1       pvalchev   53: .Fl f Ar device
                     54: .Op Fl t Ar table
                     55: .Op Fl v
                     56: .Fl r
1.2       jakob      57: .Pp
                     58: .Nm
1.1       pvalchev   59: .Fl f Ar device
                     60: .Op Fl t Ar table
                     61: .Op Fl l
                     62: .Op Fl n
                     63: .Op Fl v
                     64: .Op Ar item ...
1.2       jakob      65: .Pp
                     66: .Nm
1.1       pvalchev   67: .Fl f Ar device
                     68: .Op Fl t Ar table
                     69: .Fl w
                     70: .Op Ar item=value ...
                     71: .Sh DESCRIPTION
                     72: .Nm
                     73: can be used to dump or modify the state of a USB HID (Human Interface Device).
                     74: If a list of items is present on the command line, then
                     75: .Nm
                     76: prints the current value of those items for the specified device.  If the
                     77: .Fl w
                     78: flag is specified
                     79: .Nm
                     80: attempts to set the specified items to the given values.
                     81: .Pp
                     82: The options are as follows:
                     83: .Bl -tag -width Ds
                     84: .It Fl a
                     85: Show all items and their current values.
                     86: .It Fl f Ar device
                     87: Specify a path name for the device to operate on.  If
                     88: .Ar device
                     89: is numeric, it is taken to be the USB HID device number.  If it is a relative
                     90: path, it is taken to be the name of the device under
                     91: .Pa /dev .
                     92: An absolute path is taken to be the literal device pathname.
                     93: .It Fl l
                     94: Loop and dump the device data every time it changes.  Only 'input' items are
                     95: displayed in this mode.
                     96: .It Fl n
                     97: Suppress printing of the item name when querying specific item values.
                     98: .It Fl r
                     99: Dump the report descriptor.
                    100: .It Fl t Ar table
                    101: Specify a path name for the HID usage table file.
                    102: .It Fl v
                    103: Be verbose.  Repeating this option increases verbosity.
                    104: .It Fl w
                    105: Change item values.  Only 'output' and 'feature' kinds can be set with this
                    106: option.
                    107: .El
                    108: .Sh FILES
                    109: .Pa /usr/share/misc/usb_hid_usages
                    110: The default HID usage table.
                    111: .Sh SEE ALSO
1.3     ! pvalchev  112: .Xr usbhid 3 ,
1.1       pvalchev  113: .Xr uhid 4 ,
                    114: .Xr usb 4
                    115: .Sh AUTHOR
                    116: David Sainty <David.Sainty@dtsp.co.nz>
                    117: .Sh HISTORY
                    118: The
                    119: .Nm
                    120: command first appeared in
                    121: .Ox 3.0 .
                    122: .Sh BUGS
                    123: Some USB HID devices report multiple items with exactly the same description.
                    124: The current naming scheme does not provide the means to specify which of the
                    125: identically named items you are referring to.