aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Duerr <chrisduerr@users.noreply.github.com>2018-01-10 18:36:34 +0000
committerGitHub <noreply@github.com>2018-01-10 18:36:34 +0000
commitf6839a8794f3a60a4a9086a5015e5b3ab2010562 (patch)
treeee926c6d0d430e6269ff039ee5f4b3e567c1800d
parent632ef0df7f55cad7c7694acfff69a8ba76fac4a0 (diff)
downloadalacritty-f6839a8794f3a60a4a9086a5015e5b3ab2010562.tar.gz
alacritty-f6839a8794f3a60a4a9086a5015e5b3ab2010562.zip
Expand key binding config documentation
A link to all variants available as `key` has been added to the key bindings documentation, to help users with finding the right place for mapping key codes.
-rw-r--r--alacritty.yml5
-rw-r--r--alacritty_macos.yml3
2 files changed, 7 insertions, 1 deletions
diff --git a/alacritty.yml b/alacritty.yml
index 07e0bfc5..90a27254 100644
--- a/alacritty.yml
+++ b/alacritty.yml
@@ -238,12 +238,12 @@ live_config_reload: true
#
# 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
#
# Each binding is defined as an object with some properties. Most of the
@@ -253,6 +253,9 @@ live_config_reload: true
# `Key1`, `Key2`, etc. Keys on the number pad are encoded `Number1`, `Number2`,
# etc. These all match the glutin::VirtualKeyCode variants.
#
+# A list with all available `key` names can be found here:
+# https://docs.rs/glutin/*/glutin/enum.VirtualKeyCode.html#variants
+#
# Possible values for `mods`
# `Command`, `Super` refer to the super/command/windows key
# `Control` for the control key
diff --git a/alacritty_macos.yml b/alacritty_macos.yml
index aaa38d21..7593cabe 100644
--- a/alacritty_macos.yml
+++ b/alacritty_macos.yml
@@ -234,6 +234,9 @@ live_config_reload: true
# `Key1`, `Key2`, etc. Keys on the number pad are encoded `Number1`, `Number2`,
# etc. These all match the glutin::VirtualKeyCode variants.
#
+# A list with all available `key` names can be found here:
+# https://docs.rs/glutin/*/glutin/enum.VirtualKeyCode.html#variants
+#
# Possible values for `mods`
# `Command`, `Super` refer to the super/command/windows key
# `Control` for the control key