wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-12-24 05:42:03 +03:00
Code Issues Projects Releases Wiki Activity

docs: update for release

Browse Source
This commit is contained in:
Wez Furlong 2022-06-24 14:58:18 -07:00
parent bd1b7c5d9a
commit fc14ac87fc
52 changed files with 63 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/changelog.md
View File

@ -11,6 +11,10 @@ usually the best available version.
As features stabilize some brief notes about them will accumulate here.
* Not yet
### 20220624-141144-bd1b7c5d
#### New
* [background](config/lua/config/background.md) option for rich background compositing and parallax scrolling effects.
* Added [docs for the cli](cli/general.md)

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: nightly builds only*
*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: nightly builds only*
*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: nightly builds only*
*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: nightly builds only*)
* `--no-paste` - Send the text directly, rather than as a bracketed paste. (*Since: 20220624-141144-bd1b7c5d*)
* `--pane-id` - Specifies which pane to send the text to. See also [Targeting Panes](index.md#targeting-panes).

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

@ -37,7 +37,7 @@ The following options affect the behavior:
* `--pane-id` - Specifies the pane that should be split. See also [Targeting Panes](index.md#targeting-panes).
*Since nightly builds only*
*Since 20220624-141144-bd1b7c5d*
* `--bottom` - Split vertically, with the new pane on the bottom.
* `--cells CELLS` - The number of cells that the new split should have. If omitted, 50% of the available space is used.

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

@ -1,6 +1,6 @@
# `wezterm show-keys`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Prints the complete set of key assignments based on your config file.

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

@ -119,7 +119,7 @@ The stack is also cleared when the configuration is reloaded, so if you're
working on a complex key table setup and get stuck, you may be able to unstick
yourself by re-saving your wezterm configuration to trigger a reload.
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
When resolving a key assignment, the top of stack is first searched for a match,
and if one is not found, the next entry on the stack is searched and so on until a match is found.

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

@ -1,6 +1,6 @@
# MuxPane
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
`MuxPane` represents a pane that is managed by the multiplexer.

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

@ -1,6 +1,6 @@
# MuxTab
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
`MuxTab` represents a tab that is managed by the multiplexer.

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

@ -1,6 +1,6 @@
# MuxWindow
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
`MuxWindow` represents a window that is managed by the multiplexer.

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

@ -97,7 +97,7 @@ return {
}
```
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The `domain_name` field returns the name of the domain with which the pane is associated.

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

@ -9,7 +9,7 @@ applications.
See also [Improved Keyboard Handling in ConPTY](https://github.com/microsoft/terminal/blob/main/doc/specs/%234999%20-%20Improved%20keyboard%20handling%20in%20Conpty.md).
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The default for `allow_win32_input_mode` is now true.

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

@ -1,6 +1,6 @@
# background
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The `background` config option allows you to compose a number of layers to
produce the background content in the terminal.

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

@ -1,6 +1,6 @@
# `cell_width = 1.0`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Scales the computed cell width to adjust the spacing between successive cells
of text.

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

@ -1,6 +1,6 @@
## `clean_exit_codes = { 0 }`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Defines the set of exit codes that are considered to be a "clean" exit by
[exit_behavior](exit_behavior.md) when the program running in the terminal

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

@ -1,6 +1,6 @@
# `enable_kitty_keyboard = false`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
When set to `true`, wezterm will honor kitty keyboard protocol escape
sequences that modify the [keyboard encoding](../../key-encoding.md).

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

@ -14,6 +14,6 @@ return {
}
```
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The default is now `true`.

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

@ -33,7 +33,7 @@ the pane to remain open.
See also: [clean_exit_codes](clean_exit_codes.md) for fine tuning what is
considered to be a clean exit status.
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The default is now `"Close"`.

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

@ -1,6 +1,6 @@
# `freetype_pcf_long_family_names = false`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
This option provides control over the
[no-long-family-names](https://freetype.org/freetype2/docs/reference/ft2-properties.html#no-long-family-names)

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

@ -1,6 +1,6 @@
# `ime_preedit_rendering`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Control IME preedit rendering.
IME preedit is an area that is used to display the string being preedited in IME.

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

@ -1,6 +1,6 @@
# `min_scroll_bar_height = "0.5cell"`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Controls the minimum size of the scroll bar "thumb".

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

@ -1,6 +1,6 @@
## quote_dropped_files = "SpacesOnly"
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Controls how file names are quoted (or not) when dragging and dropping.
There are five possible values:
@ -25,7 +25,7 @@ Drag and drop support for files is a platform dependent feature
|Platform |Supported since |
|----------|-------------------|
|macOS |nightly builds only|
|Windows |nightly builds only|
|macOS |20220624-141144-bd1b7c5d|
|Windows |20220624-141144-bd1b7c5d|
|X11 |Not yet |
|Wayland |nightly builds only|
|Wayland |20220624-141144-bd1b7c5d|

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

@ -1,6 +1,6 @@
# `treat_east_asian_ambiguous_width_as_wide = false`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Unicode defines a number of codepoints as having [Ambiguous
Width](http://www.unicode.org/reports/tr11/#Ambiguous). These are characters

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

@ -71,7 +71,7 @@ for some usage examples and additional information about gradients.
## Linear gradient:
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
A linear gradient follows a linear path across the window. It can be rotated
around the window center. The angle is described in degrees and moves

2
docs/config/lua/gui-events/gui-startup.md
View File

@ -1,6 +1,6 @@
# `gui-startup`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The `gui-startup` event is emitted once when the GUI server is starting up
when running the `wezterm start` subcommand.

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

@ -1,6 +1,6 @@
# AttachDomain(domain_name)
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Attempts to attach the named multiplexing domain. The name can be any of the
names used in you `ssh_domains`, `unix_domains` or `tls_clients`

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

@ -1,6 +1,6 @@
# ClearSelection
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Clears the selection in the current pane.

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

@ -1,6 +1,6 @@
# DetachDomain(domain)
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Attempts to detach the specified domain. Detaching a domain causes
it to disconnect and remove its set of windows, tabs and panes from

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

@ -23,6 +23,6 @@ when unspecified, wezterm will use a default mode which at the time
of writing is `Cell`, but in a future release may be context sensitive
based on recent actions.
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The mode argument can also be `"Block"` to enable a rectangular block selection.

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

@ -1,6 +1,6 @@
# PaneSelect
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
This action activates the pane selection modal display. In this mode, each pane
will be overlayed with a one- or two-character label taken from the selection

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

@ -1,6 +1,6 @@
# RotatePanes
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Rotates the sequence of panes within the active tab, preserving the sizes based on the tab positions.

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

@ -27,7 +27,7 @@ return {
[Learn more about the search overlay](../../../scrollback.html#searching-the-scrollback)
*since: nightly builds only*
*since: 20220624-141144-bd1b7c5d*
You may now use `wezterm.action{Search="CurrentSelectionOrEmptyString"}` to have the search take the currently selected text as the item to search.

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

@ -27,6 +27,6 @@ return {
[See Shell Integration docs](../../../shell-integration.md) for more details on
how to set up your shell to define semantic zones.
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The mode argument can also be `"Block"` to enable a rectangular block selection.

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

@ -1,6 +1,6 @@
# SplitPane
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Splits the active pane in a particular direction, spawning a new command into the newly created pane.

2
docs/config/lua/mux-events/mux-startup.md
View File

@ -1,6 +1,6 @@
# `mux-startup`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The `mux-startup` event is emitted once when the mux server is starting up.
It is triggered before any default program is started.

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

@ -1,5 +1,5 @@
# `pane:get_domain_name()`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Returns the name of the domain with which the pane is associated.

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

@ -1,6 +1,6 @@
# `pane:get_foreground_process_info()`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Returns a [LocalProcessInfo](../LocalProcessInfo.md) object corresponding to the current foreground process that is running in the pane.

2
docs/config/lua/wezterm.mux/get_active_workspace.md
View File

@ -1,6 +1,6 @@
# `wezterm.mux.get_active_workspace()`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Returns the name of the active workspace.

2
docs/config/lua/wezterm.mux/get_pane.md
View File

@ -1,6 +1,6 @@
# `wezterm.mux.get_pane(PANE_ID)`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Given a pane ID, verifies that the ID is a valid pane known to the mux
and returns a [MuxPane](../MuxPane.md) object that can be used to

2
docs/config/lua/wezterm.mux/get_tab.md
View File

@ -1,6 +1,6 @@
# `wezterm.mux.get_tab(WINDOW_ID)`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Given a tab ID, verifies that the ID is a valid tab known to the mux
and returns a [MuxTab](../MuxTab.md) object that can be used to

2
docs/config/lua/wezterm.mux/get_window.md
View File

@ -1,6 +1,6 @@
# `wezterm.mux.get_window(WINDOW_ID)`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Given a window ID, verifies that the ID is a valid window known to the mux
and returns a [MuxWindow](../MuxWindow.md) object that can be used to

2
docs/config/lua/wezterm.mux/get_workspace_names.md
View File

@ -1,6 +1,6 @@
# `wezterm.mux.get_workspace_names()`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Returns a table containing the names of the workspaces known to the mux.

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

@ -1,4 +1,4 @@
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The `wezterm.mux` module exposes functions that operate on the multiplexer layer.

2
docs/config/lua/wezterm.mux/set_active_workspace.md
View File

@ -1,6 +1,6 @@
# `wezterm.mux.set_active_workspace(WORKSPACE)`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Sets the active workspace name.

2
docs/config/lua/wezterm.mux/spawn_window.md
View File

@ -1,6 +1,6 @@
## `wezterm.mux.spawn_window{}`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Spawns a program into a new window, returning the [MuxTab](../MuxTab.md),
[MuxPane](../MuxPane.md) and [MuxWindow](../MuxWindow.md) objects

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

@ -1,6 +1,6 @@
# `wezterm.GLOBAL`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Provides global, in-process, in-memory, data storage for json-like variables
that persists across config reloads.

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

@ -1,6 +1,6 @@
# `wezterm.strftime_utc(format)`
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
Formats the current UTC date/time into a string using [the Rust chrono
strftime syntax](https://docs.rs/chrono/0.4.19/chrono/format/strftime/index.html).

10
docs/config/mouse.md
View File

@ -32,16 +32,16 @@ that order.
| Double Left Down | `NONE` | `SelectTextAtMouseCursor="Word"` |
| Single Left Down | `NONE` | `SelectTextAtMouseCursor="Cell"` |
| Single Left Down | `SHIFT` | `ExtendSelectionToMouseCursor={}` |
| Single Left Down | `ALT` | `SelectTextAtMouseCursor="Block"` (*since: nightly builds only*) |
| Single Left Down | `ALT` | `SelectTextAtMouseCursor="Block"` (*since: 20220624-141144-bd1b7c5d*) |
| Single Left Up | `SHIFT` | `CompleteSelectionOrOpenLinkAtMouseCursor="PrimarySelection"` |
| Single Left Up | `NONE` | `CompleteSelectionOrOpenLinkAtMouseCursor="PrimarySelection"` |
| Single Left Up | `ALT` | `CompleteSelection="PrimarySelection"` (*since: nightly builds only*) |
| Single Left Up | `ALT` | `CompleteSelection="PrimarySelection"` (*since: 20220624-141144-bd1b7c5d*) |
| Double Left Up | `NONE` | `CompleteSelection="PrimarySelection"` |
| Triple Left Up | `NONE` | `CompleteSelection="PrimarySelection"` |
| Single Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Cell"` |
| Single Left Drag | `ALT` | `ExtendSelectionToMouseCursor="Block"` (*since: nightly builds only*) |
| Single Left Down | `ALT+SHIFT` | `ExtendSelectionToMouseCursor="Block"` (*since: nightly builds only*) |
| Single Left Up | `ALT+SHIFT` | `CompleteSelection="PrimarySelection"` (*since: nightly builds only*) |
| Single Left Drag | `ALT` | `ExtendSelectionToMouseCursor="Block"` (*since: 20220624-141144-bd1b7c5d*) |
| Single Left Down | `ALT+SHIFT` | `ExtendSelectionToMouseCursor="Block"` (*since: 20220624-141144-bd1b7c5d*) |
| Single Left Up | `ALT+SHIFT` | `CompleteSelection="PrimarySelection"` (*since: 20220624-141144-bd1b7c5d*) |
| Double Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Word"` |
| Triple Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Line"` |
| Single Middle Down | `NONE` | `PasteFrom="PrimarySelection"` |

4
docs/copymode.md
View File

@ -34,7 +34,7 @@ reassignable.
| | `q` |
| Cell selection | `v` |
| Line selection | `V` |
| Rectangular selection | `CTRL-v` (*since: nightly builds only*)|
| Rectangular selection | `CTRL-v` (*since: 20220624-141144-bd1b7c5d*)|
| Move Left | `LeftArrow`|
| | `h` |
| Move Down | `DownArrow`|
@ -70,7 +70,7 @@ reassignable.
### Configurable Key Assignments
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The key assignments for copy mode are specified by the `copy_mode` [Key Table](config/key-tables.md).

2
docs/faq.md
View File

@ -293,7 +293,7 @@ When a cursor is needed, the XCursor theme is tried first:
If no XCursor was found, wezterm will fall back to using the default X11 cursor
font provided by the system.
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
When troubleshooting xcursor issues, you can enable tracing by turning on the log level shown
below, and then moving the mouse over the wezterm window:

2
docs/scrollback.md
View File

@ -87,7 +87,7 @@ When the search overlay is active the behavior of wezterm changes:
#### Configurable search mode key assignments
*Since: nightly builds only*
*Since: 20220624-141144-bd1b7c5d*
The key assignments for copy mode are specified by the `search_mode` [Key Table](config/key-tables.md).