disk: Colorize output when below given threshold

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 656a8bfdf73a1229fbad06a2f9e1e3e5d0716c16..1182e5407b5531c7425caa07d17831c91d395275 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -223,6 +223,16 @@ SI prefixes (k, M, G, T) represent multiples of powers of 1000.
 custom::
 The custom prefixes (K, M, G, T) represent multiples of powers of 1024.
 
+It is possible to define a low_threshold that causes the disk text to be
+displayed using color_bad. The low_threshold type can be of threshold_type
+"bytes_free", "bytes_avail", "percentage_free", or "percentage_avail", where
+the former two can be prepended by a generic prefix (k, m, g, t) having
+prefix_type. So, if you configure low_threshold to 2, threshold_type to
+"gbytes_avail", and prefix_type to "binary", and the remaining available disk
+space is below 2 GiB, it will be colored bad. If not specified, threshold_type
+is assumed to be "percentage_avail" and low_threshold to be set to 0, which
+implies no coloring at all.
+
 *Example order*: +disk /mnt/usbstick+
 
 *Example format*: +%free (%avail)/ %total+
@@ -231,6 +241,10 @@ The custom prefixes (K, M, G, T) represent multiples of powers of 1024.
 
 *Example prefix_type*: +custom+
 
+*Example low_threshold*: +5+
+
+*Example threshold_type*: +percentage_free+
+
 === Run-watch
 
 Expands the given path to a pidfile and checks if the process ID found inside