usr.bin/usbhidctl/usbhidctl.1

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