about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorJeffas <dev@jeffas.io>2019-09-19 23:37:45 +0100
committerDrew DeVault <sir@cmpwn.com>2019-09-20 14:56:02 -0400
commit36af93b8f44886b5f9b3c75d12950ce27b1b4bfc (patch)
tree1ba55c300f338703e3351e7f53d86e606385276c /doc
parent90d26da58a4af2d34328f5916adf3781222966c6 (diff)
downloadaerc-36af93b8f44886b5f9b3c75d12950ce27b1b4bfc.tar.gz
Add documentation for sort
This adds documentation for the config option and the command.
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-config.5.scd9
-rw-r--r--doc/aerc.1.scd25
2 files changed, 34 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 91b444a..67ab608 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -125,6 +125,15 @@ These options are configured in the *[ui]* section of aerc.conf.
 
 	Default: ","
 
+*sort*
+	List of space-separated criteria to sort the messages by, see *sort*
+	command in *aerc*(1) for reference. Prefixing a criterion with "-r "
+	reverses that criterion.
+
+	Example: "from -r date"
+
+	Default: ""
+
 *dirlist-format*
 	Describes the format string to use for the directory list
 
diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd
index 2ec17a4..e76b519 100644
--- a/doc/aerc.1.scd
+++ b/doc/aerc.1.scd
@@ -192,6 +192,31 @@ message list, the message in the message viewer, etc).
 	Selects the nth message in the message list (and scrolls it into view if
 	necessary).
 
+*sort* [[-r] <criterion>]...
+	Sorts the message list by the given criteria. *-r* sorts the
+	immediately following criterion in reverse order.
+
+	Available criteria:
+
+[[ *Criterion*
+:- *Description*
+|  arrival
+:- Date and time of the messages arrival
+|  cc
+:- Addresses in the "cc" field
+|  date
+:- Date and time of the message
+|  from
+:- Addresses in the "from" field
+|  read
+:- Presence of the read flag
+|  size
+:- Size of the message
+|  subject
+:- Subject of the message
+|  to
+:- Addresses in the "to" field
+
 *view*
 	Opens the message viewer to display the selected message.