From fc14ac87fcda8123035377868ec742297f4dcab8 Mon Sep 17 00:00:00 2001 From: Wez Furlong Date: Fri, 24 Jun 2022 14:58:18 -0700 Subject: [PATCH] docs: update for release --- docs/changelog.md | 4 ++++ docs/cli/cli/list-clients.md | 2 +- docs/cli/cli/list.md | 2 +- docs/cli/cli/move-pane-to-new-tab.md | 2 +- docs/cli/cli/send-text.md | 2 +- docs/cli/cli/split-pane.md | 2 +- docs/cli/show-keys.md | 2 +- docs/config/key-tables.md | 2 +- docs/config/lua/MuxPane.md | 2 +- docs/config/lua/MuxTab.md | 2 +- docs/config/lua/MuxWindow.md | 2 +- docs/config/lua/PaneInformation.md | 2 +- docs/config/lua/config/allow_win32_input_mode.md | 2 +- docs/config/lua/config/background.md | 2 +- docs/config/lua/config/cell_width.md | 2 +- docs/config/lua/config/clean_exit_codes.md | 2 +- docs/config/lua/config/enable_kitty_keyboard.md | 2 +- docs/config/lua/config/enable_wayland.md | 2 +- docs/config/lua/config/exit_behavior.md | 2 +- .../lua/config/freetype_pcf_long_family_names.md | 2 +- docs/config/lua/config/ime_preedit_rendering.md | 2 +- docs/config/lua/config/min_scroll_bar_height.md | 2 +- docs/config/lua/config/quote_dropped_files.md | 8 ++++---- .../config/treat_east_asian_ambiguous_width_as_wide.md | 2 +- docs/config/lua/config/window_background_gradient.md | 2 +- docs/config/lua/gui-events/gui-startup.md | 2 +- docs/config/lua/keyassignment/AttachDomain.md | 2 +- docs/config/lua/keyassignment/ClearSelection.md | 2 +- docs/config/lua/keyassignment/DetachDomain.md | 2 +- .../lua/keyassignment/ExtendSelectionToMouseCursor.md | 2 +- docs/config/lua/keyassignment/PaneSelect.md | 2 +- docs/config/lua/keyassignment/RotatePanes.md | 2 +- docs/config/lua/keyassignment/Search.md | 2 +- .../lua/keyassignment/SelectTextAtMouseCursor.md | 2 +- docs/config/lua/keyassignment/SplitPane.md | 2 +- docs/config/lua/mux-events/mux-startup.md | 2 +- docs/config/lua/pane/get_domain_name.md | 2 +- docs/config/lua/pane/get_foreground_process_info.md | 2 +- docs/config/lua/wezterm.mux/get_active_workspace.md | 2 +- docs/config/lua/wezterm.mux/get_pane.md | 2 +- docs/config/lua/wezterm.mux/get_tab.md | 2 +- docs/config/lua/wezterm.mux/get_window.md | 2 +- docs/config/lua/wezterm.mux/get_workspace_names.md | 2 +- docs/config/lua/wezterm.mux/index.markdown | 2 +- docs/config/lua/wezterm.mux/set_active_workspace.md | 2 +- docs/config/lua/wezterm.mux/spawn_window.md | 2 +- docs/config/lua/wezterm/GLOBAL.md | 2 +- docs/config/lua/wezterm/strftime_utc.md | 2 +- docs/config/mouse.md | 10 +++++----- docs/copymode.md | 4 ++-- docs/faq.md | 2 +- docs/scrollback.md | 2 +- 52 files changed, 63 insertions(+), 59 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 015d806e3..b33fca97b 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -11,6 +11,10 @@ usually the best available version. As features stabilize some brief notes about them will accumulate here. +* Not yet + +### 20220624-141144-bd1b7c5d + #### New * [background](config/lua/config/background.md) option for rich background compositing and parallax scrolling effects. * Added [docs for the cli](cli/general.md) diff --git a/docs/cli/cli/list-clients.md b/docs/cli/cli/list-clients.md index 3c05cb43c..ce44c8246 100644 --- a/docs/cli/cli/list-clients.md +++ b/docs/cli/cli/list-clients.md @@ -20,7 +20,7 @@ The meanings of the fields are: * `WORKSPACE` - shows the active workspace for that session * `FOCUS` - shows the pane id of the pane that has focus in that session -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* You may request JSON output: diff --git a/docs/cli/cli/list.md b/docs/cli/cli/list.md index 93e97822e..50ccae7d0 100644 --- a/docs/cli/cli/list.md +++ b/docs/cli/cli/list.md @@ -22,7 +22,7 @@ Each row describes a pane. The meaning of the fields are: * `TITLE` - the pane title * `CWD` - the current working directory associated with the pane -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* You may request JSON output: diff --git a/docs/cli/cli/move-pane-to-new-tab.md b/docs/cli/cli/move-pane-to-new-tab.md index a40e4d8ff..1c01c8b74 100644 --- a/docs/cli/cli/move-pane-to-new-tab.md +++ b/docs/cli/cli/move-pane-to-new-tab.md @@ -1,6 +1,6 @@ # `wezterm cli move-pane-to-new-tab` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* *Run `wezterm cli move-pane-to-new-tab --help` to see more help* diff --git a/docs/cli/cli/send-text.md b/docs/cli/cli/send-text.md index 6660e9b8a..8f1a696f2 100644 --- a/docs/cli/cli/send-text.md +++ b/docs/cli/cli/send-text.md @@ -21,5 +21,5 @@ $ echo hello there | wezterm cli send-text The following arguments modify the behavior: -* `--no-paste` - Send the text directly, rather than as a bracketed paste. (*Since: nightly builds only*) +* `--no-paste` - Send the text directly, rather than as a bracketed paste. (*Since: 20220624-141144-bd1b7c5d*) * `--pane-id` - Specifies which pane to send the text to. See also [Targeting Panes](index.md#targeting-panes). diff --git a/docs/cli/cli/split-pane.md b/docs/cli/cli/split-pane.md index 18469d0cb..1af4909f0 100644 --- a/docs/cli/cli/split-pane.md +++ b/docs/cli/cli/split-pane.md @@ -37,7 +37,7 @@ The following options affect the behavior: * `--pane-id` - Specifies the pane that should be split. See also [Targeting Panes](index.md#targeting-panes). -*Since nightly builds only* +*Since 20220624-141144-bd1b7c5d* * `--bottom` - Split vertically, with the new pane on the bottom. * `--cells CELLS` - The number of cells that the new split should have. If omitted, 50% of the available space is used. diff --git a/docs/cli/show-keys.md b/docs/cli/show-keys.md index 1fe04afc0..6df3ea250 100644 --- a/docs/cli/show-keys.md +++ b/docs/cli/show-keys.md @@ -1,6 +1,6 @@ # `wezterm show-keys` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Prints the complete set of key assignments based on your config file. diff --git a/docs/config/key-tables.md b/docs/config/key-tables.md index 8075eb518..65bc1afc2 100644 --- a/docs/config/key-tables.md +++ b/docs/config/key-tables.md @@ -119,7 +119,7 @@ The stack is also cleared when the configuration is reloaded, so if you're working on a complex key table setup and get stuck, you may be able to unstick yourself by re-saving your wezterm configuration to trigger a reload. -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* When resolving a key assignment, the top of stack is first searched for a match, and if one is not found, the next entry on the stack is searched and so on until a match is found. diff --git a/docs/config/lua/MuxPane.md b/docs/config/lua/MuxPane.md index 96252d957..f2eafaa32 100644 --- a/docs/config/lua/MuxPane.md +++ b/docs/config/lua/MuxPane.md @@ -1,6 +1,6 @@ # MuxPane -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* `MuxPane` represents a pane that is managed by the multiplexer. diff --git a/docs/config/lua/MuxTab.md b/docs/config/lua/MuxTab.md index 49e23710c..56ae1f92f 100644 --- a/docs/config/lua/MuxTab.md +++ b/docs/config/lua/MuxTab.md @@ -1,6 +1,6 @@ # MuxTab -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* `MuxTab` represents a tab that is managed by the multiplexer. diff --git a/docs/config/lua/MuxWindow.md b/docs/config/lua/MuxWindow.md index 82e5f64f5..dc6f89865 100644 --- a/docs/config/lua/MuxWindow.md +++ b/docs/config/lua/MuxWindow.md @@ -1,6 +1,6 @@ # MuxWindow -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* `MuxWindow` represents a window that is managed by the multiplexer. diff --git a/docs/config/lua/PaneInformation.md b/docs/config/lua/PaneInformation.md index 139b85112..411075bc4 100644 --- a/docs/config/lua/PaneInformation.md +++ b/docs/config/lua/PaneInformation.md @@ -97,7 +97,7 @@ return { } ``` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The `domain_name` field returns the name of the domain with which the pane is associated. diff --git a/docs/config/lua/config/allow_win32_input_mode.md b/docs/config/lua/config/allow_win32_input_mode.md index 2e2924d8f..c28e9c3cb 100644 --- a/docs/config/lua/config/allow_win32_input_mode.md +++ b/docs/config/lua/config/allow_win32_input_mode.md @@ -9,7 +9,7 @@ applications. See also [Improved Keyboard Handling in ConPTY](https://github.com/microsoft/terminal/blob/main/doc/specs/%234999%20-%20Improved%20keyboard%20handling%20in%20Conpty.md). -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The default for `allow_win32_input_mode` is now true. diff --git a/docs/config/lua/config/background.md b/docs/config/lua/config/background.md index 48da2e794..77537c316 100644 --- a/docs/config/lua/config/background.md +++ b/docs/config/lua/config/background.md @@ -1,6 +1,6 @@ # background -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The `background` config option allows you to compose a number of layers to produce the background content in the terminal. diff --git a/docs/config/lua/config/cell_width.md b/docs/config/lua/config/cell_width.md index 7249db104..8e56d9dfa 100644 --- a/docs/config/lua/config/cell_width.md +++ b/docs/config/lua/config/cell_width.md @@ -1,6 +1,6 @@ # `cell_width = 1.0` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Scales the computed cell width to adjust the spacing between successive cells of text. diff --git a/docs/config/lua/config/clean_exit_codes.md b/docs/config/lua/config/clean_exit_codes.md index 5794da76a..2da99a5be 100644 --- a/docs/config/lua/config/clean_exit_codes.md +++ b/docs/config/lua/config/clean_exit_codes.md @@ -1,6 +1,6 @@ ## `clean_exit_codes = { 0 }` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Defines the set of exit codes that are considered to be a "clean" exit by [exit_behavior](exit_behavior.md) when the program running in the terminal diff --git a/docs/config/lua/config/enable_kitty_keyboard.md b/docs/config/lua/config/enable_kitty_keyboard.md index f3c0250a0..741aea35d 100644 --- a/docs/config/lua/config/enable_kitty_keyboard.md +++ b/docs/config/lua/config/enable_kitty_keyboard.md @@ -1,6 +1,6 @@ # `enable_kitty_keyboard = false` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* When set to `true`, wezterm will honor kitty keyboard protocol escape sequences that modify the [keyboard encoding](../../key-encoding.md). diff --git a/docs/config/lua/config/enable_wayland.md b/docs/config/lua/config/enable_wayland.md index 4e2b393da..348409c69 100644 --- a/docs/config/lua/config/enable_wayland.md +++ b/docs/config/lua/config/enable_wayland.md @@ -14,6 +14,6 @@ return { } ``` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The default is now `true`. diff --git a/docs/config/lua/config/exit_behavior.md b/docs/config/lua/config/exit_behavior.md index a77bfa7fc..9fe728ffc 100644 --- a/docs/config/lua/config/exit_behavior.md +++ b/docs/config/lua/config/exit_behavior.md @@ -33,7 +33,7 @@ the pane to remain open. See also: [clean_exit_codes](clean_exit_codes.md) for fine tuning what is considered to be a clean exit status. -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The default is now `"Close"`. diff --git a/docs/config/lua/config/freetype_pcf_long_family_names.md b/docs/config/lua/config/freetype_pcf_long_family_names.md index 3947447ea..ad7de83ff 100644 --- a/docs/config/lua/config/freetype_pcf_long_family_names.md +++ b/docs/config/lua/config/freetype_pcf_long_family_names.md @@ -1,6 +1,6 @@ # `freetype_pcf_long_family_names = false` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* This option provides control over the [no-long-family-names](https://freetype.org/freetype2/docs/reference/ft2-properties.html#no-long-family-names) diff --git a/docs/config/lua/config/ime_preedit_rendering.md b/docs/config/lua/config/ime_preedit_rendering.md index d5630f293..5c6fddf9f 100644 --- a/docs/config/lua/config/ime_preedit_rendering.md +++ b/docs/config/lua/config/ime_preedit_rendering.md @@ -1,6 +1,6 @@ # `ime_preedit_rendering` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Control IME preedit rendering. IME preedit is an area that is used to display the string being preedited in IME. diff --git a/docs/config/lua/config/min_scroll_bar_height.md b/docs/config/lua/config/min_scroll_bar_height.md index 3938af8e3..dcee3382d 100644 --- a/docs/config/lua/config/min_scroll_bar_height.md +++ b/docs/config/lua/config/min_scroll_bar_height.md @@ -1,6 +1,6 @@ # `min_scroll_bar_height = "0.5cell"` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Controls the minimum size of the scroll bar "thumb". diff --git a/docs/config/lua/config/quote_dropped_files.md b/docs/config/lua/config/quote_dropped_files.md index 6c89f4e11..7ffea8fdd 100644 --- a/docs/config/lua/config/quote_dropped_files.md +++ b/docs/config/lua/config/quote_dropped_files.md @@ -1,6 +1,6 @@ ## quote_dropped_files = "SpacesOnly" -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Controls how file names are quoted (or not) when dragging and dropping. There are five possible values: @@ -25,7 +25,7 @@ Drag and drop support for files is a platform dependent feature |Platform |Supported since | |----------|-------------------| -|macOS |nightly builds only| -|Windows |nightly builds only| +|macOS |20220624-141144-bd1b7c5d| +|Windows |20220624-141144-bd1b7c5d| |X11 |Not yet | -|Wayland |nightly builds only| +|Wayland |20220624-141144-bd1b7c5d| diff --git a/docs/config/lua/config/treat_east_asian_ambiguous_width_as_wide.md b/docs/config/lua/config/treat_east_asian_ambiguous_width_as_wide.md index 784c30756..9c8926644 100644 --- a/docs/config/lua/config/treat_east_asian_ambiguous_width_as_wide.md +++ b/docs/config/lua/config/treat_east_asian_ambiguous_width_as_wide.md @@ -1,6 +1,6 @@ # `treat_east_asian_ambiguous_width_as_wide = false` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Unicode defines a number of codepoints as having [Ambiguous Width](http://www.unicode.org/reports/tr11/#Ambiguous). These are characters diff --git a/docs/config/lua/config/window_background_gradient.md b/docs/config/lua/config/window_background_gradient.md index ea1bdbf2a..0880caa52 100644 --- a/docs/config/lua/config/window_background_gradient.md +++ b/docs/config/lua/config/window_background_gradient.md @@ -71,7 +71,7 @@ for some usage examples and additional information about gradients. ## Linear gradient: -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* A linear gradient follows a linear path across the window. It can be rotated around the window center. The angle is described in degrees and moves diff --git a/docs/config/lua/gui-events/gui-startup.md b/docs/config/lua/gui-events/gui-startup.md index 82b61fe86..7fa5ebde4 100644 --- a/docs/config/lua/gui-events/gui-startup.md +++ b/docs/config/lua/gui-events/gui-startup.md @@ -1,6 +1,6 @@ # `gui-startup` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The `gui-startup` event is emitted once when the GUI server is starting up when running the `wezterm start` subcommand. diff --git a/docs/config/lua/keyassignment/AttachDomain.md b/docs/config/lua/keyassignment/AttachDomain.md index f8f1ac261..7ec170121 100644 --- a/docs/config/lua/keyassignment/AttachDomain.md +++ b/docs/config/lua/keyassignment/AttachDomain.md @@ -1,6 +1,6 @@ # AttachDomain(domain_name) -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Attempts to attach the named multiplexing domain. The name can be any of the names used in you `ssh_domains`, `unix_domains` or `tls_clients` diff --git a/docs/config/lua/keyassignment/ClearSelection.md b/docs/config/lua/keyassignment/ClearSelection.md index 64bff5356..4618c41ab 100644 --- a/docs/config/lua/keyassignment/ClearSelection.md +++ b/docs/config/lua/keyassignment/ClearSelection.md @@ -1,6 +1,6 @@ # ClearSelection -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Clears the selection in the current pane. diff --git a/docs/config/lua/keyassignment/DetachDomain.md b/docs/config/lua/keyassignment/DetachDomain.md index 1e58866c9..d8e42bf4e 100644 --- a/docs/config/lua/keyassignment/DetachDomain.md +++ b/docs/config/lua/keyassignment/DetachDomain.md @@ -1,6 +1,6 @@ # DetachDomain(domain) -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Attempts to detach the specified domain. Detaching a domain causes it to disconnect and remove its set of windows, tabs and panes from diff --git a/docs/config/lua/keyassignment/ExtendSelectionToMouseCursor.md b/docs/config/lua/keyassignment/ExtendSelectionToMouseCursor.md index 7aeb3f975..0fc28f1a7 100644 --- a/docs/config/lua/keyassignment/ExtendSelectionToMouseCursor.md +++ b/docs/config/lua/keyassignment/ExtendSelectionToMouseCursor.md @@ -23,6 +23,6 @@ when unspecified, wezterm will use a default mode which at the time of writing is `Cell`, but in a future release may be context sensitive based on recent actions. -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The mode argument can also be `"Block"` to enable a rectangular block selection. diff --git a/docs/config/lua/keyassignment/PaneSelect.md b/docs/config/lua/keyassignment/PaneSelect.md index 52af7d875..d5892e3bc 100644 --- a/docs/config/lua/keyassignment/PaneSelect.md +++ b/docs/config/lua/keyassignment/PaneSelect.md @@ -1,6 +1,6 @@ # PaneSelect -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* This action activates the pane selection modal display. In this mode, each pane will be overlayed with a one- or two-character label taken from the selection diff --git a/docs/config/lua/keyassignment/RotatePanes.md b/docs/config/lua/keyassignment/RotatePanes.md index 6dec44fcc..7b1e24b21 100644 --- a/docs/config/lua/keyassignment/RotatePanes.md +++ b/docs/config/lua/keyassignment/RotatePanes.md @@ -1,6 +1,6 @@ # RotatePanes -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Rotates the sequence of panes within the active tab, preserving the sizes based on the tab positions. diff --git a/docs/config/lua/keyassignment/Search.md b/docs/config/lua/keyassignment/Search.md index bf3abd501..11f09f8d8 100644 --- a/docs/config/lua/keyassignment/Search.md +++ b/docs/config/lua/keyassignment/Search.md @@ -27,7 +27,7 @@ return { [Learn more about the search overlay](../../../scrollback.html#searching-the-scrollback) -*since: nightly builds only* +*since: 20220624-141144-bd1b7c5d* You may now use `wezterm.action{Search="CurrentSelectionOrEmptyString"}` to have the search take the currently selected text as the item to search. diff --git a/docs/config/lua/keyassignment/SelectTextAtMouseCursor.md b/docs/config/lua/keyassignment/SelectTextAtMouseCursor.md index fb75930e3..2ebfe3fa1 100644 --- a/docs/config/lua/keyassignment/SelectTextAtMouseCursor.md +++ b/docs/config/lua/keyassignment/SelectTextAtMouseCursor.md @@ -27,6 +27,6 @@ return { [See Shell Integration docs](../../../shell-integration.md) for more details on how to set up your shell to define semantic zones. -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The mode argument can also be `"Block"` to enable a rectangular block selection. diff --git a/docs/config/lua/keyassignment/SplitPane.md b/docs/config/lua/keyassignment/SplitPane.md index abdddc3f2..4c4d8254b 100644 --- a/docs/config/lua/keyassignment/SplitPane.md +++ b/docs/config/lua/keyassignment/SplitPane.md @@ -1,6 +1,6 @@ # SplitPane -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Splits the active pane in a particular direction, spawning a new command into the newly created pane. diff --git a/docs/config/lua/mux-events/mux-startup.md b/docs/config/lua/mux-events/mux-startup.md index 860fbc4ab..cc68019e2 100644 --- a/docs/config/lua/mux-events/mux-startup.md +++ b/docs/config/lua/mux-events/mux-startup.md @@ -1,6 +1,6 @@ # `mux-startup` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The `mux-startup` event is emitted once when the mux server is starting up. It is triggered before any default program is started. diff --git a/docs/config/lua/pane/get_domain_name.md b/docs/config/lua/pane/get_domain_name.md index 2af541dcd..69aeff6e3 100644 --- a/docs/config/lua/pane/get_domain_name.md +++ b/docs/config/lua/pane/get_domain_name.md @@ -1,5 +1,5 @@ # `pane:get_domain_name()` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Returns the name of the domain with which the pane is associated. diff --git a/docs/config/lua/pane/get_foreground_process_info.md b/docs/config/lua/pane/get_foreground_process_info.md index ede95ea7a..a6e0a942b 100644 --- a/docs/config/lua/pane/get_foreground_process_info.md +++ b/docs/config/lua/pane/get_foreground_process_info.md @@ -1,6 +1,6 @@ # `pane:get_foreground_process_info()` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Returns a [LocalProcessInfo](../LocalProcessInfo.md) object corresponding to the current foreground process that is running in the pane. diff --git a/docs/config/lua/wezterm.mux/get_active_workspace.md b/docs/config/lua/wezterm.mux/get_active_workspace.md index af36c48c1..d772ce1ab 100644 --- a/docs/config/lua/wezterm.mux/get_active_workspace.md +++ b/docs/config/lua/wezterm.mux/get_active_workspace.md @@ -1,6 +1,6 @@ # `wezterm.mux.get_active_workspace()` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Returns the name of the active workspace. diff --git a/docs/config/lua/wezterm.mux/get_pane.md b/docs/config/lua/wezterm.mux/get_pane.md index 8f7ea18f9..fff8ccfe0 100644 --- a/docs/config/lua/wezterm.mux/get_pane.md +++ b/docs/config/lua/wezterm.mux/get_pane.md @@ -1,6 +1,6 @@ # `wezterm.mux.get_pane(PANE_ID)` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Given a pane ID, verifies that the ID is a valid pane known to the mux and returns a [MuxPane](../MuxPane.md) object that can be used to diff --git a/docs/config/lua/wezterm.mux/get_tab.md b/docs/config/lua/wezterm.mux/get_tab.md index bc94ce2de..65ed9f452 100644 --- a/docs/config/lua/wezterm.mux/get_tab.md +++ b/docs/config/lua/wezterm.mux/get_tab.md @@ -1,6 +1,6 @@ # `wezterm.mux.get_tab(WINDOW_ID)` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Given a tab ID, verifies that the ID is a valid tab known to the mux and returns a [MuxTab](../MuxTab.md) object that can be used to diff --git a/docs/config/lua/wezterm.mux/get_window.md b/docs/config/lua/wezterm.mux/get_window.md index ce4fe44ec..7a647556e 100644 --- a/docs/config/lua/wezterm.mux/get_window.md +++ b/docs/config/lua/wezterm.mux/get_window.md @@ -1,6 +1,6 @@ # `wezterm.mux.get_window(WINDOW_ID)` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Given a window ID, verifies that the ID is a valid window known to the mux and returns a [MuxWindow](../MuxWindow.md) object that can be used to diff --git a/docs/config/lua/wezterm.mux/get_workspace_names.md b/docs/config/lua/wezterm.mux/get_workspace_names.md index 772584786..3f060518d 100644 --- a/docs/config/lua/wezterm.mux/get_workspace_names.md +++ b/docs/config/lua/wezterm.mux/get_workspace_names.md @@ -1,6 +1,6 @@ # `wezterm.mux.get_workspace_names()` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Returns a table containing the names of the workspaces known to the mux. diff --git a/docs/config/lua/wezterm.mux/index.markdown b/docs/config/lua/wezterm.mux/index.markdown index 878aa0c38..09392dcbf 100644 --- a/docs/config/lua/wezterm.mux/index.markdown +++ b/docs/config/lua/wezterm.mux/index.markdown @@ -1,4 +1,4 @@ -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The `wezterm.mux` module exposes functions that operate on the multiplexer layer. diff --git a/docs/config/lua/wezterm.mux/set_active_workspace.md b/docs/config/lua/wezterm.mux/set_active_workspace.md index 70a73e4ab..7045e7bc6 100644 --- a/docs/config/lua/wezterm.mux/set_active_workspace.md +++ b/docs/config/lua/wezterm.mux/set_active_workspace.md @@ -1,6 +1,6 @@ # `wezterm.mux.set_active_workspace(WORKSPACE)` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Sets the active workspace name. diff --git a/docs/config/lua/wezterm.mux/spawn_window.md b/docs/config/lua/wezterm.mux/spawn_window.md index b8b155f68..0bc964e17 100644 --- a/docs/config/lua/wezterm.mux/spawn_window.md +++ b/docs/config/lua/wezterm.mux/spawn_window.md @@ -1,6 +1,6 @@ ## `wezterm.mux.spawn_window{}` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Spawns a program into a new window, returning the [MuxTab](../MuxTab.md), [MuxPane](../MuxPane.md) and [MuxWindow](../MuxWindow.md) objects diff --git a/docs/config/lua/wezterm/GLOBAL.md b/docs/config/lua/wezterm/GLOBAL.md index bab4c6fbb..b9a0deddf 100644 --- a/docs/config/lua/wezterm/GLOBAL.md +++ b/docs/config/lua/wezterm/GLOBAL.md @@ -1,6 +1,6 @@ # `wezterm.GLOBAL` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Provides global, in-process, in-memory, data storage for json-like variables that persists across config reloads. diff --git a/docs/config/lua/wezterm/strftime_utc.md b/docs/config/lua/wezterm/strftime_utc.md index 0cd1b9a49..69e83937a 100644 --- a/docs/config/lua/wezterm/strftime_utc.md +++ b/docs/config/lua/wezterm/strftime_utc.md @@ -1,6 +1,6 @@ # `wezterm.strftime_utc(format)` -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* Formats the current UTC date/time into a string using [the Rust chrono strftime syntax](https://docs.rs/chrono/0.4.19/chrono/format/strftime/index.html). diff --git a/docs/config/mouse.md b/docs/config/mouse.md index 74a71c5b6..23579bd53 100644 --- a/docs/config/mouse.md +++ b/docs/config/mouse.md @@ -32,16 +32,16 @@ that order. | Double Left Down | `NONE` | `SelectTextAtMouseCursor="Word"` | | Single Left Down | `NONE` | `SelectTextAtMouseCursor="Cell"` | | Single Left Down | `SHIFT` | `ExtendSelectionToMouseCursor={}` | -| Single Left Down | `ALT` | `SelectTextAtMouseCursor="Block"` (*since: nightly builds only*) | +| Single Left Down | `ALT` | `SelectTextAtMouseCursor="Block"` (*since: 20220624-141144-bd1b7c5d*) | | Single Left Up | `SHIFT` | `CompleteSelectionOrOpenLinkAtMouseCursor="PrimarySelection"` | | Single Left Up | `NONE` | `CompleteSelectionOrOpenLinkAtMouseCursor="PrimarySelection"` | -| Single Left Up | `ALT` | `CompleteSelection="PrimarySelection"` (*since: nightly builds only*) | +| Single Left Up | `ALT` | `CompleteSelection="PrimarySelection"` (*since: 20220624-141144-bd1b7c5d*) | | Double Left Up | `NONE` | `CompleteSelection="PrimarySelection"` | | Triple Left Up | `NONE` | `CompleteSelection="PrimarySelection"` | | Single Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Cell"` | -| Single Left Drag | `ALT` | `ExtendSelectionToMouseCursor="Block"` (*since: nightly builds only*) | -| Single Left Down | `ALT+SHIFT` | `ExtendSelectionToMouseCursor="Block"` (*since: nightly builds only*) | -| Single Left Up | `ALT+SHIFT` | `CompleteSelection="PrimarySelection"` (*since: nightly builds only*) | +| Single Left Drag | `ALT` | `ExtendSelectionToMouseCursor="Block"` (*since: 20220624-141144-bd1b7c5d*) | +| Single Left Down | `ALT+SHIFT` | `ExtendSelectionToMouseCursor="Block"` (*since: 20220624-141144-bd1b7c5d*) | +| Single Left Up | `ALT+SHIFT` | `CompleteSelection="PrimarySelection"` (*since: 20220624-141144-bd1b7c5d*) | | Double Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Word"` | | Triple Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Line"` | | Single Middle Down | `NONE` | `PasteFrom="PrimarySelection"` | diff --git a/docs/copymode.md b/docs/copymode.md index e7fdb0886..03d8f63e6 100644 --- a/docs/copymode.md +++ b/docs/copymode.md @@ -34,7 +34,7 @@ reassignable. | | `q` | | Cell selection | `v` | | Line selection | `V` | -| Rectangular selection | `CTRL-v` (*since: nightly builds only*)| +| Rectangular selection | `CTRL-v` (*since: 20220624-141144-bd1b7c5d*)| | Move Left | `LeftArrow`| | | `h` | | Move Down | `DownArrow`| @@ -70,7 +70,7 @@ reassignable. ### Configurable Key Assignments -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The key assignments for copy mode are specified by the `copy_mode` [Key Table](config/key-tables.md). diff --git a/docs/faq.md b/docs/faq.md index 0869f87a2..78b701fce 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -293,7 +293,7 @@ When a cursor is needed, the XCursor theme is tried first: If no XCursor was found, wezterm will fall back to using the default X11 cursor font provided by the system. -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* When troubleshooting xcursor issues, you can enable tracing by turning on the log level shown below, and then moving the mouse over the wezterm window: diff --git a/docs/scrollback.md b/docs/scrollback.md index 7e46f0621..de9582254 100644 --- a/docs/scrollback.md +++ b/docs/scrollback.md @@ -87,7 +87,7 @@ When the search overlay is active the behavior of wezterm changes: #### Configurable search mode key assignments -*Since: nightly builds only* +*Since: 20220624-141144-bd1b7c5d* The key assignments for copy mode are specified by the `search_mode` [Key Table](config/key-tables.md).