config: sanitize default values

Remove `Default: none` or `Default: ""` statements which may be
confusing. If there is no default value, simply do not mention a default
value.

Comment all settings in aerc.conf so that real default values are used.

Adjust man pages.

Signed-off-by: Robin Jarry <robin@jarry.cc>
Acked-by: Koni Marti <koni.marti@gmail.com>

5 files changed, 54 insertions, 115 deletions

diff --git a/config/aerc.conf b/config/aerc.conf
index 8b153ad8..ebd361ad 100644
--- a/config/aerc.conf
+++ b/config/aerc.conf
@@ -6,15 +6,14 @@
 # Used as a default path for save operations if no other path is specified.
 # ~ is expanded to the current user home dir.
 #
-# Default: ""
-#default-save-path=~/tmp
+#default-save-path=
 
 #
 # If set to "gpg", aerc will use system gpg binary and keystore for all crypto
 # operations. Otherwise, the internal openpgp implementation will be used.
 #
 # Default: internal
-pgp-provider=internal
+#pgp-provider=internal
 
 # 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
@@ -22,13 +21,12 @@ pgp-provider=internal
 # credentials.
 #
 # Default: false
-unsafe-accounts-conf=false
+#unsafe-accounts-conf=false
 
 # 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.
 #
-# Default: ""
 #log-file=
 
 # Only log messages above the specified level to log-file. Supported levels
@@ -45,91 +43,88 @@ unsafe-accounts-conf=false
 # with mutt's printf-like syntax.
 #
 # Default: %-20.20D %-17.17n %Z %s
-index-format=%-20.20D %-17.17n %Z %s
+#index-format=%-20.20D %-17.17n %Z %s
 
 #
 # See time.Time#Format at https://godoc.org/time#Time.Format
 #
 # Default: 2006-01-02 03:04 PM (ISO 8601 + 12 hour time)
-timestamp-format=2006-01-02 03:04 PM
+#timestamp-format=2006-01-02 03:04 PM
 
 #
 # Index-only time format for messages that were received/sent today.
 # If this is not specified, timestamp-format is used instead.
 #
-# Default: ""
-#this-day-time-format=03:04 PM
+#this-day-time-format=
 
 #
 # 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.
 #
-# Default: ""
-#this-week-time-format=Monday 03:04 PM
+#this-week-time-format=
 
 #
 # Index-only time format for messages that were received/sent this year.
 # If this is not specified, timestamp-format is used instead.
 #
-# Default: ""
-#this-year-time-format=January 02
+#this-year-time-format=
 
 #
 # Width of the sidebar, including the border.
 #
 # Default: 20
-sidebar-width=20
+#sidebar-width=20
 
 #
 # Message to display when viewing an empty folder.
 #
 # Default: (no messages)
-empty-message=(no messages)
+#empty-message=(no messages)
 
 # Message to display when no folders exists or are all filtered
 #
 # Default: (no folders)
-empty-dirlist=(no folders)
+#empty-dirlist=(no folders)
 
 # Enable mouse events in the ui, e.g. clicking and scrolling with the mousewheel
 #
 # Default: false
-mouse-enabled=false
+#mouse-enabled=false
 
 #
 # Ring the bell when new messages are received
 #
 # Default: true
-new-message-bell=true
+#new-message-bell=true
 
 # Marker to show before a pinned tab's name.
 #
 # Default: `
-pinned-tab-marker='`'
+#pinned-tab-marker='`'
 
 # Describes the format string to use for the directory list
 #
 # Default: %n %>r
-dirlist-format=%n %>r
+#dirlist-format=%n %>r
 
 # 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 0s.
 #
 # Default: 200ms
-dirlist-delay=200ms
+#dirlist-delay=200ms
 
 # Display the directory list as a foldable tree that allows to collapse and
 # expand the folders.
 #
 # Default: false
-dirlist-tree=false
+#dirlist-tree=false
 
 # If dirlist-tree is enabled, set level at which folders are collapsed by
 # default. Set to 0 to disable.
 #
 # Default: 0
-dirlist-collapse=0
+#dirlist-collapse=0
 
 # List of space-separated criteria to sort the messages by, see *sort*
 # command in *aerc*(1) for reference. Prefixing a criterion with "-r "
@@ -137,19 +132,18 @@ dirlist-collapse=0
 #
 # Example: "from -r date"
 #
-# Default: ""
-sort=
+#sort=
 
 # Moves to next message when the current message is deleted
 #
 # Default: true
-next-message-on-delete=true
+#next-message-on-delete=true
 
 # Automatically set the "seen" flag when a message is opened in the message
 # viewer.
 #
 # Default: true
-auto-mark-read=true
+#auto-mark-read=true
 
 # The directories where the stylesets are stored. It takes a colon-separated
 # list of directories. If this is unset or if a styleset cannot be found, the
@@ -160,29 +154,30 @@ auto-mark-read=true
 #   /usr/local/share/aerc/stylesets
 #   /usr/share/aerc/stylesets
 #
-# default: ""
-stylesets-dirs=
+#stylesets-dirs=
 
 # Uncomment to use box-drawing characters for vertical and horizontal borders.
 #
-# Default: spaces
-# border-char-vertical=│
-# border-char-horizontal=─
+# Default: " "
+#border-char-vertical=" "
+#border-char-horizontal=" "
 
 # Sets the styleset to use for the aerc ui elements.
 #
 # Default: default
-styleset-name=default
+#styleset-name=default
 
 # Activates fuzzy search in commands and their arguments: the typed string is
-#   searched in the command or option in any position, and need not be
-#   consecutive characters in the command or option.
+# searched in the command or option in any position, and need not be
+# consecutive characters in the command or option.
+#
+# Default: false
 #fuzzy-complete=false
 
 # How long to wait after the last input before auto-completion is triggered.
 #
 # Default: 250ms
-completion-delay=250ms
+#completion-delay=250ms
 
 # The minimum required characters to allow auto-completion to be triggered after
 # completion-delay.
@@ -194,7 +189,7 @@ completion-delay=250ms
 # Global switch for completion popovers
 #
 # Default: true
-completion-popovers=true
+#completion-popovers=true
 
 # Uncomment to use UTF-8 symbols to indicate PGP status of messages
 #
@@ -205,7 +200,6 @@ completion-popovers=true
 #icon-signed-encrypted=✔
 #icon-unknown=✘
 #icon-invalid=⚠
-#
 
 # 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
@@ -254,18 +248,18 @@ completion-popovers=true
 # Describes the format string for the statusline.
 #
 # Default: [%a] %S %>%T
-render-format=[%a] %S %>%T
+#render-format=[%a] %S %>%T
 
 # Specifies the separator between grouped statusline elements.
 #
 # Default: " | "
-# separator=
+#separator=" | "
 
 # Defines the mode for displaying the status elements.
 # Options: text, icon
 #
 # Default: text
-# display-mode=
+#display-mode=text
 
 [viewer]
 #
@@ -274,7 +268,7 @@ render-format=[%a] %S %>%T
 # pager which supports ANSI codes.
 #
 # Default: less -R
-pager=less -R
+#pager=less -R
 
 #
 # If an email offers several versions (multipart), you can configure which
@@ -282,14 +276,14 @@ pager=less -R
 # html emails.
 #
 # Default: text/plain,text/html
-alternatives=text/plain,text/html
+#alternatives=text/plain,text/html
 
 #
 # Default setting to determine whether to show full headers or only parsed
 # ones in message viewer.
 #
 # Default: false
-show-headers=false
+#show-headers=false
 
 #
 # Layout of headers when viewing a message. To display multiple headers in the
@@ -297,32 +291,32 @@ show-headers=false
 # none of their specified headers are present in the message.
 #
 # Default: From|To,Cc|Bcc,Date,Subject
-header-layout=From|To,Cc|Bcc,Date,Subject
+#header-layout=From|To,Cc|Bcc,Date,Subject
 
 # Whether to always show the mimetype of an email, even when it is just a single part
 #
 # Default: false
-always-show-mime=false
+#always-show-mime=false
 
 # Parses and extracts http links when viewing a message. Links can then be
 # accessed with the open-link command.
 #
 # Default: true
-parse-http-links=true
+#parse-http-links=true
 
 [compose]
 #
 # 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.
-editor=
+#editor=
 
 #
 # Default header fields 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
-header-layout=To|From,Subject
+#header-layout=To|From,Subject
 
 #
 # Specifies the command to be used to tab-complete email addresses. Any
