docs: update for 20220319-142410-0fcdea07

2024-11-22 22:42:48 +03:00 · 2022-03-19 16:37:27 -07:00 · 2022-03-19 16:37:27 -07:00 · ee5d5714ca
commit ee5d5714ca
parent 0fcdea0789
41 changed files with 53 additions and 46 deletions
--- a/docs/changelog.md
+++ b/docs/changelog.md
@ -11,6 +11,13 @@ usually the best available version.

 As features stabilize some brief notes about them will accumulate here.

+#### New
+#### Changed
+#### Updated and Improved
+#### Fixed
+
+### 20220319-142410-0fcdea07
+
 #### New

 * [window:composition_status()](config/lua/window/composition_status.md) and [window:leader_is_active()](config/lua/window/leader_is_active.md) methods that can help populate [window:set_right_status()](config/lua/window/set_right_status.md) [#686](https://github.com/wez/wezterm/issues/686)
--- a/docs/config/appearance.md
+++ b/docs/config/appearance.md
@ -61,7 +61,7 @@ return {
      -- Arbitrary colors of the palette in the range from 16 to 255
      indexed = {[136] = "#af8700"},

-      -- Since: nightly builds only
+      -- Since: 20220319-142410-0fcdea07
      -- When the IME, a dead key or a leader key are being processed and are effectively
      -- holding input pending the result of input composition, change the cursor
      -- to this color to give a visual cue about the compose state.
@ -88,7 +88,7 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Colors now also accept the following CSS-style color specifications:

--- a/docs/config/keys.md
+++ b/docs/config/keys.md
@ -250,7 +250,7 @@ pressing the corresponding key.

 ### Physical vs Mapped Key Assignments

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 The `key` value can refer either to the physical position of a key on an ANSI
 US keyboard or to the post-keyboard-layout-mapped value produced by a key
--- a/docs/config/lua/PaneInformation.md
+++ b/docs/config/lua/PaneInformation.md
@ -59,7 +59,7 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 The `has_unseen_output` field returns true if the there has been output
 in the pane since the last time it was focused.
--- a/docs/config/lua/SshDomain.md
+++ b/docs/config/lua/SshDomain.md
@ -54,7 +54,7 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 You may now specify the type of `multiplexing` used by an ssh domain.
 The following values are possible:
--- a/docs/config/lua/TlsDomainClient.md
+++ b/docs/config/lua/TlsDomainClient.md
@ -66,7 +66,7 @@ It is a lua object with the following fields:
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 You may now specify the round-trip latency threshold for enabling predictive
 local echo using `local_echo_threshold_ms`. If the measured round-trip latency
--- a/docs/config/lua/WslDomain.md
+++ b/docs/config/lua/WslDomain.md
@ -1,6 +1,6 @@
 # WslDomain

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 The `WslDomain` struct specifies information about an individual `WslDomain`,
 which is used to tell wezterm how to interact with one of your locally
--- a/docs/config/lua/config/animation_fps.md
+++ b/docs/config/lua/config/animation_fps.md
@ -1,6 +1,6 @@
 # `animation_fps = 10`

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 This setting controls the maximum frame rate used when rendering easing effects
 for blinking cursors, blinking text and visual bell.
--- a/docs/config/lua/config/canonicalize_pasted_newlines.md
+++ b/docs/config/lua/config/canonicalize_pasted_newlines.md
@ -13,12 +13,12 @@ The following values are accepted:
 |-----|-------|---------------|
 |`true` |same as `"CarriageReturnAndLineFeed"`|*Since: 20211204-082213-a66c61ee9*|
 |`false` |same as `"None"`|*Since: 20211204-082213-a66c61ee9*|
-|`"None"` |The text is passed through unchanged|*Since: nightly builds only*|
-|`"LineFeed"` |Newlines of any style are rewritten as LF|*Since: nightly builds only*|
-|`"CarriageReturn"` |Newlines of any style are rewritten as CR|*Since: nightly builds only*|
-|`"CarriageReturnAndLineFeed"` |Newlines of any style are rewritten as CRLF|*Since: nightly builds only*|
+|`"None"` |The text is passed through unchanged|*Since: 20220319-142410-0fcdea07*|
+|`"LineFeed"` |Newlines of any style are rewritten as LF|*Since: 20220319-142410-0fcdea07*|
+|`"CarriageReturn"` |Newlines of any style are rewritten as CR|*Since: 20220319-142410-0fcdea07*|
+|`"CarriageReturnAndLineFeed"` |Newlines of any style are rewritten as CRLF|*Since: 20220319-142410-0fcdea07*|

-Note that the string forms of these values are accepted in nightly builds only,
+Note that the string forms of these values are accepted in 20220319-142410-0fcdea07,
 however, `true` in all prior versions behaves the same way as
 `"CarriageReturnAndLineFeed"` behaves in the nightly build.

@ -28,7 +28,7 @@ The default value has changed in different versions of wezterm:
 |-------|--------|-------|
 |20211204-082213-a66c61ee9|Windows|`"CarriageReturnAndLineFeed"`|
 |20211204-082213-a66c61ee9|NOT Windows|`"None"`|
-|nightly builds only|NOT Windows|`"CarriageReturn"`|
+|20220319-142410-0fcdea07|NOT Windows|`"CarriageReturn"`|

 On Windows we're in a bit of a frustrating situation: pasting into
 Windows console programs requires CRLF otherwise there is no newline
--- a/docs/config/lua/config/cursor_blink_ease_in.md
+++ b/docs/config/lua/config/cursor_blink_ease_in.md
@ -1,6 +1,6 @@
 # cursor_blink_ease_in = "Linear"

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Specifies the *easing function* to use when computing the color
 for the text cursor when it is set to a blinking style.
--- a/docs/config/lua/config/cursor_blink_ease_out.md
+++ b/docs/config/lua/config/cursor_blink_ease_out.md
@ -1,6 +1,6 @@
 # cursor_blink_ease_out = "Linear"

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Specifies the *easing function* to use when computing the color
 for the text cursor when it is set to a blinking style.
--- a/docs/config/lua/config/cursor_blink_rate.md
+++ b/docs/config/lua/config/cursor_blink_rate.md
@ -16,7 +16,7 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 The cursor blink is controlled by the easing functions specified by the
 [cursor_blink_ease_in](cursor_blink_ease_in.md) and
--- a/docs/config/lua/config/default_domain.md
+++ b/docs/config/lua/config/default_domain.md
@ -1,6 +1,6 @@
 # `default_domain = "local"`

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 When starting the GUI (not using the `serial` or `connect` subcommands), by default wezterm will set the built-in `"local"` domain as the default multiplexing domain.

--- a/docs/config/lua/config/default_workspace.md
+++ b/docs/config/lua/config/default_workspace.md
@ -1,6 +1,6 @@
 # `default_workspace = "default"`

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Specifies the name of the default workspace.
 The default is `"default"`.
--- a/docs/config/lua/config/force_reverse_video_cursor.md
+++ b/docs/config/lua/config/force_reverse_video_cursor.md
@ -10,7 +10,7 @@ colors.
 When `force_reverse_video_cursor = false` (the default), `cursor_fg`,
 `cursor_bg` and `cursor_border` color scheme settings are applied as normal.

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 If escape sequences are used to change the cursor color, they will take
 precedence over `force_reverse_video_cursor`.  In earlier releases, setting
--- a/docs/config/lua/config/swallow_mouse_click_on_window_focus.md
+++ b/docs/config/lua/config/swallow_mouse_click_on_window_focus.md
@ -1,6 +1,6 @@
 # `swallow_mouse_click_on_window_focus`

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 When set to `true`, clicking on a wezterm window will focus it.

--- a/docs/config/lua/config/text_blink_ease_in.md
+++ b/docs/config/lua/config/text_blink_ease_in.md
@ -1,6 +1,6 @@
 # text_blink_ease_in = "Linear"

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Specifies the *easing function* to use when computing the color
 for text that has the blinking attribute in the fading-in
--- a/docs/config/lua/config/text_blink_ease_out.md
+++ b/docs/config/lua/config/text_blink_ease_out.md
@ -1,6 +1,6 @@
 # text_blink_ease_out = "Linear"

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Specifies the *easing function* to use when computing the color
 for text that has the blinking attribute in the fading-out
--- a/docs/config/lua/config/text_blink_rapid_ease_in.md
+++ b/docs/config/lua/config/text_blink_rapid_ease_in.md
@ -1,6 +1,6 @@
 # text_blink_rapid_ease_in = "Linear"

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Specifies the *easing function* to use when computing the color
 for text that has the rapid blinking attribute in the fading-in
--- a/docs/config/lua/config/text_blink_rapid_ease_out.md
+++ b/docs/config/lua/config/text_blink_rapid_ease_out.md
@ -1,6 +1,6 @@
 # text_blink_rapid_ease_out = "Linear"

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Specifies the *easing function* to use when computing the color
 for text that has the rapid blinking attribute in the fading-out
--- a/docs/config/lua/config/text_blink_rate.md
+++ b/docs/config/lua/config/text_blink_rate.md
@ -14,7 +14,7 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Blinking is no longer a binary blink, but interpolates between invisible and
 visible text using an easing function.  See
--- a/docs/config/lua/config/text_blink_rate_rapid.md
+++ b/docs/config/lua/config/text_blink_rate_rapid.md
@ -14,7 +14,7 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Blinking is no longer a binary blink, but interpolates between invisible and
 visible text using an easing function.  See
--- a/docs/config/lua/config/use_ime.md
+++ b/docs/config/lua/config/use_ime.md
@ -33,6 +33,6 @@ environment variable or the new [xim_im_name](xim_im_name.md) configuration
 option is set appropriately before wezterm is launched!  For
 example, Gnome users will probably want to set `XMODIFIERS=@im=ibus`.

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 The default for all systems is now `true`
--- a/docs/config/lua/config/wsl_domains.md
+++ b/docs/config/lua/config/wsl_domains.md
@ -1,6 +1,6 @@
 # `wsl_domains`

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Configures [WSL](https://docs.microsoft.com/en-us/windows/wsl/about) domains.

--- a/docs/config/lua/keyassignment/ActivatePaneByIndex.md
+++ b/docs/config/lua/keyassignment/ActivatePaneByIndex.md
@ -1,6 +1,6 @@
 # ActivatePaneByIndex

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 `ActivatePaneByIndex` activates the pane with the specified index within
 the current tab.  Invalid indices are ignored.
--- a/docs/config/lua/keyassignment/CopyTo.md
+++ b/docs/config/lua/keyassignment/CopyTo.md
@ -17,6 +17,6 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 `PrimarySelection` is now also supported on Wayland systems that support [primary-selection-unstable-v1](https://wayland.app/protocols/primary-selection-unstable-v1) or the older Gtk primary selection protocol.
--- a/docs/config/lua/keyassignment/PasteFrom.md
+++ b/docs/config/lua/keyassignment/PasteFrom.md
@ -24,6 +24,6 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 `PrimarySelection` is now also supported on Wayland systems that support [primary-selection-unstable-v1](https://wayland.app/protocols/primary-selection-unstable-v1) or the older Gtk primary selection protocol.
--- a/docs/config/lua/keyassignment/ScrollByPage.md
+++ b/docs/config/lua/keyassignment/ScrollByPage.md
@ -14,7 +14,7 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 You may now use floating point values to scroll by partial pages.  This example shows
 how to make the `PageUp`/`PageDown` scroll by half a page at a time:
--- a/docs/config/lua/keyassignment/ShowLauncherArgs.md
+++ b/docs/config/lua/keyassignment/ShowLauncherArgs.md
@ -1,6 +1,6 @@
 # ShowLauncherArgs

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Activate the [Launcher Menu](../../launch.md#the-launcher-menu)
 in the current tab, scoping it to a set of items and with an optional title.
--- a/docs/config/lua/keyassignment/SwitchToWorkspace.md
+++ b/docs/config/lua/keyassignment/SwitchToWorkspace.md
@ -1,6 +1,6 @@
 # SwitchToWorkspace

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Switch to a different workspace, creating it if it doesn't already exist.

--- a/docs/config/lua/keyassignment/SwitchWorkspaceRelative.md
+++ b/docs/config/lua/keyassignment/SwitchWorkspaceRelative.md
@ -1,6 +1,6 @@
 # SwitchWorkspaceRelative

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Switch to the workspace relative to the current workspace.  Workspaces are ordered
 lexicographically based on their names.
--- a/docs/config/lua/pane/has_unseen_output.md
+++ b/docs/config/lua/pane/has_unseen_output.md
@ -1,6 +1,6 @@
 # `pane:has_unseen_output()`

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Returns true if there has been output in the pane since the last time
 the time the pane was focused.
--- a/docs/config/lua/wezterm/default_wsl_domains.md
+++ b/docs/config/lua/wezterm/default_wsl_domains.md
@ -1,6 +1,6 @@
 # wezterm.default_wsl_domains()

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Computes a list of [WslDomain](../WslDomain.md) objects, each one
 representing an installed
--- a/docs/config/lua/wezterm/enumerate_ssh_hosts.md
+++ b/docs/config/lua/wezterm/enumerate_ssh_hosts.md
@ -1,6 +1,6 @@
 # wezterm.enumerate_ssh_hosts(\[ssh_config_file_name, ...\])

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 This function will parse your ssh configuration file(s) and extract from them
 the set of literal (non-pattern, non-negated) host names that are specified in
--- a/docs/config/lua/wezterm/font.md
+++ b/docs/config/lua/wezterm/font.md
@ -94,7 +94,7 @@ The following options can be specified in the same way:
 * [freetype_render_target](../config/freetype_render_target.md)
 * [freetype_load_flags](../config/freetype_load_flags.md)

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 You may now specify `style="Normal"`, `style="Italic"` or `style="Oblique"`
 instead of simply specifying a boolean `italic` value such as `italic=true`.
--- a/docs/config/lua/wezterm/nerdfonts.md
+++ b/docs/config/lua/wezterm/nerdfonts.md
@ -1,6 +1,6 @@
 # `wezterm.nerdfonts`

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 A special userdata value that can be used to resolve the symbolic name
 of a glyph from the [Nerd Fonts](https://www.nerdfonts.com/cheat-sheet)
--- a/docs/config/lua/window/active_workspace.md
+++ b/docs/config/lua/window/active_workspace.md
@ -1,6 +1,6 @@
 # window:active_workspace()

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Returns the name of the active workspace.

--- a/docs/config/lua/window/composition_status.md
+++ b/docs/config/lua/window/composition_status.md
@ -1,6 +1,6 @@
 # wezterm:composition_status()

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Returns a string holding the current dead key or IME composition text,
 or `nil` if the input layer is not in a composition state.
--- a/docs/config/lua/window/leader_is_active.md
+++ b/docs/config/lua/window/leader_is_active.md
@ -1,6 +1,6 @@
 # wezterm:leader_is_active()

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 Returns `true` if the [Leader Key](../../keys.md) is active in the window, or false otherwise.

--- a/docs/imgcat.md
+++ b/docs/imgcat.md
@ -18,7 +18,7 @@ $ wezterm imgcat /path/to/image.png
 at this time**.


-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 WezTerm supports an extension to the protocol; passing `doNotMoveCursor=1` as
 an argument to the `File` escape sequence causes wezterm to not move the cursor
--- a/docs/multiplexing.md
+++ b/docs/multiplexing.md
@ -158,7 +158,7 @@ return {
 }
 ```

-*Since: nightly builds only*
+*Since: 20220319-142410-0fcdea07*

 You may now specify the round-trip latency threshold for enabling predictive
 local echo using `local_echo_threshold_ms`. If the measured round-trip latency