Update alacritty config from repo

files/alacritty.yml

@@ -1,94 +1,122 @@
-# 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
 # environment variables. Some entries may override variables
-# set by alacritty it self.
+# set by alacritty itself.
 env:
-  # TERM env customization.
+  # TERM variable
   #
-  # If this property is not set, alacritty will set it to xterm-256color.
+  # This value is used to set the `$TERM` environment variable for
-  #
+  # each instance of Alacritty. If it is not present, alacritty will
-  # Note that some xterm terminfo databases don't declare support for italics.
+  # check the local terminfo database and use 'alacritty' if it is
-  # You can verify this by checking for the presence of `smso` and `sitm` in
+  # available, otherwise 'xterm-256color' is used.
-  # `infocmp xterm-256color`.
   TERM: xterm-256color
 
 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:
     columns: 0
     lines: 0
 
-  # 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 scaled
+  # by DPI and the specified value is always added at both opposing sides.
   padding:
     x: 1
     y: 1
 
+  # Spread additional padding evenly around the terminal content.
+  dynamic_padding: false
+
   # Window decorations
-  # Setting this to false will result in window without borders and title bar.
+  #
-  decorations: true
+  # Values for `decorations`:
+  #     - full: Borders and title bar
+  #     - none: Neither borders nor title bar
+  decorations: full
 
-# Display tabs using this many cells (changes require restart)
+scrolling:
-tabspaces: 4
+  # Maximum number of lines in the scrollback buffer.
+  # Specifying '0' will disable scrolling.
+  history: 10000
 
-# When true, bold text is drawn using the bright variant of colors.
+  # Number of lines the viewport will move for every line scrolled when
-draw_bold_text_with_bright_colors: true
+  # 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: true
+
+# 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
-# * hintstyle
+#   - antialias
-# * antialias
+#   - lcdfilter
-# * lcdfilter
+#   - rgba
-# * 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
+# 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:
-  # The normal (roman) font face to use.
+  # Normal (roman) font face
   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:
-    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:
-    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
 
-  # 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:
     x: 0
     y: 0
 
   # 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:
     x: 0
     y: 0
@@ -97,19 +125,16 @@ font:
   # 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: false
+  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
 
-# Use custom cursor colors. If true, display the cursor in the cursor.foreground
+# Keep the log file after quitting Alacritty.
-# and cursor.background colors, otherwise invert the colors of the cursor.
+persistent_logging: 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:
@@ -118,10 +143,21 @@ colors:
     background: '0x000000'
     foreground: '0xeaeaea'
 
-  # Colors the cursor will use if `custom_cursor_colors` is true
+    # Bright and dim foreground colors
-  cursor:
+    #
-    text: '0x000000'
+    # The dimmed foreground color is calculated automatically if it is not present.
-    cursor: '0xffffff'
+    # 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
+  #
+  # Colors which should be used to draw the terminal cursor. If these are unset,
+  # the cursor color will be the inverse of the cell color.
+  #cursor:
+  #  text: '0x000000'
+  #  cursor: '0xffffff'
 
   # Normal colors
   normal:
@@ -145,7 +181,10 @@ colors:
     cyan:    '0x54ced6'
     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:
     black:   '0x333333'
     red:     '0xf2777a'
@@ -156,6 +195,13 @@ colors:
     cyan:    '0x66cccc'
     white:   '0xdddddd'
 
+  # Indexed Colors
+  #
+  # The indexed colors include all colors from 16 to 256.
+  # When these are not set, they're filled with sensible defaults.
+  #indexed_colors:
+  #  - { index: 16, color: '0x000000' }
+
 # Visual Bell
 #
 # Any time the BEL code is received, Alacritty "rings" the visual bell. Once
@@ -164,42 +210,44 @@ colors:
 # setting the `duration` property (represented in milliseconds). You can also
 # 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:
   animation: EaseOutExpo
   duration: 0
 
 # 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.
 background_opacity: 1.0
 
 # 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`:
-# - 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: Middle, action: PasteSelection }
 
@@ -212,81 +260,134 @@ mouse:
   double_click: { threshold: 300 }
   triple_click: { threshold: 300 }
 
-  # Faux Scrollback
+  # If this is `true`, the cursor is temporarily hidden when typing.
-  #
+  hide_when_typing: false
-  # The `faux_scrollback_lines` setting controls the number
+
-  # of lines the terminal should scroll when the alternate
+  url:
-  # screen buffer is active. This is used to allow mouse
+    # URL launcher
-  # scrolling for applications like `man`.
+    #
-  #
+    # This program is executed when clicking on a text which is recognized as a URL.
-  # To disable this completely, set `faux_scrollback_lines` to 0.
+    # The URL is always added to the command as the last parameter.
-  faux_scrollback_lines: 1
+    launcher: xdg-open
+
+    # URL modifiers
+    #
+    # These are the modifiers that need to be held down for opening URLs when clicking
+    # on them. The available modifiers are documented in the key binding section.
+    #modifiers: Control|Shift
 
 selection:
   semantic_escape_chars: ",│`|:\"' ()[]{}<>"
 
+  # When set to `true`, selected text will be copied to both the primary and
+  # the selection clipboard. Otherwise, it will only be copied to the selection
+  # clipboard.
+  save_to_clipboard: false
+
 dynamic_title: true
 
-hide_cursor_when_typing: false
+cursor:
+  # Cursor style
+  #
+  # Values for 'style':
+  #   - ▇ Block
+  #   - _ Underline
+  #   - | Beam
+  style: Block
 
-# Style of the cursor
+  # If this is `true`, the cursor will be rendered as a hollow box when the
-#
+  # window is not focused.
-# Values for 'cursor_style':
+  unfocused_hollow: true
-# - Block
-# - Underline
-# - Beam
-cursor_style: Block
 
 # 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.
+# 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: /usr/bin/tmux
+#  args:
+#    - --login
 
 # 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 -
+#   Instead of using the name of the keys, the `key` field also supports using
-# capitalization must match exactly, and piped items must not have whitespace
+#   the scancode of the desired key. Scancodes have to be specified as a
-# around them.
+#   decimal number.
+#   This command will allow you to display the hex scancodes for certain keys:
+#     `showkey --scancodes`
 #
-# Either an `action`, `chars`, or `command` field must be present.
+# Values for `mods`:
-#   `action` must be one of `Paste`, `PasteSelection`, `Copy`, or `Quit`.
+#   - Command
-#   `chars` writes the specified string every time that binding is activated.
+#   - Control
-#     These should generally be escape sequences, but they can be configured to
+#   - Shift
-#     send arbitrary strings of bytes.
+#   - Alt
-#   `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
+#   Multiple `mods` can be combined using `|` like this: `mods: Control|Shift`.
-# (e.g. "\x1b[5~") is? Open another terminal (like xterm) without tmux,
+#   Whitespace and capitalization is relevant and must match the example.
-# then run `showkey -a` to get the sequence associated to a key combination.
+#
+# 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.
+#   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.
+#
+# 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                }