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).
  28
  29 get_tree::
  30 Gets the layout tree. i3 uses a tree as data structure which includes every
  31 container. The reply will be the JSON-encoded tree.
  32
  33 get_marks::
  34 Gets a list of marks (identifiers for containers to easily jump to them later).
  35 The reply will be a JSON-encoded list of window marks.
  36
  37 get_bar_config::
  38 Gets the configuration (as JSON map) of the workspace bar with the given ID. If
  39 no ID is provided, an array with all configured bar IDs is returned instead.
  40
  41 get_version::
  42 Gets the version of i3. The reply will be a JSON-encoded dictionary with the
  43 major, minor, patch and human-readable version.
  44
  45 == DESCRIPTION
  46
  47 i3-msg is a sample implementation for a client using the unix socket IPC
  48 interface to i3.
  49
  50 == EXAMPLES
  51
  52 ------------------------------------------------
  53 # Use 1-px border for current client
  54 i3-msg "border 1pixel"
  55
  56 # You can leave out the quotes
  57 i3-msg border normal
  58
  59 # Dump the layout tree
  60 i3-msg -t get_tree
  61 ------------------------------------------------
  62
  63 == ENVIRONMENT
  64
  65 === I3SOCK
  66
  67 If no ipc-socket is specified on the commandline, this variable is used
  68 to determine the path, at wich the unix domain socket is expected, on which
  69 to connect to i3.
  70
  71 == SEE ALSO
  72
  73 i3(1)
  74
  75 == AUTHOR
  76
  77 Michael Stapelberg and contributors