clarify the unit of the power consumption and reformat that paragraph

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 8cac1bb7c9196eb83e694e783c8d098207c1a21d..9ec6acb616ae64735bbe5bf5875b81efcd126547 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael+i3@stapelberg.de>
-v2.4, December 2011
+v2.5, May 2012
 
 == NAME
 
@@ -72,6 +72,7 @@ ethernet eth0 {
 battery 0 {
         format = "%status %percentage %remaining %emptytime"
         path = "/sys/class/power_supply/BAT%d/uevent"
+        low_threshold = 10
 }
 
 run_watch DHCP {
@@ -191,21 +192,27 @@ it using +setcap cap_net_admin=ep $(which i3status)+.
 
 === Battery
 
-Gets the status (charging, discharging, running), percentage and remaining
-time of the given battery and when it's estimated to be empty. If you want
-to use the last full capacity instead of the design capacity (when using
-the design capacity, it may happen that your battery is at 23% when fully
-charged because it’s old. In general, I want to see it this way, because
-it tells me how worn off my battery is.), just specify
+Gets the status (charging, discharging, running), percentage, remaining
+time and power consumption (in Watts) of the given battery and when it's
+estimated to be empty. If you want to use the last full capacity instead of the
+design capacity (when using the design capacity, it may happen that your
+battery is at 23% when fully charged because it’s old. In general, I want to
+see it this way, because it tells me how worn off my battery is.), just specify
 +last_full_capacity = true+.
 
 If your battery is represented in a non-standard path in /sys, be sure to
 modify the "path" property accordingly. The first occurence of %d gets replaced
 with the battery number, but you can just hard-code a path as well.
 
+If the remaining time sinks below low_threshold minutes, the battery text will
+be colored red. So, if you configure low_threshold to 10, and your battery
+lasts another 9 minutes, it will be colored red.
+
 *Example order*: +battery 0+
 
-*Example format*: +%status %remaining (%emptytime)+
+*Example format*: +%status %remaining (%emptytime %consumption)+
+
+*Example low_threshold*: +low_threshold 10+
 
 === CPU-Temperature
 
@@ -217,7 +224,7 @@ Gets the temperature of the given thermal zone.
 
 === CPU Usage
 
-Gets the percentual CPU usage from +/proc/stat+.
+Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+ (FreeBSD/OpenBSD).
 
 *Example order*: +cpu_usage+
 
@@ -254,6 +261,10 @@ details on the format string.
 
 Outputs the volume of the specified mixer on the specified device. Works only
 on Linux because it uses ALSA.
+A simplified configuration can be used on FreeBSD and OpenBSD due to
+the lack of ALSA,  the +device+, +mixer+ and +mixder_idx+ options can be
+ignored on these systems. On these systems the OSS API is used instead to
+query +/dev/mixer+ directly.
 
 *Example order*: +volume master+