X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=man%2Fi3-msg.man;h=625131de5855f16cac7b4fc10aeef881c5ef656f;hb=refs%2Fpull%2F3435%2Fhead;hp=911fc995c47bd1b7acaddecaa428fe1d7b895118;hpb=6582da993948c392daeaf4be018546e9186effb0;p=i3%2Fi3 diff --git a/man/i3-msg.man b/man/i3-msg.man index 911fc995..625131de 100644 --- a/man/i3-msg.man +++ b/man/i3-msg.man @@ -29,7 +29,12 @@ from the root window and then try /tmp/i3-ipc.sock before exiting with an error. *-t* 'type':: -Send ipc message, see below. +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. @@ -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 -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 @@ -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. +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_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 @@ -82,6 +101,9 @@ i3-msg border normal # Dump the layout tree i3-msg -t get_tree + +# Monitor window changes +i3-msg -t subscribe -m '[ "window" ]' ------------------------------------------------ == ENVIRONMENT @@ -89,7 +111,7 @@ i3-msg -t get_tree === I3SOCK If no ipc-socket is specified on the commandline, this variable is used -to determine the path, at wich the unix domain socket is expected, on which +to determine the path, at which the unix domain socket is expected, on which to connect to i3. == SEE ALSO