docs: text_blink_rate

refs: #904
wez · Jul 25, 2021 · 50c3e17 · 50c3e17
1 parent b953172
commit 50c3e17
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -62,6 +62,7 @@ As features stabilize some brief notes about them will accumulate here.
 * Fixed: if a line of text was exactly the width of the terminal it would get marked as wrappable even when followed by a newline, causing text to reflow incorrectly on resize. [#971](https://github.com/wez/wezterm/issues/971)
 * Fixed: `wezterm ssh` could loop forever in the background if the connection drops and the window is closed. [#857](https://github.com/wez/wezterm/issues/857)
 * Improved: VT102 conformance. Many thanks to [Autumn Lamonte](https://gitlab.com/klamonte)! [#904](https://github.com/wez/wezterm/pull/904)
+* New: [text_blink_rate](config/lua/config/text_blink_rate.md) and [text_blink_rate_rapid](config/lua/config/text_blink_rate_rapid.md) options to control blinking text. Thanks to [Autumn Lamonte](https://gitlab.com/klamonte)! [#904](https://github.com/wez/wezterm/pull/904)
 
 ### 20210502-154244-3f7122cb
 

diff --git a/docs/config/lua/config/text_blink_rate.md b/docs/config/lua/config/text_blink_rate.md
@@ -0,0 +1,15 @@
+# `text_blink_rate`
+
+*Since: nightly builds only*
+
+Specifies how often blinking text (normal speed) transitions between visible
+and invisible, expressed in milliseconds.  Setting this to 0 disables slow text
+blinking.  Note that this value is approximate due to the way that the system
+event loop schedulers manage timers; non-zero values will be at least the
+interval specified with some degree of slop.
+
+```lua
+return {
+  text_blink_rate = 500
+}
+```
diff --git a/docs/config/lua/config/text_blink_rate_rapid.md b/docs/config/lua/config/text_blink_rate_rapid.md
@@ -0,0 +1,16 @@
+# `text_blink_rate_rapid`
+
+*Since: nightly builds only*
+
+Specifies how often blinking text (rapid speed) transitions between visible
+and invisible, expressed in milliseconds.  Setting this to 0 disables slow text
+blinking.  Note that this value is approximate due to the way that the system
+event loop schedulers manage timers; non-zero values will be at least the
+interval specified with some degree of slop.
+
+```lua
+return {
+  text_blink_rate_rapid = 250
+}
+```
+