<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: i3bar input protocol</title>\r
<link rel="stylesheet" href="/css/style.css" type="text/css" />\r
<link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\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="https://faq.i3wm.org/">FAQ</a></li>\r
+ <li><a href="https://www.reddit.com/r/i3wm/">FAQ</a></li>\r
<li><a href="/contact">Contact</a></li>\r
<li><a href="https://github.com/i3/i3/issues">Bugs</a></li>\r
</ul>\r
</div>\r
</div>\r
<div class="sect1">\r
-<h2 id="_rationale_for_chosing_json">1. Rationale for chosing JSON</h2>\r
+<h2 id="_rationale_for_choosing_json">1. Rationale for choosing JSON</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>Before describing the protocol, let’s cover why JSON is a building block of\r
this protocol.</p></div>\r
\n.</p></div>\r
<div class="paragraph"><p>You can find an example of a shell script which can be used as your\r
<tt>status_command</tt> in the bar configuration at\r
-<a href="http://code.stapelberg.de/git/i3/tree/contrib/trivial-bar-script.sh?h=next">http://code.stapelberg.de/git/i3/tree/contrib/trivial-bar-script.sh?h=next</a></p></div>\r
+<a href="https://github.com/i3/i3/blob/next/contrib/trivial-bar-script.sh">https://github.com/i3/i3/blob/next/contrib/trivial-bar-script.sh</a></p></div>\r
<div class="sect2">\r
<h3 id="_header_in_detail">2.1. Header in detail</h3>\r
<div class="dlist"><dl>\r
</dt>\r
<dd>\r
<p>\r
- Specify to i3bar the signal (as an integer)to send to continue your\r
+ Specify to i3bar the signal (as an integer) to send to continue your\r
processing.\r
The default value (if none is specified) is SIGCONT.\r
</p>\r
</dt>\r
<dd>\r
<p>\r
- If specified and true i3bar will write a infinite array (same as above)\r
+ If specified and true i3bar will write an infinite array (same as above)\r
to your stdin.\r
</p>\r
</dd>\r
<dd>\r
<p>\r
The <tt>full_text</tt> will be displayed by i3bar on the status line. This is the\r
- only required key.\r
+ only required key. If <tt>full_text</tt> is an empty string, the block will be\r
+ skipped.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
+background\r
+</dt>\r
+<dd>\r
+<p>\r
+ Overrides the background color for this particular block.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+border\r
+</dt>\r
+<dd>\r
+<p>\r
+ Overrides the border color for this particular block.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
min_width\r
</dt>\r
<dd>\r
<p>\r
A string that indicates how the text of the block should be parsed. Set to\r
<tt>"pango"</tt> to use <a href="https://developer.gnome.org/pango/stable/PangoMarkupFormat.html">Pango markup</a>.\r
- Set to <tt>"none"</tt> to not use any markup (default).\r
+ Set to <tt>"none"</tt> to not use any markup (default). Pango markup only works\r
+ if you use a pango font.\r
</p>\r
</dd>\r
</dl></div>\r
"full_text": "E: 10.0.0.1 (1000 Mbit/s)",\r
"short_text": "10.0.0.1",\r
"color": "#00ff00",\r
+ "background": "#1c1c1c",\r
+ "border": "#ee0000",\r
"min_width": 300,\r
"align": "right",\r
"urgent": false,\r
</dt>\r
<dd>\r
<p>\r
- X11 root window coordinates where the click occured\r
+ X11 root window coordinates where the click occurred\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
X11 button ID (for example 1 to 3 for left/middle/right mouse button)\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+relative_x, relative_y\r
+</dt>\r
+<dd>\r
+<p>\r
+ Coordinates where the click occurred, with respect to the top left corner\r
+ of the block\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+width, height\r
+</dt>\r
+<dd>\r
+<p>\r
+ Width and height (in px) of the block\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+modifiers\r
+</dt>\r
+<dd>\r
+<p>\r
+ An array of the modifiers active when the click occurred. The order in which\r
+ modifiers are listed is not guaranteed.\r
+</p>\r
+</dd>\r
</dl></div>\r
<div class="paragraph"><p><strong>Example</strong>:</p></div>\r
<div class="listingblock">\r
"name": "ethernet",\r
"instance": "eth0",\r
"button": 1,\r
+ "modifiers": ["Shift", "Mod1"],\r
"x": 1320,\r
- "y": 1400\r
+ "y": 1400,\r
+ "relative_x": 12,\r
+ "relative_y": 8,\r
+ "width": 50,\r
+ "height": 22\r
}</tt></pre>\r
</div></div>\r
</div>\r
</div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer" lang="de">\r
-© 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>\r
+ © 2009-present Michael Stapelberg,\r
+ <a href="/impress.html">Impressum</a>,\r
+ <a href="https://github.com/i3/i3.github.io">Source</a>\r
</div>\r
</body>\r
</html>\r
projects / i3 / i3.github.io / blobdiff