about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorBen Burwell <ben@benburwell.com>2019-12-20 13:21:35 -0500
committerDrew DeVault <sir@cmpwn.com>2019-12-21 09:23:22 -0500
commitfad375c673e7bab4b01bbe6a774fae460ce62b86 (patch)
tree52b5f904a53dca3d5e8b98adac91ac0ffcdbb646 /doc
parent4d00a2b4d6ef3b4bea5c06553538b4010b7c09c2 (diff)
downloadaerc-fad375c673e7bab4b01bbe6a774fae460ce62b86.tar.gz
Add address book completion in composer
Complete email address fields in the message composer with an external
address book command, compatible with mutt's query_cmd.
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-config.5.scd16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 01abefe..615c3ab 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -218,6 +218,22 @@ These options are configured in the *[compose]* section of aerc.conf.
 
 	Default: To|From,Subject
 
+*address-book-cmd*
+	Specifies the command to be used to tab-complete email addresses. Any
+	occurrence of "%s" in the address-book-cmd will be replaced with what the
+	user has typed so far.
+
+	The command must output the completions to standard output, one completion
+	per line. Each line must be tab-delimited, with an email address occurring as
+	the first field. Only the email address field is required. The second field,
+	if present, will be treated as the contact name. Additional fields are
+	ignored.
+
+	Example:
+		khard email --parsable '%s'
+
+	Default: none
+
 ## FILTERS
 
 Filters allow you to pipe an email body through a shell command to render