mirror of
https://github.com/alacritty/alacritty.git
synced 2024-11-25 14:05:41 -05:00
cee35b309d
This changes a lot of small details in the configuration file in an
attempt to unify its structure. These are some main guidelines used for
this refactoring:
- Specify that changes require restart consistently
- Unify the specification of available field values
- Provide clear distinction between description title and body
Besides these guidelines used to unify minor details in the
configuration file, the section on key configuration has been completely
reworked in an attempt to reduce the amount of text used. This should
make it possible to understand what's going on without having to read
any text.
The notice that modifiers are not supported has been removed from the
mouse binding documentation.
459 lines
17 KiB
YAML
459 lines
17 KiB
YAML
# Configuration for Alacritty, the GPU enhanced terminal emulator.
|
|
|
|
|
|
# Any items in the `env` entry below will be added as
|
|
# environment variables. Some entries may override variables
|
|
# set by alacritty itself.
|
|
env:
|
|
# TERM env customization
|
|
#
|
|
# If this property is not set, alacritty will set it to `xterm-256color`.
|
|
#
|
|
# Note that some xterm terminfo databases don't declare support for italics.
|
|
# You can verify this by checking for the presence of `smso` and `sitm` in
|
|
# `infocmp xterm-256color`.
|
|
TERM: xterm-256color
|
|
|
|
window:
|
|
# Window dimensions (changes require restart)
|
|
#
|
|
# Specified in number of columns/lines, not pixels.
|
|
# If both are `0`, this setting is ignored.
|
|
dimensions:
|
|
columns: 80
|
|
lines: 24
|
|
|
|
# Window padding (changes require restart)
|
|
#
|
|
# Blank space added around the window in pixels. This padding is not scaled
|
|
# by DPI and the specified value is always added at both opposing sides.
|
|
padding:
|
|
x: 2
|
|
y: 2
|
|
|
|
# Window decorations
|
|
#
|
|
# Values for `decorations`:
|
|
# - full: Borders and title bar
|
|
# - none: Neither borders nor title bar
|
|
decorations: full
|
|
|
|
scrolling:
|
|
# Maximum number of lines in the scrollback buffer.
|
|
# Specifying '0' will disable scrolling.
|
|
history: 10000
|
|
|
|
# Number of lines the viewport will move for every line scrolled when
|
|
# scrollback is enabled (history > 0).
|
|
multiplier: 3
|
|
|
|
# Faux Scrolling
|
|
#
|
|
# The `faux_multiplier` setting controls the number of lines the terminal
|
|
# should scroll when the alternate screen buffer is active. This is used
|
|
# to allow mouse scrolling for applications like `man`.
|
|
#
|
|
# Specifying `0` will disable faux scrolling.
|
|
faux_multiplier: 3
|
|
|
|
# Scroll to the bottom when new text is written to the terminal.
|
|
auto_scroll: false
|
|
|
|
# Spaces per Tab (changes require restart)
|
|
#
|
|
# This setting defines the width of a tab in cells.
|
|
#
|
|
# Some applications, like Emacs, rely on knowing about the width of a tab.
|
|
# To prevent unexpected behavior in these applications, it's also required to
|
|
# change the `it` value in terminfo when altering this setting.
|
|
tabspaces: 8
|
|
|
|
# Font configuration (changes require restart)
|
|
#
|
|
# Important font attributes like antialiasing, subpixel aa, and hinting can be
|
|
# controlled through fontconfig. Specifically, the following attributes should
|
|
# have an effect:
|
|
# - hintstyle
|
|
# - antialias
|
|
# - lcdfilter
|
|
# - rgba
|
|
#
|
|
# For instance, if you wish to disable subpixel antialiasing, you might set the
|
|
# rgba property to `none`. If you wish to completely disable antialiasing, you
|
|
# can set antialias to `false`.
|
|
#
|
|
# Please see these resources for more information on how to use fontconfig:
|
|
# - https://wiki.archlinux.org/index.php/font_configuration#Fontconfig_configuration
|
|
# - file:///usr/share/doc/fontconfig/fontconfig-user.html
|
|
font:
|
|
# Normal (roman) font face
|
|
normal:
|
|
family: monospace
|
|
# The `style` can be specified to pick a specific face.
|
|
# style: Regular
|
|
|
|
# Bold font face
|
|
bold:
|
|
family: monospace
|
|
# The `style` can be specified to pick a specific face.
|
|
# style: Bold
|
|
|
|
# Italic font face
|
|
italic:
|
|
family: monospace
|
|
# The `style` can be specified to pick a specific face.
|
|
# style: 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 upwards.
|
|
glyph_offset:
|
|
x: 0
|
|
y: 0
|
|
|
|
# Scale the font size based on the monitor's DPI. This will lead to bigger text on HiDPI
|
|
# screens and make reading text a little easier.
|
|
# On X11 it is possible to change the DPI for each instance of alacritty by using
|
|
# `WINIT_HIDPI_FACTOR=1.0 alacritty` to scale the font.
|
|
scale_with_dpi: true
|
|
|
|
# Display the time it takes to redraw each frame.
|
|
render_timer: false
|
|
|
|
# Use custom cursor colors. If `true`, the `colors.cursor.foreground` and
|
|
# `colors.cursor.background` colors will be used to display the cursor.
|
|
# Otherwise the cell colors are inverted for the cursor.
|
|
custom_cursor_colors: false
|
|
|
|
# If `true`, bold text is drawn using the bright color variants.
|
|
draw_bold_text_with_bright_colors: true
|
|
|
|
# Colors (Tomorrow Night Bright)
|
|
colors:
|
|
# Default colors
|
|
primary:
|
|
background: '0x000000'
|
|
foreground: '0xeaeaea'
|
|
|
|
# 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: '0x9a9a9a'
|
|
#bright_foreground: '0xffffff'
|
|
|
|
# Cursor colors
|
|
#
|
|
# These will only be used when the `custom_cursor_colors` field is set to `true`.
|
|
cursor:
|
|
text: '0x000000'
|
|
cursor: '0xffffff'
|
|
|
|
# Normal colors
|
|
normal:
|
|
black: '0x000000'
|
|
red: '0xd54e53'
|
|
green: '0xb9ca4a'
|
|
yellow: '0xe6c547'
|
|
blue: '0x7aa6da'
|
|
magenta: '0xc397d8'
|
|
cyan: '0x70c0ba'
|
|
white: '0xffffff'
|
|
|
|
# Bright colors
|
|
bright:
|
|
black: '0x666666'
|
|
red: '0xff3334'
|
|
green: '0x9ec400'
|
|
yellow: '0xe7c547'
|
|
blue: '0x7aa6da'
|
|
magenta: '0xb77ee0'
|
|
cyan: '0x54ced6'
|
|
white: '0xffffff'
|
|
|
|
# Dim colors
|
|
#
|
|
# If the dim colors are not set, they will be calculated automatically based
|
|
# on the `normal` colors.
|
|
dim:
|
|
black: '0x333333'
|
|
red: '0xf2777a'
|
|
green: '0x99cc99'
|
|
yellow: '0xffcc66'
|
|
blue: '0x6699cc'
|
|
magenta: '0xcc99cc'
|
|
cyan: '0x66cccc'
|
|
white: '0xdddddd'
|
|
|
|
# Visual Bell
|
|
#
|
|
# Any time the BEL code is received, Alacritty "rings" the visual bell. Once
|
|
# rung, the terminal background will be set to white and transition back to the
|
|
# default background color. You can control the rate of this transition by
|
|
# setting the `duration` property (represented in milliseconds). You can also
|
|
# configure the transition function by setting the `animation` property.
|
|
#
|
|
# Values for `animation`:
|
|
# - Ease
|
|
# - EaseOut
|
|
# - EaseOutSine
|
|
# - EaseOutQuad
|
|
# - EaseOutCubic
|
|
# - EaseOutQuart
|
|
# - EaseOutQuint
|
|
# - EaseOutExpo
|
|
# - EaseOutCirc
|
|
# - Linear
|
|
#
|
|
# Specifying a `duration` of `0` will disable the visual bell.
|
|
visual_bell:
|
|
animation: EaseOutExpo
|
|
duration: 0
|
|
|
|
# Background opacity
|
|
background_opacity: 1.0
|
|
|
|
# Mouse bindings
|
|
#
|
|
# Available fields:
|
|
# - mouse
|
|
# - action
|
|
# - mods (optional)
|
|
#
|
|
# Values for `mouse`:
|
|
# - Middle
|
|
# - Left
|
|
# - Right
|
|
# - Numeric identifier such as `5`
|
|
#
|
|
# All available `mods` and `action` values are documented in the key binding
|
|
# section.
|
|
mouse_bindings:
|
|
- { mouse: Middle, action: PasteSelection }
|
|
|
|
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 }
|
|
|
|
selection:
|
|
semantic_escape_chars: ",│`|:\"' ()[]{}<>"
|
|
|
|
dynamic_title: true
|
|
|
|
hide_cursor_when_typing: false
|
|
|
|
# Cursor style
|
|
#
|
|
# Values for 'cursor_style':
|
|
# - Block
|
|
# - Underline
|
|
# - Beam
|
|
cursor_style: Block
|
|
|
|
# If this is `true`, the cursor will be rendered as a hollow box when the
|
|
# window is not focused.
|
|
unfocused_hollow_cursor: true
|
|
|
|
# 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.
|
|
#
|
|
#shell:
|
|
# program: /bin/bash
|
|
# args:
|
|
# - --login
|
|
|
|
# Key bindings
|
|
#
|
|
# Key bindings are specified as a list of objects. Each binding will specify
|
|
# a key and modifiers required to trigger it, terminal modes where the binding
|
|
# is applicable, and what should be done when the key binding fires. It can
|
|
# either send a byte sequnce to the running application (`chars`), execute
|
|
# a predefined action (`action`) or fork and execute a specified command plus
|
|
# arguments (`command`).
|
|
#
|
|
# Example:
|
|
# `- { key: V, mods: Command, action: Paste }`
|
|
#
|
|
# Available fields:
|
|
# - key
|
|
# - mods (optional)
|
|
# - chars | action | command (exactly one required)
|
|
# - mode (optional)
|
|
#
|
|
# Values for `key`:
|
|
# - `A` -> `Z`
|
|
# - `F1` -> `F12`
|
|
# - `Key1` -> `Key0`
|
|
#
|
|
# A full list with available key codes can be found here:
|
|
# https://docs.rs/glutin/*/glutin/enum.VirtualKeyCode.html#variants
|
|
#
|
|
# Values for `mods`:
|
|
# - Command
|
|
# - Control
|
|
# - Shift
|
|
# - Alt
|
|
#
|
|
# Multiple `mods` can be combined using `|` like this: `mods: Control|Shift`.
|
|
# Whitespace and capitalization is relevant and must match the example.
|
|
#
|
|
# Values for `chars`:
|
|
# 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.
|
|
#
|
|
# Values for `action`:
|
|
# - Paste
|
|
# - PasteSelection
|
|
# - Copy
|
|
# - IncreaseFontSize
|
|
# - DecreaseFontSize
|
|
# - ResetFontSize
|
|
# - ScrollPageUp
|
|
# - ScrollPageDown
|
|
# - ScrollToTop
|
|
# - ScrollToBottom
|
|
# - ClearHistory
|
|
# - Hide
|
|
# - Quit
|
|
#
|
|
# Values for `command`:
|
|
# The `command` field must be a map containing a `program` string and
|
|
# an `args` array of command line parameter strings.
|
|
#
|
|
# Example:
|
|
# `command: { program: "alacritty", args: ["-e", "vttest"] }`
|
|
#
|
|
# Values for `mode`:
|
|
# - ~AppCursor
|
|
# - AppCursor
|
|
# - ~AppKeypad
|
|
# - AppKeypad
|
|
key_bindings:
|
|
- { key: V, mods: Control|Shift, action: Paste }
|
|
- { key: C, mods: Control|Shift, action: Copy }
|
|
- { key: Paste, action: Paste }
|
|
- { key: Copy, action: Copy }
|
|
- { key: Q, mods: Command, action: Quit }
|
|
- { key: W, mods: Command, action: Quit }
|
|
- { key: Insert, mods: Shift, action: PasteSelection }
|
|
- { key: Key0, mods: Control, action: ResetFontSize }
|
|
- { key: Equals, mods: Control, action: IncreaseFontSize }
|
|
- { key: Subtract, mods: Control, action: DecreaseFontSize }
|
|
- { key: Home, chars: "\x1bOH", mode: AppCursor }
|
|
- { key: Home, chars: "\x1b[H", mode: ~AppCursor }
|
|
- { key: End, chars: "\x1bOF", mode: AppCursor }
|
|
- { key: End, chars: "\x1b[F", mode: ~AppCursor }
|
|
- { key: PageUp, mods: Shift, chars: "\x1b[5;2~" }
|
|
- { key: PageUp, mods: Control, chars: "\x1b[5;5~" }
|
|
- { key: PageUp, chars: "\x1b[5~" }
|
|
- { key: PageDown, mods: Shift, chars: "\x1b[6;2~" }
|
|
- { key: PageDown, mods: Control, chars: "\x1b[6;5~" }
|
|
- { key: PageDown, chars: "\x1b[6~" }
|
|
- { key: Tab, mods: Shift, chars: "\x1b[Z" }
|
|
- { key: Back, chars: "\x7f" }
|
|
- { key: Back, mods: Alt, chars: "\x1b\x7f" }
|
|
- { key: Insert, chars: "\x1b[2~" }
|
|
- { key: Delete, chars: "\x1b[3~" }
|
|
- { key: Left, mods: Shift, chars: "\x1b[1;2D" }
|
|
- { key: Left, mods: Control, chars: "\x1b[1;5D" }
|
|
- { key: Left, mods: Alt, chars: "\x1b[1;3D" }
|
|
- { key: Left, chars: "\x1b[D", mode: ~AppCursor }
|
|
- { key: Left, chars: "\x1bOD", mode: AppCursor }
|
|
- { key: Right, mods: Shift, chars: "\x1b[1;2C" }
|
|
- { key: Right, mods: Control, chars: "\x1b[1;5C" }
|
|
- { key: Right, mods: Alt, chars: "\x1b[1;3C" }
|
|
- { key: Right, chars: "\x1b[C", mode: ~AppCursor }
|
|
- { key: Right, chars: "\x1bOC", mode: AppCursor }
|
|
- { key: Up, mods: Shift, chars: "\x1b[1;2A" }
|
|
- { key: Up, mods: Control, chars: "\x1b[1;5A" }
|
|
- { key: Up, mods: Alt, chars: "\x1b[1;3A" }
|
|
- { key: Up, chars: "\x1b[A", mode: ~AppCursor }
|
|
- { key: Up, chars: "\x1bOA", mode: AppCursor }
|
|
- { key: Down, mods: Shift, chars: "\x1b[1;2B" }
|
|
- { key: Down, mods: Control, chars: "\x1b[1;5B" }
|
|
- { key: Down, mods: Alt, chars: "\x1b[1;3B" }
|
|
- { key: Down, chars: "\x1b[B", mode: ~AppCursor }
|
|
- { key: Down, chars: "\x1bOB", mode: AppCursor }
|
|
- { key: F1, chars: "\x1bOP" }
|
|
- { key: F2, chars: "\x1bOQ" }
|
|
- { key: F3, chars: "\x1bOR" }
|
|
- { key: F4, chars: "\x1bOS" }
|
|
- { key: F5, chars: "\x1b[15~" }
|
|
- { key: F6, chars: "\x1b[17~" }
|
|
- { key: F7, chars: "\x1b[18~" }
|
|
- { key: F8, chars: "\x1b[19~" }
|
|
- { key: F9, chars: "\x1b[20~" }
|
|
- { key: F10, chars: "\x1b[21~" }
|
|
- { key: F11, chars: "\x1b[23~" }
|
|
- { key: F12, chars: "\x1b[24~" }
|
|
- { key: F1, mods: Shift, chars: "\x1b[1;2P" }
|
|
- { key: F2, mods: Shift, chars: "\x1b[1;2Q" }
|
|
- { key: F3, mods: Shift, chars: "\x1b[1;2R" }
|
|
- { key: F4, mods: Shift, chars: "\x1b[1;2S" }
|
|
- { key: F5, mods: Shift, chars: "\x1b[15;2~" }
|
|
- { key: F6, mods: Shift, chars: "\x1b[17;2~" }
|
|
- { key: F7, mods: Shift, chars: "\x1b[18;2~" }
|
|
- { key: F8, mods: Shift, chars: "\x1b[19;2~" }
|
|
- { key: F9, mods: Shift, chars: "\x1b[20;2~" }
|
|
- { key: F10, mods: Shift, chars: "\x1b[21;2~" }
|
|
- { key: F11, mods: Shift, chars: "\x1b[23;2~" }
|
|
- { key: F12, mods: Shift, chars: "\x1b[24;2~" }
|
|
- { key: F1, mods: Control, chars: "\x1b[1;5P" }
|
|
- { key: F2, mods: Control, chars: "\x1b[1;5Q" }
|
|
- { key: F3, mods: Control, chars: "\x1b[1;5R" }
|
|
- { key: F4, mods: Control, chars: "\x1b[1;5S" }
|
|
- { key: F5, mods: Control, chars: "\x1b[15;5~" }
|
|
- { key: F6, mods: Control, chars: "\x1b[17;5~" }
|
|
- { key: F7, mods: Control, chars: "\x1b[18;5~" }
|
|
- { key: F8, mods: Control, chars: "\x1b[19;5~" }
|
|
- { key: F9, mods: Control, chars: "\x1b[20;5~" }
|
|
- { key: F10, mods: Control, chars: "\x1b[21;5~" }
|
|
- { key: F11, mods: Control, chars: "\x1b[23;5~" }
|
|
- { key: F12, mods: Control, chars: "\x1b[24;5~" }
|
|
- { key: F1, mods: Alt, chars: "\x1b[1;6P" }
|
|
- { key: F2, mods: Alt, chars: "\x1b[1;6Q" }
|
|
- { key: F3, mods: Alt, chars: "\x1b[1;6R" }
|
|
- { key: F4, mods: Alt, chars: "\x1b[1;6S" }
|
|
- { key: F5, mods: Alt, chars: "\x1b[15;6~" }
|
|
- { key: F6, mods: Alt, chars: "\x1b[17;6~" }
|
|
- { key: F7, mods: Alt, chars: "\x1b[18;6~" }
|
|
- { key: F8, mods: Alt, chars: "\x1b[19;6~" }
|
|
- { key: F9, mods: Alt, chars: "\x1b[20;6~" }
|
|
- { key: F10, mods: Alt, chars: "\x1b[21;6~" }
|
|
- { key: F11, mods: Alt, chars: "\x1b[23;6~" }
|
|
- { key: F12, mods: Alt, chars: "\x1b[24;6~" }
|
|
- { key: F1, mods: Super, chars: "\x1b[1;3P" }
|
|
- { key: F2, mods: Super, chars: "\x1b[1;3Q" }
|
|
- { key: F3, mods: Super, chars: "\x1b[1;3R" }
|
|
- { key: F4, mods: Super, chars: "\x1b[1;3S" }
|
|
- { key: F5, mods: Super, chars: "\x1b[15;3~" }
|
|
- { key: F6, mods: Super, chars: "\x1b[17;3~" }
|
|
- { key: F7, mods: Super, chars: "\x1b[18;3~" }
|
|
- { key: F8, mods: Super, chars: "\x1b[19;3~" }
|
|
- { key: F9, mods: Super, chars: "\x1b[20;3~" }
|
|
- { key: F10, mods: Super, chars: "\x1b[21;3~" }
|
|
- { key: F11, mods: Super, chars: "\x1b[23;3~" }
|
|
- { key: F12, mods: Super, chars: "\x1b[24;3~" }
|