i3status(1)
===========
Michael Stapelberg <michael@i3wm.org>
-v2.11, January 2017
+v2.12, May 2018
== NAME
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
+Using +output_format+ you can choose which format strings i3status should
use in its output. Currently available are:
i3bar::
If you don't fancy the vertical separators between modules i3status/i3bar
uses by default, you can employ the +separator+ directive to configure how
-modules are separated. You can either disable the default separator altogether
+modules are separated. You can also disable the default separator altogether by
setting it to the empty string. You might then define separation as part of a
module's format string. This is your only option when using the i3bar output
format as the separator is drawn by i3bar directly otherwise. For the other
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
+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 "`&`", "`<`",
*Example order*: +wireless wlan0+
-*Example format*: +W: (%quality at %essid, %bitrate / %frequency) %ip+
+*Example format_up*: +W: (%quality at %essid, %bitrate / %frequency) %ip+
+
+*Example format_down*: +W: down+
=== Ethernet
Gets the IP address and (if possible) the link speed of the given ethernet
-interface. Getting the link speed requires the cap_net_admin capability. Set
-it using +setcap cap_net_admin=ep $(which i3status)+.
+interface. If no IPv4 address is available and an IPv6 address is, it will be
+displayed. Getting the link speed requires the cap_net_admin capability.
+Set it using +setcap cap_net_admin=ep $(which i3status)+.
The special interface name `_first_` will be replaced by the first non-wireless
network interface found on the system (excluding devices starting with "lo").
*Example order*: +ethernet eth0+
-*Example format*: +E: %ip (%speed)+
+*Example format_up*: +E: %ip (%speed)+
+
+*Example format_down*: +E: down+
=== Battery
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. The output format
+higher than the configured threshold. Defaults to 90. The output format
when above degraded threshold can be customized with
format_above_degraded_threshold.
+For displaying the Nth CPU usage, you can use the %cpu<N> format string,
+starting from %cpu0. This feature is currently not supported in FreeBSD.
+
*Example order*: +cpu_usage+
-*Example format*: +%usage+
+*Example format*: +all: %usage CPU_0: %cpu0 CPU_1: %cpu1+
*Example max_threshold*: +75+
<head>\r
<link rel="icon" type="image/x-icon" href="/favicon.ico">\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.9" />\r
+<meta name="generator" content="AsciiDoc 8.6.10" />\r
<title>i3: i3status(1)</title>\r
<link rel="stylesheet" href="/css/style.css" type="text/css" />\r
<link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
<h1>i3status(1)</h1>\r
<span id="author">Michael Stapelberg</span><br />\r
<span id="email"><tt><<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>></tt></span><br />\r
-<span id="revnumber">version 2.11,</span>\r
-<span id="revdate">January 2017</span>\r
+<span id="revnumber">version 2.12,</span>\r
+<span id="revdate">May 2018</span>\r
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
<div class="sect1">\r
<h2 id="_description">4. DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>i3status is a small program for generating a status bar for\r
-i3bar, dzen2, xmobar, lemonbar or similar programs. It is designed to be very\r
-efficient by issuing a very small number of system calls, as one generally\r
-wants to update such a status line every second. This ensures that even under\r
-high load, your status bar is updated correctly. Also, it saves a bit of energy\r
-by not hogging your CPU as much as spawning the corresponding amount of shell\r
-commands would.</p></div>\r
+<div class="paragraph"><p>i3status is a small program for generating a status bar for i3bar, dzen2,\r
+xmobar, lemonbar or similar programs. It is designed to be very efficient by\r
+issuing a very small number of system calls, as one generally wants to update\r
+such a status line every second. This ensures that even under high load, your\r
+status bar is updated correctly. Also, it saves a bit of energy by not hogging\r
+your CPU as much as spawning the corresponding amount of shell commands would.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
no effect when <tt>output_format</tt> is set to <tt>i3bar</tt> or <tt>none</tt>.</p></div>\r
<div class="paragraph"><p>The <tt>interval</tt> directive specifies the time in seconds for which i3status will\r
sleep before printing the next status line.</p></div>\r
-<div class="paragraph"><p>Using <tt>output_format</tt> you can chose which format strings i3status should\r
+<div class="paragraph"><p>Using <tt>output_format</tt> you can choose which format strings i3status should\r
use in its output. Currently available are:</p></div>\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
section just for this module.</p></div>\r
<div class="paragraph"><p>If you don’t fancy the vertical separators between modules i3status/i3bar\r
uses by default, you can employ the <tt>separator</tt> directive to configure how\r
-modules are separated. You can either disable the default separator altogether\r
+modules are separated. You can also disable the default separator altogether by\r
setting it to the empty string. You might then define separation as part of a\r
module’s format string. This is your only option when using the i3bar output\r
format as the separator is drawn by i3bar directly otherwise. For the other\r
output formats, the provided non-empty string will be automatically enclosed\r
with the necessary coloring bits if color support is enabled.</p></div>\r
-<div class="paragraph"><p>i3bar supports Pango markup, allowing your format strings to specify font\r
+<div class="paragraph"><p>i3bar supports Pango markup, allowing your format strings to specify font,\r
color, size, etc. by setting the <tt>markup</tt> directive to "pango". Note that the\r
ampersand ("&"), less-than ("<"), greater-than (">"), single-quote ("'"), and\r
double-quote (""") characters need to be replaced with "<tt>&amp;</tt>", "<tt>&lt;</tt>",\r
<div class="paragraph"><p>The special interface name <tt>_first_</tt> will be replaced by the first wireless\r
network interface found on the system (excluding devices starting with "lo").</p></div>\r
<div class="paragraph"><p><strong>Example order</strong>: <tt>wireless wlan0</tt></p></div>\r
-<div class="paragraph"><p><strong>Example format</strong>: <tt>W: (%quality at %essid, %bitrate / %frequency) %ip</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format_up</strong>: <tt>W: (%quality at %essid, %bitrate / %frequency) %ip</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format_down</strong>: <tt>W: down</tt></p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_ethernet">5.7. Ethernet</h3>\r
<div class="paragraph"><p>Gets the IP address and (if possible) the link speed of the given ethernet\r
-interface. Getting the link speed requires the cap_net_admin capability. Set\r
-it using <tt>setcap cap_net_admin=ep $(which i3status)</tt>.</p></div>\r
+interface. If no IPv4 address is available and an IPv6 address is, it will be\r
+displayed. Getting the link speed requires the cap_net_admin capability.\r
+Set it using <tt>setcap cap_net_admin=ep $(which i3status)</tt>.</p></div>\r
<div class="paragraph"><p>The special interface name <tt>_first_</tt> will be replaced by the first non-wireless\r
network interface found on the system (excluding devices starting with "lo").</p></div>\r
<div class="paragraph"><p><strong>Example order</strong>: <tt>ethernet eth0</tt></p></div>\r
-<div class="paragraph"><p><strong>Example format</strong>: <tt>E: %ip (%speed)</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format_up</strong>: <tt>E: %ip (%speed)</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format_down</strong>: <tt>E: down</tt></p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_battery">5.8. Battery</h3>\r
format_above_threshold.</p></div>\r
<div class="paragraph"><p>It is possible to define a degraded_threshold that will color the load\r
value yellow in case the CPU average over the last interval is getting\r
-higher than the configured threshold. Defaults to 90. The output format\r
+higher than the configured threshold. Defaults to 90. The output format\r
when above degraded threshold can be customized with\r
format_above_degraded_threshold.</p></div>\r
+<div class="paragraph"><p>For displaying the Nth CPU usage, you can use the %cpu<N> format string,\r
+starting from %cpu0. This feature is currently not supported in FreeBSD.</p></div>\r
<div class="paragraph"><p><strong>Example order</strong>: <tt>cpu_usage</tt></p></div>\r
-<div class="paragraph"><p><strong>Example format</strong>: <tt>%usage</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>all: %usage CPU_0: %cpu0 CPU_1: %cpu1</tt></p></div>\r
<div class="paragraph"><p><strong>Example max_threshold</strong>: <tt>75</tt></p></div>\r
<div class="paragraph"><p><strong>Example format_above_threshold</strong>: <tt>Warning above threshold: %usage</tt></p></div>\r
<div class="paragraph"><p><strong>Example degraded_threshold</strong>: <tt>25</tt></p></div>\r