Add documentation for sort

This adds documentation for the config option and the command.
This commit is contained in:
Jeffas 2019-09-19 23:37:45 +01:00 committed by Drew DeVault
parent 90d26da58a
commit 36af93b8f4
3 changed files with 43 additions and 0 deletions

View file

@ -48,6 +48,15 @@ new-message-bell=true
# Default: %n %>r
dirlist-format=%n %>r
# 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: ""
sort=
[viewer]
#
# Specifies the pager to use when displaying emails. Note that some filters

View file

@ -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

View file

@ -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.