WMACPI(1)

🌸 WMACPI — battery vibes, but make it ACPI 💅

okay bestie, sit down, we're reading a General Commands Manual page together and honestly? it's iconic. two whole programs live here: wmacpi and wmacpi-cli. yes they're cousins. no we're not picking favorites. 🫶

---

✨ NAME ✨

• wmacpi — battery status monitor for systems supporting ACPI 🦋
• wmacpi-cli — query battery status for systems supporting ACPI 🔥

---

✨ SYNOPSIS ✨

like literally just the shapes of the commands, no cap:

wmacpi [ -c value ] [ -d display ] [ -m battery no ] [ -s sample rate ]
[ -f ] [ -v ] [ -n ] [ -x ] [ -a samples ] [ -v ] [ -h ]

wmacpi-cli [ -a samples ] [ -V ] [ -v ] ] -b ] [ -r ] [ -h ]

(yes that second line has a stray ] in it. we do not speak of it. it's canon. 💀)

---

✨ DESCRIPTION ✨

This manual page documents briefly the wmacpi command. brief queen behavior only. 💅

wmacpi is a program that displays the current battery status in a WindowMaker dock app, on systems that support Intel's Advanced Configuration and Power Interface specification (ACPI). it's giving tiny window, big feelings. 🌸

The program monitors a battery, displaying its current percentage charge via a bar and a numeric value. It also displays the current power status for the system, the time remaining (calculated based on the remaining battery capacity and the current rate of power usage), and a scrolling message with some hopefully useful information. honestly the scrolling message is the main character. 👑

Clicking on the window cycles through the batteries that the ACPI system knows about. click it. click it again. collect them all. 🎀

wmacpi-cli queries the battery status from the command line. It prints the power status, the percentage remaining for each battery found, and the time remaining if the system is on battery, or the time remaining for each battery to reach full charge if the batteries are charging. terminal girlies, this one's for you. ✨

---

✨ OPTIONS ✨

🦋 wmacpi

• -c, --critical=percentage — set critical low alarm at <percentage>% (default: 10%). lowkey the "bestie plug me in" threshold. 🔌
• -d, --display=display — set the X display to open the window on.
• -m, --battery=battery number — set the battery to monitor initially. pick your fave. 💖
• -s, --sample-rate=sample rate — set the rate at which to sample the ACPI data, in number of times per minute. Minimum is 1, ie once a minute, default is 20, maximum is 600. it's giving data girlie with a schedule. ⏰
• -n, --no-blink — disable blinking power glyph when charging. Note that it still blinks when the battery reports its capacity state as critical. so basically it never fully shuts up when things get real. 😭
• -f, --force-capacity-mode — force the use of capacity mode for calculating time remaining. By default wmacpi will use the reported values of remaining capacity and present rate to calculate the time remaining on battery. This flag will force the use of the remaining capacity and time samples to calculate the present rate of drain, and from there the time remaining. Note that this mode of calculation generally underreports the time remaining. This mode works around certain buggy ACPI BIOSes that fail to report the current rate. dramatic? yes. necessary? also yes. 💅
• -x, --cmdline — run wmacpi in command line mode - this operates identically to wmacpi-cli.
• -a, --samples=samples — average the time remaining over num samples. This greatly improves the accuracy of the reported time remaining. glow up for your numbers. ✨
• -V, --verbosity=num — increase the verbosity of the program. Setting this to 1 will print extra error information; 2 will produce informational output; 3 will produce copious debugging output. three is unhinged and we support it. 🗣️
• -v, --version — print the version information.
• -r, --no-scroll — disable scrolling message.
• -h, --help — display help. we love a helpful icon. 🫶

🌈 wmacpi-cli

• -a num — average the time remaining over num samples. This greatly improves the accuracy of the reported time remaining.
• -V — increase the verbosity of the program. If repeated, the result is the same as setting --verbosity for wmacpi to the number of repetitions. spam it, go off. 🔥
• -v — print the version information.
• -h — display help.

⚠️ heads up bestie: the synopsis up top mentions -b and -r for wmacpi-cli too, but the options list down here only spells out -a, -V, -v and -h. we report, we don't invent. 🧚

---

✨ AUTHOR ✨

wmacpi was originally written by Tim Copperfield <timecop@japan.co.jp>, then completely rewritten after 1.34 by Simon Fowler <simon@himi.org>. a full glow-up era, honestly. 💖

This manual page was originally written by Simon Richter <sjr@debian.org> for the Debian GNU/Linux system, and then updated by Simon Fowler. Last modification by Simon Fowler <simon@himi.org>, 2007-07-13.

---

okay that's the whole page, no skips, no crumbs. 🎀 this one's from the General Commands Manual, dated July 13 2007, and it goes by WMACPI(1) — vintage, iconic, still slaying. periodt. 💜