]> git.sur5r.net Git - i3/i3.github.io/blobdiff - _docs/ipc
update docs/debugging from git
[i3/i3.github.io] / _docs / ipc
index 8cfb21d035659d2089a4c59a0a3809b205192c7f..85e5e77e3e7966122f2835c716ac31d07ee35aef 100644 (file)
--- a/_docs/ipc
+++ b/_docs/ipc
@@ -458,9 +458,8 @@ JSON dump:
 === MARKS reply
 
 The reply consists of a single array of strings for each container that has a
-mark. The order of that array is undefined. If more than one container has the
-same mark, it will be represented multiple times in the reply (the array
-contents are not unique).
+mark. A mark can only be set on one container, so the array is unique.
+The order of that array is undefined.
 
 If no window has a mark the response will be the empty array [].
 
@@ -495,6 +494,8 @@ font (string)::
        The font to use for text on the bar.
 workspace_buttons (boolean)::
        Display workspace buttons or not? Defaults to true.
+binding_mode_indicator (boolean)::
+       Display the mode indicator or not? Defaults to true.
 verbose (boolean)::
        Should the bar enable verbose output for debugging? Defaults to false.
 colors (map)::
@@ -540,6 +541,7 @@ urgent_workspace_text/urgent_workspace_bar::
  "status_command": "i3status",
  "font": "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1",
  "workspace_buttons": true,
+ "binding_mode_indicator": true,
  "verbose": false,
  "colors": {
    "background": "#c0c0c0",
@@ -626,6 +628,9 @@ mode (2)::
 window (3)::
        Sent when a client's window is successfully reparented (that is when i3
        has finished fitting it into a container).
+barconfig_update (4)::
+    Sent when the hidden_state or mode field in the barconfig of any bar
+    instance was updated.
 
 *Example:*
 --------------------------------------------------------------------
@@ -723,6 +728,24 @@ window title as "urxvt").
 }
 ---------------------------
 
+=== barconfig_update event
+
+This event consists of a single serialized map reporting on options from the
+barconfig of the specified bar_id that were updated in i3. The map always
+consists of a property +id (string)+, which specifies to which bar instance the
+sent config update belongs, a property +hidden_state (string)+, which indicates
+the hidden_state of an i3bar instance, and a property +mode (string)+, which
+corresponds to the current mode.
+
+*Example:*
+---------------------------
+{
+    "id": "bar-0",
+    "hidden_state": "hide"
+    "mode": "hide"
+}
+---------------------------
+
 == See also (existing libraries)
 
 [[libraries]]