HMS(4)

📦 version 15.1, in freebsd 14.5, freebsd 15.1, nixpkgs unstable

💅 HMS(4) — the HID mouse driver, bestie edition 🐭✨

okay so this is the hms manual page from the Kernel Interfaces Manual — it's the HID mouse driver and honestly? it's giving quiet luxury. no drama, just mice. let's get into it 🫶

🌸 NAME 🌸

hms — the HID mouse driver. that's it, that's the whole vibe. 🐭

✨ SYNOPSIS ✨

so if you wanna bake this driver into the kernel, you gotta drop these lines into your kernel configuration file, no cap:

device hms
device hidbus
device hid
device evdev

or — and this is the lowkey easier route — load it as a module at boot time by putting this line in loader.conf(5):

hms_load="YES"

pick your fighter, both slay 💅

🦋 DESCRIPTION 🦋

the hms driver provides support for HID mice that attach to the HID transport backend. see iichid(4) or usbhid(4) for the deets on that. 👀

what's supported, you ask? literally icons only:

  • mice with any number of buttons — yes, any, go feral 🎀
  • mice with a wheel 🎡
  • absolute mice ⭐

and the /dev/input/eventX device presents the mouse as a evdev type device. that's the whole thing. it's giving minimalism, it's giving main character. 🧚

🎀 SYSCTL VARIABLES 🎀

the following variable is available as both a sysctl(8) variable and a loader(8) tunable — dual threat, we love to see it:

  • dev.hms.X.debug — debug output level, where 0 is debugging disabled and larger values increase debug message verbosity. default is 0. basically: crank it up if you wanna see everything the driver's yapping about 🔥

its default value is derived from this loader(8) tunable:

hw.hid.hms.debug

💖 FILES 💖

  • /dev/input/eventX — the input event device node. that's the one. 🎯

🌈 SEE ALSO 🌈

iichid(4), usbhid(4), xorg.conf(5) (ports/x11/xorg)

go read them, iykyk 📚

💀 BUGS 💀

hms cannot act like sysmouse(4). nope. not happening. don't ask. 😭 (fr fr, that's the documented limitation, not me being dramatic)

👑 AUTHORS 👑

the hms driver was written by Vladimir Kondratyev <wulf@FreeBSD.org> 💜

this manual page was originally written by Nick Hibma <n_hibma@FreeBSD.org> for the umt(4) driver, and was adopted for hms by Vladimir Kondratyev <wulf@FreeBSD.org>. collaboration era 🫶

and that's the whole page, bestie 🎀✨ this one's from the Debian fam, dated September 12, 2020 — go forth and point-and-click with confidence 💅🐭

📦 where this page comes from