aboutsummaryrefslogtreecommitdiff
path: root/lowbat.1
diff options
context:
space:
mode:
Diffstat (limited to 'lowbat.1')
-rw-r--r--lowbat.128
1 files changed, 28 insertions, 0 deletions
diff --git a/lowbat.1 b/lowbat.1
new file mode 100644
index 0000000..1d0d66f
--- /dev/null
+++ b/lowbat.1
@@ -0,0 +1,28 @@
+.TH LOWBAT 1 lowbat\-1.0
+.SH NAME
+lowbat - A minimal battery level monitor daemon, written in C
+.SH DESCRIPTION
+lowbat is configured by default to check the system battery level every 3
+seconds. It is able to detect each battery installed and the system, and
+calculate the remaining capacity of all batteries combined. Batteries added to
+the system during runtime will also be detected.
+.P
+The daemon will send a warning notification the user when their battery level
+drops below 20% while the batteries are discharging, and another critical
+warning at 5%.
+.P
+The current battery level will also be displayed in stdout.
+.SH USAGE
+Call the lowbat executable in your xinitrc or xprofile.
+.SH CUSTOMIZATION
+There are no runtime flags or configuration files. Simply modify the source
+code to suit your needs.
+.SH COPYRIGHT
+Copyright 2024 Tim Keller.
+MIT License.
+.P
+.BR <https://TJKeller.xyz>
+.SH SEE ALSO
+.BR notify-send(1)
+.P
+.BR <https://www.kernel.org/doc/Documentation/ABI/testing/sysfs-class-power>