Add "modifiers" to events sent by i3bar

[i3/i3] / docs / i3bar-protocol

diff --git a/docs/i3bar-protocol b/docs/i3bar-protocol
index ebd3b83a231741f998d63cab2dad49b44f605d30..826cae53f018bcc21abfa34a1457de07552bf9bd 100644 (file)
--- a/docs/i3bar-protocol
+++ b/docs/i3bar-protocol
@@ -96,7 +96,7 @@ i3status and others will output single statuslines in one line, separated by
 
 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
 
 === Header in detail
 
@@ -107,7 +107,7 @@ stop_signal::
        processing.
        The default value (if none is specified) is SIGSTOP.
 cont_signal::
-       Specify to i3bar the signal (as an integer)to send to continue your
+       Specify to i3bar the signal (as an integer) to send to continue your
        processing.
        The default value (if none is specified) is SIGCONT.
 click_events::
@@ -118,7 +118,8 @@ click_events::
 
 full_text::
        The +full_text+ will be displayed by i3bar on the status line. This is the
-       only required key.
+       only required key. If +full_text+ is an empty string, the block will be
+       skipped.
 short_text::
        Where appropriate, the +short_text+ (string) entry should also be
        provided. It will be used in case the status line needs to be shortened
@@ -177,7 +178,8 @@ separator_block_width::
 markup::
        A string that indicates how the text of the block should be parsed. Set to
        +"pango"+ to use https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup].
-       Set to +"none"+ to not use any markup (default).
+       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
@@ -236,6 +238,14 @@ 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
+modifiers::
+    An array of the modifiers active when the click occurred. The order in which
+    modifiers are listed is not guaranteed.
 
 *Example*:
 ------------------------------------------
@@ -243,7 +253,12 @@ button::
  "name": "ethernet",
  "instance": "eth0",
  "button": 1,
+ "modifiers": ["Shift", "Mod1"],
  "x": 1320,
- "y": 1400
+ "y": 1400,
+ "relative_x": 12,
+ "relative_y": 8,
+ "width": 50,
+ "height": 22
 }
 ------------------------------------------