diff options
author | Christian Duerr <chrisduerr@users.noreply.github.com> | 2018-09-22 02:46:41 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-09-22 02:46:41 +0000 |
commit | cee35b309de129f16d4c9df80172e43f5320c82a (patch) | |
tree | ae33942a9d44d0f8aa6565448f1fde42be3fd0c9 /alacritty_macos.yml | |
parent | 6cfd7aea82ea57d7808cffd36997d0deec55749f (diff) |
Unify configuration file structure
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.
Diffstat (limited to 'alacritty_macos.yml')
-rw-r--r-- | alacritty_macos.yml | 270 |
1 files changed, 153 insertions, 117 deletions
diff --git a/alacritty_macos.yml b/alacritty_macos.yml index 9c911e26..07566b22 100644 --- a/alacritty_macos.yml +++ b/alacritty_macos.yml @@ -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 # environment variables. Some entries may override variables -# set by alacritty it self. +# set by alacritty itself. 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. # You can verify this by checking for the presence of `smso` and `sitm` in @@ -14,20 +14,24 @@ env: TERM: xterm-256color window: - # Window dimensions in character columns and lines - # (changes require restart) + # 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 - # Adds this many blank pixels of padding around the window - # Units are physical pixels; this is not DPI aware. - # (change requires restart) + # 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 + # # Available values: # - `full`: Window with title bar and title bar buttons # - `none`: Window without title bar, rounded corners, or drop shadow @@ -35,76 +39,77 @@ window: # bar buttons # - `buttonless`: Window with title bar with transparent background and no # 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 scrolling: - # How many lines of scrollback to keep, - # '0' will disable 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). + # 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`. + # 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`. # - # To disable this completely, set `faux_multiplier` to 0. + # Specifying `0` will disable faux scrolling. faux_multiplier: 3 - # Automatically scroll to the bottom when new text is written - # to the terminal. + # Scroll to the bottom when new text is written to the terminal. 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 -# value require a restart to take effect. +# 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 -# 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: - # The normal (roman) font face to use. + # Normal (roman) font face normal: family: Menlo - # Style can be specified to pick a specific face. + # The `style` can be specified to pick a specific face. # style: Regular - # The bold font face + # Italic font face bold: family: Menlo - # Style can be specified to pick a specific face. + # The `style` can be specified to pick a specific face. # style: Bold - # The italic font face + # Italic font face italic: family: Menlo - # Style can be specified to pick a specific face. + # The `style` can be specified to pick a specific face. # style: Italic - # Point size of the font + # Point size size: 12.0 - # 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. + # 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. Increase the x offset to move the glyph to - # the right, increase the y offset to move the glyph upward. + # 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 @@ -113,18 +118,23 @@ font: # screens and make reading text a little easier. scale_with_dpi: true - # OS X only: use thin stroke font rendering. Thin strokes are suitable - # for retina displays, but for non-retina you probably want this set to - # false. + # Thin stroke font rendering (OS X only) + # + # 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 -# Should display the render timer +# Display the time it takes to redraw each frame. render_timer: false -# Use custom cursor colors. If true, display the cursor in the cursor.foreground -# and cursor.background colors, otherwise invert the colors of the cursor. +# 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 @@ -132,16 +142,18 @@ colors: background: '0x000000' 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. # 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' + #dim_foreground: '0x9a9a9a' + #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: text: '0x000000' cursor: '0xffffff' @@ -168,7 +180,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' @@ -179,7 +194,6 @@ colors: cyan: '0x66cccc' white: '0xdddddd' - # Visual Bell # # 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 # configure the transition function by setting the `animation` property. # -# Possible values for `animation` -# `Ease` -# `EaseOut` -# `EaseOutSine` -# `EaseOutQuad` -# `EaseOutCubic` -# `EaseOutQuart` -# `EaseOutQuint` -# `EaseOutExpo` -# `EaseOutCirc` -# `Linear` -# -# To completely disable the visual bell, set its duration to 0. +# 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 @@ -211,8 +224,10 @@ background_opacity: 1.0 # Mouse bindings # -# Currently doesn't support modifiers. Both the `mouse` and `action` fields must -# be specified. +# Available fields: +# - mouse +# - action +# - mods (optional) # # Values for `mouse`: # - Middle @@ -220,10 +235,8 @@ background_opacity: 1.0 # - Right # - Numeric identifier such as `5` # -# Values for `action`: -# - Paste -# - PasteSelection -# - Copy (TODO) +# All available `mods` and `action` values are documented in the key binding +# section. mouse_bindings: - { mouse: Middle, action: PasteSelection } @@ -243,15 +256,16 @@ dynamic_title: true hide_cursor_when_typing: false -# Style of the cursor +# Cursor style # # Values for 'cursor_style': -# - Block -# - Underline -# - Beam +# - Block +# - Underline +# - Beam 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 # Live config reload (changes require restart) @@ -259,60 +273,82 @@ 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. +# 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 +#shell: +# program: /bin/bash +# args: +# - --login # Key bindings # -# Each binding is defined as an object with some properties. Most of the -# properties are optional. All of the alphabetical keys should have a letter for -# the `key` value such as `V`. Function keys are probably what you would expect -# as well (F1, F2, ..). The number keys above the main keyboard are encoded as -# `Key1`, `Key2`, etc. Keys on the number pad are encoded `Number1`, `Number2`, -# etc. These all match the glutin::VirtualKeyCode variants. +# 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 }` # -# A list with all available `key` names can be found here: -# https://docs.rs/glutin/*/glutin/enum.VirtualKeyCode.html#variants +# Available fields: +# - key +# - mods (optional) +# - chars | action | command (exactly one required) +# - mode (optional) # -# Possible values for `mods` -# `Command`, `Super` refer to the super/command/windows key -# `Control` for the control key -# `Shift` for the Shift key -# `Alt` and `Option` refer to alt/option +# Values for `key`: +# - `A` -> `Z` +# - `F1` -> `F12` +# - `Key1` -> `Key0` # -# mods may be combined with a `|`. For example, requiring control and shift -# looks like: +# 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 # -# mods: Control|Shift +# Values for `command`: +# The `command` field must be a map containing a `program` string and +# an `args` array of command line parameter strings. # -# The parser is currently quite sensitive to whitespace and capitalization - -# capitalization must match exactly, and piped items must not have whitespace -# around them. +# Example: +# `command: { program: "alacritty", args: ["-e", "vttest"] }` # -# Either an `action`, `chars`, or `command` field must be present. -# `action` must be one of the following: -# - `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"] } } +# Values for `mode`: +# - ~AppCursor +# - AppCursor +# - ~AppKeypad +# - AppKeypad key_bindings: - { key: V, mods: Command, action: Paste } - { key: C, mods: Command, action: Copy } |