i3-msg: add support for SUBSCRIBE message type

[i3/i3] / man / i3-msg.man

diff --git a/man/i3-msg.man b/man/i3-msg.man
index 000d9bf2026ae79c61fef6f1e06c4747cf1d285b..625131de5855f16cac7b4fc10aeef881c5ef656f 100644 (file)
--- a/man/i3-msg.man
+++ b/man/i3-msg.man
@@ -31,6 +31,11 @@ with an error.
 *-t* 'type'::
 Send ipc message, see below. This option defaults to "command".
 
 *-t* 'type'::
 Send ipc message, see below. This option defaults to "command".
 

+*-m*, *--monitor*::
+Instead of exiting right after receiving the first subscribed event,
+wait indefinitely for all of them. Can only be used with "-t subscribe".
+See the "subscribe" IPC message type below for details.
+

 *message*::
 Send ipc message, see below.
 
 *message*::
 Send ipc message, see below.
 


@@ -48,7 +53,7 @@ workspaces.
 get_outputs::
 Gets the current outputs. The reply will be a JSON-encoded list of outputs (see
 the reply section of docs/ipc, e.g. at
 get_outputs::
 Gets the current outputs. The reply will be a JSON-encoded list of outputs (see
 the reply section of docs/ipc, e.g. at

-http://i3wm.org/docs/ipc.html#_receiving_replies_from_i3).
+https://i3wm.org/docs/ipc.html#_receiving_replies_from_i3).

 
 get_tree::
 Gets the layout tree. i3 uses a tree as data structure which includes every
 
 get_tree::
 Gets the layout tree. i3 uses a tree as data structure which includes every


@@ -62,10 +67,24 @@ get_bar_config::
 Gets the configuration (as JSON map) of the workspace bar with the given ID. If
 no ID is provided, an array with all configured bar IDs is returned instead.
 
 Gets the configuration (as JSON map) of the workspace bar with the given ID. If
 no ID is provided, an array with all configured bar IDs is returned instead.
 

+get_binding_modes::
+Gets a list of configured binding modes.
+

 get_version::
 Gets the version of i3. The reply will be a JSON-encoded dictionary with the
 major, minor, patch and human-readable version.
 
 get_version::
 Gets the version of i3. The reply will be a JSON-encoded dictionary with the
 major, minor, patch and human-readable version.
 

+get_config::
+Gets the currently loaded i3 configuration.
+
+send_tick::
+Sends a tick to all IPC connections which subscribe to tick events.
+
+subscribe::
+The payload of the message describes the events to subscribe to.
+Upon reception, each event will be dumped as a JSON-encoded object.
+See the -m option for continuous monitoring.
+

 == DESCRIPTION
 
 i3-msg is a sample implementation for a client using the unix socket IPC
 == DESCRIPTION
 
 i3-msg is a sample implementation for a client using the unix socket IPC


@@ -82,6 +101,9 @@ i3-msg border normal
 
 # Dump the layout tree
 i3-msg -t get_tree
 
 # Dump the layout tree
 i3-msg -t get_tree

+
+# Monitor window changes
+i3-msg -t subscribe -m '[ "window" ]'

 ------------------------------------------------
 
 == ENVIRONMENT
 ------------------------------------------------
 
 == ENVIRONMENT