diff options
Diffstat (limited to 'lowbat.1')
| -rw-r--r-- | lowbat.1 | 32 |
1 files changed, 25 insertions, 7 deletions
@@ -1,17 +1,35 @@ -.TH LOWBAT 1 lowbat\-1.0 +.TH LOWBAT 1 lowbat\-1.2 .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. +seconds. It is able to detect each of the system's batteries, and calculate the +remaining sum capacity of all installed batteries. Additional batteries +installed during runtime will also be detected and summed. .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 +The daemon will send a warning notification the user when the sum battery level +drops below 20% while any battery is discharging, and another critical warning at 5%. +.SH BATTERY STATUS LOG +The current charging status and sum capacity will be logged in stdout whenever +a change is detected. .P -The current battery level and charging state will also be displayed in stdout. +Each possible battery status value is assigned a single character symbol which +will prefix the current battery level. E.g. `-50%` if any attached battery is +currently discharging and the current sum capacity equals 50%. The symbols are +defined as follows in order of highest to lowest priority: +.TP +.B - +Discharging +.TP +.B + +Charging +.TP +.B = +Full / Not charging +.TP +.B ? +Unknown .SH USAGE Call the lowbat executable in your .B |