Fix the build on NetBSD

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 00fdcbc45d892e135724b157e845a9a46bb5dec2..eb23bd1a164119897cadfe7926b420707b7f52b1 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,11 +1,11 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael@i3wm.org>
-v2.6, October 2012
+v2.7, March 2013
 
 == NAME
 
-i3status - Generates a status line for dzen2 or xmobar
+i3status - Generates a status line for i3bar, dzen2 or xmobar
 
 == SYNOPSIS
 
@@ -72,6 +72,7 @@ ethernet eth0 {
 
 battery 0 {
         format = "%status %percentage %remaining %emptytime"
+        format_down = "No battery"
         path = "/sys/class/power_supply/BAT%d/uevent"
         low_threshold = 10
 }
@@ -145,6 +146,12 @@ managers like dwm, wmii and xmonad though it will work with any windowmanger
 xmobar::
 xmobar is a minimalistic, text based, status bar. It was designed to work
 with the xmonad Window Manager.
+term::
+Use ANSI Escape sequences to produce a terminal-output as close as possible to
+the graphical outputs. This makes debugging your config file a little bit
+easier because the terminal-output of i3status becomes much more readable, but
+should only used for such quick glances, because it will only support very
+basic output-features (for example you only get 3 bits of color depth).
 none::
 Does not use any color codes. Separates values by the pipe symbol. This should
 be used with i3bar and can be used for custom scripts.
@@ -220,8 +227,9 @@ If you want the battery percentage to be shown without decimals, add
 +integer_battery_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.
+modify the "path" property accordingly, i.e. pointing to the uevent file on
+your system. The first occurence of %d gets replaced with the battery number,
+but you can just hard-code a path as well.
 
 It is possible to define a low_threshold that causes the battery text to be
 colored red. The low_threshold type can be of threshold_type "time" or
@@ -236,6 +244,8 @@ colored red. The low_threshold type can be of threshold_type "time" or
 
 *Example threshold_type*: +time+
 
+*Example path*: +/sys/class/power_supply/CMB1/uevent+
+
 === CPU-Temperature
 
 Gets the temperature of the given thermal zone. It is possible to
@@ -248,6 +258,8 @@ specified thermal zone is getting too hot. Defaults to 75 degrees C.
 
 *Example max_threshold*: +42+
 
+*Example path*: +/sys/devices/platform/coretemp.0/temp1_input+
+
 === CPU Usage
 
 Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+ (FreeBSD/OpenBSD).
@@ -267,7 +279,7 @@ getting higher than the configured threshold. Defaults to 5.
 
 *Example format*: +%1min %5min %15min+
 
-*Example max_threshold*: 5
+*Example max_threshold*: +"0,1"+
 
 === Time
 
@@ -311,9 +323,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
+the lack of ALSA,  the +device+ and +mixer+ options can be
 ignored on these systems. On these systems the OSS API is used instead to
-query +/dev/mixer+ directly.
+query +/dev/mixer+ directly if +mixer_dix+ is -1, otherwise
++/dev/mixer++mixer_idx+.
 
 *Example order*: +volume master+