1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-25 22:33:52 +03:00
wezterm/docs
Wez Furlong 7caaf136e4 compensate for flickery TUI programs by going slower(!)
It's not the first time that I've solved a problem by slowing things
down... in this situation, a couple of very inefficient TUI programs had
flickering outputs in wezterm because they were filling a buffer with a
bunch of spaces to erase a screen before sending the main body of their
updates in a subsequent buffer chunk. wezterm would render the
intervening partially blank frame and appear to flicker.

The resolution is to add a small delay (3ms by default) before sending
data to the terminal model. If the output is readable in that time
we'll accumulate it with the pending set of actions so that the
whole batch can be applied "more atomically".

Take care: `time cat bigfile` is sensitive to this, so we want to
keep the latency as small as possible, and we also want to avoid
accumulating actions and only flushing them at the end of the file.

We use the existing buffer size (~1MB) as a threshold: we bump
a count of the number of input bytes that resulted in the current
set of actions, and if that exceeds that buffer size we flush it.

refs: https://github.com/wez/wezterm/issues/2443
2022-08-21 14:40:06 -07:00
..
cli docs: note about wezterm-gui.exe --help not outputting anything 2022-07-22 07:52:31 -07:00
colorschemes chore: Sync color schemes with nightfox changes 2022-08-12 20:09:02 -07:00
config docs: fix typo 2022-08-21 12:59:39 -07:00
examples showkeys/docs: generate copy_mode defaults from the code 2022-08-04 06:28:32 -07:00
install Fix alias for Flatpak: command wasn't quoted 2022-08-11 13:08:24 -07:00
screenshots docs for new background config 2022-05-31 23:20:11 -07:00
_config.yml docs: switch to the "Hacker" theme which is darker 2019-12-18 09:25:36 -08:00
asciinema-player.css docs: use asciinema's web player for screenshots 2022-07-09 18:59:44 -07:00
asciinema-player.min.js docs: use asciinema's web player for screenshots 2022-07-09 18:59:44 -07:00
book.toml docs: use asciinema's web player for screenshots 2022-07-09 18:59:44 -07:00
changelog.md compensate for flickery TUI programs by going slower(!) 2022-08-21 14:40:06 -07:00
contributing.md docs: upgrade to mdbook 0.4, enable link checking 2021-01-30 14:14:29 -08:00
copymode.md docs: clarify that we might be showing more recent info 2022-08-04 06:31:40 -07:00
custom.css docs: embed nerd fonts symbols on the nerdfonts page 2022-02-03 08:19:51 -07:00
escape-sequences.md docs: 20220807-113146-c2fee766 release 2022-08-07 13:26:59 -07:00
faq.md docs: apply stylua formatting 2022-07-19 07:54:31 -07:00
features.md Fix shortcut for "move between panes": shift was missing 2022-07-12 22:42:35 -07:00
help.md docs: upgrade to mdbook 0.4, enable link checking 2021-01-30 14:14:29 -08:00
hyperlinks.md docs: apply stylua formatting 2022-07-19 07:54:31 -07:00
imgcat.md docs: update for 20220319-142410-0fcdea07 2022-03-19 16:37:27 -07:00
index.md docs: slightly clarify key assignment docs 2021-10-03 09:10:04 -07:00
installation.md docs: add installation info for FreeBSD 2021-03-03 08:45:58 -08:00
mermaid-init.js docs: adopt mermaid-js for flowchart 2022-04-03 22:09:17 -07:00
multiplexing.md docs: apply stylua formatting 2022-07-19 07:54:31 -07:00
quickselect.md Document CopyMode/QuickSelect Colors (#2324) 2022-07-29 18:00:03 -07:00
README.markdown docs: redirect people from GH docs dir to website 2021-12-12 07:54:01 -07:00
scrollback.md docs: clarify that we might be showing more recent info 2022-08-04 06:31:40 -07:00
serial.md docs: upgrade to mdbook 0.4, enable link checking 2021-01-30 14:14:29 -08:00
shell-integration.md docs: apply stylua formatting 2022-07-19 07:54:31 -07:00
ssh.md ssh: support BindAddress 2022-04-15 20:53:07 -07:00

This directory contains the sources for the documentation. Read the generated documentation at: https://wezfurlong.org/wezterm