i3status(1)
===========
Michael Stapelberg <michael+i3@stapelberg.de>
-v2, October 2009
+v2.3, July 2011
== NAME
== 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. ~/.i3status.conf
+2. ~/.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)
+3. /etc/i3status.conf
+4. /etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)
== DESCRIPTION
-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
-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.
+i3status is a small program (about 1500 SLOC) for generating a status bar for
+i3bar, dzen2, xmobar or similar programs. It is designed to be very
+efficient by 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.
== CONFIGURATION
.Sample configuration
-------------------------------------------------------------
general {
+ output_format = "dzen2"
colors = true
- interval = 5
+ interval = 5
}
order = "ipv6"
order += "time"
wireless wlan0 {
- format_up = "W: (%quality at %essid) %ip"
+ format_up = "W: (%quality at %essid, %bitrate) %ip"
format_down = "W: down"
}
ethernet eth0 {
- # if you use %speed, i3status requires root privileges
- format = "E: %ip (%speed)"
+ # if you use %speed, i3status requires the cap_net_admin capability
+ format_up = "E: %ip (%speed)"
+ format_down = "E: down"
}
battery 0 {
cpu_temperature 0 {
format = "T: %degrees °C"
+ path = "/sys/devices/platform/coretemp.0/temp1_input"
}
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 configuration*:
+-------------------------------------------------------------
+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:
+
+dzen2::
+Dzen is a general purpose messaging, notification and menuing program for X11.
+It was designed to be scriptable in any language and integrate well with window
+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.
+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.
=== IPv6
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
*Example order*: +wireless wlan0+
-*Example format*: +W: (%quality at %essid) %ip+
+*Example format*: +W: (%quality at %essid, %bitrate) %ip+
=== Ethernet
Gets the IP address and (if possible) the link speed of the given ethernet
-interface. Getting the link speed requires root privileges.
+interface. Getting the link speed requires the cap_net_admin capability. Set
+it using +setcap cap_net_admin=ep $(which i3status)+.
*Example order*: +ethernet eth0+
*Example format*: +T: %degrees °C+
+=== CPU Usage
+
+Gets the percentual CPU usage from +/proc/stat+.
+
+*Example order*: +cpu_usage+
+
+*Example format*: +%usage+
+
=== Load
Gets the system load (number of processes waiting for CPU time in the last
*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:
+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*:
--------------------------------------------------------------
== 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]"
---------------------------------------------------------------------
+== External scripts/programs with i3status
+
+In i3status, we don’t want to implement process management again. Therefore,
+there is no module to run arbitrary scripts or commands. Instead, you should
+use your shell, for example like this:
+
+*Example for prepending the i3status output*:
+--------------------------------------------------------------
+i3status | while :
+do
+ read line
+ echo "mystuff | $line"
+done | i3bar -d
+--------------------------------------------------------------
+
== SEE ALSO
+strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
Thorsten Toepper
Baptiste Daroussin
+
+Axel Wagner
+
+Fernando Tarlá Cardoso Lemos
projects / i3 / i3status / blobdiff