X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fipc.html;h=1771a14660e37b92a924d4f8503fe96082c30cd7;hb=d5c09e7f9685ff3e10afb87d7f132105b2dc78ec;hp=91cb0b1780e8956f7481bf79f1a4328f4effe946;hpb=fc53ed8222ac81a61af347c790f19820eb98e9fc;p=i3%2Fi3.github.io diff --git a/docs/ipc.html b/docs/ipc.html index 91cb0b1..1771a14 100644 --- a/docs/ipc.html +++ b/docs/ipc.html @@ -31,7 +31,7 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a

IPC interface (interprocess communication)

Michael Stapelberg
<michael@i3wm.org>
-October 2012 +February 2014
Table of Contents
@@ -279,12 +279,13 @@ VERSION (7)

3.2. COMMAND reply

-

The reply consists of a single serialized map. At the moment, the only -property is success (bool), but this will be expanded in future versions.

+

The reply consists of a list of serialized maps for each command that was +parsed. Each has the property success (bool) and may also include a +human-readable error message in the property error (string).

Example:

-
{ "success": true }
+
[{ "success": true }]
@@ -422,12 +423,12 @@ active (boolean)

-current_workspace (integer) +current_workspace (string)

- The current workspace which is visible on this output. null if the - output is not active. + The name of the current workspace that is visible on this output. null if + the output is not active.

@@ -447,7 +448,7 @@ rect (map) { "name": "LVDS1", "active": true, - "current_workspace": 4, + "current_workspace": "4", "rect": { "x": 0, "y": 0, @@ -458,7 +459,7 @@ rect (map) { "name": "VGA1", "active": true, - "current_workspace": 1, + "current_workspace": "1", "rect": { "x": 1280, "y": 0, @@ -494,10 +495,21 @@ name (string) The internal name of this container. For all containers which are part of the tree structure down to the workspace contents, this is set to a nice human-readable name of the container. + For containers that have an X11 window, the content is the title + (_NET_WM_NAME property) of that window. For all other containers, the content is not defined (yet).

+type (string) +
+
+

+ Type of this container. Can be one of "root", "output", "con", + "floating_con", "workspace" or "dockarea". +

+
+
border (string)
@@ -1109,7 +1121,8 @@ window (3)

Sent when a client’s window is successfully reparented (that is when i3 - has finished fitting it into a container). + has finished fitting it into a container), when a window received input + focus or when certain properties of the window have changed.

@@ -1118,7 +1131,7 @@ barconfig_update (4)

Sent when the hidden_state or mode field in the barconfig of any bar - instance was updated. + instance was updated and when the config is reloaded.

@@ -1160,12 +1173,12 @@ but will still be present in the "old" property.

"change": "focus", "current": { "id": 28489712, - "type":4, + "type": "workspace", ... } "old": { "id": 28489715, - "type": 4, + "type": "workspace", ... } } @@ -1197,13 +1210,34 @@ mode is simply named default.

4.6. window event

This event consists of a single serialized map containing a property -change (string) which currently can indicate only that a new window -has been successfully reparented (the value will be "new").

+change (string) which indicates the type of the change

+

Additionally a container (object) field will be present, which consists -of the window’s parent container. Be aware that the container will hold -the initial name of the newly reparented window (e.g. if you run urxvt -with a shell that changes the title, you will still at this point get the -window title as "urxvt").

+of the window’s parent container. Be aware that for the "new" event, the +container will hold the initial name of the newly reparented window (e.g. +if you run urxvt with a shell that changes the title, you will still at +this point get the window title as "urxvt").

Example:

@@ -1211,7 +1245,7 @@ window title as "urxvt").

"change": "new", "container": { "id": 35569536, - "type": 2, + "type": "con", ... } } @@ -1220,20 +1254,8 @@ window title as "urxvt").

4.7. 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"
-}
-
+barconfig of the specified bar_id that were updated in i3. This event is the +same as a GET_BAR_CONFIG reply for the bar with the given id.

@@ -1250,53 +1272,25 @@ C

i3 includes a headerfile i3/ipc.h which provides you all constants. - However, there is no library yet.

-
-
-Ruby -
-
-

- http://github.com/badboy/i3-ipc -

-
-
-Perl -
-
-

- https://metacpan.org/module/AnyEvent::I3 -

-
-
-Python -
-
-
-
-
-Go -
-
-
+
+
+
        https://github.com/acrisci/i3ipc-glib
+Go::
+        * https://github.com/proxypoke/i3ipc
+JavaScript::
+        * https://github.com/acrisci/i3ipc-gjs
+Lua::
+        * https:/github.com/acrisci/i3ipc-lua
+Perl::
+        * https://metacpan.org/module/AnyEvent::I3
+Python::
+        * https://github.com/acrisci/i3ipc-python
+        * https://github.com/whitelynx/i3ipc (not maintained)
+        * https://github.com/ziberna/i3-py (not maintained)
+Ruby::
+        http://github.com/badboy/i3-ipc
+