X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fi3bar-protocol.html;h=e84e177719130eb4e489f8f19376cb2d1b321b1e;hb=8924ec1339061840e02c918d36c86dd179a86aac;hp=222543fed00ba229db2d47c55d5e4b6ec50cbb46;hpb=032464499ebd3845d47ef437ccae5093e263af32;p=i3%2Fi3.github.io diff --git a/docs/i3bar-protocol.html b/docs/i3bar-protocol.html index 222543f..e84e177 100644 --- a/docs/i3bar-protocol.html +++ b/docs/i3bar-protocol.html @@ -2,15 +2,15 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
- + - +Before describing the protocol, letâs cover why JSON is a building block of this protocol.
All features example:
{ "version": 1, "stop_signal": 10, "cont_signal": 12 }+
{ "version": 1, "stop_signal": 10, "cont_signal": 12, "click_events": true }
(Note that before i3 v4.3 the precise format had to be {"version":1}, byte-for-byte.)
You can find an example of a shell script which can be used as your status_command in the bar configuration at -http://code.stapelberg.de/git/i3/tree/contrib/trivial-bar-script.sh?h=next
+ If specified and true i3bar will write an infinite array (same as above) + to your stdin. +
+- 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.
+ Overrides the background color for this particular block. +
++ Overrides the border color for this particular block. +
+- 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.
@@ -290,6 +315,17 @@ separator_block_width is 9 pixels), since the separator line is drawn in the middle.+ 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). Pango markup only works + if you use a pango font. +
+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 @@ -321,6 +357,8 @@ used to set the minimum width:
If enabled i3bar will send you notifications if the user clicks on a block and +looks like this:
+ Name of the block, if set +
++ Instance of the block, if set +
++ X11 root window coordinates where the click occurred +
++ X11 button ID (for example 1 to 3 for left/middle/right mouse button) +
++ Coordinates where the click occurred, with respect to the top left corner + of the block +
++ Width and height (in px) of the block +
+Example:
{ + "name": "ethernet", + "instance": "eth0", + "button": 1, + "x": 1320, + "y": 1400, + "relative_x": 12, + "relative_y": 8, + "width": 50, + "height": 22 +}+