i3status(1)
===========
Michael Stapelberg <michael@i3wm.org>
-v2.7, March 2013
+v2.8, January 2014
== NAME
order += "ipv6"
order += "disk /"
order += "run_watch DHCP"
-order += "run_watch VPN"
+order += "run_watch VPNC"
+order += "path_exists VPN"
order += "wireless wlan0"
order += "ethernet eth0"
order += "battery 0"
pidfile = "/var/run/dhclient*.pid"
}
-run_watch VPN {
+run_watch VPNC {
+ # file containing the PID of a vpnc process
pidfile = "/var/run/vpnc/pid"
}
+path_exists VPN {
+ # path exists when a VPN tunnel launched by nmcli/nm-applet is active
+ path = "/proc/sys/net/ipv4/conf/tun0"
+}
+
tztime local {
format = "%Y-%m-%d %H:%M:%S"
}
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.
*Example format_up*: +%ip+
-*Example format_down* +no IPv6+
+*Example format_down*: +no IPv6+
=== Disk
These values can also be expressed in percentages with the percentage_used,
percentage_free, percentage_avail and percentage_used_of_avail formats.
+Byte sizes are presented in a human readable format using a set of prefixes
+whose type can be specified via the "prefix_type" option. Three sets of
+prefixes are available:
+
+binary::
+IEC prefixes (Ki, Mi, Gi, Ti) represent multiples of powers of 1024.
+This is the default.
+decimal::
+SI prefixes (k, M, G, T) represent multiples of powers of 1000.
+custom::
+The custom prefixes (K, M, G, T) represent multiples of powers of 1024.
+
*Example order*: +disk /mnt/usbstick+
*Example format*: +%free (%avail)/ %total+
*Example format*: +%percentage_used used, %percentage_free free, %percentage_avail avail+
+*Example prefix_type*: +custom+
+
=== Run-watch
Expands the given path to a pidfile and checks if the process ID found inside
*Example format*: +%title: %status+
+=== Path-exists
+
+Checks if the given path exists in the filesystem. You can use this to check if
+something is active, like for example a VPN tunnel managed by NetworkManager.
+
+*Example order*: +path_exists VPN+
+
+*Example format*: +%title: %status+
+
=== Wireless
Gets the link quality and ESSID of the given wireless network interface. You
*Example format*: +%status %remaining (%emptytime %consumption)+
+*Example format_down*: +No battery+
+
*Example low_threshold*: +30+
*Example threshold_type*: +time+
*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).
*Example format*: +%1min %5min %15min+
-*Example max_threshold*: 5
+*Example max_threshold*: +"0,1"+
=== Time
*Example order*: +volume master+
*Example format*: +♪: %volume+
+*Example format_muted*: +♪: 0%%+
*Example configuration*:
-------------------------------------------------------------
volume master {
format = "♪: %volume"
+ format_muted = "♪: muted (%volume)"
device = "default"
mixer = "Master"
mixer_idx = 0