1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
\r
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
\r
5 <link rel="icon" type="image/x-icon" href="/favicon.ico">
\r
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
\r
7 <meta name="generator" content="AsciiDoc 8.6.9" />
\r
8 <title>i3: IPC interface (interprocess communication)</title>
\r
9 <link rel="stylesheet" href="/css/style.css" type="text/css" />
\r
10 <link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />
\r
11 <script type="text/javascript">
\r
13 document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); asciidoc.toc(2);}, false);
\r
16 <script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>
\r
18 <body class="article">
\r
21 <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>
\r
23 <li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>
\r
24 <li><a href="/screenshots">Screens</a></li>
\r
25 <li><a href="https://faq.i3wm.org/">FAQ</a></li>
\r
26 <li><a href="/contact">Contact</a></li>
\r
27 <li><a href="https://github.com/i3/i3/issues">Bugs</a></li>
\r
29 <br style="clear: both">
\r
32 <h1>IPC interface (interprocess communication)</h1>
\r
33 <span id="author">Michael Stapelberg</span><br />
\r
34 <span id="email"><tt><<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>></tt></span><br />
\r
35 <span id="revdate">October 2014</span>
\r
37 <div id="toctitle">Table of Contents</div>
38 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
42 <div class="sectionbody">
\r
43 <div class="paragraph"><p>This document describes how to interface with i3 from a separate process. This
\r
44 is useful for example to remote-control i3 (to write test cases for example) or
\r
45 to get various information like the current workspaces to implement an external
\r
46 workspace bar.</p></div>
\r
47 <div class="paragraph"><p>The method of choice for IPC in our case is a unix socket because it has very
\r
48 little overhead on both sides and is usually available without headaches in
\r
49 most languages. In the default configuration file, the ipc-socket gets created
\r
50 in <tt>/tmp/i3-%u.XXXXXX/ipc-socket.%p</tt> where <tt>%u</tt> is your UNIX username, <tt>%p</tt> is
\r
51 the PID of i3 and XXXXXX is a string of random characters from the portable
\r
52 filename character set (see mkdtemp(3)). You can get the socketpath from i3 by
\r
53 calling <tt>i3 --get-socketpath</tt>.</p></div>
\r
54 <div class="paragraph"><p>All i3 utilities, like <tt>i3-msg</tt> and <tt>i3-input</tt> will read the <tt>I3_SOCKET_PATH</tt>
\r
55 X11 property, stored on the X11 root window.</p></div>
\r
56 <div class="admonitionblock">
\r
59 <div class="title">Warning</div>
\r
61 <td class="content">
\r
62 <div class="title">Use an existing library!</div>There are existing libraries for many languages. You can have a look at
\r
63 <a href="#libraries">[libraries]</a> or search the web if your language of choice is not mentioned.
\r
64 Usually, it is not necessary to implement low-level communication with i3
\r
71 <h2 id="_establishing_a_connection">1. Establishing a connection</h2>
\r
72 <div class="sectionbody">
\r
73 <div class="paragraph"><p>To establish a connection, simply open the IPC socket. The following code
\r
74 snippet illustrates this in Perl:</p></div>
\r
75 <div class="listingblock">
\r
76 <div class="content">
\r
77 <pre><tt>use IO::Socket::UNIX;
\r
78 chomp(my $path = qx(i3 --get-socketpath));
\r
79 my $sock = IO::Socket::UNIX->new(Peer => $path);</tt></pre>
\r
84 <h2 id="_sending_messages_to_i3">2. Sending messages to i3</h2>
\r
85 <div class="sectionbody">
\r
86 <div class="paragraph"><p>To send a message to i3, you have to format in the binary message format which
\r
87 i3 expects. This format specifies a magic string in the beginning to ensure
\r
88 the integrity of messages (to prevent follow-up errors). Following the magic
\r
89 string comes the length of the payload of the message as 32-bit integer, and
\r
90 the type of the message as 32-bit integer (the integers are not converted, so
\r
91 they are in native byte order).</p></div>
\r
92 <div class="paragraph"><p>The magic string currently is "i3-ipc" and will only be changed when a change
\r
93 in the IPC API is done which breaks compatibility (we hope that we don’t need
\r
94 to do that).</p></div>
\r
95 <div class="paragraph"><p>Currently implemented message types are the following:</p></div>
\r
96 <div class="dlist"><dl>
\r
97 <dt class="hdlist1">
\r
102 The payload of the message is a command for i3 (like the commands you
\r
103 can bind to keys in the configuration file) and will be executed
\r
104 directly after receiving it.
\r
107 <dt class="hdlist1">
\r
112 Gets the current workspaces. The reply will be a JSON-encoded list of
\r
113 workspaces (see the reply section).
\r
116 <dt class="hdlist1">
\r
121 Subscribes your connection to certain events. See <a href="#events">[events]</a> for a
\r
122 description of this message and the concept of events.
\r
125 <dt class="hdlist1">
\r
130 Gets the current outputs. The reply will be a JSON-encoded list of outputs
\r
131 (see the reply section).
\r
134 <dt class="hdlist1">
\r
139 Gets the layout tree. i3 uses a tree as data structure which includes
\r
140 every container. The reply will be the JSON-encoded tree (see the reply
\r
144 <dt class="hdlist1">
\r
149 Gets a list of marks (identifiers for containers to easily jump to them
\r
150 later). The reply will be a JSON-encoded list of window marks (see
\r
154 <dt class="hdlist1">
\r
159 Gets the configuration (as JSON map) of the workspace bar with the
\r
160 given ID. If no ID is provided, an array with all configured bar IDs is
\r
164 <dt class="hdlist1">
\r
169 Gets the version of i3. The reply will be a JSON-encoded dictionary
\r
170 with the major, minor, patch and human-readable version.
\r
174 <div class="paragraph"><p>So, a typical message could look like this:</p></div>
\r
175 <div class="listingblock">
\r
176 <div class="content">
\r
177 <pre><tt>"i3-ipc" <message length> <message type> <payload></tt></pre>
\r
179 <div class="paragraph"><p>Or, as a hexdump:</p></div>
\r
180 <div class="listingblock">
\r
181 <div class="content">
\r
182 <pre><tt>00000000 69 33 2d 69 70 63 04 00 00 00 00 00 00 00 65 78 |i3-ipc........ex|
\r
183 00000010 69 74 |it|</tt></pre>
\r
185 <div class="paragraph"><p>To generate and send such a message, you could use the following code in Perl:</p></div>
\r
186 <div class="listingblock">
\r
187 <div class="content">
\r
188 <pre><tt>sub format_ipc_command {
\r
191 # Get the real byte count (vs. amount of characters)
\r
192 { use bytes; $len = length($msg); }
\r
193 return "i3-ipc" . pack("LL", $len, 0) . $msg;
\r
196 $sock->write(format_ipc_command("exit"));</tt></pre>
\r
200 <div class="sect1">
\r
201 <h2 id="_receiving_replies_from_i3">3. Receiving replies from i3</h2>
\r
202 <div class="sectionbody">
\r
203 <div class="paragraph"><p>Replies from i3 usually consist of a simple string (the length of the string
\r
204 is the message_length, so you can consider them length-prefixed) which in turn
\r
205 contain the JSON serialization of a data structure. For example, the
\r
206 GET_WORKSPACES message returns an array of workspaces (each workspace is a map
\r
207 with certain attributes).</p></div>
\r
208 <div class="sect2">
\r
209 <h3 id="_reply_format">3.1. Reply format</h3>
\r
210 <div class="paragraph"><p>The reply format is identical to the normal message format. There also is
\r
211 the magic string, then the message length, then the message type and the
\r
213 <div class="paragraph"><p>The following reply types are implemented:</p></div>
\r
214 <div class="dlist"><dl>
\r
215 <dt class="hdlist1">
\r
220 Confirmation/Error code for the COMMAND message.
\r
223 <dt class="hdlist1">
\r
228 Reply to the GET_WORKSPACES message.
\r
231 <dt class="hdlist1">
\r
236 Confirmation/Error code for the SUBSCRIBE message.
\r
239 <dt class="hdlist1">
\r
244 Reply to the GET_OUTPUTS message.
\r
247 <dt class="hdlist1">
\r
252 Reply to the GET_TREE message.
\r
255 <dt class="hdlist1">
\r
260 Reply to the GET_MARKS message.
\r
263 <dt class="hdlist1">
\r
268 Reply to the GET_BAR_CONFIG message.
\r
271 <dt class="hdlist1">
\r
276 Reply to the GET_VERSION message.
\r
281 <div class="sect2">
\r
282 <h3 id="_command_reply">3.2. COMMAND reply</h3>
\r
283 <div class="paragraph"><p>The reply consists of a list of serialized maps for each command that was
\r
284 parsed. Each has the property <tt>success (bool)</tt> and may also include a
\r
285 human-readable error message in the property <tt>error (string)</tt>.</p></div>
\r
286 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
287 <div class="listingblock">
\r
288 <div class="content">
\r
289 <pre><tt>[{ "success": true }]</tt></pre>
\r
292 <div class="sect2">
\r
293 <h3 id="_workspaces_reply">3.3. WORKSPACES reply</h3>
\r
294 <div class="paragraph"><p>The reply consists of a serialized list of workspaces. Each workspace has the
\r
295 following properties:</p></div>
\r
296 <div class="dlist"><dl>
\r
297 <dt class="hdlist1">
\r
302 The logical number of the workspace. Corresponds to the command
\r
303 to switch to this workspace. For named workspaces, this will be -1.
\r
306 <dt class="hdlist1">
\r
311 The name of this workspace (by default num+1), as changed by the
\r
312 user. Encoded in UTF-8.
\r
315 <dt class="hdlist1">
\r
320 Whether this workspace is currently visible on an output (multiple
\r
321 workspaces can be visible at the same time).
\r
324 <dt class="hdlist1">
\r
329 Whether this workspace currently has the focus (only one workspace
\r
330 can have the focus at the same time).
\r
333 <dt class="hdlist1">
\r
338 Whether a window on this workspace has the "urgent" flag set.
\r
341 <dt class="hdlist1">
\r
346 The rectangle of this workspace (equals the rect of the output it
\r
347 is on), consists of x, y, width, height.
\r
350 <dt class="hdlist1">
\r
355 The video output this workspace is on (LVDS1, VGA1, …).
\r
359 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
360 <div class="listingblock">
\r
361 <div class="content">
\r
394 <div class="sect2">
\r
395 <h3 id="_subscribe_reply">3.4. SUBSCRIBE reply</h3>
\r
396 <div class="paragraph"><p>The reply consists of a single serialized map. The only property is
\r
397 <tt>success (bool)</tt>, indicating whether the subscription was successful (the
\r
398 default) or whether a JSON parse error occurred.</p></div>
\r
399 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
400 <div class="listingblock">
\r
401 <div class="content">
\r
402 <pre><tt>{ "success": true }</tt></pre>
\r
405 <div class="sect2">
\r
406 <h3 id="_outputs_reply">3.5. OUTPUTS reply</h3>
\r
407 <div class="paragraph"><p>The reply consists of a serialized list of outputs. Each output has the
\r
408 following properties:</p></div>
\r
409 <div class="dlist"><dl>
\r
410 <dt class="hdlist1">
\r
415 The name of this output (as seen in <tt>xrandr(1)</tt>). Encoded in UTF-8.
\r
418 <dt class="hdlist1">
\r
423 Whether this output is currently active (has a valid mode).
\r
426 <dt class="hdlist1">
\r
427 current_workspace (string)
\r
431 The name of the current workspace that is visible on this output. <tt>null</tt> if
\r
432 the output is not active.
\r
435 <dt class="hdlist1">
\r
440 The rectangle of this output (equals the rect of the output it
\r
441 is on), consists of x, y, width, height.
\r
445 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
446 <div class="listingblock">
\r
447 <div class="content">
\r
452 "current_workspace": "4",
\r
463 "current_workspace": "1",
\r
474 <div class="sect2">
\r
475 <h3 id="_tree_reply">3.6. TREE reply</h3>
\r
476 <div class="paragraph"><p>The reply consists of a serialized tree. Each node in the tree (representing
\r
477 one container) has at least the properties listed below. While the nodes might
\r
478 have more properties, please do not use any properties which are not documented
\r
479 here. They are not yet finalized and will probably change!</p></div>
\r
480 <div class="dlist"><dl>
\r
481 <dt class="hdlist1">
\r
486 The internal ID (actually a C pointer value) of this container. Do not
\r
487 make any assumptions about it. You can use it to (re-)identify and
\r
488 address containers when talking to i3.
\r
491 <dt class="hdlist1">
\r
496 The internal name of this container. For all containers which are part
\r
497 of the tree structure down to the workspace contents, this is set to a
\r
498 nice human-readable name of the container.
\r
499 For containers that have an X11 window, the content is the title
\r
500 (_NET_WM_NAME property) of that window.
\r
501 For all other containers, the content is not defined (yet).
\r
504 <dt class="hdlist1">
\r
509 Type of this container. Can be one of "root", "output", "con",
\r
510 "floating_con", "workspace" or "dockarea".
\r
513 <dt class="hdlist1">
\r
518 Can be either "normal", "none" or "1pixel", dependending on the
\r
519 container’s border style.
\r
522 <dt class="hdlist1">
\r
523 current_border_width (integer)
\r
527 Number of pixels of the border width.
\r
530 <dt class="hdlist1">
\r
535 Can be either "splith", "splitv", "stacked", "tabbed", "dockarea" or
\r
537 Other values might be possible in the future, should we add new
\r
541 <dt class="hdlist1">
\r
542 orientation (string)
\r
546 Can be either "none" (for non-split containers), "horizontal" or
\r
548 THIS FIELD IS OBSOLETE. It is still present, but your code should not
\r
549 use it. Instead, rely on the layout field.
\r
552 <dt class="hdlist1">
\r
557 The percentage which this container takes in its parent. A value of
\r
558 <tt>null</tt> means that the percent property does not make sense for this
\r
559 container, for example for the root container.
\r
562 <dt class="hdlist1">
\r
567 The absolute display coordinates for this container. Display
\r
568 coordinates means that when you have two 1600x1200 monitors on a single
\r
569 X11 Display (the standard way), the coordinates of the first window on
\r
570 the second monitor are <tt>{ "x": 1600, "y": 0, "width": 1600, "height":
\r
574 <dt class="hdlist1">
\r
579 The coordinates of the <strong>actual client window</strong> inside its container.
\r
580 These coordinates are relative to the container and do not include the
\r
581 window decoration (which is actually rendered on the parent container).
\r
582 So, when using the <tt>default</tt> layout, you will have a 2 pixel border on
\r
583 each side, making the window_rect <tt>{ "x": 2, "y": 0, "width": 632,
\r
584 "height": 366 }</tt> (for example).
\r
587 <dt class="hdlist1">
\r
592 The coordinates of the <strong>window decoration</strong> inside its container. These
\r
593 coordinates are relative to the container and do not include the actual
\r
597 <dt class="hdlist1">
\r
602 The original geometry the window specified when i3 mapped it. Used when
\r
603 switching a window to floating mode, for example.
\r
606 <dt class="hdlist1">
\r
611 The X11 window ID of the <strong>actual client window</strong> inside this container.
\r
612 This field is set to null for split containers or otherwise empty
\r
613 containers. This ID corresponds to what xwininfo(1) and other
\r
614 X11-related tools display (usually in hex).
\r
617 <dt class="hdlist1">
\r
622 Whether this container (window or workspace) has the urgency hint set.
\r
625 <dt class="hdlist1">
\r
630 Whether this container is currently focused.
\r
634 <div class="paragraph"><p>Please note that in the following example, I have left out some keys/values
\r
635 which are not relevant for the type of the node. Otherwise, the example would
\r
636 be by far too long (it already is quite long, despite showing only 1 window and
\r
637 one dock window).</p></div>
\r
638 <div class="paragraph"><p>It is useful to have an overview of the structure before taking a look at the
\r
639 JSON dump:</p></div>
\r
640 <div class="ulist"><ul>
\r
645 <div class="ulist"><ul>
\r
650 <div class="ulist"><ul>
\r
660 <div class="ulist"><ul>
\r
665 <div class="ulist"><ul>
\r
679 <div class="ulist"><ul>
\r
697 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
698 <div class="listingblock">
\r
699 <div class="content">
\r
714 "layout": "output",
\r
726 "layout": "dockarea",
\r
727 "orientation": "vertical",
\r
750 "orientation": "horizontal",
\r
757 "floating_nodes": [],
\r
763 "border": "normal",
\r
781 "name": "bottomdock",
\r
782 "layout": "dockarea",
\r
783 "orientation": "vertical",
\r
812 <div class="sect2">
\r
813 <h3 id="_marks_reply">3.7. MARKS reply</h3>
\r
814 <div class="paragraph"><p>The reply consists of a single array of strings for each container that has a
\r
815 mark. A mark can only be set on one container, so the array is unique.
\r
816 The order of that array is undefined.</p></div>
\r
817 <div class="paragraph"><p>If no window has a mark the response will be the empty array [].</p></div>
\r
819 <div class="sect2">
\r
820 <h3 id="_bar_config_reply">3.8. BAR_CONFIG reply</h3>
\r
821 <div class="paragraph"><p>This can be used by third-party workspace bars (especially i3bar, but others
\r
822 are free to implement compatible alternatives) to get the <tt>bar</tt> block
\r
823 configuration from i3.</p></div>
\r
824 <div class="paragraph"><p>Depending on the input, the reply is either:</p></div>
\r
825 <div class="dlist"><dl>
\r
826 <dt class="hdlist1">
\r
831 An array of configured bar IDs
\r
834 <dt class="hdlist1">
\r
839 A JSON map containing the configuration for the specified bar.
\r
843 <div class="paragraph"><p>Each bar configuration has the following properties:</p></div>
\r
844 <div class="dlist"><dl>
\r
845 <dt class="hdlist1">
\r
850 The ID for this bar. Included in case you request multiple
\r
851 configurations and want to differentiate the different replies.
\r
854 <dt class="hdlist1">
\r
859 Either <tt>dock</tt> (the bar sets the dock window type) or <tt>hide</tt> (the bar
\r
860 does not show unless a specific key is pressed).
\r
863 <dt class="hdlist1">
\r
868 Either <tt>bottom</tt> or <tt>top</tt> at the moment.
\r
871 <dt class="hdlist1">
\r
872 status_command (string)
\r
876 Command which will be run to generate a statusline. Each line on stdout
\r
877 of this command will be displayed in the bar. At the moment, no
\r
878 formatting is supported.
\r
881 <dt class="hdlist1">
\r
886 The font to use for text on the bar.
\r
889 <dt class="hdlist1">
\r
890 workspace_buttons (boolean)
\r
894 Display workspace buttons or not? Defaults to true.
\r
897 <dt class="hdlist1">
\r
898 binding_mode_indicator (boolean)
\r
902 Display the mode indicator or not? Defaults to true.
\r
905 <dt class="hdlist1">
\r
910 Should the bar enable verbose output for debugging? Defaults to false.
\r
913 <dt class="hdlist1">
\r
918 Contains key/value pairs of colors. Each value is a color code in hex,
\r
919 formatted #rrggbb (like in HTML).
\r
923 <div class="paragraph"><p>The following colors can be configured at the moment:</p></div>
\r
924 <div class="dlist"><dl>
\r
925 <dt class="hdlist1">
\r
930 Background color of the bar.
\r
933 <dt class="hdlist1">
\r
938 Text color to be used for the statusline.
\r
941 <dt class="hdlist1">
\r
946 Text color to be used for the separator.
\r
949 <dt class="hdlist1">
\r
950 focused_workspace_text/focused_workspace_bg
\r
954 Text color/background color for a workspace button when the workspace
\r
958 <dt class="hdlist1">
\r
959 active_workspace_text/active_workspace_bg
\r
963 Text color/background color for a workspace button when the workspace
\r
964 is active (visible) on some output, but the focus is on another one.
\r
965 You can only tell this apart from the focused workspace when you are
\r
966 using multiple monitors.
\r
969 <dt class="hdlist1">
\r
970 inactive_workspace_text/inactive_workspace_bg
\r
974 Text color/background color for a workspace button when the workspace
\r
975 does not have focus and is not active (visible) on any output. This
\r
976 will be the case for most workspaces.
\r
979 <dt class="hdlist1">
\r
980 urgent_workspace_text/urgent_workspace_bar
\r
984 Text color/background color for workspaces which contain at least one
\r
985 window with the urgency hint set.
\r
989 <div class="paragraph"><p><strong>Example of configured bars:</strong></p></div>
\r
990 <div class="listingblock">
\r
991 <div class="content">
\r
992 <pre><tt>["bar-bxuqzf"]</tt></pre>
\r
994 <div class="paragraph"><p><strong>Example of bar configuration:</strong></p></div>
\r
995 <div class="listingblock">
\r
996 <div class="content">
\r
998 "id": "bar-bxuqzf",
\r
1000 "position": "bottom",
\r
1001 "status_command": "i3status",
\r
1002 "font": "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1",
\r
1003 "workspace_buttons": true,
\r
1004 "binding_mode_indicator": true,
\r
1007 "background": "#c0c0c0",
\r
1008 "statusline": "#00ff00",
\r
1009 "focused_workspace_text": "#ffffff",
\r
1010 "focused_workspace_bg": "#000000"
\r
1015 <div class="sect2">
\r
1016 <h3 id="_version_reply">3.9. VERSION reply</h3>
\r
1017 <div class="paragraph"><p>The reply consists of a single JSON dictionary with the following keys:</p></div>
\r
1018 <div class="dlist"><dl>
\r
1019 <dt class="hdlist1">
\r
1024 The major version of i3, such as <tt>4</tt>.
\r
1027 <dt class="hdlist1">
\r
1032 The minor version of i3, such as <tt>2</tt>. Changes in the IPC interface (new
\r
1033 features) will only occur with new minor (or major) releases. However,
\r
1034 bugfixes might be introduced in patch releases, too.
\r
1037 <dt class="hdlist1">
\r
1042 The patch version of i3, such as <tt>1</tt> (when the complete version is
\r
1043 <tt>4.2.1</tt>). For versions such as <tt>4.2</tt>, patch will be set to <tt>0</tt>.
\r
1046 <dt class="hdlist1">
\r
1047 human_readable (string)
\r
1051 A human-readable version of i3 containing the precise git version,
\r
1052 build date and branch name. When you need to display the i3 version to
\r
1053 your users, use the human-readable version whenever possible (since
\r
1054 this is what <tt>i3 --version</tt> displays, too).
\r
1058 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
1059 <div class="listingblock">
\r
1060 <div class="content">
\r
1062 "human_readable" : "4.2-169-gf80b877 (2012-08-05, branch \"next\")",
\r
1071 <div class="sect1">
\r
1072 <h2 id="_events">4. Events</h2>
\r
1073 <div class="sectionbody">
\r
1074 <div class="paragraph" id="events"><p>To get informed when certain things happen in i3, clients can subscribe to
\r
1075 events. Events consist of a name (like "workspace") and an event reply type
\r
1076 (like I3_IPC_EVENT_WORKSPACE). The events sent by i3 are in the same format
\r
1077 as replies to specific commands. However, the highest bit of the message type
\r
1078 is set to 1 to indicate that this is an event reply instead of a normal reply.</p></div>
\r
1079 <div class="paragraph"><p>Caveat: As soon as you subscribe to an event, it is not guaranteed any longer
\r
1080 that the requests to i3 are processed in order. This means, the following
\r
1081 situation can happen: You send a GET_WORKSPACES request but you receive a
\r
1082 "workspace" event before receiving the reply to GET_WORKSPACES. If your
\r
1083 program does not want to cope which such kinds of race conditions (an
\r
1084 event based library may not have a problem here), I suggest you create a
\r
1085 separate connection to receive events.</p></div>
\r
1086 <div class="sect2">
\r
1087 <h3 id="_subscribing_to_events">4.1. Subscribing to events</h3>
\r
1088 <div class="paragraph"><p>By sending a message of type SUBSCRIBE with a JSON-encoded array as payload
\r
1089 you can register to an event.</p></div>
\r
1090 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
1091 <div class="listingblock">
\r
1092 <div class="content">
\r
1093 <pre><tt>type: SUBSCRIBE
\r
1094 payload: [ "workspace", "output" ]</tt></pre>
\r
1097 <div class="sect2">
\r
1098 <h3 id="_available_events">4.2. Available events</h3>
\r
1099 <div class="paragraph"><p>The numbers in parenthesis is the event type (keep in mind that you need to
\r
1100 strip the highest bit first).</p></div>
\r
1101 <div class="dlist"><dl>
\r
1102 <dt class="hdlist1">
\r
1107 Sent when the user switches to a different workspace, when a new
\r
1108 workspace is initialized or when a workspace is removed (because the
\r
1109 last client vanished).
\r
1112 <dt class="hdlist1">
\r
1117 Sent when RandR issues a change notification (of either screens,
\r
1118 outputs, CRTCs or output properties).
\r
1121 <dt class="hdlist1">
\r
1126 Sent whenever i3 changes its binding mode.
\r
1129 <dt class="hdlist1">
\r
1134 Sent when a client’s window is successfully reparented (that is when i3
\r
1135 has finished fitting it into a container), when a window received input
\r
1136 focus or when certain properties of the window have changed.
\r
1139 <dt class="hdlist1">
\r
1140 barconfig_update (4)
\r
1144 Sent when the hidden_state or mode field in the barconfig of any bar
\r
1145 instance was updated and when the config is reloaded.
\r
1148 <dt class="hdlist1">
\r
1153 Sent when a configured command binding is triggered with the keyboard or
\r
1158 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
1159 <div class="listingblock">
\r
1160 <div class="content">
\r
1161 <pre><tt># the appropriate 4 bytes read from the socket are stored in $input
\r
1163 # unpack a 32-bit unsigned integer
\r
1164 my $message_type = unpack("L", $input);
\r
1166 # check if the highest bit is 1
\r
1167 my $is_event = (($message_type >> 31) == 1);
\r
1169 # use the other bits
\r
1170 my $event_type = ($message_type & 0x7F);
\r
1173 say "Received event of type $event_type";
\r
1177 <div class="sect2">
\r
1178 <h3 id="_workspace_event">4.3. workspace event</h3>
\r
1179 <div class="paragraph"><p>This event consists of a single serialized map containing a property
\r
1180 <tt>change (string)</tt> which indicates the type of the change ("focus", "init",
\r
1181 "empty", "urgent"). A <tt>current (object)</tt> property will be present with the
\r
1182 affected workspace whenever the type of event affects a workspace (otherwise,
\r
1183 it will be +null).</p></div>
\r
1184 <div class="paragraph"><p>When the change is "focus", an <tt>old (object)</tt> property will be present with the
\r
1185 previous workspace. When the first switch occurs (when i3 focuses the
\r
1186 workspace visible at the beginning) there is no previous workspace, and the
\r
1187 <tt>old</tt> property will be set to <tt>null</tt>. Also note that if the previous is empty
\r
1188 it will get destroyed when switching, but will still be present in the "old"
\r
1189 property.</p></div>
\r
1190 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
1191 <div class="listingblock">
\r
1192 <div class="content">
\r
1194 "change": "focus",
\r
1197 "type": "workspace",
\r
1202 "type": "workspace",
\r
1208 <div class="sect2">
\r
1209 <h3 id="_output_event">4.4. output event</h3>
\r
1210 <div class="paragraph"><p>This event consists of a single serialized map containing a property
\r
1211 <tt>change (string)</tt> which indicates the type of the change (currently only
\r
1212 "unspecified").</p></div>
\r
1213 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
1214 <div class="listingblock">
\r
1215 <div class="content">
\r
1216 <pre><tt>{ "change": "unspecified" }</tt></pre>
\r
1219 <div class="sect2">
\r
1220 <h3 id="_mode_event">4.5. mode event</h3>
\r
1221 <div class="paragraph"><p>This event consists of a single serialized map containing a property
\r
1222 <tt>change (string)</tt> which holds the name of current mode in use. The name
\r
1223 is the same as specified in config when creating a mode. The default
\r
1224 mode is simply named default.</p></div>
\r
1225 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
1226 <div class="listingblock">
\r
1227 <div class="content">
\r
1228 <pre><tt>{ "change": "default" }</tt></pre>
\r
1231 <div class="sect2">
\r
1232 <h3 id="_window_event">4.6. window event</h3>
\r
1233 <div class="paragraph"><p>This event consists of a single serialized map containing a property
\r
1234 <tt>change (string)</tt> which indicates the type of the change</p></div>
\r
1235 <div class="ulist"><ul>
\r
1238 <tt>new</tt> - the window has become managed by i3
\r
1243 <tt>close</tt> - the window has closed
\r
1248 <tt>focus</tt> - the window has received input focus
\r
1253 <tt>title</tt> - the window’s title has changed
\r
1258 <tt>fullscreen_mode</tt> - the window has entered or exited fullscreen mode
\r
1263 <tt>move</tt> - the window has changed its position in the tree
\r
1268 <tt>floating</tt> - the window has transitioned to or from floating
\r
1273 <tt>urgent</tt> - the window has become urgent or lost its urgent status
\r
1277 <div class="paragraph"><p>Additionally a <tt>container (object)</tt> field will be present, which consists
\r
1278 of the window’s parent container. Be aware that for the "new" event, the
\r
1279 container will hold the initial name of the newly reparented window (e.g.
\r
1280 if you run urxvt with a shell that changes the title, you will still at
\r
1281 this point get the window title as "urxvt").</p></div>
\r
1282 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
1283 <div class="listingblock">
\r
1284 <div class="content">
\r
1295 <div class="sect2">
\r
1296 <h3 id="_barconfig_update_event">4.7. barconfig_update event</h3>
\r
1297 <div class="paragraph"><p>This event consists of a single serialized map reporting on options from the
\r
1298 barconfig of the specified bar_id that were updated in i3. This event is the
\r
1299 same as a <tt>GET_BAR_CONFIG</tt> reply for the bar with the given id.</p></div>
\r
1301 <div class="sect2">
\r
1302 <h3 id="_binding_event">4.8. binding event</h3>
\r
1303 <div class="paragraph"><p>This event consists of a single serialized map reporting on the details of a
\r
1304 binding that ran a command because of user input. The <tt>change (sring)</tt> field
\r
1305 indicates what sort of binding event was triggered (right now it will always be
\r
1306 <tt>"run"</tt> but may be expanded in the future).</p></div>
\r
1307 <div class="paragraph"><p>The <tt>binding (object)</tt> field contains details about the binding that was run:</p></div>
\r
1308 <div class="dlist"><dl>
\r
1309 <dt class="hdlist1">
\r
1314 The i3 command that is configured to run for this binding.
\r
1317 <dt class="hdlist1">
\r
1318 mods (array of strings)
\r
1322 The modifier keys that were configured with this binding.
\r
1325 <dt class="hdlist1">
\r
1326 input_code (integer)
\r
1330 If the binding was configured with <tt>bindcode</tt>, this will be the key code
\r
1331 that was given for the binding. If the binding is a mouse binding, it will be
\r
1332 the number of the mouse button that was pressed. Otherwise it will be 0.
\r
1335 <dt class="hdlist1">
\r
1336 symbol (string or null)
\r
1340 If this is a keyboard binding that was configured with <tt>bindsym</tt>, this
\r
1341 field will contain the given symbol. Otherwise it will be <tt>null</tt>.
\r
1344 <dt class="hdlist1">
\r
1345 input_type (string)
\r
1349 This will be <tt>"keyboard"</tt> or <tt>"mouse"</tt> depending on whether or not this was
\r
1350 a keyboard or a mouse binding.
\r
1354 <div class="paragraph"><p><strong>Example:</strong></p></div>
\r
1355 <div class="listingblock">
\r
1356 <div class="content">
\r
1367 "input_type": "keyboard"
\r
1374 <div class="sect1">
\r
1375 <h2 id="_see_also_existing_libraries">5. See also (existing libraries)</h2>
\r
1376 <div class="sectionbody">
\r
1377 <div class="paragraph" id="libraries"><p>For some languages, libraries are available (so you don’t have to implement
\r
1378 all this on your own). This list names some (if you wrote one, please let me
\r
1380 <div class="dlist"><dl>
\r
1381 <dt class="hdlist1">
\r
1385 <div class="ulist"><ul>
\r
1388 i3 includes a headerfile <tt>i3/ipc.h</tt> which provides you all constants.
\r
1393 <a href="https://github.com/acrisci/i3ipc-glib">https://github.com/acrisci/i3ipc-glib</a>
\r
1398 <dt class="hdlist1">
\r
1402 <div class="ulist"><ul>
\r
1405 <a href="https://github.com/proxypoke/i3ipc">https://github.com/proxypoke/i3ipc</a>
\r
1410 <dt class="hdlist1">
\r
1414 <div class="ulist"><ul>
\r
1417 <a href="https://github.com/acrisci/i3ipc-gjs">https://github.com/acrisci/i3ipc-gjs</a>
\r
1422 <dt class="hdlist1">
\r
1426 <div class="ulist"><ul>
\r
1429 <a href="https://github.com/acrisci/i3ipc-lua">https://github.com/acrisci/i3ipc-lua</a>
\r
1434 <dt class="hdlist1">
\r
1438 <div class="ulist"><ul>
\r
1441 <a href="https://metacpan.org/module/AnyEvent::I3">https://metacpan.org/module/AnyEvent::I3</a>
\r
1446 <dt class="hdlist1">
\r
1450 <div class="ulist"><ul>
\r
1453 <a href="https://github.com/acrisci/i3ipc-python">https://github.com/acrisci/i3ipc-python</a>
\r
1458 <a href="https://github.com/whitelynx/i3ipc">https://github.com/whitelynx/i3ipc</a> (not maintained)
\r
1463 <a href="https://github.com/ziberna/i3-py">https://github.com/ziberna/i3-py</a> (not maintained)
\r
1468 <dt class="hdlist1">
\r
1472 <div class="ulist"><ul>
\r
1475 <a href="http://github.com/badboy/i3-ipc">http://github.com/badboy/i3-ipc</a>
\r
1484 <div id="footnotes"><hr /></div>
\r
1485 <div id="footer" lang="de">
\r
1486 © 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>
\r