]> git.sur5r.net Git - i3/i3.github.io/blobdiff - docs/i3status.html
add the 4.8 release
[i3/i3.github.io] / docs / i3status.html
index c4bccd500a51816d5bbeb211dc8cce5bf65e09df..c86426839fd57c3a648b8a3d48b4f9bafeaacf78 100644 (file)
@@ -4,13 +4,13 @@
 <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.7" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\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
 <script type="text/javascript">\r
 /*<![CDATA[*/\r
-window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}\r
+document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); asciidoc.toc(2);}, false);\r
 /*]]>*/\r
 </script>\r
 <script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>\r
@@ -125,7 +125,8 @@ order += "ethernet eth0"
 order += "battery 0"\r
 order += "cpu_temperature 0"\r
 order += "load"\r
-order += "time"\r
+order += "tztime local"\r
+order += "tztime berlin"\r
 \r
 wireless wlan0 {\r
         format_up = "W: (%quality at %essid, %bitrate) %ip"\r
@@ -152,10 +153,15 @@ run_watch VPN {
         pidfile = "/var/run/vpnc/pid"\r
 }\r
 \r
-time {\r
+tztime local {\r
         format = "%Y-%m-%d %H:%M:%S"\r
 }\r
 \r
+tztime berlin {\r
+        format = "%Y-%m-%d %H:%M:%S %Z"\r
+        timezone = "Europe/Berlin"\r
+}\r
+\r
 load {\r
         format = "%5min"\r
 }\r
@@ -232,6 +238,10 @@ be used with i3bar and can be used for custom scripts.
 </p>\r
 </dd>\r
 </dl></div>\r
+<div class="paragraph"><p>It&#8217;s also possible to use the color_good, color_degraded, color_bad directives\r
+to define specific colors per module. If one of these directives is defined\r
+in a module section its value will override the value defined in the general\r
+section just for this module.</p></div>\r
 </div>\r
 <div class="sect2">\r
 <h3 id="_ipv6">5.2. IPv6</h3>\r
@@ -282,6 +292,8 @@ 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\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 you want the battery percentage to be shown without decimals, add\r
+<tt>integer_battery_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
@@ -296,9 +308,12 @@ colored red. The low_threshold type can be of threshold_type "time" or
 </div>\r
 <div class="sect2">\r
 <h3 id="_cpu_temperature">5.8. CPU-Temperature</h3>\r
-<div class="paragraph"><p>Gets the temperature of the given thermal zone.</p></div>\r
+<div class="paragraph"><p>Gets the temperature of the given thermal zone. It is possible to\r
+define a max_threshold that will color the temperature red in case the\r
+specified thermal zone is getting too hot. Defaults to 75 degrees C.</p></div>\r
 <div class="paragraph"><p><strong>Example order</strong>: <tt>cpu_temperature 0</tt></p></div>\r
 <div class="paragraph"><p><strong>Example format</strong>: <tt>T: %degrees °C</tt></p></div>\r
+<div class="paragraph"><p><strong>Example max_threshold</strong>: <tt>42</tt></p></div>\r
 </div>\r
 <div class="sect2">\r
 <h3 id="_cpu_usage">5.9. CPU Usage</h3>\r
@@ -309,18 +324,37 @@ colored red. The low_threshold type can be of threshold_type "time" or
 <div class="sect2">\r
 <h3 id="_load">5.10. Load</h3>\r
 <div class="paragraph"><p>Gets the system load (number of processes waiting for CPU time in the last\r
-1, 5 and 15 minutes).</p></div>\r
+1, 5 and 15 minutes). It is possible to define a max_threshold that will\r
+color the load value red in case the load average of the last minute is\r
+getting higher than the configured threshold. Defaults to 5.</p></div>\r
 <div class="paragraph"><p><strong>Example order</strong>: <tt>load</tt></p></div>\r
 <div class="paragraph"><p><strong>Example format</strong>: <tt>%1min %5min %15min</tt></p></div>\r
+<div class="paragraph"><p><strong>Example max_threshold</strong>: 5</p></div>\r
 </div>\r
 <div class="sect2">\r
 <h3 id="_time">5.11. Time</h3>\r
-<div class="paragraph"><p>Formats the current system time. See <tt>strftime(3)</tt> for the format.</p></div>\r
+<div class="paragraph"><p>Outputs the current time in the local timezone.\r
+To use a different timezone, you can set the TZ environment variable,\r
+or use the <tt>tztime</tt> module.\r
+See <tt>strftime(3)</tt> for details on the format string.</p></div>\r
 <div class="paragraph"><p><strong>Example order</strong>: <tt>time</tt></p></div>\r
 <div class="paragraph"><p><strong>Example format</strong>: <tt>%Y-%m-%d %H:%M:%S</tt></p></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_ddate">5.12. DDate</h3>\r
+<h3 id="_tztime">5.12. TzTime</h3>\r
+<div class="paragraph"><p>Outputs the current time in the given timezone.\r
+If no timezone is given, local time will be used.\r
+See <tt>strftime(3)</tt> for details on the format string.\r
+The system&#8217;s timezone database is usually installed in <tt>/usr/share/zoneinfo</tt>.\r
+Files below that path make for valid timezone strings, e.g. for\r
+<tt>/usr/share/zoneinfo/Europe/Berlin</tt> you can set timezone to <tt>Europe/Berlin</tt>\r
+in the <tt>tztime</tt> module.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>tztime berlin</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%Y-%m-%d %H:%M:%S %Z</tt></p></div>\r
+<div class="paragraph"><p><strong>Example timezone</strong>: <tt>Europe/Berlin</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_ddate">5.13. DDate</h3>\r
 <div class="paragraph"><p>Outputs the current discordian date in user-specified format. See <tt>ddate(1)</tt> for\r
 details on the format string.\r
 <strong>Note</strong>: Neither <strong>%.</strong> nor <strong>%X</strong> are implemented yet.</p></div>\r
@@ -328,7 +362,7 @@ details on the format string.
 <div class="paragraph"><p><strong>Example format</strong>: <tt>%{%a, %b %d%}, %Y%N - %H</tt></p></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_volume">5.13. Volume</h3>\r
+<h3 id="_volume">5.14. 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.\r
 A simplified configuration can be used on FreeBSD and OpenBSD due to\r
@@ -434,13 +468,21 @@ contrib/ folder, see <a href="http://code.i3wm.org/i3status/tree/contrib">http:/
 </div>\r
 </div>\r
 <div class="sect1">\r
-<h2 id="_see_also">10. SEE ALSO</h2>\r
+<h2 id="_signals">10. SIGNALS</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>When receiving <tt>SIGUSR1</tt>, i3status’s nanosleep() will be interrupted and thus\r
+you will force an update. You can use killall -USR1 i3status to force an update\r
+after changing the system volume, for example.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_see_also">11. SEE ALSO</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p><tt>strftime(3)</tt>, <tt>date(1)</tt>, <tt>glob(3)</tt>, <tt>dzen2(1)</tt>, <tt>xmobar(1)</tt></p></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
-<h2 id="_authors">11. AUTHORS</h2>\r
+<h2 id="_authors">12. AUTHORS</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>Michael Stapelberg and contributors</p></div>\r
 <div class="paragraph"><p>Thorsten Toepper</p></div>\r