Return to usbhidctl.1 CVS log

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

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

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