1
1
mirror of https://github.com/wez/wezterm.git synced 2024-11-22 13:16:39 +03:00

docs: add tags to a number of pages

This commit is contained in:
Wez Furlong 2023-04-08 07:48:40 -07:00
parent 36d5307b80
commit 84f7fb9f3b
No known key found for this signature in database
GPG Key ID: 7A7F66A31EC9B387
195 changed files with 948 additions and 1 deletions

View File

@ -1,3 +1,11 @@
---
search:
boost: 20
keywords: default keys key
tags:
- keys
---
The default key assignments are shown in the table below.
You may also use `wezterm show-keys --lua` to see the assignments

View File

@ -1,3 +1,8 @@
---
tags:
- font
---
# `adjust_window_size_when_changing_font_size = true`
{{since('20210203-095643-70a364eb')}}

View File

@ -1,3 +1,8 @@
---
tags:
- font
---
# `allow_square_glyphs_to_overflow_width = "Never"`
{{since('20210203-095643-70a364eb')}}

View File

@ -1,3 +1,7 @@
---
tags:
- keys
---
# `allow_win32_input_mode`
{{since('20220319-142410-0fcdea07')}}

View File

@ -1,3 +1,7 @@
---
tags:
- mouse
---
# `alternate_buffer_wheel_scroll_speed = 3`
{{since('20210203-095643-70a364eb')}}

View File

@ -1,3 +1,7 @@
---
tags:
- tuning
---
# `animation_fps = 10`
{{since('20220319-142410-0fcdea07')}}

View File

@ -1,3 +1,7 @@
---
tags:
- bell
---
# `audible_bell`
{{since('20211204-082213-a66c61ee9')}}

View File

@ -1,3 +1,7 @@
---
tags:
- reload
---
# `automatically_reload_config`
{{since('20201031-154415-9614e117')}}

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- background
---
# `background`
{{since('20220624-141144-bd1b7c5d')}}

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- font
---
# `bold_brightens_ansi_colors = true`
When true (the default), PaletteIndex 0-7 are shifted to bright when the font

View File

@ -1,3 +1,7 @@
---
tags:
- mouse
---
# `bypass_mouse_reporting_modifiers = "SHIFT"`
{{since('20210814-124438-54e29167')}}

View File

