updated docs

This commit is contained in:
2025-08-12 18:16:24 +02:00
committed by T.v.Dein
parent dacdc5c214
commit 4741481527

View File

@@ -43,12 +43,12 @@ bindsym $mod+Tab exec ~/bin/swaycycle -d -l /tmp/cycle.log
## How does it work? ## How does it work?
`swaycycle` is being executed by sway when the user presses a key `swaycycle` is being executed by sway when the user presses a key
(e.g. `ALT-tab`). It then executes: (e.g. `ALT-tab`). It then connects to the running sway instance via
the provided IPC unix domain socket as available in the environment
`swaymsg -t get_tree -r` variable `SWAYSOCK`. Via that connection it sends the `GET_TREE`
command and processes the retrieved JSON response. This JSON tree
to get a JSON representation of the current setup (a tree consisting contains all information about the running instance such as outputs,
of outputs, workspaces, containers and running programs). workspaces and containers.
Then it determines which workspace is the current active one and Then it determines which workspace is the current active one and
builds a list of all windows visible on that workspace, whether builds a list of all windows visible on that workspace, whether
@@ -58,12 +58,10 @@ Next it determines which window is following the one in the list with
the current active focus. If the active one is at the end of the list, the current active focus. If the active one is at the end of the list,
it starts from the top. it starts from the top.
Finally another swaymsg command is being executed to give focus to the Finally `swaycycle` sends the propper switch focus command via the IPC
calculated next window, e.g.: connection to sway, e.g.:
`swaymsg [con_id=14] focus` `[con_id=14] focus`
`swaycycle` then just exists. It does not store any state to disk.
## Getting help ## Getting help