3 Michael Stapelberg <michael@i3wm.org>
8 i3-msg - send messages to i3 window manager
12 i3-msg [-q] [-v] [-h] [-s socket] [-t type] [message]
17 Only send ipc message and suppress the output of the response.
20 Display version number and exit.
23 Display a short help-message and exit.
25 *-s, --socket* 'sock_path'::
26 i3-msg will use the environment variable I3SOCK or the socket path
27 given here. If both fail, it will try to get the socket information
28 from the root window and then try /tmp/i3-ipc.sock before exiting
32 Send ipc message, see below. This option defaults to "command".
35 Instead of exiting right after receiving the first subscribed event,
36 wait indefinitely for all of them. Can only be used with "-t subscribe".
37 See the "subscribe" IPC message type below for details.
40 Send ipc message, see below.
45 The payload of the message is a command for i3 (like the commands you can bind
46 to keys in the configuration file) and will be executed directly after
50 Gets the current workspaces. The reply will be a JSON-encoded list of
54 Gets the current outputs. The reply will be a JSON-encoded list of outputs (see
55 the reply section of docs/ipc, e.g. at
56 https://i3wm.org/docs/ipc.html#_receiving_replies_from_i3).
59 Gets the layout tree. i3 uses a tree as data structure which includes every
60 container. The reply will be the JSON-encoded tree.
63 Gets a list of marks (identifiers for containers to easily jump to them later).
64 The reply will be a JSON-encoded list of window marks.
67 Gets the configuration (as JSON map) of the workspace bar with the given ID. If
68 no ID is provided, an array with all configured bar IDs is returned instead.
71 Gets a list of configured binding modes.
74 Gets the version of i3. The reply will be a JSON-encoded dictionary with the
75 major, minor, patch and human-readable version.
78 Gets the currently loaded i3 configuration.
81 Sends a tick to all IPC connections which subscribe to tick events.
84 The payload of the message describes the events to subscribe to.
85 Upon reception, each event will be dumped as a JSON-encoded object.
86 See the -m option for continuous monitoring.
90 i3-msg is a sample implementation for a client using the unix socket IPC
95 ------------------------------------------------
96 # Use 1-px border for current client
97 i3-msg "border 1pixel"
99 # You can leave out the quotes
102 # Dump the layout tree
105 # Monitor window changes
106 i3-msg -t subscribe -m '[ "window" ]'
107 ------------------------------------------------
113 If no ipc-socket is specified on the commandline, this variable is used
114 to determine the path, at which the unix domain socket is expected, on which
123 Michael Stapelberg and contributors