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"> - + - + i3: i3bar input protocol @@ -22,8 +22,9 @@ window.onload = 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.

@@ -103,7 +104,7 @@ consists of a single JSON hash:

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.)

@@ -144,7 +145,7 @@ i3status and others will output single statuslines in one line, separated by \n.

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

+https://github.com/i3/i3/blob/next/contrib/trivial-bar-script.sh

2.1. Header in detail

@@ -176,6 +177,15 @@ cont_signal The default value (if none is specified) is SIGCONT.

+
+click_events +
+
+

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

+
@@ -186,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.

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

+background +
+
+

+ Overrides the background color for this particular block. +

+
+
+border +
+
+

+ Overrides the border color for this particular block. +

+
+
min_width
@@ -241,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.

@@ -290,6 +315,17 @@ 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). 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:

"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, @@ -331,6 +369,77 @@ used to set the minimum width:

} +
+

2.3. Click events

+

If enabled i3bar will send you notifications if the user clicks on a block and +looks like this:

+
+
+name +
+
+

+ Name of the block, if set +

+
+
+instance +
+
+

+ Instance of the block, if set +

+
+
+x, y +
+
+

+ X11 root window coordinates where the click occurred +

+
+
+button +
+
+

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

+
+
+relative_x, relative_y +
+
+

+ Coordinates where the click occurred, with respect to the top left corner + of the block +

+
+
+width, height +
+
+

+ 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
+}
+
+