usr.bin/usbhidctl/usbhidctl.1

   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 August 1, 2011
  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 v
  49 .Op Fl x
  50 .Fl r
  51 .Nm
  52 .Fl f Ar device
  53 .Op Fl t Ar table
  54 .Op Fl l
  55 .Op Fl v
  56 .Op Fl x
  57 .Op Fl z
  58 .Fl a
  59 .Nm
  60 .Fl f Ar device
  61 .Op Fl t Ar table
  62 .Op Fl l
  63 .Op Fl n
  64 .Op Fl v
  65 .Op Fl x
  66 .Op Fl z
  67 .Ar item ...
  68 .Nm
  69 .Fl f Ar device
  70 .Op Fl t Ar table
  71 .Op Fl v
  72 .Op Fl z
  73 .Fl w
  74 .Ar item=value ...
  75 .Sh DESCRIPTION
  76 The
  77 .Nm
  78 utility can be used to dump and modify the state of a USB HID (Human
  79 Interface Device).
  80 Each named
  81 .Ar item
  82 is printed.
  83 If the
  84 .Fl w
  85 flag is specified
  86 .Nm
  87 attempts to set the specified items to the given values.
  88 .Pp
  89 The options are as follows:
  90 .Bl -tag -width Ds
  91 .It Fl a
  92 Show all items and their current values if device returns.
  93 .It Fl f Ar device
  94 Specify a path name for the device to operate on.
  95 .It Fl l
  96 Loop and dump the device data every time it changes.
  97 .It Fl n
  98 Suppress printing of the item name.
  99 .It Fl r
 100 Dump the report descriptor.
 101 .It Fl t Ar table
 102 Specify a path name for the HID usage table file.
 103 .It Fl v
 104 Be verbose.
 105 .It Fl w
 106 Change item values.
 107 Only 'output' and 'feature' kinds can be set with this option.
 108 .It Fl x
 109 Dump data in hexadecimal as well as decimal.
 110 .It Fl z
 111 Reset reports to zero before processing other arguments.
 112 If not specified, current values will be requested from device.
 113 .El
 114 .Sh SYNTAX
 115 .Nm
 116 compares the names of items specified on the command line against the human
 117 interface items reported by the USB device.
 118 Each human interface item is mapped from its native form to a human readable
 119 name, using the HID usage table file.
 120 Command line items are compared with the generated item names,
 121 and the USB HID device is operated on when a match is found.
 122 .Pp
 123 Each human interface item is named by the
 124 .Qq page
 125 it appears in, the
 126 .Qq usage
 127 within that page, and the list of
 128 .Qq collections
 129 containing the item.
 130 Each collection in turn is also identified by page, and
 131 the usage within that page.
 132 .Pp
 133 On the
 134 .Nm
 135 command line the page name is separated from the usage name with the character
 136 .Sq Cm \&: .
 137 The collections are separated by the character
 138 .Sq Cm \&. .
 139 .Pp
 140 Some devices give the same name to more than one item.
 141 .Nm
 142 supports isolating each item by appending a
 143 .Sq Cm \&# .
 144 character and a decimal item instance number, starting at zero.
 145 .Sh FILES
 146 .Pa /usr/share/misc/usb_hid_usages
 147 The default HID usage table.
 148 .Sh SEE ALSO
 149 .Xr usbhid 3 ,
 150 .Xr uhid 4 ,
 151 .Xr usb 4
 152 .Sh HISTORY
 153 The
 154 .Nm
 155 command appeared in
 156 .Nx 1.4 .