git.sur5r.net Git - i3/i3/blob - man/i3-msg.man

   1 i3-msg(1)
   2 =========
   3 Michael Stapelberg <michael@i3wm.org>
   4 v4.2, August 2012
   5
   6 == NAME
   7
   8 i3-msg - send messages to i3 window manager
   9
  10 == SYNOPSIS
  11
  12 i3-msg  [-q] [-v] [-h] [-s socket] [-t type] [message]
  13
  14 == OPTIONS
  15
  16 *-q, --quiet*::
  17 Only send ipc message and suppress the output of the response.
  18
  19 *-v, --version*::
  20 Display version number and exit.
  21
  22 *-h, --help*::
  23 Display a short help-message and exit.
  24
  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
  29 with an error.
  30
  31 *-t* 'type'::
  32 Send ipc message, see below. This option defaults to "command".
  33
  34 *message*::
  35 Send ipc message, see below.
  36
  37 == IPC MESSAGE TYPES
  38
  39 command::
  40 The payload of the message is a command for i3 (like the commands you can bind
  41 to keys in the configuration file) and will be executed directly after
  42 receiving it.
  43
  44 get_workspaces::
  45 Gets the current workspaces. The reply will be a JSON-encoded list of
  46 workspaces.
  47
  48 get_outputs::
  49 Gets the current outputs. The reply will be a JSON-encoded list of outputs (see
  50 the reply section of docs/ipc, e.g. at
  51 http://i3wm.org/docs/ipc.html#_receiving_replies_from_i3).
  52
  53 get_tree::
  54 Gets the layout tree. i3 uses a tree as data structure which includes every
  55 container. The reply will be the JSON-encoded tree.
  56
  57 get_marks::
  58 Gets a list of marks (identifiers for containers to easily jump to them later).
  59 The reply will be a JSON-encoded list of window marks.
  60
  61 get_bar_config::
  62 Gets the configuration (as JSON map) of the workspace bar with the given ID. If
  63 no ID is provided, an array with all configured bar IDs is returned instead.
  64
  65 get_binding_modes::
  66 Gets a list of configured binding modes.
  67
  68 get_version::
  69 Gets the version of i3. The reply will be a JSON-encoded dictionary with the
  70 major, minor, patch and human-readable version.
  71
  72 == DESCRIPTION
  73
  74 i3-msg is a sample implementation for a client using the unix socket IPC
  75 interface to i3.
  76
  77 == EXAMPLES
  78
  79 ------------------------------------------------
  80 # Use 1-px border for current client
  81 i3-msg "border 1pixel"
  82
  83 # You can leave out the quotes
  84 i3-msg border normal
  85
  86 # Dump the layout tree
  87 i3-msg -t get_tree
  88 ------------------------------------------------
  89
  90 == ENVIRONMENT
  91
  92 === I3SOCK
  93
  94 If no ipc-socket is specified on the commandline, this variable is used
  95 to determine the path, at which the unix domain socket is expected, on which
  96 to connect to i3.
  97
  98 == SEE ALSO
  99
 100 i3(1)
 101
 102 == AUTHOR
 103
 104 Michael Stapelberg and contributors