BATSIGNAL(1)

💖 NAME 💖

Okay bestie, this is the BATSIGNAL(1) page from the General Commands Manual, and it’s all about batsignal — a lightweight battery daemon written in C that notifies the user about battery states. It’s intended for minimal window managers, but no cap it can be used in any environment that supports desktop notifications via libnotify. ✨

🦋 SYNOPSIS 🦋

batsignal [OPTIONS]

🌸 DESCRIPTION 🌸

batsignal is giving lightweight battery daemon realness, written in C, and its whole job is notifying the user about battery states. It’s intended for minimal window managers, but bestie it can absolutely be used in any environment that supports desktop notifications via libnotify. 💅

---

✨ OPTIONS ✨

• -h — display help.
• -v — display version information.
• -b — run batsignal as background daemon.
• -o — check battery once and exit.
• -i — ignore missing battery errors.
• -e — cause notifications to expire.
• -N — disable desktop notifications.
• -w LEVEL — battery warning LEVEL (default 15). 0 disables this level.
• -c LEVEL — critical battery LEVEL (default 5). 0 disables this level.
• -d LEVEL — battery danger LEVEL (default 2). 0 disables this level.
• -f LEVEL — battery full LEVEL (default 0). 0 disables this level.
• -p — show a message when the battery begins charging or discharging.
• -W MESSAGE — show MESSAGE when battery is at warning level.
• -C MESSAGE — show MESSAGE when battery is at critical level.
• -D COMMAND — run COMMAND when battery is at danger level.
• -F MESSAGE — show MESSAGE when battery is at full level.
• -P MESSAGE — show MESSAGE when battery is charging, if -p option is set.
• -U MESSAGE — show MESSAGE when battery is discharging, if -p option is set.
• -M COMMAND — send each message using COMMAND.
• -n NAME — battery device NAME — multiple batteries may be separated by commas (default BAT0).
• -m SECONDS — minimum number of SECONDS (default 60) to wait between battery checks. Setting SECONDS to 0 disables polling and waits for the USR1 signal before checking battery level. Prefixing SECONDS with a + (ex: -m +10) will force a check at SECONDS intervals, regardless of battery level.
• -a APP_NAME — app name used in notifications (default: batsignal).
• -I ICON — display specified ICON in notifications.

---

🎀 CONFIGURATION 🎀

Options can be passed to batsignal as command arguments or placed in a configuration file. Options from the configuration file will be applied first and then may be overridden by command line as arguments. 💖

The configuration file should include option arguments as documented above, one argument per line. Lines beginning with # and empty lines are ignored. For example, to specify a warning level of 30 and run as a background daemon, the following configuration file could be used:

# Run in background
-b
# Use warning level of 30
-w
30

The following paths are checked in sequence for a configuration file:

• BATSIGNAL_CONFIG environment variable (if present)
• $HOME/.config/batsignal (or the config base specificed in XDG_CONFIG_HOME)
• $HOME/.batsignal
• /usr/local/etc/batsignal
• /etc/batsignal

🌈 ENVIRONMENT 🌈

• BATSIGNAL_CONFIG — sets the option configuration file path.
• XDG_CONFIG_HOME — the base path for the XDG config directory. Used in the option file search.

🦋 SIGNALS 🦋

batsignal responds to the following signals:

• SIGUSR1 — sending the process SIGUSR1 will cause an immediate battery check to be performed.

💅 NOTES 💅

In most cases, batsignal will perform fewer battery state checks while the battery is discharging and the level of charge is not near a warning level. This frequency is affected by the multiplier (-m) option and is never less than <multiplier> seconds. If the "full" level (-f) is set or charge/discharge messages are enabled (-p), batsignal will instead check the battery state every <multiplier> seconds regardless of level of charge. 😭

If the "full" level (-f) is set, the battery full notification will be triggered at the given level of charge or when the battery status changes to full, whichever occurs first. ⭐

The message COMMAND passed with -M is a C printf-style format string. It can use two string placeholders (%s) that will be replaced by the message text and the current battery level. Be sure to test the command — invalid format strings may cause batsignal to crash.

⚠️ Bestie, seriously test that command. Invalid format strings may cause batsignal to crash. 💀

Ex:

-M "wall 'Battery warning: %s - Level is %s'"

---

👑 COPYRIGHT 👑

• Copyright 2018-2024 Corey Hinshaw
• Copyright 2016-2017 Aaron Marcher
• License: ISC License

💖 Cute sign-off: this page is batsignal-1.8.0, BATSIGNAL(1), and the footer doesn’t show a date — so no invented date, bestie. Bye! 💅