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>

1 files changed, 30 insertions, 30 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.