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 [-t type] [message]
  13
  14 == IPC MESSAGE TYPES
  15
  16 command::
  17 The payload of the message is a command for i3 (like the commands you can bind
  18 to keys in the configuration file) and will be executed directly after
  19 receiving it.
  20
  21 get_workspaces::
  22 Gets the current workspaces. The reply will be a JSON-encoded list of
  23 workspaces.
  24
  25 get_outputs::
  26 Gets the current outputs. The reply will be a JSON-encoded list of outputs (see
  27 the reply section of docs/ipc, e.g. at
  28 http://i3wm.org/docs/ipc.html#_receiving_replies_from_i3).
  29
  30 get_tree::
  31 Gets the layout tree. i3 uses a tree as data structure which includes every
  32 container. The reply will be the JSON-encoded tree.
  33
  34 get_marks::
  35 Gets a list of marks (identifiers for containers to easily jump to them later).
  36 The reply will be a JSON-encoded list of window marks.
  37
  38 get_bar_config::
  39 Gets the configuration (as JSON map) of the workspace bar with the given ID. If
  40 no ID is provided, an array with all configured bar IDs is returned instead.
  41
  42 get_version::
  43 Gets the version of i3. The reply will be a JSON-encoded dictionary with the
  44 major, minor, patch and human-readable version.
  45
  46 == DESCRIPTION
  47
  48 i3-msg is a sample implementation for a client using the unix socket IPC
  49 interface to i3.
  50
  51 == EXAMPLES
  52
  53 ------------------------------------------------
  54 # Use 1-px border for current client
  55 i3-msg "border 1pixel"
  56
  57 # You can leave out the quotes
  58 i3-msg border normal
  59
  60 # Dump the layout tree
  61 i3-msg -t get_tree
  62 ------------------------------------------------
  63
  64 == ENVIRONMENT
  65
  66 === I3SOCK
  67
  68 If no ipc-socket is specified on the commandline, this variable is used
  69 to determine the path, at wich the unix domain socket is expected, on which
  70 to connect to i3.
  71
  72 == SEE ALSO
  73
  74 i3(1)
  75
  76 == AUTHOR
  77
  78 Michael Stapelberg and contributors