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

docs: update for latest release

Browse Source
This commit is contained in:
Wez Furlong 2024-01-27 12:50:49 -07:00
parent 08413ba87a
commit c85fa0b73b
No known key found for this signature in database
GPG Key ID: 7A7F66A31EC9B387
19 changed files with 71 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ci/update-doc-versions.py
View File

@ -4,7 +4,7 @@ import os
import re
import sys
NIGHTLY = '20230712-072601-f4abf8fd'
NIGHTLY = '20240127-113634-bbcac864'
SINCE = re.compile("\{\{since\('nightly'", re.MULTILINE)

2
docs/cli/cli/zoom-pane.md
View File

@ -1,6 +1,6 @@
# `wezterm cli zoom-pane`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
*Run `wezterm cli zoom-pane --help` to see more help*

98
docs/colorschemes/data.json
View File

@ -314,7 +314,7 @@
"name": "Aardvark Blue",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "a",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -711,7 +711,7 @@
"name": "alacritty",
"origin_url": "https://github.com/EdenEast/nightfox.nvim",
"prefix": "a",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -953,7 +953,7 @@
"name": "Apple System Colors",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "a",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -3402,7 +3402,7 @@
"name": "Bamboo Light",
"origin_url": "https://github.com/ribru17/bamboo.nvim",
"prefix": "b",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -6217,7 +6217,7 @@
"name": "Campbell (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "c",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -10972,7 +10972,7 @@
"name": "Ef-Arbutus",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-arbutus-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11132,7 +11132,7 @@
"name": "Ef-Cyprus",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-cyprus-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11212,7 +11212,7 @@
"name": "Ef-Day",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-day-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11252,7 +11252,7 @@
"name": "Ef-Deuteranopia-Dark",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-deuteranopia-dark-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11292,7 +11292,7 @@
"name": "Ef-Deuteranopia-Light",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-deuteranopia-light-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11332,7 +11332,7 @@
"name": "Ef-Duo-Dark",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-duo-dark-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11372,7 +11372,7 @@
"name": "Ef-Duo-Light",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-duo-light-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11412,7 +11412,7 @@
"name": "Ef-Elea-Dark",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-elea-dark-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11452,7 +11452,7 @@
"name": "Ef-Elea-Light",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-elea-light-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11492,7 +11492,7 @@
"name": "Ef-Frost",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-frost-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11532,7 +11532,7 @@
"name": "Ef-Kassio",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-kassio-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11572,7 +11572,7 @@
"name": "Ef-Light",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-light-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11612,7 +11612,7 @@
"name": "Ef-Maris-Dark",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-maris-dark-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11652,7 +11652,7 @@
"name": "Ef-Maris-Light",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-maris-light-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11692,7 +11692,7 @@
"name": "Ef-Melissa-Dark",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-melissa-dark-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11732,7 +11732,7 @@
"name": "Ef-Melissa-Light",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-melissa-light-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11772,7 +11772,7 @@
"name": "Ef-Night",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-night-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11812,7 +11812,7 @@
"name": "Ef-Rosa",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-rosa-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -11932,7 +11932,7 @@
"name": "Ef-Symbiosis",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/ef-symbiosis-theme.el",
"prefix": "e",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -13649,7 +13649,7 @@
"name": "farmhouse-dark",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "f",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -13688,7 +13688,7 @@
"name": "farmhouse-light",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "f",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -13801,7 +13801,7 @@
"name": "Firefly Traditional",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "f",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -14271,7 +14271,7 @@
"name": "flexoki-dark",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "f",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -14310,7 +14310,7 @@
"name": "flexoki-light",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "f",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -15161,7 +15161,7 @@
"name": "Github Dark (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "g",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -19416,7 +19416,7 @@
"name": "iTerm2 Dark Background",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "i",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -19455,7 +19455,7 @@
"name": "iTerm2 Default",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "i",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -19494,7 +19494,7 @@
"name": "iTerm2 Light Background",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "i",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -19533,7 +19533,7 @@
"name": "iTerm2 Pastel Dark Background",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "i",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -19572,7 +19572,7 @@
"name": "iTerm2 Smoooooth",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "i",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -19611,7 +19611,7 @@
"name": "iTerm2 Tango Dark",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "i",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -19650,7 +19650,7 @@
"name": "iTerm2 Tango Light",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "i",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -23107,7 +23107,7 @@
"name": "Modus-Operandi-Deuteranopia",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/modus-operandi-deuteranopia-theme.el",
"prefix": "m",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -23147,7 +23147,7 @@
"name": "Modus-Operandi-Tinted",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/modus-operandi-tinted-theme.el",
"prefix": "m",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -23227,7 +23227,7 @@
"name": "Modus-Vivendi-Deuteranopia",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/modus-vivendi-deuteranopia-theme.el",
"prefix": "m",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -23267,7 +23267,7 @@
"name": "Modus-Vivendi-Tinted",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/modus-vivendi-tinted-theme.el",
"prefix": "m",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -23307,7 +23307,7 @@
"name": "Modus-Vivendi-Tritanopia",
"origin_url": "https://git.sr.ht/~protesilaos/ef-themes/tree/main/item/modus-vivendi-tritanopia-theme.el",
"prefix": "m",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -24230,7 +24230,7 @@
"name": "Moonfly (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "m",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -25066,7 +25066,7 @@
"name": "Nightfly (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "n",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -26950,7 +26950,7 @@
"name": "Oxocarbon Dark (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "o",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -30290,7 +30290,7 @@
"name": "Rosé Pine Moon (base16)",
"origin_url": "https://github.com/edunfelt/base16-rose-pine-scheme",
"prefix": "r",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -31003,7 +31003,7 @@
"name": "Selenized Dark (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "s",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -31040,7 +31040,7 @@
"name": "Selenized Light (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "s",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{
@ -38254,7 +38254,7 @@
"name": "Website (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "w",
"wezterm_version": "nightly builds only"
"wezterm_version": "20240127-113634-bbcac864"
}
},
{

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

@ -5,7 +5,7 @@ tags:
---
# `command_palette_rows = 14`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
Specifies the number of rows displayed by the command palette.
[ActivateCommandPalette](../keyassignment/ActivateCommandPalette.md).

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

@ -30,7 +30,7 @@ correct render mode to activate: setting it only in a
[wezterm.font](../wezterm/font.md) override is not sufficient.
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
It is now possible to select `"VerticalLcd"` to use a subpixel-rendering
variant of `Normal` optimized for vertically decimated LCD displays.

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

@ -12,7 +12,7 @@ possible values:
* `Software` - use CPU-based rasterization.
* `WebGpu` - use GPU accelerated rasterization {{since('20221119-145034-49b9839f', inline=True)}}
{{since('nightly', outline=true)}}
{{since('20240127-113634-bbcac864', outline=true)}}
The default is `"WebGpu"`. In earlier versions it was `"OpenGL"`
You may wish (or need!) to select `Software` if there are issues with your

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

@ -5,7 +5,7 @@ tags:
# `notification_handling = "AlwaysShow"`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
This option controls how wezterm behaves when a toast notification escape
sequence is received.

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

@ -11,6 +11,6 @@ This option is only respected on X11, Wayland and macOS systems.
Note that if you have configured [window_padding](window_padding.md) then the
resize increments don't take the padding into account.
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
Window padding is now accounted for.

10
docs/config/lua/keyassignment/InputSelector.md
View File

@ -26,7 +26,7 @@ upon the input.
in its fuzzy finding mode (this is equivalent to starting the InputSelector and
pressing / in the default mode).
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
These additional fields are also available:
@ -47,7 +47,7 @@ The default key assignments in the InputSelector are as follows:
| Action | Key Assignment |
|---------|-------------------|
| Add to selection string until a match is found (if in the default mode) | Any key in `alphabet` {{since('nightly', inline=True)}} |
| Add to selection string until a match is found (if in the default mode) | Any key in `alphabet` {{since('20240127-113634-bbcac864', inline=True)}} |
| Select matching number (if in the default mode) | <kbd>1</kbd> to <kbd>9</kbd> {{since('20230408-112425-69ae8472', inline=True)}} |
| Start fuzzy search (if in the default mode) | <kbd>/</kbd> |
| Add to filtering string (if in fuzzy finding mode) | Any key not listed below |
@ -56,14 +56,14 @@ The default key assignments in the InputSelector are as follows:
| | <kbd>LeftClick</kbd> (with mouse) |
| Move Down | <kbd>DownArrow</kbd> |
| | <kbd>Ctrl</kbd> + <kbd>N</kbd> |
| | <kbd>Ctrl</kbd> + <kbd>J</kbd> {{since('nightly', inline=True)}} |
| | <kbd>Ctrl</kbd> + <kbd>J</kbd> {{since('20240127-113634-bbcac864', inline=True)}} |
| | <kbd>j</kbd> (if not in `alphabet`) |
| Move Up | <kbd>UpArrow</kbd> |
| | <kbd>Ctrl</kbd> + <kbd>P</kbd> |
| | <kbd>Ctrl</kbd> + <kbd>K</kbd> {{since('nightly', inline=True)}} |
| | <kbd>Ctrl</kbd> + <kbd>K</kbd> {{since('20240127-113634-bbcac864', inline=True)}} |
| | <kbd>k</kbd> (if not in `alphabet`) |
| Quit | <kbd>Ctrl</kbd> + <kbd>G</kbd> |
| | <kbd>Ctrl</kbd> + <kbd>C</kbd> {{since('nightly', inline=True)}} |
| | <kbd>Ctrl</kbd> + <kbd>C</kbd> {{since('20240127-113634-bbcac864', inline=True)}} |
| | <kbd>Escape</kbd> |
Note: If the InputSelector is started with `fuzzy` set to `false`, then <kbd>Backspace</kbd> can go from fuzzy finding mode back to the default mode when pressed while the filtering string is empty.

2
docs/config/lua/keyassignment/PaneSelect.md
View File

@ -22,7 +22,7 @@ The selection alphabet defaults to the same value as
[quick_select_alphabet](../config/quick_select_alphabet.md), but can be
explicitly via the `alphabet` field:
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
Additional modes are now supported:

2
docs/config/lua/keyassignment/SetWindowLevel.md
View File

@ -1,6 +1,6 @@
# `SetWindowLevel`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
Set window level specified by the argument value. eg: `AlwaysOnTop` keeps the current window on top of other windows.

2
docs/config/lua/keyassignment/ToggleAlwaysOnBottom.md
View File

@ -1,6 +1,6 @@
# `ToggleAlwaysOnBottom`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
Toggles the window to remain behind all other windows.

2
docs/config/lua/keyassignment/ToggleAlwaysOnTop.md
View File

@ -1,6 +1,6 @@
# `ToggleAlwaysOnTop`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
Toggles the window between floating and non-floating states to stay on top of other windows.

2
docs/config/lua/pane/get_current_working_dir.md
View File

@ -29,7 +29,7 @@ it is possible for an application to set it to an FTP URL or some
other kind of URL, which is why this method doesn't simply return
a file path string.
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
This method now returns a [Url](../wezterm.url/Url.md) object which
provides a convenient way to decode and operate on the URL.

2
docs/config/lua/pane/get_lines_as_escapes.md
View File

@ -1,6 +1,6 @@
# `pane:get_lines_as_escapes([nlines])`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
Returns the textual representation (*including* color and other attributes) of
the *physical* lines of text in the viewport as a string with embedded ANSI

2
docs/config/lua/wezterm.url/Url.md
View File

@ -1,6 +1,6 @@
# Url object
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
The `Url` object represents a parsed Url. It has the following fields:

2
docs/config/lua/wezterm.url/index.markdown
View File

@ -1,6 +1,6 @@
# `wezterm.url` module
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
The `wezterm.url` module exposes functions that allow working
with URLs.

2
docs/config/lua/wezterm.url/parse.md
View File

@ -1,6 +1,6 @@
# `wezterm.url.parse(URL_STRING)`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
Attempts to parse the provided *URL_STRING* as a URL.
If success, returns a [Url](Url.md) object representing that URL.

2
docs/config/lua/wezterm/to_string.md
View File

@ -5,7 +5,7 @@ tags:
---
# `wezterm.to_string(arg)`
{{since('nightly')}}
{{since('20240127-113634-bbcac864')}}
This function returns a string representation of any Lua value. In particular
this can be used to get a string representation of a table or userdata.