i3status(1)
===========
Michael Stapelberg <michael@i3wm.org>
-v2.9, March 2015
+v2.10, January 2016
== NAME
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)
+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
== DESCRIPTION
battery 0 {
format = "%status %percentage %remaining %emptytime"
format_down = "No battery"
- status_chr = "⚇ CHR"
- status_bat = "⚡ BAT"
+ status_chr = "⚡ CHR"
+ status_bat = "🔋 BAT"
+ status_unk = "? UNK"
status_full = "☻ FULL"
path = "/sys/class/power_supply/BAT%d/uevent"
low_threshold = 10
output formats, the provided non-empty string will be automatically enclosed
with the necessary coloring bits if color support is enabled.
+i3bar supports Pango markup, allowing your format strings to specify font
+color, size, etc. by setting the +markup+ directive to "pango". Note that the
+ampersand ("&"), less-than ("<"), greater-than (">"), single-quote ("'"), and
+double-quote (""") characters need to be replaced with "`&`", "`<`",
+"`>`", "`'`", and "`"`" respectively. This is done automatically
+for generated content (e.g. wireless ESSID, time).
+
*Example configuration*:
-------------------------------------------------------------
general {
implies no coloring at all.
You can define a different format with the option "format_not_mounted"
-which is used if the path does not exist or is not a mount point. So you can just empty
-the output for the given path with adding +format_not_mounted=""+
-to the config section.
+which is used if the path does not exist or is not a mount point. Defaults to "".
*Example order*: +disk /mnt/usbstick+
=== Battery
-Gets the status (charging, discharging, running), percentage, remaining
+Gets the status (charging, discharging, unknown, full), percentage, remaining
time and power consumption (in Watts) of the given battery and when it's
estimated to be empty. If you want to use the last full capacity instead of the
design capacity (when using the design capacity, it may happen that your
"percentage". So, if you configure low_threshold to 10 and threshold_type to
"time", and your battery lasts another 9 minutes, it will be colored red.
+To show an aggregate of all batteries in the system, use "all" as the number. In
+this case (for Linux), the /sys path must contain the "%d" sequence. Otherwise,
+the number indicates the battery index as reported in /sys.
+
Optionally custom strings including any UTF-8 symbols can be used for different
battery states. This makes it possible to display individual symbols
-for each state (charging, discharging, full)
+for each state (charging, discharging, unknown, full)
Of course it will also work with special iconic fonts, such as FontAwesome.
-If any of this special status strings is omitted, the default (CHR, BAT, FULL)
-is used.
+If any of these special status strings are omitted, the default (CHR, BAT, UNK,
+FULL) is used.
+
+*Example order (for the first battery)*: +battery 0+
-*Example order*: +battery 0+
+*Example order (aggregate of all batteries)*: +battery all+
*Example format*: +%status %remaining (%emptytime %consumption)+
*Example format_down*: +No battery+
-*Example status_chr*: +â\9a\87 CHR+
+*Example status_chr*: +â\9a¡ CHR+
-*Example status_bat*: +⚡ BAT+
+*Example status_bat*: +🔋 BAT+
+
+*Example status_unk*: +? UNK+
*Example status_full*: +☻ FULL+
*Example threshold_type*: +time+
-*Example path*: +/sys/class/power_supply/CMB1/uevent+
+*Example path (%d replaced by title number)*: +/sys/class/power_supply/CMB%d/uevent+
+
+*Example path (ignoring the number)*: +/sys/class/power_supply/CMB1/uevent+
=== CPU-Temperature
=== CPU Usage
-Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+ (FreeBSD/OpenBSD).
+Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+
+(FreeBSD/OpenBSD).
+
+It is possible to define a max_threshold that will color the load
+value red in case the CPU average over the last interval is getting
+higher than the configured threshold. Defaults to 95.
+
+It is possible to define a degraded_threshold that will color the load
+value yellow in case the CPU average over the last interval is getting
+higher than the configured threshold. Defaults to 90.
*Example order*: +cpu_usage+
*Example format*: +%usage+
+*Example max_threshold*: +75+
+
+*Example degraded_threshold*: +25+
+
=== Load
Gets the system load (number of processes waiting for CPU time in the last
Files below that path make for valid timezone strings, e.g. for
+/usr/share/zoneinfo/Europe/Berlin+ you can set timezone to +Europe/Berlin+
in the +tztime+ module.
+To override the locale settings of your environment, set the +locale+ option.
*Example order*: +tztime berlin+
*Example timezone*: +Europe/Berlin+
+*Example locale*: +de_DE.UTF-8+
+
+If you would like to use markup in this section, there is a separate
++format_time+ option that is automatically escaped. Its output then replaces
+%time in the format string.
+
+*Example configuration (markup)*:
+-------------------------------------------------------------
+tztime berlin {
+ format = "<span foreground='#ffffff'>time:</span> %time"
+ format_time = "%H:%M %Z"
+ timezone = "Europe/Berlin"
+}
+-------------------------------------------------------------
+
=== DDate
Outputs the current discordian date in user-specified format. See +ddate(1)+ for
device = "pulse:N"
-where N is the index of the PulseAudio sink. If no sink is specified the
-default is used. If the device string is missing or is set to "default",
-PulseAudio will be tried if detected and will fallback to ALSA (Linux)
-or OSS (FreeBSD/OpenBSD).
+where N is the index or name of the PulseAudio sink. You can obtain the name of
+the sink with the following command:
+
+ $ pacmd list-sinks | grep name:
+ name: <alsa_output.pci-0000_00_14.2.analog-stereo>
+
+The name is what's inside the angle brackets, not including them. If no sink is
+specified the default sink is used. If the device string is missing or is set
+to "default", PulseAudio will be tried if detected and will fallback to ALSA
+(Linux) or OSS (FreeBSD/OpenBSD).
*Example order*: +volume master+
device = "pulse:1"
}
-------------------------------------------------------------
+-------------------------------------------------------------
+volume master {
+ format = "♪: %volume"
+ format_muted = "♪: muted (%volume)"
+ device = "pulse:alsa_output.pci-0000_00_14.2.analog-stereo"
+}
+-------------------------------------------------------------
== Universal module options
set a sensible minimum width regardless of which font you are using, and at
what particular size. Please note that a number enclosed with quotes will
still be treated as a number.
+separator::
+ A boolean value which specifies whether a separator line should be drawn
+ after this block. The default is true, meaning the separator line will be
+ drawn. Note that if you disable the separator line, there will still be a
+ gap after the block, unless you also use separator_block_width.
+separator_block_width::
+ The amount of pixels to leave blank after the block. In the middle of this
+ gap, a separator symbol will be drawn unless separator is disabled. This is
+ why the specified width should leave enough space for the separator symbol.
*Example configuration*:
-------------------------------------------------------------
format = "%avail"
align = "left"
min_width = 100
+ separator = false
+ separator_block_width = 1
}
-------------------------------------------------------------
Note that if you want to use the JSON output format (with colors in i3bar), you
need to use a slightly more complex wrapper script. There are examples in the
-contrib/ folder, see http://code.i3wm.org/i3status/tree/contrib
+contrib/ folder, see http://code.i3wm.org/i3status/tree/master/contrib
== SIGNALS
projects / i3 / i3status / blobdiff