summaryrefslogtreecommitdiff
path: root/docs/source/configuration
diff options
context:
space:
mode:
authorLucas Hoffmann <l-m-h@web.de>2016-12-11 02:09:27 +0100
committerLucas Hoffmann <l-m-h@web.de>2016-12-11 14:29:53 +0100
commit2cf13e558f7612bc62f6d47652c03adf05faa1a9 (patch)
treef8885a789cec98b96d28b60f7f18d0f699d6e244 /docs/source/configuration
parent6d944cdb14b66292c8635741edec7843999878b8 (diff)
Update autogenerated documentation files
Diffstat (limited to 'docs/source/configuration')
-rw-r--r--docs/source/configuration/accounts_table34
-rw-r--r--docs/source/configuration/alotrc_table87
2 files changed, 94 insertions, 27 deletions
diff --git a/docs/source/configuration/accounts_table b/docs/source/configuration/accounts_table
index cc3e5646..265bc34b 100644
--- a/docs/source/configuration/accounts_table
+++ b/docs/source/configuration/accounts_table
@@ -31,6 +31,16 @@
:default: ,
+.. _alias-regexp:
+
+.. describe:: alias_regexp
+
+ a regex for catching further aliases (like + extensions).
+
+ :type: string
+ :default: None
+
+
.. _sendmail-command:
.. describe:: sendmail_command
@@ -127,10 +137,26 @@
.. describe:: encrypt_by_default
- Outgoing messages will be GPG encrypted by default if this is set to True.
-
- :type: boolean
- :default: False
+ Alot will try to GPG encrypt outgoing messages by default when this
+ is set to `all` or `trusted`. If set to `all` the message will be
+ encrypted for all recipients for who a key is available in the key
+ ring. If set to `trusted` it will be encrypted to all
+ recipients if a trusted key is available for all recipients (one
+ where the user id for the key is signed with a trusted signature).
+
+ .. note:: If the message will not be encrypted by default you can
+ still use the :ref:`toggleencrypt
+ <cmd.envelope.toggleencrypt>`, :ref:`encrypt
+ <cmd.envelope.encrypt>` and :ref:`unencrypt
+ <cmd.envelope.unencrypt>` commands to encrypt it.
+ .. note:: The values `True` and `False` are interpreted as `all` and
+ `none` respectively. They are kept for backwards
+ compatibility to give users a change to migrate to the new
+ option type. They might become deprecated in future
+ versions.
+
+ :type: option, one of ['all', 'none', 'trusted', 'True', 'False', 'true', 'false', 'Yes', 'No', 'yes', 'no', '1', '0']
+ :default: none
.. _gpg-key:
diff --git a/docs/source/configuration/alotrc_table b/docs/source/configuration/alotrc_table
index e1a4fa73..ef0c7eaa 100644
--- a/docs/source/configuration/alotrc_table
+++ b/docs/source/configuration/alotrc_table
@@ -34,6 +34,16 @@
:default: True
+.. _auto-replyto-mailinglist:
+
+.. describe:: auto_replyto_mailinglist
+
+ Automatically switch to list reply mode if appropriate
+
+ :type: boolean
+ :default: False
+
+
.. _bounce-force-address:
.. describe:: bounce_force_address
@@ -56,16 +66,6 @@
:default: True
-.. _auto_replyto_mailinglist:
-
-.. describe:: auto_replyto_mailinglist
-
- Automatically switch to list reply mode if appropriate
-
- :type: boolean
- :default: False
-
-
.. _bufferclose-focus-offset:
.. describe:: bufferclose_focus_offset
@@ -192,7 +192,7 @@
.. describe:: editor_spawn
- use terminal_cmd to spawn a new terminal for the editor?
+ use terminal_command to spawn a new terminal for the editor?
equivalent to always providing the `--spawn=yes` parameter to compose/edit commands
:type: boolean
@@ -238,7 +238,8 @@
.. describe:: flush_retry_timeout
- timeout in seconds after a failed attempt to writeout the database is repeated
+ timeout in seconds after a failed attempt to writeout the database is
+ repeated. Set to 0 for no retry.
:type: integer
:default: 5
@@ -340,6 +341,17 @@
:default: ,
+.. _msg-summary-hides-threadwide-tags:
+
+.. describe:: msg_summary_hides_threadwide_tags
+
+ In a thread buffer, hide from messages summaries tags that are commom to all
+ messages in that thread.
+
+ :type: boolean
+ :default: True
+
+
.. _notify-timeout:
.. describe:: notify_timeout
@@ -403,6 +415,19 @@
:default: "> "
+.. _reply-account-header-priority:
+
+.. describe:: reply_account_header_priority
+
+ The list of headers to match to determine sending account for a reply.
+ Headers are searched in the order in which they are specified here, and the first header
+ containing a match is used. If multiple accounts match in that header, the one defined
+ first in the account block is used.
+
+ :type: string list
+ :default: From, To, Cc, Envelope-To, X-Envelope-To, Delivered-To
+
+
.. _reply-force-address:
.. describe:: reply_force_address
@@ -548,6 +573,17 @@
:default: "Me"
+.. _thread-authors-order-by:
+
+.. describe:: thread_authors_order_by
+
+ When constructing the unique list of thread authors, order by date of
+ author's first or latest message in thread
+
+ :type: option, one of ['first_message', 'latest_message']
+ :default: first_message
+
+
.. _thread-authors-replace-me:
.. describe:: thread_authors_replace_me
@@ -559,17 +595,6 @@
:default: True
-.. _thread-authors-order-by:
-
-.. describe:: thread_authors_order_by
-
- In which order to list authors. By default, list authors in the order they
- joined the conversation.
-
- :type: option, one of ['first_message', 'latest_message']
- :default: first_message
-
-
.. _thread-statusbar:
.. describe:: thread_statusbar
@@ -588,6 +613,22 @@
:default: [{buffer_no}: thread] {subject}, {input_queue} total messages: {total_messages}
+.. _thread-subject:
+
+.. describe:: thread_subject
+
+ What should be considered to be "the thread subject".
+ Valid values are:
+
+ * 'notmuch' (the default), will use the thread subject from notmuch, which
+ depends on the selected sorting method
+ * 'oldest' will always use the subject of the oldest message in the thread as
+ the thread subject
+
+ :type: option, one of ['oldest', 'notmuch']
+ :default: notmuch
+
+
.. _timestamp-format:
.. describe:: timestamp_format