diff options
| author | Koni Marti <koni.marti@gmail.com> | 2024-01-28 00:52:20 +0100 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2024-02-11 21:20:23 +0100 |
| commit | 28ee8e65a45d38f10938571fddea4b137a1de115 (patch) | |
| tree | 11e393d4eb3da83f91da5b35f1004c971dd255d0 /doc/aerc-binds.5.scd | |
| parent | 2dcc83efda3efd61dffc75324e434ef32d322b8f (diff) | |
| download | aerc-28ee8e65a45d38f10938571fddea4b137a1de115.tar.gz | |
binds: parse annotations from keybind config
Parse inline comments in binds.conf as annotations to the corresponding
keybinds. Note that a space is required before the comment symbol, so
the comment delimiter is " # ".
Example:
p = :postpone<Enter> # I'll work on it later
where "I'll work on it later" is the annotation.
When a comment symbol ("#") is needed in the value part of the keybind,
it should be escaped ("\#"). Comment symbols can be used without
restriction in the annotation itself.
Signed-off-by: Koni Marti <koni.marti@gmail.com>
Tested-by: Bence Ferdinandy <bence@ferdinandy.com>
Reviewed-by: Bence Ferdinandy <bence@ferdinandy.com>
Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc/aerc-binds.5.scd')
| -rw-r--r-- | doc/aerc-binds.5.scd | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/aerc-binds.5.scd b/doc/aerc-binds.5.scd index 6bb2100e..a46b6427 100644 --- a/doc/aerc-binds.5.scd +++ b/doc/aerc-binds.5.scd @@ -53,6 +53,13 @@ The available contexts are: *[compose::review]* keybindings for the composer, when reviewing the email before it's sent + To customize the description shown on the review screen, add a comment + (" # ") at the end of the keybinding. + + Example: + + p = :postpone<Enter> # I'll work on it later + *[terminal]* keybindings for terminal tabs |