diff options
author | Robin Jarry <robin@jarry.cc> | 2022-11-23 23:08:43 +0100 |
---|---|---|
committer | Robin Jarry <robin@jarry.cc> | 2022-11-24 19:19:10 +0100 |
commit | 4db1353d97552b60ff57cbd6987fbe9dc6e6724b (patch) | |
tree | 4992db58f11a68433d65797585c731bc604a713c /doc/aerc-accounts.5.scd | |
parent | 15743ca513bc4a7b2f34c0875fc23cda88398b33 (diff) | |
download | aerc-4db1353d97552b60ff57cbd6987fbe9dc6e6724b.tar.gz |
doc: extract accounts and binds into separate man pages
aerc-config(5) is getting too big and cluttered. Only keep aerc.conf
settings in it. Move binds.conf settings in aerc-binds(5) and
accounts.conf settings in aerc-accounts(5).
Adjust all references accordingly. Update the README to reference the
two new man pages. Update the Makefile to install them in proper
locations.
Signed-off-by: Robin Jarry <robin@jarry.cc>
Acked-by: Koni Marti <koni.marti@gmail.com>
Diffstat (limited to 'doc/aerc-accounts.5.scd')
-rw-r--r-- | doc/aerc-accounts.5.scd | 186 |
1 files changed, 186 insertions, 0 deletions
diff --git a/doc/aerc-accounts.5.scd b/doc/aerc-accounts.5.scd new file mode 100644 index 00000000..ed9d3e12 --- /dev/null +++ b/doc/aerc-accounts.5.scd @@ -0,0 +1,186 @@ +AERC-ACCOUNTS(5) + +# NAME + +aerc-accounts - account configuration file format for *aerc*(1) + +# SYNOPSIS + +The _accounts.conf_ file is used for configuring each mail account used for +aerc. It is expected to be in your XDG config home plus _aerc_, which defaults +to _~/.config/aerc/accounts.conf_. This file must be kept secret, as it may +include your account credentials. + +If _accounts.conf_ does not exist, the *:new-account* configuration wizard will +be executed automatically on first startup. + +This file is written in the ini format where each *[section]* is the name of an +account you want to configure, and the keys & values in that section specify +details of that account's configuration. In addition to the options documented +here, specific transports for incoming and outgoing emails may have additional +configuration parameters, documented on their respective man pages. + +# CONFIGURATION + +Note that many of these configuration options are written for you, such as +*source* and *outgoing*, when you run the account configuration wizard +(*:new-account*). + +*archive* + Specifies a folder to use as the destination of the *:archive* command. + + Default: _Archive_ + +*check-mail* + Specifies an interval to check for new mail. Mail will be checked at + startup, and every interval. IMAP accounts will check for mail in all + unselected folders, and the selected folder will continue to receive PUSH + mail notifications. Maildir/Notmuch folders must use *check-mail-cmd* in + conjunction with this option. See *aerc-maildir* and *aerc-notmuch* for + more information. + + Setting this option to _0_ will disable *check-mail* + + Example: + *check-mail* = _5m_ + + Default: _0_ + +*copy-to* + Specifies a folder to copy sent mails to, usually _Sent_. + +*default* + Specifies the default folder to open in the message list when aerc + configures this account. + + Default: _INBOX_ + +*folders* + Specifies the comma separated list of folders to display in the sidebar. + Names prefixed with _~_ are interpreted as regular expressions. + + Default: all folders + +*folders-exclude* + Specifies the comma separated list of folders to exclude from the sidebar. + Names prefixed with _~_ are interpreted as regular expressions. + Note that this overrides anything from *folders*. + + Default: no folders + +*enable-folders-sort* + If _true_, folders are sorted, first by specified folders (see *folders-sort*), + then alphabetically. + + Default: _true_ + +*folders-sort* + Specifies a comma separated list of folders to be shown at the top of the + list in the provided order. Remaining folders will be sorted alphabetically. + +*from* + The default value to use for the From header in new emails. This should be + an RFC 5322-compatible string, such as _Your Name <you@example.org>_. + +*aliases* + All aliases of the current account. These will be used to fill in the From: + field. Make sure that your email server accepts this value, or for example + use *aerc-sendmail*(5) in combination with *msmtp*(1) and + *--read-envelope-from*. + +*outgoing* + 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 + more details: + + - *aerc-sendmail*(5) + - *aerc-smtp*(5) + +*outgoing-cred-cmd* + Specifies an optional command that is run to get the outgoing account's + password. See each protocol's man page for more details. + +*outgoing-cred-cmd-cache* + By default, the credentials returned by the command will be cached until + aerc is shut down. If set to _false_, *outgoing-cred-cmd* will be executed + every time an email is to be sent. + + Default: _true_ + +*pgp-auto-sign* + If _true_, all outgoing emails from this account will be signed (if a signing + 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. + +*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. + + Default: _false_ + +*postpone* + Specifies the folder to save postponed messages to. + + Default: _Drafts_ + +*send-as-utc* + Converts the timestamp of the Date header to UTC. + + Default: _false_ + +*source* + Specifies the source for reading incoming emails on this account. This key + is required for all accounts. 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 more details: + + - *aerc-imap*(5) + - *aerc-maildir*(5) + - *aerc-notmuch*(5) + +*source-cred-cmd* + Specifies an optional command that is run to get the source account's + password. See each protocol's man page for more details. + +*signature-file* + Specifies the file to read in order to obtain the signature to be added + to emails sent from this account. + +*signature-cmd* + Specifies the command to execute with _sh -c_ in order to obtain the + signature to be added to emails sent from this account. If the command + fails then *signature-file* is used instead. + +*trusted-authres* + Comma-separated list of trustworthy hostnames from which the + Authentication Results header will be displayed. Entries can be regular + expressions. If you want to trust any host (e.g. for debugging), + use the wildcard _\*_. + +*subject-re-pattern* + When replying to a message, this is the regular expression that will + be used to match the prefix of the original message's subject that has + to be removed, to create the subject line of the new message. + Typically, this will be used to avoid a repetition of the Re: + prefix in the subject header. The default will match known + translations for the common Re:. + + Default: _(?i)^((AW|RE|SV|VS|ODP|R): ?)+_ + +# SEE ALSO + +*aerc*(1) *aerc-config*(5) *aerc-imap*(5) *aerc-maildir*(5) *aerc-notmuch*(5) +*aerc-sendmail*(5) *aerc-smtp*(5) + +# AUTHORS + +Originally created by Drew DeVault <sir@cmpwn.com> and maintained by Robin +Jarry <robin@jarry.cc> who is assisted by other open source contributors. For +more information about aerc development, see https://sr.ht/~rjarry/aerc/. |