Merge branch 'master' into next

[i3/i3] / docs / ipc

diff --git a/docs/ipc b/docs/ipc
index 7e71326022606aa2b4d1abf93d4d77d3c448fe1a..4093ffce26e2233b7258c62bedc4e180b3c70fad 100644 (file)
--- a/docs/ipc
+++ b/docs/ipc
@@ -59,6 +59,10 @@ GET_TREE (4)::
        Gets the layout tree. i3 uses a tree as data structure which includes
        every container. The reply will be the JSON-encoded tree (see the reply
        section).
+GET_MARKS (5)::
+       Gets a list of marks (identifiers for containers to easily jump to them
+       later). The reply will be a JSON-encoded list of window marks (see
+       reply section).
 
 So, a typical message could look like this:
 --------------------------------------------------
@@ -110,6 +114,8 @@ GET_OUTPUTS (3)::
        Reply to the GET_OUTPUTS message.
 GET_TREE (4)::
        Reply to the GET_TREE message.
+GET_MARKS (5)::
+       Reply to the GET_MARKS message.
 
 === COMMAND reply
 
@@ -416,6 +422,16 @@ JSON dump:
    }
  ]
 }
+
+
+=== GET_MARKS reply
+
+The reply consists of a single array of strings for each container that has a
+mark. The order of that array is undefined. If more than one container has the
+same mark, it will be represented multiple times in the reply (the array
+contents are not unique).
+
+If no window has a mark the response will be the empty array [].
 ------------------------