update docs for 4.13

[i3/i3.github.io] / _docs / i3bar-protocol

diff --git a/_docs/i3bar-protocol b/_docs/i3bar-protocol
index 927631549fe9969622824b53c4435e6af08b77c1..ebd3b83a231741f998d63cab2dad49b44f605d30 100644 (file)
--- a/_docs/i3bar-protocol
+++ b/_docs/i3bar-protocol
@@ -6,7 +6,7 @@ August 2012
 This document explains the protocol in which i3bar expects its input. It
 provides support for colors, urgency, shortening and easy manipulation.
 
 This document explains the protocol in which i3bar expects its input. It
 provides support for colors, urgency, shortening and easy manipulation.
 

-== Rationale for chosing JSON
+== Rationale for choosing JSON

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


@@ -111,15 +111,14 @@ cont_signal::
        processing.
        The default value (if none is specified) is SIGCONT.
 click_events::
        processing.
        The default value (if none is specified) is SIGCONT.
 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.
 
 === Blocks in detail
 
 full_text::
        to your stdin.
 
 === Blocks in detail
 
 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.

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


@@ -137,6 +136,10 @@ color::
        when it is associated.
        Colors are specified in hex (like in HTML), starting with a leading
        hash sign. For example, +#ff0000+ means red.
        when it is associated.
        Colors are specified in hex (like in HTML), starting with a leading
        hash sign. For example, +#ff0000+ means red.

+background::
+       Overrides the background color for this particular block.
+border::
+       Overrides the border color for this particular block.

 min_width::
        The minimum width (in pixels) of the block. If the content of the
        +full_text+ key take less space than the specified min_width, the block
 min_width::
        The minimum width (in pixels) of the block. If the content of the
        +full_text+ key take less space than the specified min_width, the block


@@ -148,7 +151,7 @@ min_width::
         when you want to set a sensible minimum width regardless of which font you
         are using, and at what particular size.
 align::
         when you want to set a sensible minimum width regardless of which font you
         are using, and at what particular size.
 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.
 name and instance::
        the minimum width of the latter, specified by the +min_width+ key, is not
        reached.
 name and instance::


@@ -171,6 +174,10 @@ separator_block_width::
        this gap, a separator line will be drawn unless +separator+ is
        disabled. Normally, you want to set this to an odd value (the default
        is 9 pixels), since the separator line is drawn in the middle.
        this gap, a separator line will be drawn unless +separator+ is
        disabled. Normally, you want to set this to an odd value (the default
        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 https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[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
 
 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


@@ -204,6 +211,8 @@ An example of a block which uses all possible entries follows:
  "full_text": "E: 10.0.0.1 (1000 Mbit/s)",
  "short_text": "10.0.0.1",
  "color": "#00ff00",
  "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,
  "min_width": 300,
  "align": "right",
  "urgent": false,


@@ -224,7 +233,7 @@ name::
 instance::
        Instance of the block, if set
 x, y::
 instance::
        Instance of the block, if set
 x, y::

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

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