PolytreeDE/alacritty
1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-18 13:55:23 -05:00
Code Releases Activity

Unify configuration file structure

Browse source 
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.
This commit is contained in:
Christian Duerr 2018-09-22 02:46:41 +00:00 committed by GitHub
parent 6cfd7aea82
commit cee35b309d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 313 additions and 260 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

303
alacritty.yml
View file

@ -1,13 +1,13 @@
# Configuration for Alacritty, the GPU enhanced terminal emulator # Configuration for Alacritty, the GPU enhanced terminal emulator.
# Any items in the `env` entry below will be added as # Any items in the `env` entry below will be added as
# environment variables. Some entries may override variables # environment variables. Some entries may override variables
# set by alacritty it self. # set by alacritty itself.
env: env:
# TERM env customization. # TERM env customization
# #
# If this property is not set, alacritty will set it to xterm-256color. # 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. # 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 # You can verify this by checking for the presence of `smso` and `sitm` in
@ -15,112 +15,107 @@ env:
TERM: xterm-256color TERM: xterm-256color
window: window:
# Window dimensions in character columns and lines # Window dimensions (changes require restart)
# Falls back to size specified by window manager if set to 0x0. #
# (changes require restart) # Specified in number of columns/lines, not pixels.
# If both are `0`, this setting is ignored.
dimensions: dimensions:
columns: 80 columns: 80
lines: 24 lines: 24
# Adds this many blank pixels of padding around the window # Window padding (changes require restart)
# Units are physical pixels; this is not DPI aware. #
# (change requires 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: padding:
x: 2 x: 2
y: 2 y: 2
# Window decorations # Window decorations
# Available values: #
# - `full`: Window with borders and title bar. # Values for `decorations`:
# - `none`: Window without borders or title bar. # - full: Borders and title bar
# - none: Neither borders nor title bar
decorations: full decorations: full
scrolling: scrolling:
# How many lines of scrollback to keep, # Maximum number of lines in the scrollback buffer.
# '0' will disable scrolling. # Specifying '0' will disable scrolling.
history: 10000 history: 10000
# Number of lines the viewport will move for every line # Number of lines the viewport will move for every line scrolled when
# scrolled when scrollback is enabled (history > 0). # scrollback is enabled (history > 0).
multiplier: 3 multiplier: 3
# Faux Scrolling # Faux Scrolling
# #
# The `faux_multiplier` setting controls the number # The `faux_multiplier` setting controls the number of lines the terminal
# of lines the terminal should scroll when the alternate # should scroll when the alternate screen buffer is active. This is used
# screen buffer is active. This is used to allow mouse # to allow mouse scrolling for applications like `man`.
# scrolling for applications like `man`.
# #
# To disable this completely, set `faux_multiplier` to 0. # Specifying `0` will disable faux scrolling.
faux_multiplier: 3 faux_multiplier: 3
# Automatically scroll to the bottom when new text is written # Scroll to the bottom when new text is written to the terminal.
# to the terminal.
auto_scroll: false auto_scroll: false
# Spaces per Tab # Spaces per Tab (changes require restart)
# #
# This setting defines the width of a tab in cells. Changes to this # This setting defines the width of a tab in cells.
# value require a restart to take effect.
# #
# Some applications, like Emacs, rely on knowing about the width of a tab. # 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 # To prevent unexpected behavior in these applications, it's also required to
# change the `it` value in terminfo when altering this setting. # change the `it` value in terminfo when altering this setting.
tabspaces: 8 tabspaces: 8
# When true, bold text is drawn using the bright variant of colors.
draw_bold_text_with_bright_colors: true
# Font configuration (changes require restart) # Font configuration (changes require restart)
# #
# Important font attributes like antialiasing, subpixel aa, and hinting can be # Important font attributes like antialiasing, subpixel aa, and hinting can be
# controlled through fontconfig. Specifically, the following attributes should # controlled through fontconfig. Specifically, the following attributes should
# have an effect: # have an effect:
# # - hintstyle
# * hintstyle # - antialias
# * antialias # - lcdfilter
# * lcdfilter # - rgba
# * rgba
# #
# For instance, if you wish to disable subpixel antialiasing, you might set the # 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 # rgba property to `none`. If you wish to completely disable antialiasing, you
# can set antialias to false. # can set antialias to `false`.
# #
# Please see these resources for more information on how to use fontconfig # Please see these resources for more information on how to use fontconfig:
# # - https://wiki.archlinux.org/index.php/font_configuration#Fontconfig_configuration
# * https://wiki.archlinux.org/index.php/font_configuration#Fontconfig_configuration # - file:///usr/share/doc/fontconfig/fontconfig-user.html
# * file:///usr/share/doc/fontconfig/fontconfig-user.html
font: font:
# The normal (roman) font face to use. # Normal (roman) font face
normal: normal:
family: monospace # should be "Menlo" or something on macOS. family: monospace
# Style can be specified to pick a specific face. # The `style` can be specified to pick a specific face.
# style: Regular # style: Regular
# The bold font face # Bold font face
bold: bold:
family: monospace # should be "Menlo" or something on macOS. family: monospace
# Style can be specified to pick a specific face. # The `style` can be specified to pick a specific face.
# style: Bold # style: Bold
# The italic font face # Italic font face
italic: italic:
family: monospace # should be "Menlo" or something on macOS. family: monospace
# Style can be specified to pick a specific face. # The `style` can be specified to pick a specific face.
# style: Italic # style: Italic
# Point size of the font # Point size
size: 11.0 size: 11.0
# Offset is the extra space around each character. offset.y can be thought of # Offset is the extra space around each character. `offset.y` can be thought of
# as modifying the linespacing, and offset.x as modifying the letter spacing. # as modifying the line spacing, and `offset.x` as modifying the letter spacing.
offset: offset:
x: 0 x: 0
y: 0 y: 0
# Glyph offset determines the locations of the glyphs within their cells with # Glyph offset determines the locations of the glyphs within their cells with
# the default being at the bottom. Increase the x offset to move the glyph to # the default being at the bottom. Increasing `x` moves the glyph to the right,
# the right, increase the y offset to move the glyph upward. # increasing `y` moves the glyph upwards.
glyph_offset: glyph_offset:
x: 0 x: 0
y: 0 y: 0
@ -131,18 +126,17 @@ font:
# `WINIT_HIDPI_FACTOR=1.0 alacritty` to scale the font. # `WINIT_HIDPI_FACTOR=1.0 alacritty` to scale the font.
scale_with_dpi: true scale_with_dpi: true
# OS X only: use thin stroke font rendering. Thin strokes are suitable # Display the time it takes to redraw each frame.
# for retina displays, but for non-retina you probably want this set to
# false.
use_thin_strokes: true
# Should display the render timer
render_timer: false render_timer: false
# Use custom cursor colors. If true, display the cursor in the cursor.foreground # Use custom cursor colors. If `true`, the `colors.cursor.foreground` and
# and cursor.background colors, otherwise invert the colors of the cursor. # `colors.cursor.background` colors will be used to display the cursor.
# Otherwise the cell colors are inverted for the cursor.
custom_cursor_colors: false 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 (Tomorrow Night Bright)
colors: colors:
# Default colors # Default colors
@ -150,16 +144,18 @@ colors:
background: '0x000000' background: '0x000000'
foreground: '0xeaeaea' foreground: '0xeaeaea'
# (Optional) Bright and Dim foreground colors # Bright and dim foreground colors
# #
# The dimmed foreground color is calculated automatically if it is not present. # 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` # If the bright foreground color is not set, or `draw_bold_text_with_bright_colors`
# is `false`, the normal foreground color will be used. # is `false`, the normal foreground color will be used.
# #
# dim_foreground: '0x9a9a9a' #dim_foreground: '0x9a9a9a'
# bright_foreground: '0xffffff' #bright_foreground: '0xffffff'
# Colors the cursor will use if `custom_cursor_colors` is true # Cursor colors
#
# These will only be used when the `custom_cursor_colors` field is set to `true`.
cursor: cursor:
text: '0x000000' text: '0x000000'
cursor: '0xffffff' cursor: '0xffffff'
@ -186,7 +182,10 @@ colors:
cyan: '0x54ced6' cyan: '0x54ced6'
white: '0xffffff' white: '0xffffff'
# Dim colors (Optional) # Dim colors
#
# If the dim colors are not set, they will be calculated automatically based
# on the `normal` colors.
dim: dim:
black: '0x333333' black: '0x333333'
red: '0xf2777a' red: '0xf2777a'
@ -205,20 +204,19 @@ colors:
# setting the `duration` property (represented in milliseconds). You can also # setting the `duration` property (represented in milliseconds). You can also
# configure the transition function by setting the `animation` property. # configure the transition function by setting the `animation` property.
# #
# Possible values for `animation` # Values for `animation`:
# `Ease` # - Ease
# `EaseOut` # - EaseOut
# `EaseOutSine` # - EaseOutSine
# `EaseOutQuad` # - EaseOutQuad
# `EaseOutCubic` # - EaseOutCubic
# `EaseOutQuart` # - EaseOutQuart
# `EaseOutQuint` # - EaseOutQuint
# `EaseOutExpo` # - EaseOutExpo
# `EaseOutCirc` # - EaseOutCirc
# `Linear` # - Linear
#
# To completely disable the visual bell, set its duration to 0.
# #
# Specifying a `duration` of `0` will disable the visual bell.
visual_bell: visual_bell:
animation: EaseOutExpo animation: EaseOutExpo
duration: 0 duration: 0
@ -228,19 +226,19 @@ background_opacity: 1.0
# Mouse bindings # Mouse bindings
# #
# Currently doesn't support modifiers. Both the `mouse` and `action` fields must # Available fields:
# be specified. # - mouse
# - action
# - mods (optional)
# #
# Values for `mouse`: # Values for `mouse`:
# - Middle # - Middle
# - Left # - Left
# - Right # - Right
# - Numeric identifier such as `5` # - Numeric identifier such as `5`
# #
# Values for `action`: # All available `mods` and `action` values are documented in the key binding
# - Paste # section.
# - PasteSelection
# - Copy (TODO)
mouse_bindings: mouse_bindings:
- { mouse: Middle, action: PasteSelection } - { mouse: Middle, action: PasteSelection }
@ -260,15 +258,16 @@ dynamic_title: true
hide_cursor_when_typing: false hide_cursor_when_typing: false
# Style of the cursor # Cursor style
# #
# Values for 'cursor_style': # Values for 'cursor_style':
# - Block # - Block
# - Underline # - Underline
# - Beam # - Beam
cursor_style: Block cursor_style: Block
# Whether the cursor should be a hollow block on window focus loss # If this is `true`, the cursor will be rendered as a hollow box when the
# window is not focused.
unfocused_hollow_cursor: true unfocused_hollow_cursor: true
# Live config reload (changes require restart) # Live config reload (changes require restart)
@ -276,64 +275,82 @@ live_config_reload: true
# Shell # Shell
# #
# You can set shell.program to the path of your favorite shell, e.g. /bin/fish. # 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. # Entries in `shell.args` are passed unmodified as arguments to the shell.
# #
# shell: #shell:
# program: /bin/bash # program: /bin/bash
# args: # args:
# - --login # - --login
# Key bindings # Key bindings
# #
# Each binding is defined as an object with some properties. Most of the # Key bindings are specified as a list of objects. Each binding will specify
# properties are optional. All of the alphabetical keys should have a letter for # a key and modifiers required to trigger it, terminal modes where the binding
# the `key` value such as `V`. Function keys are probably what you would expect # is applicable, and what should be done when the key binding fires. It can
# as well (F1, F2, ..). The number keys above the main keyboard are encoded as # either send a byte sequnce to the running application (`chars`), execute
# `Key1`, `Key2`, etc. Keys on the number pad are encoded `Number1`, `Number2`, # a predefined action (`action`) or fork and execute a specified command plus
# etc. These all match the glutin::VirtualKeyCode variants. # arguments (`command`).
# #
# A list with all available `key` names can be found here: # Example:
# https://docs.rs/glutin/*/glutin/enum.VirtualKeyCode.html#variants # `- { key: V, mods: Command, action: Paste }`
# #
# Possible values for `mods` # Available fields:
# `Command`, `Super` refer to the super/command/windows key # - key
# `Control` for the control key # - mods (optional)
# `Shift` for the Shift key # - chars | action | command (exactly one required)
# `Alt` and `Option` refer to alt/option # - mode (optional)
# #
# mods may be combined with a `|`. For example, requiring control and shift # Values for `key`:
# looks like: # - `A` -> `Z`
# - `F1` -> `F12`
# - `Key1` -> `Key0`
# #
# mods: Control|Shift # A full list with available key codes can be found here:
# https://docs.rs/glutin/*/glutin/enum.VirtualKeyCode.html#variants
# #
# The parser is currently quite sensitive to whitespace and capitalization - # Values for `mods`:
# capitalization must match exactly, and piped items must not have whitespace # - Command
# around them. # - Control
# - Shift
# - Alt
# #
# Either an `action`, `chars`, or `command` field must be present. # Multiple `mods` can be combined using `|` like this: `mods: Control|Shift`.
# `action` must be one of the following: # Whitespace and capitalization is relevant and must match the example.
# - `Paste`
# - `PasteSelection`
# - `Copy`
# - `IncreaseFontSize`
# - `DecreaseFontSize`
# - `ResetFontSize`
# - `ScrollPageUp`
# - `ScrollPageDown`
# - `ScrollToTop`
# - `ScrollToBottom`
# - `Quit`
# `chars` writes the specified string every time that binding is activated.
# These should generally be escape sequences, but they can be configured to
# send arbitrary strings of bytes.
# `command` must be a map containing a `program` string, and `args` array of
# strings. For example:
# - { ... , command: { program: "alacritty", args: ["-e", "vttest"] } }
# #
# Want to add a binding (e.g. "PageUp") but are unsure what the X sequence # Values for `chars`:
# (e.g. "\x1b[5~") is? Open another terminal (like xterm) without tmux, # The `chars` field writes the specified string to the terminal. This makes
# then run `showkey -a` to get the sequence associated to a key combination. # 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_bindings:
- { key: V, mods: Control|Shift, action: Paste } - { key: V, mods: Control|Shift, action: Paste }
- { key: C, mods: Control|Shift, action: Copy } - { key: C, mods: Control|Shift, action: Copy }

