]> git.sur5r.net Git - i3/i3.github.io/blobdiff - docs/ipc.html
update docs for 4.13
[i3/i3.github.io] / docs / ipc.html
index a616b4ac7ac8db538c8b9c4213332305b2baa69c..39f6182959aa8b4e95e8ae52e7dfb05daaaf683e 100644 (file)
@@ -22,7 +22,7 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a
                         <ul id="nav">\r
                                 <li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>\r
                                 <li><a href="/screenshots">Screens</a></li>\r
-                                <li><a href="https://faq.i3wm.org/">FAQ</a></li>\r
+                                <li><a href="https://www.reddit.com/r/i3wm/">FAQ</a></li>\r
                                 <li><a href="/contact">Contact</a></li>\r
                                 <li><a href="https://github.com/i3/i3/issues">Bugs</a></li>\r
                         </ul>\r
@@ -170,6 +170,14 @@ GET_VERSION (7)
         with the major, minor, patch and human-readable version.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+GET_BINDING_MODES (8)\r
+</dt>\r
+<dd>\r
+<p>\r
+        Gets a list of currently configured binding modes.\r
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p>So, a typical message could look like this:</p></div>\r
 <div class="listingblock">\r
@@ -276,6 +284,14 @@ VERSION (7)
         Reply to the GET_VERSION message.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+BINDING_MODES (8)\r
+</dt>\r
+<dd>\r
+<p>\r
+        Reply to the GET_BINDING_MODES message.\r
+</p>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 <div class="sect2">\r
@@ -515,7 +531,7 @@ border (string)
 </dt>\r
 <dd>\r
 <p>\r
-        Can be either "normal", "none" or "1pixel", dependending on the\r
+        Can be either "normal", "none" or "pixel", depending on the\r
         container’s border style.\r
 </p>\r
 </dd>\r
@@ -947,44 +963,78 @@ separator
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
-focused_workspace_text/focused_workspace_bg\r
+focused_background\r
+</dt>\r
+<dd>\r
+<p>\r
+        Background color of the bar on the currently focused monitor output.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+focused_statusline\r
 </dt>\r
 <dd>\r
 <p>\r
-        Text color/background color for a workspace button when the workspace\r
+        Text color to be used for the statusline on the currently focused\r
+        monitor output.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+focused_separator\r
+</dt>\r
+<dd>\r
+<p>\r
+        Text color to be used for the separator on the currently focused\r
+        monitor output.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+focused_workspace_text/focused_workspace_bg/focused_workspace_border\r
+</dt>\r
+<dd>\r
+<p>\r
+        Text/background/border color for a workspace button when the workspace\r
         has focus.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
-active_workspace_text/active_workspace_bg\r
+active_workspace_text/active_workspace_bg/active_workspace_border\r
 </dt>\r
 <dd>\r
 <p>\r
-        Text color/background color for a workspace button when the workspace\r
+        Text/background/border color for a workspace button when the workspace\r
         is active (visible) on some output, but the focus is on another one.\r
         You can only tell this apart from the focused workspace when you are\r
         using multiple monitors.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
-inactive_workspace_text/inactive_workspace_bg\r
+inactive_workspace_text/inactive_workspace_bg/inactive_workspace_border\r
 </dt>\r
 <dd>\r
 <p>\r
-        Text color/background color for a workspace button when the workspace\r
+        Text/background/border color for a workspace button when the workspace\r
         does not have focus and is not active (visible) on any output. This\r
         will be the case for most workspaces.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
-urgent_workspace_text/urgent_workspace_bar\r
+urgent_workspace_text/urgent_workspace_bg/urgent_workspace_border\r
 </dt>\r
 <dd>\r
 <p>\r
-        Text color/background color for workspaces which contain at least one\r
+        Text/background/border color for workspaces which contain at least one\r
         window with the urgency hint set.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+binding_mode_text/binding_mode_bg/binding_mode_border\r
+</dt>\r
+<dd>\r
+<p>\r
+        Text/background/border color for the binding mode indicator.\r
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p><strong>Example of configured bars:</strong></p></div>\r
 <div class="listingblock">\r
@@ -1054,18 +1104,36 @@ human_readable (string)
         this is what <tt>i3 --version</tt> displays, too).\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+loaded_config_file_name (string)\r
