git.sur5r.net Git - i3/i3.github.io/blob - docs/ipc.html

   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
   4 <head>\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
  12 /*<![CDATA[*/\r
  13 document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); asciidoc.toc(2);}, false);\r
  14 /*]]>*/\r
  15 </script>\r
  16 <script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>\r
  17 </head>\r
  18 <body class="article">\r
  19 \r
  20         <div id="main">\r
  21             <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>\r
  22                         <ul id="nav">\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://www.reddit.com/r/i3wm/">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
  28                         </ul>\r
  29         <br style="clear: both">\r
  30 <div id="content">\r
  31 <div id="header">\r
  32 <h1>IPC interface (interprocess communication)</h1>\r
  33 <span id="author">Michael Stapelberg</span><br />\r
  34 <span id="email"><tt>&lt;<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>&gt;</tt></span><br />\r
  35 <span id="revdate">October 2014</span>\r
  36 <div id="toc">
  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>
  39 </div>\r
  40 </div>\r
  41 <div id="preamble">\r
  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
  57 <table><tr>\r
  58 <td class="icon">\r
  59 <div class="title">Warning</div>\r
  60 </td>\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
  65 directly.</td>\r
  66 </tr></table>\r
  67 </div>\r
  68 </div>\r
  69 </div>\r
  70 <div class="sect1">\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-&gt;new(Peer =&gt; $path);</tt></pre>\r
  80 </div></div>\r
  81 </div>\r
  82 </div>\r
  83 <div class="sect1">\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
  98 COMMAND (0)\r
  99 </dt>\r
 100 <dd>\r
 101 <p>\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
 105 </p>\r
 106 </dd>\r
 107 <dt class="hdlist1">\r
 108 GET_WORKSPACES (1)\r
 109 </dt>\r
 110 <dd>\r
 111 <p>\r
 112         Gets the current workspaces. The reply will be a JSON-encoded list of\r
 113         workspaces (see the reply section).\r
 114 </p>\r
 115 </dd>\r
 116 <dt class="hdlist1">\r
 117 SUBSCRIBE (2)\r
 118 </dt>\r
 119 <dd>\r
 120 <p>\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
 123 </p>\r
 124 </dd>\r
 125 <dt class="hdlist1">\r
 126 GET_OUTPUTS (3)\r
 127 </dt>\r
 128 <dd>\r
 129 <p>\r
 130         Gets the current outputs. The reply will be a JSON-encoded list of outputs\r
 131         (see the reply section).\r
 132 </p>\r
 133 </dd>\r
 134 <dt class="hdlist1">\r
 135 GET_TREE (4)\r
 136 </dt>\r
 137 <dd>\r
 138 <p>\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
 141         section).\r
 142 </p>\r
 143 </dd>\r
 144 <dt class="hdlist1">\r
 145 GET_MARKS (5)\r
 146 </dt>\r
 147 <dd>\r
 148 <p>\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
 151         reply section).\r
 152 </p>\r
 153 </dd>\r
 154 <dt class="hdlist1">\r
 155 GET_BAR_CONFIG (6)\r
 156 </dt>\r
 157 <dd>\r
 158 <p>\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
 161         returned instead.\r
 162 </p>\r
 163 </dd>\r
 164 <dt class="hdlist1">\r
 165 GET_VERSION (7)\r
 166 </dt>\r
 167 <dd>\r
 168 <p>\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
 171 </p>\r
 172 </dd>\r
 173 <dt class="hdlist1">\r
 174 GET_BINDING_MODES (8)\r
 175 </dt>\r
 176 <dd>\r
 177 <p>\r
 178         Gets a list of currently configured binding modes.\r
 179 </p>\r
 180 </dd>\r
 181 </dl></div>\r
 182 <div class="paragraph"><p>So, a typical message could look like this:</p></div>\r
 183 <div class="listingblock">\r
 184 <div class="content">\r
 185 <pre><tt>"i3-ipc" &lt;message length&gt; &lt;message type&gt; &lt;payload&gt;</tt></pre>\r
 186 </div></div>\r
 187 <div class="paragraph"><p>Or, as a hexdump:</p></div>\r
 188 <div class="listingblock">\r
 189 <div class="content">\r
 190 <pre><tt>00000000  69 33 2d 69 70 63 04 00  00 00 00 00 00 00 65 78  |i3-ipc........ex|\r
 191 00000010  69 74                                             |it|</tt></pre>\r
 192 </div></div>\r
 193 <div class="paragraph"><p>To generate and send such a message, you could use the following code in Perl:</p></div>\r
 194 <div class="listingblock">\r
 195 <div class="content">\r
 196 <pre><tt>sub format_ipc_command {\r
 197     my ($msg) = @_;\r
 198     my $len;\r
 199     # Get the real byte count (vs. amount of characters)\r
 200     { use bytes; $len = length($msg); }\r
 201     return "i3-ipc" . pack("LL", $len, 0) . $msg;\r
 202 }\r
 203 \r
 204 $sock-&gt;write(format_ipc_command("exit"));</tt></pre>\r
 205 </div></div>\r
 206 </div>\r
 207 </div>\r
 208 <div class="sect1">\r
 209 <h2 id="_receiving_replies_from_i3">3. Receiving replies from i3</h2>\r
 210 <div class="sectionbody">\r
 211 <div class="paragraph"><p>Replies from i3 usually consist of a simple string (the length of the string\r
 212 is the message_length, so you can consider them length-prefixed) which in turn\r
 213 contain the JSON serialization of a data structure. For example, the\r
 214 GET_WORKSPACES message returns an array of workspaces (each workspace is a map\r
 215 with certain attributes).</p></div>\r
 216 <div class="sect2">\r
 217 <h3 id="_reply_format">3.1. Reply format</h3>\r
 218 <div class="paragraph"><p>The reply format is identical to the normal message format. There also is\r
 219 the magic string, then the message length, then the message type and the\r
 220 payload.</p></div>\r
 221 <div class="paragraph"><p>The following reply types are implemented:</p></div>\r
 222 <div class="dlist"><dl>\r
 223 <dt class="hdlist1">\r
 224 COMMAND (0)\r
 225 </dt>\r
 226 <dd>\r
 227 <p>\r
 228         Confirmation/Error code for the COMMAND message.\r
 229 </p>\r
 230 </dd>\r
 231 <dt class="hdlist1">\r
 232 WORKSPACES (1)\r
 233 </dt>\r
 234 <dd>\r
 235 <p>\r
 236         Reply to the GET_WORKSPACES message.\r
 237 </p>\r
 238 </dd>\r
 239 <dt class="hdlist1">\r
 240 SUBSCRIBE (2)\r
 241 </dt>\r
 242 <dd>\r
 243 <p>\r
 244         Confirmation/Error code for the SUBSCRIBE message.\r
 245 </p>\r
 246 </dd>\r
 247 <dt class="hdlist1">\r
 248 OUTPUTS (3)\r
 249 </dt>\r
 250 <dd>\r
 251 <p>\r
 252         Reply to the GET_OUTPUTS message.\r
 253 </p>\r
 254 </dd>\r
 255 <dt class="hdlist1">\r
 256 TREE (4)\r
 257 </dt>\r
 258 <dd>\r
 259 <p>\r
 260         Reply to the GET_TREE message.\r
 261 </p>\r
 262 </dd>\r
 263 <dt class="hdlist1">\r
 264 MARKS (5)\r
 265 </dt>\r
 266 <dd>\r
 267 <p>\r
 268         Reply to the GET_MARKS message.\r
 269 </p>\r
 270 </dd>\r
 271 <dt class="hdlist1">\r
 272 BAR_CONFIG (6)\r
 273 </dt>\r
 274 <dd>\r
 275 <p>\r
 276         Reply to the GET_BAR_CONFIG message.\r
 277 </p>\r
 278 </dd>\r
 279 <dt class="hdlist1">\r
 280 VERSION (7)\r
 281 </dt>\r
 282 <dd>\r
 283 <p>\r
 284         Reply to the GET_VERSION message.\r
 285 </p>\r
 286 </dd>\r
 287 <dt class="hdlist1">\r
 288 BINDING_MODES (8)\r
 289 </dt>\r
 290 <dd>\r
 291 <p>\r
 292         Reply to the GET_BINDING_MODES message.\r
 293 </p>\r
 294 </dd>\r
 295 </dl></div>\r
 296 </div>\r
 297 <div class="sect2">\r
 298 <h3 id="_command_reply">3.2. COMMAND reply</h3>\r
 299 <div class="paragraph"><p>The reply consists of a list of serialized maps for each command that was\r
 300 parsed. Each has the property <tt>success (bool)</tt> and may also include a\r
 301 human-readable error message in the property <tt>error (string)</tt>.</p></div>\r
 302 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 303 <div class="listingblock">\r
 304 <div class="content">\r
 305 <pre><tt>[{ "success": true }]</tt></pre>\r
 306 </div></div>\r
 307 </div>\r
 308 <div class="sect2">\r
 309 <h3 id="_workspaces_reply">3.3. WORKSPACES reply</h3>\r
 310 <div class="paragraph"><p>The reply consists of a serialized list of workspaces. Each workspace has the\r
 311 following properties:</p></div>\r
 312 <div class="dlist"><dl>\r
 313 <dt class="hdlist1">\r
 314 num (integer)\r
 315 </dt>\r
 316 <dd>\r
 317 <p>\r
 318         The logical number of the workspace. Corresponds to the command\r
 319         to switch to this workspace. For named workspaces, this will be -1.\r
 320 </p>\r
 321 </dd>\r
 322 <dt class="hdlist1">\r
 323 name (string)\r
 324 </dt>\r
 325 <dd>\r
 326 <p>\r
 327         The name of this workspace (by default num+1), as changed by the\r
 328         user. Encoded in UTF-8.\r
 329 </p>\r
 330 </dd>\r
 331 <dt class="hdlist1">\r
 332 visible (boolean)\r
 333 </dt>\r
 334 <dd>\r
 335 <p>\r
 336         Whether this workspace is currently visible on an output (multiple\r
 337         workspaces can be visible at the same time).\r
 338 </p>\r
 339 </dd>\r
 340 <dt class="hdlist1">\r
 341 focused (boolean)\r
 342 </dt>\r
 343 <dd>\r
 344 <p>\r
 345         Whether this workspace currently has the focus (only one workspace\r
 346         can have the focus at the same time).\r
 347 </p>\r
 348 </dd>\r
 349 <dt class="hdlist1">\r
 350 urgent (boolean)\r
 351 </dt>\r
 352 <dd>\r
 353 <p>\r
 354         Whether a window on this workspace has the "urgent" flag set.\r
 355 </p>\r
 356 </dd>\r
 357 <dt class="hdlist1">\r
 358 rect (map)\r
 359 </dt>\r
 360 <dd>\r
 361 <p>\r
 362         The rectangle of this workspace (equals the rect of the output it\r
 363         is on), consists of x, y, width, height.\r
 364 </p>\r
 365 </dd>\r
 366 <dt class="hdlist1">\r
 367 output (string)\r
 368 </dt>\r
 369 <dd>\r
 370 <p>\r
 371         The video output this workspace is on (LVDS1, VGA1, …).\r
 372 </p>\r
 373 </dd>\r
 374 </dl></div>\r
 375 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 376 <div class="listingblock">\r
 377 <div class="content">\r
 378 <pre><tt>[\r
 379  {\r
 380   "num": 0,\r
 381   "name": "1",\r
 382   "visible": true,\r
 383   "focused": true,\r
 384   "urgent": false,\r
 385   "rect": {\r
 386    "x": 0,\r
 387    "y": 0,\r
 388    "width": 1280,\r
 389    "height": 800\r
 390   },\r
 391   "output": "LVDS1"\r
 392  },\r
 393  {\r
 394   "num": 1,\r
 395   "name": "2",\r
 396   "visible": false,\r
 397   "focused": false,\r
 398   "urgent": false,\r
 399   "rect": {\r
 400    "x": 0,\r
 401    "y": 0,\r
 402    "width": 1280,\r
 403    "height": 800\r
 404   },\r
 405   "output": "LVDS1"\r
 406  }\r
 407 ]</tt></pre>\r
 408 </div></div>\r
 409 </div>\r
 410 <div class="sect2">\r
 411 <h3 id="_subscribe_reply">3.4. SUBSCRIBE reply</h3>\r
 412 <div class="paragraph"><p>The reply consists of a single serialized map. The only property is\r
 413 <tt>success (bool)</tt>, indicating whether the subscription was successful (the\r
 414 default) or whether a JSON parse error occurred.</p></div>\r
 415 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 416 <div class="listingblock">\r
 417 <div class="content">\r
 418 <pre><tt>{ "success": true }</tt></pre>\r
 419 </div></div>\r
 420 </div>\r
 421 <div class="sect2">\r
 422 <h3 id="_outputs_reply">3.5. OUTPUTS reply</h3>\r
 423 <div class="paragraph"><p>The reply consists of a serialized list of outputs. Each output has the\r
 424 following properties:</p></div>\r
 425 <div class="dlist"><dl>\r
 426 <dt class="hdlist1">\r
 427 name (string)\r
 428 </dt>\r
 429 <dd>\r
 430 <p>\r
 431         The name of this output (as seen in <tt>xrandr(1)</tt>). Encoded in UTF-8.\r
 432 </p>\r
 433 </dd>\r
 434 <dt class="hdlist1">\r
 435 active (boolean)\r
 436 </dt>\r
 437 <dd>\r
 438 <p>\r
 439         Whether this output is currently active (has a valid mode).\r
 440 </p>\r
 441 </dd>\r
 442 <dt class="hdlist1">\r
 443 current_workspace (string)\r
 444 </dt>\r
 445 <dd>\r
 446 <p>\r
 447         The name of the current workspace that is visible on this output. <tt>null</tt> if\r
 448         the output is not active.\r
 449 </p>\r
 450 </dd>\r
 451 <dt class="hdlist1">\r
 452 rect (map)\r
 453 </dt>\r
 454 <dd>\r
 455 <p>\r
 456         The rectangle of this output (equals the rect of the output it\r
 457         is on), consists of x, y, width, height.\r
 458 </p>\r
 459 </dd>\r
 460 </dl></div>\r
 461 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 462 <div class="listingblock">\r
 463 <div class="content">\r
 464 <pre><tt>[\r
 465  {\r
 466   "name": "LVDS1",\r
 467   "active": true,\r
 468   "current_workspace": "4",\r
 469   "rect": {\r
 470    "x": 0,\r
 471    "y": 0,\r
 472    "width": 1280,\r
 473    "height": 800\r
 474   }\r
 475  },\r
 476  {\r
 477   "name": "VGA1",\r
 478   "active": true,\r
 479   "current_workspace": "1",\r
 480   "rect": {\r
 481    "x": 1280,\r
 482    "y": 0,\r
 483    "width": 1280,\r
 484    "height": 1024\r
 485   },\r
 486  }\r
 487 ]</tt></pre>\r
 488 </div></div>\r
 489 </div>\r
 490 <div class="sect2">\r
 491 <h3 id="_tree_reply">3.6. TREE reply</h3>\r
 492 <div class="paragraph"><p>The reply consists of a serialized tree. Each node in the tree (representing\r
 493 one container) has at least the properties listed below. While the nodes might\r
 494 have more properties, please do not use any properties which are not documented\r
 495 here. They are not yet finalized and will probably change!</p></div>\r
 496 <div class="dlist"><dl>\r
 497 <dt class="hdlist1">\r
 498 id (integer)\r
 499 </dt>\r
 500 <dd>\r
 501 <p>\r
 502         The internal ID (actually a C pointer value) of this container. Do not\r
 503         make any assumptions about it. You can use it to (re-)identify and\r
 504         address containers when talking to i3.\r
 505 </p>\r
 506 </dd>\r
 507 <dt class="hdlist1">\r
 508 name (string)\r
 509 </dt>\r
 510 <dd>\r
 511 <p>\r
 512         The internal name of this container. For all containers which are part\r
 513         of the tree structure down to the workspace contents, this is set to a\r
 514         nice human-readable name of the container.\r
 515         For containers that have an X11 window, the content is the title\r
 516         (_NET_WM_NAME property) of that window.\r
 517         For all other containers, the content is not defined (yet).\r
 518 </p>\r
 519 </dd>\r
 520 <dt class="hdlist1">\r
 521 type (string)\r
 522 </dt>\r
 523 <dd>\r
 524 <p>\r
 525         Type of this container. Can be one of "root", "output", "con",\r
 526         "floating_con", "workspace" or "dockarea".\r
 527 </p>\r
 528 </dd>\r
 529 <dt class="hdlist1">\r
 530 border (string)\r
 531 </dt>\r
 532 <dd>\r
 533 <p>\r
 534         Can be either "normal", "none" or "pixel", depending on the\r
 535         container’s border style.\r
 536 </p>\r
 537 </dd>\r
 538 <dt class="hdlist1">\r
 539 current_border_width (integer)\r
 540 </dt>\r
 541 <dd>\r
 542 <p>\r
 543         Number of pixels of the border width.\r
 544 </p>\r
 545 </dd>\r
 546 <dt class="hdlist1">\r
 547 layout (string)\r
 548 </dt>\r
 549 <dd>\r
 550 <p>\r
 551         Can be either "splith", "splitv", "stacked", "tabbed", "dockarea" or\r
 552         "output".\r
 553         Other values might be possible in the future, should we add new\r
 554         layouts.\r
 555 </p>\r
 556 </dd>\r
 557 <dt class="hdlist1">\r
 558 orientation (string)\r
 559 </dt>\r
 560 <dd>\r
 561 <p>\r
 562         Can be either "none" (for non-split containers), "horizontal" or\r
 563         "vertical".\r
 564         THIS FIELD IS OBSOLETE. It is still present, but your code should not\r
 565         use it. Instead, rely on the layout field.\r
 566 </p>\r
 567 </dd>\r
 568 <dt class="hdlist1">\r
 569 percent (float)\r
 570 </dt>\r
 571 <dd>\r
 572 <p>\r
 573         The percentage which this container takes in its parent. A value of\r
 574         <tt>null</tt> means that the percent property does not make sense for this\r
 575         container, for example for the root container.\r
 576 </p>\r
 577 </dd>\r
 578 <dt class="hdlist1">\r
 579 rect (map)\r
 580 </dt>\r
 581 <dd>\r
 582 <p>\r
 583         The absolute display coordinates for this container. Display\r
 584         coordinates means that when you have two 1600x1200 monitors on a single\r
 585         X11 Display (the standard way), the coordinates of the first window on\r
 586         the second monitor are <tt>{ "x": 1600, "y": 0, "width": 1600, "height":\r
 587         1200 }</tt>.\r
 588 </p>\r
 589 </dd>\r
 590 <dt class="hdlist1">\r
 591 window_rect (map)\r
 592 </dt>\r
 593 <dd>\r
 594 <p>\r
 595         The coordinates of the <strong>actual client window</strong> inside its container.\r
 596         These coordinates are relative to the container and do not include the\r
 597         window decoration (which is actually rendered on the parent container).\r
 598         So, when using the <tt>default</tt> layout, you will have a 2 pixel border on\r
 599         each side, making the window_rect <tt>{ "x": 2, "y": 0, "width": 632,\r
 600         "height": 366 }</tt> (for example).\r
 601 </p>\r
 602 </dd>\r
 603 <dt class="hdlist1">\r
 604 deco_rect (map)\r
 605 </dt>\r
 606 <dd>\r
 607 <p>\r
 608         The coordinates of the <strong>window decoration</strong> inside its container. These\r
 609         coordinates are relative to the container and do not include the actual\r
 610         client window.\r
 611 </p>\r
 612 </dd>\r
 613 <dt class="hdlist1">\r
 614 geometry (map)\r
 615 </dt>\r
 616 <dd>\r
 617 <p>\r
 618         The original geometry the window specified when i3 mapped it. Used when\r
 619         switching a window to floating mode, for example.\r
 620 </p>\r
 621 </dd>\r
 622 <dt class="hdlist1">\r
 623 window (integer)\r
 624 </dt>\r
 625 <dd>\r
 626 <p>\r
 627         The X11 window ID of the <strong>actual client window</strong> inside this container.\r
 628         This field is set to null for split containers or otherwise empty\r
 629         containers. This ID corresponds to what xwininfo(1) and other\r
 630         X11-related tools display (usually in hex).\r
 631 </p>\r
 632 </dd>\r
 633 <dt class="hdlist1">\r
 634 urgent (bool)\r
 635 </dt>\r
 636 <dd>\r
 637 <p>\r
 638         Whether this container (window or workspace) has the urgency hint set.\r
 639 </p>\r
 640 </dd>\r
 641 <dt class="hdlist1">\r
 642 focused (bool)\r
 643 </dt>\r
 644 <dd>\r
 645 <p>\r
 646         Whether this container is currently focused.\r
 647 </p>\r
 648 </dd>\r
 649 </dl></div>\r
 650 <div class="paragraph"><p>Please note that in the following example, I have left out some keys/values\r
 651 which are not relevant for the type of the node. Otherwise, the example would\r
 652 be by far too long (it already is quite long, despite showing only 1 window and\r
 653 one dock window).</p></div>\r
 654 <div class="paragraph"><p>It is useful to have an overview of the structure before taking a look at the\r
 655 JSON dump:</p></div>\r
 656 <div class="ulist"><ul>\r
 657 <li>\r
 658 <p>\r
 659 root\r
 660 </p>\r
 661 <div class="ulist"><ul>\r
 662 <li>\r
 663 <p>\r
 664 LVDS1\r
 665 </p>\r
 666 <div class="ulist"><ul>\r
 667 <li>\r
 668 <p>\r
 669 topdock\r
 670 </p>\r
 671 </li>\r
 672 <li>\r
 673 <p>\r
 674 content\r
 675 </p>\r
 676 <div class="ulist"><ul>\r
 677 <li>\r
 678 <p>\r
 679 workspace 1\r
 680 </p>\r
 681 <div class="ulist"><ul>\r
 682 <li>\r
 683 <p>\r
 684 window 1\r
 685 </p>\r
 686 </li>\r
 687 </ul></div>\r
 688 </li>\r
 689 </ul></div>\r
 690 </li>\r
 691 <li>\r
 692 <p>\r
 693 bottomdock\r
 694 </p>\r
 695 <div class="ulist"><ul>\r
 696 <li>\r
 697 <p>\r
 698 dock window 1\r
 699 </p>\r
 700 </li>\r
 701 </ul></div>\r
 702 </li>\r
 703 </ul></div>\r
 704 </li>\r
 705 <li>\r
 706 <p>\r
 707 VGA1\r
 708 </p>\r
 709 </li>\r
 710 </ul></div>\r
 711 </li>\r
 712 </ul></div>\r
 713 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 714 <div class="listingblock">\r
 715 <div class="content">\r
 716 <pre><tt>{\r
 717  "id": 6875648,\r
 718  "name": "root",\r
 719  "rect": {\r
 720    "x": 0,\r
 721    "y": 0,\r
 722    "width": 1280,\r
 723    "height": 800\r
 724  },\r
 725  "nodes": [\r
 726 \r
 727    {\r
 728     "id": 6878320,\r
 729     "name": "LVDS1",\r
 730     "layout": "output",\r
 731     "rect": {\r
 732       "x": 0,\r
 733       "y": 0,\r
 734       "width": 1280,\r
 735       "height": 800\r
 736     },\r
 737     "nodes": [\r
 738 \r
 739       {\r
 740        "id": 6878784,\r
 741        "name": "topdock",\r
 742        "layout": "dockarea",\r
 743        "orientation": "vertical",\r
 744        "rect": {\r
 745          "x": 0,\r
 746          "y": 0,\r
 747          "width": 1280,\r
 748          "height": 0\r
 749        },\r
 750       },\r
 751 \r
 752       {\r
 753        "id": 6879344,\r
 754        "name": "content",\r
 755        "rect": {\r
 756          "x": 0,\r
 757          "y": 0,\r
 758          "width": 1280,\r
 759          "height": 782\r
 760        },\r
 761        "nodes": [\r
 762 \r
 763          {\r
 764           "id": 6880464,\r
 765           "name": "1",\r
 766           "orientation": "horizontal",\r
 767           "rect": {\r
 768             "x": 0,\r
 769             "y": 0,\r
 770             "width": 1280,\r
 771             "height": 782\r
 772           },\r
 773           "floating_nodes": [],\r
 774           "nodes": [\r
 775 \r
 776             {\r
 777              "id": 6929968,\r
 778              "name": "#aa0000",\r
 779              "border": "normal",\r
 780              "percent": 1,\r
 781              "rect": {\r
 782                "x": 0,\r
 783                "y": 18,\r
 784                "width": 1280,\r
 785                "height": 782\r
 786              }\r
 787             }\r
 788 \r
 789           ]\r
 790          }\r
 791 \r
 792        ]\r
 793       },\r
 794 \r
 795       {\r
 796        "id": 6880208,\r
 797        "name": "bottomdock",\r
 798        "layout": "dockarea",\r
 799        "orientation": "vertical",\r
 800        "rect": {\r
 801          "x": 0,\r
 802          "y": 782,\r
 803          "width": 1280,\r
 804          "height": 18\r
 805        },\r
 806        "nodes": [\r
 807 \r
 808          {\r
 809           "id": 6931312,\r
 810           "name": "#00aa00",\r
 811           "percent": 1,\r
 812           "rect": {\r
 813             "x": 0,\r
 814             "y": 782,\r
 815             "width": 1280,\r
 816             "height": 18\r
 817           }\r
 818          }\r
 819 \r
 820        ]\r
 821       }\r
 822     ]\r
 823    }\r
 824  ]\r
 825 }</tt></pre>\r
 826 </div></div>\r
 827 </div>\r
 828 <div class="sect2">\r
 829 <h3 id="_marks_reply">3.7. MARKS reply</h3>\r
 830 <div class="paragraph"><p>The reply consists of a single array of strings for each container that has a\r
 831 mark. A mark can only be set on one container, so the array is unique.\r
 832 The order of that array is undefined.</p></div>\r
 833 <div class="paragraph"><p>If no window has a mark the response will be the empty array [].</p></div>\r
 834 </div>\r
 835 <div class="sect2">\r
 836 <h3 id="_bar_config_reply">3.8. BAR_CONFIG reply</h3>\r
 837 <div class="paragraph"><p>This can be used by third-party workspace bars (especially i3bar, but others\r
 838 are free to implement compatible alternatives) to get the <tt>bar</tt> block\r
 839 configuration from i3.</p></div>\r
 840 <div class="paragraph"><p>Depending on the input, the reply is either:</p></div>\r
 841 <div class="dlist"><dl>\r
 842 <dt class="hdlist1">\r
 843 empty input\r
 844 </dt>\r
 845 <dd>\r
 846 <p>\r
 847         An array of configured bar IDs\r
 848 </p>\r
 849 </dd>\r
 850 <dt class="hdlist1">\r
 851 Bar ID\r
 852 </dt>\r
 853 <dd>\r
 854 <p>\r
 855         A JSON map containing the configuration for the specified bar.\r
 856 </p>\r
 857 </dd>\r
 858 </dl></div>\r
 859 <div class="paragraph"><p>Each bar configuration has the following properties:</p></div>\r
 860 <div class="dlist"><dl>\r
 861 <dt class="hdlist1">\r
 862 id (string)\r
 863 </dt>\r
 864 <dd>\r
 865 <p>\r
 866         The ID for this bar. Included in case you request multiple\r
 867         configurations and want to differentiate the different replies.\r
 868 </p>\r
 869 </dd>\r
 870 <dt class="hdlist1">\r
 871 mode (string)\r
 872 </dt>\r
 873 <dd>\r
 874 <p>\r
 875         Either <tt>dock</tt> (the bar sets the dock window type) or <tt>hide</tt> (the bar\r
 876         does not show unless a specific key is pressed).\r
 877 </p>\r
 878 </dd>\r
 879 <dt class="hdlist1">\r
 880 position (string)\r
 881 </dt>\r
 882 <dd>\r
 883 <p>\r
 884         Either <tt>bottom</tt> or <tt>top</tt> at the moment.\r
 885 </p>\r
 886 </dd>\r
 887 <dt class="hdlist1">\r
 888 status_command (string)\r
 889 </dt>\r
 890 <dd>\r
 891 <p>\r
 892         Command which will be run to generate a statusline. Each line on stdout\r
 893         of this command will be displayed in the bar. At the moment, no\r
 894         formatting is supported.\r
 895 </p>\r
 896 </dd>\r
 897 <dt class="hdlist1">\r
 898 font (string)\r
 899 </dt>\r
 900 <dd>\r
 901 <p>\r
 902         The font to use for text on the bar.\r
 903 </p>\r
 904 </dd>\r
 905 <dt class="hdlist1">\r
 906 workspace_buttons (boolean)\r
 907 </dt>\r
 908 <dd>\r
 909 <p>\r
 910         Display workspace buttons or not? Defaults to true.\r
 911 </p>\r
 912 </dd>\r
 913 <dt class="hdlist1">\r
 914 binding_mode_indicator (boolean)\r
 915 </dt>\r
 916 <dd>\r
 917 <p>\r
 918         Display the mode indicator or not? Defaults to true.\r
 919 </p>\r
 920 </dd>\r
 921 <dt class="hdlist1">\r
 922 verbose (boolean)\r
 923 </dt>\r
 924 <dd>\r
 925 <p>\r
 926         Should the bar enable verbose output for debugging? Defaults to false.\r
 927 </p>\r
 928 </dd>\r
 929 <dt class="hdlist1">\r
 930 colors (map)\r
 931 </dt>\r
 932 <dd>\r
 933 <p>\r
 934         Contains key/value pairs of colors. Each value is a color code in hex,\r
 935         formatted #rrggbb (like in HTML).\r
 936 </p>\r
 937 </dd>\r
 938 </dl></div>\r
 939 <div class="paragraph"><p>The following colors can be configured at the moment:</p></div>\r
 940 <div class="dlist"><dl>\r
 941 <dt class="hdlist1">\r
 942 background\r
 943 </dt>\r
 944 <dd>\r
 945 <p>\r
 946         Background color of the bar.\r
 947 </p>\r
 948 </dd>\r
 949 <dt class="hdlist1">\r
 950 statusline\r
 951 </dt>\r
 952 <dd>\r
 953 <p>\r
 954         Text color to be used for the statusline.\r
 955 </p>\r
 956 </dd>\r
 957 <dt class="hdlist1">\r
 958 separator\r
 959 </dt>\r
 960 <dd>\r
 961 <p>\r
 962         Text color to be used for the separator.\r
 963 </p>\r
 964 </dd>\r
 965 <dt class="hdlist1">\r
 966 focused_background\r
 967 </dt>\r
 968 <dd>\r
 969 <p>\r
 970         Background color of the bar on the currently focused monitor output.\r
 971 </p>\r
 972 </dd>\r
 973 <dt class="hdlist1">\r
 974 focused_statusline\r
 975 </dt>\r
 976 <dd>\r
 977 <p>\r
 978         Text color to be used for the statusline on the currently focused\r
 979         monitor output.\r
 980 </p>\r
 981 </dd>\r
 982 <dt class="hdlist1">\r
 983 focused_separator\r
 984 </dt>\r
 985 <dd>\r
 986 <p>\r
 987         Text color to be used for the separator on the currently focused\r
 988         monitor output.\r
 989 </p>\r
 990 </dd>\r
 991 <dt class="hdlist1">\r
 992 focused_workspace_text/focused_workspace_bg/focused_workspace_border\r
 993 </dt>\r
 994 <dd>\r
 995 <p>\r
 996         Text/background/border color for a workspace button when the workspace\r
 997         has focus.\r
 998 </p>\r
 999 </dd>\r
