PolytreeDE
/
alacritty
mirror of https://github.com/alacritty/alacritty.git
1
0
Fork 0
Code Releases Activity

Update binding sections in config manpage

This commit is contained in:
Pavel Roskin 2023-07-07 14:37:50 -07:00 committed by GitHub
parent edf4df66c9
commit acbf8e581e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
alacritty/src/migrate.rs
View File

@ -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(())

47
extra/man/alacritty.5.scd
View File

@ -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.
This section documents the *[keyboard]* table 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.
*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.