+</dt>\r
+<dd>\r
+<p>\r
+        The current config path.\r
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>{\r
    "human_readable" : "4.2-169-gf80b877 (2012-08-05, branch \"next\")",\r
+   "loaded_config_file_name" : "/home/hwangcc23/.i3/config",\r
    "minor" : 2,\r
    "patch" : 0,\r
    "major" : 4\r
 }</tt></pre>\r
 </div></div>\r
 </div>\r
+<div class="sect2">\r
+<h3 id="_binding_modes_reply">3.10. BINDING_MODES reply</h3>\r
+<div class="paragraph"><p>The reply consists of an array of all currently configured binding modes.</p></div>\r
+<div class="paragraph"><p><strong>Example:</strong></p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>["default", "resize"]</tt></pre>\r
+</div></div>\r
+</div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -1221,11 +1289,15 @@ property.</p></div>
 <div class="paragraph"><p>This event consists of a single serialized map containing a property\r
 <tt>change (string)</tt> which holds the name of current mode in use. The name\r
 is the same as specified in config when creating a mode. The default\r
-mode is simply named default.</p></div>\r
+mode is simply named default. It contains a second property, <tt>pango_markup</tt>, which\r
+defines whether pango markup shall be used for displaying this mode.</p></div>\r
 <div class="paragraph"><p><strong>Example:</strong></p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>{ "change": "default" }</tt></pre>\r
+<pre><tt>{\r
+  "change": "default",\r
+  "pango_markup": true\r
+}</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -1235,42 +1307,47 @@ mode is simply named default.</p></div>
 <div class="ulist"><ul>\r
 <li>\r
 <p>\r
-<tt>new</tt> - the window has become managed by i3\r
+<tt>new</tt> – the window has become managed by i3\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<tt>close</tt> – the window has closed\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-<tt>close</tt> - the window has closed\r
+<tt>focus</tt> – the window has received input focus\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-<tt>focus</tt> - the window has received input focus\r
+<tt>title</tt> – the window&#8217;s title has changed\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-<tt>title</tt> - the window&#8217;s title has changed\r
+<tt>fullscreen_mode</tt> – the window has entered or exited fullscreen mode\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-<tt>fullscreen_mode</tt> - the window has entered or exited fullscreen mode\r
+<tt>move</tt> – the window has changed its position in the tree\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-<tt>move</tt> - the window has changed its position in the tree\r
+<tt>floating</tt> – the window has transitioned to or from floating\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-<tt>floating</tt> - the window has transitioned to or from floating\r
+<tt>urgent</tt> – the window has become urgent or lost its urgent status\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-<tt>urgent</tt> - the window has become urgent or lost its urgent status\r
+<tt>mark</tt> – a mark has been added to or removed from the window\r
 </p>\r
 </li>\r
 </ul></div>\r
@@ -1315,11 +1392,11 @@ command (string)
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
-mods (array of strings)\r
+event_state_mask (array of strings)\r
 </dt>\r
 <dd>\r
 <p>\r
-        The modifier keys that were configured with this binding.\r
+        The group and modifier keys that were configured with this binding.\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
@@ -1358,7 +1435,7 @@ input_type (string)
  "change": "run",\r
  "binding": {\r
   "command": "nop",\r
-  "mods": [\r
+  "event_state_mask": [\r
     "shift",\r
     "ctrl"\r
   ],\r
@@ -1396,6 +1473,18 @@ i3 includes a headerfile <tt>i3/ipc.h</tt> which provides you all constants.
 </ul></div>\r
 </dd>\r
 <dt class="hdlist1">\r
+C++\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://github.com/drmgc/i3ipcpp">https://github.com/drmgc/i3ipcpp</a>\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
+<dt class="hdlist1">\r
 Go\r
 </dt>\r
 <dd>\r
@@ -1472,7 +1561,24 @@ Ruby
 <div class="ulist"><ul>\r
 <li>\r
 <p>\r
-<a href="http://github.com/badboy/i3-ipc">http://github.com/badboy/i3-ipc</a>\r
+<a href="https://github.com/veelenga/i3ipc-ruby">https://github.com/veelenga/i3ipc-ruby</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="https://github.com/badboy/i3-ipc">https://github.com/badboy/i3-ipc</a> (not maintained)\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+Rust\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://github.com/tmerr/i3ipc-rs">https://github.com/tmerr/i3ipc-rs</a>\r
 </p>\r
 </li>\r
 </ul></div>\r