Bump version in manpage

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 74493b949093bf18c1b63582cc664b5d5b7b63ed..afe4fda9ff2776154f9fed1ee613263f6df3b095 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael+i3@stapelberg.de>
-v2, October 2009
+v2.2, September 2010
 
 == NAME
 
@@ -21,7 +21,7 @@ or ~/.i3status.conf).
 
 i3status is a small program (less than 1000 SLOC) for generating a status bar
 for dzen2, xmobar or similar programs. It is designed to be very efficient by
-issuing a very small number of systemcalls, as one generally wants to update
+issuing a very small number of system calls, as one generally wants to update
 such a status line every second. This ensures that even under high load, your
 status bar is updated correctly. Also, it saves a bit of energy by not hogging
 your CPU as much as spawning the corresponding amount of shell commands would.
@@ -57,7 +57,7 @@ order += "load"
 order += "time"
 
 wireless wlan0 {
-        format_up = "W: (%quality at %essid) %ip"
+        format_up = "W: (%quality at %essid, %bitrate) %ip"
         format_down = "W: down"
 }
 
@@ -97,9 +97,22 @@ disk "/" {
 
 === General
 
-The colors directive will disable all colors if you set it to +false+.
-+interval+ is the time in seconds which i3status will sleep until printing
-the next status line.
+The +colors+ directive will disable all colors if you set it to +false+. You can
+also specify the colors that will be used to display "good", "degraded" or "bad"
+values using the +color_good+, +color_degraded+ or +color_bad+ directives,
+respectively. Those directives are only used if color support is not disabled by
+the +colors+ directive. The input format for color values is the canonical RGB
+hexadecimal triplet (with no separators between the colors), prefixed by a hash
+character ("#").
+
+*Example color_good*: +#00FF00+
+
+Likewise, you can use the +color_separator+ directive to specify the color that
+will be used to paint the separator bar. The separator is always output in
+color, even when colors are disabled by the +colors+ directive.
+
+The +interval+ directive specifies the time in seconds for which i3status will
+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:
@@ -119,15 +132,17 @@ Does not use any color codes. Separates values by the pipe symbol.
 This module gets the IPv6 address used for outgoing connections (that is, the
 best available public IPv6 address on your computer).
 
-*Example format*: +%ip+
+*Example format_up*: +%ip+
+
+*Example format_down* +no IPv6+
 
 === Disk
 
-Gets used, free and total amount of bytes on the given mounted filesystem.
+Gets used, free, available and total amount of bytes on the given mounted filesystem.
 
 *Example order*: +disk /mnt/usbstick+
 
-*Example format*: +%free / %total+
+*Example format*: +%free (%avail)/ %total+
 
 === Run-watch
 
@@ -145,7 +160,7 @@ connected.
 
 *Example order*: +wireless wlan0+
 
-*Example format*: +W: (%quality at %essid) %ip+
+*Example format*: +W: (%quality at %essid, %bitrate) %ip+
 
 === Ethernet
 
@@ -195,6 +210,35 @@ Formats the current system time. See +strftime(3)+ for the format.
 
 *Example format*: +%Y-%m-%d %H:%M:%S+
 
+=== DDate
+
+Outputs the current discordian date in user-specified format. See +ddate(1)+ for
+details on the format string.
+*Note*: Neither *%.* nor *%X* are implemented yet.
+
+*Example order*: +ddate+
+
+*Example format*: +%{%a, %b %d%}, %Y%N - %H+
+
+=== Volume
+
+Outputs the volume of the specified mixer on the specified device. Works only
+on Linux because it uses ALSA.
+
+*Example order*: +volume master+
+
+*Example format*: +♪: %volume+
+
+*Example configuration*:
+-------------------------------------------------------------
+volume master {
+       format = "♪: %volume"
+       device = "default"
+       mixer = "Master"
+       mixer_idx = 0
+}
+-------------------------------------------------------------
+
 == Using i3status with dzen2
 
 After installing dzen2, you can directly use it with i3status: