docs/ipc: make the GET_MARKS docs a little more precise
This commit is contained in:
parent
dab3a0b85a
commit
fadf9088db
11
docs/ipc
11
docs/ipc
|
@ -60,8 +60,9 @@ GET_TREE (4)::
|
||||||
every container. The reply will be the JSON-encoded tree (see the reply
|
every container. The reply will be the JSON-encoded tree (see the reply
|
||||||
section).
|
section).
|
||||||
GET_MARKS (5)::
|
GET_MARKS (5)::
|
||||||
Gets a list of marks. The reply will be a JSON-encoded list of window marks
|
Gets a list of marks (identifiers for containers to easily jump to them
|
||||||
(see reply section).
|
later). The reply will be a JSON-encoded list of window marks (see
|
||||||
|
reply section).
|
||||||
|
|
||||||
So, a typical message could look like this:
|
So, a typical message could look like this:
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
|
@ -425,8 +426,10 @@ JSON dump:
|
||||||
|
|
||||||
=== GET_MARKS reply
|
=== GET_MARKS reply
|
||||||
|
|
||||||
The reply consists of a single array of strings for each
|
The reply consists of a single array of strings for each container that has a
|
||||||
window that has a mark.
|
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 [].
|
If no window has a mark the response will be the empty array [].
|
||||||
------------------------
|
------------------------
|
||||||
|
|
Loading…
Reference in New Issue