wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-11-22 13:16:39 +03:00
Code Issues Projects Releases Wiki Activity

docs: update a bunch of since lines to new macro

Browse Source
This commit is contained in:
Wez Furlong 2023-03-20 22:01:24 -07:00
parent 3b8551e03c
commit 40081cb573
No known key found for this signature in database
GPG Key ID: 7A7F66A31EC9B387
381 changed files with 521 additions and 496 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ci/generate-docs.py
View File

@ -279,7 +279,7 @@ function load_scheme_player(ident) {{
idx.write(f"Source: <{origin_url}><br/>\n")
version = scheme["metadata"].get("wezterm_version", None)
if version and version != "Always":
idx.write(f"Since: *{version}*<br/>\n")
idx.write(f"{{{{since('{version}')}}}}<br/>\n")
aliases = scheme["metadata"]["aliases"]
if len(aliases) > 1:

25
ci/update-doc-versions.py Normal file
View File

@ -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)

2
docs/cli/cli/activate-pane-direction.md
View File

@ -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*

2
docs/cli/cli/list-clients.md
View File

@ -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:

2
docs/cli/cli/list.md
View File

@ -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:

2
docs/cli/cli/move-pane-to-new-tab.md
View File

@ -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*

2
docs/cli/cli/send-text.md
View File

@ -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).

2
docs/cli/show-keys.md
View File

@ -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.

16
docs/config/appearance.md
View File

@ -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

10
docs/config/default-keys.md
View File

@ -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}` |

2
docs/config/files.md
View File

@ -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:

2
docs/config/font-shaping.md
View File

@ -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:

2
docs/config/key-encoding.md
View File

@ -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

4
docs/config/key-tables.md
View File

@ -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.

6
docs/config/keyboard-concepts.md
View File

@ -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

8
docs/config/keys.md
View File

@ -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

4
docs/config/launch.md
View File

@ -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"

2
docs/config/lua/ExecDomain.md
View File

@ -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

2
docs/config/lua/LocalProcessInfo.md
View File

@ -1,6 +1,6 @@
# `LocalProcessInfo`
*Since: 20220101-133340-7edc5b5a*
{{since('20220101-133340-7edc5b5a')}}
`LocalProcessInfo` represents a process running on the local machine.

2
docs/config/lua/MuxTab/get_title.md
View File

@ -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()`.

2
docs/config/lua/MuxTab/index.markdown
View File

@ -1,6 +1,6 @@
# MuxTab
*Since: 20220624-141144-bd1b7c5d*
{{since('20220624-141144-bd1b7c5d')}}
`MuxTab` represents a tab that is managed by the multiplexer.

2
docs/config/lua/MuxTab/panes.md
View File

@ -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.

2
docs/config/lua/MuxTab/panes_with_info.md
View File

@ -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.

2
docs/config/lua/MuxTab/set_title.md
View File

@ -1,6 +1,6 @@
# tab:set_title(TITLE)
*Since: 20220807-113146-c2fee766*
{{since('20220807-113146-c2fee766')}}
Sets the tab title to the provided string.

2
docs/config/lua/MuxTab/set_zoomed.md
View File

@ -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.

2
docs/config/lua/MuxTab/tab_id.md
View File

@ -1,6 +1,6 @@
# `tab:tab_id()`
*Since: 20220624-141144-bd1b7c5d*
{{since('20220624-141144-bd1b7c5d')}}
Returns the tab id

2
docs/config/lua/MuxTab/window.md
View File

@ -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.

6
docs/config/lua/PaneInformation.md
View File

@ -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.

2
docs/config/lua/SpawnCommand.md
View File

@ -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

6
docs/config/lua/SshDomain.md
View File

@ -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

6
docs/config/lua/TabInformation.md
View File

@ -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)}}

4
docs/config/lua/TlsDomainClient.md
View File

@ -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

2
docs/config/lua/WslDomain.md
View File

@ -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

2
docs/config/lua/color/adjust_hue_fixed.md
View File

@ -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.

2
docs/config/lua/color/adjust_hue_fixed_ryb.md
View File

@ -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.

2
docs/config/lua/color/complement.md
View File

@ -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

2
docs/config/lua/color/complement_ryb.md
View File

@ -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

2
docs/config/lua/color/contrast_ratio.md
View File

@ -1,6 +1,6 @@
### `color:contrast_ratio(color)`
*Since: 20220807-113146-c2fee766*
{{since('20220807-113146-c2fee766')}}
Computes the contrast ratio between the two colors.

2
docs/config/lua/color/darken.md
View File

@ -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`.

2
docs/config/lua/color/darken_fixed.md
View File

@ -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`.

2
docs/config/lua/color/delta_e.md
View File

@ -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.

2
docs/config/lua/color/desaturate.md
View File

