aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2021-01-26 19:32:04 +0000
committerDaniel Eklöf <daniel@ekloef.se>2021-01-26 19:32:04 +0000
commitc1675af1038eedf96ac3782afd03465b31f74fd6 (patch)
tree61f6d9d365f2e9c33ba361a83019aefd187c22cf /doc
parentMerge branch 'search-extend-to-word-boundary-handle-composed-chars' (diff)
parentconfig: promote tweak.resize-delay-ms to a real, supported option (diff)
Merge branch 'delay-tiocswinsz-on-interactive-resize'
Closes #283 Closes #301
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 180ac7c2..8684850b 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -131,6 +131,25 @@ in this order:
Default: _2x2_.
+*resize-delay-ms*
+ Time, in milliseconds, of "idle time" "before foot sends the new
+ window dimensions to the client application while doing an
+ interactive resize of a foot window. Idle time in this context is
+ a period of time where the window size is not changing.
+
+ In other words, while you are fiddling with the window size, foot
+ does not send the updated dimensions to the client. Only when you
+ pause the fiddling for *relay-size-ms* milliseconds is the client
+ updated.
+
+ Emphasis is on _while_ here; as soon as the interactive resize
+ ends (i.e. when you let go of the window border), the final
+ dimensions is sent to the client, without any delays.
+
+ Setting it to 0 disables the delay completely.
+
+ Default: _100_.
+
*initial-window-size-pixels*
Initial window width and height in _pixels_ (subject to output
scaling), on the form _WIDTHxHEIGHT_. The height _includes_ the