update docs for 4.15

[i3/i3.github.io] / docs / i3bar-protocol.html

diff --git a/docs/i3bar-protocol.html b/docs/i3bar-protocol.html
index 3285613adc182d6ca8a4977abc1d6720a3201bd5..e84e177719130eb4e489f8f19376cb2d1b321b1e 100644 (file)
--- a/docs/i3bar-protocol.html
+++ b/docs/i3bar-protocol.html
@@ -41,7 +41,7 @@ provides support for colors, urgency, shortening and easy manipulation.</p></div
 </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
@@ -145,7 +145,7 @@ i3status and others will output single statuslines in one line, separated by
 \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
@@ -182,7 +182,7 @@ click_events
 </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
@@ -230,6 +230,22 @@ color
 </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
@@ -306,7 +322,8 @@ markup
 <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
@@ -340,6 +357,8 @@ used to set the minimum width:</p></div>
  "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
@@ -376,7 +395,7 @@ x, y
 </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
@@ -387,6 +406,23 @@ button
         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
 </dl></div>\r
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
@@ -396,7 +432,11 @@ button
  "instance": "eth0",\r
  "button": 1,\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