diff options
| -rw-r--r-- | alot/defaults/alot.rc.spec | 31 | ||||
| -rw-r--r-- | docs/source/configuration/accounts_table.rst | 12 | ||||
| -rw-r--r-- | docs/source/configuration/alotrc_table.rst | 12 | ||||
| -rw-r--r-- | docs/source/configuration/index.rst | 2 |
4 files changed, 29 insertions, 28 deletions
diff --git a/alot/defaults/alot.rc.spec b/alot/defaults/alot.rc.spec index eca74218..69a8b7ea 100644 --- a/alot/defaults/alot.rc.spec +++ b/alot/defaults/alot.rc.spec @@ -1,4 +1,5 @@ -ask_subject = boolean(default=True) # ask for subject when compose + +ask_subject = boolean(default=True) # ask for subject when compose # confirm exit bug_on_exit = boolean(default=False) @@ -6,7 +7,7 @@ bug_on_exit = boolean(default=False) # offset of next focused buffer if the current one gets closed bufferclose_focus_offset = integer(default=-1) -# number of colours your terminal supports +# number of colours to use colourmode = option(1, 16, 256, default=256) # number of spaces used to replace tab characters @@ -35,15 +36,15 @@ envelope_headers_blacklist = string_list(default=list(In-Reply-To,References)) # Uses own addresses and aliases in all configured accounts. thread_authors_replace_me = boolean(default=True) -#Word to replace own addresses with. Works in combination with -#:ref:`thread_authors_replace_me <thread-authors-replace-me>` +# Word to replace own addresses with. Works in combination with +# :ref:`thread_authors_replace_me <thread-authors-replace-me>` thread_authors_me = string(default='Me') # set terminal command used for spawning shell commands terminal_cmd = string(default='x-terminal-emulator -e') # editor command -# if unset, alot will first try the EDITOR env variable, then /usr/bin/editor +# if unset, alot will first try the :env:`EDITOR` env variable, then :file:`/usr/bin/editor` editor_cmd = string(default=None) # file encoding used by your editor @@ -65,7 +66,7 @@ edit_headers_whitelist = string_list(default=list(*,)) # see :ref:`edit_headers_whitelist <edit-headers-whitelist>` edit_headers_blacklist = string_list(default=list(Content-Type,MIME-Version,References,In-Reply-To)) -# timeout in secs after a failed attempt to flush is repeated +# timeout in seconds after a failed attempt to writeout the database is repeated flush_retry_timeout = integer(default=5) # where to look up hooks @@ -74,17 +75,17 @@ hooksfile = string(default='~/.config/alot/hooks.py') # time in secs to display status messages notify_timeout = integer(default=2) -# display status-line? +# display status-bar at the bottom of the screen? show_statusbar = boolean(default=True) # timestamp format in `strftime format syntax <http://docs.python.org/library/datetime.html#strftime-strptime-behavior>`_ timestamp_format = string(default=None) -# max length of authors line in thread widgets +# maximal length of authors string in search mode before it gets truncated authors_maxlength = integer(default=30) # how to print messages: -# this specifies a shell command used pro printing. +# this specifies a shell command used for printing. # threads/messages are piped to this command as plain text. # muttprint/a2ps works nicely print_cmd = string(default=None) @@ -134,7 +135,7 @@ user_agent = string(default='alot/{version}') [accounts] [[__many__]] - # your email address + # your main email address address = string # used to format the (proposed) From-header in outgoing mails @@ -143,7 +144,7 @@ user_agent = string(default='alot/{version}') # used to clear your addresses/ match account when formatting replies aliases = string_list(default=list()) - # how to send mails + # sendmail command. This is the shell command used to send out mails via the sendmail protocol sendmail_command = string(default='sendmail') # specifies the mailbox where you want outgoing mails to be stored after successfully sending them, e.g. @@ -151,19 +152,19 @@ user_agent = string(default='alot/{version}') # You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL. sent_box = string(default=None) - # how to tag sent mails. + # list of tags to automatically add to outgoing messages sent_tags = string_list(default=list('sent')) # path to signature file that gets attached to all outgoing mails from this account, optionally - # renamed to `signature_filename`. + # renamed to ref:`signature_filename <signature-filename>`. signature = string(default=None) # attach signature file if set to True, append its content (mimetype text) - # to the body text if set to False. Defaults to False. + # to the body text if set to False. signature_as_attachment = boolean(default=False) # signature file's name as it appears in outgoing mails if - # signature_as_attachment is set to True + # :ref:`signature_as_attachment <signature-as-attachment>` is set to True signature_filename = string(default=None) diff --git a/docs/source/configuration/accounts_table.rst b/docs/source/configuration/accounts_table.rst index 55c5f55d..d784b803 100644 --- a/docs/source/configuration/accounts_table.rst +++ b/docs/source/configuration/accounts_table.rst @@ -3,7 +3,7 @@ .. describe:: address - your email address + your main email address :type: string @@ -29,7 +29,7 @@ .. describe:: sendmail_command - how to send mails + sendmail command. This is the shell command used to send out mails via the sendmail protocol :type: string :default: "sendmail" @@ -51,7 +51,7 @@ .. describe:: sent_tags - how to tag sent mails. + list of tags to automatically add to outgoing messages :type: string_list :default: "sent," @@ -62,7 +62,7 @@ .. describe:: signature path to signature file that gets attached to all outgoing mails from this account, optionally - renamed to `signature_filename`. + renamed to ref:`signature_filename <signature-filename>`. :type: string :default: None @@ -73,7 +73,7 @@ .. describe:: signature_as_attachment attach signature file if set to True, append its content (mimetype text) - to the body text if set to False. Defaults to False. + to the body text if set to False. :type: boolean :default: False @@ -84,7 +84,7 @@ .. describe:: signature_filename signature file's name as it appears in outgoing mails if - signature_as_attachment is set to True + :ref:`signature_as_attachment <signature-as-attachment>` is set to True :type: string :default: None diff --git a/docs/source/configuration/alotrc_table.rst b/docs/source/configuration/alotrc_table.rst index 59748dda..bcfb9230 100644 --- a/docs/source/configuration/alotrc_table.rst +++ b/docs/source/configuration/alotrc_table.rst @@ -12,7 +12,7 @@ .. describe:: authors_maxlength - max length of authors line in thread widgets + maximal length of authors string in search mode before it gets truncated :type: integer :default: 30 @@ -42,7 +42,7 @@ .. describe:: colourmode - number of colours your terminal supports + number of colours to use :type: option, one of ['1', '16', '256'] :default: 256 @@ -107,7 +107,7 @@ .. describe:: editor_cmd editor command - if unset, alot will first try the EDITOR env variable, then /usr/bin/editor + if unset, alot will first try the :env:`EDITOR` env variable, then :file:`/usr/bin/editor` :type: string :default: None @@ -159,7 +159,7 @@ .. describe:: flush_retry_timeout - timeout in secs after a failed attempt to flush is repeated + timeout in seconds after a failed attempt to writeout the database is repeated :type: integer :default: 5 @@ -200,7 +200,7 @@ .. describe:: print_cmd how to print messages: - this specifies a shell command used pro printing. + this specifies a shell command used for printing. threads/messages are piped to this command as plain text. muttprint/a2ps works nicely @@ -232,7 +232,7 @@ .. describe:: show_statusbar - display status-line? + display status-bar at the bottom of the screen? :type: boolean :default: True diff --git a/docs/source/configuration/index.rst b/docs/source/configuration/index.rst index 3a8229d9..ef8d1686 100644 --- a/docs/source/configuration/index.rst +++ b/docs/source/configuration/index.rst @@ -53,7 +53,7 @@ Here is an example configuration:: .. warning:: - Sending mails is only supported via sendmail for now. If you want + Sending mails is only supported via a sendmail shell command for now. If you want to use a sendmail command different from `sendmail`, specify it as `sendmail_command`. The following entries are interpreted at the moment: |