]> git.sur5r.net Git - i3/i3.github.io/blobdiff - docs/i3bar-protocol.html
Merge pull request #61 from ketomi/master
[i3/i3.github.io] / docs / i3bar-protocol.html
index a9478fc3ac4fb4849c0ece3c2b5f98f0ce301200..ffdc1f71b7d99aa0908535f16bb0f38685f3d891 100644 (file)
@@ -4,7 +4,7 @@
 <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
@@ -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
@@ -172,7 +172,7 @@ cont_signal
 </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
@@ -197,7 +197,8 @@ full_text
 <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
@@ -322,7 +323,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
@@ -405,6 +407,32 @@ 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
+<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
@@ -413,8 +441,13 @@ button
  "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