1AERC-BINDS(5)                 File Formats Manual                AERC-BINDS(5)
2
3
4

NAME

6       aerc-binds - key bindings configuration file format for aerc(1)
7

SYNOPSIS

9       The binds.conf file is used for configuring keybindings used in the
10       aerc interactive client. It is expected to be in your XDG config home
11       plus aerc, which defaults to ~/.config/aerc/binds.conf. If the file
12       does not exist, the built-in default will be installed.
13
14       This file is written in the ini format with key bindings defined as:
15
16           <key sequence> = <command>
17
18       Where <key sequence> is the keystrokes pressed (in order) to invoke
19       this keybinding, and <command> specifies keystrokes that aerc will sim‐
20       ulate when the keybinding is invoked. Generally this is used to execute
21       commands, for example:
22
23           rq = :reply -q<Enter>
24
25       Pressing r, then q, will simulate typing in :reply -q<Enter>, and exe‐
26       cute :reply -q accordingly. It is also possible to invoke keybindings
27       recursively in a similar fashion.
28
29       You may configure different keybindings for different contexts by writ‐
30       ing them into different [sections] of the ini file.
31

CONTEXTS

33       The available contexts are:
34
35       [messages]
36           keybindings for the message list
37
38       [view]
39           keybindings for the message viewer
40
41       [view::passthrough]
42           keybindings for the viewer, when in key passthrough mode (toggled
43           with :toggle-key-passthrough)
44
45       [compose]
46           keybindings for the message composer
47
48       [compose::editor]
49           keybindings for the composer, when the editor is focused
50
51       [compose::review]
52           keybindings for the composer, when reviewing the email before it's
53           sent
54
55       [terminal]
56           keybindings for terminal tabs
57
58       You may also configure account specific key bindings for each context:
59
60       [context:account=AccountName]
61           keybindings for this context and account, where AccountName matches
62           the account name you provided in accounts.conf.
63
64       Folder-specific bindings can be configured for message lists:
65
66       [messages:folder=FolderName]
67           keybindings under this section will be specific to the folder named
68           FolderName. Keybindings from a folder specifier will take prece‐
69           dence over account specifiers
70
71       Example:
72
73           [messages:account=Mailbox]
74           c = :cf path:mailbox/** and<space>
75
76           [compose::editor:account=Mailbox2]
77
78           [messages:folder=Drafts]
79           <Enter> = :recall<Enter>
80           ...
81
82       You may also configure global keybindings by placing them at the begin‐
83       ning of the file, before specifying any context-specific sections.
84

SPECIAL OPTIONS

86       In addition of user defined key sequences, the following special op‐
87       tions are available in each binding context:
88
89       $noinherit = true|false
90           If set to true, global keybindings will not be effective in this
91           context.
92
93           Default: false
94
95       $ex = <key-stroke>
96           This can be set to a keystroke which will bring up the command in‐
97           put in this context.
98
99           Default: :
100

SUPPORTED KEYS

102       In addition to letters and some characters (e.g. a, RR, gu, ?, !,
103       etc.), special keys may be specified in <angle brackets>. The following
104       special keys are supported:
105
106       ┌────────────┬──────────────┐
107       │Name        │ Description  │
108       ├────────────┼──────────────┤
109       │<space>     │     " "      │
110       ├────────────┼──────────────┤
111       │<semicolon> │      ;       │
112       ├────────────┼──────────────┤
113       │<tab>       │     Tab      │
114       ├────────────┼──────────────┤
115       │<enter>     │    Enter     │
116       ├────────────┼──────────────┤
117       │<up>        │   Up arrow   │
118       ├────────────┼──────────────┤
119       │<c-up>      │   Ctrl+Up    │
120       ├────────────┼──────────────┤
121       │<a-up>      │    Alt+Up    │
122       ├────────────┼──────────────┤
123       │<down>      │  Down arrow  │
124       ├────────────┼──────────────┤
125       │<c-down>    │  Ctrl+Down   │
126       ├────────────┼──────────────┤
127       │<a-down>    │   Alt+Down   │
128       ├────────────┼──────────────┤
129       │<right>     │ Right arrow  │
130       ├────────────┼──────────────┤
131       │<c-right>   │  Ctrl+Right  │
132       ├────────────┼──────────────┤
133       │<a-right>   │  Alt+Right   │
134       ├────────────┼──────────────┤
135       │<left>      │  Left arrow  │
136       ├────────────┼──────────────┤
137       │<c-left>    │  Ctrl+Left   │
138       ├────────────┼──────────────┤
139       │<a-left>    │   Alt+Left   │
140       ├────────────┼──────────────┤
141       │<pgup>      │   Page Up    │
142       ├────────────┼──────────────┤
143       │<c-pgup>    │ Ctrl+PageUp  │
144       ├────────────┼──────────────┤
145       │<a-pgup>    │  Alt+PageUp  │
146       ├────────────┼──────────────┤
147       │<pgdn>      │  Page Down   │
148       ├────────────┼──────────────┤
149       │<c-pgdn>    │ Ctrl+PageDn  │
150       ├────────────┼──────────────┤
151       │<a-pgdn>    │  Alt+PageDn  │
152       ├────────────┼──────────────┤
153       │<home>      │     Home     │
154       ├────────────┼──────────────┤
155       │<end>       │     End      │
156       ├────────────┼──────────────┤
157       │<insert>    │    Insert    │
158       ├────────────┼──────────────┤
159       │<delete>    │    Delete    │
160       ├────────────┼──────────────┤
161       │<exit>      │     Exit     │
162       ├────────────┼──────────────┤
163       │<cancel>    │    Cancel    │
164       ├────────────┼──────────────┤
165       │<print>     │ Print screen │
166       ├────────────┼──────────────┤
167       │<pause>     │    Pause     │
168       ├────────────┼──────────────┤
169       │<backtab>   │  Shift+Tab   │
170       ├────────────┼──────────────┤
171       │<c-space>   │  Ctrl+Space  │
172       ├────────────┼──────────────┤
173       │<a-space>   │  Alt+Space   │
174       ├────────────┼──────────────┤
175       │<c-a>       │    Ctrl+a    │
176       ├────────────┼──────────────┤
177       │<a-a>       │    Alt+a     │
178       ├────────────┼──────────────┤
179       │<c-b>       │    Ctrl+b    │
180       ├────────────┼──────────────┤
181       │<a-b>       │    Alt+b     │
182       ├────────────┼──────────────┤
183       │<c-c>       │    Ctrl+c    │
184       ├────────────┼──────────────┤
185       │<a-c>       │    Alt+c     │
186       ├────────────┼──────────────┤
187       │<c-d>       │    Ctrl+d    │
188       ├────────────┼──────────────┤
189       │<a-d>       │    Alt+d     │
190       ├────────────┼──────────────┤
191       │<c-e>       │    Ctrl+e    │
192       ├────────────┼──────────────┤
193       │<a-e>       │    Alt+e     │
194       ├────────────┼──────────────┤
195       │<c-f>       │    Ctrl+f    │
196       ├────────────┼──────────────┤
197       │<a-f>       │    Alt+f     │
198       ├────────────┼──────────────┤
199       │<c-g>       │    Ctrl+g    │
200       ├────────────┼──────────────┤
201       │<a-g>       │    Alt+g     │
202       ├────────────┼──────────────┤
203       │<c-h>       │    Ctrl+h    │
204       ├────────────┼──────────────┤
205       │<a-h>       │    Alt+h     │
206       ├────────────┼──────────────┤
207       │<c-i>       │    Ctrl+i    │
208       ├────────────┼──────────────┤
209       │<a-i>       │    Alt+i     │
210       ├────────────┼──────────────┤
211       │<c-j>       │    Ctrl+j    │
212       ├────────────┼──────────────┤
213       │<a-j>       │    Alt+j     │
214       ├────────────┼──────────────┤
215       │<c-k>       │    Ctrl+k    │
216       ├────────────┼──────────────┤
217       │<a-k>       │    Alt+k     │
218       ├────────────┼──────────────┤
219       │<c-l>       │    Ctrl+l    │
220       ├────────────┼──────────────┤
221       │<a-l>       │    Alt+l     │
222       ├────────────┼──────────────┤
223       │<c-m>       │    Ctrl+m    │
224       ├────────────┼──────────────┤
225       │<a-m>       │    Alt+m     │
226       ├────────────┼──────────────┤
227       │<c-n>       │    Ctrl+n    │
228       ├────────────┼──────────────┤
229       │<a-n>       │    Alt+n     │
230       ├────────────┼──────────────┤
231       │<c-o>       │    Ctrl+o    │
232       ├────────────┼──────────────┤
233       │<a-o>       │    Alt+o     │
234       ├────────────┼──────────────┤
235       │<c-p>       │    Ctrl+p    │
236       ├────────────┼──────────────┤
237       │<a-p>       │    Alt+p     │
238       ├────────────┼──────────────┤
239       │<c-q>       │    Ctrl+q    │
240       ├────────────┼──────────────┤
241       │<a-q>       │    Alt+q     │
242       ├────────────┼──────────────┤
243       │<c-r>       │    Ctrl+r    │
244       ├────────────┼──────────────┤
245       │<a-r>       │    Alt+r     │
246       ├────────────┼──────────────┤
247       │<c-s>       │    Ctrl+s    │
248       ├────────────┼──────────────┤
249       │<a-s>       │    Alt+s     │
250       ├────────────┼──────────────┤
251       │<c-t>       │    Ctrl+t    │
252       ├────────────┼──────────────┤
253       │<a-t>       │    Alt+t     │
254       ├────────────┼──────────────┤
255       │<c-u>       │    Ctrl+u    │
256       ├────────────┼──────────────┤
257       │<a-u>       │    Alt+u     │
258       ├────────────┼──────────────┤
259       │<c-v>       │    Ctrl+v    │
260       ├────────────┼──────────────┤
261       │<a-v>       │    Alt+v     │
262       ├────────────┼──────────────┤
263       │<c-w>       │    Ctrl+w    │
264       ├────────────┼──────────────┤
265       │<a-w>       │    Alt+w     │
266       ├────────────┼──────────────┤
267       │<c-x>       │    Ctrl+x    │
268       ├────────────┼──────────────┤
269       │<a-x>       │    Alt+x     │
270       ├────────────┼──────────────┤
271       │<c-y>       │    Ctrl+y    │
272       ├────────────┼──────────────┤
273       │<a-y>       │    Alt+y     │
274       ├────────────┼──────────────┤
275       │<c-z>       │    Ctrl+z    │
276       ├────────────┼──────────────┤
277       │<a-z>       │    Alt+z     │
278       ├────────────┼──────────────┤
279       │<c-]>       │    Ctrl+]    │
280       ├────────────┼──────────────┤
281       │<a-]>       │    Alt+]     │
282       ├────────────┼──────────────┤
283       │<c-[>       │    Ctrl+[    │
284       ├────────────┼──────────────┤
285       │<a-[>       │    Alt+[     │
286       ├────────────┼──────────────┤
287       │<c-^>       │    Ctrl+^    │
288       ├────────────┼──────────────┤
289       │<a-^>       │    Alt+^     │
290       ├────────────┼──────────────┤
291       │<c-_>       │    Ctrl+_    │
292       ├────────────┼──────────────┤
293       │<a-_>       │    Alt+_     │
294       └────────────┴──────────────┘
295

SEE ALSO

297       aerc(1) aerc-config(5)
298

AUTHORS

300       Originally created by Drew DeVault <sir@cmpwn.com> and maintained by
301       Robin Jarry <robin@jarry.cc> who is assisted by other open source con‐
302       tributors. For more information about aerc development, see
303       https://sr.ht/~rjarry/aerc/.
304
305
306
307                                  2023-07-19                     AERC-BINDS(5)