manpage: fix example for xmobar/dzen2

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index b7f362e950b7ff809848c73016ff884b53224dba..a8f461f44050eb9fce278d6849ec45910ad60d96 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael+i3@stapelberg.de>
-v2.1, April 2010
+v2.2, September 2010
 
 == NAME
 
@@ -9,13 +9,18 @@ i3status - Generates a status line for dzen2 or xmobar
 
 == SYNOPSIS
 
-i3status [-c configfile]
+i3status [-c configfile] [-h] [-v]
 
 == OPTIONS
 
 -c::
-Specifies an alternate configuration file path (default is /etc/i3status.conf
-or ~/.i3status.conf).
+Specifies an alternate configuration file path. By default, i3status looks for
+configuration files in the following order:
+
+1. ~/.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)
+2. /etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)
+3. ~/.i3status.conf
+4. /etc/i3status.conf (or SYSCONFDIR/i3status.conf if set at compile-time)
 
 == DESCRIPTION
 
@@ -57,7 +62,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 +102,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:
@@ -125,11 +143,11 @@ best available public IPv6 address on your computer).
 
 === 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
 
@@ -147,7 +165,7 @@ connected.
 
 *Example order*: +wireless wlan0+
 
-*Example format*: +W: (%quality at %essid) %ip+
+*Example format*: +W: (%quality at %essid, %bitrate) %ip+
 
 === Ethernet
 
@@ -207,9 +225,29 @@ details on the format string.
 
 *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:
+After installing dzen2, you can directly use it with i3status. Just ensure that
++output_format+ is set to +dzen2+.
 
 *Example for usage of i3status with dzen2*:
 --------------------------------------------------------------
@@ -220,11 +258,12 @@ i3status | dzen2 -fg white -ta r -w 1280 \
 == Using i3status with xmobar
 
 To get xmobar to start, you might need to copy the default configuration
-file to +~/.xmobarrc+.
+file to +~/.xmobarrc+. Also, ensure that the +output_format+ option for i3status
+is set to +xmobar+.
 
 *Example for usage of i3status with xmobar*:
 ---------------------------------------------------------------------
-i3status-xmobar | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
+i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
 ---------------------------------------------------------------------
 
 == SEE ALSO