d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e9f7ad1fa4
freebsd-nq/usr.bin/usbhidctl/usbhidctl.1

150 lines
4.0 KiB
Groff
Raw Normal View History

Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.\" $NetBSD: usbhidctl.1,v 1.8 1999/05/11 21:03:58 augustss Exp $
.\" $FreeBSD$
.\"
.\" Copyright (c) 1998 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Lennart Augustsson.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
Fix style nit: don't use leading zero for dates in .Dd Prompted by: brueffer Approved by: brueffer MFC after: 3 days
2012-06-05 03:14:39 +00:00
.Dd August 1, 2011
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Dt USBHIDCTL 1
.Os
.Sh NAME
.Nm usbhidctl
.Nd manipulate USB HID devices
.Sh SYNOPSIS
.Nm
.Fl f Ar device
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
.Op Fl t Ar table
.Op Fl v
.Op Fl x
.Fl r
.Nm
.Fl f Ar device
.Op Fl t Ar table
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Op Fl l
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
.Op Fl v
.Op Fl x
Add support for -z option for reading operations. It allows to not request current values from device, but only receive changes.
2012-05-16 20:30:20 +00:00
.Op Fl z
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
.Fl a
.Nm
.Fl f Ar device
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Op Fl t Ar table
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
.Op Fl l
.Op Fl n
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Op Fl v
Add option -x to display output values in hex in addition to decimal.
2006-11-23 00:20:54 +00:00
.Op Fl x
Add support for -z option for reading operations. It allows to not request current values from device, but only receive changes.
2012-05-16 20:30:20 +00:00
.Op Fl z
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
.Ar item ...
.Nm
.Fl f Ar device
.Op Fl t Ar table
.Op Fl v
.Op Fl z
.Fl w
.Ar item=value ...
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Sh DESCRIPTION
Use `The .Nm utility'
2002-04-20 12:18:28 +00:00
The
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Nm
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
utility can be used to dump and modify the state of a USB HID (Human
Interface Device).
Rename the ``name'' argument to ``item'' and mark it up as an argument. Make use of the marked up argument to clarify the text in the DESCRIPTION section. Insert a missing word: ``the''. Make the phrase in the BUGS section a full sentence. Sort the cross-references in the SEE ALSO section correctly.
2000-07-20 11:39:14 +00:00
Each named
.Ar item
is printed.
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
If the
.Fl w
flag is specified
.Nm
attempts to set the specified items to the given values.
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl a
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
Show all items and their current values if device returns.
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.It Fl f Ar device
Rename the ``name'' argument to ``item'' and mark it up as an argument. Make use of the marked up argument to clarify the text in the DESCRIPTION section. Insert a missing word: ``the''. Make the phrase in the BUGS section a full sentence. Sort the cross-references in the SEE ALSO section correctly.
2000-07-20 11:39:14 +00:00
Specify a path name for the device to operate on.
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.It Fl l
Loop and dump the device data every time it changes.
.It Fl n
Suppress printing of the item name.
.It Fl r
Dump the report descriptor.
.It Fl t Ar table
Specify a path name for the HID usage table file.
.It Fl v
Be verbose.
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
.It Fl w
Change item values.
Only 'output' and 'feature' kinds can be set with this option.
Add option -x to display output values in hex in addition to decimal.
2006-11-23 00:20:54 +00:00
.It Fl x
Dump data in hexadecimal as well as decimal.
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
.It Fl z
Add support for -z option for reading operations. It allows to not request current values from device, but only receive changes.
2012-05-16 20:30:20 +00:00
Reset reports to zero before processing other arguments.
If not specified, current values will be requested from device.
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.El
MFprojects/hid: Import the rest of HID improvements from the branch: - improve report descriptor parser in libusbhid to handle several kinds of reports same time; - add to the libusbhid API two functions wrapping respective kernel IOCTLs for reading and writing reports; - tune uhid IOCTL interface to allow reading and writing arbitrary report, when multiple supported by the device; - teach usbhidctl to set output and feature reports; - make usbhidaction support all the same item names as bhidctl. Sponsored by: iXsystems, inc.
2011-09-28 14:52:25 +00:00
.Sh SYNTAX
.Nm
compares the names of items specified on the command line against the human
interface items reported by the USB device.
Each human interface item is mapped from its native form to a human readable
name, using the HID usage table file.
Command line items are compared with the generated item names,
and the USB HID device is operated on when a match is found.
.Pp
Each human interface item is named by the
.Qq page
it appears in, the
.Qq usage
within that page, and the list of
.Qq collections
containing the item.
Each collection in turn is also identified by page, and
the usage within that page.
.Pp
On the
.Nm
command line the page name is separated from the usage name with the character
.Sq Cm \&: .
The collections are separated by the character
.Sq Cm \&. .
.Pp
Some devices give the same name to more than one item.
.Nm
supports isolating each item by appending a
.Sq Cm \&# .
character and a decimal item instance number, starting at zero.
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Sh FILES
.Pa /usr/share/misc/usb_hid_usages
The default HID usage table.
.Sh SEE ALSO
Correct reference to a non existant man page.
2004-01-04 16:34:16 +00:00
.Xr usbhid 3 ,
Rename the ``name'' argument to ``item'' and mark it up as an argument. Make use of the marked up argument to clarify the text in the DESCRIPTION section. Insert a missing word: ``the''. Make the phrase in the BUGS section a full sentence. Sort the cross-references in the SEE ALSO section correctly.
2000-07-20 11:39:14 +00:00
.Xr uhid 4 ,
.Xr usb 4
Add the usbhidctl utility, from NetBSD, by Lennart Augusst
2000-07-05 17:43:33 +00:00
.Sh HISTORY
The
.Nm
command appeared in
.Nx 1.4 .
Reference in New Issue Copy Permalink