X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fipc.html;h=9f55e32d4844e93f0de1785911d7dc45264d21c4;hb=4425ebb5f0ee2ec3bd1851052775226df8805dbc;hp=d10feef5146d97492b3293eba73cba6182158359;hpb=fdb8f31619e2335615f85f04a1b2b10dfb68f42b;p=i3%2Fi3.github.io diff --git a/docs/ipc.html b/docs/ipc.html index d10feef..9f55e32 100644 --- a/docs/ipc.html +++ b/docs/ipc.html @@ -2,15 +2,15 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: IPC interface (interprocess communication) @@ -22,16 +22,17 @@ window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}
@@ -88,7 +101,7 @@ COMMAND (0)

The payload of the message is a command for i3 (like the commands you can bind to keys in the configuration file) and will be executed - directly after receiving it. There is no reply to this message. + directly after receiving it.

@@ -148,6 +161,15 @@ GET_BAR_CONFIG (6) returned instead.

+
+GET_VERSION (7) +
+
+

+ Gets the version of i3. The reply will be a JSON-encoded dictionary + with the major, minor, patch and human-readable version. +

+

So, a typical message could look like this:

@@ -158,7 +180,7 @@ GET_BAR_CONFIG (6) 
00000000  69 33 2d 69 70 63 04 00  00 00 00 00 00 00 65 78  |i3-ipc........ex|
-00000010  69 74 0a                                          |it.|
+00000010 69 74 |it|

To generate and send such a message, you could use the following code in Perl:

@@ -199,7 +221,7 @@ COMMAND (0)

-GET_WORKSPACES (1) +WORKSPACES (1)

@@ -215,7 +237,7 @@ SUBSCRIBE (2)

-GET_OUTPUTS (3) +OUTPUTS (3)

@@ -223,7 +245,7 @@ GET_OUTPUTS (3)

-GET_TREE (4) +TREE (4)

@@ -231,7 +253,7 @@ GET_TREE (4)

-GET_MARKS (5) +MARKS (5)

@@ -239,27 +261,36 @@ GET_MARKS (5)

-GET_BAR_CONFIG (6) +BAR_CONFIG (6)

Reply to the GET_BAR_CONFIG message.

+
+VERSION (7) +
+
+

+ Reply to the GET_VERSION message. +

+

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

3.3. GET_WORKSPACES reply

+

3.3. WORKSPACES reply

The reply consists of a serialized list of workspaces. Each workspace has the following properties:

@@ -269,7 +300,7 @@ num (integer)

The logical number of the workspace. Corresponds to the command - to switch to this workspace. + to switch to this workspace. For named workspaces, this will be -1.

@@ -372,7 +403,7 @@ default) or whether a JSON parse error occurred.

-

3.5. GET_OUTPUTS reply

+

3.5. OUTPUTS reply

The reply consists of a serialized list of outputs. Each output has the following properties:

@@ -393,12 +424,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.

