Switch to TOML configuration format
This switches Alacritty's default configuration format from yaml to toml. While yaml is still supported, it is done by converting it to toml and should be removed entirely in the future. All existing features were persisted based on my testing. Behavior should not change much, though `--option` might have slightly different behavior since the entire line is not interpreted as one line of toml. A new `alacritty migrate` subcommand has been added which allows automatic migration from yaml to toml. This also could be used as a facility to automatically fix configuration file changes in the future. Closes #6592.
This commit is contained in:
Christian Duerr
GitHub
parent
ea2c39e65d
commit
bd4906722a
|
|
@ -10,10 +10,6 @@ insert_final_newline = true
|
|||
indent_style = space
|
||||
indent_size = 4
|
||||
|
||||
[*.yml]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[Makefile]
|
||||
indent_style = tab
|
||||
|
||||
|
|
|
|||
|
|
@ -76,6 +76,8 @@ jobs:
|
|||
run: |
|
||||
scdoc < extra/man/alacritty.1.scd | gzip -c > "./alacritty.1.gz"
|
||||
scdoc < extra/man/alacritty-msg.1.scd | gzip -c > "./alacritty-msg.1.gz"
|
||||
scdoc < extra/man/alacritty.5.scd | gzip -c > "./alacritty.5.gz"
|
||||
scdoc < extra/man/alacritty-bindings.5.scd | gzip -c > "./alacritty-bindings.5.gz"
|
||||
- name: Upload Assets
|
||||
run: |
|
||||
mv ./extra/logo/alacritty-term.svg ./Alacritty.svg
|
||||
|
|
@ -87,4 +89,3 @@ jobs:
|
|||
./.github/workflows/upload_asset.sh ./extra/completions/_alacritty $GITHUB_TOKEN
|
||||
./.github/workflows/upload_asset.sh ./extra/linux/Alacritty.desktop $GITHUB_TOKEN
|
||||
./.github/workflows/upload_asset.sh ./extra/alacritty.info $GITHUB_TOKEN
|
||||
./.github/workflows/upload_asset.sh ./alacritty.yml $GITHUB_TOKEN
|
||||
|
|
|
|||
16
CHANGELOG.md
16
CHANGELOG.md
|
|
@ -12,16 +12,32 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|||
- Minimum Rust version has been bumped to 1.65.0
|
||||
- Manpages are now generated using `scdoc` (see `INSTALL.md`)
|
||||
|
||||
### Added
|
||||
|
||||
- Warnings for unused configuration file options
|
||||
|
||||
### Changed
|
||||
|
||||
- Mode-specific bindings can now be bound in any mode for easier macros
|
||||
- `--help` output is more compact now and uses more neutral palette
|
||||
- Configuration file now uses TOML instead of YAML
|
||||
Run `alacritty migrate` to automatically convert all configuration files
|
||||
- Deprecated config option `draw_bold_text_with_bright_colors`, use
|
||||
`colors.draw_bold_text_with_bright_colors`
|
||||
- Deprecated config option `key_bindings`, use `keyboard.bindings`
|
||||
- Deprecated config option `mouse_bindings`, use `mouse.bindings`
|
||||
|
||||
### Fixed
|
||||
|
||||
- Hyperlink preview not being shown when the terminal has exactly 2 lines
|
||||
- Crash on Windows when changing display scale factor
|
||||
|
||||
### Removed
|
||||
|
||||
- Config option `background_opacity`, use `window.background_opacity`
|
||||
- Config option `colors.search.bar`, use `colors.footer_bar` instead
|
||||
- Config option `mouse.url`, use the `hints` config section
|
||||
|
||||
## 0.12.1
|
||||
|
||||
### Fixed
|
||||
|
|
|
|||
|
|
@ -86,8 +86,7 @@ Latency is another important factor for Alacritty. On X11, Windows, and macOS th
|
|||
Code should be documented where appropriate. The existing code can be used as a guidance here and
|
||||
the general `rustfmt` rules can be followed for formatting.
|
||||
|
||||
If any change has been made to the `config.rs` file, these changes should also be documented in the
|
||||
example configuration file `alacritty.yml`.
|
||||
If any change has been made to the `config.rs` file, it should also be documented in the man pages.
|
||||
|
||||
Changes compared to the latest Alacritty release which have a direct effect on the user (opposed to
|
||||
things like code refactorings or documentation/tests) additionally need to be documented in the
|
||||
|
|
|
|||
|
|
@ -38,6 +38,7 @@ dependencies = [
|
|||
"serde",
|
||||
"serde_json",
|
||||
"serde_yaml",
|
||||
"toml 0.7.4",
|
||||
"unicode-width",
|
||||
"wayland-client",
|
||||
"windows-sys 0.48.0",
|
||||
|
|
@ -52,7 +53,7 @@ version = "0.1.2-dev"
|
|||
dependencies = [
|
||||
"log",
|
||||
"serde",
|
||||
"serde_yaml",
|
||||
"toml 0.7.4",
|
||||
"winit",
|
||||
]
|
||||
|
||||
|
|
@ -65,8 +66,8 @@ dependencies = [
|
|||
"proc-macro2",
|
||||
"quote",
|
||||
"serde",
|
||||
"serde_yaml",
|
||||
"syn 2.0.18",
|
||||
"toml 0.7.4",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
|
|
@ -92,6 +93,7 @@ dependencies = [
|
|||
"serde_yaml",
|
||||
"signal-hook",
|
||||
"signal-hook-mio",
|
||||
"toml 0.7.4",
|
||||
"unicode-width",
|
||||
"vte",
|
||||
"windows-sys 0.48.0",
|
||||
|
|
@ -585,7 +587,7 @@ checksum = "e62abb876c07e4754fae5c14cafa77937841f01740637e17d78dc04352f32a5e"
|
|||
dependencies = [
|
||||
"cc",
|
||||
"rustc_version",
|
||||
"toml",
|
||||
"toml 0.5.11",
|
||||
"vswhom",
|
||||
"winreg",
|
||||
]
|
||||
|
|
@ -1663,6 +1665,15 @@ dependencies = [
|
|||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde_spanned"
|
||||
version = "0.6.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "93107647184f6027e3b7dcb2e11034cf95ffa1e3a682c67951963ac69c1c007d"
|
||||
dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde_yaml"
|
||||
version = "0.8.26"
|
||||
|
|
@ -1886,11 +1897,26 @@ dependencies = [
|
|||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml"
|
||||
version = "0.7.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d6135d499e69981f9ff0ef2167955a5333c35e36f6937d382974566b3d5b94ec"
|
||||
dependencies = [
|
||||
"serde",
|
||||
"serde_spanned",
|
||||
"toml_datetime",
|
||||
"toml_edit",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml_datetime"
|
||||
version = "0.6.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5a76a9312f5ba4c2dec6b9161fdf25d87ad8a09256ccea5a556fef03c706a10f"
|
||||
dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml_edit"
|
||||
|
|
@ -1899,6 +1925,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
|||
checksum = "2380d56e8670370eee6566b0bfd4265f65b3f432e8c6d85623f728d4fa31f739"
|
||||
dependencies = [
|
||||
"indexmap",
|
||||
"serde",
|
||||
"serde_spanned",
|
||||
"toml_datetime",
|
||||
"winnow",
|
||||
]
|
||||
|
|
|
|||
|
|
@ -333,6 +333,8 @@ Installing the manual page requires the additional dependencies `gzip` and `scdo
|
|||
sudo mkdir -p /usr/local/share/man/man1
|
||||
scdoc < extra/man/alacritty.1.scd | gzip -c | sudo tee /usr/local/share/man/man1/alacritty.1.gz > /dev/null
|
||||
scdoc < extra/man/alacritty-msg.1.scd | gzip -c | sudo tee /usr/local/share/man/man1/alacritty-msg.1.gz > /dev/null
|
||||
scdoc < extra/man/alacritty.5.scd | gzip -c | sudo tee /usr/local/share/man/man5/alacritty.5.gz > /dev/null
|
||||
scdoc < extra/man/alacritty-bindings.5.scd | gzip -c | sudo tee /usr/local/share/man/man5/alacritty-bindings.5.gz > /dev/null
|
||||
```
|
||||
|
||||
### Shell completions
|
||||
|
|
|
|||
6
Makefile
6
Makefile
|
|
@ -4,7 +4,8 @@ ASSETS_DIR = extra
|
|||
RELEASE_DIR = target/release
|
||||
MANPAGE = $(ASSETS_DIR)/man/alacritty.1.scd
|
||||
MANPAGE-MSG = $(ASSETS_DIR)/man/alacritty-msg.1.scd
|
||||
CONFIGFILE = alacritty.yml
|
||||
MANPAGE-CONFIG = $(ASSETS_DIR)/man/alacritty.5.scd
|
||||
MANPAGE-CONFIG-BINDINGS = $(ASSETS_DIR)/man/alacritty-bindings.5.scd
|
||||
TERMINFO = $(ASSETS_DIR)/alacritty.info
|
||||
COMPLETIONS_DIR = $(ASSETS_DIR)/completions
|
||||
COMPLETIONS = $(COMPLETIONS_DIR)/_alacritty \
|
||||
|
|
@ -48,10 +49,11 @@ $(APP_NAME)-%: $(TARGET)-%
|
|||
@mkdir -p $(APP_COMPLETIONS_DIR)
|
||||
@scdoc < $(MANPAGE) | gzip -c > $(APP_EXTRAS_DIR)/alacritty.1.gz
|
||||
@scdoc < $(MANPAGE-MSG) | gzip -c > $(APP_EXTRAS_DIR)/alacritty-msg.1.gz
|
||||
@scdoc < $(MANPAGE-CONFIG) | gzip -c > $(APP_EXTRAS_DIR)/alacritty.5.gz
|
||||
@scdoc < $(MANPAGE-CONFIG-BINDINGS) | gzip -c > $(APP_EXTRAS_DIR)/alacritty-bindings.5.gz
|
||||
@tic -xe alacritty,alacritty-direct -o $(APP_EXTRAS_DIR) $(TERMINFO)
|
||||
@cp -fRp $(APP_TEMPLATE) $(APP_DIR)
|
||||
@cp -fp $(APP_BINARY) $(APP_BINARY_DIR)
|
||||
@cp -fp $(CONFIGFILE) $(APP_EXTRAS_DIR)/
|
||||
@cp -fp $(COMPLETIONS) $(APP_COMPLETIONS_DIR)
|
||||
@touch -r "$(APP_BINARY)" "$(APP_DIR)/$(APP_NAME)"
|
||||
@codesign --remove-signature "$(APP_DIR)/$(APP_NAME)"
|
||||
|
|
|
|||
17
README.md
17
README.md
|
|
@ -52,22 +52,25 @@ For everyone else, the detailed instructions to install Alacritty can be found
|
|||
|
||||
## Configuration
|
||||
|
||||
You can find the default configuration file with documentation for all available
|
||||
fields on the [GitHub releases page](https://github.com/alacritty/alacritty/releases) for each release.
|
||||
You can find the documentation for Alacritty's configuration in `man 5
|
||||
alacritty`, or by looking at [the scdoc file] if you do not have the manpages
|
||||
installed.
|
||||
|
||||
[the scdoc file]: ./extra/man/alacritty.5.scd
|
||||
|
||||
Alacritty doesn't create the config file for you, but it looks for one in the
|
||||
following locations:
|
||||
|
||||
1. `$XDG_CONFIG_HOME/alacritty/alacritty.yml`
|
||||
2. `$XDG_CONFIG_HOME/alacritty.yml`
|
||||
3. `$HOME/.config/alacritty/alacritty.yml`
|
||||
4. `$HOME/.alacritty.yml`
|
||||
1. `$XDG_CONFIG_HOME/alacritty/alacritty.toml`
|
||||
2. `$XDG_CONFIG_HOME/alacritty.toml`
|
||||
3. `$HOME/.config/alacritty/alacritty.toml`
|
||||
4. `$HOME/.alacritty.toml`
|
||||
|
||||
### Windows
|
||||
|
||||
On Windows, the config file should be located at:
|
||||
|
||||
`%APPDATA%\alacritty\alacritty.yml`
|
||||
`%APPDATA%\alacritty\alacritty.toml`
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
|||
911
alacritty.yml
911
alacritty.yml
|
|
@ -1,911 +0,0 @@
|
|||
# Configuration for Alacritty, the GPU enhanced terminal emulator.
|
||||
|
||||
# Import additional configuration files
|
||||
#
|
||||
# Imports are loaded in order, skipping all missing files, with the importing
|
||||
# file being loaded last. If a field is already present in a previous import, it
|
||||
# will be replaced.
|
||||
#
|
||||
# All imports must either be absolute paths starting with `/`, or paths relative
|
||||
# to the user's home directory starting with `~/`.
|
||||
#import:
|
||||
# - /path/to/alacritty.yml
|
||||
|
||||
# Any items in the `env` entry below will be added as
|
||||
# environment variables. Some entries may override variables
|
||||
# set by alacritty itself.
|
||||
#env:
|
||||
# TERM variable
|
||||
#
|
||||
# This value is used to set the `$TERM` environment variable for
|
||||
# each instance of Alacritty. If it is not present, alacritty will
|
||||
# check the local terminfo database and use `alacritty` if it is
|
||||
# available, otherwise `xterm-256color` is used.
|
||||
#TERM: alacritty
|
||||
|
||||
#window:
|
||||
# Window dimensions (changes require restart)
|
||||
#
|
||||
# Number of lines/columns (not pixels) in the terminal. Both lines and columns
|
||||
# must be non-zero for this to take effect. The number of columns must be at
|
||||
# least `2`, while using a value of `0` for columns and lines will fall back
|
||||
# to the window manager's recommended size
|
||||
#dimensions:
|
||||
# columns: 0
|
||||
# lines: 0
|
||||
|
||||
# Window position (changes require restart)
|
||||
#
|
||||
# Specified in number of pixels.
|
||||
# If the position is not set, the window manager will handle the placement.
|
||||
#position:
|
||||
# x: 0
|
||||
# y: 0
|
||||
|
||||
# Window padding (changes require restart)
|
||||
#
|
||||
# Blank space added around the window in pixels. This padding is scaled
|
||||
# by DPI and the specified value is always added at both opposing sides.
|
||||
#padding:
|
||||
# x: 0
|
||||
# y: 0
|
||||
|
||||
# Spread additional padding evenly around the terminal content.
|
||||
#dynamic_padding: false
|
||||
|
||||
# Window decorations
|
||||
#
|
||||
# Values for `decorations`:
|
||||
# - full: Borders and title bar
|
||||
# - none: Neither borders nor title bar
|
||||
#
|
||||
# Values for `decorations` (macOS only):
|
||||
# - transparent: Title bar, transparent background and title bar buttons
|
||||
# - buttonless: Title bar, transparent background and no title bar buttons
|
||||
#decorations: full
|
||||
|
||||
# Background opacity
|
||||
#
|
||||
# Window opacity as a floating point number from `0.0` to `1.0`.
|
||||
# The value `0.0` is completely transparent and `1.0` is opaque.
|
||||
#opacity: 1.0
|
||||
|
||||
# Startup Mode (changes require restart)
|
||||
#
|
||||
# Values for `startup_mode`:
|
||||
# - Windowed
|
||||
# - Maximized
|
||||
# - Fullscreen
|
||||
#
|
||||
# Values for `startup_mode` (macOS only):
|
||||
# - SimpleFullscreen
|
||||
#startup_mode: Windowed
|
||||
|
||||
# Window title
|
||||
#title: Alacritty
|
||||
|
||||
# Allow terminal applications to change Alacritty's window title.
|
||||
#dynamic_title: true
|
||||
|
||||
# Window class (Linux/BSD only):
|
||||
#class:
|
||||
# Application instance name
|
||||
#instance: Alacritty
|
||||
# General application class
|
||||
#general: Alacritty
|
||||
|
||||
# Decorations theme variant
|
||||
#
|
||||
# Override the variant of the System theme/GTK theme/Wayland client side
|
||||
# decorations. Commonly supported values are `Dark`, `Light`, and `None` for
|
||||
# auto pick-up. Set this to `None` to use the default theme variant.
|
||||
#decorations_theme_variant: None
|
||||
|
||||
# Resize increments
|
||||
#
|
||||
# Prefer resizing window by discrete steps equal to cell dimensions.
|
||||
#resize_increments: false
|
||||
|
||||
# Make `Option` key behave as `Alt` (macOS only):
|
||||
# - OnlyLeft
|
||||
# - OnlyRight
|
||||
# - Both
|
||||
# - None (default)
|
||||
#option_as_alt: None
|
||||
|
||||
#scrolling:
|
||||
# Maximum number of lines in the scrollback buffer.
|
||||
# Specifying '0' will disable scrolling.
|
||||
#history: 10000
|
||||
|
||||
# Scrolling distance multiplier.
|
||||
#multiplier: 3
|
||||
|
||||
# Font configuration
|
||||
#font:
|
||||
# Normal (roman) font face
|
||||
#normal:
|
||||
# Font family
|
||||
#
|
||||
# Default:
|
||||
# - (macOS) Menlo
|
||||
# - (Linux/BSD) monospace
|
||||
# - (Windows) Consolas
|
||||
#family: monospace
|
||||
|
||||
# The `style` can be specified to pick a specific face.
|
||||
#style: Regular
|
||||
|
||||
# Bold font face
|
||||
#bold:
|
||||
# Font family
|
||||
#
|
||||
# If the bold family is not specified, it will fall back to the
|
||||
# value specified for the normal font.
|
||||
#family: monospace
|
||||
|
||||
# The `style` can be specified to pick a specific face.
|
||||
#style: Bold
|
||||
|
||||
# Italic font face
|
||||
#italic:
|
||||
# Font family
|
||||
#
|
||||
# If the italic family is not specified, it will fall back to the
|
||||
# value specified for the normal font.
|
||||
#family: monospace
|
||||
|
||||
# The `style` can be specified to pick a specific face.
|
||||
#style: Italic
|
||||
|
||||
# Bold italic font face
|
||||
#bold_italic:
|
||||
# Font family
|
||||
#
|
||||
# If the bold italic family is not specified, it will fall back to the
|
||||
# value specified for the normal font.
|
||||
#family: monospace
|
||||
|
||||
# The `style` can be specified to pick a specific face.
|
||||
#style: Bold Italic
|
||||
|
||||
# Point size
|
||||
#size: 11.0
|
||||
|
||||
# Offset is the extra space around each character. `offset.y` can be thought
|
||||
# of as modifying the line spacing, and `offset.x` as modifying the letter
|
||||
# spacing.
|
||||
#offset:
|
||||
# x: 0
|
||||
# y: 0
|
||||
|
||||
# Glyph offset determines the locations of the glyphs within their cells with
|
||||
# the default being at the bottom. Increasing `x` moves the glyph to the
|
||||
# right, increasing `y` moves the glyph upward.
|
||||
#glyph_offset:
|
||||
# x: 0
|
||||
# y: 0
|
||||
|
||||
# Use built-in font for box drawing characters.
|
||||
#
|
||||
# If `true`, Alacritty will use a custom built-in font for box drawing
|
||||
# characters (Unicode points 2500 - 259f).
|
||||
#
|
||||
#builtin_box_drawing: true
|
||||
|
||||
# If `true`, bold text is drawn using the bright color variants.
|
||||
#draw_bold_text_with_bright_colors: false
|
||||
|
||||
# Colors (Tomorrow Night)
|
||||
#colors:
|
||||
# Default colors
|
||||
#primary:
|
||||
# background: '#1d1f21'
|
||||
# foreground: '#c5c8c6'
|
||||
|
||||
# Bright and dim foreground colors
|
||||
#
|
||||
# The dimmed foreground color is calculated automatically if it is not
|
||||
# present. If the bright foreground color is not set, or
|
||||
# `draw_bold_text_with_bright_colors` is `false`, the normal foreground
|
||||
# color will be used.
|
||||
#dim_foreground: '#828482'
|
||||
#bright_foreground: '#eaeaea'
|
||||
|
||||
# Cursor colors
|
||||
#
|
||||
# Colors which should be used to draw the terminal cursor.
|
||||
#
|
||||
# Allowed values are CellForeground/CellBackground, which reference the
|
||||
# affected cell, or hexadecimal colors like #ff00ff.
|
||||
#cursor:
|
||||
# text: CellBackground
|
||||
# cursor: CellForeground
|
||||
|
||||
# Vi mode cursor colors
|
||||
#
|
||||
# Colors for the cursor when the vi mode is active.
|
||||
#
|
||||
# Allowed values are CellForeground/CellBackground, which reference the
|
||||
# affected cell, or hexadecimal colors like #ff00ff.
|
||||
#vi_mode_cursor:
|
||||
# text: CellBackground
|
||||
# cursor: CellForeground
|
||||
|
||||
# Search colors
|
||||
#
|
||||
# Colors used for the search bar and match highlighting.
|
||||
#search:
|
||||
# Allowed values are CellForeground/CellBackground, which reference the
|
||||
# affected cell, or hexadecimal colors like #ff00ff.
|
||||
#matches:
|
||||
# foreground: '#000000'
|
||||
# background: '#ffffff'
|
||||
#focused_match:
|
||||
# foreground: '#ffffff'
|
||||
# background: '#000000'
|
||||
|
||||
# Keyboard hints
|
||||
#hints:
|
||||
# First character in the hint label
|
||||
#
|
||||
# Allowed values are CellForeground/CellBackground, which reference the
|
||||
# affected cell, or hexadecimal colors like #ff00ff.
|
||||
#start:
|
||||
# foreground: '#1d1f21'
|
||||
# background: '#e9ff5e'
|
||||
|
||||
# All characters after the first one in the hint label
|
||||
#
|
||||
# Allowed values are CellForeground/CellBackground, which reference the
|
||||
# affected cell, or hexadecimal colors like #ff00ff.
|
||||
#end:
|
||||
# foreground: '#e9ff5e'
|
||||
# background: '#1d1f21'
|
||||
|
||||
# Line indicator
|
||||
#
|
||||
# Color used for the indicator displaying the position in history during
|
||||
# search and vi mode.
|
||||
#
|
||||
# By default, these will use the opposing primary color.
|
||||
#line_indicator:
|
||||
# foreground: None
|
||||
# background: None
|
||||
|
||||
# Footer bar
|
||||
#
|
||||
# Color used for the footer bar on the bottom, used by search regex input,
|
||||
# hyperlink URI preview, etc.
|
||||
#
|
||||
#footer_bar:
|
||||
# background: '#c5c8c6'
|
||||
# foreground: '#1d1f21'
|
||||
|
||||
# Selection colors
|
||||
#
|
||||
# Colors which should be used to draw the selection area.
|
||||
#
|
||||
# Allowed values are CellForeground/CellBackground, which reference the
|
||||
# affected cell, or hexadecimal colors like #ff00ff.
|
||||
#selection:
|
||||
# text: CellBackground
|
||||
# background: CellForeground
|
||||
|
||||
# Normal colors
|
||||
#normal:
|
||||
# black: '#1d1f21'
|
||||
# red: '#cc6666'
|
||||
# green: '#b5bd68'
|
||||
# yellow: '#f0c674'
|
||||
# blue: '#81a2be'
|
||||
# magenta: '#b294bb'
|
||||
# cyan: '#8abeb7'
|
||||
# white: '#c5c8c6'
|
||||
|
||||
# Bright colors
|
||||
#bright:
|
||||
# black: '#666666'
|
||||
# red: '#d54e53'
|
||||
# green: '#b9ca4a'
|
||||
# yellow: '#e7c547'
|
||||
# blue: '#7aa6da'
|
||||
# magenta: '#c397d8'
|
||||
# cyan: '#70c0b1'
|
||||
# white: '#eaeaea'
|
||||
|
||||
# Dim colors
|
||||
#
|
||||
# If the dim colors are not set, they will be calculated automatically based
|
||||
# on the `normal` colors.
|
||||
#dim:
|
||||
# black: '#131415'
|
||||
# red: '#864343'
|
||||
# green: '#777c44'
|
||||
# yellow: '#9e824c'
|
||||
# blue: '#556a7d'
|
||||
# magenta: '#75617b'
|
||||
# cyan: '#5b7d78'
|
||||
# white: '#828482'
|
||||
|
||||
# Indexed Colors
|
||||
#
|
||||
# The indexed colors include all colors from 16 to 256.
|
||||
# When these are not set, they're filled with sensible defaults.
|
||||
#
|
||||
# Example:
|
||||
# `- { index: 16, color: '#ff00ff' }`
|
||||
#
|
||||
#indexed_colors: []
|
||||
|
||||
# Transparent cell backgrounds
|
||||
#
|
||||
# Whether or not `window.opacity` applies to all cell backgrounds or only to
|
||||
# the default background. When set to `true` all cells will be transparent
|
||||
# regardless of their background color.
|
||||
#transparent_background_colors: false
|
||||
|
||||
# Bell
|
||||
#
|
||||
# The bell is rung every time the BEL control character is received.
|
||||
#bell:
|
||||
# Visual Bell Animation
|
||||
#
|
||||
# Animation effect for flashing the screen when the visual bell is rung.
|
||||
#
|
||||
# Values for `animation`:
|
||||
# - Ease
|
||||
# - EaseOut
|
||||
# - EaseOutSine
|
||||
# - EaseOutQuad
|
||||
# - EaseOutCubic
|
||||
# - EaseOutQuart
|
||||
# - EaseOutQuint
|
||||
# - EaseOutExpo
|
||||
# - EaseOutCirc
|
||||
# - Linear
|
||||
#animation: EaseOutExpo
|
||||
|
||||
# Duration of the visual bell flash in milliseconds. A `duration` of `0` will
|
||||
# disable the visual bell animation.
|
||||
#duration: 0
|
||||
|
||||
# Visual bell animation color.
|
||||
#color: '#ffffff'
|
||||
|
||||
# Bell Command
|
||||
#
|
||||
# This program is executed whenever the bell is rung.
|
||||
#
|
||||
# When set to `command: None`, no command will be executed.
|
||||
#
|
||||
# Example:
|
||||
# command:
|
||||
# program: notify-send
|
||||
# args: ["Hello, World!"]
|
||||
#
|
||||
#command: None
|
||||
|
||||
#selection:
|
||||
# This string contains all characters that are used as separators for
|
||||
# "semantic words" in Alacritty.
|
||||
#semantic_escape_chars: ",│`|:\"' ()[]{}<>\t"
|
||||
|
||||
# When set to `true`, selected text will be copied to the primary clipboard.
|
||||
#save_to_clipboard: false
|
||||
|
||||
#cursor:
|
||||
# Cursor style
|
||||
#style:
|
||||
# Cursor shape
|
||||
#
|
||||
# Values for `shape`:
|
||||
# - ▇ Block
|
||||
# - _ Underline
|
||||
# - | Beam
|
||||
#shape: Block
|
||||
|
||||
# Cursor blinking state
|
||||
#
|
||||
# Values for `blinking`:
|
||||
# - Never: Prevent the cursor from ever blinking
|
||||
# - Off: Disable blinking by default
|
||||
# - On: Enable blinking by default
|
||||
# - Always: Force the cursor to always blink
|
||||
#blinking: Off
|
||||
|
||||
# Vi mode cursor style
|
||||
#
|
||||
# If the vi mode cursor style is `None` or not specified, it will fall back to
|
||||
# the style of the active value of the normal cursor.
|
||||
#
|
||||
# See `cursor.style` for available options.
|
||||
#vi_mode_style: None
|
||||
|
||||
# Cursor blinking interval in milliseconds.
|
||||
#blink_interval: 750
|
||||
|
||||
# Time after which cursor stops blinking, in seconds.
|
||||
#
|
||||
# Specifying '0' will disable timeout for blinking.
|
||||
#blink_timeout: 5
|
||||
|
||||
# If this is `true`, the cursor will be rendered as a hollow box when the
|
||||
# window is not focused.
|
||||
#unfocused_hollow: true
|
||||
|
||||
# Thickness of the cursor relative to the cell width as floating point number
|
||||
# from `0.0` to `1.0`.
|
||||
#thickness: 0.15
|
||||
|
||||
# Live config reload (changes require restart)
|
||||
#live_config_reload: true
|
||||
|
||||
# Shell
|
||||
#
|
||||
# You can set `shell.program` to the path of your favorite shell, e.g.
|
||||
# `/bin/fish`. Entries in `shell.args` are passed unmodified as arguments to the
|
||||
# shell.
|
||||
#
|
||||
# Default:
|
||||
# - (Linux/BSD/macOS) `$SHELL` or the user's login shell, if `$SHELL` is unset
|
||||
# - (Windows) powershell
|
||||
#shell:
|
||||
# program: /bin/bash
|
||||
# args:
|
||||
# - --login
|
||||
|
||||
# Startup directory
|
||||
#
|
||||
# Directory the shell is started in. If this is unset, or `None`, the working
|
||||
# directory of the parent process will be used.
|
||||
#working_directory: None
|
||||
|
||||
# Offer IPC using `alacritty msg` (unix only)
|
||||
#ipc_socket: true
|
||||
|
||||
#mouse:
|
||||
# Click settings
|
||||
#
|
||||
# The `double_click` and `triple_click` settings control the time
|
||||
# alacritty should wait for accepting multiple clicks as one double
|
||||
# or triple click.
|
||||
#double_click: { threshold: 300 }
|
||||
#triple_click: { threshold: 300 }
|
||||
|
||||
# If this is `true`, the cursor is temporarily hidden when typing.
|
||||
#hide_when_typing: false
|
||||
|
||||
# Hints
|
||||
#
|
||||
# Terminal hints can be used to find text or hyperlink in the visible part of
|
||||
# the terminal and pipe it to other applications.
|
||||
#hints:
|
||||
# Keys used for the hint labels.
|
||||
#alphabet: "jfkdls;ahgurieowpq"
|
||||
|
||||
# List with all available hints
|
||||
#
|
||||
# Each hint must have any of `regex` or `hyperlinks` field and either an
|
||||
# `action` or a `command` field. The fields `mouse`, `binding` and
|
||||
# `post_processing` are optional.
|
||||
#
|
||||
# The `hyperlinks` option will cause OSC 8 escape sequence hyperlinks to be
|
||||
# highlighted.
|
||||
#
|
||||
# The fields `command`, `binding.key`, `binding.mods`, `binding.mode` and
|
||||
# `mouse.mods` accept the same values as they do in the `key_bindings` section.
|
||||
#
|
||||
# The `mouse.enabled` field controls if the hint should be underlined while
|
||||
# the mouse with all `mouse.mods` keys held or the vi mode cursor is above it.
|
||||
#
|
||||
# If the `post_processing` field is set to `true`, heuristics will be used to
|
||||
# shorten the match if there are characters likely not to be part of the hint
|
||||
# (e.g. a trailing `.`). This is most useful for URIs and applies only to
|
||||
# `regex` matches.
|
||||
#
|
||||
# Values for `action`:
|
||||
# - Copy
|
||||
# Copy the hint's text to the clipboard.
|
||||
# - Paste
|
||||
# Paste the hint's text to the terminal or search.
|
||||
# - Select
|
||||
# Select the hint's text.
|
||||
# - MoveViModeCursor
|
||||
# Move the vi mode cursor to the beginning of the hint.
|
||||
#enabled:
|
||||
# - regex: "(ipfs:|ipns:|magnet:|mailto:|gemini:|gopher:|https:|http:|news:|file:|git:|ssh:|ftp:)\
|
||||
# [^\u0000-\u001F\u007F-\u009F<>\"\\s{-}\\^⟨⟩`]+"
|
||||
# hyperlinks: true
|
||||
# command: xdg-open
|
||||
# post_processing: true
|
||||
# mouse:
|
||||
# enabled: true
|
||||
# mods: None
|
||||
# binding:
|
||||
# key: U
|
||||
# mods: Control|Shift
|
||||
|
||||
# Mouse bindings
|
||||
#
|
||||
# Mouse bindings are specified as a list of objects, much like the key
|
||||
# bindings further below.
|
||||
#
|
||||
# To trigger mouse bindings when an application running within Alacritty
|
||||
# captures the mouse, the `Shift` modifier is automatically added as a
|
||||
# requirement.
|
||||
#
|
||||
# Each mouse binding will specify a:
|
||||
#
|
||||
# - `mouse`:
|
||||
#
|
||||
# - Middle
|
||||
# - Left
|
||||
# - Right
|
||||
# - Numeric identifier such as `5`
|
||||
#
|
||||
# - `action` (see key bindings for actions not exclusive to mouse mode)
|
||||
#
|
||||
# - Mouse exclusive actions:
|
||||
#
|
||||
# - ExpandSelection
|
||||
# Expand the selection to the current mouse cursor location.
|
||||
#
|
||||
# And optionally:
|
||||
#
|
||||
# - `mods` (see key bindings)
|
||||
#mouse_bindings:
|
||||
# - { mouse: Right, action: ExpandSelection }
|
||||
# - { mouse: Right, mods: Control, action: ExpandSelection }
|
||||
# - { mouse: Middle, mode: ~Vi, action: PasteSelection }
|
||||
|
||||
# Key bindings
|
||||
#
|
||||
# Key bindings are specified as a list of objects. For example, this is the
|
||||
# default paste binding:
|
||||
#
|
||||
# `- { key: V, mods: Control|Shift, action: Paste }`
|
||||
#
|
||||
# Each key binding will specify a:
|
||||
#
|
||||
# - `key`: Identifier of the key pressed
|
||||
#
|
||||
# - A-Z
|
||||
# - F1-F24
|
||||
# - Key0-Key9
|
||||
#
|
||||
# A full list with available key codes can be found here:
|
||||
# https://docs.rs/winit/*/winit/event/enum.VirtualKeyCode.html#variants
|
||||
#
|
||||
# Instead of using the name of the keys, the `key` field also supports using
|
||||
# the scancode of the desired key. Scancodes have to be specified as a
|
||||
# decimal number. This command will allow you to display the hex scancodes
|
||||
# for certain keys:
|
||||
#
|
||||
# `showkey --scancodes`.
|
||||
#
|
||||
# Then exactly one of:
|
||||
#
|
||||
# - `chars`: Send a byte sequence to the running application
|
||||
#
|
||||
# The `chars` field writes the specified string to the terminal. This makes
|
||||
# it possible to pass escape sequences. To find escape codes for bindings
|
||||
# like `PageUp` (`"\x1b[5~"`), you can run the command `showkey -a` outside
|
||||
# of tmux. Note that applications use terminfo to map escape sequences back
|
||||
# to keys. It is therefore required to update the terminfo when changing an
|
||||
# escape sequence.
|
||||
#
|
||||
# - `action`: Execute a predefined action
|
||||
#
|
||||
# - ToggleViMode
|
||||
# - SearchForward
|
||||
# Start searching toward the right of the search origin.
|
||||
# - SearchBackward
|
||||
# Start searching toward the left of the search origin.
|
||||
# - Copy
|
||||
# - Paste
|
||||
# - IncreaseFontSize
|
||||
# - DecreaseFontSize
|
||||
# - ResetFontSize
|
||||
# - ScrollPageUp
|
||||
# - ScrollPageDown
|
||||
# - ScrollHalfPageUp
|
||||
# - ScrollHalfPageDown
|
||||
# - ScrollLineUp
|
||||
# - ScrollLineDown
|
||||
# - ScrollToTop
|
||||
# - ScrollToBottom
|
||||
# - ClearHistory
|
||||
# Remove the terminal's scrollback history.
|
||||
# - Hide
|
||||
# Hide the Alacritty window.
|
||||
# - Minimize
|
||||
# Minimize the Alacritty window.
|
||||
# - Quit
|
||||
# Quit Alacritty.
|
||||
# - ToggleFullscreen
|
||||
# - ToggleMaximized
|
||||
# - SpawnNewInstance
|
||||
# Spawn a new instance of Alacritty.
|
||||
# - CreateNewWindow
|
||||
# Create a new Alacritty window from the current process.
|
||||
# - ClearLogNotice
|
||||
# Clear Alacritty's UI warning and error notice.
|
||||
# - ClearSelection
|
||||
# Remove the active selection.
|
||||
# - ReceiveChar
|
||||
# - None
|
||||
#
|
||||
# - Vi mode exclusive actions:
|
||||
#
|
||||
# - Open
|
||||
# Perform the action of the first matching hint under the vi mode cursor
|
||||
# with `mouse.enabled` set to `true`.
|
||||
# - ToggleNormalSelection
|
||||
# - ToggleLineSelection
|
||||
# - ToggleBlockSelection
|
||||
# - ToggleSemanticSelection
|
||||
# Toggle semantic selection based on `selection.semantic_escape_chars`.
|
||||
# - CenterAroundViCursor
|
||||
# Center view around vi mode cursor
|
||||
#
|
||||
# - Vi mode exclusive cursor motion actions:
|
||||
#
|
||||
# - Up
|
||||
# One line up.
|
||||
# - Down
|
||||
# One line down.
|
||||
# - Left
|
||||
# One character left.
|
||||
# - Right
|
||||
# One character right.
|
||||
# - First
|
||||
# First column, or beginning of the line when already at the first column.
|
||||
# - Last
|
||||
# Last column, or beginning of the line when already at the last column.
|
||||
# - FirstOccupied
|
||||
# First non-empty cell in this terminal row, or first non-empty cell of
|
||||
# the line when already at the first cell of the row.
|
||||
# - High
|
||||
# Top of the screen.
|
||||
# - Middle
|
||||
# Center of the screen.
|
||||
# - Low
|
||||
# Bottom of the screen.
|
||||
# - SemanticLeft
|
||||
# Start of the previous semantically separated word.
|
||||
# - SemanticRight
|
||||
# Start of the next semantically separated word.
|
||||
# - SemanticLeftEnd
|
||||
# End of the previous semantically separated word.
|
||||
# - SemanticRightEnd
|
||||
# End of the next semantically separated word.
|
||||
# - WordLeft
|
||||
# Start of the previous whitespace separated word.
|
||||
# - WordRight
|
||||
# Start of the next whitespace separated word.
|
||||
# - WordLeftEnd
|
||||
# End of the previous whitespace separated word.
|
||||
# - WordRightEnd
|
||||
# End of the next whitespace separated word.
|
||||
# - Bracket
|
||||
# Character matching the bracket at the cursor's location.
|
||||
# - SearchNext
|
||||
# Beginning of the next match.
|
||||
# - SearchPrevious
|
||||
# Beginning of the previous match.
|
||||
# - SearchStart
|
||||
# Start of the match to the left of the vi mode cursor.
|
||||
# - SearchEnd
|
||||
# End of the match to the right of the vi mode cursor.
|
||||
#
|
||||
# - Search mode exclusive actions:
|
||||
# - SearchFocusNext
|
||||
# Move the focus to the next search match.
|
||||
# - SearchFocusPrevious
|
||||
# Move the focus to the previous search match.
|
||||
# - SearchConfirm
|
||||
# - SearchCancel
|
||||
# - SearchClear
|
||||
# Reset the search regex.
|
||||
# - SearchDeleteWord
|
||||
# Delete the last word in the search regex.
|
||||
# - SearchHistoryPrevious
|
||||
# Go to the previous regex in the search history.
|
||||
# - SearchHistoryNext
|
||||
# Go to the next regex in the search history.
|
||||
#
|
||||
# - macOS exclusive actions:
|
||||
# - ToggleSimpleFullscreen
|
||||
# Enter fullscreen without occupying another space.
|
||||
#
|
||||
# - Linux/BSD exclusive actions:
|
||||
#
|
||||
# - CopySelection
|
||||
# Copy from the selection buffer.
|
||||
# - PasteSelection
|
||||
# Paste from the selection buffer.
|
||||
#
|
||||
# - `command`: Fork and execute a specified command plus arguments
|
||||
#
|
||||
# The `command` field must be a map containing a `program` string and an
|
||||
# `args` array of command line parameter strings. For example:
|
||||
# `{ program: "alacritty", args: ["-e", "vttest"] }`
|
||||
#
|
||||
# And optionally:
|
||||
#
|
||||
# - `mods`: Key modifiers to filter binding actions
|
||||
#
|
||||
# - Command
|
||||
# - Control
|
||||
# - Option
|
||||
# - Super
|
||||
# - Shift
|
||||
# - Alt
|
||||
#
|
||||
# Multiple `mods` can be combined using `|` like this:
|
||||
# `mods: Control|Shift`.
|
||||
# Whitespace and capitalization are relevant and must match the example.
|
||||
#
|
||||
# - `mode`: Indicate a binding for only specific terminal reported modes
|
||||
#
|
||||
# This is mainly used to send applications the correct escape sequences
|
||||
# when in different modes.
|
||||
#
|
||||
# - AppCursor
|
||||
# - AppKeypad
|
||||
# - Search
|
||||
# - Alt
|
||||
# - Vi
|
||||
#
|
||||
# A `~` operator can be used before a mode to apply the binding whenever
|
||||
# the mode is *not* active, e.g. `~Alt`.
|
||||
#
|
||||
# Bindings are always filled by default, but will be replaced when a new
|
||||
# binding with the same triggers is defined. To unset a default binding, it can
|
||||
# be mapped to the `ReceiveChar` action. Alternatively, you can use `None` for
|
||||
# a no-op if you do not wish to receive input characters for that binding.
|
||||
#
|
||||
# If the same trigger is assigned to multiple actions, all of them are executed
|
||||
# in the order they were defined in.
|
||||
#key_bindings:
|
||||
#- { key: Paste, action: Paste }
|
||||
#- { key: Copy, action: Copy }
|
||||
#- { key: L, mods: Control, action: ClearLogNotice }
|
||||
#- { key: L, mods: Control, mode: ~Vi|~Search, chars: "\x0c" }
|
||||
#- { key: PageUp, mods: Shift, mode: ~Alt, action: ScrollPageUp }
|
||||
#- { key: PageDown, mods: Shift, mode: ~Alt, action: ScrollPageDown }
|
||||
#- { key: Home, mods: Shift, mode: ~Alt, action: ScrollToTop }
|
||||
#- { key: End, mods: Shift, mode: ~Alt, action: ScrollToBottom }
|
||||
|
||||
# Vi Mode
|
||||
#- { key: Space, mods: Shift|Control, mode: ~Search, action: ToggleViMode }
|
||||
#- { key: Space, mods: Shift|Control, mode: Vi|~Search, action: ScrollToBottom }
|
||||
#- { key: Escape, mode: Vi|~Search, action: ClearSelection }
|
||||
#- { key: I, mode: Vi|~Search, action: ToggleViMode }
|
||||
#- { key: I, mode: Vi|~Search, action: ScrollToBottom }
|
||||
#- { key: C, mods: Control, mode: Vi|~Search, action: ToggleViMode }
|
||||
#- { key: Y, mods: Control, mode: Vi|~Search, action: ScrollLineUp }
|
||||
#- { key: E, mods: Control, mode: Vi|~Search, action: ScrollLineDown }
|
||||
#- { key: G, mode: Vi|~Search, action: ScrollToTop }
|
||||
#- { key: G, mods: Shift, mode: Vi|~Search, action: ScrollToBottom }
|
||||
#- { key: B, mods: Control, mode: Vi|~Search, action: ScrollPageUp }
|
||||
#- { key: F, mods: Control, mode: Vi|~Search, action: ScrollPageDown }
|
||||
#- { key: U, mods: Control, mode: Vi|~Search, action: ScrollHalfPageUp }
|
||||
#- { key: D, mods: Control, mode: Vi|~Search, action: ScrollHalfPageDown }
|
||||
#- { key: Y, mode: Vi|~Search, action: Copy }
|
||||
#- { key: Y, mode: Vi|~Search, action: ClearSelection }
|
||||
#- { key: Copy, mode: Vi|~Search, action: ClearSelection }
|
||||
#- { key: V, mode: Vi|~Search, action: ToggleNormalSelection }
|
||||
#- { key: V, mods: Shift, mode: Vi|~Search, action: ToggleLineSelection }
|
||||
#- { key: V, mods: Control, mode: Vi|~Search, action: ToggleBlockSelection }
|
||||
#- { key: V, mods: Alt, mode: Vi|~Search, action: ToggleSemanticSelection }
|
||||
#- { key: Return, mode: Vi|~Search, action: Open }
|
||||
#- { key: Z, mode: Vi|~Search, action: CenterAroundViCursor }
|
||||
#- { key: K, mode: Vi|~Search, action: Up }
|
||||
#- { key: J, mode: Vi|~Search, action: Down }
|
||||
#- { key: H, mode: Vi|~Search, action: Left }
|
||||
#- { key: L, mode: Vi|~Search, action: Right }
|
||||
#- { key: Up, mode: Vi|~Search, action: Up }
|
||||
#- { key: Down, mode: Vi|~Search, action: Down }
|
||||
#- { key: Left, mode: Vi|~Search, action: Left }
|
||||
#- { key: Right, mode: Vi|~Search, action: Right }
|
||||
#- { key: Key0, mode: Vi|~Search, action: First }
|
||||
#- { key: Key4, mods: Shift, mode: Vi|~Search, action: Last }
|
||||
#- { key: Key6, mods: Shift, mode: Vi|~Search, action: FirstOccupied }
|
||||
#- { key: H, mods: Shift, mode: Vi|~Search, action: High }
|
||||
#- { key: M, mods: Shift, mode: Vi|~Search, action: Middle }
|
||||
#- { key: L, mods: Shift, mode: Vi|~Search, action: Low }
|
||||
#- { key: B, mode: Vi|~Search, action: SemanticLeft }
|
||||
#- { key: W, mode: Vi|~Search, action: SemanticRight }
|
||||
#- { key: E, mode: Vi|~Search, action: SemanticRightEnd }
|
||||
#- { key: B, mods: Shift, mode: Vi|~Search, action: WordLeft }
|
||||
#- { key: W, mods: Shift, mode: Vi|~Search, action: WordRight }
|
||||
#- { key: E, mods: Shift, mode: Vi|~Search, action: WordRightEnd }
|
||||
#- { key: Key5, mods: Shift, mode: Vi|~Search, action: Bracket }
|
||||
#- { key: Slash, mode: Vi|~Search, action: SearchForward }
|
||||
#- { key: Slash, mods: Shift, mode: Vi|~Search, action: SearchBackward }
|
||||
#- { key: N, mode: Vi|~Search, action: SearchNext }
|
||||
#- { key: N, mods: Shift, mode: Vi|~Search, action: SearchPrevious }
|
||||
|
||||
# Search Mode
|
||||
#- { key: Return, mode: Search|Vi, action: SearchConfirm }
|
||||
#- { key: Escape, mode: Search, action: SearchCancel }
|
||||
#- { key: C, mods: Control, mode: Search, action: SearchCancel }
|
||||
#- { key: U, mods: Control, mode: Search, action: SearchClear }
|
||||
#- { key: W, mods: Control, mode: Search, action: SearchDeleteWord }
|
||||
#- { key: P, mods: Control, mode: Search, action: SearchHistoryPrevious }
|
||||
#- { key: N, mods: Control, mode: Search, action: SearchHistoryNext }
|
||||
#- { key: Up, mode: Search, action: SearchHistoryPrevious }
|
||||
#- { key: Down, mode: Search, action: SearchHistoryNext }
|
||||
#- { key: Return, mode: Search|~Vi, action: SearchFocusNext }
|
||||
#- { key: Return, mods: Shift, mode: Search|~Vi, action: SearchFocusPrevious }
|
||||
|
||||
# (Windows, Linux, and BSD only)
|
||||
#- { key: V, mods: Control|Shift, mode: ~Vi, action: Paste }
|
||||
#- { key: C, mods: Control|Shift, action: Copy }
|
||||
#- { key: F, mods: Control|Shift, mode: ~Search, action: SearchForward }
|
||||
#- { key: B, mods: Control|Shift, mode: ~Search, action: SearchBackward }
|
||||
#- { key: C, mods: Control|Shift, mode: Vi|~Search, action: ClearSelection }
|
||||
#- { key: Insert, mods: Shift, action: PasteSelection }
|
||||
#- { key: Key0, mods: Control, action: ResetFontSize }
|
||||
#- { key: Equals, mods: Control, action: IncreaseFontSize }
|
||||
#- { key: Plus, mods: Control, action: IncreaseFontSize }
|
||||
#- { key: NumpadAdd, mods: Control, action: IncreaseFontSize }
|
||||
#- { key: Minus, mods: Control, action: DecreaseFontSize }
|
||||
#- { key: NumpadSubtract, mods: Control, action: DecreaseFontSize }
|
||||
|
||||
# (Windows only)
|
||||
#- { key: Return, mods: Alt, action: ToggleFullscreen }
|
||||
|
||||
# (macOS only)
|
||||
#- { key: K, mods: Command, mode: ~Vi|~Search, chars: "\x0c" }
|
||||
#- { key: K, mods: Command, mode: ~Vi|~Search, action: ClearHistory }
|
||||
#- { key: Key0, mods: Command, action: ResetFontSize }
|
||||
#- { key: Equals, mods: Command, action: IncreaseFontSize }
|
||||
#- { key: Plus, mods: Command, action: IncreaseFontSize }
|
||||
#- { key: NumpadAdd, mods: Command, action: IncreaseFontSize }
|
||||
#- { key: Minus, mods: Command, action: DecreaseFontSize }
|
||||
#- { key: NumpadSubtract, mods: Command, action: DecreaseFontSize }
|
||||
#- { key: V, mods: Command, action: Paste }
|
||||
#- { key: C, mods: Command, action: Copy }
|
||||
#- { key: C, mods: Command, mode: Vi|~Search, action: ClearSelection }
|
||||
#- { key: H, mods: Command, action: Hide }
|
||||
#- { key: H, mods: Command|Alt, action: HideOtherApplications }
|
||||
#- { key: M, mods: Command, action: Minimize }
|
||||
#- { key: Q, mods: Command, action: Quit }
|
||||
#- { key: W, mods: Command, action: Quit }
|
||||
#- { key: N, mods: Command, action: CreateNewWindow }
|
||||
#- { key: F, mods: Command|Control, action: ToggleFullscreen }
|
||||
#- { key: F, mods: Command, mode: ~Search, action: SearchForward }
|
||||
#- { key: B, mods: Command, mode: ~Search, action: SearchBackward }
|
||||
|
||||
#debug:
|
||||
# Display the time it takes to redraw each frame.
|
||||
#render_timer: false
|
||||
|
||||
# Keep the log file after quitting Alacritty.
|
||||
#persistent_logging: false
|
||||
|
||||
# Log level
|
||||
#
|
||||
# Values for `log_level`:
|
||||
# - Off
|
||||
# - Error
|
||||
# - Warn
|
||||
# - Info
|
||||
# - Debug
|
||||
# - Trace
|
||||
#log_level: Warn
|
||||
|
||||
# Renderer override.
|
||||
# - glsl3
|
||||
# - gles2
|
||||
# - gles2_pure
|
||||
#renderer: None
|
||||
|
||||
# Print all received window events.
|
||||
#print_events: false
|
||||
|
||||
# Highlight window damage information.
|
||||
#highlight_damage: false
|
||||
|
|
@ -39,6 +39,7 @@ raw-window-handle = "0.5.0"
|
|||
serde = { version = "1", features = ["derive"] }
|
||||
serde_json = "1"
|
||||
serde_yaml = "0.8"
|
||||
toml = "0.7.1"
|
||||
unicode-width = "0.1"
|
||||
winit = { version = "0.28.2", default-features = false, features = ["serde"] }
|
||||
|
||||
|
|
|
|||
|
|
@ -2,12 +2,10 @@ use std::cmp::max;
|
|||
use std::os::raw::c_ulong;
|
||||
use std::path::PathBuf;
|
||||
|
||||
#[cfg(unix)]
|
||||
use clap::Subcommand;
|
||||
use clap::{ArgAction, Args, Parser, ValueHint};
|
||||
use clap::{ArgAction, Args, Parser, Subcommand, ValueHint};
|
||||
use log::{self, error, LevelFilter};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_yaml::Value;
|
||||
use toml::{Table, Value};
|
||||
|
||||
use alacritty_terminal::config::{Program, PtyConfig};
|
||||
|
||||
|
|
@ -30,17 +28,18 @@ pub struct Options {
|
|||
#[clap(long)]
|
||||
pub embed: Option<String>,
|
||||
|
||||
/// Specify alternative configuration file [default: $XDG_CONFIG_HOME/alacritty/alacritty.yml].
|
||||
/// Specify alternative configuration file [default:
|
||||
/// $XDG_CONFIG_HOME/alacritty/alacritty.toml].
|
||||
#[cfg(not(any(target_os = "macos", windows)))]
|
||||
#[clap(long, value_hint = ValueHint::FilePath)]
|
||||
pub config_file: Option<PathBuf>,
|
||||
|
||||
/// Specify alternative configuration file [default: %APPDATA%\alacritty\alacritty.yml].
|
||||
/// Specify alternative configuration file [default: %APPDATA%\alacritty\alacritty.toml].
|
||||
#[cfg(windows)]
|
||||
#[clap(long, value_hint = ValueHint::FilePath)]
|
||||
pub config_file: Option<PathBuf>,
|
||||
|
||||
/// Specify alternative configuration file [default: $HOME/.config/alacritty/alacritty.yml].
|
||||
/// Specify alternative configuration file [default: $HOME/.config/alacritty/alacritty.toml].
|
||||
#[cfg(target_os = "macos")]
|
||||
#[clap(long, value_hint = ValueHint::FilePath)]
|
||||
pub config_file: Option<PathBuf>,
|
||||
|
|
@ -64,14 +63,13 @@ pub struct Options {
|
|||
|
||||
/// CLI options for config overrides.
|
||||
#[clap(skip)]
|
||||
pub config_options: Value,
|
||||
pub config_options: TomlValue,
|
||||
|
||||
/// Options which can be passed via IPC.
|
||||
#[clap(flatten)]
|
||||
pub window_options: WindowOptions,
|
||||
|
||||
/// Subcommand passed to the CLI.
|
||||
#[cfg(unix)]
|
||||
#[clap(subcommand)]
|
||||
pub subcommands: Option<Subcommands>,
|
||||
}
|
||||
|
|
@ -81,7 +79,7 @@ impl Options {
|
|||
let mut options = Self::parse();
|
||||
|
||||
// Convert `--option` flags into serde `Value`.
|
||||
options.config_options = options_as_value(&options.option);
|
||||
options.config_options = TomlValue(options_as_value(&options.option));
|
||||
|
||||
options
|
||||
}
|
||||
|
|
@ -125,9 +123,9 @@ impl Options {
|
|||
}
|
||||
}
|
||||
|
||||
/// Combine multiple options into a [`serde_yaml::Value`].
|
||||
/// Combine multiple options into a [`toml::Value`].
|
||||
pub fn options_as_value(options: &[String]) -> Value {
|
||||
options.iter().fold(Value::default(), |value, option| match option_as_value(option) {
|
||||
options.iter().fold(Value::Table(Table::new()), |value, option| match toml::from_str(option) {
|
||||
Ok(new_value) => serde_utils::merge(value, new_value),
|
||||
Err(_) => {
|
||||
eprintln!("Ignoring invalid option: {:?}", option);
|
||||
|
|
@ -136,31 +134,6 @@ pub fn options_as_value(options: &[String]) -> Value {
|
|||
})
|
||||
}
|
||||
|
||||
/// Parse an option in the format of `parent.field=value` as a serde Value.
|
||||
fn option_as_value(option: &str) -> Result<Value, serde_yaml::Error> {
|
||||
let mut yaml_text = String::with_capacity(option.len());
|
||||
let mut closing_brackets = String::new();
|
||||
|
||||
for (i, c) in option.chars().enumerate() {
|
||||
match c {
|
||||
'=' => {
|
||||
yaml_text.push_str(": ");
|
||||
yaml_text.push_str(&option[i + 1..]);
|
||||
break;
|
||||
},
|
||||
'.' => {
|
||||
yaml_text.push_str(": {");
|
||||
closing_brackets.push('}');
|
||||
},
|
||||
_ => yaml_text.push(c),
|
||||
}
|
||||
}
|
||||
|
||||
yaml_text += &closing_brackets;
|
||||
|
||||
serde_yaml::from_str(&yaml_text)
|
||||
}
|
||||
|
||||
/// Parse the class CLI parameter.
|
||||
fn parse_class(input: &str) -> Result<Class, String> {
|
||||
let (general, instance) = match input.split_once(',') {
|
||||
|
|
@ -259,10 +232,11 @@ impl WindowIdentity {
|
|||
}
|
||||
|
||||
/// Available CLI subcommands.
|
||||
#[cfg(unix)]
|
||||
#[derive(Subcommand, Debug)]
|
||||
pub enum Subcommands {
|
||||
#[cfg(unix)]
|
||||
Msg(MessageOptions),
|
||||
Migrate(MigrateOptions),
|
||||
}
|
||||
|
||||
/// Send a message to the Alacritty socket.
|
||||
|
|
@ -289,6 +263,30 @@ pub enum SocketMessage {
|
|||
Config(IpcConfig),
|
||||
}
|
||||
|
||||
/// Migrate the configuration file.
|
||||
#[derive(Args, Clone, Debug)]
|
||||
pub struct MigrateOptions {
|
||||
/// Path to the configuration file.
|
||||
#[clap(short, long, value_hint = ValueHint::FilePath)]
|
||||
pub config_file: Option<PathBuf>,
|
||||
|
||||
/// Only output TOML config to stdout.
|
||||
#[clap(short, long)]
|
||||
pub dry_run: bool,
|
||||
|
||||
/// Do not recurse over imports.
|
||||
#[clap(short = 'i', long)]
|
||||
pub skip_imports: bool,
|
||||
|
||||
/// Do not move renamed fields to their new location.
|
||||
#[clap(long)]
|
||||
pub skip_renames: bool,
|
||||
|
||||
#[clap(short, long)]
|
||||
/// Do not output to STDOUT.
|
||||
pub silent: bool,
|
||||
}
|
||||
|
||||
/// Subset of options that we pass to 'create-window' IPC subcommand.
|
||||
#[derive(Serialize, Deserialize, Args, Default, Clone, Debug, PartialEq, Eq)]
|
||||
pub struct WindowOptions {
|
||||
|
|
@ -320,6 +318,16 @@ pub struct IpcConfig {
|
|||
pub reset: bool,
|
||||
}
|
||||
|
||||
/// Toml value with default implementation.
|
||||
#[derive(Debug)]
|
||||
pub struct TomlValue(pub Value);
|
||||
|
||||
impl Default for TomlValue {
|
||||
fn default() -> Self {
|
||||
Self(Value::Table(Table::new()))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
|
@ -333,7 +341,7 @@ mod tests {
|
|||
use clap::CommandFactory;
|
||||
#[cfg(target_os = "linux")]
|
||||
use clap_complete::Shell;
|
||||
use serde_yaml::mapping::Mapping;
|
||||
use toml::Table;
|
||||
|
||||
#[test]
|
||||
fn dynamic_title_ignoring_options_by_default() {
|
||||
|
|
@ -371,38 +379,38 @@ mod tests {
|
|||
#[test]
|
||||
fn valid_option_as_value() {
|
||||
// Test with a single field.
|
||||
let value = option_as_value("field=true").unwrap();
|
||||
let value: Value = toml::from_str("field=true").unwrap();
|
||||
|
||||
let mut mapping = Mapping::new();
|
||||
mapping.insert(Value::String(String::from("field")), Value::Bool(true));
|
||||
let mut table = Table::new();
|
||||
table.insert(String::from("field"), Value::Boolean(true));
|
||||
|
||||
assert_eq!(value, Value::Mapping(mapping));
|
||||
assert_eq!(value, Value::Table(table));
|
||||
|
||||
// Test with nested fields
|
||||
let value = option_as_value("parent.field=true").unwrap();
|
||||
let value: Value = toml::from_str("parent.field=true").unwrap();
|
||||
|
||||
let mut parent_mapping = Mapping::new();
|
||||
parent_mapping.insert(Value::String(String::from("field")), Value::Bool(true));
|
||||
let mut mapping = Mapping::new();
|
||||
mapping.insert(Value::String(String::from("parent")), Value::Mapping(parent_mapping));
|
||||
let mut parent_table = Table::new();
|
||||
parent_table.insert(String::from("field"), Value::Boolean(true));
|
||||
let mut table = Table::new();
|
||||
table.insert(String::from("parent"), Value::Table(parent_table));
|
||||
|
||||
assert_eq!(value, Value::Mapping(mapping));
|
||||
assert_eq!(value, Value::Table(table));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn invalid_option_as_value() {
|
||||
let value = option_as_value("}");
|
||||
let value = toml::from_str::<Value>("}");
|
||||
assert!(value.is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn float_option_as_value() {
|
||||
let value = option_as_value("float=3.4").unwrap();
|
||||
let value: Value = toml::from_str("float=3.4").unwrap();
|
||||
|
||||
let mut expected = Mapping::new();
|
||||
expected.insert(Value::String(String::from("float")), Value::Number(3.4.into()));
|
||||
let mut expected = Table::new();
|
||||
expected.insert(String::from("float"), Value::Float(3.4));
|
||||
|
||||
assert_eq!(value, Value::Mapping(expected));
|
||||
assert_eq!(value, Value::Table(expected));
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ use std::fmt::{self, Debug, Display};
|
|||
use bitflags::bitflags;
|
||||
use serde::de::{self, Error as SerdeError, MapAccess, Unexpected, Visitor};
|
||||
use serde::{Deserialize, Deserializer};
|
||||
use serde_yaml::Value as SerdeValue;
|
||||
use toml::Value as SerdeValue;
|
||||
use winit::event::VirtualKeyCode::*;
|
||||
use winit::event::{ModifiersState, MouseButton, VirtualKeyCode};
|
||||
|
||||
|
|
@ -1011,19 +1011,20 @@ impl<'a> Deserialize<'a> for RawBinding {
|
|||
return Err(<V::Error as Error>::duplicate_field("key"));
|
||||
}
|
||||
|
||||
let val = map.next_value::<SerdeValue>()?;
|
||||
if val.is_u64() {
|
||||
let scancode = val.as_u64().unwrap();
|
||||
if scancode > u64::from(u32::MAX) {
|
||||
return Err(<V::Error as Error>::custom(format!(
|
||||
"Invalid key binding, scancode too big: {}",
|
||||
scancode
|
||||
)));
|
||||
}
|
||||
key = Some(Key::Scancode(scancode as u32));
|
||||
} else {
|
||||
let k = Key::deserialize(val).map_err(V::Error::custom)?;
|
||||
key = Some(k);
|
||||
let value = map.next_value::<SerdeValue>()?;
|
||||
match value.as_integer() {
|
||||
Some(scancode) => match u32::try_from(scancode) {
|
||||
Ok(scancode) => key = Some(Key::Scancode(scancode)),
|
||||
Err(_) => {
|
||||
return Err(<V::Error as Error>::custom(format!(
|
||||
"Invalid key binding, scancode is too big: {}",
|
||||
scancode
|
||||
)));
|
||||
},
|
||||
},
|
||||
None => {
|
||||
key = Some(Key::deserialize(value).map_err(V::Error::custom)?);
|
||||
},
|
||||
}
|
||||
},
|
||||
Field::Mods => {
|
||||
|
|
@ -1066,15 +1067,6 @@ impl<'a> Deserialize<'a> for RawBinding {
|
|||
Err(err) => {
|
||||
let value = match value {
|
||||
SerdeValue::String(string) => string,
|
||||
SerdeValue::Mapping(map) if map.len() == 1 => {
|
||||
match map.into_iter().next() {
|
||||
Some((
|
||||
SerdeValue::String(string),
|
||||
SerdeValue::Null,
|
||||
)) => string,
|
||||
_ => return Err(err),
|
||||
}
|
||||
},
|
||||
_ => return Err(err),
|
||||
};
|
||||
return Err(V::Error::custom(format!(
|
||||
|
|
|
|||
|
|
@ -18,16 +18,17 @@ pub struct Colors {
|
|||
pub line_indicator: LineIndicatorColors,
|
||||
pub hints: HintColors,
|
||||
pub transparent_background_colors: bool,
|
||||
pub draw_bold_text_with_bright_colors: bool,
|
||||
footer_bar: BarColors,
|
||||
}
|
||||
|
||||
impl Colors {
|
||||
pub fn footer_bar_foreground(&self) -> Rgb {
|
||||
self.search.bar.foreground.or(self.footer_bar.foreground).unwrap_or(self.primary.background)
|
||||
self.footer_bar.foreground.unwrap_or(self.primary.background)
|
||||
}
|
||||
|
||||
pub fn footer_bar_background(&self) -> Rgb {
|
||||
self.search.bar.background.or(self.footer_bar.background).unwrap_or(self.primary.foreground)
|
||||
self.footer_bar.background.unwrap_or(self.primary.foreground)
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -126,8 +127,6 @@ impl Default for InvertedCellColors {
|
|||
pub struct SearchColors {
|
||||
pub focused_match: FocusedMatchColors,
|
||||
pub matches: MatchColors,
|
||||
#[config(deprecated = "use `colors.footer_bar` instead")]
|
||||
bar: BarColors,
|
||||
}
|
||||
|
||||
#[derive(ConfigDeserialize, Debug, Copy, Clone, PartialEq, Eq)]
|
||||
|
|
|
|||
|
|
@ -1,11 +1,14 @@
|
|||
use std::fmt::{self, Display, Formatter};
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::result::Result as StdResult;
|
||||
use std::{env, fs, io};
|
||||
|
||||