nixo
/
gri3-wm
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs/ipc: make the GET_MARKS docs a little more precise

This commit is contained in:
Michael Stapelberg 2011-08-09 08:22:58 +02:00
parent dab3a0b85a
commit fadf9088db
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/ipc
View File

@ -60,8 +60,9 @@ GET_TREE (4)::
every container. The reply will be the JSON-encoded tree (see the reply
section).
GET_MARKS (5)::
Gets a list of marks. The reply will be a JSON-encoded list of window marks
(see reply section).
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:
--------------------------------------------------
@ -425,8 +426,10 @@ JSON dump:
=== GET_MARKS reply
The reply consists of a single array of strings for each
window that has a mark.
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 [].
------------------------