mirror of
https://github.com/wez/wezterm.git
synced 2024-09-20 11:17:15 +03:00
docs: 20220807-113146-c2fee766 release
This commit is contained in:
parent
c2fee76638
commit
52af7a2b2b
@ -11,6 +11,10 @@ usually the best available version.
|
||||
|
||||
As features stabilize some brief notes about them will accumulate here.
|
||||
|
||||
* Not yet
|
||||
|
||||
### 20220807-113146-c2fee766
|
||||
|
||||
#### New
|
||||
* [ActivateKeyTable](config/lua/keyassignment/ActivateKeyTable.md) now supports `until_unknown=true` to implicitly pop the table when a key not defined by that table is pressed. [#2178](https://github.com/wez/wezterm/issues/2178)
|
||||
* [window:copy_to_clipboard](config/lua/window/copy_to_clipboard.md) method for putting arbitrary text into the clipboard/selection.
|
||||
|
File diff suppressed because it is too large
Load Diff
@ -86,7 +86,7 @@ return {
|
||||
compose_cursor = 'orange',
|
||||
|
||||
-- Colors for copy_mode and quick_select
|
||||
-- available since: nightly builds only
|
||||
-- available since: 20220807-113146-c2fee766
|
||||
-- In copy_mode, the color of the active text is:
|
||||
-- 1. copy_mode_active_highlight_* if additional text was selected using the mouse
|
||||
-- 2. selection_* otherwise
|
||||
|
@ -1,6 +1,6 @@
|
||||
# ExecDomain
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `pane:tab()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the [MuxTab](../MuxTab/index.md) that contains this pane.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `pane:window()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the [MuxWindow](../mux-window/index.md) that contains the tab that contains this pane.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# tab:get_title()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the tab title as set by `tab:set_title()`.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# tab:panes()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns an array table containing the set of [MuxPane](../MuxPane/index.md) objects
|
||||
contained by this tab.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# tab:panes_with_info()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns an array table containing an extended info entry for each of the panes
|
||||
contained by this tab.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# tab:set_title(TITLE)
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Sets the tab title to the provided string.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# tab:set_zoomed(bool)
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Sets the zoomed state for the active pane within this tab.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# tab:window()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the [MuxWindow](../mux-window/index.md) object that contains this tab.
|
||||
|
||||
|
@ -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: nightly builds only*)
|
||||
* `window_title` - the title of the window that contains this tab (*Since: nightly builds only*)
|
||||
* `tab_title` - the title of the tab (*Since: nightly builds only*)
|
||||
* `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*)
|
||||
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:adjust_hue_fixed(degrees)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Adjust the hue angle by the specified number of degrees.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:adjust_hue_fixed_ryb(degrees)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Adjust the hue angle by the specified number of degrees.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:complement()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:complement_ryb()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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
|
||||
|
@ -1,6 +1,6 @@
|
||||
### `color:contrast_ratio(color)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Computes the contrast ratio between the two colors.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:darken(factor)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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`.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:darken_fixed(amount)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Decrease the lightness by amount, a value ranging from `0.0` to `1.0`.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
### `color:delta_e(color)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Computes the CIEDE2000 DeltaE value representing the difference
|
||||
between the two colors.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:desaturate(factor)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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`.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:desaturate_fixed(amount)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Decrease the saturation by amount, a value ranging from `0.0` to `1.0`.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:hsla()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Converts the color to the HSL colorspace and returns those values +
|
||||
alpha:
|
||||
|
@ -1,6 +1,6 @@
|
||||
### `color:laba()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Converts the color to the LAB colorspace and returns those values +
|
||||
alpha:
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:lighten(factor)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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`.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:lighten_fixed(amount)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Increase the lightness by amount, a value ranging from `0.0` to `1.0`.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:linear_rgba()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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`:
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:saturate(factor)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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`.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:saturate_fixed(amount)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Increase the saturation by amount, a value ranging from `0.0` to `1.0`.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:square()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:srgba_u8()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns a tuple of the internal SRGBA colors expressed
|
||||
as unsigned 8-bit integers in the range 0-255:
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `color:triad()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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.
|
||||
|
@ -11,7 +11,7 @@ IME support is a platform dependent feature
|
||||
|Windows |Forever |Always enabled, cannot be disabled|
|
||||
|macOS |20200113-214446-bb6251f|defaults to enabled starting in 20220319-142410-0fcdea07. Earlier versions had problems with key repeat when enabled|
|
||||
|X11 |20211204-082213-a66c61ee9|[XIM](https://en.wikipedia.org/wiki/X_Input_Method) based. Your system needs to have a running input method engine (such as ibus or fcitx) that support the XIM protocol in order for wezterm to use it.|
|
||||
|Wayland |Nightly builds only|Your compositor must support `zwp_text_input_v3`|
|
||||
|Wayland |20220807-113146-c2fee766|Your compositor must support `zwp_text_input_v3`|
|
||||
|
||||
You can control whether the IME is enabled in your configuration file:
|
||||
|
||||
|
@ -15,7 +15,7 @@ program will be spawned.
|
||||
This event is useful for starting a set of programs in a standard
|
||||
configuration to save you the effort of doing it manually each time.
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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`.
|
||||
|
@ -10,7 +10,7 @@ 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: nightly builds only*: 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*: 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: nightly builds only*)
|
||||
* `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*)
|
||||
|
@ -34,7 +34,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: nightly builds only*. 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*. 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
|
||||
|
@ -1,6 +1,6 @@
|
||||
# ScrollByCurrentEventWheelDelta
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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
|
||||
|
@ -1,6 +1,6 @@
|
||||
# SetPaneZoomState(bool)
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## window:get_title()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the window title as set by `OSC 0`, `OSC 2` in a contained pane, or through
|
||||
`window:set_title()`.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:gui_window()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Attempts to resolve this mux window to its corresponding [Gui Window](../window/index.md).
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
## window:set_title(TITLE)
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Sets the window title to the provided string. Note that applications may
|
||||
subsequently change the title via escape sequences.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## window:tabs()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns an array table holding each of the [MuxTab](../MuxTab/index.md) objects
|
||||
contained within this window.
|
||||
|
@ -1,6 +1,6 @@
|
||||
## window:tabs_with_info()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns an array table holding an extended info entry for each of the tabs
|
||||
contained within this window.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `pane:is_alt_screen_active()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns whether the alternate screen is active for the pane.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# pane:mux_pane()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the [MuxPane](../MuxPane/index.md) representation of this pane.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.color.extract_colors_from_image(filename [,params])`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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
|
||||
|
@ -1,6 +1,6 @@
|
||||
## `wezterm.color.from_hsla(h, s, l, a)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Constructs a new [color object](../color/index.md) from values in the HSL
|
||||
colorspace, plus alpha.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.color.get_builtin_schemes()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
(In earlier releases, you can use [wezterm.get_builtin_color_schemes()](../wezterm/get_builtin_color_schemes.md))
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.color.get_default_colors()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the set of colors that would be used by default.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.color.gradient(gradient, num_colors)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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
|
||||
|
@ -1,4 +1,4 @@
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
The `wezterm.color` module exposes functions that work with colors.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.color.load_base16_scheme(file_name)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Loads a yaml file in [base16](https://github.com/chriskempson/base16) format
|
||||
and returns it as a wezterm color scheme.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.color.load_scheme(file_name)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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:
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.color.load_terminal_sexy_scheme(file_name)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Loads a json file exported from [terminal.sexy](https://terminal.sexy/)
|
||||
and returns it as a wezterm color scheme.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# wezterm.color.parse(string)
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Parses the passed color and returns a [Color
|
||||
object](../color/index.md). `Color` objects evaluate as strings but
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.color.save_scheme(colors, metadata, file_name)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Saves a color scheme as a wezterm TOML file.
|
||||
This is useful when sharing your custom color scheme with others.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.gui.get_appearance()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
This function returns the appearance of the window environment. The appearance
|
||||
can be one of the following 4 values:
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.gui.gui_window_for_mux_window(window_id)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Attempts to resolve a mux window to its corresponding [Gui Window](../window/index.md).
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
The `wezterm.gui` module exposes functions that operate on the gui layer.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.gui.screens()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns information about the screens connected to the system.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.mux.all_windows()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns an array table holding all of the known [MuxWindow](../mux-window/index.md)
|
||||
objects.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.procinfo.current_working_dir_for_pid(pid)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the current working directory for the specified process id.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.procinfo.executable_path_for_pid(pid)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the path to the executable image for the specified process id.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.procinfo.get_info_for_pid(pid)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns a [LocalProcessInfo](../LocalProcessInfo.md) object for the specified
|
||||
process id.
|
||||
|
@ -1,4 +1,4 @@
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
The `wezterm.procinfo` module exposes functions that allow querying information
|
||||
about processes that are running on the local system.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.procinfo.pid()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the process id for the current process.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `Time:format(format)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Formats the time object as a string, using the local date/time representation of the time.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `Time:format_utc(format)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Formats the time object as a string, using UTC date/time representation of the time.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `Time:sun_times(lat, lon)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.time.call_after(interval_seconds, function)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Arranges to call your callback function after the specified number of seconds
|
||||
have elapsed.
|
||||
|
@ -1,4 +1,4 @@
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
The `wezterm.time` module exposes functions that allow working
|
||||
with time.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.time.now()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns a [Time](Time/index.md) object representing the time at which
|
||||
`wezterm.time.now()` was called.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.time.parse(str, format)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Parses a string that is formatted according to the supplied format string:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.time.partse_rfc3339(str)`
|
||||
# `wezterm.time.parse_rfc3339(str)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Parses a string that is formatted according to [RFC
|
||||
3339](https://datatracker.ietf.org/doc/html/rfc3339) and returns a
|
||||
|
@ -7,6 +7,6 @@ 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: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
This function is now called implicitly when you `require` a lua file.
|
||||
|
@ -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: nightly builds only*)
|
||||
* `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*)
|
||||
|
||||
|
@ -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: nightly builds only*)
|
||||
* `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*)
|
||||
|
||||
## Dealing with different fallback font heights
|
||||
|
||||
|
@ -46,4 +46,4 @@ 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: nightly builds only*)
|
||||
* `"ResetAttributes"` - reset all attributes to default. (*Since: 20220807-113146-c2fee766*)
|
||||
|
@ -103,7 +103,7 @@ end)
|
||||
return {}
|
||||
```
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
This function moved to
|
||||
[wezterm.color.get_builtin_schemes()](../wezterm.color/get_builtin_schemes.md)
|
||||
|
@ -20,7 +20,7 @@ This example is what you'd see if you opened up the [debug overlay](../keyassign
|
||||
["#6e40aa", "#ff8c38", "#5dea8d", "#6e40aa"]
|
||||
```
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
This function has moved to
|
||||
[wezterm.color.gradient](../wezterm.color/gradient.md) and that name
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.json_encode(value)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Encodes the supplied lua value as json:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.json_parse(string)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Parses the supplied string as json and returns the equivalent lua values:
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `wezterm.reload_configuration()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Immediately causes the configuration to be reloaded and re-applied.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# wezterm.shell_join_args({"foo", "bar"})
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# wezterm.shell_quote_arg(string)
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Quotes its single argument using posix shell quoting rules.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# wezterm.shell_split(line)
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Splits a command line into an argument array according to posix shell rules.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# window:copy_to_clipboard(text \[,clipboard\])
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Puts `text` into the specified `clipboard`.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:current_event()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the current event.
|
||||
For now only implemented for mouse events.
|
||||
|
@ -45,7 +45,7 @@ return {}
|
||||
|
||||
### Wayland GNOME Appearance
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
wezterm uses [XDG Desktop
|
||||
Portal](https://flatpak.github.io/xdg-desktop-portal/) to determine the
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:get_selection_escapes_for_pane(pane)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:maximize()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Puts the window into the maximized state.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# window:mux_window()
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Returns the [MuxWindow](../mux-window/index.md) representation of this window.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:restore()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Restores the window from the maximized state.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:set_inner_size(width, height)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Resizes the inner portion of the window (excluding any window decorations) to
|
||||
the specified width and height.
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:set_left_status(string)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*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
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:set_position(x, y)`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Repositions the top-left corner of the window to the specified `x`, `y` coordinates.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# `window:toggle_fullscreen()`
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
Toggles full screen mode for the window.
|
||||
|
||||
|
@ -115,14 +115,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: nightly builds only*)
|
||||
key](lua/config/bypass_mouse_reporting_modifiers.md). (*Since: 20220807-113146-c2fee766*)
|
||||
* `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: nightly builds only*).
|
||||
the terminal in alt screen mode. (*Since: 20220807-113146-c2fee766*).
|
||||
|
||||
The `action` and `mods` portions are described in more detail in the key assignment
|
||||
information below.
|
||||
@ -149,7 +149,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: nightly builds only*
|
||||
*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
|
||||
|
@ -275,7 +275,7 @@ CSI 38 : 2 : R : G : B m
|
||||
|
||||
##### CSI 38:6 - foreground color: RGBA
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
This is a wezterm extension: wezterm considers colorspace ID `6` as RGBA,
|
||||
allowing you to specify the alpha channel in addition to the RGB channels.
|
||||
@ -303,7 +303,7 @@ CSI 48 : 2 : R : G : B m
|
||||
|
||||
##### CSI 48:6 - background color: RGBA
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
This is a wezterm extension: wezterm considers colorspace ID `6` as RGBA,
|
||||
allowing you to specify the alpha channel in addition to the RGB channels.
|
||||
@ -331,7 +331,7 @@ CSI 58 : 2 : R : G : B m
|
||||
|
||||
##### CSI 58:6 - underline color: RGBA
|
||||
|
||||
*Since: nightly builds only*
|
||||
*Since: 20220807-113146-c2fee766*
|
||||
|
||||
This is a wezterm extension: wezterm considers colorspace ID `6` as RGBA,
|
||||
allowing you to specify the alpha channel in addition to the RGB channels.
|
||||
|
Loading…
Reference in New Issue
Block a user