i3status(1)
===========
Michael Stapelberg <michael+i3@stapelberg.de>
-v2.3, July 2011
+v2.5, May 2012
== NAME
== CONFIGURATION
-Since version 2, the configuration file for i3status will be parsed using
-libconfuse. This makes configuration easier in the programmer’s point of
-view and more flexible for the user at the same time.
-
The basic idea of i3status is that you can specify which "modules" should
be used (the order directive). You can then configure each module with its
own section. For every module, you can specify the output format. See below
interval = 5
}
-order = "ipv6"
+order += "ipv6"
order += "disk /"
order += "run_watch DHCP"
order += "run_watch VPN"
}
battery 0 {
- format = "%status %percentage %remaining"
+ format = "%status %percentage %remaining %emptytime"
+ path = "/sys/class/power_supply/BAT%d/uevent"
}
run_watch DHCP {
Using +output_format+ you can chose which format strings i3status should
use in its output. Currently available are:
+i3bar::
+i3bar comes with i3 and provides a workspace bar which does the right thing in
+multi-monitor situations. It also comes with tray support and can display the
+i3status output. This output type uses JSON to pass as much meta-information to
+i3bar as possible (like colors, which blocks can be shortened in which way,
+etc.).
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
*Example order*: +run_watch DHCP+
+*Example format*: +%title: %status+
+
=== Wireless
Gets the link quality and ESSID of the given wireless network interface. You
=== Battery
Gets the status (charging, discharging, running), percentage and remaining
-time of the given battery. 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+.
+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
++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.
*Example order*: +battery 0+
-*Example format*: +%status %remaining+
+*Example format*: +%status %remaining (%emptytime)+
=== CPU-Temperature
i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
---------------------------------------------------------------------
+== What about memory usage or CPU frequency?
+
+While talking about two specific things, please understand this section as a
+general explanation why your favorite information is not included in i3status.
+
+Let’s talk about memory usage specifically. It is hard to measure memory in a
+way which is accurate or meaningful. An in-depth understanding of how paging
+and virtual memory work in your operating system is required. Furthermore, even
+if we had a well-defined way of displaying memory usage and you would
+understand it, I think that it’s not helpful to repeatedly monitor your memory
+usage. One reason for that is that I have not run out of memory in the last few
+years. Memory has become so cheap that even in my 4 year old notebook, I have
+8 GiB of RAM. Another reason is that your operating system will do the right
+thing anyway: Either you have not enough RAM for your workload, but you need to
+do it anyway, then your operating system will swap. Or you don’t have enough
+RAM and you want to restrict your workload so that it fits, then the operating
+system will kill the process using too much RAM and you can act accordingly.
+
+For CPU frequency, the situation is similar. Many people don’t understand how
+frequency scaling works precisely. The generally recommended CPU frequency
+governor ("ondemand") changes the CPU frequency far more often than i3status
+could display it. The display number is therefore often incorrect and doesn’t
+tell you anything useful either.
+
+In general, i3status wants to display things which you would look at
+occasionally anyways, like the current date/time, whether you are connected to
+a WiFi network or not, and if you have enough disk space to fit that 4.3 GiB
+download.
+
+However, if you need to look at some kind of information more than once in a
+while (like checking repeatedly how full your RAM is), you are probably better
+off with a script doing that, which pops up an alert when your RAM usage reaches
+a certain threshold. After all, the point of computers is not to burden you
+with additional boring tasks like repeatedly checking a number.
+
== External scripts/programs with i3status
In i3status, we don’t want to implement process management again. Therefore,
i3status | while :
do
read line
- echo "mystuff | $line"
+ echo "mystuff | $line" || exit 1
done
--------------------------------------------------------------
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<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.4" />\r
-<title>i3status(1)</title>\r
-<style type="text/css">\r
-/* Sans-serif font. */\r
-h1, h2, h3, h4, h5, h6,\r
-div.title, caption.title,\r
-thead, p.table.header,\r
-div#toctitle,\r
-span#author, span#revnumber, span#revdate, span#revremark,\r
-div#footer {\r
- font-family: Arial,Helvetica,sans-serif;\r
-}\r
-\r
-/* Serif font. */\r
-div.sectionbody {\r
- font-family: Georgia,"Times New Roman",Times,serif;\r
-}\r
-\r
-/* Monospace font. */\r
-tt {\r
- font-size: inherit;\r
-}\r
-\r
-body {\r
- margin: 1em 5% 1em 5%;\r
-}\r
-\r
-a {\r
- color: blue;\r
- text-decoration: underline;\r
-}\r
-a:visited {\r
- color: fuchsia;\r
-}\r
-\r
-em {\r
- font-style: italic;\r
- color: navy;\r
-}\r
-\r
-strong {\r
- font-weight: bold;\r
- color: #083194;\r
-}\r
-\r
-tt {\r
- font-size: inherit;\r
- color: navy;\r
-}\r
-\r
-h1, h2, h3, h4, h5, h6 {\r
- color: #527bbd;\r
- margin-top: 1.2em;\r
- margin-bottom: 0.5em;\r
- line-height: 1.3;\r
-}\r
-\r
-h1, h2, h3 {\r
- border-bottom: 2px solid silver;\r
-}\r
-h2 {\r
- padding-top: 0.5em;\r
-}\r
-h3 {\r
- float: left;\r
-}\r
-h3 + * {\r
- clear: left;\r
-}\r
-\r
-div.sectionbody {\r
- margin-left: 0;\r
-}\r
-\r
-hr {\r
- border: 1px solid silver;\r
-}\r
-\r
-p {\r
- margin-top: 0.5em;\r
- margin-bottom: 0.5em;\r
-}\r
-\r
-ul, ol, li > p {\r
- margin-top: 0;\r
-}\r
-ul > li { color: #aaa; }\r
-ul > li > * { color: black; }\r
-\r
-pre {\r
- padding: 0;\r
- margin: 0;\r
-}\r
-\r
-span#author {\r
- color: #527bbd;\r
- font-weight: bold;\r
- font-size: 1.1em;\r
-}\r
-span#email {\r
-}\r
-span#revnumber, span#revdate, span#revremark {\r
-}\r
-\r
-div#footer {\r
- font-size: small;\r
- border-top: 2px solid silver;\r
- padding-top: 0.5em;\r
- margin-top: 4.0em;\r
-}\r
-div#footer-text {\r
- float: left;\r
- padding-bottom: 0.5em;\r
-}\r
-div#footer-badges {\r
- float: right;\r
- padding-bottom: 0.5em;\r
-}\r
-\r
-div#preamble {\r
- margin-top: 1.5em;\r
- margin-bottom: 1.5em;\r
-}\r
-div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
-div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
-div.admonitionblock {\r
- margin-top: 1.0em;\r
- margin-bottom: 1.5em;\r
-}\r
-div.admonitionblock {\r
- margin-top: 2.0em;\r
- margin-bottom: 2.0em;\r
- margin-right: 10%;\r
- color: #606060;\r
-}\r
-\r
-div.content { /* Block element content. */\r
- padding: 0;\r
-}\r
-\r
-/* Block element titles. */\r
-div.title, caption.title {\r
- color: #527bbd;\r
- font-weight: bold;\r
- text-align: left;\r
- margin-top: 1.0em;\r
- margin-bottom: 0.5em;\r
-}\r
-div.title + * {\r
- margin-top: 0;\r
-}\r
-\r
-td div.title:first-child {\r
- margin-top: 0.0em;\r
-}\r
-div.content div.title:first-child {\r
- margin-top: 0.0em;\r
-}\r
-div.content + div.title {\r
- margin-top: 0.0em;\r
-}\r
-\r
-div.sidebarblock > div.content {\r
- background: #ffffee;\r
- border: 1px solid #dddddd;\r
- border-left: 4px solid #f0f0f0;\r
- padding: 0.5em;\r
-}\r
-\r
-div.listingblock > div.content {\r
- border: 1px solid #dddddd;\r
- border-left: 5px solid #f0f0f0;\r
- background: #f8f8f8;\r
- padding: 0.5em;\r
-}\r
-\r
-div.quoteblock, div.verseblock {\r
- padding-left: 1.0em;\r
- margin-left: 1.0em;\r
- margin-right: 10%;\r
- border-left: 5px solid #f0f0f0;\r
- color: #777777;\r
-}\r
-\r
-div.quoteblock > div.attribution {\r
- padding-top: 0.5em;\r
- text-align: right;\r
-}\r
-\r
-div.verseblock > pre.content {\r
- font-family: inherit;\r
- font-size: inherit;\r
-}\r
-div.verseblock > div.attribution {\r
- padding-top: 0.75em;\r
- text-align: left;\r
-}\r
-/* DEPRECATED: Pre version 8.2.7 verse style literal block. */\r
-div.verseblock + div.attribution {\r
- text-align: left;\r
-}\r
-\r
-div.admonitionblock .icon {\r
- vertical-align: top;\r
- font-size: 1.1em;\r
- font-weight: bold;\r
- text-decoration: underline;\r
- color: #527bbd;\r
- padding-right: 0.5em;\r
-}\r
-div.admonitionblock td.content {\r
- padding-left: 0.5em;\r
- border-left: 3px solid #dddddd;\r
-}\r
-\r
-div.exampleblock > div.content {\r
- border-left: 3px solid #dddddd;\r
- padding-left: 0.5em;\r
-}\r
-\r
-div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
-a.image:visited { color: white; }\r
-\r
-dl {\r
- margin-top: 0.8em;\r
- margin-bottom: 0.8em;\r
-}\r
-dt {\r
- margin-top: 0.5em;\r
- margin-bottom: 0;\r
- font-style: normal;\r
- color: navy;\r
-}\r
-dd > *:first-child {\r
- margin-top: 0.1em;\r
-}\r
-\r
-ul, ol {\r
- list-style-position: outside;\r
-}\r
-ol.arabic {\r
- list-style-type: decimal;\r
-}\r
-ol.loweralpha {\r
- list-style-type: lower-alpha;\r
-}\r
-ol.upperalpha {\r
- list-style-type: upper-alpha;\r
-}\r
-ol.lowerroman {\r
- list-style-type: lower-roman;\r
-}\r
-ol.upperroman {\r
- list-style-type: upper-roman;\r
-}\r
-\r
-div.compact ul, div.compact ol,\r
-div.compact p, div.compact p,\r
-div.compact div, div.compact div {\r
- margin-top: 0.1em;\r
- margin-bottom: 0.1em;\r
-}\r
-\r
-div.tableblock > table {\r
- border: 3px solid #527bbd;\r
-}\r
-thead, p.table.header {\r
- font-weight: bold;\r
- color: #527bbd;\r
-}\r
-tfoot {\r
- font-weight: bold;\r
-}\r
-td > div.verse {\r
- white-space: pre;\r
-}\r
-p.table {\r
- margin-top: 0;\r
-}\r
-/* Because the table frame attribute is overriden by CSS in most browsers. */\r
-div.tableblock > table[frame="void"] {\r
- border-style: none;\r
-}\r
-div.tableblock > table[frame="hsides"] {\r
- border-left-style: none;\r
- border-right-style: none;\r
-}\r
-div.tableblock > table[frame="vsides"] {\r
- border-top-style: none;\r
- border-bottom-style: none;\r
-}\r
-\r
-\r
-div.hdlist {\r
- margin-top: 0.8em;\r
- margin-bottom: 0.8em;\r
-}\r
-div.hdlist tr {\r
- padding-bottom: 15px;\r
-}\r
-dt.hdlist1.strong, td.hdlist1.strong {\r
- font-weight: bold;\r
-}\r
-td.hdlist1 {\r
- vertical-align: top;\r
- font-style: normal;\r
- padding-right: 0.8em;\r
- color: navy;\r
-}\r
-td.hdlist2 {\r
- vertical-align: top;\r
-}\r
-div.hdlist.compact tr {\r
- margin: 0;\r
- padding-bottom: 0;\r
-}\r
-\r
-.comment {\r
- background: yellow;\r
-}\r
-\r
-.footnote, .footnoteref {\r
- font-size: 0.8em;\r
-}\r
-\r
-span.footnote, span.footnoteref {\r
- vertical-align: super;\r
-}\r
-\r
-#footnotes {\r
- margin: 20px 0 20px 0;\r
- padding: 7px 0 0 0;\r
-}\r
-\r
-#footnotes div.footnote {\r
- margin: 0 0 5px 0;\r
-}\r
-\r
-#footnotes hr {\r
- border: none;\r
- border-top: 1px solid silver;\r
- height: 1px;\r
- text-align: left;\r
- margin-left: 0;\r
- width: 20%;\r
- min-width: 100px;\r
-}\r
-\r
-div.colist td {\r
- padding-right: 0.5em;\r
- padding-bottom: 0.3em;\r
- vertical-align: top;\r
-}\r
-div.colist td img {\r
- margin-top: 0.3em;\r
-}\r
-\r
-@media print {\r
- div#footer-badges { display: none; }\r
-}\r
-\r
-div#toc {\r
- margin-bottom: 2.5em;\r
-}\r
-\r
-div#toctitle {\r
- color: #527bbd;\r
- font-size: 1.1em;\r
- font-weight: bold;\r
- margin-top: 1.0em;\r
- margin-bottom: 0.1em;\r
-}\r
-\r
-div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
- margin-top: 0;\r
- margin-bottom: 0;\r
-}\r
-div.toclevel2 {\r
- margin-left: 2em;\r
- font-size: 0.9em;\r
-}\r
-div.toclevel3 {\r
- margin-left: 4em;\r
- font-size: 0.9em;\r
-}\r
-div.toclevel4 {\r
- margin-left: 6em;\r
- font-size: 0.9em;\r
-}\r
-\r
-span.aqua { color: aqua; }\r
-span.black { color: black; }\r
-span.blue { color: blue; }\r
-span.fuchsia { color: fuchsia; }\r
-span.gray { color: gray; }\r
-span.green { color: green; }\r
-span.lime { color: lime; }\r
-span.maroon { color: maroon; }\r
-span.navy { color: navy; }\r
-span.olive { color: olive; }\r
-span.purple { color: purple; }\r
-span.red { color: red; }\r
-span.silver { color: silver; }\r
-span.teal { color: teal; }\r
-span.white { color: white; }\r
-span.yellow { color: yellow; }\r
-\r
-span.aqua-background { background: aqua; }\r
-span.black-background { background: black; }\r
-span.blue-background { background: blue; }\r
-span.fuchsia-background { background: fuchsia; }\r
-span.gray-background { background: gray; }\r
-span.green-background { background: green; }\r
-span.lime-background { background: lime; }\r
-span.maroon-background { background: maroon; }\r
-span.navy-background { background: navy; }\r
-span.olive-background { background: olive; }\r
-span.purple-background { background: purple; }\r
-span.red-background { background: red; }\r
-span.silver-background { background: silver; }\r
-span.teal-background { background: teal; }\r
-span.white-background { background: white; }\r
-span.yellow-background { background: yellow; }\r
-\r
-span.big { font-size: 2em; }\r
-span.small { font-size: 0.6em; }\r
-</style>\r
+<meta name="generator" content="AsciiDoc 8.6.6" />\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
/*<+'])');\r
- // Function that scans the DOM tree for header elements (the DOM2\r
- // nodeIterator API would be a better technique but not supported by all\r
- // browsers).\r
- var iterate = function (el) {\r
- for (var i = el.firstChild; i != null; i = i.nextSibling) {\r
- if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {\r
- var mo = re.exec(i.tagName);\r
- if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {\r
- result[result.length] = new TocEntry(i, getText(i), mo[1]-1);\r
- }\r
- iterate(i);\r
- }\r
- }\r
- }\r
- iterate(el);\r
- return result;\r
- }\r
-\r
- var toc = document.getElementById("toc");\r
- var entries = tocEntries(document.getElementById("content"), toclevels);\r
- for (var i = 0; i < entries.length; ++i) {\r
- var entry = entries[i];\r
- if (entry.element.id == "")\r
- entry.element.id = "_toc_" + i;\r
- var a = document.createElement("a");\r
- a.href = "#" + entry.element.id;\r
- a.appendChild(document.createTextNode(entry.text));\r
- var div = document.createElement("div");\r
- div.appendChild(a);\r
- div.className = "toclevel" + entry.toclevel;\r
- toc.appendChild(div);\r
- }\r
- if (entries.length == 0)\r
- toc.parentNode.removeChild(toc);\r
-},\r
-\r
-\r
-/////////////////////////////////////////////////////////////////////\r
-// Footnotes generator\r
-/////////////////////////////////////////////////////////////////////\r
-\r
-/* Based on footnote generation code from:\r
- * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html\r
- */\r
-\r
-footnotes: function () {\r
- var cont = document.getElementById("content");\r
- var noteholder = document.getElementById("footnotes");\r
- var spans = cont.getElementsByTagName("span");\r
- var refs = {};\r
- var n = 0;\r
- for (i=0; i<spans.length; i++) {\r
- if (spans[i].className == "footnote") {\r
- n++;\r
- // Use [\s\S] in place of . so multi-line matches work.\r
- // Because JavaScript has no s (dotall) regex flag.\r
- note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];\r
- noteholder.innerHTML +=\r
- "<div class='footnote' id='_footnote_" + n + "'>" +\r
- "<a href='#_footnoteref_" + n + "' title='Return to text'>" +\r
- n + "</a>. " + note + "</div>";\r
- spans[i].innerHTML =\r
- "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +\r
- "' title='View footnote' class='footnote'>" + n + "</a>]";\r
- var id =spans[i].getAttribute("id");\r
- if (id != null) refs["#"+id] = n;\r
- }\r
- }\r
- if (n == 0)\r
- noteholder.parentNode.removeChild(noteholder);\r
- else {\r
- // Process footnoterefs.\r
- for (i=0; i<spans.length; i++) {\r
- if (spans[i].className == "footnoteref") {\r
- var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");\r
- href = href.match(/#.*/)[0]; // Because IE return full URL.\r
- n = refs[href];\r
- spans[i].innerHTML =\r
- "[<a href='#_footnote_" + n +\r
- "' title='View footnote' class='footnote'>" + n + "</a>]";\r
- }\r
- }\r
- }\r
-}\r
-\r
-}\r
+window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}\r
/*]]>*/\r
</script>\r
+<script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>\r
</head>\r
<body class="article">\r
+\r
+ <div id="main">\r
+ <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>\r
+ <ul id="nav">\r
+ <li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>\r
+ <li><a href="/screenshots">Screens</a></li>\r
+ <li><a href="/contact">Contact</a></li>\r
+ <li><a href="http://bugs.i3wm.org/">Bugs</a></li>\r
+ </ul>\r
+ <br style="clear: both">\r
+<div id="content">\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.4,</span>\r
-<span id="revdate">December 2011</span>\r
+<span id="revnumber">version 2.5,</span>\r
+<span id="revdate">May 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>
+</div>\r
</div>\r
-<div id="content">\r
<div class="sect1">\r
-<h2 id="_name">NAME</h2>\r
+<h2 id="_name">1. NAME</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>i3status - Generates a status line for dzen2 or xmobar</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_synopsis">SYNOPSIS</h2>\r
+<h2 id="_synopsis">2. SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>i3status [-c configfile] [-h] [-v]</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_options">OPTIONS</h2>\r
+<h2 id="_options">3. OPTIONS</h2>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_description">DESCRIPTION</h2>\r
+<h2 id="_description">4. DESCRIPTION</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>i3status is a small program (about 1500 SLOC) for generating a status bar for\r
i3bar, dzen2, xmobar or similar programs. It is designed to be very\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_configuration">CONFIGURATION</h2>\r
+<h2 id="_configuration">5. CONFIGURATION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>Since version 2, the configuration file for i3status will be parsed using\r
-libconfuse. This makes configuration easier in the programmer’s point of\r
-view and more flexible for the user at the same time.</p></div>\r
<div class="paragraph"><p>The basic idea of i3status is that you can specify which "modules" should\r
be used (the order directive). You can then configure each module with its\r
own section. For every module, you can specify the output format. See below\r
}\r
\r
battery 0 {\r
- format = "%status %percentage %remaining"\r
+ format = "%status %percentage %remaining %emptytime"\r
path = "/sys/class/power_supply/BAT%d/uevent"\r
}\r
\r
}</tt></pre>\r
</div></div>\r
<div class="sect2">\r
-<h3 id="_general">General</h3>\r
+<h3 id="_general">5.1. General</h3>\r
<div class="paragraph"><p>The <tt>colors</tt> directive will disable all colors if you set it to <tt>false</tt>. You can\r
also specify the colors that will be used to display "good", "degraded" or "bad"\r
values using the <tt>color_good</tt>, <tt>color_degraded</tt> or <tt>color_bad</tt> directives,\r
use in its output. Currently available are:</p></div>\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
+i3bar\r
+</dt>\r
+<dd>\r
+<p>\r
+i3bar comes with i3 and provides a workspace bar which does the right thing in\r
+multi-monitor situations. It also comes with tray support and can display the\r
+i3status output. This output type uses JSON to pass as much meta-information to\r
+i3bar as possible (like colors, which blocks can be shortened in which way,\r
+etc.).\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
dzen2\r
</dt>\r
<dd>\r
</dl></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_ipv6">IPv6</h3>\r
+<h3 id="_ipv6">5.2. IPv6</h3>\r
<div class="paragraph"><p>This module gets the IPv6 address used for outgoing connections (that is, the\r
best available public IPv6 address on your computer).</p></div>\r
<div class="paragraph"><p><strong>Example format_up</strong>: <tt>%ip</tt></p></div>\r
<div class="paragraph"><p><strong>Example format_down</strong> <tt>no IPv6</tt></p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_disk">Disk</h3>\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><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>\r
<div class="sect2">\r
-<h3 id="_run_watch">Run-watch</h3>\r
+<h3 id="_run_watch">5.4. Run-watch</h3>\r
<div class="paragraph"><p>Expands the given path to a pidfile and checks if the process ID found inside\r
is valid (that is, if the process is running). You can use this to check if\r
a specific application, such as a VPN client or your DHCP client is running.</p></div>\r
<div class="paragraph"><p><strong>Example order</strong>: <tt>run_watch DHCP</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%title: %status</tt></p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_wireless">Wireless</h3>\r
+<h3 id="_wireless">5.5. Wireless</h3>\r
<div class="paragraph"><p>Gets the link quality and ESSID of the given wireless network interface. You\r
can specify different format strings for the network being connected or not\r
connected.</p></div>\r
<div class="paragraph"><p><strong>Example format</strong>: <tt>W: (%quality at %essid, %bitrate) %ip</tt></p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_ethernet">Ethernet</h3>\r
+<h3 id="_ethernet">5.6. 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
<div class="paragraph"><p><strong>Example format</strong>: <tt>E: %ip (%speed)</tt></p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_battery">Battery</h3>\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. If you want to use the last full capacity instead\r
-of the design capacity (when using the design capacity, it may happen that\r
-your battery is at 23% when fully charged because it’s old. In general, I\r
-want to see it this way, because it tells me how worn off my battery is.),\r
-just specify <tt>last_full_capacity = true</tt>.</p></div>\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
+<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><strong>Example order</strong>: <tt>battery 0</tt></p></div>\r
-<div class="paragraph"><p><strong>Example format</strong>: <tt>%status %remaining</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%status %remaining (%emptytime)</tt></p></div>\r
</div>\r
<div class="sect2">\r
-<h3 id="_cpu_temperature">CPU-Temperature</h3>\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><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>\r
<div class="sect2">\r
-<h3 id="_cpu_usage">CPU Usage</h3>\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><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="_load">Load</h3>\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
<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>\r
<div class="sect2">\r
-<h3 id="_time">Time</h3>\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><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">DDate</h3>\r
+<h3 id="_ddate">5.12. 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
<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">Volume</h3>\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
<div class="paragraph"><p><strong>Example order</strong>: <tt>volume master</tt></p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_using_i3status_with_dzen2">Using i3status with dzen2</h2>\r
+<h2 id="_using_i3status_with_dzen2">6. Using i3status with dzen2</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>After installing dzen2, you can directly use it with i3status. Just ensure that\r
<tt>output_format</tt> is set to <tt>dzen2</tt>.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_using_i3status_with_xmobar">Using i3status with xmobar</h2>\r
+<h2 id="_using_i3status_with_xmobar">7. Using i3status with xmobar</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>To get xmobar to start, you might need to copy the default configuration\r
file to <tt>~/.xmobarrc</tt>. Also, ensure that the <tt>output_format</tt> option for i3status\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_external_scripts_programs_with_i3status">External scripts/programs with i3status</h2>\r
+<h2 id="_what_about_memory_usage_or_cpu_frequency">8. What about memory usage or CPU frequency?</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>While talking about two specific things, please understand this section as a\r
+general explanation why your favorite information is not included in i3status.</p></div>\r
+<div class="paragraph"><p>Let’s talk about memory usage specifically. It is hard to measure memory in a\r
+way which is accurate or meaningful. An in-depth understanding of how paging\r
+and virtual memory work in your operating system is required. Furthermore, even\r
+if we had a well-defined way of displaying memory usage and you would\r
+understand it, I think that it’s not helpful to repeatedly monitor your memory\r
+usage. One reason for that is that I have not run out of memory in the last few\r
+years. Memory has become so cheap that even in my 4 year old notebook, I have\r
+8 GiB of RAM. Another reason is that your operating system will do the right\r
+thing anyway: Either you have not enough RAM for your workload, but you need to\r
+do it anyway, then your operating system will swap. Or you don’t have enough\r
+RAM and you want to restrict your workload so that it fits, then the operating\r
+system will kill the process using too much RAM and you can act accordingly.</p></div>\r
+<div class="paragraph"><p>For CPU frequency, the situation is similar. Many people don’t understand how\r
+frequency scaling works precisely. The generally recommended CPU frequency\r
+governor ("ondemand") changes the CPU frequency far more often than i3status\r
+could display it. The display number is therefore often incorrect and doesn’t\r
+tell you anything useful either.</p></div>\r
+<div class="paragraph"><p>In general, i3status wants to display things which you would look at\r
+occasionally anyways, like the current date/time, whether you are connected to\r
+a WiFi network or not, and if you have enough disk space to fit that 4.3 GiB\r
+download.</p></div>\r
+<div class="paragraph"><p>However, if you need to look at some kind of information more than once in a\r
+while (like checking repeatedly how full your RAM is), you are probably better\r
+off with a script doing that, which pops up an alert when your RAM usage reaches\r
+a certain threshold. After all, the point of computers is not to burden you\r
+with additional boring tasks like repeatedly checking a number.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_external_scripts_programs_with_i3status">9. External scripts/programs with i3status</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>In i3status, we don’t want to implement process management again. Therefore,\r
there is no module to run arbitrary scripts or commands. Instead, you should\r
i3status | while :\r
do\r
read line\r
- echo "mystuff | $line"\r
+ echo "mystuff | $line" || exit 1\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>\r
</div>\r
<div class="sect1">\r
-<h2 id="_see_also">SEE ALSO</h2>\r
+<h2 id="_see_also">10. 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">AUTHORS</h2>\r
+<h2 id="_authors">11. 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
</div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
-<div id="footer">\r
-<div id="footer-text">\r
-Version 2.4<br />\r
-Last updated 2011-12-27 00:31:50 CET\r
-</div>\r
+<div id="footer" lang="de">\r
+© 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>\r
</div>\r
</body>\r
</html>\r
projects / i3 / i3.github.io / commitdiff