ums(4)

ums4

Usb mouse driver

Usage

device hid device uhci device ohci device usb device ums

In loader.conf(5): ums_load="YES"

Overview

The ums driver provides support for mice that attach to the USB port. Supported are mice with any number of buttons and mice with a wheel.

The /dev/ums0 device presents the mouse as a sysmouse or mousesystems type device. See moused(8) for an explanation of these mouse types.

Sysctl variables

The following variables are available as both sysctl(8) variables and loader(8) tunables:

hw.usb.ums.debug

Debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. Default is 0.

Files

/dev/ums0

blocking device node

Examples

Use the first USB mouse on the system as your console mouse:

moused -p /dev/ums0 -t auto

To be able to use the USB mouse under X, change the "Pointer" section in xorg.conf to the following:

Device /dev/ums0
Protocol Auto

If you want to be able to use the mouse in both virtual consoles as well as in X change it to:

Device /dev/sysmouse
Protocol Auto

Releases

74 releases since FreeBSD 3.3-RELEASE; the text changed 45 times.

  1. 3.3
  2. 3.4
  3. 3.5–3.5.1
  4. 4.0
  5. 4.1–4.2
  6. 4.3
  7. 4.4–4.9
  8. 4.10–4.11
  9. 5.0–5.2.1
  10. 5.3
  11. 5.4–5.5
  12. 6.0–6.2
  13. 6.3
  14. 6.4
  15. 7.0
  16. 7.1
  17. 7.2
  18. 7.3
  19. 7.4
  20. 8.0
  21. 8.1
  22. 8.2
  23. 8.3
  24. 8.4
  25. 9.0
  26. 9.1
  27. 9.2
  28. 9.3
  29. 10.0
  30. 10.1
  31. 10.2
  32. 10.3
  33. 10.4
  34. 11.0
  35. 11.1
  36. 11.2
  37. 11.3
  38. 11.4
  39. 12.0
  40. 12.1
  41. 12.2
  42. 12.3
  43. 12.4
  44. 13.0–13.2
  45. 13.3–15.1
  46. 16.0

Authors

The ums driver was written by Lennart Augustsson ⟨[email protected]⟩ for NetBSD and was adopted for FreeBSD by MAEKAWA Masahide ⟨[email protected]⟩.

This manual page was written by Nick Hibma ⟨[email protected]⟩ with input from Kazutaka YOKOTA ⟨[email protected]⟩.

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