"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<head>\r
-<link rel="icon" type="image/png" href="/favicon.png">\r
+<link rel="icon" type="image/x-icon" href="/favicon.ico">\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
<meta name="generator" content="AsciiDoc 8.6.9" />\r
<title>i3: IPC interface (interprocess communication)</title>\r
<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://www.reddit.com/r/i3wm/">FAQ</a></li>\r
<li><a href="/contact">Contact</a></li>\r
- <li><a href="http://bugs.i3wm.org/">Bugs</a></li>\r
+ <li><a href="https://github.com/i3/i3/issues">Bugs</a></li>\r
</ul>\r
<br style="clear: both">\r
<div id="content">\r
<h1>IPC interface (interprocess communication)</h1>\r
<span id="author">Michael Stapelberg</span><br />\r
<span id="email"><tt><<a href="mailto:michael@i3wm.org">michael@i3wm.org</a>></tt></span><br />\r
-<span id="revdate">February 2014</span>\r
+<span id="revdate">October 2014</span>\r
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
<dd>\r
<p>\r
The logical number of the workspace. Corresponds to the command\r
- to switch to this workspace.\r
+ to switch to this workspace. For named workspaces, this will be -1.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
+deco_rect (map)\r
+</dt>\r
+<dd>\r
+<p>\r
+ The coordinates of the <strong>window decoration</strong> inside its container. These\r
+ coordinates are relative to the container and do not include the actual\r
+ client window.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
geometry (map)\r
</dt>\r
<dd>\r
</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 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/background color for a workspace button when the workspace\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
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
<div class="listingblock">\r
<div class="content">\r
<pre><tt>type: SUBSCRIBE\r
-payload: [ "workspace", "focus" ]</tt></pre>\r
+payload: [ "workspace", "output" ]</tt></pre>\r
</div></div>\r
</div>\r
<div class="sect2">\r
instance was updated and when the config is reloaded.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+binding (5)\r
+</dt>\r
+<dd>\r
+<p>\r
+ Sent when a configured command binding is triggered with the keyboard or\r
+ mouse\r
+</p>\r
+</dd>\r
</dl></div>\r
<div class="paragraph"><p><strong>Example:</strong></p></div>\r
<div class="listingblock">\r
<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").</p></div>\r
-<div class="paragraph"><p>Moreover, when the change is "focus", an <tt>old (object)</tt> and a <tt>current\r
-(object)</tt> properties will be present with the previous and current\r
-workspace respectively. When the first switch occurs (when i3 focuses\r
-the workspace visible at the beginning) there is no previous\r
-workspace, and the <tt>old</tt> property will be set to <tt>null</tt>. Also note\r
-that if the previous is empty it will get destroyed when switching,\r
-but will still be present in the "old" property.</p></div>\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
+<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
+<tt>old</tt> property will be set to <tt>null</tt>. Also note that if the previous is empty\r
+it will get destroyed when switching, but will still be present in the "old"\r
+property.</p></div>\r
<div class="paragraph"><p><strong>Example:</strong></p></div>\r
<div class="listingblock">\r
<div class="content">\r
<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
</li>\r
<li>\r
<p>\r
+<tt>close</tt> - the window has closed\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
<tt>focus</tt> - the window has received input focus\r
</p>\r
</li>\r
<tt>fullscreen_mode</tt> - the window has entered or exited fullscreen mode\r
</p>\r
</li>\r
+<li>\r
+<p>\r
+<tt>move</tt> - the window has changed its position in the tree\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<tt>floating</tt> - the window has transitioned to or from floating\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<tt>urgent</tt> - the window has become urgent or lost its urgent status\r
+</p>\r
+</li>\r
</ul></div>\r
<div class="paragraph"><p>Additionally a <tt>container (object)</tt> field will be present, which consists\r
of the window’s parent container. Be aware that for the "new" event, the\r
barconfig of the specified bar_id that were updated in i3. This event is the\r
same as a <tt>GET_BAR_CONFIG</tt> reply for the bar with the given id.</p></div>\r
</div>\r
+<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
+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
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+command (string)\r
+</dt>\r
+<dd>\r
+<p>\r
+ The i3 command that is configured to run for this binding.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+event_state_mask (array of strings)\r
+</dt>\r
+<dd>\r
+<p>\r
+ The group and modifier keys that were configured with this binding.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+input_code (integer)\r
+</dt>\r
+<dd>\r
+<p>\r
+ If the binding was configured with <tt>bindcode</tt>, this will be the key code\r
+ that was given for the binding. If the binding is a mouse binding, it will be\r
+ the number of the mouse button that was pressed. Otherwise it will be 0.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+symbol (string or null)\r
+</dt>\r
+<dd>\r
+<p>\r
+ If this is a keyboard binding that was configured with <tt>bindsym</tt>, this\r
+ field will contain the given symbol. Otherwise it will be <tt>null</tt>.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+input_type (string)\r
+</dt>\r
+<dd>\r
+<p>\r
+ This will be <tt>"keyboard"</tt> or <tt>"mouse"</tt> depending on whether or not this was\r
+ a keyboard or a mouse binding.\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
+ "change": "run",\r
+ "binding": {\r
+ "command": "nop",\r
+ "event_state_mask": [\r
+ "shift",\r
+ "ctrl"\r
+ ],\r
+ "input_code": 0,\r
+ "symbol": "t",\r
+ "input_type": "keyboard"\r
+ }\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
</div>\r
</div>\r
<div class="sect1">\r
C\r
</dt>\r
<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
<p>\r
- i3 includes a headerfile <tt>i3/ipc.h</tt> which provides you all constants.\r
+i3 includes a headerfile <tt>i3/ipc.h</tt> which provides you all constants.\r
</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt> https://github.com/acrisci/i3ipc-glib\r
-Go::\r
- * https://github.com/proxypoke/i3ipc\r
-JavaScript::\r
- * https://github.com/acrisci/i3ipc-gjs\r
-Lua::\r
- * https:/github.com/acrisci/i3ipc-lua\r
-Perl::\r
- * https://metacpan.org/module/AnyEvent::I3\r
-Python::\r
- * https://github.com/acrisci/i3ipc-python\r
- * https://github.com/whitelynx/i3ipc (not maintained)\r
- * https://github.com/ziberna/i3-py (not maintained)\r
-Ruby::\r
- http://github.com/badboy/i3-ipc</tt></pre>\r
-</div></div>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="https://github.com/acrisci/i3ipc-glib">https://github.com/acrisci/i3ipc-glib</a>\r
+</p>\r
+</li>\r
+</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
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://github.com/proxypoke/i3ipc">https://github.com/proxypoke/i3ipc</a>\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+JavaScript\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://github.com/acrisci/i3ipc-gjs">https://github.com/acrisci/i3ipc-gjs</a>\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+Lua\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://github.com/acrisci/i3ipc-lua">https://github.com/acrisci/i3ipc-lua</a>\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+Perl\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://metacpan.org/module/AnyEvent::I3">https://metacpan.org/module/AnyEvent::I3</a>\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+Python\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+<a href="https://github.com/acrisci/i3ipc-python">https://github.com/acrisci/i3ipc-python</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="https://github.com/whitelynx/i3ipc">https://github.com/whitelynx/i3ipc</a> (not maintained)\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="https://github.com/ziberna/i3-py">https://github.com/ziberna/i3-py</a> (not maintained)\r
+</p>\r
+</li>\r
+</ul></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+Ruby\r
+</dt>\r
+<dd>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\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
</dd>\r
</dl></div>\r
</div>\r
projects / i3 / i3.github.io / blobdiff