From 23ca1f7f2f28adaf47bbc68c5a6dcd11325bcfd2 Mon Sep 17 00:00:00 2001 From: Tassilo Horn Date: Fri, 6 May 2022 06:54:53 +0200 Subject: [PATCH] Minor doc adjustments --- README.md | 31 +++++++++++++++++-------------- swayr/NEWS.md | 9 +++++---- 2 files changed, 22 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index cdbe322..4e8eb15 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ by the shortcut. The following shortcuts are supported. `w:` would do. -#### Cycling commands +#### Cycling commands Those commands cycle through (a subset of windows) in last-recently-used order. @@ -173,11 +173,12 @@ These commands change the layout of the current workspace. * `execute-swayr-command` displays all commands above and executes the selected one. (This is useful for accessing swayr commands which are not bound to a key.) -* `nop` (unsurprisingly) does nothing, the command can be used to break out of a - sequence of [window cycling commands](#cycling-commands). The LRU window order - is frozen when the first cycling command is processed and remains so until a - non-cycling command is received. The `nop` command can conveniently serve to - interrupt a sequence without having any other side effects. +* `nop` (unsurprisingly) does nothing, the command can be used to break out of + a sequence of [window cycling commands](#swayr-cycling-commands). The LRU + window order is frozen when the first cycling command is processed and + remains so until a non-cycling command is received. The `nop` command can + conveniently serve to interrupt a sequence without having any other side + effects. ### Screenshots @@ -275,10 +276,11 @@ bindsym $mod+Shift+c exec env RUST_BACKTRACE=1 \ Of course, configure the keys to your liking. Again, enabling rust backtraces and logging are optional. -Pending a fix for [Sway issue 6456](https://github.com/swaywm/sway/issues/6456), -it will be possible to close a sequence of window cycling commands using -a `nop` command bound to the release of the `$mod` key. Assuming your `$mod` -is bound to `Super_L` it could look something like this: +Pending a fix for [Sway issue +#6456](https://github.com/swaywm/sway/issues/6456), it will be possible to +close a sequence of [window cycling commands](#swayr-cycling-commands) using a +`nop` command bound to the release of the `$mod` key. Assuming your `$mod` is +bound to `Super_L` it could look something like this: ``` bindsym --release Super_L exec env RUST_BACKTRACE=1 \ @@ -476,10 +478,11 @@ are a workaround and wouldn't be required if there were resize-events. #### The focus section -In the `[focus]` section, you can configure the amount of time a window -has to keep the focus in order to affect the LRU order. If a given window -is only briefly focused, e.g. moving the mouse over it on the way to -another window, then its position in the LRU order will not be modified. +In the `[focus]` section, you can configure the amount of time a window has to +keep the focus in order to affect the LRU order, the `lockin_delay`. If a +given window is only briefly focused, e.g., by moving the mouse over it on the +way to another window with sway's `focus_follows_mouse` set to `yes` or +`always`, then its position in the LRU order will not be modified. ### Version changes diff --git a/swayr/NEWS.md b/swayr/NEWS.md index d7aed6c..bf4d2c9 100644 --- a/swayr/NEWS.md +++ b/swayr/NEWS.md @@ -2,10 +2,11 @@ swayr v0.18.0 ============= - The LRU window order will no longer be immediately updated when there is a - focus change. Instead there is now a short (configurable) delay before the - update. The user-visible change is that quickly moving over windows with the - mouse, or moving through them using keyboard navigation, will only register - the start and destination windows in the LRU sequence. + focus change. Instead there is now a short (configurable) delay + (`focus.lockin_delay`) before the update. The user-visible change is that + quickly moving over windows with the mouse, or moving through them using + keyboard navigation, will only register the start and destination windows in + the LRU sequence. - A `nop` command can be used to interrupt a sequence of window-cycling commands.