hyprcursor-util(1)

💖 hyprcursor-util 💖

okay bestie, welcome to hyprcursor-util(1) — the user manual, but make it a group chat. this is a utility to compile, pack, unpack, etc. hyprcursor and xcursor themes. yep. she does it all. 👑

---

✨ NAME ✨

hyprcursor-util — a utility to compile, pack, unpack, etc. hyprcursor and xcursor themes

like literally the little multitool of cursor themes. compile? yes. pack? yes. unpack? yes. "etc."? also yes. 💅

---

🌈 SYNOPSIS 🌈

hyprcursor-util -c <path> [-o <dir>]

hyprcursor-util -x <path> [-o <dir>] [--resize [mode]]

so you got two whole modes of existence here, and that's the vibe check. 🦋

---

🎀 OPTIONS 🎀

• -c <path>, --create <path> — create a compiled hyprcursor theme from a working state. take your cute little working-state folder and slay it into a real compiled theme. ✨
• -x <path>, --extract <path> — extract an xcursor theme into a working state. ngl this one is the social butterfly of the two, because it uses the external program xcur2png(1) to convert xcursor theme files into the format that hyprcursor needs. so it's not doing it alone, it's calling in a friend. 🫶
• -o <path-to-dir>, --output <path-to-dir> — both --create and --extract support the -output option to specify an output directory.

🚨 okay listen. for safety reasons, do not use this on versions below 0.1.1 because it will nuke the specified directory without asking. not "tidy it up", not "move things around" — nuke. literally obliterate. so check your version first bestie, i am begging. 💀

since v0.1.2, this directory is the parent, and the theme will be written to a subdirectory in it called ACTION_NAME. so it's giving "here's the neighborhood, the house goes inside it". 🏡

• --resize [mode] — for use with the --extract option. specify a default resize algorithm for shapes. default is none. so if you don't say anything, she's just gonna leave those shapes exactly the size they came in. lowkey respectful of her honestly. 🙈
• -v, --version — print info about the version of hyprcursor-util. the classic "who even am i" flag, but make it productive. ⭐

---

🦋 DESCRIPTION 🦋

so here's the tea: cursor themes can be in 3 states, and you gotta know which one you're holding. 🫧

• compiled hyprcursor — these can be used by apps / compositors
• compiled xcursor — these can be used by xcursor
• working state — an easy to navigate mode where every cursor is a png/svg, and all the meta is in files

like, that last one? that's the one you actually want to poke around in. every cursor is a png or an svg, all the meta lives in plain files, it's so readable, it's giving open book. 📖✨ the compiled ones are the final form — they're what apps and compositors and xcursor actually consume, but they are not chatty about it.

---

💜 AUTHORS 💜

this man page is written for the Debian GNU/Linux system by Alan M Varghese. and the info in this page is collected from the official README file included with hyprcursor-util source files. so credit where credit is due, periodt. 🫡

---

and that's the whole page, bestie!! 🎉 go forth and theme your cursors, you absolute icon. stay safe with that -o flag, check your versions, and remember: hyprcursor-util(1) — the user manual, the moment, the legend. 🌸💖 from the hyprcursor-util User Manual, signing off. mwah. 💅✨