aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-smtp.5.scd
diff options
context:
space:
mode:
authorRobin Jarry <robin@jarry.cc>2022-12-06 11:11:47 +0100
committerRobin Jarry <robin@jarry.cc>2022-12-06 11:26:08 +0100
commitc1784b624aea6c93e398a90a4274abe158e72b8a (patch)
tree25f06f286c0d910043592a4293490447373eac4e /doc/aerc-smtp.5.scd
parentc9524d265793775e4c3e326c7191471d982c1e66 (diff)
downloadaerc-c1784b624aea6c93e398a90a4274abe158e72b8a.tar.gz
doc: add synopsis for all settings
Instead of obscure descriptions for the settings format, add a synopsis for all settings in the man pages. Signed-off-by: Robin Jarry <robin@jarry.cc> Acked-by: Bence Ferdinandy <bence@ferdinandy.com>
Diffstat (limited to 'doc/aerc-smtp.5.scd')
-rw-r--r--doc/aerc-smtp.5.scd14
1 files changed, 7 insertions, 7 deletions
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