aboutsummaryrefslogtreecommitdiff
path: root/extra
diff options
context:
space:
mode:
authorPavel Roskin <1317472+proski@users.noreply.github.com>2023-07-07 14:37:50 -0700
committerGitHub <noreply@github.com>2023-07-07 21:37:50 +0000
commitacbf8e581e4b795fe264b52dbc0c7cc395ceb89d (patch)
treeac3e6ca89fbabe59cc1a66945391742595caffb3 /extra
parentedf4df66c9afcb9593eaeaaf34d5c80c66925adc (diff)
downloadalacritty-acbf8e581e4b795fe264b52dbc0c7cc395ceb89d.tar.gz
alacritty-acbf8e581e4b795fe264b52dbc0c7cc395ceb89d.zip
Update binding sections in config manpage
Diffstat (limited to 'extra')
-rw-r--r--extra/man/alacritty.5.scd47
1 files changed, 23 insertions, 24 deletions
diff --git a/extra/man/alacritty.5.scd b/extra/man/alacritty.5.scd
index 19d66f61..78884e32 100644
--- a/extra/man/alacritty.5.scd
+++ b/extra/man/alacritty.5.scd
@@ -544,6 +544,24 @@ This section documents the *[mouse]* table of the configuration file.
Default: _false_
+*bindings*: [{ <mouse>, <mods>, <mode>, <action> | chars = <string> },]
+
+ See _keyboard.bindings_ for full documentation on _mods_, _mode_, _action_,
+ and _chars_.
+
+ To trigger mouse bindings when an application running within Alacritty
+ captures the mouse, the `Shift` modifier is automatically added as a
+ requirement.
+
+ *mouse* "Middle" | "Left" | "Right" | <number>
+
+ Mouse button which needs to be pressed to trigger this binding.
+
+ *action* <keyboard.bindings.action> | "ExpandSelection"
+
+ *ExpandSelection*
+ Expand the selection to the current mouse cursor location.
+
# Hints
This section documents the *[hints]* table of the configuration file.
@@ -603,14 +621,14 @@ _action_ or a _command_.
*binding* { key = <string>, mods = <string>, mode = <string> }
- See _key_bindings_ for documentation on available values.
+ See _keyboard.bindings_ for documentation on available values.
This controls which key binding is used to start the keyboard hint
selection process.
*mouse* { mods = <string>, enabled = <boolean> }
- See _key_bindings_ for documentation on available _mods_.
+ See _keyboard.bindings_ for documentation on available _mods_.
The _enabled_ field controls if the hint should be underlined when
hovering over the hint text with all _mods_ pressed.
@@ -624,30 +642,11 @@ mouse = { enabled = true },++
binding = { key = "U", mods = "Control | Shift" },
}]_
-# Bindings
+# Keyboard
-This section documents the *mouse_bindings* and *key_bindings* at the root level
-of the configuration file.
-
-*mouse_bindings* [{ <mouse>, <mods>, <mode>, <action> | chars = <string> },]
-
- See _key_bindings_ for full documentation on _mods_, _mode_, _action_, and
- _chars_.
-
- To trigger mouse bindings when an application running within Alacritty
- captures the mouse, the `Shift` modifier is automatically added as a
- requirement.
-
- *mouse* "Middle" | "Left" | "Right" | <number>
-
- Mouse button which needs to be pressed to trigger this binding.
-
- *action* <key_bindings.action> | "ExpandSelection"
-
- *ExpandSelection*
- Expand the selection to the current mouse cursor location.
+This section documents the *[keyboard]* table of the configuration file.
-*key_bindings* [{ <key>, <mods>, <mode>, <action> | chars = <string> },]
+*bindings*: [{ <key>, <mods>, <mode>, <action> | chars = <string> },]
To unset a default binding, you can use the action _"ReceiveChar"_ to remove
it or _"None"_ to inhibit any action.