1000 <dt class="hdlist1">\r
1001 active_workspace_text/active_workspace_bg/active_workspace_border\r
1002 </dt>\r
1003 <dd>\r
1004 <p>\r
1005         Text/background/border color for a workspace button when the workspace\r
1006         is active (visible) on some output, but the focus is on another one.\r
1007         You can only tell this apart from the focused workspace when you are\r
1008         using multiple monitors.\r
1009 </p>\r
1010 </dd>\r
1011 <dt class="hdlist1">\r
1012 inactive_workspace_text/inactive_workspace_bg/inactive_workspace_border\r
1013 </dt>\r
1014 <dd>\r
1015 <p>\r
1016         Text/background/border color for a workspace button when the workspace\r
1017         does not have focus and is not active (visible) on any output. This\r
1018         will be the case for most workspaces.\r
1019 </p>\r
1020 </dd>\r
1021 <dt class="hdlist1">\r
1022 urgent_workspace_text/urgent_workspace_bg/urgent_workspace_border\r
1023 </dt>\r
1024 <dd>\r
1025 <p>\r
1026         Text/background/border color for workspaces which contain at least one\r
1027         window with the urgency hint set.\r
1028 </p>\r
1029 </dd>\r
1030 <dt class="hdlist1">\r
1031 binding_mode_text/binding_mode_bg/binding_mode_border\r
1032 </dt>\r
1033 <dd>\r
1034 <p>\r
1035         Text/background/border color for the binding mode indicator.\r
1036 </p>\r
1037 </dd>\r
1038 </dl></div>\r
1039 <div class="paragraph"><p><strong>Example of configured bars:</strong></p></div>\r
1040 <div class="listingblock">\r
1041 <div class="content">\r
1042 <pre><tt>["bar-bxuqzf"]</tt></pre>\r
1043 </div></div>\r
1044 <div class="paragraph"><p><strong>Example of bar configuration:</strong></p></div>\r
1045 <div class="listingblock">\r
1046 <div class="content">\r
1047 <pre><tt>{\r
1048  "id": "bar-bxuqzf",\r
1049  "mode": "dock",\r
1050  "position": "bottom",\r
1051  "status_command": "i3status",\r
1052  "font": "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1",\r
1053  "workspace_buttons": true,\r
1054  "binding_mode_indicator": true,\r
1055  "verbose": false,\r
1056  "colors": {\r
1057    "background": "#c0c0c0",\r
1058    "statusline": "#00ff00",\r
1059    "focused_workspace_text": "#ffffff",\r
1060    "focused_workspace_bg": "#000000"\r
1061  }\r
1062 }</tt></pre>\r
1063 </div></div>\r
1064 </div>\r
1065 <div class="sect2">\r
1066 <h3 id="_version_reply">3.9. VERSION reply</h3>\r
1067 <div class="paragraph"><p>The reply consists of a single JSON dictionary with the following keys:</p></div>\r
1068 <div class="dlist"><dl>\r
1069 <dt class="hdlist1">\r
1070 major (integer)\r
1071 </dt>\r
1072 <dd>\r
1073 <p>\r
1074         The major version of i3, such as <tt>4</tt>.\r
1075 </p>\r
1076 </dd>\r
1077 <dt class="hdlist1">\r
1078 minor (integer)\r
1079 </dt>\r
1080 <dd>\r
1081 <p>\r
1082         The minor version of i3, such as <tt>2</tt>. Changes in the IPC interface (new\r
1083         features) will only occur with new minor (or major) releases. However,\r
1084         bugfixes might be introduced in patch releases, too.\r
1085 </p>\r
1086 </dd>\r
1087 <dt class="hdlist1">\r
1088 patch (integer)\r
1089 </dt>\r
1090 <dd>\r
1091 <p>\r
1092         The patch version of i3, such as <tt>1</tt> (when the complete version is\r
1093         <tt>4.2.1</tt>). For versions such as <tt>4.2</tt>, patch will be set to <tt>0</tt>.\r
1094 </p>\r
1095 </dd>\r
1096 <dt class="hdlist1">\r
1097 human_readable (string)\r
1098 </dt>\r
1099 <dd>\r
1100 <p>\r
1101         A human-readable version of i3 containing the precise git version,\r
1102         build date and branch name. When you need to display the i3 version to\r
1103         your users, use the human-readable version whenever possible (since\r
1104         this is what <tt>i3 --version</tt> displays, too).\r
1105 </p>\r
1106 </dd>\r
1107 <dt class="hdlist1">\r
1108 loaded_config_file_name (string)\r
1109 </dt>\r
1110 <dd>\r
1111 <p>\r
1112         The current config path.\r
1113 </p>\r
1114 </dd>\r
1115 </dl></div>\r
1116 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
1117 <div class="listingblock">\r
1118 <div class="content">\r
1119 <pre><tt>{\r
1120    "human_readable" : "4.2-169-gf80b877 (2012-08-05, branch \"next\")",\r
1121    "loaded_config_file_name" : "/home/hwangcc23/.i3/config",\r
1122    "minor" : 2,\r
1123    "patch" : 0,\r
1124    "major" : 4\r
1125 }</tt></pre>\r
1126 </div></div>\r
1127 </div>\r
1128 <div class="sect2">\r
1129 <h3 id="_binding_modes_reply">3.10. BINDING_MODES reply</h3>\r
1130 <div class="paragraph"><p>The reply consists of an array of all currently configured binding modes.</p></div>\r
1131 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
1132 <div class="listingblock">\r
1133 <div class="content">\r
1134 <pre><tt>["default", "resize"]</tt></pre>\r
1135 </div></div>\r
1136 </div>\r
1137 </div>\r
1138 </div>\r
1139 <div class="sect1">\r
1140 <h2 id="_events">4. Events</h2>\r
1141 <div class="sectionbody">\r
1142 <div class="paragraph" id="events"><p>To get informed when certain things happen in i3, clients can subscribe to\r
1143 events. Events consist of a name (like "workspace") and an event reply type\r
1144 (like I3_IPC_EVENT_WORKSPACE). The events sent by i3 are in the same format\r
1145 as replies to specific commands. However, the highest bit of the message type\r
1146 is set to 1 to indicate that this is an event reply instead of a normal reply.</p></div>\r
1147 <div class="paragraph"><p>Caveat: As soon as you subscribe to an event, it is not guaranteed any longer\r
1148 that the requests to i3 are processed in order. This means, the following\r
1149 situation can happen: You send a GET_WORKSPACES request but you receive a\r
1150 "workspace" event before receiving the reply to GET_WORKSPACES. If your\r
1151 program does not want to cope which such kinds of race conditions (an\r
1152 event based library may not have a problem here), I suggest you create a\r
1153 separate connection to receive events.</p></div>\r
1154 <div class="sect2">\r
1155 <h3 id="_subscribing_to_events">4.1. Subscribing to events</h3>\r
1156 <div class="paragraph"><p>By sending a message of type SUBSCRIBE with a JSON-encoded array as payload\r
1157 you can register to an event.</p></div>\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>type: SUBSCRIBE\r
1162 payload: [ "workspace", "output" ]</tt></pre>\r
1163 </div></div>\r
1164 </div>\r
1165 <div class="sect2">\r
1166 <h3 id="_available_events">4.2. Available events</h3>\r
1167 <div class="paragraph"><p>The numbers in parenthesis is the event type (keep in mind that you need to\r
1168 strip the highest bit first).</p></div>\r
1169 <div class="dlist"><dl>\r
1170 <dt class="hdlist1">\r
1171 workspace (0)\r
1172 </dt>\r
1173 <dd>\r
1174 <p>\r
1175         Sent when the user switches to a different workspace, when a new\r
1176         workspace is initialized or when a workspace is removed (because the\r
1177         last client vanished).\r
1178 </p>\r
1179 </dd>\r
1180 <dt class="hdlist1">\r
1181 output (1)\r
1182 </dt>\r
1183 <dd>\r
1184 <p>\r
1185         Sent when RandR issues a change notification (of either screens,\r
1186         outputs, CRTCs or output properties).\r
1187 </p>\r
1188 </dd>\r
1189 <dt class="hdlist1">\r
1190 mode (2)\r
1191 </dt>\r
1192 <dd>\r
1193 <p>\r
1194         Sent whenever i3 changes its binding mode.\r
1195 </p>\r
1196 </dd>\r
1197 <dt class="hdlist1">\r
1198 window (3)\r
1199 </dt>\r
1200 <dd>\r
1201 <p>\r
1202         Sent when a client&#8217;s window is successfully reparented (that is when i3\r
1203         has finished fitting it into a container), when a window received input\r
1204         focus or when certain properties of the window have changed.\r
1205 </p>\r
1206 </dd>\r
1207 <dt class="hdlist1">\r
1208 barconfig_update (4)\r
1209 </dt>\r
1210 <dd>\r
1211 <p>\r
1212     Sent when the hidden_state or mode field in the barconfig of any bar\r
1213     instance was updated and when the config is reloaded.\r
1214 </p>\r
1215 </dd>\r
1216 <dt class="hdlist1">\r
1217 binding (5)\r
1218 </dt>\r
1219 <dd>\r
1220 <p>\r
1221         Sent when a configured command binding is triggered with the keyboard or\r
1222         mouse\r
1223 </p>\r
1224 </dd>\r
1225 </dl></div>\r
1226 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
1227 <div class="listingblock">\r
1228 <div class="content">\r
1229 <pre><tt># the appropriate 4 bytes read from the socket are stored in $input\r
1230 \r
1231 # unpack a 32-bit unsigned integer\r
1232 my $message_type = unpack("L", $input);\r
1233 \r
1234 # check if the highest bit is 1\r
1235 my $is_event = (($message_type &gt;&gt; 31) == 1);\r
1236 \r
1237 # use the other bits\r
1238 my $event_type = ($message_type &amp; 0x7F);\r
1239 \r
1240 if ($is_event) {\r
1241   say "Received event of type $event_type";\r
1242 }</tt></pre>\r
1243 </div></div>\r
1244 </div>\r
1245 <div class="sect2">\r
1246 <h3 id="_workspace_event">4.3. workspace event</h3>\r
1247 <div class="paragraph"><p>This event consists of a single serialized map containing a property\r
1248 <tt>change (string)</tt> which indicates the type of the change ("focus", "init",\r
1249 "empty", "urgent"). A <tt>current (object)</tt> property will be present with the\r
1250 affected workspace whenever the type of event affects a workspace (otherwise,\r
1251 it will be +null).</p></div>\r
1252 <div class="paragraph"><p>When the change is "focus", an <tt>old (object)</tt> property will be present with the\r
1253 previous workspace.  When the first switch occurs (when i3 focuses the\r
1254 workspace visible at the beginning) there is no previous workspace, and the\r
1255 <tt>old</tt> property will be set to <tt>null</tt>.  Also note that if the previous is empty\r
1256 it will get destroyed when switching, but will still be present in the "old"\r
1257 property.</p></div>\r
1258 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
1259 <div class="listingblock">\r
1260 <div class="content">\r
1261 <pre><tt>{\r
1262  "change": "focus",\r
1263  "current": {\r
1264   "id": 28489712,\r
1265   "type": "workspace",\r
1266   ...\r
1267  }\r
1268  "old": {\r
1269   "id": 28489715,\r
1270   "type": "workspace",\r
1271   ...\r
1272  }\r
1273 }</tt></pre>\r
1274 </div></div>\r
1275 </div>\r
1276 <div class="sect2">\r
1277 <h3 id="_output_event">4.4. output event</h3>\r
1278 <div class="paragraph"><p>This event consists of a single serialized map containing a property\r
1279 <tt>change (string)</tt> which indicates the type of the change (currently only\r
1280 "unspecified").</p></div>\r
1281 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
1282 <div class="listingblock">\r
1283 <div class="content">\r
1284 <pre><tt>{ "change": "unspecified" }</tt></pre>\r
1285 </div></div>\r
1286 </div>\r
1287 <div class="sect2">\r
1288 <h3 id="_mode_event">4.5. mode event</h3>\r
1289 <div class="paragraph"><p>This event consists of a single serialized map containing a property\r
1290 <tt>change (string)</tt> which holds the name of current mode in use. The name\r
1291 is the same as specified in config when creating a mode. The default\r
1292 mode is simply named default. It contains a second property, <tt>pango_markup</tt>, which\r
1293 defines whether pango markup shall be used for displaying this mode.</p></div>\r
1294 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
1295 <div class="listingblock">\r
1296 <div class="content">\r
1297 <pre><tt>{\r
1298   "change": "default",\r
1299   "pango_markup": true\r
1300 }</tt></pre>\r
1301 </div></div>\r
1302 </div>\r
1303 <div class="sect2">\r
1304 <h3 id="_window_event">4.6. window event</h3>\r
1305 <div class="paragraph"><p>This event consists of a single serialized map containing a property\r
1306 <tt>change (string)</tt> which indicates the type of the change</p></div>\r
1307 <div class="ulist"><ul>\r
1308 <li>\r
1309 <p>\r
1310 <tt>new</tt> – the window has become managed by i3\r
1311 </p>\r
1312 </li>\r
1313 <li>\r
1314 <p>\r
1315 <tt>close</tt> – the window has closed\r
1316 </p>\r
1317 </li>\r
1318 <li>\r
1319 <p>\r
1320 <tt>focus</tt> – the window has received input focus\r
1321 </p>\r
1322 </li>\r
1323 <li>\r
1324 <p>\r
1325 <tt>title</tt> – the window&#8217;s title has changed\r
1326 </p>\r
1327 </li>\r
1328 <li>\r
1329 <p>\r
1330 <tt>fullscreen_mode</tt> – the window has entered or exited fullscreen mode\r
1331 </p>\r
1332 </li>\r
1333 <li>\r
1334 <p>\r
1335 <tt>move</tt> – the window has changed its position in the tree\r
1336 </p>\r
1337 </li>\r
1338 <li>\r
1339 <p>\r
1340 <tt>floating</tt> – the window has transitioned to or from floating\r
1341 </p>\r
1342 </li>\r
1343 <li>\r
1344 <p>\r
1345 <tt>urgent</tt> – the window has become urgent or lost its urgent status\r
1346 </p>\r
1347 </li>\r
1348 <li>\r
1349 <p>\r
1350 <tt>mark</tt> – a mark has been added to or removed from the window\r
1351 </p>\r
1352 </li>\r
1353 </ul></div>\r
1354 <div class="paragraph"><p>Additionally a <tt>container (object)</tt> field will be present, which consists\r
1355 of the window&#8217;s parent container. Be aware that for the "new" event, the\r
1356 container will hold the initial name of the newly reparented window (e.g.\r
1357 if you run urxvt with a shell that changes the title, you will still at\r
1358 this point get the window title as "urxvt").</p></div>\r
1359 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
1360 <div class="listingblock">\r
1361 <div class="content">\r
1362 <pre><tt>{\r
1363  "change": "new",\r
1364  "container": {\r
1365   "id": 35569536,\r
1366   "type": "con",\r
1367   ...\r
1368  }\r
1369 }</tt></pre>\r
1370 </div></div>\r
1371 </div>\r
1372 <div class="sect2">\r
1373 <h3 id="_barconfig_update_event">4.7. barconfig_update event</h3>\r
1374 <div class="paragraph"><p>This event consists of a single serialized map reporting on options from the\r
1375 barconfig of the specified bar_id that were updated in i3. This event is the\r
1376 same as a <tt>GET_BAR_CONFIG</tt> reply for the bar with the given id.</p></div>\r
1377 </div>\r
1378 <div class="sect2">\r
1379 <h3 id="_binding_event">4.8. binding event</h3>\r
1380 <div class="paragraph"><p>This event consists of a single serialized map reporting on the details of a\r
1381 binding that ran a command because of user input. The <tt>change (sring)</tt> field\r
1382 indicates what sort of binding event was triggered (right now it will always be\r
1383 <tt>"run"</tt> but may be expanded in the future).</p></div>\r
1384 <div class="paragraph"><p>The <tt>binding (object)</tt> field contains details about the binding that was run:</p></div>\r
1385 <div class="dlist"><dl>\r
1386 <dt class="hdlist1">\r
1387 command (string)\r
1388 </dt>\r
1389 <dd>\r
1390 <p>\r
1391         The i3 command that is configured to run for this binding.\r
1392 </p>\r
1393 </dd>\r
1394 <dt class="hdlist1">\r
1395 event_state_mask (array of strings)\r
1396 </dt>\r
1397 <dd>\r
1398 <p>\r
1399         The group and modifier keys that were configured with this binding.\r
1400 </p>\r
1401 </dd>\r
1402 <dt class="hdlist1">\r
1403 input_code (integer)\r
1404 </dt>\r
1405 <dd>\r
1406 <p>\r
1407         If the binding was configured with <tt>bindcode</tt>, this will be the key code\r
1408         that was given for the binding. If the binding is a mouse binding, it will be\r
1409         the number of the mouse button that was pressed. Otherwise it will be 0.\r
1410 </p>\r
1411 </dd>\r
1412 <dt class="hdlist1">\r
1413 symbol (string or null)\r
1414 </dt>\r
1415 <dd>\r
1416 <p>\r
1417         If this is a keyboard binding that was configured with <tt>bindsym</tt>, this\r
1418         field will contain the given symbol. Otherwise it will be <tt>null</tt>.\r
1419 </p>\r
1420 </dd>\r
1421 <dt class="hdlist1">\r
1422 input_type (string)\r
1423 </dt>\r
1424 <dd>\r
1425 <p>\r
1426         This will be <tt>"keyboard"</tt> or <tt>"mouse"</tt> depending on whether or not this was\r
1427         a keyboard or a mouse binding.\r
1428 </p>\r
1429 </dd>\r
1430 </dl></div>\r
1431 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
1432 <div class="listingblock">\r
1433 <div class="content">\r
1434 <pre><tt>{\r
1435  "change": "run",\r
1436  "binding": {\r
1437   "command": "nop",\r
1438   "event_state_mask": [\r
1439     "shift",\r
1440     "ctrl"\r
1441   ],\r
1442   "input_code": 0,\r
1443   "symbol": "t",\r
1444   "input_type": "keyboard"\r
1445  }\r
1446 }</tt></pre>\r
1447 </div></div>\r
1448 </div>\r
1449 </div>\r
1450 </div>\r
1451 <div class="sect1">\r
1452 <h2 id="_see_also_existing_libraries">5. See also (existing libraries)</h2>\r
1453 <div class="sectionbody">\r
1454 <div class="paragraph" id="libraries"><p>For some languages, libraries are available (so you don’t have to implement\r
1455 all this on your own). This list names some (if you wrote one, please let me\r
1456 know):</p></div>\r
1457 <div class="dlist"><dl>\r
1458 <dt class="hdlist1">\r
1459 C\r
1460 </dt>\r
1461 <dd>\r
1462 <div class="ulist"><ul>\r
1463 <li>\r
1464 <p>\r
1465 i3 includes a headerfile <tt>i3/ipc.h</tt> which provides you all constants.\r
1466 </p>\r
1467 </li>\r
1468 <li>\r
1469 <p>\r
1470 <a href="https://github.com/acrisci/i3ipc-glib">https://github.com/acrisci/i3ipc-glib</a>\r
1471 </p>\r
1472 </li>\r
1473 </ul></div>\r
1474 </dd>\r
1475 <dt class="hdlist1">\r
1476 C++\r
1477 </dt>\r
1478 <dd>\r
1479 <div class="ulist"><ul>\r
1480 <li>\r
1481 <p>\r
1482 <a href="https://github.com/drmgc/i3ipcpp">https://github.com/drmgc/i3ipcpp</a>\r
1483 </p>\r
1484 </li>\r
1485 </ul></div>\r
1486 </dd>\r
1487 <dt class="hdlist1">\r
1488 Go\r
1489 </dt>\r
1490 <dd>\r
1491 <div class="ulist"><ul>\r
1492 <li>\r
1493 <p>\r
1494 <a href="https://github.com/proxypoke/i3ipc">https://github.com/proxypoke/i3ipc</a>\r
1495 </p>\r
1496 </li>\r
1497 </ul></div>\r
1498 </dd>\r
1499 <dt class="hdlist1">\r
1500 JavaScript\r
1501 </dt>\r
1502 <dd>\r
1503 <div class="ulist"><ul>\r
1504 <li>\r
1505 <p>\r
1506 <a href="https://github.com/acrisci/i3ipc-gjs">https://github.com/acrisci/i3ipc-gjs</a>\r
1507 </p>\r
1508 </li>\r
1509 </ul></div>\r
1510 </dd>\r
1511 <dt class="hdlist1">\r
1512 Lua\r
1513 </dt>\r
1514 <dd>\r
1515 <div class="ulist"><ul>\r
1516 <li>\r
1517 <p>\r
1518 <a href="https://github.com/acrisci/i3ipc-lua">https://github.com/acrisci/i3ipc-lua</a>\r
1519 </p>\r
1520 </li>\r
1521 </ul></div>\r
1522 </dd>\r
1523 <dt class="hdlist1">\r
1524 Perl\r
1525 </dt>\r
1526 <dd>\r
1527 <div class="ulist"><ul>\r
1528 <li>\r
1529 <p>\r
1530 <a href="https://metacpan.org/module/AnyEvent::I3">https://metacpan.org/module/AnyEvent::I3</a>\r
1531 </p>\r
1532 </li>\r
1533 </ul></div>\r
1534 </dd>\r
1535 <dt class="hdlist1">\r
1536 Python\r
1537 </dt>\r
1538 <dd>\r
1539 <div class="ulist"><ul>\r
1540 <li>\r
1541 <p>\r
1542 <a href="https://github.com/acrisci/i3ipc-python">https://github.com/acrisci/i3ipc-python</a>\r
1543 </p>\r
1544 </li>\r
1545 <li>\r
1546 <p>\r
1547 <a href="https://github.com/whitelynx/i3ipc">https://github.com/whitelynx/i3ipc</a> (not maintained)\r
1548 </p>\r
1549 </li>\r
1550 <li>\r
1551 <p>\r
1552 <a href="https://github.com/ziberna/i3-py">https://github.com/ziberna/i3-py</a> (not maintained)\r
1553 </p>\r
1554 </li>\r
1555 </ul></div>\r
1556 </dd>\r
1557 <dt class="hdlist1">\r
1558 Ruby\r
1559 </dt>\r
1560 <dd>\r
1561 <div class="ulist"><ul>\r
1562 <li>\r
1563 <p>\r
1564 <a href="https://github.com/veelenga/i3ipc-ruby">https://github.com/veelenga/i3ipc-ruby</a>\r
1565 </p>\r
1566 </li>\r
1567 <li>\r
1568 <p>\r
1569 <a href="https://github.com/badboy/i3-ipc">https://github.com/badboy/i3-ipc</a> (not maintained)\r
1570 </p>\r
1571 </li>\r
1572 </ul></div>\r
1573 </dd>\r
1574 <dt class="hdlist1">\r
1575 Rust\r
1576 </dt>\r
1577 <dd>\r
1578 <div class="ulist"><ul>\r
1579 <li>\r
1580 <p>\r
1581 <a href="https://github.com/tmerr/i3ipc-rs">https://github.com/tmerr/i3ipc-rs</a>\r
1582 </p>\r
1583 </li>\r
1584 </ul></div>\r
1585 </dd>\r
1586 </dl></div>\r
1587 </div>\r
1588 </div>\r
1589 </div>\r
1590 <div id="footnotes"><hr /></div>\r
1591 <div id="footer" lang="de">\r
1592 © 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>\r
1593 </div>\r
1594 </body>\r
1595 </html>\r