@@ -336,7 +330,7 @@ header-layout=To|From,Subject
 # ignored.
 #
 # This parameter can also be set per account in accounts.conf.
-address-book-cmd=
+#address-book-cmd=
 
 # Specifies the command to be used to select attachments. Any occurence of '%s'
 # in the file-picker-cmd will be replaced the argument <arg> to :attach -m
@@ -344,13 +338,13 @@ address-book-cmd=
 #
 # The command must output the selected files to standard output, one file per
 # line.
-file-picker-cmd=
+#file-picker-cmd=
 
 #
 # Allow to address yourself when replying
 #
 # Default: true
-reply-to-self=true
+#reply-to-self=true
 
 #
 # Warn before sending an email that matches the specified regexp but does not
@@ -362,7 +356,7 @@ reply-to-self=true
 # Example:
 # no-attachment-warning=^[^>]*attach(ed|ment)
 #
-no-attachment-warning=
+#no-attachment-warning=
 
 [filters]
 #
@@ -427,7 +421,7 @@ message/rfc822=colorize
 
 #
 # Executed when a new email arrives in the selected folder
-new-email=
+#new-email=
 
 [templates]
 # Templates are used to populate email bodies automatically.
@@ -442,20 +436,19 @@ new-email=
 #   /usr/local/share/aerc/templates
 #   /usr/share/aerc/templates
 #
-# default: ""
-template-dirs=
+#template-dirs=
 
 # The default template to be used for new messages.
 #
 # default: new_message
-new-message=new_message
+#new-message=new_message
 
 # The default template to be used for quoted replies.
 #
 # default: quoted_reply
-quoted-reply=quoted_reply
+#quoted-reply=quoted_reply
 
 # The default template to be used for forward as body.
 #
 # default: forward_as_body
-forwards=forward_as_body
+#forwards=forward_as_body
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 7338161d..bdb74bdf 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -51,8 +51,6 @@ These options are configured in the *[general]* section of aerc.conf.
 	using _>_ shell redirection, this setting is ignored and log messages
 	are printed to stdout.
 
-	Default: ""
-
 *log-level*
 	Only log messages above the specified level to *log-file*. Supported
 	levels are: _debug_, _info_, _warn_ and _error_. When redirecting aerc's
@@ -122,44 +120,30 @@ These options are configured in the *[ui]* section of aerc.conf.
 	Index-only time format for messages that were received/sent today.
 	If this is not specified, *timestamp-format* is used instead.
 
-	Default: ""
-
 *this-week-time-format*
 	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.
 
-	Default: ""
-
 *this-year-time-format*
 	Index-only time format for messages that were received/sent this year.
 	If this is not specified, *timestamp-format* is used instead.
 
-	Default: ""
-
 *message-view-timestamp-format*
 	If set, overrides *timestamp-format* for the message view.
 
-	Default: ""
-
 *message-view-this-day-time-format*
 	If set, overrides *timestamp-format* in the message view for messages
 	that were received/sent today.
 
-	Default: ""
-
 *message-view-this-week-time-format*
 	If set, overrides *timestamp-format* in the message view for messages
 	that were recieved/sent within the last 7 days.
 
-	Default: ""
-
 *message-view-this-year-time-format*
 	If set, overrides *timestamp-format* in the message view for messages
 	that were received/sent this year.
 
-	Default: ""
-
 *sidebar-width*
 	Width of the sidebar, including the border. Set to zero to disable the
 	sidebar.
@@ -214,8 +198,6 @@ These options are configured in the *[ui]* section of aerc.conf.
 	Example:
 		sort = from -r date
 
-	Default: ""
-
 *dirlist-format*
 	Describes the format string to use for the directory list.
 
