X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fi3bar-protocol.html;h=a9478fc3ac4fb4849c0ece3c2b5f98f0ce301200;hb=de1d38fe580f40e073beb2500bafaf128575612a;hp=679093e0c73d6cdc56c2d6b2fa72db5be83b365a;hpb=fc53ed8222ac81a61af347c790f19820eb98e9fc;p=i3%2Fi3.github.io diff --git a/docs/i3bar-protocol.html b/docs/i3bar-protocol.html index 679093e..a9478fc 100644 --- a/docs/i3bar-protocol.html +++ b/docs/i3bar-protocol.html @@ -2,7 +2,7 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + i3: i3bar input protocol @@ -22,8 +22,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes();},
@@ -40,7 +41,7 @@ provides support for colors, urgency, shortening and easy manipulation.

-

1. Rationale for chosing JSON

+

1. Rationale for choosing JSON

Before describing the protocol, let’s cover why JSON is a building block of this protocol.

@@ -181,7 +182,7 @@ click_events

- If specified and true i3bar will write a infinite array (same as above) + If specified and true i3bar will write an infinite array (same as above) to your stdin.

@@ -195,9 +196,8 @@ full_text

- The most simple block you can think of is one which just includes the - only required key, the full_text key. i3bar will display the string - value and that’s it. + The full_text will be displayed by i3bar on the status line. This is the + only required key.

@@ -230,6 +230,22 @@ color

+background +
+
+

+ Overrides the background color for this particular block. +

+
+
+border +
+
+

+ Overrides the border color for this particular block. +

+
+
min_width
@@ -250,7 +266,7 @@ align

- Align text on the center (default), right or left of the block, when + Align text on the center, right or left (default) of the block, when the minimum width of the latter, specified by the min_width key, is not reached.

@@ -299,6 +315,16 @@ separator_block_width is 9 pixels), since the separator line is drawn in the middle.

+
+markup +
+
+

+ A string that indicates how the text of the block should be parsed. Set to + "pango" to use Pango markup. + Set to "none" to not use any markup (default). +

+

If you want to put in your own entries into a block, prefix the key with an underscore (_). i3bar will ignore all keys it doesn’t understand, and prefixing @@ -330,6 +356,8 @@ used to set the minimum width:

"full_text": "E: 10.0.0.1 (1000 Mbit/s)", "short_text": "10.0.0.1", "color": "#00ff00", + "background": "#1c1c1c", + "border": "#ee0000", "min_width": 300, "align": "right", "urgent": false, @@ -366,8 +394,14 @@ x, y

- X11 root window coordinates where the click occured -button: + X11 root window coordinates where the click occurred +

+
+
+button +
+
+

X11 button ID (for example 1 to 3 for left/middle/right mouse button)