compass(6x)

🧭 compass — the spinning compass screensaver (from the XScreenSaver manual, bestie)

okay so picture this: a compass. but it's spinning. that's the whole bit. welcome to compass from the XScreenSaver family, and honestly? it's giving nautical chaos in the best way 💅

---

✨ SYNOPSIS ✨

compass [--display host:display.screen] [--visual visual] [--window]
        [--root] [--window-id number] [--delay number] [--no-db] [--fps]

that's it. that's the whole invocation. you literally just run it and vibe 🦋

---

🌸 DESCRIPTION 🌸

This one draws a compass — y'know, the pointy-north thing — except every single element is spinning around randomly, which serves up exactly that "lost and nauseous" feeling. no cap. that's the design goal, it's not a bug, it's the aesthetic 😭✨

---

🎀 OPTIONS 🎀

• --visual visual — picks which visual to use. legal values are either the name of a visual class, or the id number (decimal or hex, go off) of one specific visual.
• --window — draws on a newly-created window. this is the default, main character behavior 👑
• --root — draws on the root window instead.
• --window-id number — draws on the window you specify. you pick, bestie.
• --delay number — per-frame delay, measured in microseconds. default is 20000, which is 0.02 seconds. (yes, microseconds. she's precise 💅)
• --db | --no-db — Double Buffer. it's a Boolean, so it's either on or off, no in-between situationship.
• --fps — displays the current frame rate and CPU load. great for when you wanna know exactly how hard your machine is sweating 🔥

---

🌈 ENVIRONMENT 🌈

• DISPLAY — used to get the default host and display number.
• XENVIRONMENT — used to get the name of a resource file that overrides the global resources stored in the RESOURCE_MANAGER property. fancy, i know 💜
• XSCREENSAVER_WINDOW — the window ID to use with --root.

---

🦋 SEE ALSO 🦋

X(1), xscreensaver(1) — go read those too, iykyk 🫶

---

⭐ COPYRIGHT ⭐

Copyright © 2002 by Jamie Zawinski. Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

okay little legal moment but it genuinely means a lot: you can do basically whatever with this, just keep the copyright notice and this permission notice with it, and know that there's no warranty, express or implied — it's as-is, so no suing if your compass spins somewhere unhinged 🙈

---

🧚 AUTHOR 🧚

Jamie Zawinski.

---

and that's the whole page, bestie — written by Jamie Zawinski, from X Version 11, 6.09 dated 07-Jun-2024, and filed under compass(6x) in the XScreenSaver manual. go spin something 💖✨