UNCLUTTER-XFIXES(1)

📦
version 1.6 · 6 versions
, in ubuntu noble, ubuntu questing

✨ unclutter-xfixes ✨

okay bestie, welcome to the unclutter-xfixes(1) page — section 1 of the manual, she's iconic, she's tiny, she hides your cursor 💅

🎀 NAME 🎀

unclutter-xfixes — a whole rewrite of unclutter, rebuilt on top of the X11-Xfixes extension 🦋

🌸 SYNOPSIS 🌸

unclutter [--timeout seconds] [--jitter radius] [--exclude-root]
[--ignore-scrolling] [--ignore-buttons buttons] [--hide-on-touch]
[--fork|-b] [--help|-h] [--version|-v] [--start-hidden]

Compatibility arguments, aka the blast-from-the-past pile 💀:

unclutter [--display|-d display] [--idle seconds] [--keystroke] [--grab]
[--noevents] [--reset] [--root] [--onescreen] [--not] name …

💖 DESCRIPTION 💖

She hides the mouse cursor when it isn't being used. That's the whole job. No cap. 🙈

This version of unclutter is a rewrite of the original, and she runs on the x11-xfixes extension — which means no fake windows and no pointer grabbing are needed at all. Literally none. Which means she plays way nicer with your window managers and your applications. Obsessed, honestly. ✨

💅 OPTIONS 💅

  • --timeout seconds — how many seconds of no cursor movement and no button presses before the cursor gets hidden. (Default: 5) ⏳
  • --jitter radius — cursor movements that are smaller than radius pixels? Ignored, bestie. She's not counting those. 🫶
  • --exclude-root — don't hide the cursor if it's just idling over the root window and not an actual window, because in that case it's literally not obscuring anything important, she's just chilling on the desktop background 🖼️
  • --ignore-scrolling — ignore mouse scroll events (buttons 4 and 5) so scrolling does not un-hide the cursor. This is a shortcut for --ignore-buttons 4,5. And if you wanna ignore horizontal scrolling too, use --ignore-buttons instead and list all the buttons yourself, like 4,5,6,7 💫
  • --ignore-buttons — sets which mouse buttons do not un-hide the cursor when you click them. You can pass a bunch of button numbers at once, just separate them with , 🍓
  • --hide-on-touch — hides the mouse cursor when touch events happen 👆
  • --start-hidden — the cursor starts out hidden. Main character entrance, but invisible. 👑
  • --fork|-b — fork unclutter off to the background 🌙
  • --help|-h — show the usage and dip out ✌️
  • --version|-v — show the version and dip out ⭐

😭 TROUBLESHOOTING 😭

🧚 --ignore-scrolling doesn't work

ngl this can happen, especially on trackpoints, when other button events get sent too — like the ones for horizontal scrolling. So your options are: try adding some jitter, or verify what's actually going on by using xev -event button. And if you want horizontal scrolling ignored as well, use --ignore-buttons instead of --ignore-scrolling. periodt 💀

🌈 COMPATIBILITY 🌈

So she can be a drop-in replacement for unclutter, unclutter-xfixes accepts all of unclutter's command line arguments… but she ignores most of them 💀 no thoughts, head empty, just vibes.

  • --display|-d display — specifies the X display to use. You can get the exact same effect by setting the DISPLAY environment variable 🖥️
  • --idle seconds — this argument is mapped onto --timeout 🔁
  • --keystroke — this argument is ignored 🙈
  • --grab — this argument is ignored 🙈
  • --noevents — this argument is ignored 🙈
  • --reset — this argument is ignored 🙈
  • --root — this argument does the opposite of --exclude-root. You shouldn't need to pass it, because this is the default behavior in unclutter-xfixes anyway ✨
  • --onescreen — this argument restricts unclutter to the single screen specified in --display, or to the default screen of the display 🪟
  • --not — this argument makes it so that all arguments that aren't options or option arguments get collected into a list, and that list specifies windows where the cursor shall not be removed. These are the windows where an element of the list matches, in a case insensitive comparison, the starting characters of either the WM_NAME, or the name or class of the WM_CLASS, properties of the window. (Note that this argument can be given anywhere on the command line.) 🔍

👑 AUTHOR 👑

Ingo Bürk 💜

and that's the whole page, bestie — this was the unclutter-xfixes(1) manual, dated 2024-04-01, from the UNCLUTTER-XFIXES(1) source, and she ate. no crumbs. bye mwah 🫶✨💅

📦 where this page comes from