ZZZ(8)

💤 ZZZ(8) 💤 — zzz, ZZZ: suspend or hibernate your computer 🫶

✨ NAME ✨

zzz, ZZZ — suspend or hibernate your computer. No cap, that’s the whole mission. 💅

🌸 SYNOPSIS 🌸

zzz [-v] [-n|s|S|z|Z|H|X|R|V|h]
ZZZ [-v] [-n|s|S|z|Z|H|X|R|V|h]

🦋 DESCRIPTION 🦋

Okay so zzz is a simple program to suspend or hibernate your computer. It supports hooks before and after suspending. Like, it handles the sleepy-time vibes and lets your hook scripts do their little routines around it. ✨

💖 OPTIONS 💖

• -n — Dry-run mode. Instead of performing an ACPI action, zzz will just sleep for a few seconds. Pretend nap era, lowkey iconic. 😴
• -s, -S — Enter low-power idle mode (ACPI S1, kernel name freeze). Chill mode activated. 🧊
• -z — Enter suspend to RAM mode (ACPI S3, kernel name mem). This is the default for zzz. 🫶
• -Z — Enter hibernate to disk mode (ACPI S4, kernel name disk) and power off. This is the default for ZZZ. 💤
• -H — Enter hibernate to disk mode and suspend. This is also known as suspend-hybrid. Hybrid queen behavior. 👑
• -X — Enter hibernate to disk mode and shutdown. This can be used when ACPI S4 mode causes issues. Emergency vibe check. 🚨
• -R — Enter hibernate to disk mode and reboot. This can be used to switch operating systems. Reboot era. 🔁
• -v — Be verbose. Give me all the lore. 🗣️
• -V — Print program name & version and exit. Little identity check. 🪪
• -h — Print help message and exit. Help bestie out. 🆘

🎀 FILES 🎀

• /etc/zzz.d/* — Hook scripts found in this directory are executed before/after the system is suspended/resumed by zzz. ✨
• /etc/zzz.d/suspend/* — Hook scripts found in this directory are executed before the system is suspended by zzz. This directory is supported for compatibility with zzz(8) on Void Linux. 🐧
• /etc/zzz.d/resume/* — Hook scripts found in this directory are executed after the system is resumed. This directory is supported for compatibility with zzz(8) on Void Linux. 🐧

The hook script is a regular file (or a symlink) owned by root, executable by the owner and not writeable by others. Any other files found in the aforesaid directories are ignored. Rules are rules, bestie. 🫡

The hook scripts are executed sequentially in alphabetic order with two arguments:

1. “pre” (before suspend), or “post” (after resume),
2. the same as ZZZ_MODE (see below).

And the following environment variables:

• ZZZ_MODE — The selected suspend mode; one of “hibernate”, “noop”, “standby”, or “suspend”.
• ZZZ_HIBERNATE_MODE — The selected hibernate mode: “platform”, “reboot”, “shutdown”, or “suspend”.

🌈 EXIT CODES 🌈

• 0 — Clean exit, no error has encountered. Slay. ✅
• 1 — General error. Oop. 😭
• 10 — Invalid usage. Bestie, the syntax said no. 💀
• 11 — The requested sleep state or hibernation mode is not supported or you don’t have insufficient privileges.
• 12 — Unable to obtain lock; another instance of zzz is running. One at a time, main character. 🔒
• 20 — Failed to put system to sleep. The nap did not happen. 😔
• 21 — Some hook script exited with a non-zero code. Note that zzz does not stop when a hook script fails. It keeps going, fr fr. 🚶‍♀️

📝 LOGGING 📝

Information and debug messages are printed to STDOUT, error messages are printed to STDERR. All messages are also logged to syslog with ident string zzz and facility code 1 (user). Receipts everywhere. 🧾

Debug messages are not printed and logged unless -v is specified. So if you want the deep lore, say -v. 👀

🕰️ HISTORY 🕰️

This program is inspired from zzz(8) script in Void Linux written by Leah Neukirchen. Respect the ancestors. 🫶

👑 AUTHORS 👑

Jakub Jirutka. Icon. ✨

🐛 REPORTING BUGS 🐛

Report bugs to the project’s issue tracker at https://github.com/jirutka/zzz/issues. Tell them everything, bestie. 🫡

---

🎀 That’s the whole manual, bestie. Page date: 2024-08-15; manual: ZZZ(8). Go suspend something iconic. 💅✨