port support for xdg basedir and some makefile fixes from i3

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 18cfb196bb84a69c41ae18a16562d8a3cf1b88ce..0fff8e628eec497fd47cd5f303c4eb1478d0d8bc 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"
 }
 
@@ -160,7 +165,7 @@ connected.
 
 *Example order*: +wireless wlan0+
 
-*Example format*: +W: (%quality at %essid) %ip+
+*Example format*: +W: (%quality at %essid, %bitrate) %ip+
 
 === Ethernet
 
@@ -220,6 +225,25 @@ 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: