]> git.sur5r.net Git - i3/i3.github.io/blobdiff - docs/i3bar-protocol.html
save docs for 4.14
[i3/i3.github.io] / docs / i3bar-protocol.html
index aee5f07f0d0c2ba1a8eea69c56241d129fc8e001..a9478fc3ac4fb4849c0ece3c2b5f98f0ce301200 100644 (file)
@@ -2,7 +2,7 @@
     "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
+<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
 <title>i3: i3bar input protocol</title>\r
@@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes();},
                         <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://www.reddit.com/r/i3wm/">FAQ</a></li>\r
                                 <li><a href="/contact">Contact</a></li>\r
-                                <li><a href="http://bugs.i3wm.org/">Bugs</a></li>\r
+                                <li><a href="https://github.com/i3/i3/issues">Bugs</a></li>\r
                         </ul>\r
         <br style="clear: both">\r
 <div id="content">\r
@@ -40,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
@@ -181,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
@@ -195,9 +196,8 @@ full_text
 </dt>\r
 <dd>\r
 <p>\r
-        The most simple block you can think of is one which just includes the\r
-        only required key, the <tt>full_text</tt> key. i3bar will display the string\r
-        value and that’s it.\r
+        The <tt>full_text</tt> will be displayed by i3bar on the status line. This is the\r
+        only required key.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\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
@@ -250,7 +266,7 @@ align
 </dt>\r
 <dd>\r
 <p>\r
-        Align text on the <tt>center</tt> (default), <tt>right</tt> or <tt>left</tt> of the block, when\r
+        Align text on the <tt>center</tt>, <tt>right</tt> or <tt>left</tt> (default) of the block, when\r
         the minimum width of the latter, specified by the <tt>min_width</tt> key, is not\r
         reached.\r
 </p>\r
@@ -299,6 +315,16 @@ separator_block_width
         is 9 pixels), since the separator line is drawn in the middle.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+markup\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
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p>If you want to put in your own entries into a block, prefix the key with an\r
 underscore (_). i3bar will ignore all keys it doesn’t understand, and prefixing\r
@@ -330,6 +356,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
@@ -366,7 +394,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