usbhidctl(1)

usbhidctl1

Manipulate usb hid devices

Usage

usbhidctl -f device [-t table] [-v] [-x] -r

usbhidctl -f device [-t table] [-l] [-v] [-x] [-z] -a

usbhidctl -f device [-t table] [-l] [-n] [-v] [-x] [-z] item ...

usbhidctl -f device [-t table] [-v] [-z] -w item=value ...

On the usbhidctl command line the page name is separated from the usage name with the character ‘:’. The collections are separated by the character ‘.’.

Overview

The usbhidctl utility can be used to dump and modify the state of a USB HID (Human Interface Device). Each named item is printed. If the -w flag is specified usbhidctl attempts to set the specified items to the given values.

The options are as follows:

-a

Show all items and their current values if device returns.

-f device

Specify a path name for the device to operate on.

-l

Loop and dump the device data every time it changes.

-n

Suppress printing of the item name.

-r

Dump the report descriptor.

-t table

Specify a path name for the HID usage table file.

-v

Be verbose.

-w

Change item values. Only 'output' and 'feature' kinds can be set with this option.

-x

Dump data in hexadecimal as well as decimal.

-z

Reset reports to zero before processing other arguments. If not specified, current values will be requested from device.

Files

/usr/share/misc/usb_hid_usages

The default HID usage table.

Releases

63 releases since FreeBSD 4.6-RELEASE; the text changed 37 times.

  1. 4.6–4.6.2
  2. 4.7–4.11
  3. 5.0–5.2.1
  4. 5.3–5.5
  5. 6.0–6.3
  6. 6.4
  7. 7.0
  8. 7.1
  9. 7.2
  10. 7.3
  11. 7.4
  12. 8.0
  13. 8.1
  14. 8.2
  15. 8.3
  16. 8.4
  17. 9.0
  18. 9.1
  19. 9.2
  20. 9.3
  21. 10.0
  22. 10.1
  23. 10.2
  24. 10.3
  25. 10.4
  26. 11.0
  27. 11.1
  28. 11.2
  29. 11.3
  30. 11.4
  31. 12.0
  32. 12.1
  33. 12.2
  34. 12.3
  35. 12.4
  36. 13.0–13.2
  37. 13.3–15.1
  38. 16.0

-w since FreeBSD 9.1-RELEASE; -x since FreeBSD 7.0-RELEASE; -z since FreeBSD 9.1-RELEASE.

History

The usbhidctl command appeared in NetBSD 1.4.

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.