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

docs: update for version 20210314-114017-04b7cedd

Browse Source
This commit is contained in:
Wez Furlong 2021-03-14 11:55:12 -07:00
parent 04b7cedd02
commit 46227a741f
34 changed files with 40 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/changelog.md
View File

@ -10,6 +10,10 @@ daily) from the master branch. It may not be usable and
the feature set may change. As features stabilize some
brief notes about them may accumulate here.
* Not yet!
### 20210314-114017-04b7cedd
* New: [tab_bar_style](config/lua/config/tab_bar_style.md) allows customizing the appearance of the rest of tha tab bar.
* New: animated gif and png images displayed via `wezterm imgcat` (the iTerm2 image protocol), or attached to the window background via [window_background_image](config/appearance.html#window-background-image) will now animate while the window has focus.
* New: added [foreground_text_hsb](config/lua/config/foreground_text_hsb.md) setting to adjust hue, saturation and brightness when text is rendered.

6
docs/config/files.md
View File

@ -4,11 +4,11 @@
configuration file in the following locations, stopping at the first file that
it finds:
* (in the nightly builds) if the `--config-file` CLI argument was specified, then
* (since version 20210314-114017-04b7cedd) if the `--config-file` CLI argument was specified, then
that path will be used. If that path fails to load, then the defaults will be
used instead.
* If the environment variable `$WEZTERM_CONFIG_FILE` is set, it will be treated as the
path to a configuration file. In the nightly builds: if that path fails to load
path to a configuration file. Since version 20210314-114017-04b7cedd: if that path fails to load
then the defaults will be used instead. In earlier releases, the following steps
would be used as a fallback.
* On Windows, `wezterm.lua` from the directory that contains `wezterm.exe`.
@ -30,7 +30,7 @@ many copies of wezterm, or are frequently reloading your config file.
### Configuration Overrides
*since: nightly builds only*
*since: 20210314-114017-04b7cedd*
`wezterm` allows overriding configuration values via the command line; here are
a couple of examples:

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

@ -1,6 +1,6 @@
## `custom_block_glyphs = true`
*Since: nightly builds only*
*Since: 20210314-114017-04b7cedd*
When set to `true` (the default), WezTerm will compute its own idea of what the
[U2580](https://www.unicode.org/charts/PDF/U2580.pdf) unicode block elements

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

@ -13,7 +13,7 @@ The default value is system specific:
|macOS |72.0 |144.0 |
|Windows |Probed from the display |Probed from the display |
|X11 |96.0 |96.0 |
|X11 (*nightly builds of WezTerm*)|Probed from `Xft.dpi`, fallback to 96.0 |Probed from `Xft.dpi`, fallback to 96.0 |
|X11 (*version 20210314-114017-04b7cedd and later*)|Probed from `Xft.dpi`, fallback to 96.0 |Probed from `Xft.dpi`, fallback to 96.0 |
|Wayland |96.0 |192.0 |
In macOS and Wayland environments there isn't strictly a system DPI value that

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

@ -1,6 +1,6 @@
## `exit_behavior = "CloseOnCleanExit"`
*Since: nightly builds only*
*Since: 20210314-114017-04b7cedd*
Controls the behavior when the shell program spawned by the terminal exits.
There are three possible values:

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

@ -1,6 +1,6 @@
# `font_antialias = "Greyscale"`
*Deprecated in the nightly; this option no longer does anything and will be removed in a future release. Use [freetype_load_target](freetype_load_target.md) instead*
*Deprecated starting in version 20210314-114017-04b7cedd; this option no longer does anything and will be removed in a future release. Use [freetype_load_target](freetype_load_target.md) instead*
Adjusts the anti-aliasing portion of the font rasterizer.

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

@ -1,6 +1,6 @@
# `font_hinting = "Full"`
*Deprecated in the nightly; this option no longer does anything and will be removed in a future release. Use [freetype_load_target](freetype_load_target.md) instead*
*Deprecated starting in version 20210314-114017-04b7cedd; this option no longer does anything and will be removed in a future release. Use [freetype_load_target](freetype_load_target.md) instead*
Adjust the hinting portion of the font rasterizer.

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: nightly builds*
*Since: 20210314-114017-04b7cedd*
The default font size is now `12.0` points.

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

@ -1,6 +1,6 @@
# foreground_text_hsb
*Since: nightly builds only*
*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: nightly*
*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: nightly*
*Since: 20210314-114017-04b7cedd*
Configures the rendering mode used with the freetype rasterizer.
The following values are possible:

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

@ -1,6 +1,6 @@
# `status_update_interval = 1000`
*Since: nightly builds only*
*Since: 20210314-114017-04b7cedd*
Specifies the number of milliseconds that need to elapse between triggering the
[update-right-status](../window-events/update-right-status.md) hook.

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

@ -1,6 +1,6 @@
# `tab_bar_style`
*Since: nightly builds only*
*Since: 20210314-114017-04b7cedd*
This config option allows styling the elements that appear in the tab bar.
This configuration supplements the [tab bar color](../../../config/appearance.html#tab-bar-appearance--colors)

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

@ -1,6 +1,6 @@
# `treat_left_ctrlalt_as_altgr = false`
*since: nightly*
*since: 20210314-114017-04b7cedd*
If you are using a layout with an *AltGr* key, you may experience issues
when running inside a VNC session, because VNC emulates the AltGr keypresses

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

@ -1,6 +1,6 @@
# `window_decorations = "TITLE | RESIZE"`
*Since nightly builds only*
*Since 20210314-114017-04b7cedd*
Configures whether the window has a title bar and/or resizable border.

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

@ -1,6 +1,6 @@
# ResetFontAndWindowSize
*Since: nightly builds only*
*Since: 20210314-114017-04b7cedd*
Reset both the font size and the terminal dimensions for the current window to
the values specified by your `font`, `initial_rows`, and `initial_cols` configuration.

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

@ -1,6 +1,6 @@
# ScrollByLine
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
Adjusts the scroll position by the number of lines specified by the argument.
Negative values scroll upwards, while positive values scroll downwards.

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

@ -1,6 +1,6 @@
# StartWindowDrag
*since: nightly builds only*
*since: 20210314-114017-04b7cedd*
Places the window in the drag-to-move state, which means that the window will
move to follow your mouse pointer until the mouse button is released.

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

@ -1,6 +1,6 @@
# `wezterm.battery_info()`
*Since: nightly builds only*
*Since: 20210314-114017-04b7cedd*
This function returns battery information for each of the installed
batteries on the system. This is useful for example to assemble

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

@ -1,6 +1,6 @@
# `wezterm.format({})`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
`wezterm.format` can be used to produce a formatted string
with terminal graphic attributes such as bold, italic and colors.

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

@ -1,6 +1,6 @@
# `wezterm.log_info(msg)`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
This function logs the provided message string through wezterm's logging layer
at 'INFO' level. If you started wezterm from a terminal that text will print

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

@ -1,6 +1,6 @@
# `wezterm.log_warn(msg)`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
This function logs the provided message string through wezterm's logging layer
at 'WARN' level. If you started wezterm from a terminal that text will print

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

@ -1,6 +1,6 @@
# `wezterm.strftime(format)`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
Formats the current local date/time into a string using [the Rust chrono
strftime syntax](https://docs.rs/chrono/0.4.19/chrono/format/strftime/index.html).

2
docs/config/lua/window-events/update-right-status.md
View File

@ -1,6 +1,6 @@
# `update-right-status`
*Since: nightly builds only*
*Since: 20210314-114017-04b7cedd*
The `update-right-status` event is emitted periodically (based on the
interval specified by the [status_update_interval](../config/status_update_interval.md)

2
docs/config/lua/window-events/window-config-reloaded.md
View File

@ -1,6 +1,6 @@
# `window-config-reloaded`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
The `window-config-reloaded` event is emitted when the configuration for a
window has been reloaded. This can occur when the configuration file is

2
docs/config/lua/window-events/window-resized.md
View File

@ -1,6 +1,6 @@
# `window-resized`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
The `window-resized` event is emitted when the window is resized and when
transitioning between full-screen and regular windowed mode.

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

@ -1,6 +1,6 @@
# `window:effective_config()`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
Returns a lua table representing the effective configuration for the Window.
The table is in the same format as that used to specify the config in

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

@ -1,6 +1,6 @@
# `window:get_config_overrides()`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
Returns a copy of the current set of configuration overrides that is in effect
for the window.

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

@ -1,6 +1,6 @@
# `window:set_config_overrides(overrides)`
*Since: nightly*
*Since: 20210314-114017-04b7cedd*
Changes the set of configuration overrides for the window.
The config file is re-evaluated and any CLI overrides are

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

@ -1,6 +1,6 @@
# `window:set_right_status(string)`
*Since: nightly builds only*
*Since: 20210314-114017-04b7cedd*
This method can be used to change the content that is displayed in the tab bar,
to the right of the tabs and new tab button. The content is displayed

4
docs/config/mouse.md
View File

@ -25,8 +25,8 @@ that order.
| Double Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Word"` |
| Triple Left Drag | `NONE` | `ExtendSelectionToMouseCursor="Line"` |
| Single Middle Down | `NONE` | `PasteFrom="PrimarySelection"` |
| Single Left Drag | `SUPER` | `StartWindowDrag` (*since nightly*) |
| Single Left Drag | `CTRL|SHIFT` | `StartWindowDrag` (*since nightly*) |
| Single Left Drag | `SUPER` | `StartWindowDrag` (*since 20210314-114017-04b7cedd*) |
| Single Left Drag | `CTRL|SHIFT` | `StartWindowDrag` (*since 20210314-114017-04b7cedd*) |
If you don't want the default assignments to be registered, you can
disable all of them with this configuration; if you chose to do this,

2
docs/faq.md
View File

@ -158,7 +158,7 @@ environment.
## How do I enable undercurl (curly underlines)?
Starting in the nightly builds, WezTerm has support for colored and curly underlines.
Starting in version 20210314-114017-04b7cedd, WezTerm has support for colored and curly underlines.
The relevant escape sequences are:

2
docs/features.md
View File

@ -10,7 +10,7 @@
* Render underline, double-underline, italic, bold, strikethrough (most other terminal emulators do not support as many render attributes)
* Configuration via a <a href="config/files.html">configuration file</a> with hot reloading
* Multiple Windows (Hotkey: `Super-N`)
* Splits/Panes (currently only in the nightly builds)
* Splits/Panes
* Tabs (Hotkey: `Super-T`, next/prev: `Super-[` and `Super-]`, go-to: `Super-[1-9]`)
<video width="80%" controls src="screenshots/wezterm-tabs.mp4" loop></video>
* [SSH client with native tabs](ssh.html)

2
docs/shell-integration.md
View File

@ -16,7 +16,7 @@ shell program to emit the escape sequences at the appropriate place.
You can find some [examples for various shells in the wezterm
repo](https://github.com/wez/wezterm/tree/main/assets/shell-integration).
In the most recently nightly builds the Fedora and Debian packages
Starting with version 20210314-114017-04b7cedd, the Fedora and Debian packages
automatically activate shell integration for Bash and Zsh.
If you're on another system, more information on how these escapes work