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

Rework cursor config documentation

The documentation of the cursor fields has been completely reworked in
an attempt to make it more obvious what the specific fields in the
config are about.
This commit is contained in:
Christian Dürr 2018-02-07 10:42:59 +01:00
parent c0b7dced40
commit 94f7c57634
2 changed files with 28 additions and 18 deletions

View file

@ -109,13 +109,15 @@ colors:
foreground: '0xeaeaea' foreground: '0xeaeaea'
bright_foreground: '0xeaeaea' bright_foreground: '0xeaeaea'
# Colors the cursor will use if `custom_cursor_colors` is true
cursor: cursor:
# Use custom cursor colors. If true, always display the cursor in the # If this is `false` the text cursor inverses
# `colors.cursor.text` and `colors.cursor.cursor` colors, # the foreground and background colors.
# otherwise invert the colors of the background and foreground.
custom_colors: false custom_colors: false
# Text color when the cursor is above a character.
# Only used when `custom_colors` is `true`.
text: '0x000000' text: '0x000000'
# Cursor color.
# Only used when `custom_colors` is `true`.
cursor: '0xffffff' cursor: '0xffffff'
# Normal colors # Normal colors
@ -223,13 +225,16 @@ selection:
dynamic_title: true dynamic_title: true
cursor: cursor:
# Style of the cursor # This is the default look of your text cursor.
# It might be overwritten by applications like `vim`.
# #
# Values for 'cursor_style': # Values for `style`:
# - Block # - Block (Looks like: ▒)
# - Underline # - Underline (Looks like: _)
# - Beam # - Beam (Looks like: |)
style: Block style: Block
# When this is `true`, the text cursor is temporarily
# hidden when typing.
hide_when_typing: false hide_when_typing: false
# Live config reload (changes require restart) # Live config reload (changes require restart)

View file

@ -89,13 +89,15 @@ colors:
foreground: '0xeaeaea' foreground: '0xeaeaea'
bright_foreground: '0xeaeaea' bright_foreground: '0xeaeaea'
# Colors the cursor will use if `custom_cursor_colors` is true
cursor: cursor:
# Use custom cursor colors. If true, always display the cursor in the # If this is `false` the text cursor inverses
# `colors.cursor.text` and `colors.cursor.cursor` colors, # the foreground and background colors.
# otherwise invert the colors of the background and foreground.
custom_colors: false custom_colors: false
# Text color when the cursor is above a character.
# Only used when `custom_colors` is `true`.
text: '0x000000' text: '0x000000'
# Cursor color.
# Only used when `custom_colors` is `true`.
cursor: '0xffffff' cursor: '0xffffff'
# Normal colors # Normal colors
@ -204,13 +206,16 @@ selection:
dynamic_title: true dynamic_title: true
cursor: cursor:
# Style of the cursor # This is the default look of your text cursor.
# It might be overwritten by applications like `vim`.
# #
# Values for 'cursor_style': # Values for `style`:
# - Block # - Block (Looks like: ▒)
# - Underline # - Underline (Looks like: _)
# - Beam # - Beam (Looks like: |)
style: Block style: Block
# When this is `true`, the text cursor is temporarily
# hidden when typing.
hide_when_typing: false hide_when_typing: false
# Live config reload (changes require restart) # Live config reload (changes require restart)