diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/aerc-config.5.scd | 40 | ||||
| -rw-r--r-- | doc/aerc-imap.5.scd | 5 | ||||
| -rw-r--r-- | doc/aerc-maildir.5.scd | 2 | ||||
| -rw-r--r-- | doc/aerc-notmuch.5.scd | 6 | ||||
| -rw-r--r-- | doc/aerc-search.1.scd | 42 | ||||
| -rw-r--r-- | doc/aerc-sendmail.5.scd | 2 | ||||
| -rw-r--r-- | doc/aerc-smtp.5.scd | 3 | ||||
| -rw-r--r-- | doc/aerc-stylesets.7.scd | 12 | ||||
| -rw-r--r-- | doc/aerc-templates.7.scd | 4 | ||||
| -rw-r--r-- | doc/aerc-tutorial.7.scd | 11 | ||||
| -rw-r--r-- | doc/aerc.1.scd | 19 |
11 files changed, 67 insertions, 79 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd index e685eb55..852f01e3 100644 --- a/doc/aerc-config.5.scd +++ b/doc/aerc-config.5.scd @@ -211,12 +211,13 @@ These options are configured in the *[ui]* section of aerc.conf. command in *aerc*(1) for reference. Prefixing a criterion with "-r " reverses that criterion. - Example: "from -r date" + Example: + sort = from -r date Default: "" *dirlist-format* - Describes the format string to use for the directory list + Describes the format string to use for the directory list. Default: %n %>r @@ -553,7 +554,7 @@ These options are configured in the *[compose]* section of aerc.conf. This parameter can also be set per account in accounts.conf. Example: - khard email --remove-first-line --parsable '%s' + address-book-cmd = khard email --remove-first-line --parsable '%s' Default: none @@ -566,7 +567,7 @@ These options are configured in the *[compose]* section of aerc.conf. one file per line. Example: - file-picker-cmd=fzf --multi --query=%s + file-picker-cmd = fzf --multi --query=%s Default: none @@ -587,7 +588,7 @@ These options are configured in the *[compose]* section of aerc.conf. The "(?im)" flags are set by default (case-insensitive and multi-line). Example: - no-attachment-warning=^[^>]\*attach(ed|ment) + no-attachment-warning = ^[^>]\*attach(ed|ment) Default: none @@ -634,6 +635,22 @@ _AERC_FROM_ Note that said email body is converted into UTF-8 before being passed to filters. +Example: + +``` +[filters] +from,thatguywhodoesnothardwraphismessages=fmt -w 72 | colorize +subject,~Git(hub|lab)=lolcat -f +text/plain=colorize +text/calendar=calendar | colorize +message/delivery-status=colorize +message/rfc822=colorize +text/html=html | colorize +text/*=bat -fP --file-name="$AERC_FILENAME" +application/x-sh=bat -fP -l sh +image/*=catimg -w $(tput cols) - +``` + ## OPENERS Openers allow you to specify the command to use for the *:open* action on a @@ -737,7 +754,8 @@ Note that many of these configuration options are written for you, such as Setting this option to 0 will disable check-mail - Example: 5m + Example: + check-mail = 5m Default: 0 @@ -791,9 +809,9 @@ Note that many of these configuration options are written for you, such as Default: none *outgoing* - Specifies the transport for sending outgoing emails on this account. It + Specifies the transport for sending outgoing emails on this account. It should be a connection string, and the specific meaning of each component - varies depending on the protocol in use. See each protocol's man page for + varies depending on the protocol in use. See each protocol's man page for more details: - *aerc-smtp*(5) @@ -813,18 +831,18 @@ Note that many of these configuration options are written for you, such as *pgp-auto-sign* If true, all outgoing emails from this account will be signed (if a signing - key is available) + key is available). Default: false *pgp-key-id* Specify the key id to use when signing a message. Can be either short or - long key id. If unset, aerc will look up the key by email + long key id. If unset, aerc will look up the key by email. *pgp-opportunistic-encrypt* If true, any outgoing email from this account will be encrypted when all recipients (including "cc" and "bcc" field) have a public key available in - the keyring + the keyring. Default: false diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd index 2a5f6c8b..52809b4d 100644 --- a/doc/aerc-imap.5.scd +++ b/doc/aerc-imap.5.scd @@ -51,7 +51,7 @@ available: - scope (optional) Example: - imaps+oauthbearer://...?token_endpoint=https://...&client_id= + imaps+oauthbearer://...?token_endpoint=https://...&client_id= *imaps+xoauth2://* IMAP with TLS/SSL using XOAUTH2 Authentication. Parameters are @@ -64,8 +64,7 @@ available: take precedence over this command. Example: - - pass hostname/username + source-cred-cmd = pass hostname/username *connection-timeout* Maximum delay to establish a connection to the IMAP server. See diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd index 24f2ea2f..f1978d9a 100644 --- a/doc/aerc-maildir.5.scd +++ b/doc/aerc-maildir.5.scd @@ -19,7 +19,7 @@ The following maildir-specific options are available: Command to run in conjunction with *check-mail* option. Example: - mbsync -a + check-mail-cmd = mbsync -a Default: none diff --git a/doc/aerc-notmuch.5.scd b/doc/aerc-notmuch.5.scd index 1608b293..5415389c 100644 --- a/doc/aerc-notmuch.5.scd +++ b/doc/aerc-notmuch.5.scd @@ -24,7 +24,7 @@ options are available: Command to run in conjunction with *check-mail* option. Example: - mbsync -a + check-mail-cmd = mbsync -a Default: none @@ -81,13 +81,13 @@ Some commands are slightly different in semantics and mentioned below: *cf* <notmuch query> The change folder command allows for arbitrary notmuch queries. Performing a - cf command will perform a new top-level notmuch query + cf command will perform a new top-level notmuch query. *filter* <notmuch query> The filter command for notmuch backends takes in arbitrary notmuch queries. It applies the query on the set of messages shown in the message list. This can be used to perform successive filters/queries. It is equivalent to - performing a set of queries concatenated with "and" + performing a set of queries concatenated with "and". # SEE ALSO diff --git a/doc/aerc-search.1.scd b/doc/aerc-search.1.scd index 75dc96ad..7cda7d43 100644 --- a/doc/aerc-search.1.scd +++ b/doc/aerc-search.1.scd @@ -4,47 +4,7 @@ aerc-search(1) aerc-search - search and filter patterns and options for *aerc*(1) -# IMAP - -*search* [-ruba] [-x <flag>] [-X <flag>] [-f <from>] [-t <to>] [-c <cc>] [terms...] - Searches the current folder for messages matching the given set of - conditions. - - Each space separated term of *terms*, if provided, is searched - case-insensitively among subject lines unless *-b* or *-a* are - provided. - - *-r*: Search for read messages - - *-u*: Search for unread messages - - *-x <flag>*, *-X <flag>*: Restrict search to messages with or without <flag> - - Use *-x* to search for messages with the flag set. - Use *-X* to search for messages without the flag set. - - Possible values are: - - Seen - Read messages - - Answered - Replied messages - - Flagged - Flagged messages - - *-b*: Search in the body of the messages - - *-a*: Search in the entire text of the messages - - *-f <from>*: Search for messages from <from> - - *-t <to>*: Search for messages to <to> - - *-c <cc>*: Search for messages cc'ed to <cc> - -# MAILDIR +# MAILDIR & IMAP *search* [-ruba] [-x <flag>] [-X <flag>] [-f <from>] [-t <to>] [-c <cc>] [terms...] Searches the current folder for messages matching the given set of diff --git a/doc/aerc-sendmail.5.scd b/doc/aerc-sendmail.5.scd index 37935808..e1f0521e 100644 --- a/doc/aerc-sendmail.5.scd +++ b/doc/aerc-sendmail.5.scd @@ -17,7 +17,7 @@ options are available: /path/to/sendmail This should be set to the path to the sendmail binary you wish to use, - which is generally /usr/bin/sendmail. aerc will execute it with a list of + which is generally /usr/sbin/sendmail. aerc will execute it with a list of recipients on the command line and pipe the message to deliver to stdin. # SEE ALSO diff --git a/doc/aerc-smtp.5.scd b/doc/aerc-smtp.5.scd index ee2aa176..ef5e6aa5 100644 --- a/doc/aerc-smtp.5.scd +++ b/doc/aerc-smtp.5.scd @@ -58,8 +58,7 @@ available: take precedence over this command. Example: - - pass hostname/username + outgoing-cred-cmd = pass hostname/username *smtp-starttls* Set this to `yes` if the server uses STARTTLS. In that case you should also diff --git a/doc/aerc-stylesets.7.scd b/doc/aerc-stylesets.7.scd index acd5ac7c..f5272013 100644 --- a/doc/aerc-stylesets.7.scd +++ b/doc/aerc-stylesets.7.scd @@ -22,10 +22,11 @@ style object "msglist_unread" is set to "cornflowerblue" msglist_unread.fg=cornflowerblue ``` -The configuration also allows wildcard matching of the style_objects +The configuration also allows wildcard matching of the keys to configure multiple style objects at a time. ## Style + The following options are available to be modified for each of the style objects. @@ -83,6 +84,7 @@ style objects. _The value doesn't matter_ ## Style Objects + The style objects represent the various ui elements or ui instances for styling. @@ -148,6 +150,7 @@ styling. : The item chooser in a selector ui element. ## fnmatch style wildcard matching + The styleset configuration can be made simpler by using the fnmatch style wildcard matching for the style object. @@ -168,8 +171,9 @@ For example, the following wildcards can be made using this syntax. : Set the background color of all style objects that end in list to hotpink. ## Selected modifier -Selected modifier can be applied to any style object. The style provided for -the selected modifier are applied on top of the style object it corresponds to. + +The selected modifier can be applied to any style object. The style provided for +the selected modifier is applied on top of the style object it corresponds to. If you would like to make sure message that are flagged as read in the msglist appear in yellow foreground and black background. You can specify that with @@ -186,6 +190,7 @@ If we specify the global style selected modifier using fnmatch as below: This toggles the reverse switch for selected version of all the style objects. ## Layered styles + Some styles, (currently the `msglist\*` and `dirlist\*` ones) are applied in layers. If a style differs from the base (in this case `\{msglist|dirlist\}_default`) then that style applies, unless overridden by a higher layer. The order that `msglist` styles @@ -209,6 +214,7 @@ dirlist_recent ``` ## Colors + The color values are set using the values accepted by the tcell library. The values can be one of the following. diff --git a/doc/aerc-templates.7.scd b/doc/aerc-templates.7.scd index 0180a2d7..d9623c11 100644 --- a/doc/aerc-templates.7.scd +++ b/doc/aerc-templates.7.scd @@ -62,8 +62,8 @@ available always. The date and time information is always available and can be easily formatted. - - Date: Date and Time information when the compose window is opened. - - OriginalDate: Date and Time when the original message of received. + - Date: Date and time information when the compose window is opened. + - OriginalDate: Date and time when the original message of received. Available for quoted reply and forward. To format the date fields, _dateFormat_ and _toLocal_ are provided. diff --git a/doc/aerc-tutorial.7.scd b/doc/aerc-tutorial.7.scd index 9c932732..3f851d0e 100644 --- a/doc/aerc-tutorial.7.scd +++ b/doc/aerc-tutorial.7.scd @@ -2,7 +2,7 @@ aerc-tutorial(7) # NAME -aerc - the world's best email client +aerc-tutorial - tutorial for *aerc*(1) # INTRODUCTION @@ -137,10 +137,11 @@ When displaying messages in the message viewer, aerc will pipe them through a _message filter_ first. This allows you to decode messages in non-plaintext formats, add syntax highlighting, etc. aerc ships with a few default filters: -- Emails which begin with "[PATCH" will be piped into a filter for rendering - git-format-patch and hg export emails. -- text/html is rendered with w3m in a network sandbox -- text/\* is rendered with a simple filter for coloring quoted text +- _text/plain_ parts are piped through the _colorized_ built-in filter which + handles URL, quotes and diff coloring. +- _text/calendar_ is processed to be human readable text +- _text/html_ (disabled by default) can be uncommented to pipe through the + built-in _html_ filter. ## CUSTOMIZING AERC diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd index c1efc954..ca01938f 100644 --- a/doc/aerc.1.scd +++ b/doc/aerc.1.scd @@ -2,7 +2,7 @@ aerc(1) # NAME -aerc - the world's best email client +aerc - a pretty good email client. # SYNOPSIS @@ -313,7 +313,7 @@ message list, the message in the message viewer, etc). Remove the directory even if it contains messages. Some programs that sync maildirs may recover deleted directories (e.g. - offlineimap). These can either be specially configured to properly + offlineimap). These can either be specially configured to properly handle directory deletion, or special commands need to be run to delete directories (e.g. 'offlineimap --delete-folder'). @@ -360,8 +360,9 @@ message list, the message in the message viewer, etc). below the message list. If a + or - is prepended, the message list size will grow or shrink accordingly. The split can be cleared by calling :split 0, or just :split. The split can be toggled by calling split with - the same size repeatedly. For example, :split 10 will create a split. - Calling :split 10 again will remove the split. Also see *vsplit* + the same (absolute) size repeatedly. For example, :split 10 will create + a split. Calling :split 10 again will remove the split. Also see + *vsplit*. *sort* [[-r] <criterion>]... Sorts the message list by the given criteria. *-r* sorts the @@ -403,8 +404,9 @@ message list, the message in the message viewer, etc). of the message list. If a + or - is prepended, the message list size will grow or shrink accordingly. The split can be cleared by calling :vsplit 0, or just :vsplit. The split can be toggled by calling split - with the same size repeatedly. For example, :vsplit 10 will create a - split. Calling :vsplit 10 again will remove the split. Also see *split* + with the same (absolute) size repeatedly. For example, :vsplit 10 will + create a split. Calling :vsplit 10 again will remove the split. Also see + *split*. ## MESSAGE VIEW COMMANDS @@ -499,7 +501,7 @@ message list, the message in the message viewer, etc). is not currently visible in the compose window, a new one will be added. *edit* - (Re-) opens your text editor to edit the message in progress. + (Re-)opens your text editor to edit the message in progress. *next-field*, *prev-field* Cycles between input fields in the compose window. @@ -546,6 +548,9 @@ write log messages to that file: $ aerc > log +Persistent logging can be configured via the *log-file* and *log-level* settings +in _aerc.conf_. + # SEE ALSO *aerc-config*(5) *aerc-imap*(5) *aerc-smtp*(5) *aerc-maildir*(5) |