UMS(4)

💖 UMS(4) 💖 — the USB mouse driver, bestie edition 🐭✨

okay so. <cyan>ums</cyan> is the kernel driver for mice that plug into your USB port. she's the section 4 kernel interfaces manual girlie. let's get into it 🫶

---

✨ NAME ✨

ums — USB mouse driver 💅

---

🌸 SYNOPSIS 🌸

so to compile this driver into the kernel, you literally just drop these lines into your kernel configuration file:

device ums
device uhci
device ohci
device usb

alternatively — and this is the path i'd take ngl — to load the driver as a module at boot time, put this line in loader.conf(5):

ums_load="YES"

no cap: you need all four device lines if you're going the compile-it-in route. don't skip uhci, ohci or usb, bestie, the mouse needs her whole entourage 👑

---

🦋 DESCRIPTION 🦋

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. yes, any number. multi-button icons, we see you, we love you 😭💖

the /dev/ums0 device presents the mouse as a sysmouse or mousesystems type device. see moused(8) for an explanation of these mouse types — she explains it better than i ever could, fr fr.

---

⭐ SYSCTL VARIABLES ⭐

the following variables are available as both sysctl(8) variables and loader(8) tunables (the way they serve double duty? it's giving versatile 👑):

• hw.usb.ums.debug — debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. default is 0.

so like: leave it at 0 unless you're out here hunting bugs, in which case crank that number up and let her yap 🗣️

---

🎀 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

the /dev/sysmouse glow-up is the move if you want one mouse config to rule both your console and your X session. main character energy fr 💅

---

💜 SEE ALSO 💜

ohci(4), sysmouse(4), uhci(4), usb(4), xorg.conf(5) (ports/x11/xorg), moused(8)

---

👑 AUTHORS 👑

the ums driver was written by Lennart Augustsson <augustss@cs.chalmers.se> for NetBSD, and was adopted for FreeBSD by MAEKAWA Masahide <bishop@rr.iij4u.or.jp>.

this manual page was written by Nick Hibma <n_hibma@FreeBSD.org> with input from Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>.

---

and that's the whole page, bestie 🫶 this one's brought to you by the Debian girlies, dated April 24, 2018 — shoutout to them for keeping the ums(4) lore alive all this time, we're obsessed 💖🎀🐭