aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-accounts.5.scd60
-rw-r--r--doc/aerc-binds.5.scd4
-rw-r--r--doc/aerc-config.5.scd145
-rw-r--r--doc/aerc-imap.5.scd26
-rw-r--r--doc/aerc-maildir.5.scd8
-rw-r--r--doc/aerc-notmuch.5.scd16
-rw-r--r--doc/aerc-sendmail.5.scd4
-rw-r--r--doc/aerc-smtp.5.scd14
-rw-r--r--doc/aerc-stylesets.7.scd36
9 files changed, 143 insertions, 170 deletions
diff --git a/doc/aerc-accounts.5.scd b/doc/aerc-accounts.5.scd
index ed9d3e12..11d4d52c 100644
--- a/doc/aerc-accounts.5.scd
+++ b/doc/aerc-accounts.5.scd
@@ -26,18 +26,18 @@ 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*
+*archive* = _<folder>_
Specifies a folder to use as the destination of the *:archive* command.
Default: _Archive_
-*check-mail*
+*check-mail* = _<duration>_
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.
+ 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*(5)
+ and *aerc-notmuch*(5) for more information.
Setting this option to _0_ will disable *check-mail*
@@ -46,49 +46,49 @@ Note that many of these configuration options are written for you, such as
Default: _0_
-*copy-to*
+*copy-to* = _<folder>_
Specifies a folder to copy sent mails to, usually _Sent_.
-*default*
+*default* = _<folder>_
Specifies the default folder to open in the message list when aerc
configures this account.
Default: _INBOX_
-*folders*
+*folders* = _<folder1,folder2,folder3...>_
Specifies the comma separated list of folders to display in the sidebar.
Names prefixed with _~_ are interpreted as regular expressions.
- Default: all folders
+ By default, all folders are displayed.
-*folders-exclude*
+*folders-exclude* = _<folder1,folder2,folder3...>_
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
+ By default, no folders are excluded.
-*enable-folders-sort*
+*enable-folders-sort* = _true_|_false_
If _true_, folders are sorted, first by specified folders (see *folders-sort*),
then alphabetically.
Default: _true_
-*folders-sort*
+*folders-sort* = _<folder1,folder2,folder3...>_
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*
+*from* = _<address>_
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*
+*aliases* = _<address1,address2,address3...>_
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*
+*outgoing* = _<uri>_
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
@@ -97,45 +97,45 @@ Note that many of these configuration options are written for you, such as
- *aerc-sendmail*(5)
- *aerc-smtp*(5)
-*outgoing-cred-cmd*
+*outgoing-cred-cmd* = _<command>_
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*
+*outgoing-cred-cmd-cache* = _true_|_false_
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*
+*pgp-auto-sign* = _true_|_false_
If _true_, all outgoing emails from this account will be signed (if a signing
key is available).
Default: _false_
-*pgp-key-id*
+*pgp-key-id* = _<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*
+*pgp-opportunistic-encrypt* = _true_|_false_
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*
+*postpone* = _<folder>_
Specifies the folder to save postponed messages to.
Default: _Drafts_
-*send-as-utc*
+*send-as-utc* = _true_|_false_
Converts the timestamp of the Date header to UTC.
Default: _false_
-*source*
+*source* = _<uri>_
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.
@@ -145,26 +145,26 @@ Note that many of these configuration options are written for you, such as
- *aerc-maildir*(5)
- *aerc-notmuch*(5)
-*source-cred-cmd*
+*source-cred-cmd* = _<command>_
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*
+*signature-file* = _<path>_
Specifies the file to read in order to obtain the signature to be added
to emails sent from this account.
-*signature-cmd*
+*signature-cmd* = _<command>_
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*
+*trusted-authres* = _<host1,host2,host3...>_
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*
+*subject-re-pattern* = _<regexp>_
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.
diff --git a/doc/aerc-binds.5.scd b/doc/aerc-binds.5.scd
index f6a0f156..c6ce1827 100644
--- a/doc/aerc-binds.5.scd
+++ b/doc/aerc-binds.5.scd
@@ -89,12 +89,12 @@ the file, before specifying any context-specific sections.
In addition of user defined key sequences, the following special options are
available in each binding context:
-*$noinherit*
+*$noinherit* = _true_|_false_
If set to _true_, global keybindings will not be effective in this context.
Default: _false_
-*$ex*
+*$ex* = _<key-stroke>_
This can be set to a keystroke which will bring up the command input in this
context.
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 17a96f07..c95e5aab 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -28,17 +28,17 @@ _aerc.conf_ is used for configuring the general appearance and behavior of aerc.
These options are configured in the *[general]* section of _aerc.conf_.
-*default-save-path*
+*default-save-path* = _<path>_
Used as a default path for save operations if no other path is specified.
-*pgp-provider*
+*pgp-provider* = _gpg_|_internal_
If set to _gpg_, aerc will use system gpg binary and keystore for all
- crypto operations. Otherwise, the internal openpgp implementation will
- be used.
+ crypto operations. If set to _internal_, the internal openpgp keyring
+ will be used.
Default: _internal_
-*unsafe-accounts-conf*
+*unsafe-accounts-conf* = _true_|_false_
By default, the file permissions of _accounts.conf_ must be restrictive
and only allow reading by the file owner (_0600_). Set this option to
_true_ to ignore this permission check. Use this with care as it may
@@ -46,13 +46,13 @@ These options are configured in the *[general]* section of _aerc.conf_.
Default: _false_
-*log-file*
+*log-file* = _<path>_
Output log messages to specified file. A path starting with _~/_ is
expanded to the user home dir. When redirecting aerc's output to a file
using _>_ shell redirection, this setting is ignored and log messages
are printed to stdout.
-*log-level*
+*log-level* = _trace_|_debug_|_info_|_warn_|_error_
Only log messages above the specified level to *log-file*. Supported
levels are: _trace_, _debug_, _info_, _warn_ and _error_. When
redirecting aerc's output to a file using _>_ shell redirection, this
@@ -64,7 +64,7 @@ These options are configured in the *[general]* section of _aerc.conf_.
These options are configured in the *[ui]* section of _aerc.conf_.
-*index-format*
+*index-format* = _<format>_
Describes the format for each row in a mailbox view. This field is
compatible with mutt's printf-like syntax.
@@ -112,71 +112,71 @@ These options are configured in the *[ui]* section of _aerc.conf_.
| _%Z_
: flags (O=old, N=new, r=answered, D=deleted, !=flagged, \*=marked)
-*timestamp-format*
+*timestamp-format* = _<timeformat>_
See time.Time#Format at https://godoc.org/time#Time.Format
Default: _2006-01-02 03:04 PM_ (ISO 8601 + 12 hour time)
-*this-day-time-format*
+*this-day-time-format* = _<timeformat>_
Index-only time format for messages that were received/sent today.
If this is not specified, *timestamp-format* is used instead.
-*this-week-time-format*
+*this-week-time-format* = _<timeformat>_
Index-only time format for messages that were received/sent within the
last 7 days. If this is not specified, *timestamp-format* is used
instead.
-*this-year-time-format*
+*this-year-time-format* = _<timeformat>_
Index-only time format for messages that were received/sent this year.
If this is not specified, *timestamp-format* is used instead.
-*message-view-timestamp-format*
+*message-view-timestamp-format* = _<timeformat>_
If set, overrides *timestamp-format* for the message view.
-*message-view-this-day-time-format*
+*message-view-this-day-time-format* = _<timeformat>_
If set, overrides *timestamp-format* in the message view for messages
that were received/sent today.
-*message-view-this-week-time-format*
+*message-view-this-week-time-format* = _<timeformat>_
If set, overrides *timestamp-format* in the message view for messages
that were recieved/sent within the last 7 days.
-*message-view-this-year-time-format*
+*message-view-this-year-time-format* = _<timeformat>_
If set, overrides *timestamp-format* in the message view for messages
that were received/sent this year.
-*sidebar-width*
+*sidebar-width* = _<int>_
Width of the sidebar, including the border. Set to zero to disable the
sidebar.
Default: _20_
-*empty-message*
+*empty-message* = _<string>_
Message to display when viewing an empty folder.
Default: _(no messages)_
-*empty-dirlist*
+*empty-dirlist* = _<string>_
Message to display when no folders exists or are all filtered.
Default: _(no folders)_
-*mouse-enabled*
+*mouse-enabled* = _true_|_false_
Enable mouse events in the ui, e.g. clicking and scrolling with the mousewheel
Default: _false_
-*new-message-bell*
+*new-message-bell* = _true_|_false_
Ring the bell when a new message is received.
Default: _true_
-*pinned-tab-marker*
+*pinned-tab-marker* = _"<string>"_
Marker to show before a pinned tab's name.
Default: _`_
-*spinner*
+*spinner* = _"<string>"_
Animation shown while loading, split by *spinner-delimiter* (below)
Examples:
@@ -186,20 +186,20 @@ These options are configured in the *[ui]* section of _aerc.conf_.
Default: _"[..] , [..] , [..] , [..] , [..], [..] , [..] , [..] "_
-*spinner-delimiter*
+*spinner-delimiter* = _<string>_
Spinner delimiter to split string into an animation
Default: _,_
-*sort*
- List of space-separated criteria to sort the messages by, see *sort*
+*sort* = _<criteria>_
+ 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:
*sort* = _from -r date_
-*dirlist-format*
+*dirlist-format* = _<format>_
Describes the format string to use for the directory list.
Default: _%n %>r_
@@ -217,7 +217,7 @@ These options are configured in the *[ui]* section of _aerc.conf_.
| _%>X_
: make format specifier 'X' be right justified
-*dirlist-delay*
+*dirlist-delay* = _<duration>_
Delay after which the messages are actually listed when entering
a directory. This avoids loading messages when skipping over folders
and makes the UI more responsive. If you do not want that, set it to
@@ -225,51 +225,51 @@ These options are configured in the *[ui]* section of _aerc.conf_.
Default: _200ms_
-*dirlist-tree*
+*dirlist-tree* = _true_|_false_
Display the directory list as a foldable tree.
Default: _false_
-*dirlist-collapse*
+*dirlist-collapse* = _<int>_
If *dirlist-tree* is enabled, set level at which folders are collapsed
by default. Set to _0_ to disable.
Default: _0_
-*next-message-on-delete*
+*next-message-on-delete* = _true_|_false_
Moves to next message when the current message is deleted, archived, or moved.
Default: _true_
-*auto-mark-read*
+*auto-mark-read* = _true_|_false_
Set the _seen_ flag when a message is opened in the message viewer.
Default: _true_
-*completion-popovers*
+*completion-popovers* = _true_|_false_
Shows potential auto-completions for text inputs in popovers.
Default: _true_
-*completion-delay*
+*completion-delay* = _<duration>_
How long to wait after the last input before auto-completion is triggered.
Default: _250ms_
-*completion-min-chars*
+*completion-min-chars* = _<int>_
The minimum required characters to allow auto-completion to be triggered
after *completion-delay*.
Default: _1_
-*border-char-vertical*++
-*border-char-horizontal*
+*border-char-vertical* = _"<char>"_++
+*border-char-horizontal* = _"<char>"_
Set stylable characters (via the *border* element) for vertical and
horizontal borders.
Default: _" "_
-*stylesets-dirs*
+*stylesets-dirs* = _<path1:path2:path3...>_
The directories where the stylesets are stored. The config takes
a colon-separated list of dirs. If this is unset or if a styleset cannot
be found, the following paths will be used as a fallback in that order:
@@ -281,7 +281,7 @@ These options are configured in the *[ui]* section of _aerc.conf_.
/usr/share/aerc/stylesets
```
-*styleset-name*
+*styleset-name* = _<string>_
The name of the styleset to be used to style the ui elements. The
stylesets are stored in the _stylesets_ directory in the config
directory.
@@ -290,44 +290,44 @@ These options are configured in the *[ui]* section of _aerc.conf_.
Have a look at *aerc-stylesets*(7) as to how a styleset looks like.
-*icon-unencrypted*
+*icon-unencrypted* = _<string>_
The icon to display for unencrypted mails. The status indicator is only
displayed if an icon is set.
-*icon-encrypted*
+*icon-encrypted* = _<string>_
The icon to display for encrypted mails.
Default: _[e]_
-*icon-signed*
+*icon-signed* = _<string>_
The icon to display for signed mails where the signature was
successfully validated.
Default: _[s]_
-*icon-signed-encrypted*
+*icon-signed-encrypted* = _<string>_
The icon to display for signed and encrypted mails where the signature
was successfully verified. The combined icon is only used if set,
otherwise the signed and encrypted icons are displayed separately.
-*icon-unknown*
+*icon-unknown* = _<string>_
The icon to display for signed mails which could not be verified due to
the key being unknown.
Default: _[s?]_
-*icon-invalid*
+*icon-invalid* = _<string>_
The icon to display for signed mails where verification failed.
Default: _[s!]_
-*fuzzy-complete*
+*fuzzy-complete* = _true_|_false_
When typing a command or option, the popover will now show not only the
items /starting/ with the string input by the user, but it will also show
instances of items /containing/ the string, starting at any position and
need not be consecutive characters in the command or option.
-*reverse-msglist-order*
+*reverse-msglist-order* = _true_|_false_
Reverses the order of the message list. By default, the message list is
ordered with the newest (highest UID) message on top. Reversing the
order will put the oldest (lowest UID) message on top. This can be
@@ -335,7 +335,7 @@ These options are configured in the *[ui]* section of _aerc.conf_.
Default: _false_
-*reverse-thread-order*
+*reverse-thread-order* = _true_|_false_
Reverse display of the mesage threads. Default order is the the intial
message is on the top with all the replies being displayed below. The
reverse option will put the initial message at the bottom with the
@@ -343,7 +343,7 @@ These options are configured in the *[ui]* section of _aerc.conf_.
Default: _false_
-*sort-thread-siblings*
+*sort-thread-siblings* = _true_|_false_
Sort the thread siblings according to the sort criteria for the messages. If
sort-thread-siblings is false, the thread siblings will be sorted based on
the message UID. This option is only applicable for client-side threading
@@ -351,13 +351,13 @@ These options are configured in the *[ui]* section of _aerc.conf_.
Default: _false_
-*threading-enabled*
+*threading-enabled* = _true_|_false_
Enable a threaded view of messages. If this is not supported by the
backend (IMAP server or notmuch), threads will be built by the client.
Default: _false_
-*force-client-threads*
+*force-client-threads* = _true_|_false_
Force threads to be built client-side. Backends that don't support threading
will always build threads client side.
@@ -406,7 +406,7 @@ index-format=...
These options are configured in the *[statusline]* section of _aerc.conf_.
-*render-format*
+*render-format* = _<format>_
Describes the format string for the statusline format.
For a minimal statusline that only shows the current account and
@@ -438,15 +438,14 @@ These options are configured in the *[statusline]* section of _aerc.conf_.
| _%>_
: does not print anything but all format specifier that follow will be right justified.
-*separator*
+*separator* = _"<string>"_
Specifies the separator between grouped statusline elements (e.g. for
the _%S_ and _%T_ specifiers in *render-format*).
Default: _" | "_
-*display-mode*
+*display-mode* = _text_|_icon_
Defines the mode for displaying the status elements.
- Options: _text_, _icon_
Default: _text_
@@ -454,21 +453,21 @@ These options are configured in the *[statusline]* section of _aerc.conf_.
These options are configured in the *[viewer]* section of _aerc.conf_.
-*pager*
+*pager* = _<command>_
Specifies the pager to use when displaying emails. Note that some filters
may add ANSI escape sequences to add color to rendered emails, so you may
want to use a pager which supports ANSI.
Default: _less -R_
-*alternatives*
+*alternatives* = _<mime,types>_
If an email offers several versions (multipart), you can configure which
mimetype to prefer. For example, this can be used to prefer plaintext over
HTML emails.
Default: _text/plain,text/html_
-*header-layout*
+*header-layout* = _<header|layout,list...>_
Defines the default headers to display when viewing a message. To display
multiple headers in the same row, separate them with a pipe, e.g. _From|To_.
Rows will be hidden if none of their specified headers are present in the
@@ -483,24 +482,24 @@ These options are configured in the *[viewer]* section of _aerc.conf_.
Default: _From|To,Cc|Bcc,Date,Subject_
-*show-headers*
+*show-headers* = _true_|_false_
Default setting to determine whether to show full headers or only parsed
ones in message viewer.
Default: _false_
-*always-show-mime*
+*always-show-mime* = _true_|_false_
Whether to always show the mimetype of an email, even when it is just a single part.
Default: _false_
-*parse-http-links*
+*parse-http-links* = _true_|_false_
Parses and extracts http links when viewing a message. Links can then be
accessed with the *open-link* command.
Default: _true_
-*close-on-reply*
+*close-on-reply* = _true_|_false_
Close the view tab when replying. If the reply is not sent, reopen the view tab.
Default: _false_
@@ -509,20 +508,20 @@ These options are configured in the *[viewer]* section of _aerc.conf_.
These options are configured in the *[compose]* section of _aerc.conf_.
-*editor*
+*editor* = _<command>_
Specifies the command to run the editor with. It will be shown in an
embedded terminal, though it may also launch a graphical window if the
environment supports it.
Defaults to *$EDITOR*, or *vi*(1).
-*header-layout*
+*header-layout* = _<header|layout,list...>_
Defines the default headers to display when composing a message. To display
multiple headers in the same row, separate them with a pipe, e.g. _To|From_.
Default: _To|From,Subject_
-*address-book-cmd*
+*address-book-cmd* = _<command>_
Specifies the command to be used to tab-complete email addresses. Any
occurrence of _%s_ in the *address-book-cmd* will be replaced with anything
the user has typed after the last comma.
@@ -538,7 +537,7 @@ These options are configured in the *[compose]* section of _aerc.conf_.
Example:
*address-book-cmd* = _khard email --remove-first-line --parsable %s_
-*file-picker-cmd*
+*file-picker-cmd* = _<command>_
Specifies the command to be used to select attachments. Any occurence of
_%s_ in the *file-picker-cmd* will be replaced with the argument _<arg>_
to *:attach -m* _<arg>_.
@@ -549,14 +548,14 @@ These options are configured in the *[compose]* section of _aerc.conf_.
Example:
*file-picker-cmd* = _fzf --multi --query=%s_
-*reply-to-self*
+*reply-to-self* = _true_|_false_
If set to _false_, do not mail yourself when replying (e.g., if replying
to emails previously sent by yourself, address your replies to the
original To and Cc).
Default: _true_
-*no-attachment-warning*
+*no-attachment-warning* = _<regexp>_
Specifies a regular expression against which an email's body should be
tested before sending an email with no attachment. If the regexp
matches, aerc will warn you before sending the message. Leave empty to
@@ -769,7 +768,7 @@ Triggers specify commands to execute when certain events occur.
They are configured in the *[triggers]* section of _aerc.conf_.
-*new-email*
+*new-email* = _<command>_
Executed when a new email arrives in the selected folder.
e.g. new-email=exec notify-send "New email from %n" "%s"
@@ -788,7 +787,7 @@ _/usr/share/aerc/templates_).
These options are configured in the *[templates]* section of _aerc.conf_.
-*template-dirs*
+*template-dirs* = _<path1:path2:path3...>_
The directory where the templates are stored. The config takes
a colon-separated list of dirs. If this is unset or if a template cannot
be found, the following paths will be used as a fallback in that order:
@@ -800,17 +799,17 @@ These options are configured in the *[templates]* section of _aerc.conf_.
/usr/share/aerc/templates
```
-*new-message*
+*new-message* = _<template_name>_
The default template to be used for new messages.
Default: _new_message_
-*quoted-reply*
+*quoted-reply* = _<template_name>_
The default template to be used for quoted replies.
Default: _quoted_reply_
-*forwards*
+*forwards* = _<template_name>_
The default template to be used for forward as body.
Default: _forward_as_body_
diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd
index c00f784f..9057d2ea 100644
--- a/doc/aerc-imap.5.scd
+++ b/doc/aerc-imap.5.scd
@@ -19,9 +19,7 @@ IMAP configuration may be done interactively with the *:new-account* command.
In _accounts.conf_ (see *aerc-accounts*(5)), the following IMAP-specific options
are available:
-*source*
- _<scheme>_://_<username>_[_:<password>_]_@<hostname>_[_:<port>_]_?_[_<oauth2_params>_]
-
+*source* = _<scheme>_://_<username>_[_:<password>_]_@<hostname>_[_:<port>_]_?_[_<oauth2_params>_]
Remember that all fields must be URL encoded. The _@_ symbol, when URL
encoded, is _%40_.
@@ -58,7 +56,7 @@ are available:
IMAP with TLS/SSL using XOAUTH2 Authentication. Parameters are
the same as OAUTHBEARER.
-*source-cred-cmd*
+*source-cred-cmd* = _<command>_
Specifies the command to run to get the password for the IMAP
account. This command will be run using _sh -c command_. If a
password is specified in the *source* option, the password will
@@ -67,13 +65,13 @@ are available:
Example:
source-cred-cmd = pass hostname/username
-*connection-timeout*
+*connection-timeout* = _<duration_>
Maximum delay to establish a connection to the IMAP server. See
https://pkg.go.dev/time#ParseDuration.
Default: _30s_
-*keepalive-period*
+*keepalive-period* = _<duration>_
The interval between the last data packet sent (simple ACKs are not
considered data) and the first keepalive probe. After the connection is
marked to need keepalive, this counter is not used any further. See
@@ -81,7 +79,7 @@ are available:
By default, the system tcp socket settings are used.
-*keepalive-probes*
+*keepalive-probes* = _<int>_
The number of unacknowledged probes to send before considering the
connection dead and notifying the application layer.
@@ -91,7 +89,7 @@ are available:
This option is only supported on linux. On other platforms, it will be
ignored.
-*keepalive-interval*
+*keepalive-interval* = _<duration>_
The interval between subsequential keepalive probes, regardless of what
the connection has exchanged in the meantime. Fractional seconds are
truncated.
@@ -102,7 +100,7 @@ are available:
This option is only supported on linux. On other platforms, it will be
ignored.
-*check-mail-include*
+*check-mail-include* = _<folder1,folder2,folder3...>_
Specifies the comma separated list of folders to include when checking for
new mail with *:check-mail*. Names prefixed with _~_ are interpreted as regular
expressions. This setting is ignored if your IMAP server supports the
@@ -110,7 +108,7 @@ are available:
By default, all folders are included.
-*check-mail-exclude*
+*check-mail-exclude* = _<folder1,folder2,folder3...>_
Specifies the comma separated list of folders to exclude when checking for
new mail with *:check-mail*. Names prefixed with _~_ are interpreted as regular
expressions. This setting is ignored if your IMAP server supports the
@@ -119,26 +117,26 @@ are available:
By default, no folders are excluded.
-*cache-headers*
+*cache-headers* = _true_|_false_
If set to _true_, headers will be cached. The cached headers will be stored
in _$XDG_CACHE_HOME/aerc_, which defaults to _~/.cache/aerc_.
Default: _false_
-*cache-max-age*
+*cache-max-age* = _<duration>_
Defines the maximum age of cached files. Note: the longest unit of time
*cache-max-age* can be specified in is hours. Set to _0_ to disable cleaning
the cache
Default: _720h_ (30 days)
-*idle-timeout*
+*idle-timeout* = _<duration>_
The length of time the client will wait for the server to send any final
update before the IDLE is closed.
Default: _10ms_
-*idle-debounce*
+*idle-debounce* = _<duration>_
Specifies the length of time from the last client command until the
idler starts.
diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd
index 528d7953..f83ca3d8 100644
--- a/doc/aerc-maildir.5.scd
+++ b/doc/aerc-maildir.5.scd
@@ -15,22 +15,20 @@ must be added manually to the _accounts.conf_ file (see *aerc-accounts*(5)).
The following maildir-specific options are available:
-*check-mail-cmd*
+*check-mail-cmd* = _<command>_
Command to run in conjunction with *check-mail* option.
Example:
check-mail-cmd = mbsync -a
-*check-mail-timeout*
+*check-mail-timeout* = _<duration>_
Timeout for the *check-mail-cmd*. The command will be stopped if it does
not complete in this interval and an error will be displayed. Increase from
the default if repeated errors occur
Default: 10s
-*source*
- maildir://_<path>_
-
+*source* = _maildir_|_maildirpp_://_<path>_
The *source* indicates the path to the directory containing your maildirs
rather than one maildir specifically.
diff --git a/doc/aerc-notmuch.5.scd b/doc/aerc-notmuch.5.scd
index 1265b4c5..0ba57d1e 100644
--- a/doc/aerc-notmuch.5.scd
+++ b/doc/aerc-notmuch.5.scd
@@ -20,22 +20,20 @@ must be added manually.
In _accounts.conf_ (see *aerc-accounts*(5)), the following notmuch-specific
options are available:
-*check-mail-cmd*
+*check-mail-cmd* = _<command>_
Command to run in conjunction with *check-mail* option.
Example:
check-mail-cmd = mbsync -a
-*check-mail-timeout*
+*check-mail-timeout* = _<duration>_
Timeout for the *check-mail-cmd*. The command will be stopped if it does
not complete in this interval and an error will be displayed. Increase from
the default if repeated errors occur
- Default: 10s
-
-*source*
- notmuch://_<path>_
+ Default: _10s_
+*source* = notmuch://_<path>_
The *source* indicates the path to the directory containing your notmuch
database (usually a _.notmuch/_ folder).
@@ -47,7 +45,7 @@ options are available:
source = notmuch://~/mail
-*query-map*
+*query-map* = _<file>_
Path to a file containing a mapping from display name to notmuch query
in the form of *<NAME>*=_<QUERY>_.
@@ -56,13 +54,13 @@ options are available:
e.g. inbox=tag:inbox and not tag:archived
-*exclude-tags*
+*exclude-tags* = _<tag1,tag2,tag3...>_
Comma separated list of tags which will be excluded from query results,
unless explicitly mentioned in the query.
This can for example be useful if you use an _archive_ or _spam_ tag.
-*maildir-store*
+*maildir-store* = _<path>_
Path to the maildir store containing the message files backing the
notmuch database. This is often the same as the notmuch database path.
This is optional. If specified, it will be used by aerc to list
diff --git a/doc/aerc-sendmail.5.scd b/doc/aerc-sendmail.5.scd
index 7aa0f8a4..93ad6662 100644
--- a/doc/aerc-sendmail.5.scd
+++ b/doc/aerc-sendmail.5.scd
@@ -13,9 +13,7 @@ aerc can defer to sendmail for the delivery of outgoing messages.
In _accounts.conf_ (see *aerc-accounts*(5)), the following sendmail-specific
options are available:
-*outgoing*
- _</path/to/sendmail>_
-
+*outgoing* = _</path/to/sendmail>_
This should be set to the path to the sendmail binary you wish to use,
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.
diff --git a/doc/aerc-smtp.5.scd b/doc/aerc-smtp.5.scd
index b1a28a5c..75837150 100644
--- a/doc/aerc-smtp.5.scd
+++ b/doc/aerc-smtp.5.scd
@@ -15,9 +15,7 @@ SMTP configuration may be done interactively with the *:new-account* command.
In _accounts.conf_ (see *aerc-accounts*(5)), the following SMTP-specific options
are available:
-*outgoing*
- _<scheme>_+_<auth>_://_<username>_[_:<password>_]_@<hostname>_[_:<port>_]?[_<oauth2_params>_]
-
+*outgoing* = _<scheme>_+_<auth>_://_<username>_[_:<password>_]_@<hostname>_[_:<port>_]?[_<oauth2_params>_]
Remember that all fields must be URL encoded. The _@_ symbol, when URL
encoded, is _%40_.
@@ -51,7 +49,7 @@ are available:
SMTP with TLS/SSL using XOAUTH2 Authentication. See
documentation in *aerc-imap*(5) for usage.
-*outgoing-cred-cmd*
+*outgoing-cred-cmd* = _<command>_
Specifies the command to run to get the password for the SMTP
account. This command will be run using _sh -c [command]_. If a
password is specified in the *outgoing* option, the password will
@@ -60,9 +58,11 @@ are available:
Example:
outgoing-cred-cmd = pass hostname/username
-*smtp-starttls*
- Set this to _yes_ if the server uses STARTTLS. In that case you should also
- use _smtp://_ instead of _smtps://_.
+*smtp-starttls* = _true_|_false_
+ Set this to _true_ if the server uses STARTTLS. In that case you should
+ also use _smtp://_ instead of _smtps://_.
+
+ Default: _false_
# SEE ALSO
diff --git a/doc/aerc-stylesets.7.scd b/doc/aerc-stylesets.7.scd
index 06efeba2..d82ba7cf 100644
--- a/doc/aerc-stylesets.7.scd
+++ b/doc/aerc-stylesets.7.scd
@@ -26,60 +26,42 @@ to configure multiple style objects at a time.
The following options are available to be modified for each of the
style objects.
-*fg*
+*<object>*.*fg* = _<color>_
The foreground color of the style object is set.
- Syntax: *<object>*.*fg* = _<color>_
-
-*bg*
+*<object>*.*bg* = _<color>_
The background color of the style object is set.
- Syntax: *<object>*.*bg* = _<color>_
-
-*bold*
+*<object>*.*bold* = _true_|_false_|_toggle_
The bold attribute of the style object is set/unset.
- Syntax: *<object>*.*bold* = _true_|_false_|_toggle_
-
-*blink*
+*<object>*.*blink* = _true_|_false_|_toggle_
The blink attribute of the style object is set/unset.
The terminal needs to support blinking text.
- Syntax: *<object>*.*blink* = _true_|_false_|_toggle_
-
-*underline*
+*<object>*.*underline* = _true_|_false_|_toggle_
The underline attribute of the style object is set/unset.
The terminal needs to support underline text.
- Syntax: *<object>*.*underline* = _true_|_false_|_toggle_
-
-*italic*
+*<object>*.*italic* = _true_|_false_|_toggle_
The italic attribute of the style object is set/unset.
The terminal needs to support italic text.
- Syntax: *<object>*.*italic* = _true_|_false_|_toggle_
-
-*reverse*
+*<object>*.*reverse* = _true_|_false_|_toggle_
Reverses the color of the style object. Exchanges the foreground
and background colors.
- Syntax: *<object>*.*reverse* = _true_|_false_|_toggle_
-
If the value is _false_, it doesn't change anything.
-*normal*
+*<object>*.*normal* = true
All the attributes of the style object are unset.
- Syntax: *<object>*.*normal* = true
-
The value doesn't matter.
-*default*
+*<object>*.*default* = true
Set the style object to the default style of the context. Usually
based on the terminal.
- Syntax: *<object>*.*default* = true
-
The value doesn't matter.
## STYLE OBJECTS
generated by cgit (git 2.34.1) at 2024-11-15 17:43:36 +0000