mirror of
https://github.com/wez/wezterm.git
synced 2024-09-19 02:37:51 +03:00
docs: migrate misc.md to individual config pages
This commit is contained in:
parent
336f209ede
commit
ec12eed180
@ -134,7 +134,6 @@ TOC = [
|
||||
Page("Launching Programs", "config/launch.md"),
|
||||
Page("Fonts", "config/fonts.md"),
|
||||
Page("Font Shaping", "config/font-shaping.md"),
|
||||
Page("Misc", "config/misc.md"),
|
||||
Page("Key Binding", "config/keys.md"),
|
||||
Page("Mouse Binding", "config/mouse.md"),
|
||||
Page("Colors & Appearance", "config/appearance.md"),
|
||||
|
17
docs/config/lua/config/cursor_blink_rate.md
Normal file
17
docs/config/lua/config/cursor_blink_rate.md
Normal file
@ -0,0 +1,17 @@
|
||||
# `cursor_blink_rate`
|
||||
|
||||
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!
|
||||
|
||||
```lua
|
||||
return {
|
||||
cursor_blink_rate = 800,
|
||||
}
|
||||
```
|
18
docs/config/lua/config/default_cursor_style.md
Normal file
18
docs/config/lua/config/default_cursor_style.md
Normal file
@ -0,0 +1,18 @@
|
||||
# `default_cursor_style = "SteadyBlock"`
|
||||
|
||||
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`.
|
||||
|
||||
```lua
|
||||
return {
|
||||
default_cursor_style = "SteadyBlock",
|
||||
}
|
||||
```
|
||||
|
14
docs/config/lua/config/enable_scroll_bar.md
Normal file
14
docs/config/lua/config/enable_scroll_bar.md
Normal file
@ -0,0 +1,14 @@
|
||||
# `enable_scroll_bar`
|
||||
|
||||
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.
|
||||
|
||||
```lua
|
||||
return {
|
||||
enable_scroll_bar = true,
|
||||
}
|
||||
```
|
||||
|
||||
|
16
docs/config/lua/config/enable_wayland.md
Normal file
16
docs/config/lua/config/enable_wayland.md
Normal file
@ -0,0 +1,16 @@
|
||||
# `enable_wayland`
|
||||
|
||||
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 false.
|
||||
|
||||
```lua
|
||||
return {
|
||||
enable_wayland = true,
|
||||
}
|
||||
```
|
||||
|
10
docs/config/lua/config/tab_max_width.md
Normal file
10
docs/config/lua/config/tab_max_width.md
Normal file
@ -0,0 +1,10 @@
|
||||
# `tab_max_width`
|
||||
|
||||
Specifies the maximum width that a tab can have in the
|
||||
tab bar. Defaults to 16 glyphs in width.
|
||||
|
||||
```lua
|
||||
return {
|
||||
tab_max_width = 16,
|
||||
}
|
||||
```
|
10
docs/config/lua/config/window_close_confirmation.md
Normal file
10
docs/config/lua/config/window_close_confirmation.md
Normal file
@ -0,0 +1,10 @@
|
||||
# `window_close_confirmation`
|
||||
|
||||
Set this to `"NeverPrompt"` if you don't like confirming closing
|
||||
windows every time.
|
||||
|
||||
```lua
|
||||
return {
|
||||
window_close_confirmation = "AlwaysPrompt",
|
||||
}
|
||||
```
|
@ -1,69 +0,0 @@
|
||||
### Misc configuration
|
||||
|
||||
```lua
|
||||
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,
|
||||
|
||||
-- Set this to "NeverPrompt" if you don't like confirming closing
|
||||
-- windows every time
|
||||
window_close_confirmation = "AlwaysPrompt",
|
||||
}
|
||||
```
|
Loading…
Reference in New Issue
Block a user