i3status(1)
===========
-Michael Stapelberg <michael+i3@stapelberg.de>
-v2.5, May 2012
+Michael Stapelberg <michael@i3wm.org>
+v2.6, October 2012
== NAME
battery 0 {
format = "%status %percentage %remaining %emptytime"
path = "/sys/class/power_supply/BAT%d/uevent"
+ low_threshold = 10
}
run_watch DHCP {
Gets used, free, available and total amount of bytes on the given mounted filesystem.
+These values can also be expressed in percentages with the percentage_used,
+percentage_free, percentage_avail and percentage_used_of_avail formats.
+
*Example order*: +disk /mnt/usbstick+
*Example format*: +%free (%avail)/ %total+
+*Example format*: +%percentage_used used, %percentage_free free, %percentage_avail avail+
+
=== Run-watch
Expands the given path to a pidfile and checks if the process ID found inside
=== Battery
-Gets the status (charging, discharging, running), percentage and remaining
-time 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 battery is at 23% when fully
-charged because it’s old. In general, I want to see it this way, because
-it tells me how worn off my battery is.), just specify
+Gets the status (charging, discharging, running), 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
+battery is at 23% when fully charged because it’s old. In general, I want to
+see it this way, because it tells me how worn off my battery is.), just specify
+last_full_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.
+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
+"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.
+
*Example order*: +battery 0+
-*Example format*: +%status %remaining (%emptytime)+
+*Example format*: +%status %remaining (%emptytime %consumption)+
+
+*Example low_threshold*: +30+
+
+*Example threshold_type*: +time+
=== CPU-Temperature
=== CPU Usage
-Gets the percentual CPU usage from +/proc/stat+.
+Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+ (FreeBSD/OpenBSD).
*Example order*: +cpu_usage+
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
+ignored on these systems. On these systems the OSS API is used instead to
+query +/dev/mixer+ directly.
*Example order*: +volume master+
Put that in some script, say +.bin/my_i3status.sh+ and execute that instead of i3status.
+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
+
== SEE ALSO
+strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
<head>\r
<link rel="icon" type="image/png" href="/favicon.png">\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.6" />\r
+<meta name="generator" content="AsciiDoc 8.6.7" />\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
<div id="header">\r
<h1>i3status(1)</h1>\r
<span id="author">Michael Stapelberg</span><br />\r
-<span id="email"><tt><<a href="mailto:michael+i3@stapelberg.de">michael+i3@stapelberg.de</a>></tt></span><br />\r
-<span id="revnumber">version 2.5,</span>\r
-<span id="revdate">May 2012</span>\r
+<span id="email"><tt><<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>></tt></span><br />\r
+<span id="revnumber">version 2.6,</span>\r
+<span id="revdate">October 2012</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>
battery 0 {\r
format = "%status %percentage %remaining %emptytime"\r
path = "/sys/class/power_supply/BAT%d/uevent"\r
+ low_threshold = 10\r
}\r
\r
run_watch DHCP {\r
<div class="sect2">\r
<h3 id="_disk">5.3. Disk</h3>\r
<div class="paragraph"><p>Gets used, free, available and total amount of bytes on the given mounted filesystem.</p></div>\r
+<div class="paragraph"><p>These values can also be expressed in percentages with the percentage_used,\r
+percentage_free, percentage_avail and percentage_used_of_avail formats.</p></div>\r
<div class="paragraph"><p><strong>Example order</strong>: <tt>disk /mnt/usbstick</tt></p></div>\r
<div class="paragraph"><p><strong>Example format</strong>: <tt>%free (%avail)/ %total</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%percentage_used used, %percentage_free free, %percentage_avail avail</tt></p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_run_watch">5.4. Run-watch</h3>\r
</div>\r
<div class="sect2">\r
<h3 id="_battery">5.7. Battery</h3>\r
-<div class="paragraph"><p>Gets the status (charging, discharging, running), percentage and remaining\r
-time of the given battery and when it’s estimated to be empty. If you want\r
-to use the last full capacity instead of the design capacity (when using\r
-the design capacity, it may happen that your battery is at 23% when fully\r
-charged because it’s old. In general, I want to see it this way, because\r
-it tells me how worn off my battery is.), just specify\r
+<div class="paragraph"><p>Gets the status (charging, discharging, running), percentage, remaining\r
+time and power consumption (in Watts) of the given battery and when it’s\r
+estimated to be empty. If you want to use the last full capacity instead of the\r
+design capacity (when using the design capacity, it may happen that your\r
+battery is at 23% when fully charged because it’s old. In general, I want to\r
+see it this way, because it tells me how worn off my battery is.), just specify\r
<tt>last_full_capacity = true</tt>.</p></div>\r
<div class="paragraph"><p>If your battery is represented in a non-standard path in /sys, be sure to\r
modify the "path" property accordingly. The first occurence of %d gets replaced\r
with the battery number, but you can just hard-code a path as well.</p></div>\r
+<div class="paragraph"><p>It is possible to define a low_threshold that causes the battery text to be\r
+colored red. The low_threshold type can be of threshold_type "time" or\r
+"percentage". So, if you configure low_threshold to 10 and threshold_type to\r
+"time", and your battery lasts another 9 minutes, it will be colored red.</p></div>\r
<div class="paragraph"><p><strong>Example order</strong>: <tt>battery 0</tt></p></div>\r
-<div class="paragraph"><p><strong>Example format</strong>: <tt>%status %remaining (%emptytime)</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%status %remaining (%emptytime %consumption)</tt></p></div>\r
+<div class="paragraph"><p><strong>Example low_threshold</strong>: <tt>30</tt></p></div>\r
+<div class="paragraph"><p><strong>Example threshold_type</strong>: <tt>time</tt></p></div>\r
</div>\r
<div class="sect2">\r
<h3 id="_cpu_temperature">5.8. CPU-Temperature</h3>\r
</div>\r
<div class="sect2">\r
<h3 id="_cpu_usage">5.9. CPU Usage</h3>\r
-<div class="paragraph"><p>Gets the percentual CPU usage from <tt>/proc/stat</tt>.</p></div>\r
+<div class="paragraph"><p>Gets the percentual CPU usage from <tt>/proc/stat</tt> (Linux) or <tt>sysctl(3)</tt> (FreeBSD/OpenBSD).</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>\r
<div class="sect2">\r
<h3 id="_volume">5.13. Volume</h3>\r
<div class="paragraph"><p>Outputs the volume of the specified mixer on the specified device. Works only\r
-on Linux because it uses ALSA.</p></div>\r
+on Linux because it uses ALSA.\r
+A simplified configuration can be used on FreeBSD and OpenBSD due to\r
+the lack of ALSA, the <tt>device</tt>, <tt>mixer</tt> and <tt>mixder_idx</tt> options can be\r
+ignored on these systems. On these systems the OSS API is used instead to\r
+query <tt>/dev/mixer</tt> directly.</p></div>\r
<div class="paragraph"><p><strong>Example order</strong>: <tt>volume master</tt></p></div>\r
<div class="paragraph"><p><strong>Example format</strong>: <tt>♪: %volume</tt></p></div>\r
<div class="paragraph"><p><strong>Example configuration</strong>:</p></div>\r
done</tt></pre>\r
</div></div>\r
<div class="paragraph"><p>Put that in some script, say <tt>.bin/my_i3status.sh</tt> and execute that instead of i3status.</p></div>\r
+<div class="paragraph"><p>Note that if you want to use the JSON output format (with colors in i3bar), you\r
+need to use a slightly more complex wrapper script. There are examples in the\r
+contrib/ folder, see <a href="http://code.i3wm.org/i3status/tree/contrib">http://code.i3wm.org/i3status/tree/contrib</a></p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
projects / i3 / i3.github.io / commitdiff