bindings
You can see the default default key bindings
Rio allows you to add new keybindings and overwrite any default key bindings.
Bindings are built using the following trigger fields:
| Name | Description |
|---|---|
| key | The key pressed |
| with | Modifier keys |
| mode | Terminal mode |
Whom can be be combined with the following effect fields:
| Name | Description |
|---|---|
| action | Predefined Rio actions |
| bytes | Write byte sequence |
| text | Write text sequence |
[bindings]
keys = [
{ key = "q", with = "super", action = "Quit" },
# Bytes[27, 91, 53, 126] is equivalent to "\x1b[5~"
{ key = "home", with = "super | shift", bytes = [27, 91, 53, 126] },
# Remove existing keybind
{ key = "v", with = "control | shift", action = "none" },
]
Key
Each value in key binding will specify an identifier of the key pressed:
a-z0-9F1-F24tabeschomespacedeleteinsertpageuppagedownendbackupdownleftright@colon.return[];\\+,/=-*numpadenternumpadaddnumpadcommanumpaddividenumpadequalsnumpadsubtractnumpadmultiplynumpad1numpad2numpad3numpad4numpad5numpad6numpad7numpad8numpad9numpad0
Action
Execute a predefined action in Rio terminal.
Basic Actions
| Action | Description |
|---|---|
| None | |
| ReceiveChar | |
| ToggleVIMode | |
| Paste | Paste command |
| Copy | Copy command |
| OpenConfigEditor | Open configuration file on configured editor property |
| ResetFontSize | |
| IncreaseFontSize | |
| DecreaseFontSize | |
| Run(string) | Example: Running command Run(code) or Run(code ~/.config/rio/config.toml) |
| PasteSelection | |
| ClearSelection | |
| CreateWindow | Create a Rio window instance |
| Quit | Exit Rio |
Split Actions
| Action | Description |
|---|---|
| SplitRigh | Create a split by right side |
| SplitDown | Create a split by under current pane |
| SelectNextSplit | Select next split |
| SelectPrevSplit | Select previous split |
| CloseSplitOrTab | Close split, if split is the last then will close the tab |
Tab Actions
| Action | Description |
|---|---|
| CreateTab | |
| CloseTab | |
| CloseUnfocusedTabs | |
| SelectPrevTab | |
| SelectNextTab | |
| SelectLastTab | |
| SelectTab(tab_index) | Example: Select first tab SelectTab(0), second tab SelectTab(1) |
Scroll Actions
| Action | Description |
|---|---|
| Scroll(int) | Example: Scroll up 8 lines Scroll(8) or scroll down 5 lines Scroll(-5) |
| ScrollPageUp | |
| ScrollPageDown | |
| ScrollHalfPageUp | |
| ScrollHalfPageDown | |
| ScrollToTop | |
| ScrollToBottom |
Search Actions
| Action | Description |
|---|---|
| SearchForward | |
| SearchBackward | |
| SearchConfirm | |
| SearchClear | |
| SearchFocusNext | |
| SearchFocusPrevious | |
| SearchDeleteWord | |
| SearchHistoryNext | |
| SearchHistoryPrevious |
Bytes
Send a byte sequence to the running application.
The bytes field writes the specified string to the terminal. This makes
it possible to pass escape sequences, like PageUp ("\x1b[5~"). Note that applications use terminfo to map escape sequences back
to keys. It is therefore required to update the terminfo when changing an escape sequence.
With
Key modifiers to filter binding actions
nonecontroloptionsupershiftalt
Multiple modifiers can be combined using | like this:
with = "control | shift"
Mode
There is currently four different modes:
vialt(Alt screen)appcursorappkeypad
~ can be prefixed to disable the keybind while in that mode.
[bindings]
keys = [
# Enable VI mode on escape, when not in VI mode.
{ key = "esc", mode = "~vi", action = "ToggleVIMode" },
]
Text
text can be used to write specific text on key press:
[bindings]
keys = [
# Write `Rio is awesome!` on `Control + r`
{ key = "r", with = "control", text = "Rio is awesome!" },
]
Overwriting
Bindings are always filled by default, but will be replaced when a new binding with the same triggers is defined. To unset a default binding, it can be mapped to the ReceiveChar action. Alternatively, you can use None for a no-op if you do not wish to receive input characters for that binding.
The example below will disable window creation binding in the macos:
[bindings]
keys = [
{ key = "n", with = "super", action = "ReceiveChar" }
]
ReceiveChar will treat the binding as non existent and simply receive the input and put the character into the terminal.
Optionally you can ignore/disable completely a binding using None. In the example below, whenever you use key "n" along with "super" key nothing will happen.
[bindings]
keys = [
{ key = "n", with = "super", action = "None" }
]
If you are missing a key binding that you believe that should be a default in the platform that you are using, feel free to open an issue.