@ -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`.

2
docs/config/lua/color/desaturate_fixed.md
View File

@ -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`.

2
docs/config/lua/color/hsla.md
View File

@ -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:

2
docs/config/lua/color/laba.md
View File

@ -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:

2
docs/config/lua/color/lighten.md
View File

@ -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`.

2
docs/config/lua/color/lighten_fixed.md
View File

@ -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`.

2
docs/config/lua/color/linear_rgba.md
View File

@ -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`:

2
docs/config/lua/color/saturate.md
View File

@ -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`.

2
docs/config/lua/color/saturate_fixed.md
View File

@ -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`.

2
docs/config/lua/color/square.md
View File

@ -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.

2
docs/config/lua/color/srgb_u8.md
View File

@ -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:

2
docs/config/lua/color/triad.md
View File

@ -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.

4
docs/config/lua/config/allow_square_glyphs_to_overflow_width.md
View File

@ -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

4
docs/config/lua/config/allow_win32_input_mode.md
View File

@ -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.

2
docs/config/lua/config/alternate_buffer_wheel_scroll_speed.md
View File

@ -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.

2
docs/config/lua/config/animation_fps.md
View File

@ -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.

2
docs/config/lua/config/audible_bell.md
View File

@ -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.

2
docs/config/lua/config/automatically_reload_config.md
View File

@ -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.

2
docs/config/lua/config/background.md
View File

@ -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.

2
docs/config/lua/config/bypass_mouse_reporting_modifiers.md
View File

@ -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

14
docs/config/lua/config/canonicalize_pasted_newlines.md
View File

@ -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

2
docs/config/lua/config/cell_width.md
View File

@ -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.

2
docs/config/lua/config/clean_exit_codes.md
View File

@ -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

2
docs/config/lua/config/cursor_blink_ease_in.md
View File

@ -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.

2
docs/config/lua/config/cursor_blink_ease_out.md
View File

@ -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.

2
docs/config/lua/config/cursor_blink_rate.md
View File

@ -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

2
docs/config/lua/config/cursor_thickness.md
View File

@ -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.

2
docs/config/lua/config/custom_block_glyphs.md
View File

@ -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.

2
docs/config/lua/config/default_cwd.md
View File

@ -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.

2
docs/config/lua/config/default_domain.md
View File

@ -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.

2
docs/config/lua/config/default_gui_startup_args.md
View File

@ -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

2
docs/config/lua/config/default_workspace.md
View File

@ -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"`.

2
docs/config/lua/config/detect_password_input.md
View File

@ -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

2
docs/config/lua/config/disable_default_quick_select_patterns.md
View File

@ -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)

2
docs/config/lua/config/enable_kitty_keyboard.md
View File

@ -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).

4
docs/config/lua/config/exit_behavior.md
View File

@ -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"`.

2
docs/config/lua/config/font_shaper.md
View File

@ -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.

2
docs/config/lua/config/font_size.md
View File

@ -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.

4
docs/config/lua/config/force_reverse_video_cursor.md
View File

@ -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

2
docs/config/lua/config/foreground_text_hsb.md
View File

@ -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.

2
docs/config/lua/config/freetype_load_flags.md
View File

@ -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 `|`

2
docs/config/lua/config/freetype_load_target.md
View File

@ -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:

2
docs/config/lua/config/freetype_pcf_long_family_names.md
View File

@ -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)

2
docs/config/lua/config/freetype_render_target.md
View File

@ -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.

4
docs/config/lua/config/front_end.md
View File

@ -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:

2
docs/config/lua/config/hyperlink_rules.md
View File

@ -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

2
docs/config/lua/config/ime_preedit_rendering.md
View File

@ -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.

2
docs/config/lua/config/key_map_preference.md
View File

@ -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.

6
docs/config/lua/config/max_fps.md
View File

@ -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)}} |

2
docs/config/lua/config/min_scroll_bar_height.md
View File

@ -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".

2
docs/config/lua/config/mux_env_remove.md
View File

@ -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.

2
docs/config/lua/config/normalize_output_to_unicode_nfc.md
View File

@ -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

2
docs/config/lua/config/pane_focus_follows_mouse.md
View File

@ -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

2
docs/config/lua/config/quick_select_alphabet.md
View File

@ -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).

2
docs/config/lua/config/quick_select_patterns.md
View File

@ -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.

2
docs/config/lua/config/quote_dropped_files.md
View File

@ -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:

2
docs/config/lua/config/selection_word_boundary.md
View File

@ -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.

2
docs/config/lua/config/show_new_tab_button_in_tab_bar.md
View File

@ -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

2
docs/config/lua/config/show_tabs_in_tab_bar.md
View File

@ -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.

Some files were not shown because too many files have changed in this diff Show More