about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorBen Burwell <ben@benburwell.com>2019-07-02 23:14:43 -0400
committerDrew DeVault <sir@cmpwn.com>2019-07-04 11:08:55 -0400
commitcffa2365be267ca2b243eee0cbb40593c0e01a3d (patch)
tree6a686570fd893d752954b1531dc02b0f4fdc1206
parentddd0fa428f0a0e394883cdec2a11c351b70f72a2 (diff)
downloadaerc-cffa2365be267ca2b243eee0cbb40593c0e01a3d.tar.gz
Document message index format specifiers
-rw-r--r--config/aerc.conf.in2
-rw-r--r--doc/aerc-config.5.scd37
2 files changed, 37 insertions, 2 deletions
diff --git a/config/aerc.conf.in b/config/aerc.conf.in
index a5994a3..f63c15a 100644
--- a/config/aerc.conf.in
+++ b/config/aerc.conf.in
@@ -4,7 +4,7 @@
 [ui]
 #
 # Describes the format for each row in a mailbox view. This field is compatible
-# with mutt's printf-like syntax. TODO: document properly
+# with mutt's printf-like syntax.
 #
 # Default:
 index-format=%D %-17.17n %s
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 8e0e056..db69aff 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -36,10 +36,45 @@ These options are configured in the *[ui]* section of aerc.conf.
 
 *index-format*
 	Describes the format for each row in a mailbox view. This field is
-	compatible with mutt's printf-like syntax. TODO: document properly
+	compatible with mutt's printf-like syntax.
 
 	Default: %D %-17.17n %s
 
+[- *Format specifier*
+:[ *Description*
+|  %%
+:  literal %
+|  %a
+:  sender address
+|  %A
+:  reply-to address, or sender address if none
+|  %C
+:  message number
+|  %d
+:  formatted message timestamp
+|  %D
+:  formatted message timestamp converted to local timezone
+|  %f
+:  sender name and address
+|  %F
+:  sender name, or sender address if none
+|  %i
+:  message id
+|  %n
+:  same as %F
+|  %r
+:  comma-separated list of formatted recipient names and addresses
+|  %R
+:  comma-separated list of formatted CC names and addresses
+|  %s
+:  subject
+|  %u
+:  sender mailbox name (e.g. "smith" in "smith@example.net")
+|  %v
+:  sender first name (e.g. "Alex" in "Alex Smith <smith@example.net>")
+|  %Z
+:  flags (O=old, N=new, r=answered, D=deleted, !=flagged)
+
 *timestamp-format*
 	See time.Time#Format at https://godoc.org/time#Time.Format