@@ -418,7 +449,7 @@ rect (map) { "name": "LVDS1", "active": true, - "current_workspace": 4, + "current_workspace": "4", "rect": { "x": 0, "y": 0, @@ -429,7 +460,7 @@ rect (map) { "name": "VGA1", "active": true, - "current_workspace": 1, + "current_workspace": "1", "rect": { "x": 1280, "y": 0, @@ -441,7 +472,7 @@ rect (map)
-

3.6. GET_TREE reply

+

3.6. TREE reply

The reply consists of a serialized tree. Each node in the tree (representing one container) has at least the properties listed below. While the nodes might have more properties, please do not use any properties which are not documented @@ -465,10 +496,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)
@@ -478,11 +520,20 @@ border (string)

+current_border_width (integer) +
+
+

+ Number of pixels of the border width. +

+
+
layout (string)

- Can be either "default", "stacked", "tabbed", "dockarea" or "output". + Can be either "splith", "splitv", "stacked", "tabbed", "dockarea" or + "output". Other values might be possible in the future, should we add new layouts.

@@ -494,6 +545,8 @@ orientation (string)

Can be either "none" (for non-split containers), "horizontal" or "vertical". + THIS FIELD IS OBSOLETE. It is still present, but your code should not + use it. Instead, rely on the layout field.

@@ -532,6 +585,16 @@ window_rect (map)

+deco_rect (map) +
+
+

+ The coordinates of the window decoration inside its container. These + coordinates are relative to the container and do not include the actual + client window. +

+
+
geometry (map)
@@ -541,6 +604,17 @@ geometry (map)

+window (integer) +
+
+

+ The X11 window ID of the actual client window inside this container. + This field is set to null for split containers or otherwise empty + containers. This ID corresponds to what xwininfo(1) and other + X11-related tools display (usually in hex). +

+
+
urgent (bool)
@@ -736,15 +810,14 @@ VGA1
-

3.7. GET_MARKS reply

+

3.7. 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 [].

-

3.8. GET_BAR_CONFIG reply

+

3.8. BAR_CONFIG reply

This can be used by third-party workspace bars (especially i3bar, but others are free to implement compatible alternatives) to get the bar block configuration from i3.

@@ -822,6 +895,14 @@ workspace_buttons (boolean)

+binding_mode_indicator (boolean) +
+
+

+ Display the mode indicator or not? Defaults to true. +

+
+
verbose (boolean)
@@ -858,44 +939,86 @@ statusline

-focused_workspace_text/focused_workspace_bg +separator

- Text color/background color for a workspace button when the workspace + Text color to be used for the separator. +

+
+
+focused_background +
+
+

+ Background color of the bar on the currently focused monitor output. +

+
+
+focused_statusline +
+
+

+ Text color to be used for the statusline on the currently focused + monitor output. +

+
+
+focused_separator +
+
+

+ Text color to be used for the separator on the currently focused + monitor output. +

+
+
+focused_workspace_text/focused_workspace_bg/focused_workspace_border +
+
+

+ Text/background/border color for a workspace button when the workspace has focus.

-active_workspace_text/active_workspace_bg +active_workspace_text/active_workspace_bg/active_workspace_border

- Text color/background color for a workspace button when the workspace + Text/background/border color for a workspace button when the workspace is active (visible) on some output, but the focus is on another one. You can only tell this apart from the focused workspace when you are using multiple monitors.

-inactive_workspace_text/inactive_workspace_bg +inactive_workspace_text/inactive_workspace_bg/inactive_workspace_border

- Text color/background color for a workspace button when the workspace + Text/background/border color for a workspace button when the workspace does not have focus and is not active (visible) on any output. This will be the case for most workspaces.

-urgent_workspace_text/urgent_workspace_bar +urgent_workspace_text/urgent_workspace_bg/urgent_workspace_border

- Text color/background color for workspaces which contain at least one + Text/background/border color for workspaces which contain at least one window with the urgency hint set.

+
+binding_mode_text/binding_mode_bg/binding_mode_border +
+
+

+ Text/background/border color for the binding mode indicator. +

+

Example of configured bars:

@@ -912,6 +1035,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", @@ -922,6 +1046,69 @@ urgent_workspace_text/urgent_workspace_bar }
+
+

3.9. VERSION reply

+

The reply consists of a single JSON dictionary with the following keys:

+
+
+major (integer) +
+
+

+ The major version of i3, such as 4. +

+
+
+minor (integer) +
+
+

+ The minor version of i3, such as 2. Changes in the IPC interface (new + features) will only occur with new minor (or major) releases. However, + bugfixes might be introduced in patch releases, too. +

+
+
+patch (integer) +
+
+

+ The patch version of i3, such as 1 (when the complete version is + 4.2.1). For versions such as 4.2, patch will be set to 0. +

+
+
+human_readable (string) +
+
+

+ A human-readable version of i3 containing the precise git version, + build date and branch name. When you need to display the i3 version to + your users, use the human-readable version whenever possible (since + this is what i3 --version displays, too). +

+
+
+loaded_config_file_name (string) +
+
+

+ The current config path. +

+
+
+

Example:

+
+
+
{
+   "human_readable" : "4.2-169-gf80b877 (2012-08-05, branch \"next\")",
+   "loaded_config_file_name" : "/home/hwangcc23/.i3/config",
+   "minor" : 2,
+   "patch" : 0,
+   "major" : 4
+}
+
+
@@ -947,7 +1134,7 @@ you can register to an event.

type: SUBSCRIBE
-payload: [ "workspace", "focus" ]
+payload: [ "workspace", "output" ]
@@ -974,6 +1161,42 @@ output (1) outputs, CRTCs or output properties).

+
+mode (2) +
+
+

+ Sent whenever i3 changes its binding mode. +

+
+
+window (3) +
+
+

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

+
+
+barconfig_update (4) +
+
+

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

+
+
+binding (5) +
+
+

+ Sent when a configured command binding is triggered with the keyboard or + mouse +

+

Example:

@@ -998,11 +1221,31 @@ if ($is_event) {

4.3. workspace event

This event consists of a single serialized map containing a property change (string) which indicates the type of the change ("focus", "init", -"empty", "urgent").

+"empty", "urgent"). A current (object) property will be present with the +affected workspace whenever the type of event affects a workspace (otherwise, +it will be +null).

+

When the change is "focus", an old (object) property will be present with the +previous workspace. When the first switch occurs (when i3 focuses the +workspace visible at the beginning) there is no previous workspace, and the +old property will be set to null. Also note that if the previous is empty +it will get destroyed when switching, but will still be present in the "old" +property.

Example:

-
{ "change": "focus" }
+
{
+ "change": "focus",
+ "current": {
+  "id": 28489712,
+  "type": "workspace",
+  ...
+ }
+ "old": {
+  "id": 28489715,
+  "type": "workspace",
+  ...
+ }
+}
@@ -1016,12 +1259,169 @@ if ($is_event) { 
{ "change": "unspecified" }
+
+

4.5. mode event

+

This event consists of a single serialized map containing a property +change (string) which holds the name of current mode in use. The name +is the same as specified in config when creating a mode. The default +mode is simply named default. It contains a second property, pango_markup, which +defines whether pango markup shall be used for displaying this mode.

+

Example:

+
+
+
{
+  "change": "default",
+  "pango_markup": true
+}
+
+
+
+

4.6. window event

+

This event consists of a single serialized map containing a property +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 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:

+
+
+
{
+ "change": "new",
+ "container": {
+  "id": 35569536,
+  "type": "con",
+  ...
+ }
+}
+
+
+
+

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. This event is the +same as a GET_BAR_CONFIG reply for the bar with the given id.

+
+
+

4.8. binding event

+

This event consists of a single serialized map reporting on the details of a +binding that ran a command because of user input. The change (sring) field +indicates what sort of binding event was triggered (right now it will always be +"run" but may be expanded in the future).

+

The binding (object) field contains details about the binding that was run:

+
+
+command (string) +
+
+

+ The i3 command that is configured to run for this binding. +

+
+
+event_state_mask (array of strings) +
+
+

+ The group and modifier keys that were configured with this binding. +

+
+
+input_code (integer) +
+
+

+ If the binding was configured with bindcode, this will be the key code + that was given for the binding. If the binding is a mouse binding, it will be + the number of the mouse button that was pressed. Otherwise it will be 0. +

+
+
+symbol (string or null) +
+
+

+ If this is a keyboard binding that was configured with bindsym, this + field will contain the given symbol. Otherwise it will be null. +

+
+
+input_type (string) +
+
+

+ This will be "keyboard" or "mouse" depending on whether or not this was + a keyboard or a mouse binding. +

+
+
+

Example:

+
+
+
{
+ "change": "run",
+ "binding": {
+  "command": "nop",
+  "event_state_mask": [
+    "shift",
+    "ctrl"
+  ],
+  "input_code": 0,
+  "symbol": "t",
+  "input_type": "keyboard"
+ }
+}
+
+
-

5. See also

+

5. See also (existing libraries)

-

For some languages, libraries are available (so you don’t have to implement +

For some languages, libraries are available (so you don’t have to implement all this on your own). This list names some (if you wrote one, please let me know):

@@ -1029,34 +1429,129 @@ know):

C
+
    +

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

    +
    • +
  • +

    +https://github.com/acrisci/i3ipc-glib +

    +
    • +
-Ruby +C++
+
+
+
+Go +
+
+
+
+
+JavaScript +
+
+
+
+
+Lua +
+
+
Perl
+
Python
+
+
+
+Ruby +
+
+
+
+
+Rust +
+
+