Added new feature - consumption - to documentation

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 4896a739a7fd1ee39390b5dd854edf1263745cc0..45524afdf6d50ddcc0133431c84ee98d4a0008ec 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
 
@@ -34,10 +34,6 @@ commands would.
 
 == CONFIGURATION
 
-Since version 2, the configuration file for i3status will be parsed using
-libconfuse. This makes configuration easier in the programmer’s point of
-view and more flexible for the user at the same time.
-
 The basic idea of i3status is that you can specify which "modules" should
 be used (the order directive). You can then configure each module with its
 own section. For every module, you can specify the output format. See below
@@ -76,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 {
@@ -129,6 +126,12 @@ sleep before printing the next status line.
 Using +output_format+ you can chose which format strings i3status should
 use in its output. Currently available are:
 
+i3bar::
+i3bar comes with i3 and provides a workspace bar which does the right thing in
+multi-monitor situations. It also comes with tray support and can display the
+i3status output. This output type uses JSON to pass as much meta-information to
+i3bar as possible (like colors, which blocks can be shortened in which way,
+etc.).
 dzen2::
 Dzen is a general purpose messaging, notification and menuing program for X11.
 It was designed to be scriptable in any language and integrate well with window
@@ -189,8 +192,8 @@ 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
+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
@@ -201,9 +204,15 @@ 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
 
@@ -215,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+
 
@@ -252,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+
 
@@ -313,14 +326,16 @@ governor ("ondemand") changes the CPU frequency far more often than i3status
 could display it. The display number is therefore often incorrect and doesn’t
 tell you anything useful either.
 
-In general, i3status wants to display things which you would often look at
-anyways, like the current date/time, whether you are connected to a WiFi
-network or not, and if you have enough disk space to fit that 4.3 GiB download.
+In general, i3status wants to display things which you would look at
+occasionally anyways, like the current date/time, whether you are connected to
+a WiFi network or not, and if you have enough disk space to fit that 4.3 GiB
+download.
 
 However, if you need to look at some kind of information more than once in a
 while (like checking repeatedly how full your RAM is), you are probably better
-of with a script doing that, which pops up an alert when your RAM usage reaches
-a certain threshold.
+off with a script doing that, which pops up an alert when your RAM usage reaches
+a certain threshold. After all, the point of computers is not to burden you
+with additional boring tasks like repeatedly checking a number.
 
 == External scripts/programs with i3status