1
1
mirror of https://github.com/wez/wezterm.git synced 2024-12-27 07:18:13 +03:00
wezterm/docs/config/misc.markdown
Wez Furlong 2603f9d4b4 fixup mux output processing
in ab342d9c46 I started to rearrange how
the output processing thread works.  It wasn't quite right, so this
commit tidies things up.

The main change here is that there is now back-pressure from the output
parser on the reader; if it is taking a while to parse the output then
we don't buffer up so much input.

This makes operations like `find /` followed immediately by `CTRL-C`
more responsive.

With this change, I don't feel that the
`ratelimit_output_bytes_per_second` option is needed any more, so it
has been removed.
2020-12-12 08:53:45 -08:00

2.5 KiB

Misc configuration

return {
  -- How many lines of scrollback you want to retain per tab
  scrollback_lines = 3500,

  -- Enable the scrollbar.  This is currently disabled by default.
  -- It will occupy the right window padding space.
  -- If right padding is set to 0 then it will be increased
  -- to a single cell width
  enable_scroll_bar = true,

  -- What to set the TERM variable to
  term = "xterm-256color",

  -- Constrains the rate at which the multiplexer server will
  -- unilaterally push data to the client.
  -- This helps to avoid saturating the link between the client
  -- and server.
  -- Each time the screen is updated as a result of the child
  -- command outputting data (rather than in response to input
  -- from the client), the server considers whether to push
  -- the result to the client.
  -- That decision is throttled by this configuration value
  -- which has a default value of 10/s
  ratelimit_mux_output_pushes_per_second = 10,

  -- Constrain how often the mux server scans the terminal
  -- model to compute a diff to send to the mux client.
  -- The default value is 100/s
  ratelimit_mux_output_scans_per_second = 100,

  -- If false, do not try to use a Wayland protocol connection
  -- when starting the gui frontend, and instead use X11.
  -- This option is only considered on X11/Wayland systems and
  -- has no effect on macOS or Windows.
  -- The default is true.
  enable_wayland = true,

  -- Specifies how often a blinking cursor transitions between visible
  -- and invisible, expressed in milliseconds.
  -- Setting this to 0 disables 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.
  -- It is recommended to avoid blinking cursors when on battery power,
  -- as it is relatively costly to keep re-rendering for the blink!
  cursor_blink_rate = 800,

  -- Specifies the default cursor style.  various escape sequences
  -- can override the default style in different situations (eg:
  -- an editor can change it depending on the mode), but this value
  -- controls how the cursor appears when it is reset to default.
  -- The default is `SteadyBlock`.
  -- Acceptable values are `SteadyBlock`, `BlinkingBlock`,
  -- `SteadyUnderline`, `BlinkingUnderline`, `SteadyBar`,
  -- and `BlinkingBar`.
  default_cursor_style = "SteadyBlock",

  -- Specifies the maximum width that a tab can have in the
  -- tab bar.  Defaults to 16 glyphs in width.
  tab_max_width = 16,
}