270
alacritty_macos.yml
View file

@ -1,12 +1,12 @@
# Configuration for Alacritty, the GPU enhanced terminal emulator # Configuration for Alacritty, the GPU enhanced terminal emulator.
# Any items in the `env` entry below will be added as # Any items in the `env` entry below will be added as
# environment variables. Some entries may override variables # environment variables. Some entries may override variables
# set by alacritty it self. # set by alacritty itself.
env: env:
# TERM env customization. # TERM env customization
# #
# If this property is not set, alacritty will set it to xterm-256color. # 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. # 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 # You can verify this by checking for the presence of `smso` and `sitm` in
@ -14,20 +14,24 @@ env:
TERM: xterm-256color TERM: xterm-256color
window: window:
# Window dimensions in character columns and lines # Window dimensions (changes require restart)
# (changes require restart) #
# Specified in number of columns/lines, not pixels.
# If both are `0`, this setting is ignored.
dimensions: dimensions:
columns: 80 columns: 80
lines: 24 lines: 24
# Adds this many blank pixels of padding around the window # Window padding (changes require restart)
# Units are physical pixels; this is not DPI aware. #
# (change requires 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: padding:
x: 2 x: 2
y: 2 y: 2
# Window decorations # Window decorations
#
# Available values: # Available values:
# - `full`: Window with title bar and title bar buttons # - `full`: Window with title bar and title bar buttons
# - `none`: Window without title bar, rounded corners, or drop shadow # - `none`: Window without title bar, rounded corners, or drop shadow
@ -35,76 +39,77 @@ window:
# bar buttons # bar buttons
# - `buttonless`: Window with title bar with transparent background and no # - `buttonless`: Window with title bar with transparent background and no
# title bar buttons # title bar buttons
# Window decorations
#
# Values for `decorations`:
# - full: Borders and title bar
# - none: Neither borders nor title bar
# - buttonless: Title bar, transparent background and title bar buttons
# - transparent: Title bar, transparent background, but no title bar buttons
decorations: full decorations: full
scrolling: scrolling:
# How many lines of scrollback to keep, # Maximum number of lines in the scrollback buffer.
# '0' will disable scrolling. # Specifying '0' will disable scrolling.
history: 10000 history: 10000
# Number of lines the viewport will move for every line # Number of lines the viewport will move for every line scrolled when
# scrolled when scrollback is enabled (history > 0). # scrollback is enabled (history > 0).
multiplier: 3 multiplier: 3
# Faux Scrolling # Faux Scrolling
# #
# The `faux_multiplier` setting controls the number # The `faux_multiplier` setting controls the number of lines the terminal
# of lines the terminal should scroll when the alternate # should scroll when the alternate screen buffer is active. This is used
# screen buffer is active. This is used to allow mouse # to allow mouse scrolling for applications like `man`.
# scrolling for applications like `man`.
# #
# To disable this completely, set `faux_multiplier` to 0. # Specifying `0` will disable faux scrolling.
faux_multiplier: 3 faux_multiplier: 3
# Automatically scroll to the bottom when new text is written # Scroll to the bottom when new text is written to the terminal.
# to the terminal.
auto_scroll: false auto_scroll: false
# Spaces per Tab # Spaces per Tab (changes require restart)
# #
# This setting defines the width of a tab in cells. Changes to this # This setting defines the width of a tab in cells.
# value require a restart to take effect.
# #
# Some applications, like Emacs, rely on knowing about the width of a tab. # 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 # To prevent unexpected behavior in these applications, it's also required to
# change the `it` value in terminfo when altering this setting. # change the `it` value in terminfo when altering this setting.
tabspaces: 8 tabspaces: 8
# When true, bold text is drawn using the bright variant of colors.
draw_bold_text_with_bright_colors: true
# Font configuration (changes require restart) # Font configuration (changes require restart)
font: font:
# The normal (roman) font face to use. # Normal (roman) font face
normal: normal:
family: Menlo family: Menlo
# Style can be specified to pick a specific face. # The `style` can be specified to pick a specific face.
# style: Regular # style: Regular
# The bold font face # Italic font face
bold: bold:
family: Menlo family: Menlo
# Style can be specified to pick a specific face. # The `style` can be specified to pick a specific face.
# style: Bold # style: Bold
# The italic font face # Italic font face
italic: italic:
family: Menlo family: Menlo
# Style can be specified to pick a specific face. # The `style` can be specified to pick a specific face.
# style: Italic # style: Italic
# Point size of the font # Point size
size: 12.0 size: 12.0
# Offset is the extra space around each character. offset.y can be thought of # Offset is the extra space around each character. `offset.y` can be thought of
# as modifying the linespacing, and offset.x as modifying the letter spacing. # as modifying the line spacing, and `offset.x` as modifying the letter spacing.
offset: offset:
x: 0 x: 0
y: 0 y: 0
# Glyph offset determines the locations of the glyphs within their cells with # Glyph offset determines the locations of the glyphs within their cells with
# the default being at the bottom. Increase the x offset to move the glyph to # the default being at the bottom. Increasing `x` moves the glyph to the right,
# the right, increase the y offset to move the glyph upward. # increasing `y` moves the glyph upwards.
glyph_offset: glyph_offset:
x: 0 x: 0
y: 0 y: 0
@ -113,18 +118,23 @@ font:
# screens and make reading text a little easier. # screens and make reading text a little easier.
scale_with_dpi: true scale_with_dpi: true
# OS X only: use thin stroke font rendering. Thin strokes are suitable # Thin stroke font rendering (OS X only)
# for retina displays, but for non-retina you probably want this set to #
# false. # Thin strokes are suitable for retina displays, but for non-retina screens
# it is recommended to set `use_thin_strokes` to `false`
use_thin_strokes: true use_thin_strokes: true
# Should display the render timer # Display the time it takes to redraw each frame.
render_timer: false render_timer: false
# Use custom cursor colors. If true, display the cursor in the cursor.foreground # Use custom cursor colors. If `true`, the `colors.cursor.foreground` and
# and cursor.background colors, otherwise invert the colors of the cursor. # `colors.cursor.background` colors will be used to display the cursor.
# Otherwise the cell colors are inverted for the cursor.
custom_cursor_colors: false 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 (Tomorrow Night Bright)
colors: colors:
# Default colors # Default colors
@ -132,16 +142,18 @@ colors:
background: '0x000000' background: '0x000000'
foreground: '0xeaeaea' foreground: '0xeaeaea'
# (Optional) Bright and Dim foreground colors # Bright and dim foreground colors
# #
# The dimmed foreground color is calculated automatically if it is not present. # 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` # If the bright foreground color is not set, or `draw_bold_text_with_bright_colors`
# is `false`, the normal foreground color will be used. # is `false`, the normal foreground color will be used.
# #
# dim_foreground: '0x9a9a9a' #dim_foreground: '0x9a9a9a'
# bright_foreground: '0xffffff' #bright_foreground: '0xffffff'
# Colors the cursor will use if `custom_cursor_colors` is true # Cursor colors
#
# These will only be used when the `custom_cursor_colors` field is set to `true`.
cursor: cursor:
text: '0x000000' text: '0x000000'
cursor: '0xffffff' cursor: '0xffffff'
@ -168,7 +180,10 @@ colors:
cyan: '0x54ced6' cyan: '0x54ced6'
white: '0xffffff' white: '0xffffff'
# Dim colors (Optional) # Dim colors
#
# If the dim colors are not set, they will be calculated automatically based
# on the `normal` colors.
dim: dim:
black: '0x333333' black: '0x333333'
red: '0xf2777a' red: '0xf2777a'
@ -179,7 +194,6 @@ colors:
cyan: '0x66cccc' cyan: '0x66cccc'
white: '0xdddddd' white: '0xdddddd'
# Visual Bell # Visual Bell
# #
# Any time the BEL code is received, Alacritty "rings" the visual bell. Once # Any time the BEL code is received, Alacritty "rings" the visual bell. Once
@ -188,20 +202,19 @@ colors:
# setting the `duration` property (represented in milliseconds). You can also # setting the `duration` property (represented in milliseconds). You can also
# configure the transition function by setting the `animation` property. # configure the transition function by setting the `animation` property.
# #
# Possible values for `animation` # Values for `animation`:
# `Ease` # - Ease
# `EaseOut` # - EaseOut
# `EaseOutSine` # - EaseOutSine
# `EaseOutQuad` # - EaseOutQuad
# `EaseOutCubic` # - EaseOutCubic
# `EaseOutQuart` # - EaseOutQuart
# `EaseOutQuint` # - EaseOutQuint
# `EaseOutExpo` # - EaseOutExpo
# `EaseOutCirc` # - EaseOutCirc
# `Linear` # - Linear
#
# To completely disable the visual bell, set its duration to 0.
# #
# Specifying a `duration` of `0` will disable the visual bell.
visual_bell: visual_bell:
animation: EaseOutExpo animation: EaseOutExpo
duration: 0 duration: 0
@ -211,8 +224,10 @@ background_opacity: 1.0
# Mouse bindings # Mouse bindings
# #
# Currently doesn't support modifiers. Both the `mouse` and `action` fields must # Available fields:
# be specified. # - mouse
# - action
# - mods (optional)
# #
# Values for `mouse`: # Values for `mouse`:
# - Middle # - Middle
@ -220,10 +235,8 @@ background_opacity: 1.0
# - Right # - Right
# - Numeric identifier such as `5` # - Numeric identifier such as `5`
# #
# Values for `action`: # All available `mods` and `action` values are documented in the key binding
# - Paste # section.
# - PasteSelection
# - Copy (TODO)
mouse_bindings: mouse_bindings:
- { mouse: Middle, action: PasteSelection } - { mouse: Middle, action: PasteSelection }
@ -243,15 +256,16 @@ dynamic_title: true
hide_cursor_when_typing: false hide_cursor_when_typing: false
# Style of the cursor # Cursor style
# #
# Values for 'cursor_style': # Values for 'cursor_style':
# - Block # - Block
# - Underline # - Underline
# - Beam # - Beam
cursor_style: Block cursor_style: Block
# Whether the cursor should be a hollow block on window focus loss # If this is `true`, the cursor will be rendered as a hollow box when the
# window is not focused.
unfocused_hollow_cursor: true unfocused_hollow_cursor: true
# Live config reload (changes require restart) # Live config reload (changes require restart)
@ -259,60 +273,82 @@ live_config_reload: true
# Shell # Shell
# #
# You can set shell.program to the path of your favorite shell, e.g. /bin/fish. # 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. # Entries in `shell.args` are passed unmodified as arguments to the shell.
# #
# shell: #shell:
# program: /bin/bash # program: /bin/bash
# args: # args:
# - --login # - --login
# Key bindings # Key bindings
# #
# Each binding is defined as an object with some properties. Most of the # Key bindings are specified as a list of objects. Each binding will specify
# properties are optional. All of the alphabetical keys should have a letter for # a key and modifiers required to trigger it, terminal modes where the binding
# the `key` value such as `V`. Function keys are probably what you would expect # is applicable, and what should be done when the key binding fires. It can
# as well (F1, F2, ..). The number keys above the main keyboard are encoded as # either send a byte sequnce to the running application (`chars`), execute
# `Key1`, `Key2`, etc. Keys on the number pad are encoded `Number1`, `Number2`, # a predefined action (`action`) or fork and execute a specified command plus
# etc. These all match the glutin::VirtualKeyCode variants. # arguments (`command`).
# #
# A list with all available `key` names can be found here: # Example:
# https://docs.rs/glutin/*/glutin/enum.VirtualKeyCode.html#variants # `- { key: V, mods: Command, action: Paste }`
# #
# Possible values for `mods` # Available fields:
# `Command`, `Super` refer to the super/command/windows key # - key
# `Control` for the control key # - mods (optional)
# `Shift` for the Shift key # - chars | action | command (exactly one required)
# `Alt` and `Option` refer to alt/option # - mode (optional)
# #
# mods may be combined with a `|`. For example, requiring control and shift # Values for `key`:
# looks like: # - `A` -> `Z`
# - `F1` -> `F12`
# - `Key1` -> `Key0`
# #
# mods: Control|Shift # A full list with available key codes can be found here:
# https://docs.rs/glutin/*/glutin/enum.VirtualKeyCode.html#variants
# #
# The parser is currently quite sensitive to whitespace and capitalization - # Values for `mods`:
# capitalization must match exactly, and piped items must not have whitespace # - Command
# around them. # - Control
# - Shift
# - Alt
# #
# Either an `action`, `chars`, or `command` field must be present. # Multiple `mods` can be combined using `|` like this: `mods: Control|Shift`.
# `action` must be one of the following: # Whitespace and capitalization is relevant and must match the example.
# - `Paste` #
# - `PasteSelection` # Values for `chars`:
# - `Copy` # The `chars` field writes the specified string to the terminal. This makes
# - `IncreaseFontSize` # it possible to pass escape sequences.
# - `DecreaseFontSize` # To find escape codes for bindings like `PageUp` ("\x1b[5~"), you can run
# - `ResetFontSize` # the command `showkey -a` outside of tmux.
# - `ScrollPageUp` #
# - `ScrollPageDown` # Values for `action`:
# - `ScrollToTop` # - Paste
# - `ScrollToBottom` # - PasteSelection
# - `Quit` # - Copy
# `chars` writes the specified string every time that binding is activated. # - IncreaseFontSize
# These should generally be escape sequences, but they can be configured to # - DecreaseFontSize
# send arbitrary strings of bytes. # - ResetFontSize
# `command` must be a map containing a `program` string, and `args` array of # - ScrollPageUp
# strings. For example: # - ScrollPageDown
# - { ... , command: { program: "alacritty", args: ["-e", "vttest"] } } # - 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_bindings:
- { key: V, mods: Command, action: Paste } - { key: V, mods: Command, action: Paste }
- { key: C, mods: Command, action: Copy } - { key: C, mods: Command, action: Copy }