@@ -298,8 +280,6 @@ These options are configured in the *[ui]* section of aerc.conf.
 	/usr/share/aerc/stylesets
 	```
 
-	Default: ""
-
 *styleset-name*
 	The name of the styleset to be used to style the ui elements. The
 	stylesets are stored in the 'stylesets' directory in the config
@@ -313,8 +293,6 @@ These options are configured in the *[ui]* section of aerc.conf.
 	The icon to display for unencrypted mails. The status indicator is only
 	displayed if an icon is set.
 
-	Default: ""
-
 *icon-encrypted*
 	The icon to display for encrypted mails.
 
@@ -331,8 +309,6 @@ These options are configured in the *[ui]* section of aerc.conf.
 	was successfully verified. The combined icon is only used if set,
 	otherwise the signed and encrypted icons are displayed separately.
 
-	Default: ""
-
 *icon-unknown*
 	The icon to display for signed mails which could not be verified due to
 	the key being unknown.
@@ -556,8 +532,6 @@ These options are configured in the *[compose]* section of aerc.conf.
 	Example:
 		address-book-cmd = khard email --remove-first-line --parsable '%s'
 
-	Default: none
-
 *file-picker-cmd*
 	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>
@@ -569,8 +543,6 @@ These options are configured in the *[compose]* section of aerc.conf.
 	Example:
 		file-picker-cmd = fzf --multi --query=%s
 
-	Default: none
-
 *reply-to-self*
 	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
@@ -681,8 +653,6 @@ They are configured in the *[triggers]* section of aerc.conf.
 
 	e.g. new-email=exec notify-send "New email from %n" "%s"
 
-	Default: ""
-
 	Format specifiers from *index-format* are expanded with respect to the new
 	message.
 
@@ -709,8 +679,6 @@ These options are configured in the *[templates]* section of aerc.conf.
 	/usr/share/aerc/templates
 	```
 
-	Default: ""
-
 *new-message*
 	The default template to be used for new messages.
 
@@ -762,8 +730,6 @@ Note that many of these configuration options are written for you, such as
 *copy-to*
 	Specifies a folder to copy sent mails to, usually "Sent".
 
-	Default: none
-
 *default*
 	Specifies the default folder to open in the message list when aerc
 	configures this account.
@@ -793,21 +759,15 @@ Note that many of these configuration options are written for you, such as
 	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.
 
-	Default: none
-
 *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>".
 
-	Default: none
-
 *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 and --read-envelope-from.
 
-	Default: none
-
 *outgoing*
 	Specifies the transport for sending outgoing emails on this account. It
 	should be a connection string, and the specific meaning of each component
@@ -820,8 +780,6 @@ Note that many of these configuration options are written for you, such as
 	Specifies an optional command that is run to get the outgoing account's
 	password. See each protocol's man page for more details.
 
-	Default: none
-
 *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
@@ -866,8 +824,6 @@ Note that many of these configuration options are written for you, such as
 	- *aerc-maildir*(5)
 	- *aerc-notmuch*(5)
 
-	Default: none
-
 *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.
diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd
index 1785a03f..b3dc5166 100644
--- a/doc/aerc-imap.5.scd
+++ b/doc/aerc-imap.5.scd
@@ -106,7 +106,7 @@ available:
 	new mail with *check-mail*. Names prefixed with ~ are interpreted as regular
 	expressions.
 
-	Default: all folders
+	By default, all folders are included.
 
 *check-mail-exclude*
 	Specifies the comma separated list of folders to exclude when checking for
@@ -114,7 +114,7 @@ available:
 	expressions.
 	Note that this overrides anything from *check-mail-include*.
 
-	Default: no folders
+	By default, no folders are excluded.
 
 *cache-headers*
 	If set to true, headers will be cached. The cached headers will be stored
diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd
index 7054d8d1..ebd76b06 100644
--- a/doc/aerc-maildir.5.scd
+++ b/doc/aerc-maildir.5.scd
@@ -21,8 +21,6 @@ The following maildir-specific options are available:
 	Example:
 		check-mail-cmd = mbsync -a
 
-	Default: none
-
 *check-mail-timeout*
 	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
diff --git a/doc/aerc-notmuch.5.scd b/doc/aerc-notmuch.5.scd
index e9c03dff..e94cc057 100644
--- a/doc/aerc-notmuch.5.scd
+++ b/doc/aerc-notmuch.5.scd
@@ -26,8 +26,6 @@ options are available:
 	Example:
 		check-mail-cmd = mbsync -a
 
-	Default: none
-
 *check-mail-timeout*
 	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
@@ -57,23 +55,17 @@ Lines starting with '#' are ignored and serve as comments.
 
 	e.g. inbox=tag:inbox and not tag:archived
 
-	Default: none
-
 *exclude-tags*
 	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.
 
-	Default: none
-
 *maildir-store*
 	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
 	available folders and enable commands such as :delete and :archive.
 
-	Default: none
-
 # USAGE
 
 Notmuch shows slightly different behavior than for example imap.++