@ -1,3 +1,7 @@
---
tags:
- clipboard
---
# `canonicalize_pasted_newlines`
{{since('20211204-082213-a66c61ee9')}}

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `cell_width = 1.0`
{{since('20220624-141144-bd1b7c5d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- updates
---
# `check_for_updates` & `check_for_updates_interval_seconds`
Wezterm checks regularly if there is a new stable version available

View File

@ -1,3 +1,7 @@
---
tags:
- exit_behavior
---
## `clean_exit_codes = { 0 }`
{{since('20220624-141144-bd1b7c5d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- color
---
# `color_schemes`
Specifies various named color schemes in your configuration file.

View File

@ -1,3 +1,7 @@
---
tags:
- color
---
# `colors`
Specifies the color palette.

View File

@ -1,3 +1,8 @@
---
tags:
- color
- command_palette
---
# `command_palette_bg_color = "#333333"`
{{since('20230320-124340-559cb7b0')}}

View File

@ -1,3 +1,8 @@
---
tags:
- color
- command_palette
---
# `command_palette_fg_color = rgba(0.75, 0.75, 0.75, 1.0)`
{{since('20230320-124340-559cb7b0')}}

View File

@ -1,3 +1,8 @@
---
tags:
- font
- command_palette
---
# `command_palette_font_size = 14.0`
{{since('20230320-124340-559cb7b0')}}

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- text_cursor
---
# `cursor_blink_ease_in = "Linear"`
{{since('20220319-142410-0fcdea07')}}

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- text_cursor
---
# `cursor_blink_ease_out = "Linear"`
{{since('20220319-142410-0fcdea07')}}

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- text_cursor
---
# `cursor_blink_rate`
Specifies how often a blinking cursor transitions between visible and

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- text_cursor
---
# `cursor_thickness`
{{since('20221119-145034-49b9839f')}}

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- font
---
## `custom_block_glyphs = true`
{{since('20210314-114017-04b7cedd')}}

View File

@ -1,3 +1,7 @@
---
tags:
- multiplexing
---
# `daemon_options`
Allows configuring the multiplexer (mux) server and how it places itself into

View File

@ -1,3 +1,8 @@
---
tags:
- keys
- debug
---
# `debug_key_events = false`
When set to true, each key event will be logged by the GUI layer as an INFO

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- text_cursor
---
# `default_cursor_style = "SteadyBlock"`
Specifies the default cursor style. Various escape sequences

View File

@ -1,3 +1,7 @@
---
tags:
- spawn
---
# `default_cwd`
{{since('20210203-095643-70a364eb')}}

View File

@ -1,3 +1,7 @@
---
tags:
- multiplexing
---
# `default_domain = "local"`
{{since('20220319-142410-0fcdea07')}}

View File

@ -1,3 +1,7 @@
---
tags:
- event
---
# `default_gui_startup_args = {"start"}`
{{since('20220101-133340-7edc5b5a')}}

View File

@ -1,3 +1,7 @@
---
tags:
- spawn
---
# `default_prog`
If no `prog` is specified on the command line, use this

View File

@ -1,3 +1,8 @@
---
tags:
- multiplexing
- workspace
---
# `default_workspace = "default"`
{{since('20220319-142410-0fcdea07')}}

View File

@ -1,3 +1,7 @@
---
tags:
- mouse
---
# `disable_default_mouse_bindings = false`
If set to true, the default mouse assignments will not be used, allowing

View File

@ -1,3 +1,7 @@
---
tags:
- quick_select
---
# `disable_default_quick_select_patterns = false`
{{since('20210502-130208-bff6815d')}}

View File

@ -1,3 +1,8 @@
---
tags:
- font
- appearance
---
# `display_pixel_geometry = "RGB"`
{{since('nightly')}}

View File

@ -1,3 +1,8 @@
---
tags:
- font
- appearance
---
# `dpi`
Override the detected DPI (dots per inch) for the display.

View File

@ -1,3 +1,7 @@
---
tags:
- keys
---
# `enable_csi_u_key_encoding = false`
When set to `true`, the [keyboard encoding](../../key-encoding.md) will be

View File

@ -1,3 +1,7 @@
---
tags:
- keys
---
# `enable_kitty_keyboard = false`
{{since('20220624-141144-bd1b7c5d')}}

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- scroll_bar
---
# `enable_scroll_bar`
Enable the scrollbar. This is currently disabled by default.

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- tab_bar
---
# `enable_tab_bar = true`
Controls whether the tab bar is enabled.

View File

@ -1,3 +1,7 @@
---
tags:
- exit_behavior
---
## `exit_behavior = "CloseOnCleanExit"`
{{since('20210314-114017-04b7cedd')}}

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font`
Configures the font to use by default. The `font` setting can specify

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font_antialias = "Greyscale"`
*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*

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font_dirs`
By default, wezterm will use an appropriate system-specific method for

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font_hinting = "Full"`
*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*

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font_locator`
specifies the method by which system fonts are located and loaded. You may

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font_rasterizer`
Specifies the method by which fonts are rendered on screen. The only available

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font_rules`
When textual output in the terminal is styled with bold, italic or other

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font_shaper`
specifies the method by which text is mapped to glyphs in the available fonts.

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `font_size = 10.0`
Specifies the size of the font, measured in points.

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- text_cursor
---
# `force_reverse_video_cursor = false`
{{since('20210502-130208-bff6815d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- appearance
---
# `foreground_text_hsb`
{{since('20210314-114017-04b7cedd')}}

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `freetype_interpreter_version`
Selects the freetype interpret version to use. Possible values are `35`, `38`

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `freetype_load_flags = "DEFAULT"`
{{since('20210314-114017-04b7cedd')}}

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `freetype_load_target = "Normal"`
{{since('20210314-114017-04b7cedd')}}

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `freetype_pcf_long_family_names = false`
{{since('20220624-141144-bd1b7c5d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `freetype_render_target = "Normal"`
{{since('20210502-130208-bff6815d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- gpu
---
# `front_end = "OpenGL"`
Specifies which render front-end to use. This option used to have

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `harfbuzz_features`
When `font_shaper = "Harfbuzz"`, this setting affects how font shaping

View File

@ -1,3 +1,8 @@
---
tags:
- mouse_cursor
- appearance
---
# `hide_mouse_cursor_when_typing`
{{since('20230320-124340-559cb7b0')}}

View File

@ -1,3 +1,8 @@
---
tags:
- tab_bar
- appearance
---
# `hide_tab_bar_if_only_one_tab = false`
If set to true, when there is only a single tab, the tab bar is

View File

@ -1,3 +1,7 @@
---
tags:
- hyperlink
---
# `hyperlink_rules`
Defines rules to match text from the terminal output and generate

View File

@ -1,3 +1,8 @@
---
tags:
- keys
- appearance
---
# `ime_preedit_rendering`
{{since('20220624-141144-bd1b7c5d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- spawn
---
# `initial_cols = 80`
Together with [initial_rows](initial_rows.md), configures the window size

View File

@ -1,3 +1,7 @@
---
tags:
- spawn
---
# `initial_rows = 24`
Together with [initial_cols](initial_cols.md), configures the window size

View File

@ -1,3 +1,7 @@
---
tags:
- appearance
---
# `integrated_title_button_alignment = "Right"`
{{since('nightly')}}

View File

@ -1,3 +1,7 @@
---
tags:
- appearance
---
# `integrated_title_button_color = "Auto"`
{{since('nightly')}}

View File

@ -1,3 +1,7 @@
---
tags:
- appearance
---
# `integrated_title_button_style = STYLE`
{{since('nightly')}}

View File

@ -1,3 +1,7 @@
---
tags:
- appearance
---
# `integrated_title_button_style = BUTTONS`
{{since('nightly')}}

View File

@ -1,3 +1,7 @@
---
tags:
- keys
---
# `key_map_preference = "Mapped"`
{{since('20220408-101518-b908e2dd')}}

View File

@ -1,3 +1,7 @@
---
tags:
- keys
---
# `key_tables = {}`
See the main [Key Tables](../../key-tables.md) docs!

View File

@ -1,3 +1,8 @@
---
tags:
- spawn
- launch_menu
---
# `launch_menu`
{{since('20200503-171512-b13ef15f')}}

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `line_height = 1.0`
Scales the computed line height to adjust the spacing between successive rows

View File

@ -1,3 +1,7 @@
---
tags:
- keys
---
# `macos_forward_to_ime_modifier_mask = "SHIFT"`
{{since('nightly')}}

View File

@ -1,3 +1,7 @@
---
tags:
- appearance
---
# `macos_window_background_blur = 0`
{{since('20230326-111934-3666303c')}}

View File

@ -1,3 +1,7 @@
---
tags:
- tuning
---
# `max_fps = 60`
Limits the maximum number of frames per second that wezterm will

View File

@ -1,3 +1,8 @@
---
tags:
- appearance
- scroll_bar
---
# `min_scroll_bar_height = "0.5cell"`
{{since('20220624-141144-bd1b7c5d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- mouse
---
# `mouse_wheel_scrolls_tabs`
{{since('20230326-111934-3666303c')}}

View File

@ -1,3 +1,8 @@
---
tags:
- multiplexing
- spawn
---
# `mux_env_remove`
{{since('20211204-082213-a66c61ee9')}}

View File

@ -1,3 +1,7 @@
---
tags:
- appearance
---
# `native_macos_fullscreen_mode = false`
Specifies whether the [ToggleFullScreen](../../lua/keyassignment/ToggleFullScreen.md)

View File

@ -1,3 +1,7 @@
---
tags:
- unicode
---
# `normalize_output_to_unicode_nfc = false`
{{since('20221119-145034-49b9839f')}}

View File

@ -1,3 +1,7 @@
---
tags:
- mouse
---
# `pane_focus_follows_mouse = false`
{{since('20210502-130208-bff6815d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- tuning
---
# `prefer_egl = true`
Depending on the OS and windowing environment, there are a number of different

View File

@ -1,3 +1,7 @@
---
tags:
- quick_select
---
# `quick_select_alphabet`
{{since('20210502-130208-bff6815d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- quick_select
---
# `quick_select_patterns`
{{since('20210502-130208-bff6815d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- keys
---
# `scroll_to_bottom_on_input`
When `true` (the default), the viewport will automatically scroll to the

View File

@ -1,3 +1,7 @@
---
tags:
- scroll_bar
---
# `scrollback_lines = 3500`
How many lines of scrollback you want to retain.

View File

@ -1,3 +1,7 @@
---
tags:
- mouse
---
# `selection_word_boundary`
{{since('20210203-095643-70a364eb')}}

View File

@ -1,3 +1,7 @@
---
tags:
- serial
---
# `serial_ports = {}`
{{since('nightly')}}

View File

@ -1,3 +1,7 @@
---
tags:
- spawn
---
# `set_environment_variables`
Specifies a map of environment variables that should be set when spawning new

View File

@ -1,3 +1,7 @@
---
tags:
- tab_bar
---
# `show_new_tab_button_in_tab_bar = true`
{{since('20221119-145034-49b9839f')}}

View File

@ -1,3 +1,7 @@
---
tags:
- tab_bar
---
# `show_tab_index_in_tab_bar = true`
When set to `true` (the default), tab titles show their tab number (tab index) with a

View File

@ -1,3 +1,7 @@
---
tags:
- tab_bar
---
# `show_tabs_in_tab_bar = true`
{{since('20221119-145034-49b9839f')}}

View File

@ -1,3 +1,7 @@
---
tags:
- updates
---
# `show_update_window`
When Wezterm checks for an update and detects a new version, this

View File

@ -1,3 +1,7 @@
---
tags:
- exit_behavior
---
# `skip_close_confirmation_for_processes_named`
{{since('20210404-112810-b63a949d')}}

View File

@ -1,3 +1,7 @@
---
tags:
- ssh
---
# `ssh_backend = "Libssh"`
{{since('20211204-082213-a66c61ee9')}}

View File

@ -1,3 +1,8 @@
---
tags:
- ssh
- multiplexing
---
# `ssh_domains`
Configures SSH multiplexing domains. [Read more about SSH Domains](

View File

@ -1,3 +1,7 @@
---
tags:
- status
---
# `status_update_interval = 1000`
{{since('20210314-114017-04b7cedd')}}

View File

@ -1,3 +1,7 @@
---
tags:
- font
---
# `strikethrough_position`
{{since('20221119-145034-49b9839f')}}

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