Documentation for format-time

gdamjan · Sep 6, 2019 · dc93fa8 · dc93fa8
1 parent a63bc84
commit dc93fa8
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/man/waybar-battery.5.scd b/man/waybar-battery.5.scd
@@ -32,6 +32,11 @@ The *battery* module displays the current capacity and state (eg. charging) of y
 	default: {capacity}% ++
 	The format, how the time should be displayed.
 
+*format-time* ++
+	typeof: string ++
+	default: {H} h {M} min ++
+	The format, how the time should be displayed.
+
 *format-icons*
 	typeof: array/object
 	Based on the current capacity, the corresponding icon gets selected. ++
@@ -78,6 +83,14 @@ The *battery* module displays the current capacity and state (eg. charging) of y
 
 *{time}*: Estimate of time until full or empty. Note that this is based on the power draw at the last refresh time, not an average.
 
+# TIME FORMAT
+
+The *battery* module allows you to define how time should be formatted via *format-time*.
+
+The two arguments are:
+*{H}*: Hours
+*{M}*: Minutes
+
 # CUSTOM FORMATS
 
 The *battery* module allows to define custom formats based on up to two factors. The best fitting format will be selected.