diff options
author | Brooks J Rady <b.j.rady@gmail.com> | 2021-04-13 16:17:40 +0100 |
---|---|---|
committer | Brooks J Rady <b.j.rady@gmail.com> | 2021-04-13 16:17:40 +0100 |
commit | 0e73227fe2418c3a4945f493afbc64ab66dcb763 (patch) | |
tree | e46256e314b2a70a5dc8f7281519695bf2a5ffad /README.md | |
parent | d2a7d100acdbcf85664fb10a04805325abd10a6c (diff) | |
parent | 313ac9f41474222133b344c1c0d8827b4dc2fa50 (diff) |
merge(main): update branch with changes from main
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 38 |
1 files changed, 38 insertions, 0 deletions
@@ -40,6 +40,44 @@ The status bar on the bottom should guide you through the possible keyboard shor For more build commands, take a look at [`Contributing.md`](CONTRIBUTING.md). +# Configuration +It is possible to configure keyboard shortcuts and their actions in a yaml file. +An example file can be found under `example/config.yaml`. + +Zellij will look for a file `/zellij/config.yaml` in the default configuration location of your os. + +To pass a config file directly to zellij run it either with: +`cargo run -- config [FILE]` or `zellij config [FILE]`. + +The structure is as follows: +``` +keybinds: + normal: + - action: [] + key: [] +``` +`normal` is one of the `modes` zellij can be in. +It is possible to bind a sequence of actions to numerous keys at the same time. +Here a reference to the [Key](https://docs.rs/termion/1.5.6/termion/event/enum.Key.html) format that is used. + +For example: +``` +keybinds: + normal: + - action: [ NewTab, GoToTab: 1,] + key: [ Char: 'c',] +``` +Will create a new tab and then switch to tab number 1 on pressing the +`c` key. +Whereas: +``` +keybinds: + normal: + - action: [ NewTab,] + key: [ Char: 'c', Char: 'd',] +``` +Will create a new tab on pressing either the `c` or the `d` key. + # What is the current status of the project? Zellij is in the last stages of being VT compatible. As much as modern terminals are. |