diff --git a/ci/generate-docs.py b/ci/generate-docs.py index 06548616b..788048b5e 100644 --- a/ci/generate-docs.py +++ b/ci/generate-docs.py @@ -279,7 +279,7 @@ function load_scheme_player(ident) {{ idx.write(f"Source: <{origin_url}>
\n") version = scheme["metadata"].get("wezterm_version", None) if version and version != "Always": - idx.write(f"Since: *{version}*
\n") + idx.write(f"{{{{since('{version}')}}}}
\n") aliases = scheme["metadata"]["aliases"] if len(aliases) > 1: diff --git a/ci/update-doc-versions.py b/ci/update-doc-versions.py new file mode 100644 index 000000000..6ef6ad622 --- /dev/null +++ b/ci/update-doc-versions.py @@ -0,0 +1,25 @@ +#!/usr/bin/env python3 +import glob +import os +import re +import sys + +NIGHTLY = '20230320-124340-559cb7b0' + +NIGHTLY_UPDATE = re.compile('[Ss]ince: nightly builds only', re.MULTILINE) +OLD_SINCE = re.compile('^\*[Ss]ince: (\\S+)\*', re.MULTILINE) +OLD_SINCE_INLINE = re.compile('\(?\*?[Ss]ince: (\\S+)\*?\)?', re.MULTILINE) + +for p in ["docs/**/*.md", "docs/**/*.markdown"]: + for filename in glob.glob(p, recursive=True): + with open(filename, "r") as f: + content = f.read() + + adjusted = NIGHTLY_UPDATE.sub(f"Since: {NIGHTLY}", content) + adjusted = OLD_SINCE.sub("{{since('\\1')}}", adjusted) + adjusted = OLD_SINCE_INLINE.sub("{{since('\\1', inline=True)}}", adjusted) + if content != adjusted: + print(filename) + with open(filename, "w") as f: + f.truncate() + f.write(adjusted) diff --git a/docs/cli/cli/activate-pane-direction.md b/docs/cli/cli/activate-pane-direction.md index 5f1c78c35..f8caa6c72 100644 --- a/docs/cli/cli/activate-pane-direction.md +++ b/docs/cli/cli/activate-pane-direction.md @@ -1,6 +1,6 @@ # `wezterm cli activate-pane-direction DIRECTION` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} *Run `wezterm cli activate-pane-direction --help` to see more help* diff --git a/docs/cli/cli/list-clients.md b/docs/cli/cli/list-clients.md index ce44c8246..ba6f5d861 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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} You may request JSON output: diff --git a/docs/cli/cli/list.md b/docs/cli/cli/list.md index 50ccae7d0..ca24ece05 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: 20220624-141144-bd1b7c5d* +{{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 1c01c8b74..7e765eb06 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: 20220624-141144-bd1b7c5d* +{{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 8f1a696f2..2d0d702fb 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: 20220624-141144-bd1b7c5d*) +* `--no-paste` - Send the text directly, rather than as a bracketed paste. {{since('20220624-141144-bd1b7c5d', inline=True)}} * `--pane-id` - Specifies which pane to send the text to. See also [Targeting Panes](index.md#targeting-panes). diff --git a/docs/cli/show-keys.md b/docs/cli/show-keys.md index 6df3ea250..ed3011a89 100644 --- a/docs/cli/show-keys.md +++ b/docs/cli/show-keys.md @@ -1,6 +1,6 @@ # `wezterm show-keys` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Prints the complete set of key assignments based on your config file. diff --git a/docs/config/appearance.md b/docs/config/appearance.md index 224601bb4..df300f379 100644 --- a/docs/config/appearance.md +++ b/docs/config/appearance.md @@ -36,7 +36,7 @@ The `color_scheme` option takes precedence over the `colors` section below, and is mutually exclusive with it. If you want to merge/override colors you need to use [wezterm.color.get_default_colors()](lua/wezterm.color/get_default_colors.md) and explicitly merge them. -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} The behavior has been changed so that the `color_scheme` you have selected, if any, is used to define the colors, and then any colors you define in the @@ -135,7 +135,7 @@ config.colors = { return config ``` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} You may specify colors in the HSL color space, if you prefer that over RGB, by using: @@ -151,7 +151,7 @@ config.colors = { } ``` -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Colors now also accept the following CSS-style color specifications: @@ -404,7 +404,7 @@ You may add padding around the edges of the terminal area. ## Styling Inactive Panes -*since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} To make it easier to see which pane is active, the inactive panes are dimmed and de-saturated slightly. @@ -443,7 +443,7 @@ reduce it by half, and 2.0 will double the value. ![Screenshot](../screenshots/wezterm-vday-screenshot.png) -*since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} You can attach an image to the background of the wezterm window: @@ -490,7 +490,7 @@ behavior and more, take a look at the more power ## Window Background Gradient -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} ![Gradient](../screenshots/radial-gradient.png) @@ -499,7 +499,7 @@ for configuration information on gradients. ## Window Background Opacity -*since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} If your Operating System provides Compositing support then WezTerm is able to specify the alpha channel value for the background content, rendering the @@ -524,7 +524,7 @@ config.window_background_opacity = 1.0 ## Text Background Opacity -*since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} When using a background image or background opacity, the image content can have relatively low contrast with respect to the text you are trying to diff --git a/docs/config/default-keys.md b/docs/config/default-keys.md index 9cc632b60..44ad88da4 100644 --- a/docs/config/default-keys.md +++ b/docs/config/default-keys.md @@ -11,7 +11,7 @@ in a form that you can copy and paste into your own configuration. | `CTRL+SHIFT` | `v` | `PasteFrom="Clipboard"` | | | `Copy` | `CopyTo="Clipboard"` | | | `Paste` | `PasteFrom="Clipboard"` | -| `CTRL` | `Insert` | `CopyTo="PrimarySelection"` (*since: 20210203-095643-70a364eb*) | +| `CTRL` | `Insert` | `CopyTo="PrimarySelection"` {{since('20210203-095643-70a364eb', inline=True)}} | | `SHIFT` | `Insert` | `PasteFrom="PrimarySelection"` | | `SUPER` | `m` | `Hide` | | `SUPER` | `n` | `SpawnWindow` | @@ -61,13 +61,13 @@ in a form that you can copy and paste into your own configuration. | `SUPER` | `h` | `HideApplication` (macOS only) | | `SUPER` | `k` | `ClearScrollback="ScrollbackOnly"` | | `CTRL+SHIFT` | `K` | `ClearScrollback="ScrollbackOnly"` | -| `CTRL+SHIFT` | `L` | `ShowDebugOverlay` (*Since: 20210814-124438-54e29167*)| -| `CTRL+SHIFT` | `P` | `PaneSelect` (*Since: 20220903-194523-3bb1ed61*)| -| `CTRL+SHIFT` | `U` | `CharSelect` (*Since: 20220903-194523-3bb1ed61*)| +| `CTRL+SHIFT` | `L` | `ShowDebugOverlay` {{since('20210814-124438-54e29167', inline=True)}}| +| `CTRL+SHIFT` | `P` | `PaneSelect` {{since('20220903-194523-3bb1ed61', inline=True)}}| +| `CTRL+SHIFT` | `U` | `CharSelect` {{since('20220903-194523-3bb1ed61', inline=True)}}| | `SUPER` | `f` | `Search={CaseSensitiveString=""}` | | `CTRL+SHIFT` | `F` | `Search={CaseSensitiveString=""}` | | `CTRL+SHIFT` | `X` | `ActivateCopyMode` | -| `CTRL+SHIFT` | `Space`| `QuickSelect` (*since: 20210502-130208-bff6815d*) | +| `CTRL+SHIFT` | `Space`| `QuickSelect` {{since('20210502-130208-bff6815d', inline=True)}} | | `CTRL+SHIFT+ALT` | `"` | `SplitVertical={domain="CurrentPaneDomain"}` | | `CTRL+SHIFT+ALT` | `%` | `SplitHorizontal={domain="CurrentPaneDomain"}` | | `CTRL+SHIFT+ALT` | `LeftArrow` | `AdjustPaneSize={"Left", 1}` | diff --git a/docs/config/files.md b/docs/config/files.md index cd7ceaa05..cbd0cfbea 100644 --- a/docs/config/files.md +++ b/docs/config/files.md @@ -86,7 +86,7 @@ to force the configuration to be reloaded. ### Configuration Overrides -*since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} `wezterm` allows overriding configuration values via the command line; here are a couple of examples: diff --git a/docs/config/font-shaping.md b/docs/config/font-shaping.md index 484cca21e..14a3d3a11 100644 --- a/docs/config/font-shaping.md +++ b/docs/config/font-shaping.md @@ -36,7 +36,7 @@ and you can set them in wezterm: config.harfbuzz_features = { 'zero' } ``` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} You can specify `harfbuzz_features` on a per-font basis, rather than globally for all fonts: diff --git a/docs/config/key-encoding.md b/docs/config/key-encoding.md index 4e640882d..09a7805df 100644 --- a/docs/config/key-encoding.md +++ b/docs/config/key-encoding.md @@ -17,7 +17,7 @@ keypresses like `Control-I` to be ASCII Tab, as an example. ## xterm `modifyOtherKeys` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} When wezterm receives the sequence `CSI >4;Nm`, where `N` is `0`, `1` or `2`, the keyboard encoding is changed according to diff --git a/docs/config/key-tables.md b/docs/config/key-tables.md index 8c4965f0f..164c786e9 100644 --- a/docs/config/key-tables.md +++ b/docs/config/key-tables.md @@ -1,4 +1,4 @@ -*Since: 20220408-101518-b908e2dd* +{{since('20220408-101518-b908e2dd')}} In addition to the default key table defined by the `keys` configuration option, `wezterm` supports defining additional named key tables using the @@ -120,7 +120,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: 20220624-141144-bd1b7c5d* +{{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/keyboard-concepts.md b/docs/config/keyboard-concepts.md index 26303c64d..13729aa67 100644 --- a/docs/config/keyboard-concepts.md +++ b/docs/config/keyboard-concepts.md @@ -102,7 +102,7 @@ enable ### macOS Left and Right Option Key -*since: 20200620-160318-e00b076c* +{{since('20200620-160318-e00b076c')}} The default behavior is to treat the left `Option` key as the `Alt` modifier with no composition effects, while the right `Option` key performs composition @@ -115,7 +115,7 @@ config.send_composed_key_when_left_alt_is_pressed = false config.send_composed_key_when_right_alt_is_pressed = true ``` -*since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} WezTerm is now able to perform dead-key expansion when `use_ime = false`. Dead keys are treated as composition effects, so with the default settings of @@ -137,7 +137,7 @@ some operating systems. ### Dead Keys -*since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} By default, if you are using a layout with *dead keys* (eg: US International layout, or a number of European layouts such as German or French) pressing diff --git a/docs/config/keys.md b/docs/config/keys.md index 181ea5333..47c389bfa 100644 --- a/docs/config/keys.md +++ b/docs/config/keys.md @@ -64,7 +64,7 @@ Pay attention to the case of the text that you use and the state of the `SHIFT` ### Physical vs Mapped Key Assignments -*Since: 20220319-142410-0fcdea07* +{{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 @@ -89,7 +89,7 @@ your config, you will need to change it to either `{key="N", mods="CMD|SHIFT", ..}` or `{key="mapped:N", mods="CMD", ..}` in order to continue to respect the `SHIFT` modifier. -*Since: 20220408-101518-b908e2dd* +{{since('20220408-101518-b908e2dd')}} A new `key_map_preference` option controls how keys without an explicit `phys:` or `mapped:` prefix are treated. If `key_map_preference = "Mapped"` (the @@ -117,7 +117,7 @@ rather than one of the other key values. ### Leader Key -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} A *leader* key is a a modal modifier key. If leader is specified in the configuration then pressing that key combination will enable a virtual `LEADER` @@ -157,7 +157,7 @@ config.keys = { ### VoidSymbol -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} 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 diff --git a/docs/config/launch.md b/docs/config/launch.md index c5d0b8161..a029a6b2d 100644 --- a/docs/config/launch.md +++ b/docs/config/launch.md @@ -14,7 +14,7 @@ Your shell is determined by the following rules: a login shell. A login shell generally loads additional startup files and sets up more environment than a non-login shell. - *Since: 20210502-154244-3f7122cb*: instead of passing `-l` to the shell, wezterm + {{since('20210502-154244-3f7122cb', inline=True)}}: instead of passing `-l` to the shell, wezterm will spawn the shell as `-$SHELL` to invoke it as a login shell. Note: if you have recently changed your shell using `chsh` and you @@ -22,7 +22,7 @@ Your shell is determined by the following rules: sign back in again for the environment to pick up your new `$SHELL` value. - *Since: 20220903-194523-3bb1ed61*: wezterm will now always resolve the shell via the + {{since('20220903-194523-3bb1ed61', inline=True)}}: wezterm will now always resolve the shell via the password database. === "On Windows Systems" diff --git a/docs/config/lua/ExecDomain.md b/docs/config/lua/ExecDomain.md index 80adb2cae..c60e72612 100644 --- a/docs/config/lua/ExecDomain.md +++ b/docs/config/lua/ExecDomain.md @@ -1,6 +1,6 @@ # ExecDomain -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} An `ExecDomain` defines a local-execution multiplexer domain. In simple terms, rather than directly executing the requested program, an `ExecDomain` allows diff --git a/docs/config/lua/LocalProcessInfo.md b/docs/config/lua/LocalProcessInfo.md index 94227464e..b9cca8863 100644 --- a/docs/config/lua/LocalProcessInfo.md +++ b/docs/config/lua/LocalProcessInfo.md @@ -1,6 +1,6 @@ # `LocalProcessInfo` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} `LocalProcessInfo` represents a process running on the local machine. diff --git a/docs/config/lua/MuxTab/get_title.md b/docs/config/lua/MuxTab/get_title.md index f894f5780..c2f6cfb19 100644 --- a/docs/config/lua/MuxTab/get_title.md +++ b/docs/config/lua/MuxTab/get_title.md @@ -1,6 +1,6 @@ # tab:get_title() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the tab title as set by `tab:set_title()`. diff --git a/docs/config/lua/MuxTab/index.markdown b/docs/config/lua/MuxTab/index.markdown index 90abc9621..fbc0249a1 100644 --- a/docs/config/lua/MuxTab/index.markdown +++ b/docs/config/lua/MuxTab/index.markdown @@ -1,6 +1,6 @@ # MuxTab -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} `MuxTab` represents a tab that is managed by the multiplexer. diff --git a/docs/config/lua/MuxTab/panes.md b/docs/config/lua/MuxTab/panes.md index 7bfeb2c74..a358ab757 100644 --- a/docs/config/lua/MuxTab/panes.md +++ b/docs/config/lua/MuxTab/panes.md @@ -1,6 +1,6 @@ # tab:panes() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns an array table containing the set of [Pane](../pane/index.md) objects contained by this tab. diff --git a/docs/config/lua/MuxTab/panes_with_info.md b/docs/config/lua/MuxTab/panes_with_info.md index 8ebcfb421..5ad6fe96f 100644 --- a/docs/config/lua/MuxTab/panes_with_info.md +++ b/docs/config/lua/MuxTab/panes_with_info.md @@ -1,6 +1,6 @@ # tab:panes_with_info() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns an array table containing an extended info entry for each of the panes contained by this tab. diff --git a/docs/config/lua/MuxTab/set_title.md b/docs/config/lua/MuxTab/set_title.md index 2986c70da..ce0887978 100644 --- a/docs/config/lua/MuxTab/set_title.md +++ b/docs/config/lua/MuxTab/set_title.md @@ -1,6 +1,6 @@ # tab:set_title(TITLE) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Sets the tab title to the provided string. diff --git a/docs/config/lua/MuxTab/set_zoomed.md b/docs/config/lua/MuxTab/set_zoomed.md index 925e260d3..02e23263a 100644 --- a/docs/config/lua/MuxTab/set_zoomed.md +++ b/docs/config/lua/MuxTab/set_zoomed.md @@ -1,6 +1,6 @@ # tab:set_zoomed(bool) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Sets the zoomed state for the active pane within this tab. diff --git a/docs/config/lua/MuxTab/tab_id.md b/docs/config/lua/MuxTab/tab_id.md index 6cf57b0ec..e8f444b45 100644 --- a/docs/config/lua/MuxTab/tab_id.md +++ b/docs/config/lua/MuxTab/tab_id.md @@ -1,6 +1,6 @@ # `tab:tab_id()` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Returns the tab id diff --git a/docs/config/lua/MuxTab/window.md b/docs/config/lua/MuxTab/window.md index b277aa0a2..2c8a9e397 100644 --- a/docs/config/lua/MuxTab/window.md +++ b/docs/config/lua/MuxTab/window.md @@ -1,6 +1,6 @@ # tab:window() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the [MuxWindow](../mux-window/index.md) object that contains this tab. diff --git a/docs/config/lua/PaneInformation.md b/docs/config/lua/PaneInformation.md index 1fdac93bb..41e0f2604 100644 --- a/docs/config/lua/PaneInformation.md +++ b/docs/config/lua/PaneInformation.md @@ -20,7 +20,7 @@ The `PaneInformation` struct contains the following fields: * `title` - the title of the pane, per [pane:get_title()](pane/get_title.md) at the time the pane information was captured * `user_vars` - the user variables defined for the pane, per [pane:get_user_vars()](pane/get_user_vars.md) at the time the pane information was captured. -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} Additional fields are available; note that accessing these may not be cheap to compute and may slow down wezterm. Unlike the fields listed above, these are @@ -63,7 +63,7 @@ wezterm.on( return {} ``` -*Since: 20220319-142410-0fcdea07* +{{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. @@ -104,7 +104,7 @@ wezterm.on( return config ``` -*Since: 20220624-141144-bd1b7c5d* +{{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/SpawnCommand.md b/docs/config/lua/SpawnCommand.md index eb9bf6e1b..0b346be03 100644 --- a/docs/config/lua/SpawnCommand.md +++ b/docs/config/lua/SpawnCommand.md @@ -58,7 +58,7 @@ wezterm.action.SpawnCommandInNewWindow { -- See the Multiplexing section of the docs for more on this topic. domain = { DomainName = 'my.server' }, - -- Since: nightly builds only + -- Since: 20230320-124340-559cb7b0 -- Specify the initial position for a GUI window when this command -- is used in a context that will create a new window, such as with -- wezterm.mux.spawn_window, SpawnCommandInNewWindow diff --git a/docs/config/lua/SshDomain.md b/docs/config/lua/SshDomain.md index b51e4da26..aad4ce9bb 100644 --- a/docs/config/lua/SshDomain.md +++ b/docs/config/lua/SshDomain.md @@ -38,7 +38,7 @@ config.ssh_domains = { } ``` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} You may now specify a table with ssh config overrides: @@ -54,7 +54,7 @@ config.ssh_domains = { } ``` -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} You may now specify the type of `multiplexing` used by an ssh domain. The following values are possible: @@ -123,7 +123,7 @@ config.ssh_domains = { } ``` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} The lag indicator now defaults to disabled. It is recommended to display the lag information in your status bar using [this diff --git a/docs/config/lua/TabInformation.md b/docs/config/lua/TabInformation.md index edd270469..864bb85a9 100644 --- a/docs/config/lua/TabInformation.md +++ b/docs/config/lua/TabInformation.md @@ -11,8 +11,8 @@ The `TabInformation` struct contains the following fields: * `tab_index` - the logical tab position within its containing window, with 0 indicating the leftmost tab * `is_active` - is true if this tab is the active tab * `active_pane` - the [PaneInformation](PaneInformation.md) for the active pane in this tab -* `window_id` - the ID of the window that contains this tab (*Since: 20220807-113146-c2fee766*) -* `window_title` - the title of the window that contains this tab (*Since: 20220807-113146-c2fee766*) -* `tab_title` - the title of the tab (*Since: 20220807-113146-c2fee766*) +* `window_id` - the ID of the window that contains this tab {{since('20220807-113146-c2fee766', inline=True)}} +* `window_title` - the title of the window that contains this tab {{since('20220807-113146-c2fee766', inline=True)}} +* `tab_title` - the title of the tab {{since('20220807-113146-c2fee766', inline=True)}} diff --git a/docs/config/lua/TlsDomainClient.md b/docs/config/lua/TlsDomainClient.md index 619855b2b..e6b8cf281 100644 --- a/docs/config/lua/TlsDomainClient.md +++ b/docs/config/lua/TlsDomainClient.md @@ -68,7 +68,7 @@ config.tls_domains = { } ``` -*Since: 20220319-142410-0fcdea07* +{{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 @@ -88,7 +88,7 @@ config.tls_domains = { } ``` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} The lag indicator now defaults to disabled. It is recommended to display the lag information in your status bar using [this diff --git a/docs/config/lua/WslDomain.md b/docs/config/lua/WslDomain.md index 99c21e9ba..a570e9347 100644 --- a/docs/config/lua/WslDomain.md +++ b/docs/config/lua/WslDomain.md @@ -1,6 +1,6 @@ # WslDomain -*Since: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/config/lua/color/adjust_hue_fixed.md b/docs/config/lua/color/adjust_hue_fixed.md index 51b5058d1..8efd1c820 100644 --- a/docs/config/lua/color/adjust_hue_fixed.md +++ b/docs/config/lua/color/adjust_hue_fixed.md @@ -1,6 +1,6 @@ ## `color:adjust_hue_fixed(degrees)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Adjust the hue angle by the specified number of degrees. diff --git a/docs/config/lua/color/adjust_hue_fixed_ryb.md b/docs/config/lua/color/adjust_hue_fixed_ryb.md index 64bcba6c2..05382e6dc 100644 --- a/docs/config/lua/color/adjust_hue_fixed_ryb.md +++ b/docs/config/lua/color/adjust_hue_fixed_ryb.md @@ -1,6 +1,6 @@ ## `color:adjust_hue_fixed_ryb(degrees)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Adjust the hue angle by the specified number of degrees. diff --git a/docs/config/lua/color/complement.md b/docs/config/lua/color/complement.md index 58b78469a..24b1b4963 100644 --- a/docs/config/lua/color/complement.md +++ b/docs/config/lua/color/complement.md @@ -1,6 +1,6 @@ ## `color:complement()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the complement of the color. The complement is computed by converting to HSL, rotating by 180 degrees and converting back diff --git a/docs/config/lua/color/complement_ryb.md b/docs/config/lua/color/complement_ryb.md index d217836fd..31866e93e 100644 --- a/docs/config/lua/color/complement_ryb.md +++ b/docs/config/lua/color/complement_ryb.md @@ -1,6 +1,6 @@ ## `color:complement_ryb()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the complement of the color using the [RYB color model](https://en.wikipedia.org/wiki/RYB_color_model), which more closely diff --git a/docs/config/lua/color/contrast_ratio.md b/docs/config/lua/color/contrast_ratio.md index 20a6c6828..129252773 100644 --- a/docs/config/lua/color/contrast_ratio.md +++ b/docs/config/lua/color/contrast_ratio.md @@ -1,6 +1,6 @@ ### `color:contrast_ratio(color)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Computes the contrast ratio between the two colors. diff --git a/docs/config/lua/color/darken.md b/docs/config/lua/color/darken.md index 0553c84dd..b67f215b9 100644 --- a/docs/config/lua/color/darken.md +++ b/docs/config/lua/color/darken.md @@ -1,6 +1,6 @@ ## `color:darken(factor)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Scales the color towards the minimum lightness by the provided factor, which should be in the range `0.0` through `1.0`. diff --git a/docs/config/lua/color/darken_fixed.md b/docs/config/lua/color/darken_fixed.md index f5d83eb52..78710e14f 100644 --- a/docs/config/lua/color/darken_fixed.md +++ b/docs/config/lua/color/darken_fixed.md @@ -1,6 +1,6 @@ ## `color:darken_fixed(amount)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Decrease the lightness by amount, a value ranging from `0.0` to `1.0`. diff --git a/docs/config/lua/color/delta_e.md b/docs/config/lua/color/delta_e.md index dc3fcf3d8..2171877a6 100644 --- a/docs/config/lua/color/delta_e.md +++ b/docs/config/lua/color/delta_e.md @@ -1,6 +1,6 @@ ### `color:delta_e(color)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Computes the CIEDE2000 DeltaE value representing the difference between the two colors. diff --git a/docs/config/lua/color/desaturate.md b/docs/config/lua/color/desaturate.md index 51139f9b4..9e4df77fa 100644 --- a/docs/config/lua/color/desaturate.md +++ b/docs/config/lua/color/desaturate.md @@ -1,6 +1,6 @@ ## `color:desaturate(factor)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Scales the color towards the minimum saturation by the provided factor, which should be in the range `0.0` through `1.0`. diff --git a/docs/config/lua/color/desaturate_fixed.md b/docs/config/lua/color/desaturate_fixed.md index 20f521111..2ec0ff8f5 100644 --- a/docs/config/lua/color/desaturate_fixed.md +++ b/docs/config/lua/color/desaturate_fixed.md @@ -1,6 +1,6 @@ ## `color:desaturate_fixed(amount)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Decrease the saturation by amount, a value ranging from `0.0` to `1.0`. diff --git a/docs/config/lua/color/hsla.md b/docs/config/lua/color/hsla.md index 73e2acc8b..8dd8eb7b5 100644 --- a/docs/config/lua/color/hsla.md +++ b/docs/config/lua/color/hsla.md @@ -1,6 +1,6 @@ ## `color:hsla()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Converts the color to the HSL colorspace and returns those values + alpha: diff --git a/docs/config/lua/color/laba.md b/docs/config/lua/color/laba.md index 46f156d38..b8999bd2c 100644 --- a/docs/config/lua/color/laba.md +++ b/docs/config/lua/color/laba.md @@ -1,6 +1,6 @@ ### `color:laba()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Converts the color to the LAB colorspace and returns those values + alpha: diff --git a/docs/config/lua/color/lighten.md b/docs/config/lua/color/lighten.md index b6cc53e8c..2b6c27f8a 100644 --- a/docs/config/lua/color/lighten.md +++ b/docs/config/lua/color/lighten.md @@ -1,6 +1,6 @@ ## `color:lighten(factor)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Scales the color towards the maximum lightness by the provided factor, which should be in the range `0.0` through `1.0`. diff --git a/docs/config/lua/color/lighten_fixed.md b/docs/config/lua/color/lighten_fixed.md index c256e204e..b38d93ef2 100644 --- a/docs/config/lua/color/lighten_fixed.md +++ b/docs/config/lua/color/lighten_fixed.md @@ -1,6 +1,6 @@ ## `color:lighten_fixed(amount)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Increase the lightness by amount, a value ranging from `0.0` to `1.0`. diff --git a/docs/config/lua/color/linear_rgba.md b/docs/config/lua/color/linear_rgba.md index 5083e9b95..f32a851a9 100644 --- a/docs/config/lua/color/linear_rgba.md +++ b/docs/config/lua/color/linear_rgba.md @@ -1,6 +1,6 @@ ## `color:linear_rgba()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns a tuple of the colors converted to linear RGBA and expressed as floating point numbers in the range `0.0-1.0`: diff --git a/docs/config/lua/color/saturate.md b/docs/config/lua/color/saturate.md index e6b50ab37..1311c4ab6 100644 --- a/docs/config/lua/color/saturate.md +++ b/docs/config/lua/color/saturate.md @@ -1,6 +1,6 @@ ## `color:saturate(factor)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Scales the color towards the maximum saturation by the provided factor, which should be in the range `0.0` through `1.0`. diff --git a/docs/config/lua/color/saturate_fixed.md b/docs/config/lua/color/saturate_fixed.md index 4bb1232d9..c81510bb9 100644 --- a/docs/config/lua/color/saturate_fixed.md +++ b/docs/config/lua/color/saturate_fixed.md @@ -1,6 +1,6 @@ ## `color:saturate_fixed(amount)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Increase the saturation by amount, a value ranging from `0.0` to `1.0`. diff --git a/docs/config/lua/color/square.md b/docs/config/lua/color/square.md index d83c7eaca..41a39a6d1 100644 --- a/docs/config/lua/color/square.md +++ b/docs/config/lua/color/square.md @@ -1,6 +1,6 @@ ## `color:square()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the other three colors that form a square. The other colors are 90 degrees apart on the HSL color wheel. diff --git a/docs/config/lua/color/srgb_u8.md b/docs/config/lua/color/srgb_u8.md index c0391181d..c5e929aca 100644 --- a/docs/config/lua/color/srgb_u8.md +++ b/docs/config/lua/color/srgb_u8.md @@ -1,6 +1,6 @@ ## `color:srgba_u8()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns a tuple of the internal SRGBA colors expressed as unsigned 8-bit integers in the range 0-255: diff --git a/docs/config/lua/color/triad.md b/docs/config/lua/color/triad.md index e74c3d9bc..a8c34dc50 100644 --- a/docs/config/lua/color/triad.md +++ b/docs/config/lua/color/triad.md @@ -1,6 +1,6 @@ ## `color:triad()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the other two colors that form a triad. The other colors are at +/- 120 degrees in the HSL color wheel. diff --git a/docs/config/lua/config/allow_square_glyphs_to_overflow_width.md b/docs/config/lua/config/allow_square_glyphs_to_overflow_width.md index 726a2c47f..9be55cfb2 100644 --- a/docs/config/lua/config/allow_square_glyphs_to_overflow_width.md +++ b/docs/config/lua/config/allow_square_glyphs_to_overflow_width.md @@ -1,6 +1,6 @@ # `allow_square_glyphs_to_overflow_width = "Never"` -*Since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} Configures how square symbol glyph's cell is rendered: @@ -10,7 +10,7 @@ Configures how square symbol glyph's cell is rendered: being a space. * "Never" (the default) - strictly respect the cell width. -*Since: 20210404-112810-b63a949d* +{{since('20210404-112810-b63a949d')}} This setting now applies to any glyph with an aspect ratio larger than 0.9, which covers more symbol glyphs than in diff --git a/docs/config/lua/config/allow_win32_input_mode.md b/docs/config/lua/config/allow_win32_input_mode.md index c28e9c3cb..525241861 100644 --- a/docs/config/lua/config/allow_win32_input_mode.md +++ b/docs/config/lua/config/allow_win32_input_mode.md @@ -1,6 +1,6 @@ # `allow_win32_input_mode` -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} When set to `true`, wezterm will honor an escape sequence generated by the Windows ConPTY layer to switch the [keyboard encoding](../../key-encoding.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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} The default for `allow_win32_input_mode` is now true. diff --git a/docs/config/lua/config/alternate_buffer_wheel_scroll_speed.md b/docs/config/lua/config/alternate_buffer_wheel_scroll_speed.md index 9135ca157..d7fed541c 100644 --- a/docs/config/lua/config/alternate_buffer_wheel_scroll_speed.md +++ b/docs/config/lua/config/alternate_buffer_wheel_scroll_speed.md @@ -1,6 +1,6 @@ # `alternate_buffer_wheel_scroll_speed = 3` -*Since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} Normally the vertical mouse wheel will scroll the terminal viewport so that different sections of the scrollback are visible. diff --git a/docs/config/lua/config/animation_fps.md b/docs/config/lua/config/animation_fps.md index 960cdd01d..03616bb74 100644 --- a/docs/config/lua/config/animation_fps.md +++ b/docs/config/lua/config/animation_fps.md @@ -1,6 +1,6 @@ # `animation_fps = 10` -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} This setting controls the maximum frame rate used when rendering easing effects for blinking cursors, blinking text and visual bell. diff --git a/docs/config/lua/config/audible_bell.md b/docs/config/lua/config/audible_bell.md index e5f1bd232..ccfb1efa4 100644 --- a/docs/config/lua/config/audible_bell.md +++ b/docs/config/lua/config/audible_bell.md @@ -1,6 +1,6 @@ # audible_bell -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} When the BEL ascii sequence is sent to a pane, the bell is "rung" in that pane. diff --git a/docs/config/lua/config/automatically_reload_config.md b/docs/config/lua/config/automatically_reload_config.md index 305b8c6ae..8fff4cfaf 100644 --- a/docs/config/lua/config/automatically_reload_config.md +++ b/docs/config/lua/config/automatically_reload_config.md @@ -1,6 +1,6 @@ # `automatically_reload_config` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} When true (the default), watch the config file and reload it automatically when it is detected as changing. diff --git a/docs/config/lua/config/background.md b/docs/config/lua/config/background.md index 49cc342e6..5d55a2e09 100644 --- a/docs/config/lua/config/background.md +++ b/docs/config/lua/config/background.md @@ -1,6 +1,6 @@ # background -*Since: 20220624-141144-bd1b7c5d* +{{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/bypass_mouse_reporting_modifiers.md b/docs/config/lua/config/bypass_mouse_reporting_modifiers.md index fcd63dbc1..355270d05 100644 --- a/docs/config/lua/config/bypass_mouse_reporting_modifiers.md +++ b/docs/config/lua/config/bypass_mouse_reporting_modifiers.md @@ -1,6 +1,6 @@ # bypass_mouse_reporting_modifiers = "SHIFT" -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} If an application has enabled mouse reporting mode, mouse events are sent directly to the application, and do not get routed through the mouse diff --git a/docs/config/lua/config/canonicalize_pasted_newlines.md b/docs/config/lua/config/canonicalize_pasted_newlines.md index 752107864..413768320 100644 --- a/docs/config/lua/config/canonicalize_pasted_newlines.md +++ b/docs/config/lua/config/canonicalize_pasted_newlines.md @@ -1,6 +1,6 @@ # canonicalize_pasted_newlines -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} Controls whether pasted text will have newlines normalized. @@ -11,12 +11,12 @@ The following values are accepted: |value|meaning|version| |-----|-------|---------------| -|`true` |same as `"CarriageReturnAndLineFeed"`|*Since: 20211204-082213-a66c61ee9*| -|`false` |same as `"None"`|*Since: 20211204-082213-a66c61ee9*| -|`"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*| +|`true` |same as `"CarriageReturnAndLineFeed"`|{{since('20211204-082213-a66c61ee9', inline=True)}}| +|`false` |same as `"None"`|{{since('20211204-082213-a66c61ee9', inline=True)}}| +|`"None"` |The text is passed through unchanged|{{since('20220319-142410-0fcdea07', inline=True)}}| +|`"LineFeed"` |Newlines of any style are rewritten as LF|{{since('20220319-142410-0fcdea07', inline=True)}}| +|`"CarriageReturn"` |Newlines of any style are rewritten as CR|{{since('20220319-142410-0fcdea07', inline=True)}}| +|`"CarriageReturnAndLineFeed"` |Newlines of any style are rewritten as CRLF|{{since('20220319-142410-0fcdea07', inline=True)}}| 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 diff --git a/docs/config/lua/config/cell_width.md b/docs/config/lua/config/cell_width.md index 8e56d9dfa..3900db462 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: 20220624-141144-bd1b7c5d* +{{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 6b1b7e2cc..a79f70465 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: 20220624-141144-bd1b7c5d* +{{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/cursor_blink_ease_in.md b/docs/config/lua/config/cursor_blink_ease_in.md index a5ca3fb63..4c34ca735 100644 --- 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: 20220319-142410-0fcdea07* +{{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. diff --git a/docs/config/lua/config/cursor_blink_ease_out.md b/docs/config/lua/config/cursor_blink_ease_out.md index c8deb8962..71342cbb7 100644 --- 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: 20220319-142410-0fcdea07* +{{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. diff --git a/docs/config/lua/config/cursor_blink_rate.md b/docs/config/lua/config/cursor_blink_rate.md index 7fb433ee8..8e0f974bb 100644 --- a/docs/config/lua/config/cursor_blink_rate.md +++ b/docs/config/lua/config/cursor_blink_rate.md @@ -14,7 +14,7 @@ relatively costly to keep re-rendering for the blink! config.cursor_blink_rate = 800 ``` -*Since: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/config/lua/config/cursor_thickness.md b/docs/config/lua/config/cursor_thickness.md index a635e7c68..07c66bbc9 100644 --- a/docs/config/lua/config/cursor_thickness.md +++ b/docs/config/lua/config/cursor_thickness.md @@ -1,6 +1,6 @@ # cursor_thickness -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} If specified, overrides the base thickness of the lines used to render the textual cursor glyph. diff --git a/docs/config/lua/config/custom_block_glyphs.md b/docs/config/lua/config/custom_block_glyphs.md index a305615cc..808488d7f 100644 --- a/docs/config/lua/config/custom_block_glyphs.md +++ b/docs/config/lua/config/custom_block_glyphs.md @@ -1,6 +1,6 @@ ## `custom_block_glyphs = true` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} When set to `true` (the default), WezTerm will compute its own idea of what the glyphs in the following unicode ranges should be, instead of using glyphs resolved from a font. diff --git a/docs/config/lua/config/default_cwd.md b/docs/config/lua/config/default_cwd.md index 7744f86bb..960fb7e9d 100644 --- a/docs/config/lua/config/default_cwd.md +++ b/docs/config/lua/config/default_cwd.md @@ -1,6 +1,6 @@ # `default_cwd` -*Since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} Sets the default current working directory used by the initial window. diff --git a/docs/config/lua/config/default_domain.md b/docs/config/lua/config/default_domain.md index 0ccd10abf..e8f93f99f 100644 --- a/docs/config/lua/config/default_domain.md +++ b/docs/config/lua/config/default_domain.md @@ -1,6 +1,6 @@ # `default_domain = "local"` -*Since: 20220319-142410-0fcdea07* +{{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. diff --git a/docs/config/lua/config/default_gui_startup_args.md b/docs/config/lua/config/default_gui_startup_args.md index 9c4803acd..e96fffb7b 100644 --- a/docs/config/lua/config/default_gui_startup_args.md +++ b/docs/config/lua/config/default_gui_startup_args.md @@ -1,6 +1,6 @@ # `default_gui_startup_args = {"start"}` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} When launching the GUI using either `wezterm` or `wezterm-gui` (with no subcommand explicitly specified), wezterm will use the value of diff --git a/docs/config/lua/config/default_workspace.md b/docs/config/lua/config/default_workspace.md index 8968bc3d7..711046d4b 100644 --- a/docs/config/lua/config/default_workspace.md +++ b/docs/config/lua/config/default_workspace.md @@ -1,6 +1,6 @@ # `default_workspace = "default"` -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Specifies the name of the default workspace. The default is `"default"`. diff --git a/docs/config/lua/config/detect_password_input.md b/docs/config/lua/config/detect_password_input.md index 25de30f94..208a93733 100644 --- a/docs/config/lua/config/detect_password_input.md +++ b/docs/config/lua/config/detect_password_input.md @@ -1,6 +1,6 @@ # `detect_password_input = true` -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} When set to `true`, on unix systems, for local panes, wezterm will query the *termios* associated with the PTY to see whether local echo is disabled and diff --git a/docs/config/lua/config/disable_default_quick_select_patterns.md b/docs/config/lua/config/disable_default_quick_select_patterns.md index 3b2731cfb..c91c6f3d9 100644 --- a/docs/config/lua/config/disable_default_quick_select_patterns.md +++ b/docs/config/lua/config/disable_default_quick_select_patterns.md @@ -1,6 +1,6 @@ # disable_default_quick_select_patterns -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} When set to `true`, the default set of quick select patterns are omitted, and your [quick_select_patterns](quick_select_patterns.md) diff --git a/docs/config/lua/config/enable_kitty_keyboard.md b/docs/config/lua/config/enable_kitty_keyboard.md index 741aea35d..6f125eeb0 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: 20220624-141144-bd1b7c5d* +{{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/exit_behavior.md b/docs/config/lua/config/exit_behavior.md index 358047167..cc57d0dd6 100644 --- a/docs/config/lua/config/exit_behavior.md +++ b/docs/config/lua/config/exit_behavior.md @@ -1,6 +1,6 @@ ## `exit_behavior = "CloseOnCleanExit"` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Controls the behavior when the shell program spawned by the terminal exits. There are three possible values: @@ -31,7 +31,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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} The default is now `"Close"`. diff --git a/docs/config/lua/config/font_shaper.md b/docs/config/lua/config/font_shaper.md index 988be5535..2e930cf40 100644 --- a/docs/config/lua/config/font_shaper.md +++ b/docs/config/lua/config/font_shaper.md @@ -7,6 +7,6 @@ for `Allsorts`. It is strongly recommended that you use the default `Harfbuzz` shaper. -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} The incomplete `Allsorts` shaper was removed. diff --git a/docs/config/lua/config/font_size.md b/docs/config/lua/config/font_size.md index 659944743..99333a7a1 100644 --- a/docs/config/lua/config/font_size.md +++ b/docs/config/lua/config/font_size.md @@ -6,7 +6,7 @@ You may use fractional point sizes, such as `13.3`, to fine tune the size. The default font size is `10.0` points. -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} The default font size is now `12.0` points. diff --git a/docs/config/lua/config/force_reverse_video_cursor.md b/docs/config/lua/config/force_reverse_video_cursor.md index a3abaa708..00385d0ad 100644 --- a/docs/config/lua/config/force_reverse_video_cursor.md +++ b/docs/config/lua/config/force_reverse_video_cursor.md @@ -1,6 +1,6 @@ # force_reverse_video_cursor = false -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} When `force_reverse_video_cursor = true`, override the `cursor_fg`, `cursor_bg`, `cursor_border` settings from the color scheme and force the @@ -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: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/config/lua/config/foreground_text_hsb.md b/docs/config/lua/config/foreground_text_hsb.md index 8f6b6b27b..3200f72ac 100644 --- a/docs/config/lua/config/foreground_text_hsb.md +++ b/docs/config/lua/config/foreground_text_hsb.md @@ -1,6 +1,6 @@ # foreground_text_hsb -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Configures a Hue, Saturation, Brightness transformation that is applied to monochrome glyphs. diff --git a/docs/config/lua/config/freetype_load_flags.md b/docs/config/lua/config/freetype_load_flags.md index ce0e9d81b..e0ab10675 100644 --- a/docs/config/lua/config/freetype_load_flags.md +++ b/docs/config/lua/config/freetype_load_flags.md @@ -1,6 +1,6 @@ # `freetype_load_flags = "DEFAULT"` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} An advanced option to fine tune the freetype rasterizer. This is a bitfield, so you can combine one or more of these options together, separated by the `|` diff --git a/docs/config/lua/config/freetype_load_target.md b/docs/config/lua/config/freetype_load_target.md index ee8df6ffa..9b31997ac 100644 --- a/docs/config/lua/config/freetype_load_target.md +++ b/docs/config/lua/config/freetype_load_target.md @@ -1,6 +1,6 @@ # `freetype_load_target = "Normal"` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Configures the hinting and (potentially) the rendering mode used with the freetype rasterizer. The following values are possible: 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 ad7de83ff..37d992176 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: 20220624-141144-bd1b7c5d* +{{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/freetype_render_target.md b/docs/config/lua/config/freetype_render_target.md index 950bc7900..a9280fbcd 100644 --- a/docs/config/lua/config/freetype_render_target.md +++ b/docs/config/lua/config/freetype_render_target.md @@ -1,6 +1,6 @@ # `freetype_render_target = "Normal"` -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Configures the *rendering* mode used with the freetype rasterizer. diff --git a/docs/config/lua/config/front_end.md b/docs/config/lua/config/front_end.md index 995a044fd..1cbe0147d 100644 --- a/docs/config/lua/config/front_end.md +++ b/docs/config/lua/config/front_end.md @@ -6,7 +6,7 @@ possible values: * `OpenGL` - use GPU accelerated rasterization (this is the default) * `Software` - use CPU-based rasterization. -* `WebGpu` - use GPU accelerated rasterization (*Since: 20221119-145034-49b9839f*) +* `WebGpu` - use GPU accelerated rasterization {{since('20221119-145034-49b9839f', inline=True)}} You may wish (or need!) to select `Software` if there are issues with your GPU/OpenGL drivers. @@ -16,7 +16,7 @@ being started in a Remote Desktop environment on Windows. ## WebGpu -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} The WebGpu front end allows wezterm to use GPU acceleration provided by a number of platform-specific backends: diff --git a/docs/config/lua/config/hyperlink_rules.md b/docs/config/lua/config/hyperlink_rules.md index 08b351079..6cafe4ea5 100644 --- a/docs/config/lua/config/hyperlink_rules.md +++ b/docs/config/lua/config/hyperlink_rules.md @@ -13,7 +13,7 @@ The value is a list of rule entries. Each entry has the following fields: the first capture group. In the example below, `mailto:$0` is used to prefix a protocol to the text to make it into an URL. -{{since('20230320-124340-559cb7b0', inline=True)}} +{{since('20230320-124340-559cb7b0', outline=True)}} * `highlight` - specifies the range of the matched text that should be highlighted/underlined when the mouse hovers over the link. The value is a number that corresponds to a capture group in the regex. The default diff --git a/docs/config/lua/config/ime_preedit_rendering.md b/docs/config/lua/config/ime_preedit_rendering.md index f6bbb94ba..45bc24f67 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: 20220624-141144-bd1b7c5d* +{{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/key_map_preference.md b/docs/config/lua/config/key_map_preference.md index 21cc2e812..e3922f469 100644 --- a/docs/config/lua/config/key_map_preference.md +++ b/docs/config/lua/config/key_map_preference.md @@ -1,6 +1,6 @@ # `key_map_preference = "Mapped"` -*Since: 20220408-101518-b908e2dd* +{{since('20220408-101518-b908e2dd')}} Controls how keys without an explicit `phys:` or `mapped:` prefix are treated. diff --git a/docs/config/lua/config/max_fps.md b/docs/config/lua/config/max_fps.md index 6ecd00a25..4868e2792 100644 --- a/docs/config/lua/config/max_fps.md +++ b/docs/config/lua/config/max_fps.md @@ -8,7 +8,7 @@ Defaults to `60`. | Environment | Supported Since | |-------------|-----------------| | Wayland | Ignored; instead, uses information from the compositor to schedule painting frames | -| X11 | Since: 20211204-082213-a66c61ee9 | -| macOS | Since: 20220903-194523-3bb1ed61 | -| Windows | Since: 20220903-194523-3bb1ed61 | +| X11 | {{since('20211204-082213-a66c61ee9', inline=True)}} | +| macOS | {{since('20220903-194523-3bb1ed61', inline=True)}} | +| Windows | {{since('20220903-194523-3bb1ed61', inline=True)}} | diff --git a/docs/config/lua/config/min_scroll_bar_height.md b/docs/config/lua/config/min_scroll_bar_height.md index dcee3382d..ced25c402 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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Controls the minimum size of the scroll bar "thumb". diff --git a/docs/config/lua/config/mux_env_remove.md b/docs/config/lua/config/mux_env_remove.md index d19721598..26b76fa84 100644 --- a/docs/config/lua/config/mux_env_remove.md +++ b/docs/config/lua/config/mux_env_remove.md @@ -1,6 +1,6 @@ # mux_env_remove -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} Specifies a list of environment variables that should be removed from the environment in the multiplexer server. diff --git a/docs/config/lua/config/normalize_output_to_unicode_nfc.md b/docs/config/lua/config/normalize_output_to_unicode_nfc.md index 0dcb96c0e..4bb97aa3b 100644 --- a/docs/config/lua/config/normalize_output_to_unicode_nfc.md +++ b/docs/config/lua/config/normalize_output_to_unicode_nfc.md @@ -1,6 +1,6 @@ # `normalize_to_nfc = false` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} When set to true, contiguous runs codepoints output to the terminal are [normalized](http://www.unicode.org/faq/normalization.html) to [Unicode diff --git a/docs/config/lua/config/pane_focus_follows_mouse.md b/docs/config/lua/config/pane_focus_follows_mouse.md index b3874330c..08dac8316 100644 --- a/docs/config/lua/config/pane_focus_follows_mouse.md +++ b/docs/config/lua/config/pane_focus_follows_mouse.md @@ -1,6 +1,6 @@ # `pane_focus_follows_mouse = false` -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} When `pane_focus_follows_mouse = true`, moving the mouse pointer over an inactive pane will cause that pane to activate; this behavior is known diff --git a/docs/config/lua/config/quick_select_alphabet.md b/docs/config/lua/config/quick_select_alphabet.md index e165e082d..0e32313e7 100644 --- a/docs/config/lua/config/quick_select_alphabet.md +++ b/docs/config/lua/config/quick_select_alphabet.md @@ -1,6 +1,6 @@ # quick_select_alphabet -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Specify the alphabet used to produce labels for the items matched in [quick select mode](../../../quickselect.md). diff --git a/docs/config/lua/config/quick_select_patterns.md b/docs/config/lua/config/quick_select_patterns.md index ada5983ce..52bd50b26 100644 --- a/docs/config/lua/config/quick_select_patterns.md +++ b/docs/config/lua/config/quick_select_patterns.md @@ -1,6 +1,6 @@ # quick_select_patterns -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Specify additional patterns to match when in [quick select mode](../../../quickselect.md). This setting is a table listing out a set of regular expressions. diff --git a/docs/config/lua/config/quote_dropped_files.md b/docs/config/lua/config/quote_dropped_files.md index 7ffea8fdd..6e1c03151 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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Controls how file names are quoted (or not) when dragging and dropping. There are five possible values: diff --git a/docs/config/lua/config/selection_word_boundary.md b/docs/config/lua/config/selection_word_boundary.md index 683b34318..d5f8ddecf 100644 --- a/docs/config/lua/config/selection_word_boundary.md +++ b/docs/config/lua/config/selection_word_boundary.md @@ -1,6 +1,6 @@ # `selection_word_boundary` -*Since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} Configures the boundaries of a word, thus what is selected when doing a word selection with the mouse. diff --git a/docs/config/lua/config/show_new_tab_button_in_tab_bar.md b/docs/config/lua/config/show_new_tab_button_in_tab_bar.md index 3becef9ab..67d34754e 100644 --- a/docs/config/lua/config/show_new_tab_button_in_tab_bar.md +++ b/docs/config/lua/config/show_new_tab_button_in_tab_bar.md @@ -1,6 +1,6 @@ # `show_new_tab_button_in_tab_bar = true` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} When set to `true` (the default), the tab bar will display the new-tab button, which can be left-clicked to create a new tab, or right-clicked to display the diff --git a/docs/config/lua/config/show_tabs_in_tab_bar.md b/docs/config/lua/config/show_tabs_in_tab_bar.md index e346da438..6b636a0c8 100644 --- a/docs/config/lua/config/show_tabs_in_tab_bar.md +++ b/docs/config/lua/config/show_tabs_in_tab_bar.md @@ -1,6 +1,6 @@ # `show_tabs_in_tab_bar = true` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} When set to `true` (the default), the tab bar will display the tabs associated with the current window. diff --git a/docs/config/lua/config/skip_close_confirmation_for_processes_named.md b/docs/config/lua/config/skip_close_confirmation_for_processes_named.md index 94bfb0e1e..111910665 100644 --- a/docs/config/lua/config/skip_close_confirmation_for_processes_named.md +++ b/docs/config/lua/config/skip_close_confirmation_for_processes_named.md @@ -1,6 +1,6 @@ # skip_close_confirmation_for_processes_named -*Since: 20210404-112810-b63a949d* +{{since('20210404-112810-b63a949d')}} This configuration specifies a list of process names that are considered to be "stateless" and that are safe to close without diff --git a/docs/config/lua/config/ssh_backend.md b/docs/config/lua/config/ssh_backend.md index cf3f25d9b..c2be24fa6 100644 --- a/docs/config/lua/config/ssh_backend.md +++ b/docs/config/lua/config/ssh_backend.md @@ -1,6 +1,6 @@ # ssh_backend = "libssh" -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} Sets which ssh backend should be used by default for the integrated ssh client. diff --git a/docs/config/lua/config/status_update_interval.md b/docs/config/lua/config/status_update_interval.md index adbd72f62..ffbe74b34 100644 --- a/docs/config/lua/config/status_update_interval.md +++ b/docs/config/lua/config/status_update_interval.md @@ -1,6 +1,6 @@ # `status_update_interval = 1000` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Specifies the number of milliseconds that need to elapse between triggering the [update-right-status](../window-events/update-right-status.md) hook. diff --git a/docs/config/lua/config/strikethrough_position.md b/docs/config/lua/config/strikethrough_position.md index e0245e155..2b7ef066f 100644 --- a/docs/config/lua/config/strikethrough_position.md +++ b/docs/config/lua/config/strikethrough_position.md @@ -1,6 +1,6 @@ # strikethrough_position -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} If specified, overrides the position of strikethrough lines. diff --git a/docs/config/lua/config/swallow_mouse_click_on_pane_focus.md b/docs/config/lua/config/swallow_mouse_click_on_pane_focus.md index 84b3bd5d6..9e9f61c87 100644 --- a/docs/config/lua/config/swallow_mouse_click_on_pane_focus.md +++ b/docs/config/lua/config/swallow_mouse_click_on_pane_focus.md @@ -1,6 +1,6 @@ # `swallow_mouse_click_on_pane_focus = false` -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} When set to `true`, clicking on a pane will focus it. diff --git a/docs/config/lua/config/swallow_mouse_click_on_window_focus.md b/docs/config/lua/config/swallow_mouse_click_on_window_focus.md index 7ca7194a8..41320b0dd 100644 --- 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: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} When set to `true`, clicking on a wezterm window will focus it. diff --git a/docs/config/lua/config/switch_to_last_active_tab_when_closing_tab.md b/docs/config/lua/config/switch_to_last_active_tab_when_closing_tab.md index c071a9bb6..66b6be7a4 100644 --- a/docs/config/lua/config/switch_to_last_active_tab_when_closing_tab.md +++ b/docs/config/lua/config/switch_to_last_active_tab_when_closing_tab.md @@ -1,6 +1,6 @@ # `switch_to_last_active_tab_when_closing_tab = false` -*Since: 20220905-102802-7d4b8249* +{{since('20220905-102802-7d4b8249')}} If set to `true`, when the active tab is closed, the previously activated tab will be activated. diff --git a/docs/config/lua/config/tab_bar_at_bottom.md b/docs/config/lua/config/tab_bar_at_bottom.md index 9e3f97b3b..f594ca58e 100644 --- a/docs/config/lua/config/tab_bar_at_bottom.md +++ b/docs/config/lua/config/tab_bar_at_bottom.md @@ -1,6 +1,6 @@ # `tab_bar_at_bottom = false` -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} When `tab_bar_at_bottom = true`, the tab bar will be rendered at the bottom of the window rather than the top of the window. diff --git a/docs/config/lua/config/tab_bar_style.md b/docs/config/lua/config/tab_bar_style.md index fdcbf7a59..5cbdc4aab 100644 --- a/docs/config/lua/config/tab_bar_style.md +++ b/docs/config/lua/config/tab_bar_style.md @@ -1,18 +1,18 @@ # `tab_bar_style` -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} `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. -*Since: 20210502-154244-3f7122cb* +{{since('20210502-154244-3f7122cb')}} `active_tab_left`, `active_tab_right`, `inactive_tab_left`, `inactive_tab_right`, `inactive_tab_hover_left`, `inactive_tab_hover_right` have been removed and replaced by the more flexible [format-tab-title](../window-events/format-tab-title.md) event. -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} This config option allows styling the elements that appear in the tab bar. This configuration supplements the [tab bar color](../../appearance.md#tab-bar-appearance--colors) diff --git a/docs/config/lua/config/text_blink_ease_in.md b/docs/config/lua/config/text_blink_ease_in.md index 5ee4c8e6b..babcb5dc2 100644 --- 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: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/config/lua/config/text_blink_ease_out.md b/docs/config/lua/config/text_blink_ease_out.md index 383f52faf..943559b66 100644 --- 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: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/config/lua/config/text_blink_rapid_ease_in.md b/docs/config/lua/config/text_blink_rapid_ease_in.md index f1224aad6..d724bba0c 100644 --- 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: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/config/lua/config/text_blink_rapid_ease_out.md b/docs/config/lua/config/text_blink_rapid_ease_out.md index e866c45b4..1d26b02d5 100644 --- 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: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/config/lua/config/text_blink_rate.md b/docs/config/lua/config/text_blink_rate.md index 4157b7d9d..ab817d372 100644 --- a/docs/config/lua/config/text_blink_rate.md +++ b/docs/config/lua/config/text_blink_rate.md @@ -1,6 +1,6 @@ # `text_blink_rate` -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} Specifies how often blinking text (normal speed) transitions between visible and invisible, expressed in milliseconds. Setting this to 0 disables slow text @@ -12,7 +12,7 @@ interval specified with some degree of slop. config.text_blink_rate = 500 ``` -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Blinking is no longer a binary blink, but interpolates between invisible and visible text using an easing function. See diff --git a/docs/config/lua/config/text_blink_rate_rapid.md b/docs/config/lua/config/text_blink_rate_rapid.md index 778ba23d4..c7c2d1ffb 100644 --- a/docs/config/lua/config/text_blink_rate_rapid.md +++ b/docs/config/lua/config/text_blink_rate_rapid.md @@ -1,6 +1,6 @@ # `text_blink_rate_rapid` -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} Specifies how often blinking text (rapid speed) transitions between visible and invisible, expressed in milliseconds. Setting this to 0 disables rapid text @@ -12,7 +12,7 @@ interval specified with some degree of slop. config.text_blink_rate_rapid = 250 ``` -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Blinking is no longer a binary blink, but interpolates between invisible and visible text using an easing function. See 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 9c8926644..493d077aa 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: 20220624-141144-bd1b7c5d* +{{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/treat_left_ctrlalt_as_altgr.md b/docs/config/lua/config/treat_left_ctrlalt_as_altgr.md index 610045be4..3a6b13f57 100644 --- a/docs/config/lua/config/treat_left_ctrlalt_as_altgr.md +++ b/docs/config/lua/config/treat_left_ctrlalt_as_altgr.md @@ -1,6 +1,6 @@ # `treat_left_ctrlalt_as_altgr = false` -*since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} If you are using a layout with an *AltGr* key, you may experience issues when running inside a VNC session, because VNC emulates the AltGr keypresses diff --git a/docs/config/lua/config/underline_position.md b/docs/config/lua/config/underline_position.md index d1f490668..7eac6f234 100644 --- a/docs/config/lua/config/underline_position.md +++ b/docs/config/lua/config/underline_position.md @@ -1,6 +1,6 @@ # underline_position -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} If specified, overrides the position of underlines. diff --git a/docs/config/lua/config/underline_thickness.md b/docs/config/lua/config/underline_thickness.md index b5b1ad721..723f29811 100644 --- a/docs/config/lua/config/underline_thickness.md +++ b/docs/config/lua/config/underline_thickness.md @@ -1,6 +1,6 @@ # underline_thickness -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} If specified, overrides the base thickness of underlines. The underline thickness is also used for rendering split pane dividers and a number of other diff --git a/docs/config/lua/config/unicode_version.md b/docs/config/lua/config/unicode_version.md index 6c8cf824d..2ae630dc7 100644 --- a/docs/config/lua/config/unicode_version.md +++ b/docs/config/lua/config/unicode_version.md @@ -1,6 +1,6 @@ # `unicode_version = 9` -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} Specifies the version of unicode that will be used when interpreting the width/presentation of text. diff --git a/docs/config/lua/config/unzoom_on_switch_pane.md b/docs/config/lua/config/unzoom_on_switch_pane.md index 7a787afa2..39fff7dad 100644 --- a/docs/config/lua/config/unzoom_on_switch_pane.md +++ b/docs/config/lua/config/unzoom_on_switch_pane.md @@ -1,6 +1,6 @@ # `unzoom_on_switch_pane = true` -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} If set to `false`, the [`ActivatePaneDirection`](../keyassignment/ActivatePaneDirection.md) command diff --git a/docs/config/lua/config/use_cap_height_to_scale_fallback_fonts.md b/docs/config/lua/config/use_cap_height_to_scale_fallback_fonts.md index b1178d4da..f5a070c2a 100644 --- a/docs/config/lua/config/use_cap_height_to_scale_fallback_fonts.md +++ b/docs/config/lua/config/use_cap_height_to_scale_fallback_fonts.md @@ -1,6 +1,6 @@ # `use_cap_height_to_scale_fallback_fonts = false` -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} When set to true, use the *cap-height* font metrics of the base and the current font to adjust the size of secondary fonts (such as bold or italic faces) to diff --git a/docs/config/lua/config/use_fancy_tab_bar.md b/docs/config/lua/config/use_fancy_tab_bar.md index ec7cbd63c..5c9c15e22 100644 --- a/docs/config/lua/config/use_fancy_tab_bar.md +++ b/docs/config/lua/config/use_fancy_tab_bar.md @@ -1,6 +1,6 @@ # `use_fancy_tab_bar = true` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} When set to `true` (the default), the tab bar is rendered in a native style with proportional fonts. diff --git a/docs/config/lua/config/use_ime.md b/docs/config/lua/config/use_ime.md index 98f1bb026..e916e16f8 100644 --- a/docs/config/lua/config/use_ime.md +++ b/docs/config/lua/config/use_ime.md @@ -21,17 +21,17 @@ config.use_ime = false Changing `use_ime` usually requires re-launching WezTerm to take full effect. -*Since: 20200620-160318-e00b076c* +{{since('20200620-160318-e00b076c')}} The default for `use_ime` is false. The default in earlier releases was `true`. -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} The default for X11 systems is now `true`. Please ensure that the `XMODIFIERS` 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: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} The default for all systems is now `true` diff --git a/docs/config/lua/config/use_resize_increments.md b/docs/config/lua/config/use_resize_increments.md index 2045edbe3..72b5d2edf 100644 --- a/docs/config/lua/config/use_resize_increments.md +++ b/docs/config/lua/config/use_resize_increments.md @@ -1,6 +1,6 @@ # use_resize_increments = false -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} When set to `true`, prefer to snap the window size to a multiple of the terminal cell size. The default is `false`, which allows sizing the window to diff --git a/docs/config/lua/config/visual_bell.md b/docs/config/lua/config/visual_bell.md index 4d7f0a11a..ad7f512b3 100644 --- a/docs/config/lua/config/visual_bell.md +++ b/docs/config/lua/config/visual_bell.md @@ -1,6 +1,6 @@ # visual_bell -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} When the BEL ascii sequence is sent to a pane, the bell is "rung" in that pane. @@ -27,7 +27,7 @@ The following easing functions are supported: * `EaseInOut` - The fade starts slowly, speeds up, and then slows down towards the end. * `EaseOut` - The fade starts abruptly, and then progressively slows down towards the end. * `{CubicBezier={0.0, 0.0, 0.58, 1.0}}` - an arbitrary cubic bezier with the specified parameters. -* `Constant` - Evaluates as 0 regardless of time. Useful to implement a step transition at the end of the duration. (*Since: 20220408-101518-b908e2dd*) +* `Constant` - Evaluates as 0 regardless of time. Useful to implement a step transition at the end of the duration. {{since('20220408-101518-b908e2dd', inline=True)}} The following configuration enables a low intensity visual bell that takes a total of 300ms to "flash" the screen: diff --git a/docs/config/lua/config/warn_about_missing_glyphs.md b/docs/config/lua/config/warn_about_missing_glyphs.md index ce6f9f0dd..3c3c6dede 100644 --- a/docs/config/lua/config/warn_about_missing_glyphs.md +++ b/docs/config/lua/config/warn_about_missing_glyphs.md @@ -1,6 +1,6 @@ ### warn_about_missing_glyphs = true -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} When set to true, if a glyph cannot be found for a given codepoint, then the configuration error window will be shown with a pointer to the font diff --git a/docs/config/lua/config/webgpu_force_fallback_adapter.md b/docs/config/lua/config/webgpu_force_fallback_adapter.md index 909a97343..de893eb36 100644 --- a/docs/config/lua/config/webgpu_force_fallback_adapter.md +++ b/docs/config/lua/config/webgpu_force_fallback_adapter.md @@ -1,6 +1,6 @@ # `webgpu_force_fallback_adapter = false` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} If set to `true`, forces the use of a fallback software (CPU based) rendering backend. The performance will not be as good as using a GPU. diff --git a/docs/config/lua/config/webgpu_power_preference.md b/docs/config/lua/config/webgpu_power_preference.md index 063f30f5d..a9bfa2c8d 100644 --- a/docs/config/lua/config/webgpu_power_preference.md +++ b/docs/config/lua/config/webgpu_power_preference.md @@ -1,6 +1,6 @@ # `webgpu_power_preference = "LowPower"` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} Specifies the power preference when selecting a webgpu GPU instance. This option is only applicable when you have configured `front_end = "WebGpu"`. diff --git a/docs/config/lua/config/webgpu_preferred_adapter.md b/docs/config/lua/config/webgpu_preferred_adapter.md index b1942d206..bb66f5244 100644 --- a/docs/config/lua/config/webgpu_preferred_adapter.md +++ b/docs/config/lua/config/webgpu_preferred_adapter.md @@ -1,6 +1,6 @@ # `webgpu_preferred_adapter` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} Specifies which WebGpu adapter should be used. diff --git a/docs/config/lua/config/window_background_gradient.md b/docs/config/lua/config/window_background_gradient.md index a5a387712..46c40125e 100644 --- a/docs/config/lua/config/window_background_gradient.md +++ b/docs/config/lua/config/window_background_gradient.md @@ -1,6 +1,6 @@ # window_background_gradient -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} Dynamically generates a `window_background_image` from the provided gradient specification. When `window_background_gradient` is configured, the value @@ -69,7 +69,7 @@ for some usage examples and additional information about gradients. ## Linear gradient: -*Since: 20220624-141144-bd1b7c5d* +{{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/config/window_frame.md b/docs/config/lua/config/window_frame.md index a0da17edb..a065685dd 100644 --- a/docs/config/lua/config/window_frame.md +++ b/docs/config/lua/config/window_frame.md @@ -1,6 +1,6 @@ # window_frame -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} This setting is applicable primarily on Wayland systems when client side decorations are in use. @@ -24,7 +24,7 @@ config.window_frame = { } ``` -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} You may explicitly add a border around the window area: diff --git a/docs/config/lua/config/window_padding.md b/docs/config/lua/config/window_padding.md index 46b1d8eaf..fad0d7142 100644 --- a/docs/config/lua/config/window_padding.md +++ b/docs/config/lua/config/window_padding.md @@ -19,7 +19,7 @@ config.window_padding = { } ``` -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} You may now express padding using a number of different units by specifying a string value with a unit suffix: diff --git a/docs/config/lua/config/wsl_domains.md b/docs/config/lua/config/wsl_domains.md index 0b771a6ff..9c52bd6e6 100644 --- a/docs/config/lua/config/wsl_domains.md +++ b/docs/config/lua/config/wsl_domains.md @@ -1,6 +1,6 @@ # `wsl_domains` -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Configures [WSL](https://docs.microsoft.com/en-us/windows/wsl/about) domains. diff --git a/docs/config/lua/config/xim_im_name.md b/docs/config/lua/config/xim_im_name.md index 23dc70812..3790dc825 100644 --- a/docs/config/lua/config/xim_im_name.md +++ b/docs/config/lua/config/xim_im_name.md @@ -1,6 +1,6 @@ # `xim_im_name` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} Explicitly set the name of the IME server to which wezterm will connect via the XIM protocol when using X11 and [use_ime](use_ime.md) is `true`. diff --git a/docs/config/lua/gui-events/gui-startup.md b/docs/config/lua/gui-events/gui-startup.md index e6441e30e..52a0826e4 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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} The `gui-startup` event is emitted once when the GUI server is starting up when running the `wezterm start` subcommand. @@ -19,7 +19,7 @@ This event fires before [gui-attached](gui-attached.md). This event does not fire for `wezterm connect` invocations. -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} The event receives an optional [SpawnCommand](../SpawnCommand.md) argument that corresponds to any arguments that may have been passed via `wezterm start`. diff --git a/docs/config/lua/keyassignment/ActivateCopyMode.md b/docs/config/lua/keyassignment/ActivateCopyMode.md index 6ed9437e9..4120e51a2 100644 --- a/docs/config/lua/keyassignment/ActivateCopyMode.md +++ b/docs/config/lua/keyassignment/ActivateCopyMode.md @@ -1,6 +1,6 @@ # ActivateCopyMode -*since: 20200607-144723-74889cd4* +{{since('20200607-144723-74889cd4')}} Activates copy mode! diff --git a/docs/config/lua/keyassignment/ActivateKeyTable.md b/docs/config/lua/keyassignment/ActivateKeyTable.md index 39e33c204..564d0696a 100644 --- a/docs/config/lua/keyassignment/ActivateKeyTable.md +++ b/docs/config/lua/keyassignment/ActivateKeyTable.md @@ -1,6 +1,6 @@ # ActivateKeyTable -*Since: 20220408-101518-b908e2dd* +{{since('20220408-101518-b908e2dd')}} Activates a named key table. @@ -10,10 +10,10 @@ The following parameters are possible: * `name` - the name of the table to activate. The name must match up to an entry in the `key_tables` configuration. * `timeout_milliseconds` - an optional duration expressed in milliseconds. If specified, then the activation will automatically expire and pop itself from the key table stack once that duration elapses. If omitted, this activation will not expire due to time. - * *Since: 20220807-113146-c2fee766*: the timer is reset each time you press a key that matches this key table activation, allowing for repeated key presses + * {{since('20220807-113146-c2fee766', inline=True)}}: the timer is reset each time you press a key that matches this key table activation, allowing for repeated key presses * `one_shot` - an optional boolean that controls whether the activation will pop itself after a single additional key press. The default if left unspecified is `one_shot=true`. When set to `false`, pressing a key will not automatically pop the activation and you will need to use either a timeout or an explicit key assignment that triggers [PopKeyTable](PopKeyTable.md) to cancel the activation. * `replace_current` - an optional boolean. Defaults to `false` if unspecified. If set to `true` then behave as though [PopKeyTable](PopKeyTable.md) was triggered before pushing this new activation on the stack. This is most useful for key assignments in a table that was activated using `one_shot=false`. -* `until_unknown` - an optional boolean. Defaults to `false` if unspecified. If set to `true` then a key press that doesn't match any entries in the named key table will implicitly pop this entry from the stack. This can be used together with `timeout_milliseconds`. (*Since: 20220807-113146-c2fee766*) +* `until_unknown` - an optional boolean. Defaults to `false` if unspecified. If set to `true` then a key press that doesn't match any entries in the named key table will implicitly pop this entry from the stack. This can be used together with `timeout_milliseconds`. {{since('20220807-113146-c2fee766', inline=True)}} * `prevent_fallback` - an optional boolean. Defaults to `false` if unspecified. If set to `true` then a key press that doesn't match any entries in the named key table will halt any further key table stack matching, allowing only key @@ -21,4 +21,4 @@ The following parameters are possible: Use with care: if you haven't defined an explicit [PopKeyTable](PopKeyTable.md) assignment in the key table, you can lock yourself out of the keyboard and will need to reload the configuration file - (eg: by re-saving it) to get back in. (*Since: 20221119-145034-49b9839f*) + (eg: by re-saving it) to get back in. {{since('20221119-145034-49b9839f', inline=True)}} diff --git a/docs/config/lua/keyassignment/ActivateLastTab.md b/docs/config/lua/keyassignment/ActivateLastTab.md index 1cab716b4..3e6f4c931 100644 --- a/docs/config/lua/keyassignment/ActivateLastTab.md +++ b/docs/config/lua/keyassignment/ActivateLastTab.md @@ -1,6 +1,6 @@ # ActivateLastTab -*Since: 20210404-112810-b63a949d* +{{since('20210404-112810-b63a949d')}} Activate the previously active tab. If there is none, it will do nothing. diff --git a/docs/config/lua/keyassignment/ActivatePaneByIndex.md b/docs/config/lua/keyassignment/ActivatePaneByIndex.md index b0bfdd930..bb703dfec 100644 --- a/docs/config/lua/keyassignment/ActivatePaneByIndex.md +++ b/docs/config/lua/keyassignment/ActivatePaneByIndex.md @@ -1,6 +1,6 @@ # ActivatePaneByIndex -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} `ActivatePaneByIndex` activates the pane with the specified index within the current tab. Invalid indices are ignored. diff --git a/docs/config/lua/keyassignment/ActivatePaneDirection.md b/docs/config/lua/keyassignment/ActivatePaneDirection.md index b05db5b00..2f466695d 100644 --- a/docs/config/lua/keyassignment/ActivatePaneDirection.md +++ b/docs/config/lua/keyassignment/ActivatePaneDirection.md @@ -1,6 +1,6 @@ # ActivatePaneDirection -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} `ActivatePaneDirection` activate an adjacent pane in the specified direction. In cases where there are multiple adjacent panes in the intended direction, @@ -39,7 +39,7 @@ config.keys = { return config ``` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} You may now use `"Next"` and `"Prev"` as directions. These cycle through the panes according to their position in the pane tree. @@ -50,7 +50,7 @@ if the active pane is already the highest pane index. `"Prev"` moves to the next lowest pane index, wrapping around to the highest of the active pane is already the lowest pane index. -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} Ambiguous moves are now resolved by selecting the most recently activated pane in a given direction, instead of based on the edge intersection. diff --git a/docs/config/lua/keyassignment/ActivateTab.md b/docs/config/lua/keyassignment/ActivateTab.md index b65ddcfdb..0a6b5344f 100644 --- a/docs/config/lua/keyassignment/ActivateTab.md +++ b/docs/config/lua/keyassignment/ActivateTab.md @@ -3,7 +3,7 @@ Activate the tab specified by the argument value. eg: `0` activates the leftmost tab, while `1` activates the second tab from the left, and so on. -*since: 20200620-160318-e00b076c* +{{since('20200620-160318-e00b076c')}} `ActivateTab` now accepts negative numbers; these wrap around from the start of the tabs to the end, so `-1` references the right-most tab, `-2` the tab diff --git a/docs/config/lua/keyassignment/ActivateTabRelativeNoWrap.md b/docs/config/lua/keyassignment/ActivateTabRelativeNoWrap.md index 95b346c1f..a11ec0287 100644 --- a/docs/config/lua/keyassignment/ActivateTabRelativeNoWrap.md +++ b/docs/config/lua/keyassignment/ActivateTabRelativeNoWrap.md @@ -1,6 +1,6 @@ # ActivateTabRelativeNoWrap -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} Activate a tab relative to the current tab. The argument value specifies an offset. eg: `-1` activates the tab to the left of the current tab, while `1` diff --git a/docs/config/lua/keyassignment/ActivateWindow.md b/docs/config/lua/keyassignment/ActivateWindow.md index 9cde2b4e0..6b9536777 100644 --- a/docs/config/lua/keyassignment/ActivateWindow.md +++ b/docs/config/lua/keyassignment/ActivateWindow.md @@ -1,6 +1,6 @@ # ActivateWindow(n) -*since: nightly builds only* +{{since('20230320-124340-559cb7b0')}} Activates the *nth* GUI window, zero-based. diff --git a/docs/config/lua/keyassignment/ActivateWindowRelative.md b/docs/config/lua/keyassignment/ActivateWindowRelative.md index 358e886ea..e6edcb410 100644 --- a/docs/config/lua/keyassignment/ActivateWindowRelative.md +++ b/docs/config/lua/keyassignment/ActivateWindowRelative.md @@ -1,6 +1,6 @@ # ActivateWindowRelative(delta) -*since: nightly builds only* +{{since('20230320-124340-559cb7b0')}} Activates a GUI window relative to the current window. diff --git a/docs/config/lua/keyassignment/ActivateWindowRelativeNoWrap.md b/docs/config/lua/keyassignment/ActivateWindowRelativeNoWrap.md index 90d5bc798..bbe49f168 100644 --- a/docs/config/lua/keyassignment/ActivateWindowRelativeNoWrap.md +++ b/docs/config/lua/keyassignment/ActivateWindowRelativeNoWrap.md @@ -1,6 +1,6 @@ # ActivateWindowRelative(delta) -*since: nightly builds only* +{{since('20230320-124340-559cb7b0')}} Activates a GUI window relative to the current window. diff --git a/docs/config/lua/keyassignment/AdjustPaneSize.md b/docs/config/lua/keyassignment/AdjustPaneSize.md index 797b0eb97..f18f25850 100644 --- a/docs/config/lua/keyassignment/AdjustPaneSize.md +++ b/docs/config/lua/keyassignment/AdjustPaneSize.md @@ -1,6 +1,6 @@ # AdjustPaneSize -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} `AdjustPaneSize` manipulates the size of the active pane, allowing the size to be adjusted by an integer amount in a specific direction. diff --git a/docs/config/lua/keyassignment/AttachDomain.md b/docs/config/lua/keyassignment/AttachDomain.md index 32bdfc80a..806ce68b9 100644 --- a/docs/config/lua/keyassignment/AttachDomain.md +++ b/docs/config/lua/keyassignment/AttachDomain.md @@ -1,6 +1,6 @@ # AttachDomain(domain_name) -*Since: 20220624-141144-bd1b7c5d* +{{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/CharSelect.md b/docs/config/lua/keyassignment/CharSelect.md index 61316114c..f4252c21b 100644 --- a/docs/config/lua/keyassignment/CharSelect.md +++ b/docs/config/lua/keyassignment/CharSelect.md @@ -1,6 +1,6 @@ # CharSelect -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} Activates *Character Selection Mode*, which is a pop-over modal that allows you to browse characters by category as well as fuzzy search by name or hex unicode diff --git a/docs/config/lua/keyassignment/ClearKeyTableStack.md b/docs/config/lua/keyassignment/ClearKeyTableStack.md index b85778138..5967dd504 100644 --- a/docs/config/lua/keyassignment/ClearKeyTableStack.md +++ b/docs/config/lua/keyassignment/ClearKeyTableStack.md @@ -1,6 +1,6 @@ # ClearKeyTableStack -*Since: 20220408-101518-b908e2dd* +{{since('20220408-101518-b908e2dd')}} Clears the entire key table stack. diff --git a/docs/config/lua/keyassignment/ClearScrollback.md b/docs/config/lua/keyassignment/ClearScrollback.md index 850d11c16..ccad8b52e 100644 --- a/docs/config/lua/keyassignment/ClearScrollback.md +++ b/docs/config/lua/keyassignment/ClearScrollback.md @@ -3,7 +3,7 @@ Clears the lines that have scrolled off the top of the viewport, resetting the scrollbar thumb to the full height of the window. -*since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} Added a parameter that allows additionally clear the viewport: diff --git a/docs/config/lua/keyassignment/ClearSelection.md b/docs/config/lua/keyassignment/ClearSelection.md index 0f4af9ef0..717fa4034 100644 --- a/docs/config/lua/keyassignment/ClearSelection.md +++ b/docs/config/lua/keyassignment/ClearSelection.md @@ -1,6 +1,6 @@ # ClearSelection -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Clears the selection in the current pane. diff --git a/docs/config/lua/keyassignment/CompleteSelection.md b/docs/config/lua/keyassignment/CompleteSelection.md index 9382f75cb..f9cdb6ed6 100644 --- a/docs/config/lua/keyassignment/CompleteSelection.md +++ b/docs/config/lua/keyassignment/CompleteSelection.md @@ -4,7 +4,7 @@ Completes an active text selection process; the selection range is marked closed and then the selected text is copied as though the `Copy` action was executed. -*since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} `CompleteSelection` now requires a destination parameter to specify which clipboard buffer the selection will populate; the copy action diff --git a/docs/config/lua/keyassignment/CompleteSelectionOrOpenLinkAtMouseCursor.md b/docs/config/lua/keyassignment/CompleteSelectionOrOpenLinkAtMouseCursor.md index 20f199019..3d7a5ab29 100644 --- a/docs/config/lua/keyassignment/CompleteSelectionOrOpenLinkAtMouseCursor.md +++ b/docs/config/lua/keyassignment/CompleteSelectionOrOpenLinkAtMouseCursor.md @@ -5,7 +5,7 @@ triggered. Otherwise acts as though `OpenLinkAtMouseCursor` was triggered. -*since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} `CompleteSelectionOrOpenLinkAtMouseCursor` now requires a destination parameter to specify which clipboard buffer the selection will populate. The copy action diff --git a/docs/config/lua/keyassignment/Copy.md b/docs/config/lua/keyassignment/Copy.md index e1ee643b2..07743fcd1 100644 --- a/docs/config/lua/keyassignment/Copy.md +++ b/docs/config/lua/keyassignment/Copy.md @@ -2,7 +2,7 @@ Copy the selection to the clipboard. -*since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} This action is considered to be deprecated and will be removed in a future release; please use [CopyTo](CopyTo.md) instead. diff --git a/docs/config/lua/keyassignment/CopyMode/AcceptPattern.md b/docs/config/lua/keyassignment/CopyMode/AcceptPattern.md index 02d2b5ac8..1fd49ddbf 100644 --- a/docs/config/lua/keyassignment/CopyMode/AcceptPattern.md +++ b/docs/config/lua/keyassignment/CopyMode/AcceptPattern.md @@ -1,6 +1,6 @@ # CopyMode 'AcceptPattern' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Take CopyMode/SearchMode out of editing mode: keyboard input will no longer be directed to the search pattern editor. diff --git a/docs/config/lua/keyassignment/CopyMode/ClearPattern.md b/docs/config/lua/keyassignment/CopyMode/ClearPattern.md index f0d1649df..3413e7654 100644 --- a/docs/config/lua/keyassignment/CopyMode/ClearPattern.md +++ b/docs/config/lua/keyassignment/CopyMode/ClearPattern.md @@ -1,6 +1,6 @@ # CopyMode 'ClearPattern' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Clear the CopyMode/SearchMode search pattern. diff --git a/docs/config/lua/keyassignment/CopyMode/ClearSelectionMode.md b/docs/config/lua/keyassignment/CopyMode/ClearSelectionMode.md index bdafd1289..c51299dc3 100644 --- a/docs/config/lua/keyassignment/CopyMode/ClearSelectionMode.md +++ b/docs/config/lua/keyassignment/CopyMode/ClearSelectionMode.md @@ -1,6 +1,6 @@ # CopyMode 'ClearSelectionMode' -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Clears the current CopyMode selection mode without leaving CopyMode. diff --git a/docs/config/lua/keyassignment/CopyMode/Close.md b/docs/config/lua/keyassignment/CopyMode/Close.md index 407442349..1ecd17832 100644 --- a/docs/config/lua/keyassignment/CopyMode/Close.md +++ b/docs/config/lua/keyassignment/CopyMode/Close.md @@ -1,6 +1,6 @@ # CopyMode 'Close' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Close copy mode. diff --git a/docs/config/lua/keyassignment/CopyMode/CycleMatchType.md b/docs/config/lua/keyassignment/CopyMode/CycleMatchType.md index 9901f8c9d..4161a1294 100644 --- a/docs/config/lua/keyassignment/CopyMode/CycleMatchType.md +++ b/docs/config/lua/keyassignment/CopyMode/CycleMatchType.md @@ -1,6 +1,6 @@ # CopyMode 'CycleMatchType' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Move the CopyMode/SearchMode cycle between case-sensitive, case-insensitive and regular expression match types. diff --git a/docs/config/lua/keyassignment/CopyMode/EditPattern.md b/docs/config/lua/keyassignment/CopyMode/EditPattern.md index 3fc42c5bf..78a47f9d5 100644 --- a/docs/config/lua/keyassignment/CopyMode/EditPattern.md +++ b/docs/config/lua/keyassignment/CopyMode/EditPattern.md @@ -1,6 +1,6 @@ # CopyMode 'EditPattern' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Put CopyMode/SearchMode into editing mode: keyboard input will be directed to the search pattern editor. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveBackwardSemanticZone.md b/docs/config/lua/keyassignment/CopyMode/MoveBackwardSemanticZone.md index 006ef51c1..ed54522d3 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveBackwardSemanticZone.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveBackwardSemanticZone.md @@ -1,6 +1,6 @@ # CopyMode 'MoveBackwardSemanticZone' -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} Moves the CopyMode cursor position one semantic zone to the left. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveBackwardSemanticZoneOfType.md b/docs/config/lua/keyassignment/CopyMode/MoveBackwardSemanticZoneOfType.md index 1c36328e4..55f82a126 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveBackwardSemanticZoneOfType.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveBackwardSemanticZoneOfType.md @@ -1,6 +1,6 @@ # CopyMode { MoveBackwardSemanticZone = ZONE } -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} Moves the CopyMode cursor position to the first semantic zone of the specified type that precedes the current zone. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveBackwardWord.md b/docs/config/lua/keyassignment/CopyMode/MoveBackwardWord.md index e2263f8e0..70f90c7fa 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveBackwardWord.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveBackwardWord.md @@ -1,6 +1,6 @@ # CopyMode 'MoveBackwardWord' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position one word to the left. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveDown.md b/docs/config/lua/keyassignment/CopyMode/MoveDown.md index 66eab975c..9b37391c0 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveDown.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveDown.md @@ -1,6 +1,6 @@ # CopyMode 'MoveDown' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position one cell down. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveForwardSemanticZone.md b/docs/config/lua/keyassignment/CopyMode/MoveForwardSemanticZone.md index 3e01c47b3..c0b82853d 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveForwardSemanticZone.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveForwardSemanticZone.md @@ -1,6 +1,6 @@ # CopyMode 'MoveForewardSemanticZone' -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} Moves the CopyMode cursor position one semantic zone to the right. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveForwardSemanticZoneOfType.md b/docs/config/lua/keyassignment/CopyMode/MoveForwardSemanticZoneOfType.md index 2d5ed18b4..6a4ea32a7 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveForwardSemanticZoneOfType.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveForwardSemanticZoneOfType.md @@ -1,6 +1,6 @@ # CopyMode { MoveForwardSemanticZone = ZONE } -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} Moves the CopyMode cursor position to the next semantic zone of the specified type that follows the current zone. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveForwardWord.md b/docs/config/lua/keyassignment/CopyMode/MoveForwardWord.md index 90094f920..0922ec9e3 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveForwardWord.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveForwardWord.md @@ -1,6 +1,6 @@ # CopyMode 'MoveForwardWord' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position one word to the right. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveLeft.md b/docs/config/lua/keyassignment/CopyMode/MoveLeft.md index 31cdb48a6..c7d3568a9 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveLeft.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveLeft.md @@ -1,6 +1,6 @@ # CopyMode 'MoveLeft' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position one cell to the left. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveRight.md b/docs/config/lua/keyassignment/CopyMode/MoveRight.md index 6879916ec..437870a6e 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveRight.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveRight.md @@ -1,6 +1,6 @@ # CopyMode 'MoveRight' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position one cell to the right. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToEndOfLineContent.md b/docs/config/lua/keyassignment/CopyMode/MoveToEndOfLineContent.md index 9d5e094dd..83e032892 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToEndOfLineContent.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToEndOfLineContent.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToEndOfLineContent' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the last non-space cell in the current line. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToScrollbackBottom.md b/docs/config/lua/keyassignment/CopyMode/MoveToScrollbackBottom.md index 2a1477eb7..346452e81 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToScrollbackBottom.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToScrollbackBottom.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToScrollbackBottom' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the bottom of the scrollback. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToScrollbackTop.md b/docs/config/lua/keyassignment/CopyMode/MoveToScrollbackTop.md index d4006bfe3..d9ea79c20 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToScrollbackTop.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToScrollbackTop.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToScrollbackTop' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the top of the scrollback. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToSelectionOtherEnd.md b/docs/config/lua/keyassignment/CopyMode/MoveToSelectionOtherEnd.md index f8745d851..5c3e0c964 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToSelectionOtherEnd.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToSelectionOtherEnd.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToSelectionOtherEnd' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the other end of the selection; if the cursor is at the top left corner and the starting point is the bottom right diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToSelectionOtherEndHoriz.md b/docs/config/lua/keyassignment/CopyMode/MoveToSelectionOtherEndHoriz.md index d865fd825..e5ffab615 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToSelectionOtherEndHoriz.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToSelectionOtherEndHoriz.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToSelectionOtherEndHoriz' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the other horizontal end of the selection without changing the y-coordinate; if the cursor at the left end and diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToStartOfLine.md b/docs/config/lua/keyassignment/CopyMode/MoveToStartOfLine.md index 8909d694d..732263dc3 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToStartOfLine.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToStartOfLine.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToStartOfLine' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the first cell in the current line. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToStartOfLineContent.md b/docs/config/lua/keyassignment/CopyMode/MoveToStartOfLineContent.md index f865e81c6..c02604c5b 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToStartOfLineContent.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToStartOfLineContent.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToStartOfLineContent' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the first non-space cell in the current line. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToStartOfNextLine.md b/docs/config/lua/keyassignment/CopyMode/MoveToStartOfNextLine.md index 99235f898..2c3ac4f2e 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToStartOfNextLine.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToStartOfNextLine.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToStartOfNextLine' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the first cell in the next line. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToViewportBottom.md b/docs/config/lua/keyassignment/CopyMode/MoveToViewportBottom.md index 614117d24..9c797bc52 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToViewportBottom.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToViewportBottom.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToViewportBottom' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the bottom of the viewport. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToViewportMiddle.md b/docs/config/lua/keyassignment/CopyMode/MoveToViewportMiddle.md index 3c07c7895..f8706bc84 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToViewportMiddle.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToViewportMiddle.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToViewportMiddle' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the middle of the viewport. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveToViewportTop.md b/docs/config/lua/keyassignment/CopyMode/MoveToViewportTop.md index 3a93bf374..df725ef5d 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveToViewportTop.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveToViewportTop.md @@ -1,6 +1,6 @@ # CopyMode 'MoveToViewportTop' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position to the top of the viewport. diff --git a/docs/config/lua/keyassignment/CopyMode/MoveUp.md b/docs/config/lua/keyassignment/CopyMode/MoveUp.md index 68c7995f5..0e9da0c28 100644 --- a/docs/config/lua/keyassignment/CopyMode/MoveUp.md +++ b/docs/config/lua/keyassignment/CopyMode/MoveUp.md @@ -1,6 +1,6 @@ # CopyMode 'MoveUp' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Moves the CopyMode cursor position one cell up. diff --git a/docs/config/lua/keyassignment/CopyMode/NextMatch.md b/docs/config/lua/keyassignment/CopyMode/NextMatch.md index a212da1dc..b83dbb3b4 100644 --- a/docs/config/lua/keyassignment/CopyMode/NextMatch.md +++ b/docs/config/lua/keyassignment/CopyMode/NextMatch.md @@ -1,6 +1,6 @@ # CopyMode 'NextMatch' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Move the CopyMode/SearchMode selection to the next matching text, if any. diff --git a/docs/config/lua/keyassignment/CopyMode/NextMatchPage.md b/docs/config/lua/keyassignment/CopyMode/NextMatchPage.md index 3a392114c..43016dedd 100644 --- a/docs/config/lua/keyassignment/CopyMode/NextMatchPage.md +++ b/docs/config/lua/keyassignment/CopyMode/NextMatchPage.md @@ -1,6 +1,6 @@ # CopyMode 'NextMatchPage' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Move the CopyMode/SearchMode selection to the next matching text on the next page of the screen, if any. diff --git a/docs/config/lua/keyassignment/CopyMode/PriorMatch.md b/docs/config/lua/keyassignment/CopyMode/PriorMatch.md index edd88d2d5..0f45fc786 100644 --- a/docs/config/lua/keyassignment/CopyMode/PriorMatch.md +++ b/docs/config/lua/keyassignment/CopyMode/PriorMatch.md @@ -1,6 +1,6 @@ # CopyMode 'PriorMatch' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Move the CopyMode/SearchMode selection to the previous matching text, if any. diff --git a/docs/config/lua/keyassignment/CopyMode/PriorMatchPage.md b/docs/config/lua/keyassignment/CopyMode/PriorMatchPage.md index 617a5b425..5d010a0d2 100644 --- a/docs/config/lua/keyassignment/CopyMode/PriorMatchPage.md +++ b/docs/config/lua/keyassignment/CopyMode/PriorMatchPage.md @@ -1,6 +1,6 @@ # CopyMode 'PriorMatchPage' -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Move the CopyMode/SearchMode selection to the previous matching text on the previous page of the screen, if any. diff --git a/docs/config/lua/keyassignment/CopyMode/SetSelectionMode.md b/docs/config/lua/keyassignment/CopyMode/SetSelectionMode.md index 1a6653ae0..2255b1157 100644 --- a/docs/config/lua/keyassignment/CopyMode/SetSelectionMode.md +++ b/docs/config/lua/keyassignment/CopyMode/SetSelectionMode.md @@ -1,6 +1,6 @@ # CopyMode { SetSelectionMode = MODE } -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Sets the CopyMode selection mode. @@ -10,7 +10,7 @@ MODE can be one of: * `"Word"` - selection expands by a word at a time * `"Line"` - selection expands by a line at a time * `"Block"` - selection expands to define a rectangular block using the starting point and current cursor position as the corners -* `"SemanticZone"` - selection expands to the current semantic zone. See [Shell Integration](../../../../shell-integration.md). (*Since: 20220903-194523-3bb1ed61*). +* `"SemanticZone"` - selection expands to the current semantic zone. See [Shell Integration](../../../../shell-integration.md). {{since('20220903-194523-3bb1ed61', inline=True)}}. ```lua local wezterm = require 'wezterm' diff --git a/docs/config/lua/keyassignment/CopyTo.md b/docs/config/lua/keyassignment/CopyTo.md index b8877cfa2..196f5eb40 100644 --- a/docs/config/lua/keyassignment/CopyTo.md +++ b/docs/config/lua/keyassignment/CopyTo.md @@ -18,6 +18,6 @@ config.keys = { } ``` -*Since: 20220319-142410-0fcdea07* +{{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. diff --git a/docs/config/lua/keyassignment/DetachDomain.md b/docs/config/lua/keyassignment/DetachDomain.md index 618964579..8f23bb37c 100644 --- a/docs/config/lua/keyassignment/DetachDomain.md +++ b/docs/config/lua/keyassignment/DetachDomain.md @@ -1,6 +1,6 @@ # DetachDomain(domain) -*Since: 20220624-141144-bd1b7c5d* +{{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/EmitEvent.md b/docs/config/lua/keyassignment/EmitEvent.md index 3b4e40c99..8699be3b9 100644 --- a/docs/config/lua/keyassignment/EmitEvent.md +++ b/docs/config/lua/keyassignment/EmitEvent.md @@ -1,6 +1,6 @@ # EmitEvent -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} This action causes the equivalent of `wezterm.emit(name, window, pane)` to be called in the context of the current pane. diff --git a/docs/config/lua/keyassignment/ExtendSelectionToMouseCursor.md b/docs/config/lua/keyassignment/ExtendSelectionToMouseCursor.md index cc6403436..3ada2c9c2 100644 --- a/docs/config/lua/keyassignment/ExtendSelectionToMouseCursor.md +++ b/docs/config/lua/keyassignment/ExtendSelectionToMouseCursor.md @@ -4,7 +4,7 @@ Extends the current text selection to the current mouse cursor position. The mode argument can be one of `Cell`, `Word` or `Line` to control the scope of the selection. -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} The mode argument can also be `"Block"` to enable a rectangular block selection. diff --git a/docs/config/lua/keyassignment/Multiple.md b/docs/config/lua/keyassignment/Multiple.md index c7e8e3759..bedd81edf 100644 --- a/docs/config/lua/keyassignment/Multiple.md +++ b/docs/config/lua/keyassignment/Multiple.md @@ -1,6 +1,6 @@ # Multiple -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} Performs a sequence of multiple assignments. This is useful when you want a single key press to trigger multiple actions. diff --git a/docs/config/lua/keyassignment/PaneSelect.md b/docs/config/lua/keyassignment/PaneSelect.md index 878ffb64d..c58260187 100644 --- a/docs/config/lua/keyassignment/PaneSelect.md +++ b/docs/config/lua/keyassignment/PaneSelect.md @@ -1,6 +1,6 @@ # PaneSelect -*Since: 20220624-141144-bd1b7c5d* +{{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/Paste.md b/docs/config/lua/keyassignment/Paste.md index 3734a2d17..a5602bb18 100644 --- a/docs/config/lua/keyassignment/Paste.md +++ b/docs/config/lua/keyassignment/Paste.md @@ -2,7 +2,7 @@ Paste the clipboard to the current pane. -*since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} This action is considered to be deprecated and will be removed in a future release; please use [PasteFrom](PasteFrom.md) instead. diff --git a/docs/config/lua/keyassignment/PasteFrom.md b/docs/config/lua/keyassignment/PasteFrom.md index 88702dc2c..2c34f3a2e 100644 --- a/docs/config/lua/keyassignment/PasteFrom.md +++ b/docs/config/lua/keyassignment/PasteFrom.md @@ -22,6 +22,6 @@ config.keys = { } ``` -*Since: 20220319-142410-0fcdea07* +{{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. diff --git a/docs/config/lua/keyassignment/PastePrimarySelection.md b/docs/config/lua/keyassignment/PastePrimarySelection.md index 7d7768379..916d71999 100644 --- a/docs/config/lua/keyassignment/PastePrimarySelection.md +++ b/docs/config/lua/keyassignment/PastePrimarySelection.md @@ -3,7 +3,7 @@ X11: Paste the Primary Selection to the current tab. On other systems, this behaves identically to [Paste](Paste.md). -*since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} This action is considered to be deprecated and will be removed in a future release; please use [PasteFrom](PasteFrom.md) instead. diff --git a/docs/config/lua/keyassignment/PopKeyTable.md b/docs/config/lua/keyassignment/PopKeyTable.md index 9905a1d69..923f8f06e 100644 --- a/docs/config/lua/keyassignment/PopKeyTable.md +++ b/docs/config/lua/keyassignment/PopKeyTable.md @@ -1,6 +1,6 @@ # PopKeyTable -*Since: 20220408-101518-b908e2dd* +{{since('20220408-101518-b908e2dd')}} Pops the current key table, if any, from the activation stack. diff --git a/docs/config/lua/keyassignment/QuickSelect.md b/docs/config/lua/keyassignment/QuickSelect.md index 8f4a64ee7..66072f530 100644 --- a/docs/config/lua/keyassignment/QuickSelect.md +++ b/docs/config/lua/keyassignment/QuickSelect.md @@ -1,6 +1,6 @@ # QuickSelect -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Activates [Quick Select Mode](../../../quickselect.md). diff --git a/docs/config/lua/keyassignment/QuickSelectArgs.md b/docs/config/lua/keyassignment/QuickSelectArgs.md index cc40accd3..6ee61ae15 100644 --- a/docs/config/lua/keyassignment/QuickSelectArgs.md +++ b/docs/config/lua/keyassignment/QuickSelectArgs.md @@ -1,6 +1,6 @@ # QuickSelectArgs -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} Activates [Quick Select Mode](../../../quickselect.md) but with the option to override the global configuration. @@ -32,7 +32,7 @@ The `QuickSelectArgs` struct allows for the following fields: * `alphabet` - if present, this alphabet is used instead of [quick_select_alphabet](../config/quick_select_alphabet.md) * `action` - if present, this key assignment action is performed as if by [window:perform_action](../window/perform_action.md) when an item is selected. The normal clipboard action is NOT performed in this case. * `label` - if present, replaces the string `"copy"` that is shown at the bottom of the overlay; you can use this to indicate which action will happen if you are using `action`. -* `scope_lines` - Specify the number of lines to search above and below the current viewport. The default is 1000 lines. The scope will be increased to the current viewport height if it is smaller than the viewport. (*Since: 20220807-113146-c2fee766*. In earlier releases, the entire scrollback was always searched). +* `scope_lines` - Specify the number of lines to search above and below the current viewport. The default is 1000 lines. The scope will be increased to the current viewport height if it is smaller than the viewport. {{since('20220807-113146-c2fee766', inline=True)}}. In earlier releases, the entire scrollback was always searched). Here's an example that shows how to trigger some lua code to operate on the quick-selected text, instead of copying it to the clipboard. Here, we open diff --git a/docs/config/lua/keyassignment/ResetFontAndWindowSize.md b/docs/config/lua/keyassignment/ResetFontAndWindowSize.md index ab3145edc..2db22ca3c 100644 --- a/docs/config/lua/keyassignment/ResetFontAndWindowSize.md +++ b/docs/config/lua/keyassignment/ResetFontAndWindowSize.md @@ -1,6 +1,6 @@ # ResetFontAndWindowSize -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Reset both the font size and the terminal dimensions for the current window to the values specified by your `font`, `initial_rows`, and `initial_cols` configuration. diff --git a/docs/config/lua/keyassignment/ResetTerminal.md b/docs/config/lua/keyassignment/ResetTerminal.md index 833cb5d62..75a594429 100644 --- a/docs/config/lua/keyassignment/ResetTerminal.md +++ b/docs/config/lua/keyassignment/ResetTerminal.md @@ -1,6 +1,6 @@ # ResetTerminal -*since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} Sends the `RIS` "Reset to Initial State" escape sequence (`ESC-c`) to the output side of the current pane, causing the terminal emulator to reset its diff --git a/docs/config/lua/keyassignment/RotatePanes.md b/docs/config/lua/keyassignment/RotatePanes.md index 5beb2b7e2..f258e85cd 100644 --- a/docs/config/lua/keyassignment/RotatePanes.md +++ b/docs/config/lua/keyassignment/RotatePanes.md @@ -1,6 +1,6 @@ # RotatePanes -*Since: 20220624-141144-bd1b7c5d* +{{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/ScrollByCurrentEventWheelDelta.md b/docs/config/lua/keyassignment/ScrollByCurrentEventWheelDelta.md index 26213d7a5..0e66b3aad 100644 --- a/docs/config/lua/keyassignment/ScrollByCurrentEventWheelDelta.md +++ b/docs/config/lua/keyassignment/ScrollByCurrentEventWheelDelta.md @@ -1,6 +1,6 @@ # ScrollByCurrentEventWheelDelta -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Adjusts the scroll position by the number of lines in the vertical mouse wheel delta field of the current mouse event, provided that it is a diff --git a/docs/config/lua/keyassignment/ScrollByLine.md b/docs/config/lua/keyassignment/ScrollByLine.md index 595e5ac92..33034c3bf 100644 --- a/docs/config/lua/keyassignment/ScrollByLine.md +++ b/docs/config/lua/keyassignment/ScrollByLine.md @@ -1,6 +1,6 @@ # ScrollByLine -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Adjusts the scroll position by the number of lines specified by the argument. Negative values scroll upwards, while positive values scroll downwards. diff --git a/docs/config/lua/keyassignment/ScrollByPage.md b/docs/config/lua/keyassignment/ScrollByPage.md index 26bcd93d4..5c9f4ba77 100644 --- a/docs/config/lua/keyassignment/ScrollByPage.md +++ b/docs/config/lua/keyassignment/ScrollByPage.md @@ -12,7 +12,7 @@ config.keys = { } ``` -*Since: 20220319-142410-0fcdea07* +{{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: diff --git a/docs/config/lua/keyassignment/ScrollToBottom.md b/docs/config/lua/keyassignment/ScrollToBottom.md index 1f20b789c..215b92a16 100644 --- a/docs/config/lua/keyassignment/ScrollToBottom.md +++ b/docs/config/lua/keyassignment/ScrollToBottom.md @@ -1,6 +1,6 @@ # ScrollToBottom -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} This action scrolls the viewport to the bottom of the scrollback. diff --git a/docs/config/lua/keyassignment/ScrollToPrompt.md b/docs/config/lua/keyassignment/ScrollToPrompt.md index 9ee8ce4d7..31d7c5168 100644 --- a/docs/config/lua/keyassignment/ScrollToPrompt.md +++ b/docs/config/lua/keyassignment/ScrollToPrompt.md @@ -1,6 +1,6 @@ # ScrollToPrompt -*Since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} This action operates on Semantic Zones defined by applications that use [OSC 133 Semantic Prompt Escapes](https://gitlab.freedesktop.org/Per_Bothner/specifications/blob/master/proposals/semantic-prompts.md) and requires configuring your shell to emit those sequences. diff --git a/docs/config/lua/keyassignment/ScrollToTop.md b/docs/config/lua/keyassignment/ScrollToTop.md index c245229df..5b1f4ab2c 100644 --- a/docs/config/lua/keyassignment/ScrollToTop.md +++ b/docs/config/lua/keyassignment/ScrollToTop.md @@ -1,6 +1,6 @@ # ScrollToTop -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} This action scrolls the viewport to the top of the scrollback. diff --git a/docs/config/lua/keyassignment/Search.md b/docs/config/lua/keyassignment/Search.md index 0162fcf8c..a247183ff 100644 --- a/docs/config/lua/keyassignment/Search.md +++ b/docs/config/lua/keyassignment/Search.md @@ -1,6 +1,6 @@ # Search -*since: 20200607-144723-74889cd4* +{{since('20200607-144723-74889cd4')}} This action will trigger the search overlay for the current tab. It accepts a typed pattern string as its parameter, allowing for @@ -40,7 +40,7 @@ config.keys = { [Learn more about the search overlay](../../../scrollback.md#searching-the-scrollback) -*since: 20220624-141144-bd1b7c5d* +{{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 539007396..fd6f36b97 100644 --- a/docs/config/lua/keyassignment/SelectTextAtMouseCursor.md +++ b/docs/config/lua/keyassignment/SelectTextAtMouseCursor.md @@ -4,7 +4,7 @@ Initiates selection of text at the current mouse cursor position. The mode argument can be one of `Cell`, `Word` or `Line` to control the scope of the selection. -*Since: 20210203-095643-70a364eb* +{{since('20210203-095643-70a364eb')}} The mode argument can be `SemanticZone` which causes the selection to take the surrounding semantic zone. @@ -26,6 +26,6 @@ config.mouse_bindings = { [See Shell Integration docs](../../../shell-integration.md) for more details on how to set up your shell to define semantic zones. -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} The mode argument can also be `"Block"` to enable a rectangular block selection. diff --git a/docs/config/lua/keyassignment/SendKey.md b/docs/config/lua/keyassignment/SendKey.md index 94b859ea7..587a77092 100644 --- a/docs/config/lua/keyassignment/SendKey.md +++ b/docs/config/lua/keyassignment/SendKey.md @@ -1,6 +1,6 @@ # SendKey -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} Send the specified key press to the current pane. This is useful to rebind the effect of a key combination. diff --git a/docs/config/lua/keyassignment/SetPaneZoomState.md b/docs/config/lua/keyassignment/SetPaneZoomState.md index 970eea1bb..1cb129c4c 100644 --- a/docs/config/lua/keyassignment/SetPaneZoomState.md +++ b/docs/config/lua/keyassignment/SetPaneZoomState.md @@ -1,6 +1,6 @@ # SetPaneZoomState(bool) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Sets the zoom state of the current pane. A Zoomed pane takes up all available space in the tab, hiding all other panes while it is zoomed. diff --git a/docs/config/lua/keyassignment/ShowDebugOverlay.md b/docs/config/lua/keyassignment/ShowDebugOverlay.md index 58229a0a3..5f786c34b 100644 --- a/docs/config/lua/keyassignment/ShowDebugOverlay.md +++ b/docs/config/lua/keyassignment/ShowDebugOverlay.md @@ -1,6 +1,6 @@ # `ShowDebugOverlay` -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} 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). diff --git a/docs/config/lua/keyassignment/ShowLauncherArgs.md b/docs/config/lua/keyassignment/ShowLauncherArgs.md index 60f0a53a8..462e8a033 100644 --- a/docs/config/lua/keyassignment/ShowLauncherArgs.md +++ b/docs/config/lua/keyassignment/ShowLauncherArgs.md @@ -1,6 +1,6 @@ # ShowLauncherArgs -*Since: 20220319-142410-0fcdea07* +{{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. @@ -25,7 +25,7 @@ an empty launcher: * `"DOMAINS"` - include multiplexing domains * `"KEY_ASSIGNMENTS"` - include items taken from your key assignments * `"WORKSPACES"` - include workspaces -* `"COMMANDS"` - include a number of default commands (*Since: 20220408-101518-b908e2dd*) +* `"COMMANDS"` - include a number of default commands {{since('20220408-101518-b908e2dd', inline=True)}} The flags can be joined together using a `|` character, so `"TABS|DOMAINS"` is an example of a set of flags that will include both tabs and domains in the diff --git a/docs/config/lua/keyassignment/SplitHorizontal.md b/docs/config/lua/keyassignment/SplitHorizontal.md index dde96a119..413e1ba3f 100644 --- a/docs/config/lua/keyassignment/SplitHorizontal.md +++ b/docs/config/lua/keyassignment/SplitHorizontal.md @@ -1,6 +1,6 @@ # SplitHorizontal -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Splits the current pane in half horizontally such that the current pane becomes the left half and the new right half spawns a new command. diff --git a/docs/config/lua/keyassignment/SplitPane.md b/docs/config/lua/keyassignment/SplitPane.md index 3d62c8985..8b3d91a81 100644 --- a/docs/config/lua/keyassignment/SplitPane.md +++ b/docs/config/lua/keyassignment/SplitPane.md @@ -1,6 +1,6 @@ # SplitPane -*Since: 20220624-141144-bd1b7c5d* +{{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/keyassignment/SplitVertical.md b/docs/config/lua/keyassignment/SplitVertical.md index 3a97a4a84..2f0661589 100644 --- a/docs/config/lua/keyassignment/SplitVertical.md +++ b/docs/config/lua/keyassignment/SplitVertical.md @@ -1,6 +1,6 @@ # SplitVertical -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Splits the current pane in half vertically such that the current pane becomes the top half and the new bottom half spawns a new command. diff --git a/docs/config/lua/keyassignment/StartWindowDrag.md b/docs/config/lua/keyassignment/StartWindowDrag.md index f14a7d055..8c57934db 100644 --- a/docs/config/lua/keyassignment/StartWindowDrag.md +++ b/docs/config/lua/keyassignment/StartWindowDrag.md @@ -1,6 +1,6 @@ # StartWindowDrag -*since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Places the window in the drag-to-move state, which means that the window will move to follow your mouse pointer until the mouse button is released. diff --git a/docs/config/lua/keyassignment/SwitchToWorkspace.md b/docs/config/lua/keyassignment/SwitchToWorkspace.md index 07d267c0f..0131edaa2 100644 --- a/docs/config/lua/keyassignment/SwitchToWorkspace.md +++ b/docs/config/lua/keyassignment/SwitchToWorkspace.md @@ -1,6 +1,6 @@ # SwitchToWorkspace -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Switch to a different workspace, creating it if it doesn't already exist. diff --git a/docs/config/lua/keyassignment/SwitchWorkspaceRelative.md b/docs/config/lua/keyassignment/SwitchWorkspaceRelative.md index 9a7fb2794..fbb676636 100644 --- a/docs/config/lua/keyassignment/SwitchWorkspaceRelative.md +++ b/docs/config/lua/keyassignment/SwitchWorkspaceRelative.md @@ -1,6 +1,6 @@ # SwitchWorkspaceRelative -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Switch to the workspace relative to the current workspace. Workspaces are ordered lexicographically based on their names. diff --git a/docs/config/lua/keyassignment/TogglePaneZoomState.md b/docs/config/lua/keyassignment/TogglePaneZoomState.md index c6cf6e27b..0eb797641 100644 --- a/docs/config/lua/keyassignment/TogglePaneZoomState.md +++ b/docs/config/lua/keyassignment/TogglePaneZoomState.md @@ -1,6 +1,6 @@ # TogglePaneZoomState -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Toggles the zoom state of the current pane. A Zoomed pane takes up all available space in the tab, hiding all other panes while it is zoomed. diff --git a/docs/config/lua/mux-events/mux-is-process-stateful.md b/docs/config/lua/mux-events/mux-is-process-stateful.md index fecfac96d..34585708c 100644 --- a/docs/config/lua/mux-events/mux-is-process-stateful.md +++ b/docs/config/lua/mux-events/mux-is-process-stateful.md @@ -1,6 +1,6 @@ # `mux-is-process-stateful` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} The `mux-is-process-stateful` event is emitted when the multiplexer layer wants to determine whether a given Pane can be closed without prompting the user. diff --git a/docs/config/lua/mux-events/mux-startup.md b/docs/config/lua/mux-events/mux-startup.md index be444b493..6dd6f6a56 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: 20220624-141144-bd1b7c5d* +{{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/mux-window/get_title.md b/docs/config/lua/mux-window/get_title.md index f6786fe88..2623ca057 100644 --- a/docs/config/lua/mux-window/get_title.md +++ b/docs/config/lua/mux-window/get_title.md @@ -1,6 +1,6 @@ ## window:get_title() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the window title as set by `OSC 0`, `OSC 2` in a contained pane, or through `window:set_title()`. diff --git a/docs/config/lua/mux-window/get_workspace.md b/docs/config/lua/mux-window/get_workspace.md index bcc7bdc43..15b310280 100644 --- a/docs/config/lua/mux-window/get_workspace.md +++ b/docs/config/lua/mux-window/get_workspace.md @@ -1,6 +1,6 @@ ## `window:get_workspace()` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Returns the name of the workspace to which the window belongs. diff --git a/docs/config/lua/mux-window/gui_window.md b/docs/config/lua/mux-window/gui_window.md index 4d137573d..ef7f9791f 100644 --- a/docs/config/lua/mux-window/gui_window.md +++ b/docs/config/lua/mux-window/gui_window.md @@ -1,6 +1,6 @@ # `window:gui_window()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Attempts to resolve this mux window to its corresponding [Gui Window](../window/index.md). diff --git a/docs/config/lua/mux-window/index.markdown b/docs/config/lua/mux-window/index.markdown index b360665b6..ec781900b 100644 --- a/docs/config/lua/mux-window/index.markdown +++ b/docs/config/lua/mux-window/index.markdown @@ -1,6 +1,6 @@ # MuxWindow -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} `MuxWindow` represents a window that is managed by the multiplexer. diff --git a/docs/config/lua/mux-window/set_title.md b/docs/config/lua/mux-window/set_title.md index f8c069fb0..cb82fbe0e 100644 --- a/docs/config/lua/mux-window/set_title.md +++ b/docs/config/lua/mux-window/set_title.md @@ -1,6 +1,6 @@ ## window:set_title(TITLE) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Sets the window title to the provided string. Note that applications may subsequently change the title via escape sequences. diff --git a/docs/config/lua/mux-window/set_workspace.md b/docs/config/lua/mux-window/set_workspace.md index 8c1f9950b..046ddbc8d 100644 --- a/docs/config/lua/mux-window/set_workspace.md +++ b/docs/config/lua/mux-window/set_workspace.md @@ -1,6 +1,6 @@ ## `window:set_workspace("something")` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Changes the name of the workspace to which the window belongs. diff --git a/docs/config/lua/mux-window/spawn_tab.md b/docs/config/lua/mux-window/spawn_tab.md index b23b75173..6ca6a0660 100644 --- a/docs/config/lua/mux-window/spawn_tab.md +++ b/docs/config/lua/mux-window/spawn_tab.md @@ -1,6 +1,6 @@ ## `window:spawn_tab{}` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Spawns a program into a new tab within this window, returning the [MuxTab](../MuxTab/index.md), [Pane](../pane/index.md) and diff --git a/docs/config/lua/mux-window/tabs.md b/docs/config/lua/mux-window/tabs.md index 6e165a196..7599df6d4 100644 --- a/docs/config/lua/mux-window/tabs.md +++ b/docs/config/lua/mux-window/tabs.md @@ -1,6 +1,6 @@ ## window:tabs() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns an array table holding each of the [MuxTab](../MuxTab/index.md) objects contained within this window. diff --git a/docs/config/lua/mux-window/tabs_with_info.md b/docs/config/lua/mux-window/tabs_with_info.md index fd0f294e3..575e75116 100644 --- a/docs/config/lua/mux-window/tabs_with_info.md +++ b/docs/config/lua/mux-window/tabs_with_info.md @@ -1,6 +1,6 @@ ## window:tabs_with_info() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns an array table holding an extended info entry for each of the tabs contained within this window. diff --git a/docs/config/lua/mux-window/window_id.md b/docs/config/lua/mux-window/window_id.md index 6b7fa1858..2f367d5ff 100644 --- a/docs/config/lua/mux-window/window_id.md +++ b/docs/config/lua/mux-window/window_id.md @@ -1,6 +1,6 @@ ## `window:window_id()` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Returns the window multiplexer id. diff --git a/docs/config/lua/pane/get_current_working_dir.md b/docs/config/lua/pane/get_current_working_dir.md index eefc4efce..c631f512b 100644 --- a/docs/config/lua/pane/get_current_working_dir.md +++ b/docs/config/lua/pane/get_current_working_dir.md @@ -1,6 +1,6 @@ # `pane:get_current_working_dir()` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Returns the current working directory of the pane, if known. The current directory can be specified by an application sending @@ -17,9 +17,9 @@ working directory using operating system dependent code: |OS |Supported? | |-------|--------------------------------------| -|macOS |Yes, *Since: 20201031-154415-9614e117*| -|Linux |Yes, *Since: 20201031-154415-9614e117*| -|Windows|Yes, *Since: 20220101-133340-7edc5b5a*| +|macOS |Yes, {{since('20201031-154415-9614e117', inline=True)}}| +|Linux |Yes, {{since('20201031-154415-9614e117', inline=True)}}| +|Windows|Yes, {{since('20220101-133340-7edc5b5a', inline=True)}}| If the current working directory is not known then this method returns `nil`. Otherwise, it returns the current working directory as a URI string. diff --git a/docs/config/lua/pane/get_cursor_position.md b/docs/config/lua/pane/get_cursor_position.md index 40fba6034..e3f051453 100644 --- a/docs/config/lua/pane/get_cursor_position.md +++ b/docs/config/lua/pane/get_cursor_position.md @@ -1,6 +1,6 @@ # `pane:get_cursor_position()` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Returns a lua representation of the `StableCursorPosition` struct that identifies the cursor position, visibility and shape. diff --git a/docs/config/lua/pane/get_dimensions.md b/docs/config/lua/pane/get_dimensions.md index bf65ea753..d05056753 100644 --- a/docs/config/lua/pane/get_dimensions.md +++ b/docs/config/lua/pane/get_dimensions.md @@ -1,6 +1,6 @@ # `pane:get_dimensions()` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Returns a lua representation of the `RenderableDimensions` struct that identifies the dimensions and position of the viewport as diff --git a/docs/config/lua/pane/get_domain_name.md b/docs/config/lua/pane/get_domain_name.md index 69aeff6e3..ea683ae7f 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: 20220624-141144-bd1b7c5d* +{{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 ba08572a8..359c1d19f 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: 20220624-141144-bd1b7c5d* +{{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/pane/get_foreground_process_name.md b/docs/config/lua/pane/get_foreground_process_name.md index 8da058be6..ff58fe499 100644 --- a/docs/config/lua/pane/get_foreground_process_name.md +++ b/docs/config/lua/pane/get_foreground_process_name.md @@ -1,6 +1,6 @@ # `pane:get_foreground_process_name()` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} Returns the path to the executable image for the pane. diff --git a/docs/config/lua/pane/get_lines_as_text.md b/docs/config/lua/pane/get_lines_as_text.md index 038083a3d..675e62dd9 100644 --- a/docs/config/lua/pane/get_lines_as_text.md +++ b/docs/config/lua/pane/get_lines_as_text.md @@ -1,6 +1,6 @@ # `pane:get_lines_as_text([nlines])` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Returns the textual representation (not including color or other attributes) of the *physical* lines of text in the viewport as a string. diff --git a/docs/config/lua/pane/get_logical_lines_as_text.md b/docs/config/lua/pane/get_logical_lines_as_text.md index 8ffbdb76b..a07375200 100644 --- a/docs/config/lua/pane/get_logical_lines_as_text.md +++ b/docs/config/lua/pane/get_logical_lines_as_text.md @@ -1,6 +1,6 @@ # `pane:get_logical_lines_as_text([nlines])` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} Returns the textual representation (not including color or other attributes) of the *logical* lines of text in the viewport as a string. diff --git a/docs/config/lua/pane/get_metadata.md b/docs/config/lua/pane/get_metadata.md index 8f7f8686c..6f4ca544e 100644 --- a/docs/config/lua/pane/get_metadata.md +++ b/docs/config/lua/pane/get_metadata.md @@ -1,6 +1,6 @@ # `pane:get_metadata()` -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} Returns metadata about a pane. The return value depends on the instance of the underlying pane. If the pane doesn't support this method, `nil` will be returned. diff --git a/docs/config/lua/pane/get_title.md b/docs/config/lua/pane/get_title.md index be99dab59..17c11780e 100644 --- a/docs/config/lua/pane/get_title.md +++ b/docs/config/lua/pane/get_title.md @@ -1,6 +1,6 @@ # `pane:get_title()` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Returns the title of the pane. This will typically be `wezterm` by default but can be modified by applications that send `OSC 1` (Icon/Tab title changing) diff --git a/docs/config/lua/pane/get_user_vars.md b/docs/config/lua/pane/get_user_vars.md index abac4d0d6..88decfd63 100644 --- a/docs/config/lua/pane/get_user_vars.md +++ b/docs/config/lua/pane/get_user_vars.md @@ -1,6 +1,6 @@ # `pane:get_user_vars()` -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Returns a table holding the user variables that have been assigned to this pane. diff --git a/docs/config/lua/pane/has_unseen_output.md b/docs/config/lua/pane/has_unseen_output.md index 905dc92d4..295254965 100644 --- 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: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Returns true if there has been output in the pane since the last time the time the pane was focused. diff --git a/docs/config/lua/pane/index.markdown b/docs/config/lua/pane/index.markdown index 907d1692d..35e3933ea 100644 --- a/docs/config/lua/pane/index.markdown +++ b/docs/config/lua/pane/index.markdown @@ -1,7 +1,7 @@ # `Pane` object --- -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} In previous releases there were separate `MuxPane` and `Pane` objects created by the mux and gui layers, respectively. This is no longer the case: there is diff --git a/docs/config/lua/pane/inject_output.md b/docs/config/lua/pane/inject_output.md index db1a95dd6..398d28fd3 100644 --- a/docs/config/lua/pane/inject_output.md +++ b/docs/config/lua/pane/inject_output.md @@ -1,6 +1,6 @@ # `pane:inject_output(text)` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} Sends text, which may include escape sequences, to the output side of the current pane. The text will be evaluated by the terminal emulator and can thus diff --git a/docs/config/lua/pane/is_alt_screen_active.md b/docs/config/lua/pane/is_alt_screen_active.md index e36020130..49492c5df 100644 --- a/docs/config/lua/pane/is_alt_screen_active.md +++ b/docs/config/lua/pane/is_alt_screen_active.md @@ -1,6 +1,6 @@ # `pane:is_alt_screen_active()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns whether the alternate screen is active for the pane. diff --git a/docs/config/lua/pane/mux_pane.md b/docs/config/lua/pane/mux_pane.md index bbb590ad6..3a19173e3 100644 --- a/docs/config/lua/pane/mux_pane.md +++ b/docs/config/lua/pane/mux_pane.md @@ -1,6 +1,6 @@ # pane:mux_pane() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} *Deprecated Since: 20221119-145034-49b9839f* diff --git a/docs/config/lua/pane/pane_id.md b/docs/config/lua/pane/pane_id.md index 7dab3434f..68900064b 100644 --- a/docs/config/lua/pane/pane_id.md +++ b/docs/config/lua/pane/pane_id.md @@ -1,6 +1,6 @@ # `pane:pane_id()` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Returns the id number for the pane. The Id is used to identify the pane within the internal multiplexer and can be used when making API calls diff --git a/docs/config/lua/pane/paste.md b/docs/config/lua/pane/paste.md index af9673e0d..d298b04b1 100644 --- a/docs/config/lua/pane/paste.md +++ b/docs/config/lua/pane/paste.md @@ -1,6 +1,6 @@ # `pane:paste(text)` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Sends the supplied `text` string to the input of the pane as if it were pasted from the clipboard, except that the clipboard is not involved. diff --git a/docs/config/lua/pane/send_paste.md b/docs/config/lua/pane/send_paste.md index 7c7a80f53..694174e8d 100644 --- a/docs/config/lua/pane/send_paste.md +++ b/docs/config/lua/pane/send_paste.md @@ -1,6 +1,6 @@ ## `pane:send_paste(text)` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Sends text to the pane as though it was pasted. If bracketed paste mode is enabled then the text will be sent as a bracketed paste. Otherwise, it will diff --git a/docs/config/lua/pane/send_text.md b/docs/config/lua/pane/send_text.md index 9152099ba..8d5f5a168 100644 --- a/docs/config/lua/pane/send_text.md +++ b/docs/config/lua/pane/send_text.md @@ -1,6 +1,6 @@ ## `pane:send_text(text)` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Sends text to the pane as-is. diff --git a/docs/config/lua/pane/split.md b/docs/config/lua/pane/split.md index ed0fbdc4a..fe22e18cb 100644 --- a/docs/config/lua/pane/split.md +++ b/docs/config/lua/pane/split.md @@ -1,6 +1,6 @@ # `pane:split{}` -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Splits `pane` and spawns a program into the split, returning the `Pane` object associated with it: diff --git a/docs/config/lua/pane/tab.md b/docs/config/lua/pane/tab.md index 15882494d..22b40aac2 100644 --- a/docs/config/lua/pane/tab.md +++ b/docs/config/lua/pane/tab.md @@ -1,6 +1,6 @@ ## `pane:tab()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the [MuxTab](../MuxTab/index.md) that contains this pane. diff --git a/docs/config/lua/pane/window.md b/docs/config/lua/pane/window.md index be6e69219..6e5185dc2 100644 --- a/docs/config/lua/pane/window.md +++ b/docs/config/lua/pane/window.md @@ -1,6 +1,6 @@ ## `pane:window()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the [MuxWindow](../mux-window/index.md) that contains the tab that contains this pane. diff --git a/docs/config/lua/wezterm.color/extract_colors_from_image.md b/docs/config/lua/wezterm.color/extract_colors_from_image.md index 1c32dee78..217559c5c 100644 --- a/docs/config/lua/wezterm.color/extract_colors_from_image.md +++ b/docs/config/lua/wezterm.color/extract_colors_from_image.md @@ -1,6 +1,6 @@ # `wezterm.color.extract_colors_from_image(filename [,params])` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This function loads an image from the specified filename and analyzes it to determine a set of distinct colors present in the image, ordered by how often a diff --git a/docs/config/lua/wezterm.color/from_hsla.md b/docs/config/lua/wezterm.color/from_hsla.md index f7beda7fa..6c6adc973 100644 --- a/docs/config/lua/wezterm.color/from_hsla.md +++ b/docs/config/lua/wezterm.color/from_hsla.md @@ -1,6 +1,6 @@ ## `wezterm.color.from_hsla(h, s, l, a)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Constructs a new [color object](../color/index.md) from values in the HSL colorspace, plus alpha. diff --git a/docs/config/lua/wezterm.color/get_builtin_schemes.md b/docs/config/lua/wezterm.color/get_builtin_schemes.md index a8801febc..c7129a89f 100644 --- a/docs/config/lua/wezterm.color/get_builtin_schemes.md +++ b/docs/config/lua/wezterm.color/get_builtin_schemes.md @@ -1,6 +1,6 @@ # `wezterm.color.get_builtin_schemes()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} (In earlier releases, you can use [wezterm.get_builtin_color_schemes()](../wezterm/get_builtin_color_schemes.md)) diff --git a/docs/config/lua/wezterm.color/get_default_colors.md b/docs/config/lua/wezterm.color/get_default_colors.md index c62ace092..5ebfbf196 100644 --- a/docs/config/lua/wezterm.color/get_default_colors.md +++ b/docs/config/lua/wezterm.color/get_default_colors.md @@ -1,6 +1,6 @@ # `wezterm.color.get_default_colors()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the set of colors that would be used by default. diff --git a/docs/config/lua/wezterm.color/gradient.md b/docs/config/lua/wezterm.color/gradient.md index 428997df2..d60f424f9 100644 --- a/docs/config/lua/wezterm.color/gradient.md +++ b/docs/config/lua/wezterm.color/gradient.md @@ -1,6 +1,6 @@ # `wezterm.color.gradient(gradient, num_colors)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Given a gradient spec and a number of colors, returns a table holding that many colors spaced evenly across the range of diff --git a/docs/config/lua/wezterm.color/index.markdown b/docs/config/lua/wezterm.color/index.markdown index 94a8b97ba..9a8831669 100644 --- a/docs/config/lua/wezterm.color/index.markdown +++ b/docs/config/lua/wezterm.color/index.markdown @@ -1,4 +1,4 @@ -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} The `wezterm.color` module exposes functions that work with colors. diff --git a/docs/config/lua/wezterm.color/load_base16_scheme.md b/docs/config/lua/wezterm.color/load_base16_scheme.md index ce5936a25..d75347fed 100644 --- a/docs/config/lua/wezterm.color/load_base16_scheme.md +++ b/docs/config/lua/wezterm.color/load_base16_scheme.md @@ -1,6 +1,6 @@ # `wezterm.color.load_base16_scheme(file_name)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Loads a yaml file in [base16](https://github.com/chriskempson/base16) format and returns it as a wezterm color scheme. diff --git a/docs/config/lua/wezterm.color/load_scheme.md b/docs/config/lua/wezterm.color/load_scheme.md index 465ecd898..99033ff06 100644 --- a/docs/config/lua/wezterm.color/load_scheme.md +++ b/docs/config/lua/wezterm.color/load_scheme.md @@ -1,6 +1,6 @@ # `wezterm.color.load_scheme(file_name)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Loads a wezterm color scheme from a TOML file. This function returns a tuple of the the color definitions and the metadata: diff --git a/docs/config/lua/wezterm.color/load_terminal_sexy_scheme.md b/docs/config/lua/wezterm.color/load_terminal_sexy_scheme.md index 2d2d8a96e..5bdd961ca 100644 --- a/docs/config/lua/wezterm.color/load_terminal_sexy_scheme.md +++ b/docs/config/lua/wezterm.color/load_terminal_sexy_scheme.md @@ -1,6 +1,6 @@ # `wezterm.color.load_terminal_sexy_scheme(file_name)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Loads a json file exported from [terminal.sexy](https://terminal.sexy/) and returns it as a wezterm color scheme. diff --git a/docs/config/lua/wezterm.color/parse.md b/docs/config/lua/wezterm.color/parse.md index ccbc6b2e5..789283353 100644 --- a/docs/config/lua/wezterm.color/parse.md +++ b/docs/config/lua/wezterm.color/parse.md @@ -1,6 +1,6 @@ # wezterm.color.parse(string) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Parses the passed color and returns a [Color object](../color/index.md). `Color` objects evaluate as strings but diff --git a/docs/config/lua/wezterm.color/save_scheme.md b/docs/config/lua/wezterm.color/save_scheme.md index 58b1f4e8f..b3f2c5c38 100644 --- a/docs/config/lua/wezterm.color/save_scheme.md +++ b/docs/config/lua/wezterm.color/save_scheme.md @@ -1,6 +1,6 @@ # `wezterm.color.save_scheme(colors, metadata, file_name)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Saves a color scheme as a wezterm TOML file. This is useful when sharing your custom color scheme with others. diff --git a/docs/config/lua/wezterm.gui/default_key_tables.md b/docs/config/lua/wezterm.gui/default_key_tables.md index 42ea9bbe9..ded5a5512 100644 --- a/docs/config/lua/wezterm.gui/default_key_tables.md +++ b/docs/config/lua/wezterm.gui/default_key_tables.md @@ -1,6 +1,6 @@ # `wezterm.gui.default_key_tables()` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} Returns a table holding the effective default set of `key_tables`. That is the set of keys that is used as a base if there was no configuration file. diff --git a/docs/config/lua/wezterm.gui/default_keys.md b/docs/config/lua/wezterm.gui/default_keys.md index b36eab0cd..0f0c301c2 100644 --- a/docs/config/lua/wezterm.gui/default_keys.md +++ b/docs/config/lua/wezterm.gui/default_keys.md @@ -1,6 +1,6 @@ # `wezterm.gui.default_keys()` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} Returns a table holding the effective default values for key assignments. That is the set of keys that is used as a base if there was no configuration file. diff --git a/docs/config/lua/wezterm.gui/enumerate_gpus.md b/docs/config/lua/wezterm.gui/enumerate_gpus.md index b5b00c3a8..c6ecedd70 100644 --- a/docs/config/lua/wezterm.gui/enumerate_gpus.md +++ b/docs/config/lua/wezterm.gui/enumerate_gpus.md @@ -1,6 +1,6 @@ # `wezterm.gui.enumerate_gpus()` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} Returns the list of available Gpus supported by WebGpu. diff --git a/docs/config/lua/wezterm.gui/get_appearance.md b/docs/config/lua/wezterm.gui/get_appearance.md index 6c60d3939..8998f77b1 100644 --- a/docs/config/lua/wezterm.gui/get_appearance.md +++ b/docs/config/lua/wezterm.gui/get_appearance.md @@ -1,6 +1,6 @@ # `wezterm.gui.get_appearance()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This function returns the appearance of the window environment. The appearance can be one of the following 4 values: diff --git a/docs/config/lua/wezterm.gui/gui_window_for_mux_window.md b/docs/config/lua/wezterm.gui/gui_window_for_mux_window.md index 78fde93d6..0df5ec92e 100644 --- a/docs/config/lua/wezterm.gui/gui_window_for_mux_window.md +++ b/docs/config/lua/wezterm.gui/gui_window_for_mux_window.md @@ -1,6 +1,6 @@ # `wezterm.gui.gui_window_for_mux_window(window_id)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Attempts to resolve a mux window to its corresponding [Gui Window](../window/index.md). diff --git a/docs/config/lua/wezterm.gui/index.markdown b/docs/config/lua/wezterm.gui/index.markdown index 72bcb4920..2f3d25012 100644 --- a/docs/config/lua/wezterm.gui/index.markdown +++ b/docs/config/lua/wezterm.gui/index.markdown @@ -1,4 +1,4 @@ -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} The `wezterm.gui` module exposes functions that operate on the gui layer. diff --git a/docs/config/lua/wezterm.gui/screens.md b/docs/config/lua/wezterm.gui/screens.md index 7bff7979f..7d19ab903 100644 --- a/docs/config/lua/wezterm.gui/screens.md +++ b/docs/config/lua/wezterm.gui/screens.md @@ -1,6 +1,6 @@ # `wezterm.gui.screens()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns information about the screens connected to the system. @@ -52,4 +52,4 @@ The screen information is a table with the following keys: * `name` - the name of the screen. * `x`, `y`, `width`, `height` - the bounds of this screen -* `max_fps` - the maximum refresh rate supported by the screen, if known, or `nil` otherwise. (*Since: 20220903-194523-3bb1ed61*) +* `max_fps` - the maximum refresh rate supported by the screen, if known, or `nil` otherwise. {{since('20220903-194523-3bb1ed61', inline=True)}} diff --git a/docs/config/lua/wezterm.mux/all_windows.md b/docs/config/lua/wezterm.mux/all_windows.md index 9cfc9fd4d..22f3cb10b 100644 --- a/docs/config/lua/wezterm.mux/all_windows.md +++ b/docs/config/lua/wezterm.mux/all_windows.md @@ -1,6 +1,6 @@ # `wezterm.mux.all_windows()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns an array table holding all of the known [MuxWindow](../mux-window/index.md) objects. diff --git a/docs/config/lua/wezterm.mux/get_active_workspace.md b/docs/config/lua/wezterm.mux/get_active_workspace.md index d772ce1ab..4285bb765 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: 20220624-141144-bd1b7c5d* +{{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 dde08fc99..d272850d4 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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Given a pane ID, verifies that the ID is a valid pane known to the mux and returns a [Pane](../pane/index.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 8f9b7d0ea..190ec21df 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: 20220624-141144-bd1b7c5d* +{{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/index.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 622033b54..b3e7aca5d 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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Given a window ID, verifies that the ID is a valid window known to the mux and returns a [MuxWindow](../mux-window/index.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 3f060518d..0cf3862e2 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: 20220624-141144-bd1b7c5d* +{{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 09392dcbf..3a8b09c15 100644 --- a/docs/config/lua/wezterm.mux/index.markdown +++ b/docs/config/lua/wezterm.mux/index.markdown @@ -1,4 +1,4 @@ -*Since: 20220624-141144-bd1b7c5d* +{{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 7045e7bc6..f2ec364c6 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: 20220624-141144-bd1b7c5d* +{{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 270965d5e..bc634f70e 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: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} Spawns a program into a new window, returning the [MuxTab](../MuxTab/index.md), [Pane](../pane/index.md) and [MuxWindow](../mux-window/index.md) objects diff --git a/docs/config/lua/wezterm.procinfo/current_working_dir_for_pid.md b/docs/config/lua/wezterm.procinfo/current_working_dir_for_pid.md index ca6e2da25..0f75473ea 100644 --- a/docs/config/lua/wezterm.procinfo/current_working_dir_for_pid.md +++ b/docs/config/lua/wezterm.procinfo/current_working_dir_for_pid.md @@ -1,6 +1,6 @@ # `wezterm.procinfo.current_working_dir_for_pid(pid)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the current working directory for the specified process id. diff --git a/docs/config/lua/wezterm.procinfo/executable_path_for_pid.md b/docs/config/lua/wezterm.procinfo/executable_path_for_pid.md index 39e4e3b0d..e059fd9d5 100644 --- a/docs/config/lua/wezterm.procinfo/executable_path_for_pid.md +++ b/docs/config/lua/wezterm.procinfo/executable_path_for_pid.md @@ -1,6 +1,6 @@ # `wezterm.procinfo.executable_path_for_pid(pid)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the path to the executable image for the specified process id. diff --git a/docs/config/lua/wezterm.procinfo/get_info_for_pid.md b/docs/config/lua/wezterm.procinfo/get_info_for_pid.md index 23131bdda..67ee0672b 100644 --- a/docs/config/lua/wezterm.procinfo/get_info_for_pid.md +++ b/docs/config/lua/wezterm.procinfo/get_info_for_pid.md @@ -1,6 +1,6 @@ # `wezterm.procinfo.get_info_for_pid(pid)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns a [LocalProcessInfo](../LocalProcessInfo.md) object for the specified process id. diff --git a/docs/config/lua/wezterm.procinfo/index.markdown b/docs/config/lua/wezterm.procinfo/index.markdown index 2b962dcea..920d55321 100644 --- a/docs/config/lua/wezterm.procinfo/index.markdown +++ b/docs/config/lua/wezterm.procinfo/index.markdown @@ -1,4 +1,4 @@ -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} The `wezterm.procinfo` module exposes functions that allow querying information about processes that are running on the local system. diff --git a/docs/config/lua/wezterm.procinfo/pid.md b/docs/config/lua/wezterm.procinfo/pid.md index b626958df..740735a8d 100644 --- a/docs/config/lua/wezterm.procinfo/pid.md +++ b/docs/config/lua/wezterm.procinfo/pid.md @@ -1,6 +1,6 @@ # `wezterm.procinfo.pid()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the process id for the current process. diff --git a/docs/config/lua/wezterm.time/Time/format.md b/docs/config/lua/wezterm.time/Time/format.md index 4e270f51d..7d9abf72d 100644 --- a/docs/config/lua/wezterm.time/Time/format.md +++ b/docs/config/lua/wezterm.time/Time/format.md @@ -1,6 +1,6 @@ # `Time:format(format)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Formats the time object as a string, using the local date/time representation of the time. diff --git a/docs/config/lua/wezterm.time/Time/format_utc.md b/docs/config/lua/wezterm.time/Time/format_utc.md index 21d4137c1..afe5b1924 100644 --- a/docs/config/lua/wezterm.time/Time/format_utc.md +++ b/docs/config/lua/wezterm.time/Time/format_utc.md @@ -1,6 +1,6 @@ # `Time:format_utc(format)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Formats the time object as a string, using UTC date/time representation of the time. diff --git a/docs/config/lua/wezterm.time/Time/sun_times.md b/docs/config/lua/wezterm.time/Time/sun_times.md index 9dbb1b195..d372fccc9 100644 --- a/docs/config/lua/wezterm.time/Time/sun_times.md +++ b/docs/config/lua/wezterm.time/Time/sun_times.md @@ -1,6 +1,6 @@ # `Time:sun_times(lat, lon)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} For the date component of the time object, compute the times of the sun rise and sun set for the given latitude and longitude. diff --git a/docs/config/lua/wezterm.time/index.markdown b/docs/config/lua/wezterm.time/index.markdown index b49a2c68b..d6d8a8969 100644 --- a/docs/config/lua/wezterm.time/index.markdown +++ b/docs/config/lua/wezterm.time/index.markdown @@ -1,4 +1,4 @@ -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} The `wezterm.time` module exposes functions that allow working with time. diff --git a/docs/config/lua/wezterm.time/now.md b/docs/config/lua/wezterm.time/now.md index f15169c22..00290a3a2 100644 --- a/docs/config/lua/wezterm.time/now.md +++ b/docs/config/lua/wezterm.time/now.md @@ -1,6 +1,6 @@ # `wezterm.time.now()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns a [Time](Time/index.md) object representing the time at which `wezterm.time.now()` was called. diff --git a/docs/config/lua/wezterm.time/parse.md b/docs/config/lua/wezterm.time/parse.md index 7360064f3..229e758ae 100644 --- a/docs/config/lua/wezterm.time/parse.md +++ b/docs/config/lua/wezterm.time/parse.md @@ -1,6 +1,6 @@ # `wezterm.time.parse(str, format)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Parses a string that is formatted according to the supplied format string: diff --git a/docs/config/lua/wezterm.time/parse_rfc3339.md b/docs/config/lua/wezterm.time/parse_rfc3339.md index 684b7fe0e..258cdf1a7 100644 --- a/docs/config/lua/wezterm.time/parse_rfc3339.md +++ b/docs/config/lua/wezterm.time/parse_rfc3339.md @@ -1,6 +1,6 @@ # `wezterm.time.parse_rfc3339(str)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Parses a string that is formatted according to [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) and returns a diff --git a/docs/config/lua/wezterm/action.md b/docs/config/lua/wezterm/action.md index b085af494..88a254a46 100644 --- a/docs/config/lua/wezterm/action.md +++ b/docs/config/lua/wezterm/action.md @@ -7,7 +7,7 @@ exist in your configuration file. ## Constructor Syntax -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} `wezterm.action` is a special enum constructor type that makes it bit more ergonomic to express the various actions than in earlier releases. diff --git a/docs/config/lua/wezterm/action_callback.md b/docs/config/lua/wezterm/action_callback.md index 547547d4b..03856f210 100644 --- a/docs/config/lua/wezterm/action_callback.md +++ b/docs/config/lua/wezterm/action_callback.md @@ -1,6 +1,6 @@ # `wezterm.action_callback(callback)` -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} This function is a helper to register a custom event and return an action triggering it. diff --git a/docs/config/lua/wezterm/add_to_config_reload_watch_list.md b/docs/config/lua/wezterm/add_to_config_reload_watch_list.md index a3d527ed5..a7eb20f79 100644 --- a/docs/config/lua/wezterm/add_to_config_reload_watch_list.md +++ b/docs/config/lua/wezterm/add_to_config_reload_watch_list.md @@ -1,12 +1,12 @@ # wezterm.add_to_config_reload_watch_list(path) -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} Adds `path` to the list of files that are watched for config changes. If [automatically_reload_config](../config/automatically_reload_config.md) is enabled, then the config will be reloaded when any of the files that have been added to the watch list have changed. -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This function is now called implicitly when you `require` a lua file. diff --git a/docs/config/lua/wezterm/background_child_process.md b/docs/config/lua/wezterm/background_child_process.md index d4d11cbc0..6174c32ab 100644 --- a/docs/config/lua/wezterm/background_child_process.md +++ b/docs/config/lua/wezterm/background_child_process.md @@ -1,6 +1,6 @@ # `wezterm.background_child_process(args)` -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} This function accepts an argument list; it will attempt to spawn that command in the background. diff --git a/docs/config/lua/wezterm/battery_info.md b/docs/config/lua/wezterm/battery_info.md index 0fd2c8754..682bad952 100644 --- a/docs/config/lua/wezterm/battery_info.md +++ b/docs/config/lua/wezterm/battery_info.md @@ -1,6 +1,6 @@ # `wezterm.battery_info()` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} This function returns battery information for each of the installed batteries on the system. This is useful for example to assemble diff --git a/docs/config/lua/wezterm/column_width.md b/docs/config/lua/wezterm/column_width.md index 953fb3af1..3d3798c60 100644 --- a/docs/config/lua/wezterm/column_width.md +++ b/docs/config/lua/wezterm/column_width.md @@ -1,6 +1,6 @@ # wezterm.column_width(string) -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Given a string parameter, returns the number of columns that that text occupies in the terminal, which is useful together with diff --git a/docs/config/lua/wezterm/config_file.md b/docs/config/lua/wezterm/config_file.md index 9a782f303..fe4118bf2 100644 --- a/docs/config/lua/wezterm/config_file.md +++ b/docs/config/lua/wezterm/config_file.md @@ -1,6 +1,6 @@ # `wezterm.config_file` -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} This constant is set to the path to the `wezterm.lua` that is in use. diff --git a/docs/config/lua/wezterm/default_wsl_domains.md b/docs/config/lua/wezterm/default_wsl_domains.md index fa800013f..5f5a562d3 100644 --- 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: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Computes a list of [WslDomain](../WslDomain.md) objects, each one representing an installed diff --git a/docs/config/lua/wezterm/emit.md b/docs/config/lua/wezterm/emit.md index f9f240fc9..421837e74 100644 --- a/docs/config/lua/wezterm/emit.md +++ b/docs/config/lua/wezterm/emit.md @@ -1,6 +1,6 @@ # `wezterm.emit(event_name, args...)` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} `wezterm.emit` resolves the registered callback(s) for the specified event name and calls each of them in turn, passing the additional diff --git a/docs/config/lua/wezterm/enumerate_ssh_hosts.md b/docs/config/lua/wezterm/enumerate_ssh_hosts.md index f39cbc84b..7ae03f6fb 100644 --- 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: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/config/lua/wezterm/font.md b/docs/config/lua/wezterm/font.md index 2d38ac018..0b3bfc0a8 100644 --- a/docs/config/lua/wezterm/font.md +++ b/docs/config/lua/wezterm/font.md @@ -114,7 +114,7 @@ return { } ``` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} You can use the expanded form mentioned above to override freetype and harfbuzz settings just for the specified font; this examples shows how to disable the @@ -136,5 +136,5 @@ The following options can be specified in the same way: * [freetype_load_target](../config/freetype_load_target.md) * [freetype_render_target](../config/freetype_render_target.md) * [freetype_load_flags](../config/freetype_load_flags.md) -* `assume_emoji_presentation = true` or `assume_emoji_presentation = false` to control whether a font is considered to have emoji (rather than text) presentation glyphs for emoji. (*Since: 20220807-113146-c2fee766*) +* `assume_emoji_presentation = true` or `assume_emoji_presentation = false` to control whether a font is considered to have emoji (rather than text) presentation glyphs for emoji. {{since('20220807-113146-c2fee766', inline=True)}} diff --git a/docs/config/lua/wezterm/font_with_fallback.md b/docs/config/lua/wezterm/font_with_fallback.md index 8fd55d295..9dd7c6a5e 100644 --- a/docs/config/lua/wezterm/font_with_fallback.md +++ b/docs/config/lua/wezterm/font_with_fallback.md @@ -20,7 +20,7 @@ The *attributes* parameter behaves the same as that of [wezterm.font](font.md) in that it allows you to specify font weight and style attributes that you want to match. -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} The attributes can now be specified per fallback font using this alternative form where the family and attributes are specified as part of the same lua table: @@ -37,7 +37,7 @@ return { } ``` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} You can use the expanded form mentioned above to override freetype and harfbuzz settings just for the specified font; this examples shows how to disable the @@ -65,7 +65,7 @@ The following options can be specified in the same way: * [freetype_load_target](../config/freetype_load_target.md) * [freetype_render_target](../config/freetype_render_target.md) * [freetype_load_flags](../config/freetype_load_flags.md) -* `assume_emoji_presentation = true` or `assume_emoji_presentation = false` to control whether a font is considered to have emoji (rather than text) presentation glyphs for emoji. (*Since: 20220807-113146-c2fee766*) +* `assume_emoji_presentation = true` or `assume_emoji_presentation = false` to control whether a font is considered to have emoji (rather than text) presentation glyphs for emoji. {{since('20220807-113146-c2fee766', inline=True)}} ## Dealing with different fallback font heights @@ -85,7 +85,7 @@ glyph(s)). ### Manual fallback scaling -*Since: 20220408-101518-b908e2dd* +{{since('20220408-101518-b908e2dd')}} CJK fonts typically won't have a useful *cap-height* metric so it may be desirable to manually configure the fallback scaling factor to boost the size diff --git a/docs/config/lua/wezterm/format.md b/docs/config/lua/wezterm/format.md index aeb7d4b27..605dc2605 100644 --- a/docs/config/lua/wezterm/format.md +++ b/docs/config/lua/wezterm/format.md @@ -1,6 +1,6 @@ # `wezterm.format({})` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} `wezterm.format` can be used to produce a formatted string with terminal graphic attributes such as bold, italic and colors. @@ -48,7 +48,7 @@ Possible values for the `FormatItem` elements are: * `{Foreground={Color="yellow"}}` - set foreground color to a named color or rgb value like `#ffffff`. * `{Background={AnsiColor="Black"}}` - set the background color to an ansi color as per `Foreground` above. * `{Background={Color="blue"}}` - set the background color to a named color or rgb value as per `Foreground` above. -* `"ResetAttributes"` - reset all attributes to default. (*Since: 20220807-113146-c2fee766*) +* `"ResetAttributes"` - reset all attributes to default. {{since('20220807-113146-c2fee766', inline=True)}} This example shows how to use arbitrary escape sequences to change the underline color: diff --git a/docs/config/lua/wezterm/get_builtin_color_schemes.md b/docs/config/lua/wezterm/get_builtin_color_schemes.md index dea3a621c..36991f893 100644 --- a/docs/config/lua/wezterm/get_builtin_color_schemes.md +++ b/docs/config/lua/wezterm/get_builtin_color_schemes.md @@ -1,6 +1,6 @@ # `wezterm.get_builtin_color_schemes()` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} Returns a lua table keyed by color scheme name and whose values are the color scheme definition of the builtin color schemes. @@ -103,7 +103,7 @@ end) return {} ``` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This function moved to [wezterm.color.get_builtin_schemes()](../wezterm.color/get_builtin_schemes.md) diff --git a/docs/config/lua/wezterm/glob.md b/docs/config/lua/wezterm/glob.md index 7be44135d..2a24f73b4 100644 --- a/docs/config/lua/wezterm/glob.md +++ b/docs/config/lua/wezterm/glob.md @@ -1,6 +1,6 @@ # `wezterm.glob(pattern [, relative_to])` -*Since: 20200503-171512-b13ef15f* +{{since('20200503-171512-b13ef15f')}} This function evalutes the glob `pattern` and returns an array containing the absolute file names of the matching results. Due to limitations in the lua diff --git a/docs/config/lua/wezterm/gradient_colors.md b/docs/config/lua/wezterm/gradient_colors.md index d56e353d8..4f627bd12 100644 --- a/docs/config/lua/wezterm/gradient_colors.md +++ b/docs/config/lua/wezterm/gradient_colors.md @@ -1,6 +1,6 @@ # wezterm.gradient_colors(gradient, num_colors) -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} Given a gradient spec and a number of colors, returns a table holding that many colors spaced evenly across the range of @@ -20,7 +20,7 @@ This example is what you'd see if you opened up the [debug overlay](../keyassign ["#6e40aa", "#ff8c38", "#5dea8d", "#6e40aa"] ``` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This function has moved to [wezterm.color.gradient](../wezterm.color/gradient.md) and that name diff --git a/docs/config/lua/wezterm/json_encode.md b/docs/config/lua/wezterm/json_encode.md index 8755bf24d..7fe7e7f24 100644 --- a/docs/config/lua/wezterm/json_encode.md +++ b/docs/config/lua/wezterm/json_encode.md @@ -1,6 +1,6 @@ # `wezterm.json_encode(value)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Encodes the supplied lua value as json: diff --git a/docs/config/lua/wezterm/json_parse.md b/docs/config/lua/wezterm/json_parse.md index d8bb8482b..3e71dd07a 100644 --- a/docs/config/lua/wezterm/json_parse.md +++ b/docs/config/lua/wezterm/json_parse.md @@ -1,6 +1,6 @@ # `wezterm.json_parse(string)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Parses the supplied string as json and returns the equivalent lua values: diff --git a/docs/config/lua/wezterm/log_error.md b/docs/config/lua/wezterm/log_error.md index 2ca20d5aa..163932584 100644 --- a/docs/config/lua/wezterm/log_error.md +++ b/docs/config/lua/wezterm/log_error.md @@ -10,7 +10,7 @@ local wezterm = require 'wezterm' wezterm.log_error 'Hello!' ``` -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} Now accepts multiple arguments, and those arguments can be of any type. diff --git a/docs/config/lua/wezterm/log_info.md b/docs/config/lua/wezterm/log_info.md index b8b5ff2f8..6b9d477c1 100644 --- a/docs/config/lua/wezterm/log_info.md +++ b/docs/config/lua/wezterm/log_info.md @@ -1,6 +1,6 @@ # `wezterm.log_info(arg, ..)` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} This function logs the provided message string through wezterm's logging layer at 'INFO' level. If you started wezterm from a terminal that text will print @@ -12,7 +12,7 @@ local wezterm = require 'wezterm' wezterm.log_info 'Hello!' ``` -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} Now accepts multiple arguments, and those arguments can be of any type. diff --git a/docs/config/lua/wezterm/log_warn.md b/docs/config/lua/wezterm/log_warn.md index 79ebd28ad..fe36a1837 100644 --- a/docs/config/lua/wezterm/log_warn.md +++ b/docs/config/lua/wezterm/log_warn.md @@ -1,6 +1,6 @@ # `wezterm.log_warn(arg, ..)` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} This function logs the provided message string through wezterm's logging layer at 'WARN' level. If you started wezterm from a terminal that text will print @@ -12,7 +12,7 @@ local wezterm = require 'wezterm' wezterm.log_warn 'Hello!' ``` -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} Now accepts multiple arguments, and those arguments can be of any type. diff --git a/docs/config/lua/wezterm/nerdfonts.md b/docs/config/lua/wezterm/nerdfonts.md index c3e438e18..e0e53b3f6 100644 --- a/docs/config/lua/wezterm/nerdfonts.md +++ b/docs/config/lua/wezterm/nerdfonts.md @@ -1,6 +1,6 @@ # `wezterm.nerdfonts` -*Since: 20220319-142410-0fcdea07* +{{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) diff --git a/docs/config/lua/wezterm/on.md b/docs/config/lua/wezterm/on.md index 2b51bf43f..a38c11e16 100644 --- a/docs/config/lua/wezterm/on.md +++ b/docs/config/lua/wezterm/on.md @@ -1,6 +1,6 @@ # `wezterm.on(event_name, callback)` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} This function follows the html/javascript naming for defining event handlers. diff --git a/docs/config/lua/wezterm/open_with.md b/docs/config/lua/wezterm/open_with.md index 82f0d38cb..1443fa0c3 100644 --- a/docs/config/lua/wezterm/open_with.md +++ b/docs/config/lua/wezterm/open_with.md @@ -1,6 +1,6 @@ # `wezterm.open_with(path_or_url [, application])` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} This function opens the specified `path_or_url` with either the specified `application` or uses the default application if `application` was not passed diff --git a/docs/config/lua/wezterm/pad_left.md b/docs/config/lua/wezterm/pad_left.md index 8357708cb..c24fa8598 100644 --- a/docs/config/lua/wezterm/pad_left.md +++ b/docs/config/lua/wezterm/pad_left.md @@ -1,6 +1,6 @@ # wezterm.pad_left(string, min_width) -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Returns a copy of `string` that is at least `min_width` columns (as measured by [wezterm.column_width](column_width.md)). diff --git a/docs/config/lua/wezterm/pad_right.md b/docs/config/lua/wezterm/pad_right.md index 98112a0e7..9d2e60fc1 100644 --- a/docs/config/lua/wezterm/pad_right.md +++ b/docs/config/lua/wezterm/pad_right.md @@ -1,6 +1,6 @@ # wezterm.pad_right(string, min_width) -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Returns a copy of `string` that is at least `min_width` columns (as measured by [wezterm.column_width](column_width.md)). diff --git a/docs/config/lua/wezterm/permute_any_mods.md b/docs/config/lua/wezterm/permute_any_mods.md index f0e030fa9..6050d38de 100644 --- a/docs/config/lua/wezterm/permute_any_mods.md +++ b/docs/config/lua/wezterm/permute_any_mods.md @@ -1,6 +1,6 @@ # `wezterm.permute_any_mods(table)` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} This function is intended to help with generating key or mouse binding entries that should apply regardless of the combination of modifier keys diff --git a/docs/config/lua/wezterm/permute_any_or_no_mods.md b/docs/config/lua/wezterm/permute_any_or_no_mods.md index 62b04367f..7e40b1068 100644 --- a/docs/config/lua/wezterm/permute_any_or_no_mods.md +++ b/docs/config/lua/wezterm/permute_any_or_no_mods.md @@ -1,6 +1,6 @@ # `wezterm.permute_any_or_no_mods(table)` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} This function is intended to help with generating key or mouse binding entries that should apply regardless of the combination of modifier keys diff --git a/docs/config/lua/wezterm/read_dir.md b/docs/config/lua/wezterm/read_dir.md index 92daa132a..bd3b199f8 100644 --- a/docs/config/lua/wezterm/read_dir.md +++ b/docs/config/lua/wezterm/read_dir.md @@ -1,6 +1,6 @@ # `wezterm.read_dir(path)` -*Since: 20200503-171512-b13ef15f* +{{since('20200503-171512-b13ef15f')}} This function returns an array containing the absolute file names of the directory specified. Due to limitations in the lua bindings, all of the paths diff --git a/docs/config/lua/wezterm/reload_configuration.md b/docs/config/lua/wezterm/reload_configuration.md index 1cd9d29ee..c9cbd1a60 100644 --- a/docs/config/lua/wezterm/reload_configuration.md +++ b/docs/config/lua/wezterm/reload_configuration.md @@ -1,6 +1,6 @@ # `wezterm.reload_configuration()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Immediately causes the configuration to be reloaded and re-applied. diff --git a/docs/config/lua/wezterm/run_child_process.md b/docs/config/lua/wezterm/run_child_process.md index 4054b4ee2..bc6c15cd9 100644 --- a/docs/config/lua/wezterm/run_child_process.md +++ b/docs/config/lua/wezterm/run_child_process.md @@ -1,6 +1,6 @@ # `wezterm.run_child_process(args)` -*Since: 20200503-171512-b13ef15f* +{{since('20200503-171512-b13ef15f')}} This function accepts an argument list; it will attempt to spawn that command and will return a tuple consisting of the boolean success of the invocation, diff --git a/docs/config/lua/wezterm/shell_join_args.md b/docs/config/lua/wezterm/shell_join_args.md index 173cbf334..d161816c1 100644 --- a/docs/config/lua/wezterm/shell_join_args.md +++ b/docs/config/lua/wezterm/shell_join_args.md @@ -1,6 +1,6 @@ # wezterm.shell_join_args({"foo", "bar"}) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} `wezterm.shell_join_args` joins together its array arguments by applying posix style shell quoting on each argument and then adding a space. diff --git a/docs/config/lua/wezterm/shell_quote_arg.md b/docs/config/lua/wezterm/shell_quote_arg.md index 4411e1506..e0db209b5 100644 --- a/docs/config/lua/wezterm/shell_quote_arg.md +++ b/docs/config/lua/wezterm/shell_quote_arg.md @@ -1,6 +1,6 @@ # wezterm.shell_quote_arg(string) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Quotes its single argument using posix shell quoting rules. diff --git a/docs/config/lua/wezterm/shell_split.md b/docs/config/lua/wezterm/shell_split.md index fec9cf36d..e347fe8f8 100644 --- a/docs/config/lua/wezterm/shell_split.md +++ b/docs/config/lua/wezterm/shell_split.md @@ -1,6 +1,6 @@ # wezterm.shell_split(line) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Splits a command line into an argument array according to posix shell rules. diff --git a/docs/config/lua/wezterm/sleep_ms.md b/docs/config/lua/wezterm/sleep_ms.md index f7b9bbd16..642771caf 100644 --- a/docs/config/lua/wezterm/sleep_ms.md +++ b/docs/config/lua/wezterm/sleep_ms.md @@ -1,6 +1,6 @@ # `wezterm.sleep_ms(milliseconds)` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} `wezterm.sleep_ms` suspends execution of the script for the specified number of milliseconds. After that time period has elapsed, the script diff --git a/docs/config/lua/wezterm/split_by_newlines.md b/docs/config/lua/wezterm/split_by_newlines.md index 9e7b434b3..0dd718cda 100644 --- a/docs/config/lua/wezterm/split_by_newlines.md +++ b/docs/config/lua/wezterm/split_by_newlines.md @@ -1,6 +1,6 @@ # `wezterm.split_by_newlines(str)` -*Since: 20200503-171512-b13ef15f* +{{since('20200503-171512-b13ef15f')}} This function takes the input string and splits it by newlines (both `\n` and `\r\n` are recognized as newlines) and returns the result as an array of strings that diff --git a/docs/config/lua/wezterm/strftime.md b/docs/config/lua/wezterm/strftime.md index 2bc975336..919d32938 100644 --- a/docs/config/lua/wezterm/strftime.md +++ b/docs/config/lua/wezterm/strftime.md @@ -1,6 +1,6 @@ # `wezterm.strftime(format)` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Formats the current local 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/lua/wezterm/strftime_utc.md b/docs/config/lua/wezterm/strftime_utc.md index 6504bd106..56fe244c0 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: 20220624-141144-bd1b7c5d* +{{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/lua/wezterm/truncate_left.md b/docs/config/lua/wezterm/truncate_left.md index 8960074b1..4aa76c698 100644 --- a/docs/config/lua/wezterm/truncate_left.md +++ b/docs/config/lua/wezterm/truncate_left.md @@ -1,6 +1,6 @@ # wezterm.truncate_left(string, max_width) -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Returns a copy of `string` that is no longer than `max_width` columns (as measured by [wezterm.column_width](column_width.md)). diff --git a/docs/config/lua/wezterm/truncate_right.md b/docs/config/lua/wezterm/truncate_right.md index 18684b935..6ee0822fe 100644 --- a/docs/config/lua/wezterm/truncate_right.md +++ b/docs/config/lua/wezterm/truncate_right.md @@ -1,6 +1,6 @@ # wezterm.truncate_right(string, max_width) -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} Returns a copy of `string` that is no longer than `max_width` columns (as measured by [wezterm.column_width](column_width.md)). diff --git a/docs/config/lua/wezterm/utf16_to_utf8.md b/docs/config/lua/wezterm/utf16_to_utf8.md index 21400e672..5ab6a977a 100644 --- a/docs/config/lua/wezterm/utf16_to_utf8.md +++ b/docs/config/lua/wezterm/utf16_to_utf8.md @@ -1,6 +1,6 @@ # `wezterm.utf16_to_utf8(str)` -*Since: 20200503-171512-b13ef15f* +{{since('20200503-171512-b13ef15f')}} This function is overly specific and exists primarily to workaround [this wsl.exe issue](https://github.com/microsoft/WSL/issues/4456). diff --git a/docs/config/lua/window-events/bell.md b/docs/config/lua/window-events/bell.md index 5f4269c94..074d30837 100644 --- a/docs/config/lua/window-events/bell.md +++ b/docs/config/lua/window-events/bell.md @@ -1,6 +1,6 @@ # `bell` -*Since: 20211204-082213-a66c61ee9* +{{since('20211204-082213-a66c61ee9')}} The `bell` event is emitted when the ASCII BEL sequence is emitted to a pane in the window. diff --git a/docs/config/lua/window-events/format-tab-title.md b/docs/config/lua/window-events/format-tab-title.md index 0e4800642..b9cd3399d 100644 --- a/docs/config/lua/window-events/format-tab-title.md +++ b/docs/config/lua/window-events/format-tab-title.md @@ -1,6 +1,6 @@ # `format-tab-title` -*Since: 20210502-130208-bff6815d* +{{since('20210502-130208-bff6815d')}} The `format-tab-title` event is emitted when the text for a tab title needs to be recomputed. diff --git a/docs/config/lua/window-events/format-window-title.md b/docs/config/lua/window-events/format-window-title.md index ee663e86c..f13e1ac5d 100644 --- a/docs/config/lua/window-events/format-window-title.md +++ b/docs/config/lua/window-events/format-window-title.md @@ -1,6 +1,6 @@ # `format-window-title` -*Since: 20210502-154244-3f7122cb* +{{since('20210502-154244-3f7122cb')}} The `format-window-title` event is emitted when the text for the window title needs to be recomputed. diff --git a/docs/config/lua/window-events/update-right-status.md b/docs/config/lua/window-events/update-right-status.md index 0edb1be11..52ed4991b 100644 --- a/docs/config/lua/window-events/update-right-status.md +++ b/docs/config/lua/window-events/update-right-status.md @@ -1,6 +1,6 @@ # `update-right-status` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} The `update-right-status` event is emitted periodically (based on the interval specified by the [status_update_interval](../config/status_update_interval.md) @@ -22,7 +22,7 @@ if the hook takes longer than the `wezterm` won't schedule another call until `status_update_interval` milliseconds have elapsed since the last call completed. -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} This event is considered to be deprecated and you should migrate to using [update-status](update-status.md), which behaves the diff --git a/docs/config/lua/window-events/update-status.md b/docs/config/lua/window-events/update-status.md index 69c32422c..205780a7d 100644 --- a/docs/config/lua/window-events/update-status.md +++ b/docs/config/lua/window-events/update-status.md @@ -1,6 +1,6 @@ # `update-status` -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} The `update-status` event is emitted periodically (based on the interval specified by the [status_update_interval](../config/status_update_interval.md) diff --git a/docs/config/lua/window-events/user-var-changed.md b/docs/config/lua/window-events/user-var-changed.md index fddde61b0..a7b23933f 100644 --- a/docs/config/lua/window-events/user-var-changed.md +++ b/docs/config/lua/window-events/user-var-changed.md @@ -1,6 +1,6 @@ # `user-var-changed` -*Since: 20220903-194523-3bb1ed61* +{{since('20220903-194523-3bb1ed61')}} The `user-var-changed` event is emitted when a *user var* escape sequence is used to set a user var. diff --git a/docs/config/lua/window-events/window-config-reloaded.md b/docs/config/lua/window-events/window-config-reloaded.md index 924473cde..9c3cacf6b 100644 --- a/docs/config/lua/window-events/window-config-reloaded.md +++ b/docs/config/lua/window-events/window-config-reloaded.md @@ -1,6 +1,6 @@ # `window-config-reloaded` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} The `window-config-reloaded` event is emitted when the configuration for a window has been reloaded. This can occur when the configuration file is diff --git a/docs/config/lua/window-events/window-focus-changed.md b/docs/config/lua/window-events/window-focus-changed.md index fb20e492c..c5bfe4268 100644 --- a/docs/config/lua/window-events/window-focus-changed.md +++ b/docs/config/lua/window-events/window-focus-changed.md @@ -1,6 +1,6 @@ # `window-focus-changed` -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} The `window-focus-changed` event is emitted when the focus state for a window is changed. diff --git a/docs/config/lua/window-events/window-resized.md b/docs/config/lua/window-events/window-resized.md index b750f3843..b13e3eb3e 100644 --- a/docs/config/lua/window-events/window-resized.md +++ b/docs/config/lua/window-events/window-resized.md @@ -1,6 +1,6 @@ # `window-resized` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} The `window-resized` event is emitted when the window is resized and when transitioning between full-screen and regular windowed mode. diff --git a/docs/config/lua/window/active_key_table.md b/docs/config/lua/window/active_key_table.md index c534a725b..ba7d0c060 100644 --- a/docs/config/lua/window/active_key_table.md +++ b/docs/config/lua/window/active_key_table.md @@ -1,6 +1,6 @@ # window:active_key_table() -*Since: 20220408-101518-b908e2dd* +{{since('20220408-101518-b908e2dd')}} Returns a string holding the top of the current key table activation stack, or `nil` if the stack is empty. diff --git a/docs/config/lua/window/active_workspace.md b/docs/config/lua/window/active_workspace.md index 944fccb01..13acd5815 100644 --- a/docs/config/lua/window/active_workspace.md +++ b/docs/config/lua/window/active_workspace.md @@ -1,6 +1,6 @@ # window:active_workspace() -*Since: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Returns the name of the active workspace. diff --git a/docs/config/lua/window/composition_status.md b/docs/config/lua/window/composition_status.md index 70f20e9b1..50ebc79bd 100644 --- a/docs/config/lua/window/composition_status.md +++ b/docs/config/lua/window/composition_status.md @@ -1,6 +1,6 @@ # window:composition_status() -*Since: 20220319-142410-0fcdea07* +{{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. diff --git a/docs/config/lua/window/copy_to_clipboard.md b/docs/config/lua/window/copy_to_clipboard.md index da6161afe..20eb84f2b 100644 --- a/docs/config/lua/window/copy_to_clipboard.md +++ b/docs/config/lua/window/copy_to_clipboard.md @@ -1,6 +1,6 @@ # window:copy_to_clipboard(text \[,clipboard\]) -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Puts `text` into the specified `clipboard`. diff --git a/docs/config/lua/window/current_event.md b/docs/config/lua/window/current_event.md index 9a50ee1ee..bcdab9a26 100644 --- a/docs/config/lua/window/current_event.md +++ b/docs/config/lua/window/current_event.md @@ -1,6 +1,6 @@ # `window:current_event()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the current event. For now only implemented for mouse events. diff --git a/docs/config/lua/window/effective_config.md b/docs/config/lua/window/effective_config.md index 9fdbcf446..3ea215a2b 100644 --- a/docs/config/lua/window/effective_config.md +++ b/docs/config/lua/window/effective_config.md @@ -1,6 +1,6 @@ # `window:effective_config()` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Returns a lua table representing the effective configuration for the Window. The table is in the same format as that used to specify the config in diff --git a/docs/config/lua/window/get_appearance.md b/docs/config/lua/window/get_appearance.md index 602df88d5..8a58598b8 100644 --- a/docs/config/lua/window/get_appearance.md +++ b/docs/config/lua/window/get_appearance.md @@ -2,7 +2,7 @@ **NOTE: You probably want to use [wezterm.gui.get_appearance()](../wezterm.gui/get_appearance.md) instead, as it is easier to use!** -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} This method returns the appearance of the window environment. The appearance can be one of the following 4 values: @@ -45,7 +45,7 @@ return {} ### Wayland GNOME Appearance -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} wezterm uses [XDG Desktop Portal](https://flatpak.github.io/xdg-desktop-portal/) to determine the diff --git a/docs/config/lua/window/get_config_overrides.md b/docs/config/lua/window/get_config_overrides.md index 16d08a7e2..38ab7eb8c 100644 --- a/docs/config/lua/window/get_config_overrides.md +++ b/docs/config/lua/window/get_config_overrides.md @@ -1,6 +1,6 @@ # `window:get_config_overrides()` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Returns a copy of the current set of configuration overrides that is in effect for the window. diff --git a/docs/config/lua/window/get_dimensions.md b/docs/config/lua/window/get_dimensions.md index 84a308541..738c6e557 100644 --- a/docs/config/lua/window/get_dimensions.md +++ b/docs/config/lua/window/get_dimensions.md @@ -1,6 +1,6 @@ # `window:get_dimensions()` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Returns a Lua table representing the dimensions for the Window. diff --git a/docs/config/lua/window/get_selection_escapes_for_pane.md b/docs/config/lua/window/get_selection_escapes_for_pane.md index 8f3581f17..57bb54bc7 100644 --- a/docs/config/lua/window/get_selection_escapes_for_pane.md +++ b/docs/config/lua/window/get_selection_escapes_for_pane.md @@ -1,6 +1,6 @@ # `window:get_selection_escapes_for_pane(pane)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the text that is currently selected within the specified pane within the specified window formatted with the escape sequences necessary to reproduce diff --git a/docs/config/lua/window/get_selection_text_for_pane.md b/docs/config/lua/window/get_selection_text_for_pane.md index 90a95e5d8..92089e1da 100644 --- a/docs/config/lua/window/get_selection_text_for_pane.md +++ b/docs/config/lua/window/get_selection_text_for_pane.md @@ -1,6 +1,6 @@ # `window:get_selection_text_for_pane(pane)` -*Since: 20210404-112810-b63a949d* +{{since('20210404-112810-b63a949d')}} Returns the text that is currently selected within the specified pane within the specified window. This is the same text that would be copied to the diff --git a/docs/config/lua/window/is_focused.md b/docs/config/lua/window/is_focused.md index 47ef47d5d..9de6873a1 100644 --- a/docs/config/lua/window/is_focused.md +++ b/docs/config/lua/window/is_focused.md @@ -1,6 +1,6 @@ # wezterm:is_focused() -*Since: 20221119-145034-49b9839f* +{{since('20221119-145034-49b9839f')}} Returns `true` if the window has focus. diff --git a/docs/config/lua/window/leader_is_active.md b/docs/config/lua/window/leader_is_active.md index 090078c92..110723bf1 100644 --- 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: 20220319-142410-0fcdea07* +{{since('20220319-142410-0fcdea07')}} Returns `true` if the [Leader Key](../../keys.md) is active in the window, or false otherwise. diff --git a/docs/config/lua/window/maximize.md b/docs/config/lua/window/maximize.md index bb117a6b5..f833e7ce3 100644 --- a/docs/config/lua/window/maximize.md +++ b/docs/config/lua/window/maximize.md @@ -1,6 +1,6 @@ # `window:maximize()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Puts the window into the maximized state. diff --git a/docs/config/lua/window/mux_window.md b/docs/config/lua/window/mux_window.md index 264330229..21ed7d330 100644 --- a/docs/config/lua/window/mux_window.md +++ b/docs/config/lua/window/mux_window.md @@ -1,6 +1,6 @@ # window:mux_window() -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Returns the [MuxWindow](../mux-window/index.md) representation of this window. diff --git a/docs/config/lua/window/perform_action.md b/docs/config/lua/window/perform_action.md index e09964a5c..e9bf7c53a 100644 --- a/docs/config/lua/window/perform_action.md +++ b/docs/config/lua/window/perform_action.md @@ -1,6 +1,6 @@ # `window:perform_action(key_assignment, pane)` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Performs a key assignment against the `window` and `pane`. There are a number of actions that can be performed against a `pane` in diff --git a/docs/config/lua/window/restore.md b/docs/config/lua/window/restore.md index a1afb5ac1..8dda7bf2d 100644 --- a/docs/config/lua/window/restore.md +++ b/docs/config/lua/window/restore.md @@ -1,6 +1,6 @@ # `window:restore()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Restores the window from the maximized state. diff --git a/docs/config/lua/window/set_config_overrides.md b/docs/config/lua/window/set_config_overrides.md index bdb670ab2..4ac178d76 100644 --- a/docs/config/lua/window/set_config_overrides.md +++ b/docs/config/lua/window/set_config_overrides.md @@ -1,6 +1,6 @@ # `window:set_config_overrides(overrides)` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} Changes the set of configuration overrides for the window. The config file is re-evaluated and any CLI overrides are diff --git a/docs/config/lua/window/set_inner_size.md b/docs/config/lua/window/set_inner_size.md index 0617a4761..8737a6347 100644 --- a/docs/config/lua/window/set_inner_size.md +++ b/docs/config/lua/window/set_inner_size.md @@ -1,6 +1,6 @@ # `window:set_inner_size(width, height)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Resizes the inner portion of the window (excluding any window decorations) to the specified width and height. diff --git a/docs/config/lua/window/set_left_status.md b/docs/config/lua/window/set_left_status.md index fcba8e85a..e26b62176 100644 --- a/docs/config/lua/window/set_left_status.md +++ b/docs/config/lua/window/set_left_status.md @@ -1,6 +1,6 @@ # `window:set_left_status(string)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This method can be used to change the content that is displayed in the tab bar, to the left of the tabs. The content is displayed diff --git a/docs/config/lua/window/set_position.md b/docs/config/lua/window/set_position.md index 01eadf249..a743a7e95 100644 --- a/docs/config/lua/window/set_position.md +++ b/docs/config/lua/window/set_position.md @@ -1,6 +1,6 @@ # `window:set_position(x, y)` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Repositions the top-left corner of the window to the specified `x`, `y` coordinates. diff --git a/docs/config/lua/window/set_right_status.md b/docs/config/lua/window/set_right_status.md index 1cab62d0a..a77ca8159 100644 --- a/docs/config/lua/window/set_right_status.md +++ b/docs/config/lua/window/set_right_status.md @@ -1,6 +1,6 @@ # `window:set_right_status(string)` -*Since: 20210314-114017-04b7cedd* +{{since('20210314-114017-04b7cedd')}} This method can be used to change the content that is displayed in the tab bar, to the right of the tabs and new tab button. The content is displayed diff --git a/docs/config/lua/window/toast_notification.md b/docs/config/lua/window/toast_notification.md index d9dda44e2..34d042849 100644 --- a/docs/config/lua/window/toast_notification.md +++ b/docs/config/lua/window/toast_notification.md @@ -1,6 +1,6 @@ # `window:toast_notification(title, message, [url, [timeout_milliseconds]])` -*Since: 20210502-154244-3f7122cb* +{{since('20210502-154244-3f7122cb')}} Generates a desktop "toast notification" with the specified *title* and *message*. diff --git a/docs/config/lua/window/toggle_fullscreen.md b/docs/config/lua/window/toggle_fullscreen.md index e2aaf28d1..fd5dc0a25 100644 --- a/docs/config/lua/window/toggle_fullscreen.md +++ b/docs/config/lua/window/toggle_fullscreen.md @@ -1,6 +1,6 @@ # `window:toggle_fullscreen()` -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} Toggles full screen mode for the window. diff --git a/docs/config/lua/window/window_id.md b/docs/config/lua/window/window_id.md index 9e8cc3668..4bb6c11b6 100644 --- a/docs/config/lua/window/window_id.md +++ b/docs/config/lua/window/window_id.md @@ -1,6 +1,6 @@ # `window:window_id()` -*Since: 20201031-154415-9614e117* +{{since('20201031-154415-9614e117')}} Returns the id number for the window. The Id is used to identify the window within the internal multiplexer and can be used when making API calls diff --git a/docs/config/mouse.md b/docs/config/mouse.md index da86993eb..0f823482b 100644 --- a/docs/config/mouse.md +++ b/docs/config/mouse.md @@ -40,16 +40,16 @@ local act = wezterm.action | Double Left Down | `NONE` | `act.SelectTextAtMouseCursor("Word")` | | Single Left Down | `NONE` | `act.SelectTextAtMouseCursor("Cell")` | | Single Left Down | `SHIFT` | `act.ExtendSelectionToMouseCursor("Cell")` | -| Single Left Down | `ALT` | `act.SelectTextAtMouseCursor("Block")` (*since: 20220624-141144-bd1b7c5d*) | +| Single Left Down | `ALT` | `act.SelectTextAtMouseCursor("Block")` {{since('20220624-141144-bd1b7c5d', inline=True)}} | | Single Left Up | `SHIFT` | `act.CompleteSelectionOrOpenLinkAtMouseCursor("ClipboardAndPrimarySelection")` | | Single Left Up | `NONE` | `act.CompleteSelectionOrOpenLinkAtMouseCursor("ClipboardAndPrimarySelection")` | -| Single Left Up | `ALT` | `act.CompleteSelection("ClipboardAndPrimarySelection")` (*since: 20220624-141144-bd1b7c5d*) | +| Single Left Up | `ALT` | `act.CompleteSelection("ClipboardAndPrimarySelection")` {{since('20220624-141144-bd1b7c5d', inline=True)}} | | Double Left Up | `NONE` | `act.CompleteSelection("ClipboardAndPrimarySelection")` | | Triple Left Up | `NONE` | `act.CompleteSelection("ClipboardAndPrimarySelection")` | | Single Left Drag | `NONE` | `act.ExtendSelectionToMouseCursor("Cell")` | -| Single Left Drag | `ALT` | `act.ExtendSelectionToMouseCursor("Block")` (*since: 20220624-141144-bd1b7c5d*) | -| Single Left Down | `ALT+SHIFT` | `act.ExtendSelectionToMouseCursor("Block")` (*since: 20220624-141144-bd1b7c5d*) | -| Single Left Up | `ALT+SHIFT` | `act.CompleteSelection("ClipboardAndPrimarySelection")` (*since: 20220624-141144-bd1b7c5d*) | +| Single Left Drag | `ALT` | `act.ExtendSelectionToMouseCursor("Block")` {{since('20220624-141144-bd1b7c5d', inline=True)}} | +| Single Left Down | `ALT+SHIFT` | `act.ExtendSelectionToMouseCursor("Block")` {{since('20220624-141144-bd1b7c5d', inline=True)}} | +| Single Left Up | `ALT+SHIFT` | `act.CompleteSelection("ClipboardAndPrimarySelection")` {{since('20220624-141144-bd1b7c5d', inline=True)}} | | Double Left Drag | `NONE` | `act.ExtendSelectionToMouseCursor("Word")` | | Triple Left Drag | `NONE` | `act.ExtendSelectionToMouseCursor("Line")` | | Single Middle Down | `NONE` | `act.PasteFrom("PrimarySelection")` | @@ -66,7 +66,7 @@ config.disable_default_mouse_bindings = true ## Configuring Mouse Assignments -*since: 20200607-144723-74889cd4* +{{since('20200607-144723-74889cd4')}} You can define mouse actions using the `mouse_bindings` configuration section: @@ -118,14 +118,14 @@ Each entry in the mouse binding table can have the following fields: pane from receiving that mouse event. You can, of course, define these and still send your mouse event to the pane by holding down the configured [mouse reporting bypass modifier - key](lua/config/bypass_mouse_reporting_modifiers.md). (*Since: 20220807-113146-c2fee766*) + key](lua/config/bypass_mouse_reporting_modifiers.md). {{since('20220807-113146-c2fee766', inline=True)}} * `alt_screen` - an optional field that defaults to `'Any'`, but that can also be set to either `true` or `false`. This mouse binding entry will only be considered if the current pane's alt screen state matches this field. Most of the default mouse assignments are defined as `alt_screen='Any'`, a notable exception being that mouse wheel scrolling only applies when `alt_screen=false`, as the mouse wheel is typically mapped to arrow keys by - the terminal in alt screen mode. (*Since: 20220807-113146-c2fee766*). + the terminal in alt screen mode. {{since('20220807-113146-c2fee766', inline=True)}}. The `action` and `mods` portions are described in more detail in the key assignment information below. @@ -152,7 +152,7 @@ you wanted quadruple-click bindings you can specify `streak=4`. | Double Left Up | `event={Up={streak=2, button="Left"}}` | | Single Left Drag | `event={Drag={streak=1, button="Left"}}` | -*since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} You can handle vertical wheel scroll events using the example shown below. The `streak` and amount associated with either `WheelUp` or `WheelDown` are set to diff --git a/docs/copymode.md b/docs/copymode.md index 6e3224d65..674e8ca26 100644 --- a/docs/copymode.md +++ b/docs/copymode.md @@ -1,4 +1,4 @@ -*since: 20200607-144723-74889cd4* +{{since('20200607-144723-74889cd4')}} Copy mode allows you to make selections using the keyboard; no need to reach for your mouse or trackpad. Copy mode is similar to [quick select @@ -34,7 +34,7 @@ The default key assignments in copy mode are as follows: | | q | | Cell selection | v | | Line selection | Shift + V | -| Rectangular selection | Ctrl + V (*since: 20220624-141144-bd1b7c5d*)| +| Rectangular selection | Ctrl + V {{since('20220624-141144-bd1b7c5d', inline=True)}}| | Move Left | LeftArrow | | | h | | Move Down | DownArrow | @@ -51,7 +51,7 @@ The default key assignments in copy mode are as follows: | | Alt + B | | | Shift + Tab | | | b | -| Move forward one word end | e (*since: nightly builds only*)| +| Move forward one word end | e {{since('20230320-124340-559cb7b0', inline=True)}}| | Move to start of this line | 0 | | | Home | | Move to start of next line | Enter | @@ -66,16 +66,16 @@ The default key assignments in copy mode are as follows: | Move to bottom of viewport | Shift + L | | Move up one screen | PageUp | | | Ctrl + B | -| Move up half a screen | Ctrl + U (*since: nightly builds only*)| +| Move up half a screen | Ctrl + U {{since('20230320-124340-559cb7b0', inline=True)}}| | Move down one screen | PageDown | | | Ctrl + F | -| Move down half a screen | Ctrl + D (*since: nightly builds only*)| +| Move down half a screen | Ctrl + D {{since('20230320-124340-559cb7b0', inline=True)}}| | Move to other end of the selection| o | | Move to other end of the selection horizontally| Shift + O (useful in Rectangular mode) | ### Configurable Key Assignments -*Since: 20220624-141144-bd1b7c5d* +{{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/escape-sequences.md b/docs/escape-sequences.md index 79c3e797e..b18ddee43 100644 --- a/docs/escape-sequences.md +++ b/docs/escape-sequences.md @@ -198,9 +198,9 @@ It is valid to omit the code number; for example `CSI m` is equivalent to `CSI |53 |OverlineOn|Renders text with a single overline/overbar| |55 |OverlineOff|Cancels OverlineOn| |59 |UnderlineColorDefault|Resets the underline color to default, which is to match the foreground color| -|73 |VerticalAlignSuperScript|Adjusts the baseline of the text so that it renders as superscript (*Since: 20221119-145034-49b9839f*)| -|74 |VerticalAlignSubScript|Adjusts the baseline of the text so that it renders as subscript (*Since: 20221119-145034-49b9839f*)| -|75 |VerticalAlignBaseLine|Reset the baseline of the text to normal (*Since: 20221119-145034-49b9839f*)| +|73 |VerticalAlignSuperScript|Adjusts the baseline of the text so that it renders as superscript {{since('20221119-145034-49b9839f', inline=True)}}| +|74 |VerticalAlignSubScript|Adjusts the baseline of the text so that it renders as subscript {{since('20221119-145034-49b9839f', inline=True)}}| +|75 |VerticalAlignBaseLine|Reset the baseline of the text to normal {{since('20221119-145034-49b9839f', inline=True)}}| |90 |ForegroundBrightBlack|Sets the foreground color to Bright Black, which is palette index 8| |91 |ForegroundBrightRed|Sets the foreground color to Bright Red, which is palette index 9| |92 |ForegroundBrightGreen|Sets the foreground color to Bright Green, which is palette index 10| @@ -278,7 +278,7 @@ CSI 38 : 2 : R : G : B m ##### CSI 38:6 - foreground color: RGBA -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This is a wezterm extension: wezterm considers color mode `6` as RGBA, allowing you to specify the alpha channel in addition to the RGB channels. @@ -306,7 +306,7 @@ CSI 48 : 2 : R : G : B m ##### CSI 48:6 - background color: RGBA -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This is a wezterm extension: wezterm considers color mode `6` as RGBA, allowing you to specify the alpha channel in addition to the RGB channels. @@ -334,7 +334,7 @@ CSI 58 : 2 : R : G : B m ##### CSI 58:6 - underline color: RGBA -*Since: 20220807-113146-c2fee766* +{{since('20220807-113146-c2fee766')}} This is a wezterm extension: wezterm considers color mode `6` as RGBA, allowing you to specify the alpha channel in addition to the RGB channels. @@ -349,7 +349,7 @@ CSI 58 : 6 : : R : G : B : A m #### Mode Functions -*Since: 20210814-124438-54e29167* +{{since('20210814-124438-54e29167')}} 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. diff --git a/docs/faq.md b/docs/faq.md index 11a91a485..e963b05b1 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: 20220624-141144-bd1b7c5d* +{{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/imgcat.md b/docs/imgcat.md index 4a50593ec..bd084b704 100644 --- a/docs/imgcat.md +++ b/docs/imgcat.md @@ -16,7 +16,7 @@ $ wezterm imgcat /path/to/image.png at this time**. -*Since: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/multiplexing.md b/docs/multiplexing.md index f73c9bad9..ef2883660 100644 --- a/docs/multiplexing.md +++ b/docs/multiplexing.md @@ -129,7 +129,7 @@ config.unix_domains = { } ``` -*Since: 20220101-133340-7edc5b5a* +{{since('20220101-133340-7edc5b5a')}} It is now possible to specify a `proxy_command` that will be used in place of making a direct unix connection. When `proxy_command` @@ -149,7 +149,7 @@ config.unix_domains = { } ``` -*Since: 20220319-142410-0fcdea07* +{{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 diff --git a/docs/quickselect.md b/docs/quickselect.md index 9e460fce1..c5241b8d3 100644 --- a/docs/quickselect.md +++ b/docs/quickselect.md @@ -1,4 +1,4 @@ -*Since: 20210502-154244-3f7122cb* +{{since('20210502-154244-3f7122cb')}} Quick Select mode allows you to quickly highlight text that matches commonly copied patterns, select a match by typing a one-or-two character diff --git a/docs/scrollback.md b/docs/scrollback.md index 707283c31..f37887364 100644 --- a/docs/scrollback.md +++ b/docs/scrollback.md @@ -81,7 +81,7 @@ When the search overlay is active the behavior of wezterm changes: #### Configurable search mode key assignments -*Since: 20220624-141144-bd1b7c5d* +{{since('20220624-141144-bd1b7c5d')}} The key assignments for search mode are specified by the `search_mode` [Key Table](config/key-tables.md). @@ -103,7 +103,7 @@ You can see the configuration in your version of wezterm by running ### Configuring Saved Searches -*since: 20200607-144723-74889cd4* +{{since('20200607-144723-74889cd4')}} If you find that you're often searching for the same things then you may wish to assign a keybinding to trigger that search. diff --git a/docs/ssh.md b/docs/ssh.md index 32b6759e4..658dada37 100644 --- a/docs/ssh.md +++ b/docs/ssh.md @@ -26,7 +26,7 @@ and preserves your tabs. The [ssh_backend](config/lua/config/ssh_backend.md) configuration can be used to specify which ssh library is used. -*Since: 20210404-112810-b63a949d* +{{since('20210404-112810-b63a949d')}} wezterm is now able to parse `~/.ssh/config` and `/etc/ssh/ssh_config` and respects the following options: @@ -44,13 +44,13 @@ and respects the following options: All other options are parsed but have no effect. Notably, neither `Match` or `Include` will do anything. -*Since: 20210502-154244-3f7122cb:* +{{since('20210502-154244-3f7122cb:')}} `Match` is now recognized but currently supports only single-phase (`final`, `canonical` are not supported) configuration parsing for `Host` and `LocalUser`. `Exec` based matches are recognized but not supported. -*Since: 20210814-124438-54e29167:* +{{since('20210814-124438-54e29167:')}} `Include` is now supported. diff --git a/docs/style.css b/docs/style.css index 37f207626..664cc5fbe 100644 --- a/docs/style.css +++ b/docs/style.css @@ -20,4 +20,3 @@ -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; } - diff --git a/mkdocs_macros.py b/mkdocs_macros.py index ef62c9367..408e28874 100644 --- a/mkdocs_macros.py +++ b/mkdocs_macros.py @@ -1,32 +1,33 @@ # https://mkdocs-macros-plugin.readthedocs.io/en/latest/macros/ def define_env(env): @env.macro - def since(vers, inline=False): - if vers == "nightly" and not inline: - return """ -???+ info "*Since: Nightly Builds Only*" + def since(vers, outline=False, inline=False): + if vers == "nightly": + first_line = "*Since: Nightly Builds Only*" + expanded = "+" + blurb = """ The feature described in this section requires a nightly build of wezterm. You can obtain a nightly build by following the instructions from the [Download](/wezterm/installation.html) section. """ - - if vers == "nightly" and inline: - return """ -!!! info "*Since: Nightly Builds Only*" - *The feature described in this section requires a nightly build of wezterm. - You can obtain a nightly build by following the instructions from the - [Download](/wezterm/installation.html) section.* -""" - - if inline: - return f""" -!!! info "*Since: Version {vers}*" + else: + first_line = f"*Since: Version {vers}*" + expanded = "" + blurb = f""" *The feature described in this section requires version {vers} of wezterm, or a more recent version.* """ - return f""" -??? info "*Since: Version {vers}*" - The feature described in this section requires version {vers} of wezterm, - or a more recent version. + if outline: + return f""" +!!! info "{first_line}" +{blurb} +""" + + if inline: + return f"({first_line})" + + return f""" +???{expanded} info "{first_line}" +{blurb} """