1aerc-config(5) File Formats Manual aerc-config(5)
2
3
4
6 aerc-config - configuration file formats for aerc(1)
7
9 There are three aerc config files: aerc.conf, binds.conf, and ac‐
10 counts.conf. The last one must be kept secret, as it may include your
11 account credentials. We look for these files in your XDG config home
12 plus "aerc", which defaults to ~/.config/aerc.
13
14 Examples of these config files are typically included with your instal‐
15 lation of aerc and are usually installed in /usr/share/aerc.
16
17 Each file uses the ini format, and consists of sections with keys and
18 values. A line beginning with # is considered a comment and ignored, as
19 are empty lines. New sections begin with [section-name] on a single
20 line, and keys and values are separated with "=".
21
23 This file is used for configuring the general appearance and behavior
24 of aerc.
25
26 GENERAL OPTIONS
27 These options are configured in the [general] section of aerc.conf.
28
29 default-save-path
30 Used as a default path for save operations if no other path is
31 specified.
32
33 pgp-provider
34 If set to "gpg", aerc will use system gpg binary and keystore for
35 all crypto operations. Otherwise, the internal openpgp implementa‐
36 tion will be used.
37
38 Default: internal
39
40 unsafe-accounts-conf
41 By default, the file permissions of accounts.conf must be restric‐
42 tive and only allow reading by the file owner (0600). Set this op‐
43 tion to true to ignore this permission check. Use this with care as
44 it may expose your credentials.
45
46 Default: false
47
48 UI OPTIONS
49 These options are configured in the [ui] section of aerc.conf.
50
51 index-format
52 Describes the format for each row in a mailbox view. This field is
53 compatible with mutt's printf-like syntax.
54
55 Default: %D %-17.17n %s
56
57 ┌─────────────────┬────────────────────────────┐
58 │Format specifier │ Description │
59 ├─────────────────┼────────────────────────────┤
60 │ %% │ literal % │
61 ├─────────────────┼────────────────────────────┤
62 │ %a │ sender address │
63 ├─────────────────┼────────────────────────────┤
64 │ %A │ reply-to address, or │
65 │ │ sender address if none │
66 ├─────────────────┼────────────────────────────┤
67 │ %C │ message number │
68 ├─────────────────┼────────────────────────────┤
69 │ %d │ formatted message time‐ │
70 │ │ stamp │
71 ├─────────────────┼────────────────────────────┤
72 │ %D │ formatted message time‐ │
73 │ │ stamp converted to local │
74 │ │ timezone │
75 ├─────────────────┼────────────────────────────┤
76 │ %f │ sender name and address │
77 ├─────────────────┼────────────────────────────┤
78 │ %F │ author name, or recipient │
79 │ │ name if the message is │
80 │ │ from you. The address is │
81 │ │ shown if no name part. │
82 ├─────────────────┼────────────────────────────┤
83 │ %g │ message labels (for exam‐ │
84 │ │ ple notmuch tags) │
85 ├─────────────────┼────────────────────────────┤
86 │ %i │ message id │
87 ├─────────────────┼────────────────────────────┤
88 │ %n │ sender name, or sender ad‐ │
89 │ │ dress if none │
90 ├─────────────────┼────────────────────────────┤
91 │ %r │ comma-separated list of │
92 │ │ formatted recipient names │
93 │ │ and addresses │
94 ├─────────────────┼────────────────────────────┤
95 │ %R │ comma-separated list of │
96 │ │ formatted CC names and ad‐ │
97 │ │ dresses │
98 ├─────────────────┼────────────────────────────┤
99 │ %s │ subject │
100 ├─────────────────┼────────────────────────────┤
101 │ %t │ the (first) address the │
102 │ │ new email was sent to │
103 ├─────────────────┼────────────────────────────┤
104 │ %T │ the account name which re‐ │
105 │ │ ceived the email │
106 ├─────────────────┼────────────────────────────┤
107 │ %u │ sender mailbox name (e.g. │
108 │ │ "smith" in "smith@exam‐ │
109 │ │ ple.net") │
110 ├─────────────────┼────────────────────────────┤
111 │ %v │ sender first name (e.g. │
112 │ │ "Alex" in "Alex Smith │
113 │ │ <smith@example.net>") │
114 ├─────────────────┼────────────────────────────┤
115 │ %Z │ flags (O=old, N=new, r=an‐ │
116 │ │ swered, D=deleted, │
117 │ │ !=flagged, *=marked) │
118 └─────────────────┴────────────────────────────┘
119 timestamp-format
120 See time.Time#Format at https://godoc.org/time#Time.Format
121
122 Default: "2006-01-02 03:04 PM" (ISO 8601 + 12 hour time)
123
124 this-day-time-format
125 Index-only time format for messages that were received/sent today.
126 If this is not specified, timestamp-format is used instead.
127
128 Default: ""
129
130 this-week-time-format
131 Index-only time format for messages that were received/sent within
132 the last 7 days. If this is not specified, timestamp-format is used
133 instead.
134
135 Default: ""
136
137 this-year-time-format
138 Index-only time format for messages that were received/sent this
139 year. If this is not specified, timestamp-format is used instead.
140
141 Default: ""
142
143 message-view-timestamp-format
144 If set, overrides timestamp-format for the message view.
145
146 Default: ""
147
148 message-view-this-day-time-format
149 If set, overrides timestamp-format in the message view for messages
150 that were received/sent today.
151
152 Default: ""
153
154 message-view-this-week-time-format
155 If set, overrides timestamp-format in the message view for messages
156 that were recieved/sent within the last 7 days.
157
158 Default: ""
159
160 message-view-this-year-time-format
161 If set, overrides timestamp-format in the message view for messages
162 that were received/sent this year.
163
164 Default: ""
165
166 sidebar-width
167 Width of the sidebar, including the border. Set to zero to disable
168 the sidebar.
169
170 Default: 20
171
172 empty-message
173 Message to display when viewing an empty folder.
174
175 Default: (no messages)
176
177 empty-dirlist
178 Message to display when no folders exists or are all filtered.
179
180 Default: (no folders)
181
182 mouse-enabled
183 Enable mouse events in the ui, e.g. clicking and scrolling with the
184 mousewheel
185
186 Default: false
187
188 new-message-bell
189 Ring the bell when a new message is received.
190
191 Default: true
192
193 pinned-tab-marker
194 Marker to show before a pinned tab's name.
195
196 Default: `
197
198 spinner
199 Animation shown while loading, split by spinner-delimiter (below)
200
201 Examples:
202 • spinner = "-_-,_-_"
203 • spinner = '. , .'
204 • spinner = ",|,/,-"
205
206
207 Default: "[..] , [..] , [..] , [..] , [..], [..] ,
208 [..] , [..] "
209
210 spinner-delimiter
211 Spinner delimiter to split string into an animation
212
213 Default: ","
214
215 sort
216 List of space-separated criteria to sort the messages by, see sort
217 command in aerc(1) for reference. Prefixing a criterion with "-r "
218 reverses that criterion.
219
220 Example: "from -r date"
221
222 Default: ""
223
224 dirlist-format
225 Describes the format string to use for the directory list
226
227 Default: %n %>r
228
229 ┌─────────────────┬───────────────────────────┐
230 │Format specifier │ Description │
231 ├─────────────────┼───────────────────────────┤
232 │ %% │ literal % │
233 ├─────────────────┼───────────────────────────┤
234 │ %n │ directory name │
235 ├─────────────────┼───────────────────────────┤
236 │ %N │ compacted directory name │
237 ├─────────────────┼───────────────────────────┤
238 │ %r │ recent/unseen/total mes‐ │
239 │ │ sage count │
240 ├─────────────────┼───────────────────────────┤
241 │ %>X │ make format specifier 'X' │
242 │ │ be right justified │
243 └─────────────────┴───────────────────────────┘
244 dirlist-delay
245 Delay after which the messages are actually listed when entering a
246 directory. This avoids loading messages when skipping over folders
247 and makes the UI more responsive. If you do not want that, set it
248 to 0s.
249
250 Default: 200ms
251
252 dirlist-tree
253 Display the directory list as a foldable tree.
254
255 Default: false
256
257 dirlist-collapse
258 If dirlist-tree is enabled, set level at which folders are col‐
259 lapsed by default. Set to 0 to disable.
260
261 Default: 0
262
263 next-message-on-delete
264 Moves to next message when the current message is deleted
265
266 Default: true
267
268 auto-mark-read
269 Set the "seen" flag when a message is opened in the message viewer.
270
271 Default: true
272
273 completion-popovers
274 Shows potential auto-completions for text inputs in popovers.
275
276 Default: true
277
278 completion-delay
279 How long to wait after the last input before auto-completion is
280 triggered.
281
282 Default: 250ms
283
284 border-char-vertical border-char-horizontal
285 Set stylable characters (via the 'border' element) for vertical and
286 horizontal borders.
287
288 Default: spaces
289
290 stylesets-dirs
291 The directories where the stylesets are stored. The config takes a
292 colon-separated list of dirs. If this is unset or if a styleset
293 cannot be found, the following paths will be used as a fallback in
294 that order:
295
296 ${XDG_CONFIG_HOME:-~/.config}/aerc/stylesets
297 ${XDG_DATA_HOME:-~/.local/share}/aerc/stylesets
298 /usr/local/share/aerc/stylesets
299 /usr/share/aerc/stylesets
300
301 Default: ""
302
303 styleset-name
304 The name of the styleset to be used to style the ui elements. The
305 stylesets are stored in the 'stylesets' directory in the config di‐
306 rectory.
307
308 Default: default
309
310 Have a look at aerc-stylesets(7) as to how a styleset looks like.
311
312 icon-unencrypted
313 The icon to display for unencrypted mails. The status indicator is
314 only displayed if an icon is set.
315
316 Default: ""
317
318 icon-encrypted
319 The icon to display for encrypted mails.
320
321 Default: [e]
322
323 icon-signed
324 The icon to display for signed mails where the signature was suc‐
325 cessfully validated.
326
327 Default: [s]
328
329 icon-signed-encrypted
330 The icon to display for signed and encrypted mails where the signa‐
331 ture was successfully verified. The combined icon is only used if
332 set, otherwise the signed and encrypted icons are displayed sepa‐
333 rately.
334
335 Default: ""
336
337 icon-unknown
338 The icon to display for signed mails which could not be verified
339 due to the key being unknown.
340
341 Default: [s?]
342
343 icon-invalid
344 The icon to display for signed mails where verification failed.
345
346 Default: [s!]
347
348 fuzzy-complete
349 When typing a command or option, the popover will now show not only
350 the items /starting/ with the string input by the user, but it will
351 also show instances of items /containing/ the string, starting at
352 any position and need not be consecutive characters in the command
353 or option.
354
355 threading-enabled
356 Enable a threaded view of messages. If this is not supported by the
357 backend (IMAP server or notmuch), threads will be built by the
358 client.
359
360 Default: false
361
362 force-client-threads
363 Force threads to be built client-side. Backends that don't support
364 threading will always build threads client side.
365
366 Default: false
367
368 Contextual UI Configuration
369 The UI configuration can be specialized for accounts, specific mail di‐
370 rectories and message subjects. The specializations are added using
371 contextual config sections based on the context.
372
373 The contextual UI configuration is merged to the base UiConfig in the
374 following order: Base UIConfig > Account Context > Folder Context >
375 Subject Context.
376
377 [ui:account=<AccountName>]
378 Adds account specific configuration with the account name.
379
380 [ui:folder=<FolderName>]
381 Add folder specific configuration with the folder name.
382
383 [ui:folder~<Regex>]
384 Add folder specific configuration for folders whose names match the
385 regular expression.
386
387 [ui:subject~<Regex>]
388 Add specialized ui configuration for messages that match a given
389 regular expression.
390
391 Example:
392 [ui:account=Work]
393 sidebar-width=...
394
395 [ui:folder=Sent]
396 index-format=...
397
398 [ui:folder~Archive/d+/.*]
399 index-format=...
400
401 [ui:subject~^[PATCH]
402 index-format=...
403
404 STATUSLINE
405 These options are configured in the [statusline] section of aerc.conf.
406
407 render-format
408 Describes the format string for the statusline format.
409
410 For a minimal statusline that only shows the current account and
411 the connection information, use [%a] %c.
412
413 To completely mute the statusline (except for push notifications),
414 use %m only.
415
416 Default: [%a] %S %>%T
417
418 ┌─────────────────┬────────────────────────────┐
419 │Format specifier │ Description │
420 ├─────────────────┼────────────────────────────┤
421 │ %% │ literal % │
422 ├─────────────────┼────────────────────────────┤
423 │ %a │ active account name │
424 ├─────────────────┼────────────────────────────┤
425 │ %d │ active directory name │
426 ├─────────────────┼────────────────────────────┤
427 │ %c │ connection state │
428 ├─────────────────┼────────────────────────────┤
429 │ %p │ current path │
430 ├─────────────────┼────────────────────────────┤
431 │ %m │ mute statusline and show │
432 │ │ only push notifications │
433 ├─────────────────┼────────────────────────────┤
434 │ %S │ general status information │
435 │ │ (e.g. connection state, │
436 │ │ filter, search) │
437 ├─────────────────┼────────────────────────────┤
438 │ %T │ general on/off information │
439 │ │ (e.g. passthrough, thread‐ │
440 │ │ ing, sorting) │
441 ├─────────────────┼────────────────────────────┤
442 │ %> │ does not print anything │
443 │ │ but all format specifier │
444 │ │ that follow will be right │
445 │ │ justified. │
446 └─────────────────┴────────────────────────────┘
447 separator
448 Specifies the separator between grouped statusline elements (e.g.
449 for the %S and %T specifiers in render-format).
450
451 Default: " | "
452
453 display-mode
454 Defines the mode for displaying the status elements. Options: text,
455 icon
456
457 Default: text
458
459 VIEWER
460 These options are configured in the [viewer] section of aerc.conf.
461
462 pager
463 Specifies the pager to use when displaying emails. Note that some
464 filters may add ANSI escape sequences to add color to rendered
465 emails, so you may want to use a pager which supports ANSI.
466
467 Default: less -R
468
469 alternatives
470 If an email offers several versions (multipart), you can configure
471 which mimetype to prefer. For example, this can be used to prefer
472 plaintext over HTML emails.
473
474 Default: text/plain,text/html
475
476 header-layout
477 Defines the default headers to display when viewing a message. To
478 display multiple headers in the same row, separate them with a
479 pipe, e.g. "From|To". Rows will be hidden if none of their speci‐
480 fied headers are present in the message.
481
482 Authentication information from the Authentication-Results header
483 can be displayed by adding DKIM, SPF or DMARC. To show more infor‐
484 mation than just the authentication result, append a plus sign (+)
485 to the header name (e.g. DKIM+).
486
487 Default: From|To,Cc|Bcc,Date,Subject
488
489 show-headers
490 Default setting to determine whether to show full headers or only
491 parsed ones in message viewer.
492
493 Default: false
494
495 always-show-mime
496 Whether to always show the mimetype of an email, even when it is
497 just a single part.
498
499 Default: false
500
501 parse-http-links
502 Parses and extracts http links when viewing a message. Links can
503 then be accessed with the open-link command.
504
505 Default: true
506
507 COMPOSE
508 These options are configured in the [compose] section of aerc.conf.
509
510 editor
511 Specifies the command to run the editor with. It will be shown in
512 an embedded terminal, though it may also launch a graphical window
513 if the environment supports it. Defaults to $EDITOR, or vi(1).
514
515 header-layout
516 Defines the default headers to display when composing a message. To
517 display multiple headers in the same row, separate them with a
518 pipe, e.g. "To|From".
519
520 Default: To|From,Subject
521
522 address-book-cmd
523 Specifies the command to be used to tab-complete email addresses.
524 Any occurrence of "%s" in the address-book-cmd will be replaced
525 with anything the user has typed after the last comma.
526
527 The command must output the completions to standard output, one
528 completion per line. Each line must be tab-delimited, with an email
529 address occurring as the first field. Only the email address field
530 is required. The second field, if present, will be treated as the
531 contact name. Additional fields are ignored.
532
533 This parameter can also be set per account in accounts.conf.
534
535 Example:
536 khard email --remove-first-line --parsable '%s'
537
538 Default: none
539
540 reply-to-self
541 If set to false, do not mail yourself when replying (e.g., if re‐
542 plying to emails previously sent by yourself, address your replies
543 to the original To: and Cc:).
544
545 Default: true
546
547 no-attachment-warning
548 Specifies a regular expression against which an email's body should
549 be tested before sending an email with no attachment. If the regexp
550 matches, aerc will warn you before sending the message. Leave empty
551 to disable this feature.
552
553 Uses Go's regexp syntax, documented at https://golang.org/s/re2syn‐
554 tax. The "(?im)" flags are set by default (case-insensitive and
555 multi-line).
556
557 Example:
558 no-attachment-warning=^[^>]*attach(ed|ment)
559
560 Default: none
561
562 FILTERS
563 Filters allow you to pipe an email body through a shell command to ren‐
564 der certain emails differently, e.g. highlighting them with ANSI escape
565 codes. They are configured in the [filters] section of aerc.conf.
566
567 The first filter which matches the email's mimetype will be used, so
568 order them from most to least specific.
569
570 You can also match on non-mimetypes, by prefixing with the header to
571 match against (non-case-sensitive) and a comma, e.g. subject,text will
572 match a subject which contains "text". Use header,~regex to match
573 against a regex.
574
575 aerc ships with some default filters installed in the share directory
576 (usually /usr/share/aerc/filters). Note that these may have additional
577 dependencies that aerc does not have alone.
578
579 The filter commands are invoked with sh -c [command]. The following
580 folders are appended to the system $PATH to allow referencing filters
581 from their name only.
582
583 ${XDG_CONFIG_HOME:-~/.config}/aerc/filters
584 ${XDG_DATA_HOME:-~/.local/share}/aerc/filters
585 $PREFIX/share/aerc/filters
586 /usr/share/aerc/filters
587
588 The following variables are defined in the filter command environment:
589
590 AERC_MIME_TYPE
591 the part MIME type/subtype
592 AERC_FILENAME
593 the attachment filename (if any)
594
595 Note that said email body is converted into UTF-8 before being passed
596 to filters.
597
598 OPENERS
599 Openers allow you to specify the command to use for the :open action on
600 a per-MIME-type basis. They are configured in the [openers] section of
601 aerc.conf.
602
603 {} is expanded as the temporary filename to be opened. If it is not en‐
604 countered in the command, the temporary filename will be appened to the
605 end of the command. Environment variables are also expanded. Tilde is
606 not expanded.
607
608 Example:
609
610 [openers]
611 text/html=surf -dfgms
612 text/plain=gvim {} +125
613 message/rfc822=thunderbird
614
615 TRIGGERS
616 Triggers specify commands to execute when certain events occur.
617
618 They are configured in the [triggers] section of aerc.conf.
619
620 new-email
621 Executed when a new email arrives in the selected folder.
622
623 e.g. new-email=exec notify-send "New email from %n" "%s"
624
625 Default: ""
626
627 Format specifiers from index-format are expanded with respect to
628 the new message.
629
630 TEMPLATES
631 Templates are used to populate the body of an email. The compose, reply
632 and forward commands can be called with the -T flag with the name of
633 the template name.
634
635 aerc ships with some default templates installed in the share directory
636 (usually /usr/share/aerc/templates).
637
638 These options are configured in the [templates] section of aerc.conf.
639
640 template-dirs
641 The directory where the templates are stored. The config takes a
642 colon-separated list of dirs. If this is unset or if a template
643 cannot be found, the following paths will be used as a fallback in
644 that order:
645
646 ${XDG_CONFIG_HOME:-~/.config}/aerc/templates
647 ${XDG_DATA_HOME:-~/.local/share}/aerc/templates
648 /usr/local/share/aerc/templates
649 /usr/share/aerc/templates
650
651 Default: ""
652
653 new-message
654 The default template to be used for new messages.
655
656 Default: "new_message"
657
658 quoted-reply
659 The default template to be used for quoted replies.
660
661 Default: "quoted_reply"
662
663 forwards
664 The default template to be used for forward as body.
665
666 Default: "forward_as_body"
667
669 This file is used for configuring each mail account used for aerc. Each
670 section is the name of an account you want to configure, and the keys &
671 values in that section specify details of that account's configuration.
672 In addition to the options documented here, specific transports for in‐
673 coming and outgoing emails may have additional configuration parame‐
674 ters, documented on their respective man pages.
675
676 Note that many of these configuration options are written for you, such
677 as source and outgoing, when you run the account configuration wizard
678 (:new-account).
679
680 archive
681 Specifies a folder to use as the destination of the :archive com‐
682 mand.
683
684 Default: Archive
685
686 check-mail
687 Specifies an interval to check for new mail. Mail will be checked
688 at startup, and every interval. IMAP accounts will check for mail
689 in all unselected folders, and the selected folder will continue to
690 receive PUSH mail notifications. Maildir/Notmuch folders must use
691 check-mail-cmd in conjunction with this option. See aerc-maildir
692 and aerc-notmuch for more information.
693
694 Setting this option to 0 will disable check-mail
695
696 Example: 5m
697
698 Default: 0
699
700 copy-to
701 Specifies a folder to copy sent mails to, usually "Sent".
702
703 Default: none
704
705 default
706 Specifies the default folder to open in the message list when aerc
707 configures this account.
708
709 Default: INBOX
710
711 folders
712 Specifies the comma separated list of folders to display in the
713 sidebar. Names prefixed with ~ are interpreted as regular expres‐
714 sions.
715
716 Default: all folders
717
718 folders-exclude
719 Specifies the comma separated list of folders to exclude from the
720 sidebar. Names prefixed with ~ are interpreted as regular expres‐
721 sions. Note that this overrides anything from folders.
722
723 Default: no folders
724
725 enable-folders-sort
726 If true, folders are sorted, first by specified folders (see fold‐
727 ers-sort), then alphabetically.
728
729 Default: true
730
731 folders-sort
732 Specifies a comma separated list of folders to be shown at the top
733 of the list in the provided order. Remaining folders will be sorted
734 alphabetically.
735
736 Default: none
737
738 from
739 The default value to use for the From header in new emails. This
740 should be an RFC 5322-compatible string, such as "Your Name
741 <you@example.org>".
742
743 Default: none
744
745 aliases
746 All aliases of the current account. These will be used to fill in
747 the From: field. Make sure that your email server accepts this
748 value, or for example use aerc-sendmail(5) in combination with
749 msmtp and --read-envelope-from.
750
751 Default: none
752
753 outgoing
754 Specifies the transport for sending outgoing emails on this ac‐
755 count. It should be a connection string, and the specific meaning
756 of each component varies depending on the protocol in use. See
757 each protocol's man page for more details:
758
759 • aerc-smtp(5)
760
761
762 outgoing-cred-cmd
763 Specifies an optional command that is run to get the outgoing ac‐
764 count's password. See each protocol's man page for more details.
765
766 Default: none
767
768 outgoing-cred-cmd-cache
769 By default, the credentials returned by the command will be cached
770 until aerc is shut down. If set to false, outgoing-cred-cmd will be
771 executed every time an email is to be sent.
772
773 Default: true
774
775 pgp-auto-sign
776 If true, all outgoing emails from this account will be signed (if a
777 signing key is available)
778
779 Default: false
780
781 pgp-key-id
782 Specify the key id to use when signing a message. Can be either
783 short or long key id. If unset, aerc will look up the key by email
784
785 pgp-opportunistic-encrypt
786 If true, any outgoing email from this account will be encrypted
787 when all recipients (including "cc" and "bcc" field) have a public
788 key available in the keyring
789
790 Default: false
791
792 postpone
793 Specifies the folder to save postponed messages to.
794
795 Default: Drafts
796
797 send-as-utc
798 Converts the timestamp of the Date header to UTC.
799
800 Default: false
801
802 source
803 Specifies the source for reading incoming emails on this account.
804 This key is required for all accounts. It should be a connection
805 string, and the specific meaning of each component varies depending
806 on the protocol in use. See each protocol's man page for more de‐
807 tails:
808
809 • aerc-imap(5)
810 • aerc-maildir(5)
811 • aerc-notmuch(5)
812
813
814 Default: none
815
816 source-cred-cmd
817 Specifies an optional command that is run to get the source ac‐
818 count's password. See each protocol's man page for more details.
819
820 signature-file
821 Specifies the file to read in order to obtain the signature to be
822 added to emails sent from this account.
823
824 signature-cmd
825 Specifies the command to execute in sh in order to obtain the sig‐
826 nature to be added to emails sent from this account. If the command
827 fails then signature-file is used instead.
828
829 trusted-authres
830 Comma-separated list of trustworthy hostnames from which the Au‐
831 thentication Results header will be displayed. Entries can be regu‐
832 lar expressions. If you want to trust any host (e.g. for debug‐
833 ging), use the wildcard *.
834
836 This file is used for configuring keybindings used in the aerc interac‐
837 tive client. You may configure different keybindings for different con‐
838 texts by writing them into different [sections] of the ini file. The
839 available contexts are:
840
841 [messages]
842 keybindings for the message list
843
844 [view]
845 keybindings for the message viewer
846
847 [view::passthrough]
848 keybindings for the viewer, when in key passthrough mode (toggled
849 with :toggle-key-passthrough)
850
851 [compose]
852 keybindings for the message composer
853
854 [compose::editor]
855 keybindings for the composer, when the editor is focused
856
857 [compose::review]
858 keybindings for the composer, when reviewing the email before it's
859 sent
860
861 [terminal]
862 keybindings for terminal tabs
863
864 You may also configure account specific key bindings for each context:
865
866 [context:account=<AccountName>]
867 keybindings for this context and account, where <AccountName>
868 matches the account name you provided in accounts.conf.
869
870 Folder-specific bindings can be configured for message lists:
871
872 [messages:folder=<FolderName>]
873 keybindings under this section will be specific to the folder named
874 <FolderName>. Keybindings from a folder specifier will take prece‐
875 dence over account specifiers
876
877 Example:
878 [messages:account=Mailbox]
879 c = :cf path:mailbox/** and<space>
880
881 [compose::editor:account=Mailbox2]
882
883 [messages:folder=Drafts]
884 <Enter> = :recall<Enter>
885 ...
886
887 You may also configure global keybindings by placing them at the begin‐
888 ning of the file, before specifying any context-specific sections. For
889 each key=value option specified, the key is the keystrokes pressed (in
890 order) to invoke this keybinding, and value specifies keystrokes that
891 aerc will simulate when the keybinding is invoked. Generally this is
892 used to execute commands, for example:
893
894 rq = :reply -q<Enter>
895
896 Pressing r, then q, will simulate typing in ":reply -q<Enter>", and ex‐
897 ecute :reply -q accordingly. It is also possible to invoke keybindings
898 recursively in a similar fashion. Additionally, the following special
899 options are available in each binding context:
900
901 $noinherit
902 If set to "true", global keybindings will not be effective in this
903 context.
904
905 Default: false
906
907 $ex
908 This can be set to a keystroke which will bring up the command in‐
909 put in this context.
910
911 Default: ':'
912
913 In addition to letters, special keys may be specified in <angle brack‐
914 ets>. The following special keys are supported:
915
916 ┌──────────┬──────────────┐
917 │Name │ Description │
918 ├──────────┼──────────────┤
919 │space │ " " │
920 ├──────────┼──────────────┤
921 │semicolon │ ; │
922 ├──────────┼──────────────┤
923 │tab │ Tab │
924 ├──────────┼──────────────┤
925 │enter │ Enter │
926 ├──────────┼──────────────┤
927 │up │ Up arrow │
928 ├──────────┼──────────────┤
929 │c-up │ Ctrl+Up │
930 ├──────────┼──────────────┤
931 │a-up │ Alt+Up │
932 ├──────────┼──────────────┤
933 │down │ Down arrow │
934 ├──────────┼──────────────┤
935 │c-down │ Ctrl+Down │
936 ├──────────┼──────────────┤
937 │a-down │ Alt+Down │
938 ├──────────┼──────────────┤
939 │right │ Right arrow │
940 ├──────────┼──────────────┤
941 │c-right │ Ctrl+Right │
942 ├──────────┼──────────────┤
943 │a-right │ Alt+Right │
944 ├──────────┼──────────────┤
945 │left │ Left arrow │
946 ├──────────┼──────────────┤
947 │c-left │ Ctrl+Left │
948 ├──────────┼──────────────┤
949 │a-left │ Alt+Left │
950 ├──────────┼──────────────┤
951 │pgup │ Page Up │
952 ├──────────┼──────────────┤
953 │c-pgup │ Ctrl+PageUp │
954 ├──────────┼──────────────┤
955 │a-pgup │ Alt+PageUp │
956 ├──────────┼──────────────┤
957 │pgdn │ Page Down │
958 ├──────────┼──────────────┤
959 │c-pgdn │ Ctrl+PageDn │
960 ├──────────┼──────────────┤
961 │a-pgdn │ Alt+PageDn │
962 ├──────────┼──────────────┤
963 │home │ Home │
964 ├──────────┼──────────────┤
965 │end │ End │
966 ├──────────┼──────────────┤
967 │insert │ Insert │
968 ├──────────┼──────────────┤
969 │delete │ Delete │
970 ├──────────┼──────────────┤
971 │exit │ Exit │
972 ├──────────┼──────────────┤
973 │cancel │ Cancel │
974 ├──────────┼──────────────┤
975 │print │ Print screen │
976 ├──────────┼──────────────┤
977 │pause │ Pause │
978 ├──────────┼──────────────┤
979 │backtab │ Shift+Tab │
980 ├──────────┼──────────────┤
981 │c-space │ Ctrl+Space │
982 ├──────────┼──────────────┤
983 │a-space │ Alt+Space │
984 ├──────────┼──────────────┤
985 │c-a │ Ctrl+a │
986 ├──────────┼──────────────┤
987 │a-a │ Alt+a │
988 ├──────────┼──────────────┤
989 │c-b │ Ctrl+b │
990 ├──────────┼──────────────┤
991 │a-b │ Alt+b │
992 ├──────────┼──────────────┤
993 │c-c │ Ctrl+c │
994 ├──────────┼──────────────┤
995 │a-c │ Alt+c │
996 ├──────────┼──────────────┤
997 │c-d │ Ctrl+d │
998 ├──────────┼──────────────┤
999 │a-d │ Alt+d │
1000 ├──────────┼──────────────┤
1001 │c-e │ Ctrl+e │
1002 ├──────────┼──────────────┤
1003 │a-e │ Alt+e │
1004 ├──────────┼──────────────┤
1005 │c-f │ Ctrl+f │
1006 ├──────────┼──────────────┤
1007 │a-f │ Alt+f │
1008 ├──────────┼──────────────┤
1009 │c-g │ Ctrl+g │
1010 ├──────────┼──────────────┤
1011 │a-g │ Alt+g │
1012 ├──────────┼──────────────┤
1013 │c-h │ Ctrl+h │
1014 ├──────────┼──────────────┤
1015 │a-h │ Alt+h │
1016 ├──────────┼──────────────┤
1017 │c-i │ Ctrl+i │
1018 ├──────────┼──────────────┤
1019 │a-i │ Alt+i │
1020 ├──────────┼──────────────┤
1021 │c-j │ Ctrl+j │
1022 ├──────────┼──────────────┤
1023 │a-j │ Alt+j │
1024 ├──────────┼──────────────┤
1025 │c-k │ Ctrl+k │
1026 ├──────────┼──────────────┤
1027 │a-k │ Alt+k │
1028 ├──────────┼──────────────┤
1029 │c-l │ Ctrl+l │
1030 ├──────────┼──────────────┤
1031 │a-l │ Alt+l │
1032 ├──────────┼──────────────┤
1033 │c-m │ Ctrl+m │
1034 ├──────────┼──────────────┤
1035 │a-m │ Alt+m │
1036 ├──────────┼──────────────┤
1037 │c-n │ Ctrl+n │
1038 ├──────────┼──────────────┤
1039 │a-n │ Alt+n │
1040 ├──────────┼──────────────┤
1041 │c-o │ Ctrl+o │
1042 ├──────────┼──────────────┤
1043 │a-o │ Alt+o │
1044 ├──────────┼──────────────┤
1045 │c-p │ Ctrl+p │
1046 ├──────────┼──────────────┤
1047 │a-p │ Alt+p │
1048 ├──────────┼──────────────┤
1049 │c-q │ Ctrl+q │
1050 ├──────────┼──────────────┤
1051 │a-q │ Alt+q │
1052 ├──────────┼──────────────┤
1053 │c-r │ Ctrl+r │
1054 ├──────────┼──────────────┤
1055 │a-r │ Alt+r │
1056 ├──────────┼──────────────┤
1057 │c-s │ Ctrl+s │
1058 ├──────────┼──────────────┤
1059 │a-s │ Alt+s │
1060 ├──────────┼──────────────┤
1061 │c-t │ Ctrl+t │
1062 ├──────────┼──────────────┤
1063 │a-t │ Alt+t │
1064 ├──────────┼──────────────┤
1065 │c-u │ Ctrl+u │
1066 ├──────────┼──────────────┤
1067 │a-u │ Alt+u │
1068 ├──────────┼──────────────┤
1069 │c-v │ Ctrl+v │
1070 ├──────────┼──────────────┤
1071 │a-v │ Alt+v │
1072 ├──────────┼──────────────┤
1073 │c-w │ Ctrl+w │
1074 ├──────────┼──────────────┤
1075 │a-w │ Alt+w │
1076 ├──────────┼──────────────┤
1077 │c-x │ Ctrl+x │
1078 ├──────────┼──────────────┤
1079 │a-x │ Alt+x │
1080 ├──────────┼──────────────┤
1081 │c-y │ Ctrl+y │
1082 ├──────────┼──────────────┤
1083 │a-y │ Alt+y │
1084 ├──────────┼──────────────┤
1085 │c-z │ Ctrl+z │
1086 ├──────────┼──────────────┤
1087 │a-z │ Alt+z │
1088 ├──────────┼──────────────┤
1089 │c-] │ Ctrl+] │
1090 ├──────────┼──────────────┤
1091 │a-] │ Alt+] │
1092 ├──────────┼──────────────┤
1093 │c-[ │ Ctrl+[ │
1094 ├──────────┼──────────────┤
1095 │a-[ │ Alt+[ │
1096 ├──────────┼──────────────┤
1097 │c-^ │ Ctrl+^ │
1098 ├──────────┼──────────────┤
1099 │a-^ │ Alt+^ │
1100 ├──────────┼──────────────┤
1101 │c-_ │ Ctrl+_ │
1102 ├──────────┼──────────────┤
1103 │a-_ │ Alt+_ │
1104 └──────────┴──────────────┘
1105
1107 aerc(1) aerc-imap(5) aerc-smtp(5) aerc-maildir(5) aerc-sendmail(5)
1108 aerc-notmuch(5) aerc-stylesets(7)
1109
1111 Originally created by Drew DeVault <sir@cmpwn.com> and maintained by
1112 Robin Jarry <robin@jarry.cc> who is assisted by other open source con‐
1113 tributors. For more information about aerc development, see
1114 https://sr.ht/~rjarry/aerc/.
1115
1116
1117
1118 2022-11-02 aerc-config(5)