Add a "format" example for run_watch

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 0666230a87d145f9338a9d23cba563a5227a6511..f232e2a33407605f2ffebf004c51330d9ecf7beb 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael+i3@stapelberg.de>
-v2.3, July 2011
+v2.4, December 2011
 
 == NAME
 
@@ -75,6 +75,7 @@ ethernet eth0 {
 
 battery 0 {
         format = "%status %percentage %remaining"
+        path = "/sys/class/power_supply/BAT%d/uevent"
 }
 
 run_watch DHCP {
@@ -164,6 +165,8 @@ a specific application, such as a VPN client or your DHCP client is running.
 
 *Example order*: +run_watch DHCP+
 
+*Example format*: +%title %status+
+
 === Wireless
 
 Gets the link quality and ESSID of the given wireless network interface. You
@@ -193,6 +196,10 @@ 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.
+
 *Example order*: +battery 0+
 
 *Example format*: +%status %remaining+