summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Stapelberg <stapelberg@users.noreply.github.com>2021-07-30 22:48:40 +0200
committerGitHub <noreply@github.com>2021-07-30 22:48:40 +0200
commit36ba1043d50d815b65b7f22619611a420726e8e3 (patch)
tree45613ea2025b7f0cd5f7cfa8873cd8a555635c3f
parentfee005bc87f4497a816b00250f5c2e42807022fb (diff)
downloadi3-36ba1043d50d815b65b7f22619611a420726e8e3.tar.gz
i3-36ba1043d50d815b65b7f22619611a420726e8e3.zip
ipc: document scratchpad_state (#4466)
fixes https://github.com/i3/i3/issues/4465
-rw-r--r--RELEASE-NOTES-next1
-rw-r--r--docs/ipc5
2 files changed, 5 insertions, 1 deletions
diff --git a/RELEASE-NOTES-next b/RELEASE-NOTES-next
index 77e290cf..523f9ab9 100644
--- a/RELEASE-NOTES-next
+++ b/RELEASE-NOTES-next
@@ -29,6 +29,7 @@ option is enabled and only then sets a screenshot as background.
└────────────────────────────┘
• default config: use dex for XDG autostart
+ • docs/ipc: document scratchpad_state
• i3-nagbar: position on focused monitor by default
• i3-nagbar: add option to position on primary monitor
• alternate focusing tab/stack children-parent containers by clicking on their titlebars
diff --git a/docs/ipc b/docs/ipc
index cf9349ed..a5c94459 100644
--- a/docs/ipc
+++ b/docs/ipc
@@ -450,12 +450,15 @@ fullscreen_mode (integer)::
floating (string)::
Floating state of container.
Can be either "auto_on", "auto_off", "user_on" or "user_off"
-
nodes (array of node)::
The tiling (i.e. non-floating) child containers of this node.
floating_nodes (array of node)::
The floating child containers of this node. Only non-empty on nodes with
type +workspace+.
+scratchpad_state (string)::
+ Whether the window is not in the scratchpad ("none"), freshly moved to
+ the scratchpad but not yet resized ("fresh") or moved to the scratchpad
+ and resized ("changed").
Please note that in the following example, I have left out some keys/values
which are not relevant for the type of the node. Otherwise, the example would