]> git.sur5r.net Git - i3/i3.github.io/blobdiff - docs/ipc.html
update docs for 4.14
[i3/i3.github.io] / docs / ipc.html
index 39f6182959aa8b4e95e8ae52e7dfb05daaaf683e..8780aed6288127da18d055d4189f1a0189456c85 100644 (file)
@@ -440,6 +440,14 @@ active (boolean)
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+primary (boolean)\r
+</dt>\r
+<dd>\r
+<p>\r
+        Whether this output is currently the primary output.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 current_workspace (string)\r
 </dt>\r
 <dd>\r
@@ -482,7 +490,7 @@ rect (map)
    "y": 0,\r
    "width": 1280,\r
    "height": 1024\r
-  },\r
+  }\r
  }\r
 ]</tt></pre>\r
 </div></div>\r
@@ -746,7 +754,7 @@ VGA1
          "y": 0,\r
          "width": 1280,\r
          "height": 0\r
-       },\r
+       }\r
       },\r
 \r
       {\r
@@ -1222,6 +1230,14 @@ binding (5)
         mouse\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+shutdown (6)\r
+</dt>\r
+<dd>\r
+<p>\r
+        Sent when the ipc shuts down because of a restart or exit by user command\r
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 <div class="listingblock">\r
@@ -1246,9 +1262,9 @@ if ($is_event) {
 <h3 id="_workspace_event">4.3. workspace event</h3>\r
 <div class="paragraph"><p>This event consists of a single serialized map containing a property\r
 <tt>change (string)</tt> which indicates the type of the change ("focus", "init",\r
-"empty", "urgent"). A <tt>current (object)</tt> property will be present with the\r
-affected workspace whenever the type of event affects a workspace (otherwise,\r
-it will be +null).</p></div>\r
+"empty", "urgent", "reload", "rename", "restored", "move"). A\r
+<tt>current (object)</tt> property will be present with the affected workspace\r
+whenever the type of event affects a workspace (otherwise, it will be +null).</p></div>\r
 <div class="paragraph"><p>When the change is "focus", an <tt>old (object)</tt> property will be present with the\r
 previous workspace.  When the first switch occurs (when i3 focuses the\r
 workspace visible at the beginning) there is no previous workspace, and the\r
@@ -1378,7 +1394,7 @@ same as a <tt>GET_BAR_CONFIG</tt> reply for the bar with the given id.</p></div>
 <div class="sect2">\r
 <h3 id="_binding_event">4.8. binding event</h3>\r
 <div class="paragraph"><p>This event consists of a single serialized map reporting on the details of a\r
-binding that ran a command because of user input. The <tt>change (sring)</tt> field\r
+binding that ran a command because of user input. The <tt>change (string)</tt> field\r
 indicates what sort of binding event was triggered (right now it will always be\r
 <tt>"run"</tt> but may be expanded in the future).</p></div>\r
 <div class="paragraph"><p>The <tt>binding (object)</tt> field contains details about the binding that was run:</p></div>\r
@@ -1446,6 +1462,20 @@ input_type (string)
 }</tt></pre>\r
 </div></div>\r
 </div>\r
+<div class="sect2">\r
+<h3 id="_shutdown_event">4.9. shutdown event</h3>\r
+<div class="paragraph"><p>This event is triggered when the connection to the ipc is about to shutdown\r
+because of a user action such as a <tt>restart</tt> or <tt>exit</tt> command. The <tt>change\r
+(string)</tt> field indicates why the ipc is shutting down. It can be either\r
+<tt>"restart"</tt> or <tt>"exit"</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Example:</strong></p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>{\r
+ "change": "restart"\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -1491,7 +1521,7 @@ Go
 <div class="ulist"><ul>\r
 <li>\r
 <p>\r
-<a href="https://github.com/proxypoke/i3ipc">https://github.com/proxypoke/i3ipc</a>\r
+<a href="https://github.com/mdirkse/i3ipc-go">https://github.com/mdirkse/i3ipc-go</a>\r
 </p>\r
 </li>\r
 </ul></div>\r
@@ -1583,6 +1613,18 @@ Rust
 </li>\r
 </ul></div>\r
 </dd>\r
+<dt class="hdlist1">\r
+OCaml\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://github.com/Armael/ocaml-i3ipc">https://github.com/Armael/ocaml-i3ipc</a>\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 </div>\r