1
1
mirror of https://github.com/wez/wezterm.git synced 2024-09-20 11:17:15 +03:00

docs: update for new 20210814-124438-54e29167 release

This commit is contained in:
Wez Furlong 2021-08-14 14:15:05 -07:00
parent 54e29167ba
commit 10812c936d
20 changed files with 27 additions and 23 deletions

View File

@ -11,6 +11,10 @@ usually the best available version.
As features stabilize some brief notes about them will accumulate here. As features stabilize some brief notes about them will accumulate here.
* Not yet!
### 20210814-124438-54e29167
* Fixed: ssh client would read `/etc/ssh/config` rather than the proper `/etc/ssh/ssh_config` * Fixed: ssh client would read `/etc/ssh/config` rather than the proper `/etc/ssh/ssh_config`
* Updated: ssh client now processes `Include` statements in ssh config * Updated: ssh client now processes `Include` statements in ssh config
* x11: support for [VoidSymbol](config/keys.md#voidsymbol) in key assignments. Thanks to [@digitallyserviced](https://github.com/digitallyserviced)! [#759](https://github.com/wez/wezterm/pull/759) * x11: support for [VoidSymbol](config/keys.md#voidsymbol) in key assignments. Thanks to [@digitallyserviced](https://github.com/digitallyserviced)! [#759](https://github.com/wez/wezterm/pull/759)

View File

@ -330,7 +330,7 @@ on hue, saturation, brigthness transformations.
## Window Background Gradient ## Window Background Gradient
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
<img src="../screenshots/radial-gradient.png"> <img src="../screenshots/radial-gradient.png">

View File

@ -169,7 +169,7 @@ The default key bindings are:
| `SUPER` | `h` | `HideApplication` (macOS only) | | `SUPER` | `h` | `HideApplication` (macOS only) |
| `SUPER` | `k` | `ClearScrollback="ScrollbackOnly"` | | `SUPER` | `k` | `ClearScrollback="ScrollbackOnly"` |
| `CTRL+SHIFT` | `K` | `ClearScrollback="ScrollbackOnly"` | | `CTRL+SHIFT` | `K` | `ClearScrollback="ScrollbackOnly"` |
| `CTRL+SHIFT` | `L` | `ShowDebugOverlay` (*since: nightly builds only*)| | `CTRL+SHIFT` | `L` | `ShowDebugOverlay` (*Since: 20210814-124438-54e29167*)|
| `SUPER` | `f` | `Search={CaseSensitiveString=""}` | | `SUPER` | `f` | `Search={CaseSensitiveString=""}` |
| `CTRL+SHIFT` | `F` | `Search={CaseSensitiveString=""}` | | `CTRL+SHIFT` | `F` | `Search={CaseSensitiveString=""}` |
| `CTRL+SHIFT` | `X` | `ActivateCopyMode` | | `CTRL+SHIFT` | `X` | `ActivateCopyMode` |
@ -290,7 +290,7 @@ return {
### VoidSymbol ### VoidSymbol
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
On X11 systems, If you decide to change certain keys on the keyboard to On X11 systems, If you decide to change certain keys on the keyboard to
`VoidSymbol` (like `CapsLock`), then you can utilize it as a `LEADER` or any `VoidSymbol` (like `CapsLock`), then you can utilize it as a `LEADER` or any

View File

@ -1,6 +1,6 @@
# bypass_mouse_reporting_modifiers = "SHIFT" # bypass_mouse_reporting_modifiers = "SHIFT"
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
If an application has enabled mouse reporting mode, mouse events are sent If an application has enabled mouse reporting mode, mouse events are sent
directly to the application, and do not get routed through the mouse directly to the application, and do not get routed through the mouse

View File

@ -14,7 +14,7 @@ The default value is system specific:
|Windows |Probed from the display |Probed from the display | |Windows |Probed from the display |Probed from the display |
|X11 |96.0 |96.0 | |X11 |96.0 |96.0 |
|X11 (*version 20210314-114017-04b7cedd and later*)|Probed from `Xft.dpi`, fallback to 96.0 |Probed from `Xft.dpi`, fallback to 96.0 | |X11 (*version 20210314-114017-04b7cedd and later*)|Probed from `Xft.dpi`, fallback to 96.0 |Probed from `Xft.dpi`, fallback to 96.0 |
|X11 (*Since: nightly builds only*)|Reads `Xft/DPI` via xsettings, fallback to `Xft.dpi`, then fallback to 96.0 | same as standard density | |X11 (*version 20210814-124438-54e29167 and later*)|Reads `Xft/DPI` via xsettings, fallback to `Xft.dpi`, then fallback to 96.0 | same as standard density |
|Wayland |96.0 |192.0 | |Wayland |96.0 |192.0 |
In macOS and Wayland environments there isn't strictly a system DPI value that In macOS and Wayland environments there isn't strictly a system DPI value that

View File

@ -24,7 +24,7 @@ return {
} }
``` ```
*Since: nightly builds only*: *Since: 20210814-124438-54e29167*:
The default value for this setting now includes some The default value for this setting now includes some
windows shell processes: windows shell processes:

View File

@ -1,6 +1,6 @@
# `tab_bar_style` # `tab_bar_style`
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
`new_tab_left`, `new_tab_right`, `new_tab_hover_left`, `new_tab_hover_right` `new_tab_left`, `new_tab_right`, `new_tab_hover_left`, `new_tab_hover_right`
have been removed and replaced by the more flexible `new_tab` and `new_tab_hover` elements. have been removed and replaced by the more flexible `new_tab` and `new_tab_hover` elements.

View File

@ -1,6 +1,6 @@
# `text_blink_rate` # `text_blink_rate`
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Specifies how often blinking text (normal speed) transitions between visible Specifies how often blinking text (normal speed) transitions between visible
and invisible, expressed in milliseconds. Setting this to 0 disables slow text and invisible, expressed in milliseconds. Setting this to 0 disables slow text

View File

@ -1,6 +1,6 @@
# `text_blink_rate_rapid` # `text_blink_rate_rapid`
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Specifies how often blinking text (rapid speed) transitions between visible Specifies how often blinking text (rapid speed) transitions between visible
and invisible, expressed in milliseconds. Setting this to 0 disables slow text and invisible, expressed in milliseconds. Setting this to 0 disables slow text

View File

@ -1,6 +1,6 @@
# window_background_gradient # window_background_gradient
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Dynamically generates a `window_background_image` from the provided gradient Dynamically generates a `window_background_image` from the provided gradient
specification. When `window_background_gradient` is configured, the value specification. When `window_background_gradient` is configured, the value

View File

@ -1,6 +1,6 @@
# window_frame # window_frame
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
This setting is applicable only on Wayland systems when client side decorations are in use. This setting is applicable only on Wayland systems when client side decorations are in use.

View File

@ -1,6 +1,6 @@
# `ShowDebugOverlay` # `ShowDebugOverlay`
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Overlays the current tab with the debug overlay, which is a combination Overlays the current tab with the debug overlay, which is a combination
of a debug log and a lua [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop). of a debug log and a lua [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop).

View File

@ -1,6 +1,6 @@
# wezterm.add_to_config_reload_watch_list(path) # wezterm.add_to_config_reload_watch_list(path)
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Adds `path` to the list of files that are watched for config changes. Adds `path` to the list of files that are watched for config changes.
If [automatically_reload_config](../config/automatically_reload_config.md) If [automatically_reload_config](../config/automatically_reload_config.md)

View File

@ -1,6 +1,6 @@
# wezterm.gradient_colors(gradient, num_colors) # wezterm.gradient_colors(gradient, num_colors)
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Given a gradient spec and a number of colors, returns a table Given a gradient spec and a number of colors, returns a table
holding that many colors spaced evenly across the range of holding that many colors spaced evenly across the range of

View File

@ -10,7 +10,7 @@ local wezterm = require 'wezterm';
wezterm.log_error("Hello!"); wezterm.log_error("Hello!");
``` ```
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Now accepts multiple arguments, and those arguments can be of any type. Now accepts multiple arguments, and those arguments can be of any type.

View File

@ -12,7 +12,7 @@ local wezterm = require 'wezterm';
wezterm.log_info("Hello!"); wezterm.log_info("Hello!");
``` ```
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Now accepts multiple arguments, and those arguments can be of any type. Now accepts multiple arguments, and those arguments can be of any type.

View File

@ -12,7 +12,7 @@ local wezterm = require 'wezterm';
wezterm.log_warn("Hello!"); wezterm.log_warn("Hello!");
``` ```
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
Now accepts multiple arguments, and those arguments can be of any type. Now accepts multiple arguments, and those arguments can be of any type.

View File

@ -1,6 +1,6 @@
# window:get_appearance() # window:get_appearance()
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
This method returns the appearance of the window environment. The appearance This method returns the appearance of the window environment. The appearance
can be one of the following 4 values: can be one of the following 4 values:

View File

@ -257,7 +257,7 @@ is not specified in the accompanying ITU T.416 specification and is ignored by
CSI 38 : 2 : : R : G : B m CSI 38 : 2 : : R : G : B m
``` ```
(*Since nightly builds only) For the sake of compatibility with some other (*Since 20210814-124438-54e29167*) For the sake of compatibility with some other
terminal emulators this additional form is also supported where the colorspace terminal emulators this additional form is also supported where the colorspace
ID argument is not specified: ID argument is not specified:
@ -272,7 +272,7 @@ The `R`, `G` and `B` symbols below are decimal numbers in the range `0-255`:
CSI 48 : 2 : : R : G : B m CSI 48 : 2 : : R : G : B m
``` ```
(*Since nightly builds only) For the sake of compatibility with some other (*Since 20210814-124438-54e29167*) For the sake of compatibility with some other
terminal emulators this additional form is also supported where the colorspace terminal emulators this additional form is also supported where the colorspace
ID argument is not specified: ID argument is not specified:
@ -287,7 +287,7 @@ The `R`, `G` and `B` symbols below are decimal numbers in the range `0-255`:
CSI 58 : 2 : : R : G : B m CSI 58 : 2 : : R : G : B m
``` ```
(*Since nightly builds only) For the sake of compatibility with some other (*Since 20210814-124438-54e29167*) For the sake of compatibility with some other
terminal emulators this additional form is also supported where the colorspace terminal emulators this additional form is also supported where the colorspace
ID argument is not specified: ID argument is not specified:
@ -301,7 +301,7 @@ CSI 58 : 2 : R : G : B m
#### Mode Functions #### Mode Functions
*Since: nightly builds only* *Since: 20210814-124438-54e29167*
WezTerm supports [Synchronized Rendering](https://gist.github.com/christianparpart/d8a62cc1ab659194337d73e399004036). WezTerm supports [Synchronized Rendering](https://gist.github.com/christianparpart/d8a62cc1ab659194337d73e399004036).
DECSET 2026 is set to batch (hold) rendering until DECSET 2026 is reset to flush the queued screen data. DECSET 2026 is set to batch (hold) rendering until DECSET 2026 is reset to flush the queued screen data.

View File

@ -48,7 +48,7 @@ All other options are parsed but have no effect. Notably, neither `Match` or
`canonical` are not supported) configuration parsing for `Host` and `canonical` are not supported) configuration parsing for `Host` and
`LocalUser`. `Exec` based matches are recognized but not supported. `LocalUser`. `Exec` based matches are recognized but not supported.
*Since: nightly builds only:* *Since: 20210814-124438-54e29167:*
`Include` is now supported. `Include` is now supported.