From acbf8e581e4b795fe264b52dbc0c7cc395ceb89d Mon Sep 17 00:00:00 2001 From: Pavel Roskin <1317472+proski@users.noreply.github.com> Date: Fri, 7 Jul 2023 14:37:50 -0700 Subject: [PATCH] Update binding sections in config manpage --- alacritty/src/migrate.rs | 2 +- extra/man/alacritty.5.scd | 47 +++++++++++++++++++-------------------- 2 files changed, 24 insertions(+), 25 deletions(-) diff --git a/alacritty/src/migrate.rs b/alacritty/src/migrate.rs index 07a10ba4..c889bcd0 100644 --- a/alacritty/src/migrate.rs +++ b/alacritty/src/migrate.rs @@ -151,7 +151,7 @@ fn migrate_renames(config: &mut Value) -> Result<(), String> { // key_bindings -> keyboard.bindings move_value(config_table, &["key_bindings"], &["keyboard", "bindings"])?; - // mouse_bindings -> keyboard.bindings + // mouse_bindings -> mouse.bindings move_value(config_table, &["mouse_bindings"], &["mouse", "bindings"])?; Ok(()) 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*: [{ , , , | chars = },] + + 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" | + + Mouse button which needs to be pressed to trigger this binding. + + *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 = , mods = , mode = } - 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 = , enabled = } - 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. +This section documents the *[keyboard]* table of the configuration file. -*mouse_bindings* [{ , , , | chars = },] - - 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" | - - Mouse button which needs to be pressed to trigger this binding. - - *action* | "ExpandSelection" - - *ExpandSelection* - Expand the selection to the current mouse cursor location. - -*key_bindings* [{ , , , | chars = },] +*bindings*: [{ , , , | chars = },] To unset a default binding, you can use the action _"ReceiveChar"_ to remove it or _"None"_ to inhibit any action.