update changelog and manpage for 2.6

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 45524afdf6d50ddcc0133431c84ee98d4a0008ec..9a19ec9f5d7946ef0e515c48df440f330cd12fc0 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
-Michael Stapelberg <michael+i3@stapelberg.de>
-v2.5, May 2012
+Michael Stapelberg <michael@i3wm.org>
+v2.6, October 2012
 
 == NAME
 
@@ -156,10 +156,15 @@ best available public IPv6 address on your computer).
 
 Gets used, free, available and total amount of bytes on the given mounted filesystem.
 
+These values can also be expressed in percentages with the percentage_used,
+percentage_free, percentage_avail and percentage_used_of_avail formats.
+
 *Example order*: +disk /mnt/usbstick+
 
 *Example format*: +%free (%avail)/ %total+
 
+*Example format*: +%percentage_used used, %percentage_free free, %percentage_avail avail+
+
 === Run-watch
 
 Expands the given path to a pidfile and checks if the process ID found inside
@@ -193,26 +198,29 @@ it using +setcap cap_net_admin=ep $(which i3status)+.
 === Battery
 
 Gets the status (charging, discharging, running), percentage, remaining
-time and consumption 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
+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.
+It is possible to define a low_threshold that causes the battery text to be
+colored red. The low_threshold type can be of threshold_type "time" or
+"percentage". So, if you configure low_threshold to 10 and threshold_type to
+"time", and your battery lasts another 9 minutes, it will be colored red.
 
 *Example order*: +battery 0+
 
 *Example format*: +%status %remaining (%emptytime %consumption)+
 
-*Example low_threshold*: +low_threshold 10+
+*Example low_threshold*: +30+
+
+*Example threshold_type*: +time+
 
 === CPU-Temperature
 
@@ -357,6 +365,10 @@ done
 
 Put that in some script, say +.bin/my_i3status.sh+ and execute that instead of i3status.
 
+Note that if you want to use the JSON output format (with colors in i3bar), you
+need to use a slightly more complex wrapper script. There are examples in the
+contrib/ folder, see http://code.i3wm.org/i3status/tree/contrib
+
 == SEE ALSO
 
 +strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+