X-Git-Url: https://git.madduck.net/etc/mutt.git/blobdiff_plain/7013dfe93a05082153f79eca6c9e5c05b54d9d50..HEAD:/.config/mutt/confvars?ds=inline diff --git a/.config/mutt/confvars b/.config/mutt/confvars index 74a417f..03e843c 100644 --- a/.config/mutt/confvars +++ b/.config/mutt/confvars @@ -1,7 +1,7 @@ # Auto-generated using mkconf from manual.txt -# on 2019-01-18 23:28:41 +# on 2022-02-09 15:28:20 # -# Invoked as: ./mkconf confvars +# Invoked as: ./mkconf # # 3.1. abort_noattach @@ -238,7 +238,7 @@ set alias_file="$my_confdir/aliases" # ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%Q │“Q”, if MIME part qualifies for attachment counting │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ -# │%s │size │ +# │%s │size (see formatstrings-size) │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%t │tagged flag │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ @@ -260,7 +260,20 @@ set alias_file="$my_confdir/aliases" # -# 3.16. attach_sep +# 3.16. attach_save_dir +# +# Type: path +# Default: (empty) +# +# The default directory to save attachments from the “attachment” menu. If it +# doesn't exist, Mutt will prompt to create the directory before saving. +# +# If the path is invalid (e.g. not a directory, or cannot be chdir'ed to), Mutt +# will fall back to using the current directory. +# + + +# 3.17. attach_sep # # Type: string # Default: “n” @@ -270,7 +283,7 @@ set alias_file="$my_confdir/aliases" # -# 3.17. attach_split +# 3.18. attach_split # # Type: boolean # Default: yes @@ -283,9 +296,9 @@ set alias_file="$my_confdir/aliases" # -# 3.18. attribution +# 3.19. attribution # -# Type: string +# Type: string (localized) # Default: “On %d, %n wrote:” # # This is the string that will precede a message which has been included in a @@ -295,7 +308,7 @@ set alias_file="$my_confdir/aliases" set attribution="$my_attribution_en" -# 3.19. attribution_locale +# 3.20. attribution_locale # # Type: string # Default: (empty) @@ -310,7 +323,19 @@ set attribution="$my_attribution_en" # -# 3.20. auto_tag +# 3.21. auto_subscribe +# +# Type: boolean +# Default: no +# +# When set, Mutt assumes the presence of a List-Post header means the recipient +# is subscribed to the list. Unless the mailing list is in the “unsubscribe” or “ +# unlist” lists, it will be added to the “subscribe” list. Parsing and checking +# these things slows header reading down, so this option is disabled by default. +# + + +# 3.22. auto_tag # # Type: boolean # Default: no @@ -322,7 +347,64 @@ set attribution="$my_attribution_en" # -# 3.21. autoedit +# 3.23. autocrypt +# +# Type: boolean +# Default: no +# +# When set, enables autocrypt, which provides passive encryption protection with +# keys exchanged via headers. See “autocryptdoc” for more details. (Autocrypt +# only) +# + + +# 3.24. autocrypt_acct_format +# +# Type: string +# Default: “%4n %-30a %20p %10s” +# +# This variable describes the format of the “autocrypt account” menu. The +# following printf(3)-style sequences are understood +# +# ┌──┬─────────────────────────────┐ +# │%a│email address │ +# ├──┼─────────────────────────────┤ +# │%k│gpg keyid │ +# ├──┼─────────────────────────────┤ +# │%n│current entry number │ +# ├──┼─────────────────────────────┤ +# │%p│prefer-encrypt flag │ +# ├──┼─────────────────────────────┤ +# │%s│status flag (active/inactive)│ +# └──┴─────────────────────────────┘ +# +# (Autocrypt only) +# + + +# 3.25. autocrypt_dir +# +# Type: path +# Default: “~/.mutt/autocrypt” +# +# This variable sets where autocrypt files are stored, including the GPG keyring +# and sqlite database. See “autocryptdoc” for more details. (Autocrypt only) +# + + +# 3.26. autocrypt_reply +# +# Type: boolean +# Default: yes +# +# When set, replying to an autocrypt email automatically enables autocrypt in the +# reply. You may want to unset this if you're using the same key for autocrypt as +# normal web-of-trust, so that autocrypt isn't forced on for all encrypted +# replies. (Autocrypt only) +# + + +# 3.27. autoedit # # Type: boolean # Default: no @@ -341,7 +423,62 @@ set attribution="$my_attribution_en" set autoedit=yes -# 3.22. beep +# 3.28. background_edit +# +# Type: boolean +# Default: no +# +# When set, Mutt will run $editor in the background during message composition. A +# landing page will display, waiting for the $editor to exit. The landing page +# may be exited, allowing perusal of the mailbox, or even for other messages to +# be composed. Backgrounded sessions may be returned to via the +# function. +# +# For background editing to work properly, $editor must be set to an editor that +# does not try to use the Mutt terminal: for example a graphical editor, or a +# script launching (and waiting for) the editor in another Gnu Screen window. +# +# For more details, see “bgedit” ("Background Editing" in the manual). +# + + +# 3.29. background_confirm_quit +# +# Type: boolean +# Default: yes +# +# When set, if there are any background edit sessions, you will be prompted to +# confirm exiting Mutt, in addition to the $quit prompt. +# + + +# 3.30. background_format +# +# Type: string +# Default: “%10S %7p %s” +# +# This variable describes the format of the “background compose” menu. The +# following printf(3)-style sequences are understood: +# +# ┌──┬──────────────────────────────────────────────────────┐ +# │%i│parent message id (for replies and forwarded messages)│ +# ├──┼──────────────────────────────────────────────────────┤ +# │%n│the running number on the menu │ +# ├──┼──────────────────────────────────────────────────────┤ +# │%p│pid of the $editor process │ +# ├──┼──────────────────────────────────────────────────────┤ +# │%r│comma separated list of “To:” recipients │ +# ├──┼──────────────────────────────────────────────────────┤ +# │%R│comma separated list of “Cc:” recipients │ +# ├──┼──────────────────────────────────────────────────────┤ +# │%s│subject of the message │ +# ├──┼──────────────────────────────────────────────────────┤ +# │%S│status of the $editor process: running/finished │ +# └──┴──────────────────────────────────────────────────────┘ +# + + +# 3.31. beep # # Type: boolean # Default: yes @@ -351,7 +488,7 @@ set autoedit=yes set beep=no -# 3.23. beep_new +# 3.32. beep_new # # Type: boolean # Default: no @@ -362,7 +499,7 @@ set beep=no # -# 3.24. bounce +# 3.33. bounce # # Type: quadoption # Default: ask-yes @@ -374,7 +511,7 @@ set beep=no # -# 3.25. bounce_delivered +# 3.34. bounce_delivered # # Type: boolean # Default: yes @@ -385,7 +522,7 @@ set beep=no set bounce_delivered=no -# 3.26. braille_friendly +# 3.35. braille_friendly # # Type: boolean # Default: no @@ -398,7 +535,7 @@ set bounce_delivered=no # -# 3.27. browser_abbreviate_mailboxes +# 3.36. browser_abbreviate_mailboxes # # Type: boolean # Default: yes @@ -413,7 +550,19 @@ set bounce_delivered=no # -# 3.28. certificate_file +# 3.37. browser_sticky_cursor +# +# Type: boolean +# Default: yes +# +# When this variable is set, the browser will attempt to keep the cursor on the +# same mailbox when performing various functions. These include moving up a +# directory, toggling between mailboxes and directory listing, creating/renaming +# a mailbox, toggling subscribed mailboxes, and entering a new mask. +# + + +# 3.38. certificate_file # # Type: path # Default: “~/.mutt_certificates” @@ -433,7 +582,7 @@ set bounce_delivered=no # -# 3.29. change_folder_next +# 3.39. change_folder_next # # Type: boolean # Default: no @@ -444,7 +593,7 @@ set bounce_delivered=no # -# 3.30. charset +# 3.40. charset # # Type: string # Default: (empty) @@ -460,7 +609,7 @@ set bounce_delivered=no # -# 3.31. check_mbox_size +# 3.41. check_mbox_size # # Type: boolean # Default: no @@ -479,7 +628,7 @@ set bounce_delivered=no # -# 3.32. check_new +# 3.42. check_new # # Type: boolean # Default: yes @@ -494,7 +643,7 @@ set bounce_delivered=no # -# 3.33. collapse_unread +# 3.43. collapse_unread # # Type: boolean # Default: yes @@ -503,31 +652,32 @@ set bounce_delivered=no # -# 3.34. compose_format +# 3.44. compose_format # -# Type: string +# Type: string (localized) # Default: “-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-” # # Controls the format of the status line displayed in the “compose” menu. This # string is similar to $status_format, but has its own set of printf(3)-like # sequences: # -# ┌──┬──────────────────────────────────────────────────┐ -# │%a│total number of attachments │ -# ├──┼──────────────────────────────────────────────────┤ -# │%h│local hostname │ -# ├──┼──────────────────────────────────────────────────┤ -# │%l│approximate size (in bytes) of the current message│ -# ├──┼──────────────────────────────────────────────────┤ -# │%v│Mutt version string │ -# └──┴──────────────────────────────────────────────────┘ +# ┌──┬──────────────────────────────────────────────────────────────────────────┐ +# │%a│total number of attachments │ +# ├──┼──────────────────────────────────────────────────────────────────────────┤ +# │%h│local hostname │ +# ├──┼──────────────────────────────────────────────────────────────────────────┤ +# │%l│approximate size (in bytes) of the current message (see formatstrings-size│ +# │ │) │ +# ├──┼──────────────────────────────────────────────────────────────────────────┤ +# │%v│Mutt version string │ +# └──┴──────────────────────────────────────────────────────────────────────────┘ # # See the text describing the $status_format option for more information on how # to set $compose_format. # -# 3.35. config_charset +# 3.45. config_charset # # Type: string # Default: (empty) @@ -545,7 +695,7 @@ set bounce_delivered=no # -# 3.36. confirmappend +# 3.46. confirmappend # # Type: boolean # Default: yes @@ -556,7 +706,7 @@ set bounce_delivered=no set confirmappend=no -# 3.37. confirmcreate +# 3.47. confirmcreate # # Type: boolean # Default: yes @@ -566,7 +716,7 @@ set confirmappend=no # -# 3.38. connect_timeout +# 3.48. connect_timeout # # Type: number # Default: 30 @@ -577,7 +727,7 @@ set confirmappend=no # -# 3.39. content_type +# 3.49. content_type # # Type: string # Default: “text/plain” @@ -587,7 +737,7 @@ set confirmappend=no set content_type="text/plain; markup=markdown" -# 3.40. copy +# 3.50. copy # # Type: quadoption # Default: yes @@ -599,7 +749,45 @@ set content_type="text/plain; markup=markdown" set copy=yes -# 3.41. crypt_autoencrypt +# 3.51. copy_decode_weed +# +# Type: boolean +# Default: no +# +# Controls whether Mutt will weed headers when invoking the or +# functions. +# + + +# 3.52. count_alternatives +# +# Type: boolean +# Default: no +# +# When set, Mutt will recurse inside multipart/alternatives while performing +# attachment searching and counting (see attachments). +# +# Traditionally, multipart/alternative parts have simply represented different +# encodings of the main content of the email. Unfortunately, some mail clients +# have started to place email attachments inside one of alternatives. Setting +# this will allow Mutt to find and count matching attachments hidden there, and +# include them in the index via %X or through ~X pattern matching. +# + + +# 3.53. cursor_overlay +# +# Type: boolean +# Default: no +# +# When set, Mutt will overlay the indicator, tree, sidebar_highlight, and +# sidebar_indicator colors onto the currently selected line. This will allow +# default colors in those to be overridden, and for attributes to be merged +# between the layers. +# + + +# 3.54. crypt_autoencrypt # # Type: boolean # Default: no @@ -613,7 +801,7 @@ set copy=yes # -# 3.42. crypt_autopgp +# 3.55. crypt_autopgp # # Type: boolean # Default: yes @@ -624,7 +812,7 @@ set copy=yes # -# 3.43. crypt_autosign +# 3.56. crypt_autosign # # Type: boolean # Default: no @@ -639,7 +827,7 @@ set copy=yes set crypt_autosign=no -# 3.44. crypt_autosmime +# 3.57. crypt_autosmime # # Type: boolean # Default: yes @@ -651,7 +839,7 @@ set crypt_autosign=no set crypt_autosmime=no -# 3.45. crypt_confirmhook +# 3.58. crypt_confirmhook # # Type: boolean # Default: yes @@ -662,7 +850,7 @@ set crypt_autosmime=no # -# 3.46. crypt_opportunistic_encrypt +# 3.59. crypt_opportunistic_encrypt # # Type: boolean # Default: no @@ -685,7 +873,92 @@ set crypt_autosmime=no set crypt_opportunistic_encrypt=no -# 3.47. crypt_replyencrypt +# 3.60. crypt_opportunistic_encrypt_strong_keys +# +# Type: boolean +# Default: no +# +# When set, this modifies the behavior of $crypt_opportunistic_encrypt to only +# search for "strong keys", that is, keys with full validity according to the +# web-of-trust algorithm. A key with marginal or no validity will not enable +# opportunistic encryption. +# +# For S/MIME, the behavior depends on the backend. Classic S/MIME will filter for +# certificates with the 't' (trusted) flag in the .index file. The GPGME backend +# will use the same filters as with OpenPGP, and depends on GPGME's logic for +# assigning the GPGME_VALIDITY_FULL and GPGME_VALIDITY_ULTIMATE validity flag. +# + + +# 3.61. crypt_protected_headers_read +# +# Type: boolean +# Default: yes +# +# When set, Mutt will display protected headers in the pager, and will update the +# index and header cache with revised headers. Protected headers are stored +# inside the encrypted or signed part of an an email, to prevent disclosure or +# tampering. For more information see https://github.com/autocrypt/ +# protected-headers. Currently Mutt only supports the Subject header. +# +# Encrypted messages using protected headers often substitute the exposed Subject +# header with a dummy value (see $crypt_protected_headers_subject). Mutt will +# update its concept of the correct subject after the message is opened, i.e. via +# the function. If you reply to a message before opening it, +# Mutt will end up using the dummy Subject header, so be sure to open such a +# message first. (Crypto only) +# + + +# 3.62. crypt_protected_headers_save +# +# Type: boolean +# Default: no +# +# When $crypt_protected_headers_read is set, and a message with a protected +# Subject is opened, Mutt will save the updated Subject into the header cache by +# default. This allows searching/limiting based on the protected Subject header +# if the mailbox is re-opened, without having to re-open the message each time. +# However, for mbox/mh mailbox types, or if header caching is not set up, you +# would need to re-open the message each time the mailbox was reopened before you +# could see or search/limit on the protected subject again. +# +# When this variable is set, Mutt additionally saves the protected Subject back +# in the clear-text message headers. This provides better usability, but with the +# tradeoff of reduced security. The protected Subject header, which may have +# previously been encrypted, is now stored in clear-text in the message headers. +# Copying the message elsewhere, via Mutt or external tools, could expose this +# previously encrypted data. Please make sure you understand the consequences of +# this before you enable this variable. (Crypto only) +# + + +# 3.63. crypt_protected_headers_subject +# +# Type: string +# Default: “...” +# +# When $crypt_protected_headers_write is set, and the message is marked for +# encryption, this will be substituted into the Subject field in the message +# headers. To prevent a subject from being substituted, unset this variable, or +# set it to the empty string. (Crypto only) +# + + +# 3.64. crypt_protected_headers_write +# +# Type: boolean +# Default: no +# +# When set, Mutt will generate protected headers for signed and encrypted emails. +# Protected headers are stored inside the encrypted or signed part of an an +# email, to prevent disclosure or tampering. For more information see https:// +# github.com/autocrypt/protected-headers. Currently Mutt only supports the +# Subject header. (Crypto only) +# + + +# 3.65. crypt_replyencrypt # # Type: boolean # Default: yes @@ -695,7 +968,7 @@ set crypt_opportunistic_encrypt=no # -# 3.48. crypt_replysign +# 3.66. crypt_replysign # # Type: boolean # Default: no @@ -708,7 +981,7 @@ set crypt_opportunistic_encrypt=no set crypt_replysign=yes -# 3.49. crypt_replysignencrypted +# 3.67. crypt_replysignencrypted # # Type: boolean # Default: no @@ -722,7 +995,7 @@ set crypt_replysign=yes set crypt_replysignencrypted=yes -# 3.50. crypt_timestamp +# 3.68. crypt_timestamp # # Type: boolean # Default: yes @@ -733,7 +1006,7 @@ set crypt_replysignencrypted=yes # -# 3.51. crypt_use_gpgme +# 3.69. crypt_use_gpgme # # Type: boolean # Default: no @@ -748,7 +1021,7 @@ set crypt_replysignencrypted=yes # -# 3.52. crypt_use_pka +# 3.70. crypt_use_pka # # Type: boolean # Default: no @@ -760,7 +1033,7 @@ set crypt_replysignencrypted=yes set crypt_use_pka=yes -# 3.53. crypt_verify_sig +# 3.71. crypt_verify_sig # # Type: quadoption # Default: yes @@ -771,7 +1044,7 @@ set crypt_use_pka=yes # -# 3.54. date_format +# 3.72. date_format # # Type: string # Default: “!%a, %b %d, %Y at %I:%M:%S%p %Z” @@ -788,7 +1061,7 @@ set crypt_use_pka=yes set date_format="%F" -# 3.55. default_hook +# 3.73. default_hook # # Type: string # Default: “~f %s !~P | (~P ~C %s)” @@ -806,7 +1079,7 @@ set date_format="%F" # -# 3.56. delete +# 3.74. delete # # Type: quadoption # Default: ask-yes @@ -819,7 +1092,7 @@ set date_format="%F" set delete=yes -# 3.57. delete_untag +# 3.75. delete_untag # # Type: boolean # Default: yes @@ -830,7 +1103,7 @@ set delete=yes # -# 3.58. digest_collapse +# 3.76. digest_collapse # # Type: boolean # Default: yes @@ -841,7 +1114,7 @@ set delete=yes # -# 3.59. display_filter +# 3.77. display_filter # # Type: path # Default: (empty) @@ -852,16 +1125,16 @@ set delete=yes # -# 3.60. dotlock_program +# 3.78. dotlock_program # # Type: path # Default: “/usr/bin/mutt_dotlock” # -# Contains the path of the mutt_dotlock(8) binary to be used by mutt. +# Contains the path of the mutt_dotlock(1) binary to be used by mutt. # -# 3.61. dsn_notify +# 3.79. dsn_notify # # Type: string # Default: (empty) @@ -884,7 +1157,7 @@ set delete=yes # -# 3.62. dsn_return +# 3.80. dsn_return # # Type: string # Default: (empty) @@ -905,7 +1178,7 @@ set delete=yes # -# 3.63. duplicate_threads +# 3.81. duplicate_threads # # Type: boolean # Default: yes @@ -917,7 +1190,7 @@ set delete=yes # -# 3.64. edit_headers +# 3.82. edit_headers # # Type: boolean # Default: no @@ -937,7 +1210,7 @@ set delete=yes set edit_headers=yes -# 3.65. editor +# 3.83. editor # # Type: path # Default: (empty) @@ -959,7 +1232,7 @@ set edit_headers=yes set editor="mailplate --edit --auto --keep-unknown" -# 3.66. encode_from +# 3.84. encode_from # # Type: boolean # Default: no @@ -972,7 +1245,7 @@ set editor="mailplate --edit --auto --keep-unknown" # -# 3.67. entropy_file +# 3.85. entropy_file # # Type: path # Default: (empty) @@ -982,7 +1255,7 @@ set editor="mailplate --edit --auto --keep-unknown" # -# 3.68. envelope_from_address +# 3.86. envelope_from_address # # Type: e-mail address # Default: (empty) @@ -992,7 +1265,7 @@ set editor="mailplate --edit --auto --keep-unknown" # -# 3.69. error_history +# 3.87. error_history # # Type: number # Default: 30 @@ -1003,7 +1276,7 @@ set editor="mailplate --edit --auto --keep-unknown" # -# 3.70. escape +# 3.88. escape # # Type: string # Default: “~” @@ -1012,7 +1285,7 @@ set editor="mailplate --edit --auto --keep-unknown" # -# 3.71. fast_reply +# 3.89. fast_reply # # Type: boolean # Default: no @@ -1025,7 +1298,7 @@ set editor="mailplate --edit --auto --keep-unknown" # -# 3.72. fcc_attach +# 3.90. fcc_attach # # Type: quadoption # Default: yes @@ -1033,20 +1306,56 @@ set editor="mailplate --edit --auto --keep-unknown" # This variable controls whether or not attachments on outgoing messages are # saved along with the main body of your message. # +# Note: $fcc_before_send forces the default (set) behavior of this option. +# set fcc_attach=yes -# 3.73. fcc_clear +# 3.91. fcc_before_send +# +# Type: boolean +# Default: no +# +# When this variable is set, FCCs will occur before sending the message. Before +# sending, the message cannot be manipulated, so it will be stored the exact same +# as sent: $fcc_attach and $fcc_clear will be ignored (using their default +# values). +# +# When unset, the default, FCCs will occur after sending. Variables $fcc_attach +# and $fcc_clear will be respected, allowing it to be stored without attachments +# or encryption/signing if desired. +# + + +# 3.92. fcc_clear # # Type: boolean # Default: no # # When this variable is set, FCCs will be stored unencrypted and unsigned, even -# when the actual message is encrypted and/or signed. (PGP only) +# when the actual message is encrypted and/or signed. +# +# Note: $fcc_before_send forces the default (unset) behavior of this option. (PGP +# only) +# +# See also $pgp_self_encrypt, $smime_self_encrypt. # -# 3.74. flag_safe +# 3.93. fcc_delimiter +# +# Type: string +# Default: (empty) +# +# When specified, this allows the ability to Fcc to more than one mailbox. The +# fcc value will be split by this delimiter and Mutt will evaluate each part as a +# mailbox separately. +# +# See $record, “fcc-hook”, and “fcc-save-hook”. +# + + +# 3.94. flag_safe # # Type: boolean # Default: no @@ -1055,7 +1364,7 @@ set fcc_attach=yes # -# 3.75. folder +# 3.95. folder # # Type: path # Default: “~/Mail” @@ -1069,7 +1378,7 @@ set fcc_attach=yes set folder="~/mail" -# 3.76. folder_format +# 3.96. folder_format # # Type: string # Default: “%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f” @@ -1100,7 +1409,7 @@ set folder="~/mail" # ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%N │N if mailbox has new mail, blank otherwise │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ -# │%s │size in bytes │ +# │%s │size in bytes (see formatstrings-size) │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%t │“*” if the file is tagged, blank otherwise │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ @@ -1122,7 +1431,8 @@ set folder="~/mail" # set folder_format='%t%N%2C %D %4s %f' -# 3.77. followup_to + +# 3.97. followup_to # # Type: boolean # Default: yes @@ -1144,7 +1454,7 @@ set folder_format='%t%N%2C %D %4s %f' # -# 3.78. force_name +# 3.98. force_name # # Type: boolean # Default: no @@ -1157,9 +1467,21 @@ set folder_format='%t%N%2C %D %4s %f' # -# 3.79. forward_attribution_intro +# 3.99. forward_attachments # -# Type: string +# Type: quadoption +# Default: ask-yes +# +# When forwarding inline (i.e. $mime_forward unset or answered with “no” and +# $forward_decode set), attachments which cannot be decoded in a reasonable +# manner will be attached to the newly composed message if this quadoption is set +# or answered with “yes”. +# + + +# 3.100. forward_attribution_intro +# +# Type: string (localized) # Default: “----- Forwarded message from %f -----” # # This is the string that will precede a message which has been forwarded in the @@ -1169,9 +1491,9 @@ set folder_format='%t%N%2C %D %4s %f' # -# 3.80. forward_attribution_trailer +# 3.101. forward_attribution_trailer # -# Type: string +# Type: string (localized) # Default: “----- End forwarded message -----” # # This is the string that will follow a message which has been forwarded in the @@ -1181,7 +1503,7 @@ set folder_format='%t%N%2C %D %4s %f' # -# 3.81. forward_decode +# 3.102. forward_decode # # Type: boolean # Default: yes @@ -1193,18 +1515,22 @@ set folder_format='%t%N%2C %D %4s %f' # -# 3.82. forward_decrypt +# 3.103. forward_decrypt # -# Type: boolean +# Type: quadoption # Default: yes # -# Controls the handling of encrypted messages when forwarding a message. When set -# , the outer layer of encryption is stripped off. This variable is only used if -# $mime_forward is set and $mime_forward_decode is unset. (PGP only) +# This quadoption controls the handling of encrypted messages when forwarding or +# attaching a message. When set to or answered “yes”, the outer layer of +# encryption is stripped off. +# +# This variable is used if $mime_forward is set and $mime_forward_decode is unset +# . It is also used when attaching a message via in the compose +# menu. (PGP only) # -# 3.83. forward_edit +# 3.104. forward_edit # # Type: quadoption # Default: yes @@ -1215,7 +1541,7 @@ set folder_format='%t%N%2C %D %4s %f' # -# 3.84. forward_format +# 3.105. forward_format # # Type: string # Default: “[%a: %s]” @@ -1226,7 +1552,7 @@ set folder_format='%t%N%2C %D %4s %f' set forward_format="(fwd) %s" -# 3.85. forward_quote +# 3.106. forward_quote # # Type: boolean # Default: no @@ -1236,7 +1562,7 @@ set forward_format="(fwd) %s" # -# 3.86. from +# 3.107. from # # Type: e-mail address # Default: (empty) @@ -1250,7 +1576,7 @@ set forward_format="(fwd) %s" set from='martin f krafft ' -# 3.87. gecos_mask +# 3.108. gecos_mask # # Type: regular expression # Default: “^[^,]*” @@ -1268,7 +1594,7 @@ set from='martin f krafft ' # -# 3.88. hdrs +# 3.109. hdrs # # Type: boolean # Default: yes @@ -1280,7 +1606,7 @@ set from='martin f krafft ' # -# 3.89. header +# 3.110. header # # Type: boolean # Default: no @@ -1290,7 +1616,7 @@ set from='martin f krafft ' # -# 3.90. header_cache +# 3.111. header_cache # # Type: path # Default: (empty) @@ -1306,7 +1632,7 @@ set from='martin f krafft ' set header_cache="~/.var/mutt/header_cache" -# 3.91. header_cache_compress +# 3.112. header_cache_compress # # Type: boolean # Default: yes @@ -1321,10 +1647,10 @@ set header_cache="~/.var/mutt/header_cache" set header_cache_compress=no -# 3.92. header_cache_pagesize +# 3.113. header_cache_pagesize # -# Type: string -# Default: “16384” +# Type: number (long) +# Default: 16384 # # When mutt is compiled with either gdbm or bdb4 as the header cache backend, # this option changes the database page size. Too large or too small values can @@ -1333,7 +1659,7 @@ set header_cache_compress=no # -# 3.93. header_color_partial +# 3.114. header_color_partial # # Type: boolean # Default: no @@ -1348,7 +1674,7 @@ set header_cache_compress=no # -# 3.94. help +# 3.115. help # # Type: boolean # Default: yes @@ -1363,7 +1689,7 @@ set header_cache_compress=no # -# 3.95. hidden_host +# 3.116. hidden_host # # Type: boolean # Default: no @@ -1374,7 +1700,7 @@ set header_cache_compress=no # -# 3.96. hide_limited +# 3.117. hide_limited # # Type: boolean # Default: no @@ -1384,7 +1710,7 @@ set header_cache_compress=no # -# 3.97. hide_missing +# 3.118. hide_missing # # Type: boolean # Default: yes @@ -1394,7 +1720,7 @@ set header_cache_compress=no # -# 3.98. hide_thread_subject +# 3.119. hide_thread_subject # # Type: boolean # Default: yes @@ -1404,7 +1730,7 @@ set header_cache_compress=no # -# 3.99. hide_top_limited +# 3.120. hide_top_limited # # Type: boolean # Default: no @@ -1415,7 +1741,7 @@ set header_cache_compress=no # -# 3.100. hide_top_missing +# 3.121. hide_top_missing # # Type: boolean # Default: yes @@ -1426,7 +1752,7 @@ set header_cache_compress=no # -# 3.101. history +# 3.122. history # # Type: number # Default: 10 @@ -1437,7 +1763,7 @@ set header_cache_compress=no # -# 3.102. history_file +# 3.123. history_file # # Type: path # Default: “~/.mutthistory” @@ -1449,7 +1775,7 @@ set header_cache_compress=no set history_file="~/.var/mutt/history" -# 3.103. history_remove_dups +# 3.124. history_remove_dups # # Type: boolean # Default: no @@ -1460,7 +1786,7 @@ set history_file="~/.var/mutt/history" # -# 3.104. honor_disposition +# 3.125. honor_disposition # # Type: boolean # Default: no @@ -1474,7 +1800,7 @@ set history_file="~/.var/mutt/history" # -# 3.105. honor_followup_to +# 3.126. honor_followup_to # # Type: quadoption # Default: yes @@ -1484,7 +1810,7 @@ set history_file="~/.var/mutt/history" # -# 3.106. hostname +# 3.127. hostname # # Type: string # Default: (empty) @@ -1501,11 +1827,16 @@ set history_file="~/.var/mutt/history" # Mutt can be compiled with a fixed domain name in which case a detected one is # not used. # +# Starting in Mutt 2.0, the operations described in the previous paragraph are +# performed after the muttrc is processed, instead of beforehand. This way, if +# the DNS operations are creating delays at startup, you can avoid those by +# manually setting the value in your muttrc. +# # Also see $use_domain and $hidden_host. # -# 3.107. idn_decode +# 3.128. idn_decode # # Type: boolean # Default: yes @@ -1516,7 +1847,7 @@ set history_file="~/.var/mutt/history" # -# 3.108. idn_encode +# 3.129. idn_encode # # Type: boolean # Default: yes @@ -1526,7 +1857,7 @@ set history_file="~/.var/mutt/history" # -# 3.109. ignore_linear_white_space +# 3.130. ignore_linear_white_space # # Type: boolean # Default: no @@ -1537,7 +1868,7 @@ set history_file="~/.var/mutt/history" # -# 3.110. ignore_list_reply_to +# 3.131. ignore_list_reply_to # # Type: boolean # Default: no @@ -1553,7 +1884,7 @@ set history_file="~/.var/mutt/history" set ignore_list_reply_to=yes -# 3.111. imap_authenticators +# 3.132. imap_authenticators # # Type: string # Default: (empty) @@ -1575,7 +1906,7 @@ set ignore_list_reply_to=yes # -# 3.112. imap_check_subscribed +# 3.133. imap_check_subscribed # # Type: boolean # Default: no @@ -1586,7 +1917,35 @@ set ignore_list_reply_to=yes # -# 3.113. imap_delim_chars +# 3.134. imap_condstore +# +# Type: boolean +# Default: no +# +# When set, mutt will use the CONDSTORE extension (RFC 7162) if advertised by the +# server. Mutt's current implementation is basic, used only for initial message +# fetching and flag updates. +# +# For some IMAP servers, enabling this will slightly speed up downloading initial +# messages. Unfortunately, Gmail is not one those, and displays worse performance +# when enabled. Your mileage may vary. +# + + +# 3.135. imap_deflate +# +# Type: boolean +# Default: no +# +# When set, mutt will use the COMPRESS=DEFLATE extension (RFC 4978) if advertised +# by the server. +# +# In general a good compression efficiency can be achieved, which speeds up +# reading large mailboxes also on fairly good connections. +# + + +# 3.136. imap_delim_chars # # Type: string # Default: “/.” @@ -1597,16 +1956,28 @@ set ignore_list_reply_to=yes # -# 3.114. imap_headers +# 3.137. imap_fetch_chunk_size +# +# Type: number (long) +# Default: 0 +# +# When set to a value greater than 0, new headers will be downloaded in groups of +# this many headers per request. If you have a very large mailbox, this might +# prevent a timeout and disconnect when opening the mailbox, by sending a FETCH +# per set of this many headers, instead of a single FETCH for all new headers. +# + + +# 3.138. imap_headers # # Type: string # Default: (empty) # # Mutt requests these header fields in addition to the default headers (“Date:”, -# “From:”, “Subject:”, “To:”, “Cc:”, “Message-Id:”, “References:”, “Content-Type: -# ”, “Content-Description:”, “In-Reply-To:”, “Reply-To:”, “Lines:”, “List-Post:”, -# “X-Label:”) from IMAP servers before displaying the index menu. You may want to -# add more headers for spam detection. +# “From:”, “Sender:”, “Subject:”, “To:”, “Cc:”, “Message-Id:”, “References:”, “ +# Content-Type:”, “Content-Description:”, “In-Reply-To:”, “Reply-To:”, “Lines:”, +# “List-Post:”, “X-Label:”) from IMAP servers before displaying the index menu. +# You may want to add more headers for spam detection. # # Note: This is a space separated list, items should be uppercase and not contain # the colon, e.g. “X-BOGOSITY X-SPAM-STATUS” for the “X-Bogosity:” and “ @@ -1614,7 +1985,7 @@ set ignore_list_reply_to=yes # -# 3.115. imap_idle +# 3.139. imap_idle # # Type: boolean # Default: no @@ -1626,7 +1997,7 @@ set ignore_list_reply_to=yes # -# 3.116. imap_keepalive +# 3.140. imap_keepalive # # Type: number # Default: 300 @@ -1641,7 +2012,7 @@ set ignore_list_reply_to=yes # -# 3.117. imap_list_subscribed +# 3.141. imap_list_subscribed # # Type: boolean # Default: no @@ -1652,7 +2023,7 @@ set ignore_list_reply_to=yes # -# 3.118. imap_login +# 3.142. imap_login # # Type: string # Default: (empty) @@ -1663,18 +2034,19 @@ set ignore_list_reply_to=yes # -# 3.119. imap_oauth_refresh_command +# 3.143. imap_oauth_refresh_command # # Type: string # Default: (empty) # # The command to run to generate an OAUTH refresh token for authorizing your # connection to your IMAP server. This command will be run on every connection -# attempt that uses the OAUTHBEARER authentication mechanism. +# attempt that uses the OAUTHBEARER authentication mechanism. See “oauth” for +# details. # -# 3.120. imap_pass +# 3.144. imap_pass # # Type: string # Default: (empty) @@ -1689,19 +2061,19 @@ set ignore_list_reply_to=yes # -# 3.121. imap_passive +# 3.145. imap_passive # # Type: boolean # Default: yes # # When set, mutt will not open new IMAP connections to check for new mail. Mutt # will only check for new mail over existing IMAP connections. This is useful if -# you don't want to be prompted to user/password pairs on mutt invocation, or if +# you don't want to be prompted for user/password pairs on mutt invocation, or if # opening the connection is slow. # -# 3.122. imap_peek +# 3.146. imap_peek # # Type: boolean # Default: yes @@ -1713,7 +2085,7 @@ set ignore_list_reply_to=yes # -# 3.123. imap_pipeline_depth +# 3.147. imap_pipeline_depth # # Type: number # Default: 15 @@ -1728,7 +2100,7 @@ set ignore_list_reply_to=yes # -# 3.124. imap_poll_timeout +# 3.148. imap_poll_timeout # # Type: number # Default: 15 @@ -1739,7 +2111,22 @@ set ignore_list_reply_to=yes # -# 3.125. imap_servernoise +# 3.149. imap_qresync +# +# Type: boolean +# Default: no +# +# When set, mutt will use the QRESYNC extension (RFC 7162) if advertised by the +# server. Mutt's current implementation is basic, used only for initial message +# fetching and flag updates. +# +# Note: this feature is currently experimental. If you experience strange +# behavior, such as duplicate or missing messages please file a bug report to let +# us know. +# + + +# 3.150. imap_servernoise # # Type: boolean # Default: yes @@ -1751,7 +2138,7 @@ set ignore_list_reply_to=yes # -# 3.126. imap_user +# 3.151. imap_user # # Type: string # Default: (empty) @@ -1762,7 +2149,7 @@ set ignore_list_reply_to=yes # -# 3.127. implicit_autoview +# 3.152. implicit_autoview # # Type: boolean # Default: no @@ -1775,7 +2162,7 @@ set ignore_list_reply_to=yes set implicit_autoview=no -# 3.128. include +# 3.153. include # # Type: quadoption # Default: ask-yes @@ -1786,7 +2173,22 @@ set implicit_autoview=no set include=yes -# 3.129. include_onlyfirst +# 3.154. include_encrypted +# +# Type: boolean +# Default: no +# +# Controls whether or not Mutt includes separately encrypted attachment contents +# when replying. +# +# This variable was added to prevent accidental exposure of encrypted contents +# when replying to an attacker. If a previously encrypted message were attached +# by the attacker, they could trick an unwary recipient into decrypting and +# including the message in their reply. +# + + +# 3.155. include_onlyfirst # # Type: boolean # Default: no @@ -1796,7 +2198,7 @@ set include=yes # -# 3.130. indent_string +# 3.156. indent_string # # Type: string # Default: “> ” @@ -1813,7 +2215,7 @@ set include=yes # -# 3.131. index_format +# 3.157. index_format # # Type: string # Default: “%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s” @@ -1826,109 +2228,118 @@ set include=yes # construct, see the $status_format description. The following sequences are # defined in Mutt: # -# ┌─────┬───────────────────────────────────────────────────────────────────────┐ -# │%a │address of the author │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%A │reply-to address (if present; otherwise: address of author) │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%b │filename of the original message folder (think mailbox) │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%B │the list to which the letter was sent, or else the folder name (%b). │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%c │number of characters (bytes) in the message │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%C │current message number │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%d │date and time of the message in the format specified by $date_format │ -# │ │converted to sender's time zone │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%D │date and time of the message in the format specified by $date_format │ -# │ │converted to the local time zone │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%e │current message number in thread │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%E │number of messages in current thread │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%f │sender (address + real name), either From: or Return-Path: │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%F │author name, or recipient name if the message is from you │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%H │spam attribute(s) of this message │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%i │message-id of the current message │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%l │number of lines in the message (does not work with maildir, mh, and │ -# │ │possibly IMAP folders) │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │ │If an address in the “To:” or “Cc:” header field matches an address │ -# │%L │defined by the users “subscribe” command, this displays "To │ -# │ │", otherwise the same as %F. │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%m │total number of message in the mailbox │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%M │number of hidden messages if the thread is collapsed. │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%N │message score │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%n │author's real name (or address if missing) │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%O │original save folder where mutt would formerly have stashed the │ -# │ │message: list name or recipient name if not sent to a list │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%P │progress indicator for the built-in pager (how much of the file has │ -# │ │been displayed) │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%r │comma separated list of “To:” recipients │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%R │comma separated list of “Cc:” recipients │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%s │subject of the message │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%S │single character status of the message (“N”/“O”/“D”/“d”/“!”/“r”/“*”) │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%t │“To:” field (recipients) │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%T │the appropriate character from the $to_chars string │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%u │user (login) name of the author │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%v │first name of the author, or the recipient if the message is from you │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%X │number of attachments (please see the “attachments” section for │ -# │ │possible speed effects) │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%y │“X-Label:” field, if present │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │ │“X-Label:” field, if present, and (1) not at part of a thread tree, (2)│ -# │%Y │at the top of a thread, or (3) “X-Label:” is different from preceding │ -# │ │message's “X-Label:”. │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │ │a three character set of message status flags. the first character is │ -# │%Z │new/read/replied flags (“n”/“o”/“r”/“O”/“N”). the second is deleted or │ -# │ │encryption flags (“D”/“d”/“S”/“P”/“s”/“K”). the third is either tagged/│ -# │ │flagged (“*”/“!”), or one of the characters listed in $to_chars. │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │% │the date and time of the message is converted to sender's time zone, │ -# │{fmt}│and “fmt” is expanded by the library function strftime(3); a leading │ -# │ │bang disables locales │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │% │the date and time of the message is converted to the local time zone, │ -# │[fmt]│and “fmt” is expanded by the library function strftime(3); a leading │ -# │ │bang disables locales │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │% │the local date and time when the message was received. “fmt” is │ -# │(fmt)│expanded by the library function strftime(3); a leading bang disables │ -# │ │locales │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │% │the current local time. “fmt” is expanded by the library function │ -# ││strftime(3); a leading bang disables locales. │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%>X │right justify the rest of the string and pad with character “X” │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%|X │pad to the end of the line with character “X” │ -# ├─────┼───────────────────────────────────────────────────────────────────────┤ -# │%*X │soft-fill with character “X” as pad │ -# └─────┴───────────────────────────────────────────────────────────────────────┘ +# ┌───────┬─────────────────────────────────────────────────────────────────────┐ +# │%a │address of the author │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%A │reply-to address (if present; otherwise: address of author) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%b │filename of the original message folder (think mailbox) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%B │the list to which the letter was sent, or else the folder name (%b). │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%c │number of characters (bytes) in the message (see formatstrings-size) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%C │current message number │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%d │date and time of the message in the format specified by $date_format │ +# │ │converted to sender's time zone │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%D │date and time of the message in the format specified by $date_format │ +# │ │converted to the local time zone │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%e │current message number in thread │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%E │number of messages in current thread │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%f │sender (address + real name), either From: or Return-Path: │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%F │author name, or recipient name if the message is from you │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%H │spam attribute(s) of this message │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%i │message-id of the current message │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%l │number of lines in the unprocessed message (may not work with │ +# │ │maildir, mh, and IMAP folders) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │ │If an address in the “To:” or “Cc:” header field matches an address │ +# │%L │defined by the users “subscribe” command, this displays "To │ +# │ │", otherwise the same as %F. │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%m │total number of message in the mailbox │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%M │number of hidden messages if the thread is collapsed. │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%N │message score │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%n │author's real name (or address if missing) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%O │original save folder where mutt would formerly have stashed the │ +# │ │message: list name or recipient name if not sent to a list │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%P │progress indicator for the built-in pager (how much of the file has │ +# │ │been displayed) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%r │comma separated list of “To:” recipients │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%R │comma separated list of “Cc:” recipients │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%s │subject of the message │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%S │single character status of the message (“N”/“O”/“D”/“d”/“!”/“r”/“*”) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%t │“To:” field (recipients) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%T │the appropriate character from the $to_chars string │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%u │user (login) name of the author │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%v │first name of the author, or the recipient if the message is from you│ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%X │number of attachments (please see the “attachments” section for │ +# │ │possible speed effects) │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%y │“X-Label:” field, if present │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │ │“X-Label:” field, if present, and (1) not at part of a thread tree, │ +# │%Y │(2) at the top of a thread, or (3) “X-Label:” is different from │ +# │ │preceding message's “X-Label:”. │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │ │a three character set of message status flags. the first character is│ +# │ │new/read/replied flags (“n”/“o”/“r”/“O”/“N”). the second is deleted │ +# │%Z │or encryption flags (“D”/“d”/“S”/“P”/“s”/“K”). the third is either │ +# │ │tagged/flagged (“*”/“!”), or one of the characters listed in │ +# │ │$to_chars. │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%@name@│insert and evaluate format-string from the matching “ │ +# │ │index-format-hook” command │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │ │the date and time of the message is converted to sender's time zone, │ +# │%{fmt} │and “fmt” is expanded by the library function strftime(3); a leading │ +# │ │bang disables locales │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │ │the date and time of the message is converted to the local time zone,│ +# │%[fmt] │and “fmt” is expanded by the library function strftime(3); a leading │ +# │ │bang disables locales │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │ │the local date and time when the message was received. “fmt” is │ +# │%(fmt) │expanded by the library function strftime(3); a leading bang disables│ +# │ │locales │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │% │the current local time. “fmt” is expanded by the library function │ +# │ │strftime(3); a leading bang disables locales. │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%>X │right justify the rest of the string and pad with character “X” │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%|X │pad to the end of the line with character “X” │ +# ├───────┼─────────────────────────────────────────────────────────────────────┤ +# │%*X │soft-fill with character “X” as pad │ +# └───────┴─────────────────────────────────────────────────────────────────────┘ +# +# Note that for mbox/mmdf, “%l” applies to the unprocessed message, and for +# maildir/mh, the value comes from the “Lines:” header field when present (the +# meaning is normally the same). Thus the value depends on the encodings used in +# the different parts of the message and has little meaning in practice. # # “Soft-fill” deserves some explanation: Normal right-justification will print # everything to the left of the “%>”, displaying padding and whatever lies to the @@ -1937,12 +2348,16 @@ set include=yes # there's still room. If necessary, soft-fill will eat text leftwards to make # room for rightward text. # -# Note that these expandos are supported in “save-hook”, “fcc-hook” and “ -# fcc-save-hook”, too. +# Note that these expandos are supported in “save-hook”, “fcc-hook”, “ +# fcc-save-hook”, and “index-format-hook”. +# +# They are also supported in the configuration variables $attribution, +# $forward_attribution_intro, $forward_attribution_trailer, $forward_format, +# $indent_string, $message_format, $pager_format, and $post_indent_string. # -# 3.132. ispell +# 3.158. ispell # # Type: path # Default: “ispell” @@ -1951,7 +2366,7 @@ set include=yes # -# 3.133. keep_flagged +# 3.159. keep_flagged # # Type: boolean # Default: no @@ -1961,7 +2376,17 @@ set include=yes # -# 3.134. mail_check +# 3.160. local_date_header +# +# Type: boolean +# Default: yes +# +# If set, convert the date in the Date header of sent emails into local +# (sender's) timezone. +# + + +# 3.161. mail_check # # Type: number # Default: 5 @@ -1971,7 +2396,7 @@ set include=yes # -# 3.135. mail_check_recent +# 3.162. mail_check_recent # # Type: boolean # Default: yes @@ -1986,7 +2411,7 @@ set include=yes # -# 3.136. mail_check_stats +# 3.163. mail_check_stats # # Type: boolean # Default: no @@ -1997,10 +2422,13 @@ set include=yes # defaults to unset, and has a separate option, $mail_check_stats_interval, to # control how often to update these counts. # +# Message statistics can also be explicitly calculated by invoking the +# function. +# set mail_check_stats=yes -# 3.137. mail_check_stats_interval +# 3.164. mail_check_stats_interval # # Type: number # Default: 60 @@ -2010,18 +2438,19 @@ set mail_check_stats=yes # -# 3.138. mailcap_path +# 3.165. mailcap_path # # Type: string # Default: (empty) # # This variable specifies which files to consult when attempting to display MIME -# bodies not directly supported by Mutt. +# bodies not directly supported by Mutt. The default value is generated during +# startup: see the “mailcap” section of the manual. # set mailcap_path="$my_confdir/mailcap.containers:$my_confdir/mailcap.icalendar:$my_confdir/mailcap.backgrounding:$my_confdir/mailcap.htmldump" -# 3.139. mailcap_sanitize +# 3.166. mailcap_sanitize # # Type: boolean # Default: yes @@ -2034,7 +2463,7 @@ set mailcap_path="$my_confdir/mailcap.containers:$my_confdir/mailcap.icalendar:$ # -# 3.140. maildir_header_cache_verify +# 3.167. maildir_header_cache_verify # # Type: boolean # Default: yes @@ -2046,7 +2475,7 @@ set mailcap_path="$my_confdir/mailcap.containers:$my_confdir/mailcap.icalendar:$ set maildir_header_cache_verify=no -# 3.141. maildir_trash +# 3.168. maildir_trash # # Type: boolean # Default: no @@ -2057,7 +2486,7 @@ set maildir_header_cache_verify=no # -# 3.142. maildir_check_cur +# 3.169. maildir_check_cur # # Type: boolean # Default: no @@ -2070,7 +2499,7 @@ set maildir_header_cache_verify=no # -# 3.143. mark_macro_prefix +# 3.170. mark_macro_prefix # # Type: string # Default: “'” @@ -2081,7 +2510,7 @@ set maildir_header_cache_verify=no # -# 3.144. mark_old +# 3.171. mark_old # # Type: boolean # Default: yes @@ -2094,7 +2523,7 @@ set maildir_header_cache_verify=no set mark_old=no -# 3.145. markers +# 3.172. markers # # Type: boolean # Default: yes @@ -2107,7 +2536,7 @@ set mark_old=no set markers=no -# 3.146. mask +# 3.173. mask # # Type: regular expression # Default: “!^.[^.]” @@ -2118,7 +2547,7 @@ set markers=no # -# 3.147. mbox +# 3.174. mbox # # Type: path # Default: “~/mbox” @@ -2131,7 +2560,7 @@ set markers=no set mbox="=spool" -# 3.148. mbox_type +# 3.175. mbox_type # # Type: folder magic # Default: mbox @@ -2142,7 +2571,7 @@ set mbox="=spool" set mbox_type=Maildir -# 3.149. menu_context +# 3.176. menu_context # # Type: number # Default: 0 @@ -2153,7 +2582,7 @@ set mbox_type=Maildir set menu_context=5 -# 3.150. menu_move_off +# 3.177. menu_move_off # # Type: boolean # Default: yes @@ -2164,7 +2593,7 @@ set menu_context=5 # -# 3.151. menu_scroll +# 3.178. menu_scroll # # Type: boolean # Default: no @@ -2177,7 +2606,7 @@ set menu_context=5 set menu_scroll=yes -# 3.152. message_cache_clean +# 3.179. message_cache_clean # # Type: boolean # Default: no @@ -2188,7 +2617,7 @@ set menu_scroll=yes # -# 3.153. message_cachedir +# 3.180. message_cachedir # # Type: path # Default: (empty) @@ -2204,7 +2633,7 @@ set menu_scroll=yes # -# 3.154. message_format +# 3.181. message_format # # Type: string # Default: “%s” @@ -2215,7 +2644,56 @@ set menu_scroll=yes # -# 3.155. meta_key +# 3.182. message_id_format +# +# Type: string +# Default: “<%z@%f>” +# +# This variable describes the format of the Message-ID generated when sending +# messages. Mutt 2.0 introduced a more compact format, but this variable allows +# the ability to choose your own format. The value may end in “|” to invoke an +# external filter. See formatstrings-filters. +# +# Please note that the Message-ID value follows a strict syntax, and you are +# responsible for ensuring correctness if you change this from the default. In +# particular, the value must follow the syntax in RFC 5322: “"<" id-left "@" +# id-right ">"”. No spaces are allowed, and id-left should follow the +# dot-atom-text syntax in the RFC. The id-right should generally be left at %f. +# +# The old Message-ID format can be used by setting this to: “ +# <%Y%02m%02d%02H%02M%02S.G%c%p@%f>” +# +# The following printf(3)-style sequences are understood: +# +# ┌──┬─────────────────────────────────────────────────────────────────┐ +# │%c│step counter looping from “A” to “Z” │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%d│current day of the month (GMT) │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%f│$hostname │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%H│current hour using a 24-hour clock (GMT) │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%m│current month number (GMT) │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%M│current minute of the hour (GMT) │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%p│pid of the running mutt process │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%r│3 bytes of pseudorandom data encoded in Base64 │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%S│current second of the minute (GMT) │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%x│1 byte of pseudorandom data hex encoded (example: '1b') │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%Y│current year using 4 digits (GMT) │ +# ├──┼─────────────────────────────────────────────────────────────────┤ +# │%z│4 byte timestamp + 8 bytes of pseudorandom data encoded in Base64│ +# └──┴─────────────────────────────────────────────────────────────────┘ +# + + +# 3.183. meta_key # # Type: boolean # Default: no @@ -2229,7 +2707,7 @@ set menu_scroll=yes # -# 3.156. metoo +# 3.184. metoo # # Type: boolean # Default: no @@ -2239,7 +2717,7 @@ set menu_scroll=yes # -# 3.157. mh_purge +# 3.185. mh_purge # # Type: boolean # Default: no @@ -2253,7 +2731,7 @@ set menu_scroll=yes # -# 3.158. mh_seq_flagged +# 3.186. mh_seq_flagged # # Type: string # Default: “flagged” @@ -2262,7 +2740,7 @@ set menu_scroll=yes # -# 3.159. mh_seq_replied +# 3.187. mh_seq_replied # # Type: string # Default: “replied” @@ -2271,7 +2749,7 @@ set menu_scroll=yes # -# 3.160. mh_seq_unseen +# 3.188. mh_seq_unseen # # Type: string # Default: “unseen” @@ -2280,7 +2758,7 @@ set menu_scroll=yes # -# 3.161. mime_forward +# 3.189. mime_forward # # Type: quadoption # Default: no @@ -2296,7 +2774,7 @@ set menu_scroll=yes set mime_forward=ask-yes -# 3.162. mime_forward_decode +# 3.190. mime_forward_decode # # Type: boolean # Default: no @@ -2307,7 +2785,7 @@ set mime_forward=ask-yes # -# 3.163. mime_forward_rest +# 3.191. mime_forward_rest # # Type: quadoption # Default: yes @@ -2318,7 +2796,7 @@ set mime_forward=ask-yes # -# 3.164. mime_type_query_command +# 3.192. mime_type_query_command # # Type: string # Default: (empty) @@ -2339,7 +2817,7 @@ set mime_forward=ask-yes # -# 3.165. mime_type_query_first +# 3.193. mime_type_query_first # # Type: boolean # Default: no @@ -2349,7 +2827,7 @@ set mime_forward=ask-yes # -# 3.166. mix_entry_format +# 3.194. mix_entry_format # # Type: string # Default: “%4n %c %-16s %a” @@ -2369,7 +2847,7 @@ set mime_forward=ask-yes # -# 3.167. mixmaster +# 3.195. mixmaster # # Type: path # Default: “mixmaster” @@ -2381,7 +2859,7 @@ set mime_forward=ask-yes set mixmaster="mixmaster-filter" -# 3.168. move +# 3.196. move # # Type: quadoption # Default: no @@ -2392,7 +2870,17 @@ set mixmaster="mixmaster-filter" set move=no -# 3.169. narrow_tree +# 3.197. muttlisp_inline_eval +# +# Type: boolean +# Default: no +# +# If set, Mutt will evaluate bare parenthesis arguments to commands as MuttLisp +# expressions. +# + + +# 3.198. narrow_tree # # Type: boolean # Default: no @@ -2403,7 +2891,7 @@ set move=no set narrow_tree=yes -# 3.170. net_inc +# 3.199. net_inc # # Type: number # Default: 10 @@ -2416,7 +2904,7 @@ set narrow_tree=yes # -# 3.171. new_mail_command +# 3.200. new_mail_command # # Type: path # Default: (empty) @@ -2427,7 +2915,7 @@ set narrow_tree=yes # -# 3.172. pager +# 3.201. pager # # Type: path # Default: “builtin” @@ -2441,9 +2929,11 @@ set narrow_tree=yes # screen resizes cause lines longer than the screen width to be badly formatted # in the help menu. # +# When using an external pager, also see $prompt_after which defaults set. +# -# 3.173. pager_context +# 3.202. pager_context # # Type: number # Default: 0 @@ -2460,7 +2950,7 @@ set narrow_tree=yes set pager_context=2 -# 3.174. pager_format +# 3.203. pager_format # # Type: string # Default: “-%Z- %C/%m: %-20.20n %s%* -- (%P)” @@ -2472,7 +2962,7 @@ set pager_context=2 set pager_format="<%a> %* %i (%P)" -# 3.175. pager_index_lines +# 3.204. pager_index_lines # # Type: number # Default: 0 @@ -2491,7 +2981,7 @@ set pager_format="<%a> %* %i (%P)" set pager_index_lines=$menu_context -# 3.176. pager_stop +# 3.205. pager_stop # # Type: boolean # Default: no @@ -2502,7 +2992,25 @@ set pager_index_lines=$menu_context set pager_stop=yes -# 3.177. pgp_auto_decode +# 3.206. pattern_format +# +# Type: string +# Default: “%2n %-15e %d” +# +# This variable describes the format of the “pattern completion” menu. The +# following printf(3)-style sequences are understood: +# +# ┌──┬────────────────────┐ +# │%d│pattern description │ +# ├──┼────────────────────┤ +# │%e│pattern expression │ +# ├──┼────────────────────┤ +# │%n│index number │ +# └──┴────────────────────┘ +# + + +# 3.207. pgp_auto_decode # # Type: boolean # Default: no @@ -2517,7 +3025,7 @@ set pager_stop=yes set pgp_auto_decode=yes -# 3.178. pgp_autoinline +# 3.208. pgp_autoinline # # Type: boolean # Default: no @@ -2538,7 +3046,7 @@ set pgp_auto_decode=yes # -# 3.179. pgp_check_exit +# 3.209. pgp_check_exit # # Type: boolean # Default: yes @@ -2548,7 +3056,7 @@ set pgp_auto_decode=yes # -# 3.180. pgp_check_gpg_decrypt_status_fd +# 3.210. pgp_check_gpg_decrypt_status_fd # # Type: boolean # Default: yes @@ -2564,7 +3072,7 @@ set pgp_auto_decode=yes # -# 3.181. pgp_clearsign_command +# 3.211. pgp_clearsign_command # # Type: string # Default: (empty) @@ -2577,7 +3085,7 @@ set pgp_auto_decode=yes # -# 3.182. pgp_decode_command +# 3.212. pgp_decode_command # # Type: string # Default: (empty) @@ -2608,7 +3116,7 @@ set pgp_auto_decode=yes # -# 3.183. pgp_decrypt_command +# 3.213. pgp_decrypt_command # # Type: string # Default: (empty) @@ -2620,7 +3128,7 @@ set pgp_auto_decode=yes # -# 3.184. pgp_decryption_okay +# 3.214. pgp_decryption_okay # # Type: regular expression # Default: (empty) @@ -2636,7 +3144,7 @@ set pgp_auto_decode=yes # -# 3.185. pgp_default_key +# 3.215. pgp_default_key # # Type: string # Default: (empty) @@ -2651,7 +3159,7 @@ set pgp_auto_decode=yes # -# 3.186. pgp_encrypt_only_command +# 3.216. pgp_encrypt_only_command # # Type: string # Default: (empty) @@ -2663,7 +3171,7 @@ set pgp_auto_decode=yes # -# 3.187. pgp_encrypt_sign_command +# 3.217. pgp_encrypt_sign_command # # Type: string # Default: (empty) @@ -2675,7 +3183,7 @@ set pgp_auto_decode=yes # -# 3.188. pgp_entry_format +# 3.218. pgp_entry_format # # Type: string # Default: “%4n %t%f %4l/0x%k %-4a %2c %u” @@ -2708,7 +3216,7 @@ set pgp_auto_decode=yes # -# 3.189. pgp_export_command +# 3.219. pgp_export_command # # Type: string # Default: (empty) @@ -2720,7 +3228,7 @@ set pgp_auto_decode=yes # -# 3.190. pgp_getkeys_command +# 3.220. pgp_getkeys_command # # Type: string # Default: (empty) @@ -2733,7 +3241,7 @@ set pgp_auto_decode=yes # -# 3.191. pgp_good_sign +# 3.221. pgp_good_sign # # Type: regular expression # Default: (empty) @@ -2745,7 +3253,7 @@ set pgp_auto_decode=yes # -# 3.192. pgp_ignore_subkeys +# 3.222. pgp_ignore_subkeys # # Type: boolean # Default: yes @@ -2756,7 +3264,7 @@ set pgp_auto_decode=yes # -# 3.193. pgp_import_command +# 3.223. pgp_import_command # # Type: string # Default: (empty) @@ -2769,7 +3277,7 @@ set pgp_auto_decode=yes # -# 3.194. pgp_list_pubring_command +# 3.224. pgp_list_pubring_command # # Type: string # Default: (empty) @@ -2779,17 +3287,20 @@ set pgp_auto_decode=yes # # gpg --list-keys --with-colons --with-fingerprint # -# This format is also generated by the pgpring utility which comes with mutt. +# This format is also generated by the mutt_pgpring utility which comes with +# mutt. # # Note: gpg's fixed-list-mode option should not be used. It produces a different # date format which may result in mutt showing incorrect key generation dates. # # This is a format string, see the $pgp_decode_command command for possible -# printf(3)-like sequences. (PGP only) +# printf(3)-like sequences. Note that in this case, %r expands to the search +# string, which is a list of one or more quoted values such as email address, +# name, or keyid. (PGP only) # -# 3.195. pgp_list_secring_command +# 3.225. pgp_list_secring_command # # Type: string # Default: (empty) @@ -2799,17 +3310,20 @@ set pgp_auto_decode=yes # # gpg --list-keys --with-colons --with-fingerprint # -# This format is also generated by the pgpring utility which comes with mutt. +# This format is also generated by the mutt_pgpring utility which comes with +# mutt. # # Note: gpg's fixed-list-mode option should not be used. It produces a different # date format which may result in mutt showing incorrect key generation dates. # # This is a format string, see the $pgp_decode_command command for possible -# printf(3)-like sequences. (PGP only) +# printf(3)-like sequences. Note that in this case, %r expands to the search +# string, which is a list of one or more quoted values such as email address, +# name, or keyid. (PGP only) # -# 3.196. pgp_long_ids +# 3.226. pgp_long_ids # # Type: boolean # Default: yes @@ -2821,7 +3335,7 @@ set pgp_auto_decode=yes # -# 3.197. pgp_mime_auto +# 3.227. pgp_mime_auto # # Type: quadoption # Default: ask-yes @@ -2835,7 +3349,7 @@ set pgp_auto_decode=yes # -# 3.198. pgp_replyinline +# 3.228. pgp_replyinline # # Type: boolean # Default: no @@ -2858,7 +3372,7 @@ set pgp_auto_decode=yes # -# 3.199. pgp_retainable_sigs +# 3.229. pgp_retainable_sigs # # Type: boolean # Default: no @@ -2873,7 +3387,7 @@ set pgp_auto_decode=yes set pgp_retainable_sigs=yes -# 3.200. pgp_self_encrypt +# 3.230. pgp_self_encrypt # # Type: boolean # Default: yes @@ -2883,7 +3397,7 @@ set pgp_retainable_sigs=yes # -# 3.201. pgp_show_unusable +# 3.231. pgp_show_unusable # # Type: boolean # Default: yes @@ -2895,7 +3409,7 @@ set pgp_retainable_sigs=yes set pgp_show_unusable=no -# 3.202. pgp_sign_as +# 3.232. pgp_sign_as # # Type: string # Default: (empty) @@ -2908,7 +3422,7 @@ set pgp_show_unusable=no set pgp_sign_as="0x9C9D6979AE941637" -# 3.203. pgp_sign_command +# 3.233. pgp_sign_command # # Type: string # Default: (empty) @@ -2921,7 +3435,7 @@ set pgp_sign_as="0x9C9D6979AE941637" # -# 3.204. pgp_sort_keys +# 3.234. pgp_sort_keys # # Type: sort order # Default: address @@ -2944,7 +3458,7 @@ set pgp_sign_as="0x9C9D6979AE941637" # -# 3.205. pgp_strict_enc +# 3.235. pgp_strict_enc # # Type: boolean # Default: yes @@ -2956,9 +3470,9 @@ set pgp_sign_as="0x9C9D6979AE941637" # -# 3.206. pgp_timeout +# 3.236. pgp_timeout # -# Type: number +# Type: number (long) # Default: 300 # # The number of seconds after which a cached passphrase will expire if not used. @@ -2966,19 +3480,30 @@ set pgp_sign_as="0x9C9D6979AE941637" # -# 3.207. pgp_use_gpg_agent +# 3.237. pgp_use_gpg_agent # # Type: boolean -# Default: no +# Default: yes +# +# If set, mutt expects a gpg-agent(1) process will handle private key passphrase +# prompts. If unset, mutt will prompt for the passphrase and pass it via stdin to +# the pgp command. # -# If set, mutt will use a possibly-running gpg-agent(1) process. Note that as of -# version 2.1, GnuPG no longer exports GPG_AGENT_INFO, so mutt no longer verifies -# if the agent is running. (PGP only) +# Note that as of version 2.1, GnuPG automatically spawns an agent and requires +# the agent be used for passphrase management. Since that version is increasingly +# prevalent, this variable now defaults set. +# +# Mutt works with a GUI or curses pinentry program. A TTY pinentry should not be +# used. +# +# If you are using an older version of GnuPG without an agent running, or another +# encryption program without an agent, you will need to unset this variable. (PGP +# only) # set pgp_use_gpg_agent=yes -# 3.208. pgp_verify_command +# 3.238. pgp_verify_command # # Type: string # Default: (empty) @@ -2990,7 +3515,7 @@ set pgp_use_gpg_agent=yes # -# 3.209. pgp_verify_key_command +# 3.239. pgp_verify_key_command # # Type: string # Default: (empty) @@ -3002,18 +3527,31 @@ set pgp_use_gpg_agent=yes # -# 3.210. pipe_decode +# 3.240. pipe_decode # # Type: boolean # Default: no # -# Used in connection with the command. When unset, Mutt will pipe -# the messages without any preprocessing. When set, Mutt will weed headers and -# will attempt to decode the messages first. +# Used in connection with the function. When unset, Mutt will pipe +# the messages without any preprocessing. When set, Mutt will attempt to decode +# the messages first. +# +# Also see $pipe_decode_weed, which controls whether headers will be weeded when +# this is set. +# + + +# 3.241. pipe_decode_weed +# +# Type: boolean +# Default: yes +# +# For , when $pipe_decode is set, this further controls whether +# Mutt will weed headers. # -# 3.211. pipe_sep +# 3.242. pipe_sep # # Type: string # Default: “n” @@ -3023,7 +3561,7 @@ set pgp_use_gpg_agent=yes # -# 3.212. pipe_split +# 3.243. pipe_split # # Type: boolean # Default: no @@ -3036,7 +3574,7 @@ set pgp_use_gpg_agent=yes # -# 3.213. pop_auth_try_all +# 3.244. pop_auth_try_all # # Type: boolean # Default: yes @@ -3048,7 +3586,7 @@ set pgp_use_gpg_agent=yes # -# 3.214. pop_authenticators +# 3.245. pop_authenticators # # Type: string # Default: (empty) @@ -3066,7 +3604,7 @@ set pgp_use_gpg_agent=yes # -# 3.215. pop_checkinterval +# 3.246. pop_checkinterval # # Type: number # Default: 60 @@ -3076,7 +3614,7 @@ set pgp_use_gpg_agent=yes # -# 3.216. pop_delete +# 3.247. pop_delete # # Type: quadoption # Default: ask-no @@ -3087,7 +3625,7 @@ set pgp_use_gpg_agent=yes # -# 3.217. pop_host +# 3.248. pop_host # # Type: string # Default: (empty) @@ -3101,7 +3639,7 @@ set pgp_use_gpg_agent=yes # -# 3.218. pop_last +# 3.249. pop_last # # Type: boolean # Default: no @@ -3112,18 +3650,19 @@ set pgp_use_gpg_agent=yes # -# 3.219. pop_oauth_refresh_command +# 3.250. pop_oauth_refresh_command # # Type: string # Default: (empty) # # The command to run to generate an OAUTH refresh token for authorizing your # connection to your POP server. This command will be run on every connection -# attempt that uses the OAUTHBEARER authentication mechanism. +# attempt that uses the OAUTHBEARER authentication mechanism. See “oauth” for +# details. # -# 3.220. pop_pass +# 3.251. pop_pass # # Type: string # Default: (empty) @@ -3137,7 +3676,7 @@ set pgp_use_gpg_agent=yes # -# 3.221. pop_reconnect +# 3.252. pop_reconnect # # Type: quadoption # Default: ask-yes @@ -3147,7 +3686,7 @@ set pgp_use_gpg_agent=yes # -# 3.222. pop_user +# 3.253. pop_user # # Type: string # Default: (empty) @@ -3158,17 +3697,18 @@ set pgp_use_gpg_agent=yes # -# 3.223. post_indent_string +# 3.254. post_indent_string # # Type: string # Default: (empty) # # Similar to the $attribution variable, Mutt will append this string after the -# inclusion of a message which is being replied to. +# inclusion of a message which is being replied to. For a full listing of defined +# printf(3)-like sequences see the section on $index_format. # -# 3.224. postpone +# 3.255. postpone # # Type: quadoption # Default: ask-yes @@ -3180,7 +3720,7 @@ set pgp_use_gpg_agent=yes # -# 3.225. postponed +# 3.256. postponed # # Type: path # Default: “~/postponed” @@ -3194,7 +3734,7 @@ set pgp_use_gpg_agent=yes set postponed="=drafts" -# 3.226. postpone_encrypt +# 3.257. postpone_encrypt # # Type: boolean # Default: no @@ -3206,7 +3746,7 @@ set postponed="=drafts" # -# 3.227. postpone_encrypt_as +# 3.258. postpone_encrypt_as # # Type: string # Default: (empty) @@ -3216,7 +3756,7 @@ set postponed="=drafts" # -# 3.228. preconnect +# 3.259. preconnect # # Type: string # Default: (empty) @@ -3235,7 +3775,7 @@ set postponed="=drafts" # -# 3.229. print +# 3.260. print # # Type: quadoption # Default: ask-no @@ -3245,7 +3785,7 @@ set postponed="=drafts" # -# 3.230. print_command +# 3.261. print_command # # Type: path # Default: “lpr” @@ -3255,30 +3795,43 @@ set postponed="=drafts" set print_command="muttprint" -# 3.231. print_decode +# 3.262. print_decode # # Type: boolean # Default: yes # -# Used in connection with the command. If this option is set, the -# message is decoded before it is passed to the external command specified by +# Used in connection with the function. If this option is set, +# the message is decoded before it is passed to the external command specified by # $print_command. If this option is unset, no processing will be applied to the # message when printing it. The latter setting may be useful if you are using # some advanced printer filter which is able to properly format e-mail messages # for printing. # +# Also see $print_decode_weed, which controls whether headers will be weeded when +# this is set. +# -# 3.232. print_split +# 3.263. print_decode_weed +# +# Type: boolean +# Default: yes +# +# For , when $print_decode is set, this further controls whether +# Mutt will weed headers. +# + + +# 3.264. print_split # # Type: boolean # Default: no # -# Used in connection with the command. If this option is set, the -# command specified by $print_command is executed once for each message which is -# to be printed. If this option is unset, the command specified by $print_command -# is executed only once, and all the messages are concatenated, with a form feed -# as the message separator. +# Used in connection with the function. If this option is set, +# the command specified by $print_command is executed once for each message which +# is to be printed. If this option is unset, the command specified by +# $print_command is executed only once, and all the messages are concatenated, +# with a form feed as the message separator. # # Those who use the enscript(1) program's mail-printing mode will most likely # want to set this option. @@ -3286,7 +3839,7 @@ set print_command="muttprint" set print_split=yes -# 3.233. prompt_after +# 3.265. prompt_after # # Type: boolean # Default: yes @@ -3297,7 +3850,7 @@ set print_split=yes # -# 3.234. query_command +# 3.266. query_command # # Type: path # Default: (empty) @@ -3312,7 +3865,7 @@ set print_split=yes set query_command="lbdbq" -# 3.235. query_format +# 3.267. query_format # # Type: string # Default: “%4c %t %-25.25a %-25.25n %?e?(%e)?” @@ -3344,7 +3897,7 @@ set query_command="lbdbq" # -# 3.236. quit +# 3.268. quit # # Type: quadoption # Default: yes @@ -3356,7 +3909,7 @@ set query_command="lbdbq" # -# 3.237. quote_regexp +# 3.269. quote_regexp # # Type: regular expression # Default: “^([ t]*[|>:}#])+” @@ -3375,7 +3928,7 @@ set query_command="lbdbq" # -# 3.238. read_inc +# 3.270. read_inc # # Type: number # Default: 10 @@ -3394,7 +3947,7 @@ set query_command="lbdbq" # -# 3.239. read_only +# 3.271. read_only # # Type: boolean # Default: no @@ -3403,7 +3956,7 @@ set query_command="lbdbq" # -# 3.240. realname +# 3.272. realname # # Type: string # Default: (empty) @@ -3416,7 +3969,7 @@ set query_command="lbdbq" # -# 3.241. recall +# 3.273. recall # # Type: quadoption # Default: ask-yes @@ -3433,7 +3986,7 @@ set query_command="lbdbq" set recall=no -# 3.242. record +# 3.274. record # # Type: path # Default: “~/sent” @@ -3444,12 +3997,15 @@ set recall=no # with your email address in it.) # # The value of $record is overridden by the $force_name and $save_name variables, -# and the “fcc-hook” command. +# and the “fcc-hook” command. Also see $copy and $write_bcc. +# +# Multiple mailboxes may be specified if $fcc_delimiter is set to a string +# delimiter. # set record="=store" -# 3.243. reflow_space_quotes +# 3.275. reflow_space_quotes # # Type: boolean # Default: yes @@ -3463,7 +4019,7 @@ set record="=store" # -# 3.244. reflow_text +# 3.276. reflow_text # # Type: boolean # Default: yes @@ -3476,7 +4032,7 @@ set record="=store" # -# 3.245. reflow_wrap +# 3.277. reflow_wrap # # Type: number # Default: 78 @@ -3492,7 +4048,7 @@ set record="=store" set reflow_wrap=-10 -# 3.246. reply_regexp +# 3.278. reply_regexp # # Type: regular expression # Default: “^(re([[0-9]+])*|aw):[ t]*” @@ -3504,7 +4060,7 @@ set reflow_wrap=-10 set reply_regexp="^((re([-[(]?[[:digit:]]+[)]]?)?|a(nt)?w(ort)?|wg|s(gkb|v)):[[:space:]]*)+" -# 3.247. reply_self +# 3.279. reply_self # # Type: boolean # Default: no @@ -3516,7 +4072,7 @@ set reply_regexp="^((re([-[(]?[[:digit:]]+[)]]?)?|a(nt)?w(ort)?|wg|s(gkb|v)):[[: # -# 3.248. reply_to +# 3.280. reply_to # # Type: quadoption # Default: ask-yes @@ -3529,7 +4085,7 @@ set reply_regexp="^((re([-[(]?[[:digit:]]+[)]]?)?|a(nt)?w(ort)?|wg|s(gkb|v)):[[: # -# 3.249. resolve +# 3.281. resolve # # Type: boolean # Default: yes @@ -3540,7 +4096,7 @@ set reply_regexp="^((re([-[(]?[[:digit:]]+[)]]?)?|a(nt)?w(ort)?|wg|s(gkb|v)):[[: # -# 3.250. resume_draft_files +# 3.282. resume_draft_files # # Type: boolean # Default: no @@ -3552,7 +4108,7 @@ set reply_regexp="^((re([-[(]?[[:digit:]]+[)]]?)?|a(nt)?w(ort)?|wg|s(gkb|v)):[[: # -# 3.251. resume_edited_draft_files +# 3.283. resume_edited_draft_files # # Type: boolean # Default: yes @@ -3569,7 +4125,7 @@ set reply_regexp="^((re([-[(]?[[:digit:]]+[)]]?)?|a(nt)?w(ort)?|wg|s(gkb|v)):[[: # -# 3.252. reverse_alias +# 3.284. reverse_alias # # Type: boolean # Default: no @@ -3590,7 +4146,7 @@ set reply_regexp="^((re([-[(]?[[:digit:]]+[)]]?)?|a(nt)?w(ort)?|wg|s(gkb|v)):[[: # -# 3.253. reverse_name +# 3.285. reverse_name # # Type: boolean # Default: no @@ -3603,24 +4159,30 @@ set reply_regexp="^((re([-[(]?[[:digit:]]+[)]]?)?|a(nt)?w(ort)?|wg|s(gkb|v)):[[: # be used doesn't match your “alternates”, the From: line will use your address # on the current machine. # -# Also see the “alternates” command. +# Also see the “alternates” command and $reverse_realname. # set reverse_name=yes -# 3.254. reverse_realname +# 3.286. reverse_realname # # Type: boolean # Default: yes # -# This variable fine-tunes the behavior of the $reverse_name feature. When it is -# set, mutt will use the address from incoming messages as-is, possibly including -# eventual real names. When it is unset, mutt will override any such real names -# with the setting of the $realname variable. +# This variable fine-tunes the behavior of the $reverse_name feature. +# +# When it is unset, Mutt will remove the real name part of a matching address. +# This allows the use of the email address without having to also use what the +# sender put in the real name field. +# +# When it is set, Mutt will use the matching address as-is. +# +# In either case, a missing real name will be filled in afterwards using the +# value of $realname. # -# 3.255. rfc2047_parameters +# 3.287. rfc2047_parameters # # Type: boolean # Default: no @@ -3644,7 +4206,7 @@ set reverse_name=yes set rfc2047_parameters=yes -# 3.256. save_address +# 3.288. save_address # # Type: boolean # Default: no @@ -3655,7 +4217,7 @@ set rfc2047_parameters=yes # -# 3.257. save_empty +# 3.289. save_empty # # Type: boolean # Default: yes @@ -3669,7 +4231,7 @@ set rfc2047_parameters=yes # -# 3.258. save_history +# 3.290. save_history # # Type: number # Default: 0 @@ -3680,7 +4242,7 @@ set rfc2047_parameters=yes set save_history=100 -# 3.259. save_name +# 3.291. save_name # # Type: boolean # Default: no @@ -3696,7 +4258,7 @@ set save_history=100 # -# 3.260. score +# 3.292. score # # Type: boolean # Default: yes @@ -3707,7 +4269,7 @@ set save_history=100 # -# 3.261. score_threshold_delete +# 3.293. score_threshold_delete # # Type: number # Default: -1 @@ -3719,7 +4281,7 @@ set save_history=100 # -# 3.262. score_threshold_flag +# 3.294. score_threshold_flag # # Type: number # Default: 9999 @@ -3729,7 +4291,7 @@ set save_history=100 # -# 3.263. score_threshold_read +# 3.295. score_threshold_read # # Type: number # Default: -1 @@ -3741,7 +4303,7 @@ set save_history=100 # -# 3.264. search_context +# 3.296. search_context # # Type: number # Default: 0 @@ -3752,7 +4314,7 @@ set save_history=100 set search_context=5 -# 3.265. send_charset +# 3.297. send_charset # # Type: string # Default: “us-ascii:iso-8859-1:utf-8” @@ -3770,7 +4332,36 @@ set search_context=5 set send_charset="utf-8" -# 3.266. sendmail +# 3.298. send_multipart_alternative +# +# Type: quadoption +# Default: no +# +# If set, Mutt will generate a multipart/alternative container and an alternative +# part using the filter script specified in $send_multipart_alternative_filter. +# See the section “MIME Multipart/Alternative” (alternative-order). +# +# Note that enabling multipart/alternative is not compatible with inline PGP +# encryption. Mutt will prompt to use PGP/MIME in that case. +# +set send_multipart_alternative=yes + + +# 3.299. send_multipart_alternative_filter +# +# Type: path +# Default: (empty) +# +# This specifies a filter script, which will convert the main (composed) message +# of the email to an alternative format. The message will be piped to the +# filter's stdin. The expected output of the filter is the generated mime type, +# e.g. text/html, followed by a blank line, and then the converted content. See +# the section “MIME Multipart/Alternative” (alternative-order). +# +set send_multipart_alternative_filter=$my_confdir/markdown2html + + +# 3.300. sendmail # # Type: path # Default: “/usr/sbin/sendmail -oem -oi” @@ -3782,10 +4373,12 @@ set send_charset="utf-8" # $use_envelope_from, $dsn_notify, or $dsn_return will be added before the # delimiter. # +# See also: $write_bcc. +# set sendmail="$my_confdir/sendmail" -# 3.267. sendmail_wait +# 3.301. sendmail_wait # # Type: number # Default: 0 @@ -3809,7 +4402,7 @@ set sendmail="$my_confdir/sendmail" # -# 3.268. shell +# 3.302. shell # # Type: path # Default: (empty) @@ -3819,7 +4412,7 @@ set sendmail="$my_confdir/sendmail" # -# 3.269. sidebar_delim_chars +# 3.303. sidebar_delim_chars # # Type: string # Default: “/.” @@ -3839,7 +4432,7 @@ set sendmail="$my_confdir/sendmail" # -# 3.270. sidebar_divider_char +# 3.304. sidebar_divider_char # # Type: string # Default: “|” @@ -3851,7 +4444,7 @@ set sendmail="$my_confdir/sendmail" set sidebar_divider_char=" " -# 3.271. sidebar_folder_indent +# 3.305. sidebar_folder_indent # # Type: boolean # Default: no @@ -3863,7 +4456,7 @@ set sidebar_divider_char=" " set sidebar_folder_indent=yes -# 3.272. sidebar_format +# 3.306. sidebar_format # # Type: string # Default: “%B%* %n” @@ -3907,7 +4500,7 @@ set sidebar_folder_indent=yes set sidebar_format="%B%?F? [%F]?%* %?N?%N/?%S" -# 3.273. sidebar_indent_string +# 3.307. sidebar_indent_string # # Type: string # Default: “ ” @@ -3920,7 +4513,7 @@ set sidebar_format="%B%?F? [%F]?%* %?N?%N/?%S" set sidebar_indent_string=" " -# 3.274. sidebar_new_mail_only +# 3.308. sidebar_new_mail_only # # Type: boolean # Default: no @@ -3932,7 +4525,7 @@ set sidebar_indent_string=" " # -# 3.275. sidebar_next_new_wrap +# 3.309. sidebar_next_new_wrap # # Type: boolean # Default: no @@ -3944,7 +4537,42 @@ set sidebar_indent_string=" " set sidebar_next_new_wrap=yes -# 3.276. sidebar_short_path +# 3.310. sidebar_relative_shortpath_indent +# +# Type: boolean +# Default: no +# +# When set, this option changes how $sidebar_short_path and +# $sidebar_folder_indent perform shortening and indentation: both will look at +# the previous sidebar entries and shorten/indent relative to the most recent +# parent. +# +# An example of this option set/unset for mailboxes listed in this order, with +# $sidebar_short_path=yes, $sidebar_folder_indent=yes, and $sidebar_indent_string +# ="→": +# +# ┌─────────┬────┬─────┐ +# │mailbox │set │unset│ +# ├─────────┼────┼─────┤ +# │=a.b │=a.b│→b │ +# ├─────────┼────┼─────┤ +# │=a.b.c.d │→c.d│→→→d │ +# ├─────────┼────┼─────┤ +# │=a.b.e │→e │→→e │ +# └─────────┴────┴─────┘ +# +# The second line illustrates most clearly. With this option set, =a.b.c.d is +# shortened relative to =a.b, becoming c.d; it is also indented one place +# relative to =a.b. With this option unset =a.b.c.d is always shortened to the +# last part of the mailbox, d and is indented three places, with respect to +# $folder (represented by '='). +# +# When set, the third line will also be indented and shortened relative to the +# first line. +# + + +# 3.311. sidebar_short_path # # Type: boolean # Default: no @@ -3970,13 +4598,13 @@ set sidebar_next_new_wrap=yes set sidebar_short_path=yes -# 3.277. sidebar_sort_method +# 3.312. sidebar_sort_method # # Type: sort order -# Default: order +# Default: unsorted # -# Specifies how to sort entries in the file browser. By default, the entries are -# sorted alphabetically. Valid values: +# Specifies how to sort mailbox entries in the sidebar. By default, the entries +# are sorted alphabetically. Valid values: # # • alpha (alphabetically) # @@ -3995,12 +4623,25 @@ set sidebar_short_path=yes # • unsorted # # You may optionally use the “reverse-” prefix to specify reverse sorting order -# (example: “set sort_browser=reverse-date”). +# (example: “set sidebar_sort_method=reverse-alpha”). # set sidebar_sort_method=path -# 3.278. sidebar_visible +# 3.313. sidebar_use_mailbox_shortcuts +# +# Type: boolean +# Default: no +# +# When set, sidebar mailboxes will be displayed with mailbox shortcut prefixes "= +# " or "~". +# +# When unset, the sidebar will trim off a matching $folder prefix but otherwise +# not use mailbox shortcuts. +# + + +# 3.314. sidebar_visible # # Type: boolean # Default: no @@ -4013,7 +4654,7 @@ set sidebar_sort_method=path set sidebar_visible=no -# 3.279. sidebar_width +# 3.315. sidebar_width # # Type: number # Default: 30 @@ -4025,7 +4666,7 @@ set sidebar_visible=no set sidebar_width=20 -# 3.280. sig_dashes +# 3.316. sig_dashes # # Type: boolean # Default: yes @@ -4040,7 +4681,7 @@ set sidebar_width=20 set sig_dashes=no -# 3.281. sig_on_top +# 3.317. sig_on_top # # Type: boolean # Default: no @@ -4052,7 +4693,7 @@ set sig_dashes=no # -# 3.282. signature +# 3.318. signature # # Type: path # Default: “~/.signature” @@ -4063,13 +4704,13 @@ set sig_dashes=no # -# 3.283. simple_search +# 3.319. simple_search # # Type: string # Default: “~f %s | ~s %s” # # Specifies how Mutt should expand a simple search into a real search pattern. A -# simple search is one that does not contain any of the “~” pattern operators. +# simple search is one that does not contain any of the “~” pattern modifiers. # See “patterns” for more information on search patterns. # # For example, if you simply type “joe” at a search or limit prompt, Mutt will @@ -4080,7 +4721,47 @@ set sig_dashes=no set simple_search="~L %s | ~s %s" -# 3.284. sleep_time +# 3.320. size_show_bytes +# +# Type: boolean +# Default: no +# +# If set, message sizes will display bytes for values less than 1 kilobyte. See +# formatstrings-size. +# + + +# 3.321. size_show_fractions +# +# Type: boolean +# Default: yes +# +# If set, message sizes will be displayed with a single decimal value for sizes +# from 0 to 10 kilobytes and 1 to 10 megabytes. See formatstrings-size. +# + + +# 3.322. size_show_mb +# +# Type: boolean +# Default: yes +# +# If set, message sizes will display megabytes for values greater than or equal +# to 1 megabyte. See formatstrings-size. +# + + +# 3.323. size_units_on_left +# +# Type: boolean +# Default: no +# +# If set, message sizes units will be displayed to the left of the number. See +# formatstrings-size. +# + + +# 3.324. sleep_time # # Type: number # Default: 1 @@ -4092,7 +4773,7 @@ set simple_search="~L %s | ~s %s" # -# 3.285. smart_wrap +# 3.325. smart_wrap # # Type: boolean # Default: yes @@ -4103,7 +4784,7 @@ set simple_search="~L %s | ~s %s" # -# 3.286. smileys +# 3.326. smileys # # Type: regular expression # Default: “(>From )|(:[-^]?[][)(><}{|/DP])” @@ -4114,7 +4795,7 @@ set simple_search="~L %s | ~s %s" # -# 3.287. smime_ask_cert_label +# 3.327. smime_ask_cert_label # # Type: boolean # Default: yes @@ -4125,7 +4806,7 @@ set simple_search="~L %s | ~s %s" # -# 3.288. smime_ca_location +# 3.328. smime_ca_location # # Type: path # Default: (empty) @@ -4135,7 +4816,7 @@ set simple_search="~L %s | ~s %s" # -# 3.289. smime_certificates +# 3.329. smime_certificates # # Type: path # Default: (empty) @@ -4150,7 +4831,7 @@ set simple_search="~L %s | ~s %s" set smime_certificates="~/.smime/certificates" -# 3.290. smime_decrypt_command +# 3.330. smime_decrypt_command # # Type: string # Default: (empty) @@ -4186,7 +4867,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.291. smime_decrypt_use_default_key +# 3.331. smime_decrypt_use_default_key # # Type: boolean # Default: yes @@ -4198,7 +4879,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.292. smime_default_key +# 3.332. smime_default_key # # Type: string # Default: (empty) @@ -4207,6 +4888,7 @@ set smime_certificates="~/.smime/certificates" # the keyid (the hash-value that OpenSSL generates) to work properly. # # It will be used for encryption (see $postpone_encrypt and $smime_self_encrypt). +# If GPGME is enabled, this is the key id displayed by gpgsm. # # It will be used for decryption unless $smime_decrypt_use_default_key is unset. # @@ -4217,7 +4899,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.293. smime_encrypt_command +# 3.333. smime_encrypt_command # # Type: string # Default: (empty) @@ -4229,7 +4911,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.294. smime_encrypt_with +# 3.334. smime_encrypt_with # # Type: string # Default: “aes256” @@ -4240,7 +4922,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.295. smime_get_cert_command +# 3.335. smime_get_cert_command # # Type: string # Default: (empty) @@ -4252,7 +4934,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.296. smime_get_cert_email_command +# 3.336. smime_get_cert_email_command # # Type: string # Default: (empty) @@ -4266,7 +4948,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.297. smime_get_signer_cert_command +# 3.337. smime_get_signer_cert_command # # Type: string # Default: (empty) @@ -4280,7 +4962,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.298. smime_import_cert_command +# 3.338. smime_import_cert_command # # Type: string # Default: (empty) @@ -4292,7 +4974,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.299. smime_is_default +# 3.339. smime_is_default # # Type: boolean # Default: no @@ -4305,7 +4987,7 @@ set smime_certificates="~/.smime/certificates" # -# 3.300. smime_keys +# 3.340. smime_keys # # Type: path # Default: (empty) @@ -4320,7 +5002,7 @@ set smime_certificates="~/.smime/certificates" set smime_keys="~/.smime/keys" -# 3.301. smime_pk7out_command +# 3.341. smime_pk7out_command # # Type: string # Default: (empty) @@ -4333,7 +5015,7 @@ set smime_keys="~/.smime/keys" # -# 3.302. smime_self_encrypt +# 3.342. smime_self_encrypt # # Type: boolean # Default: yes @@ -4343,7 +5025,7 @@ set smime_keys="~/.smime/keys" # -# 3.303. smime_sign_as +# 3.343. smime_sign_as # # Type: string # Default: (empty) @@ -4354,7 +5036,7 @@ set smime_keys="~/.smime/keys" # -# 3.304. smime_sign_command +# 3.344. smime_sign_command # # Type: string # Default: (empty) @@ -4368,7 +5050,7 @@ set smime_keys="~/.smime/keys" # -# 3.305. smime_sign_digest_alg +# 3.345. smime_sign_digest_alg # # Type: string # Default: “sha256” @@ -4379,7 +5061,7 @@ set smime_keys="~/.smime/keys" # -# 3.306. smime_sign_opaque_command +# 3.346. smime_sign_opaque_command # # Type: string # Default: (empty) @@ -4393,9 +5075,9 @@ set smime_keys="~/.smime/keys" # -# 3.307. smime_timeout +# 3.347. smime_timeout # -# Type: number +# Type: number (long) # Default: 300 # # The number of seconds after which a cached passphrase will expire if not used. @@ -4403,7 +5085,7 @@ set smime_keys="~/.smime/keys" # -# 3.308. smime_verify_command +# 3.348. smime_verify_command # # Type: string # Default: (empty) @@ -4415,7 +5097,7 @@ set smime_keys="~/.smime/keys" # -# 3.309. smime_verify_opaque_command +# 3.349. smime_verify_opaque_command # # Type: string # Default: (empty) @@ -4428,7 +5110,7 @@ set smime_keys="~/.smime/keys" # -# 3.310. smtp_authenticators +# 3.350. smtp_authenticators # # Type: string # Default: (empty) @@ -4445,18 +5127,19 @@ set smime_keys="~/.smime/keys" # -# 3.311. smtp_oauth_refresh_command +# 3.351. smtp_oauth_refresh_command # # Type: string # Default: (empty) # # The command to run to generate an OAUTH refresh token for authorizing your # connection to your SMTP server. This command will be run on every connection -# attempt that uses the OAUTHBEARER authentication mechanism. +# attempt that uses the OAUTHBEARER authentication mechanism. See “oauth” for +# details. # -# 3.312. smtp_pass +# 3.352. smtp_pass # # Type: string # Default: (empty) @@ -4471,7 +5154,7 @@ set smime_keys="~/.smime/keys" # -# 3.313. smtp_url +# 3.353. smtp_url # # Type: string # Default: (empty) @@ -4484,9 +5167,11 @@ set smime_keys="~/.smime/keys" # where “[...]” denotes an optional part. Setting this variable overrides the # value of the $sendmail variable. # +# Also see $write_bcc. +# -# 3.314. sort +# 3.354. sort # # Type: sort order # Default: date @@ -4519,7 +5204,7 @@ set smime_keys="~/.smime/keys" set sort=threads -# 3.315. sort_alias +# 3.355. sort_alias # # Type: sort order # Default: alias @@ -4535,11 +5220,14 @@ set sort=threads # -# 3.316. sort_aux +# 3.356. sort_aux # # Type: sort order # Default: date # +# This provides a secondary sort for messages in the “index” menu, used when the +# $sort value is equal for two messages. +# # When sorting by threads, this variable controls how threads are sorted in # relation to other threads, and how the branches of the thread trees are sorted. # This can be set to any value that $sort can, except “threads” (in that case, @@ -4553,13 +5241,14 @@ set sort=threads # would mean that if a new message is received in a thread, that thread becomes # the last one displayed (or the first, if you have “set sort=reverse-threads”.) # -# Note: For reversed $sort order $sort_aux is reversed again (which is not the -# right thing to do, but kept to not break any existing configuration setting). +# Note: For reversed-threads $sort order, $sort_aux is reversed again (which is +# not the right thing to do, but kept to not break any existing configuration +# setting). # set sort_aux=last-date-received -# 3.317. sort_browser +# 3.357. sort_browser # # Type: sort order # Default: alpha @@ -4584,7 +5273,33 @@ set sort_aux=last-date-received # -# 3.318. sort_re +# 3.358. sort_browser_mailboxes +# +# Type: sort order +# Default: unsorted +# +# Specifies how to sort entries in the mailbox browser. By default, the entries +# are unsorted, displayed in the same order as listed in the “mailboxes” command. +# Valid values: +# +# • alpha (alphabetically) +# +# • count +# +# • date +# +# • size +# +# • unread +# +# • unsorted +# +# You may optionally use the “reverse-” prefix to specify reverse sorting order +# (example: “set sort_browser_mailboxes=reverse-alpha”). +# + + +# 3.359. sort_re # # Type: boolean # Default: yes @@ -4599,7 +5314,7 @@ set sort_aux=last-date-received # -# 3.319. spam_separator +# 3.360. spam_separator # # Type: string # Default: “,” @@ -4611,7 +5326,7 @@ set sort_aux=last-date-received # -# 3.320. spoolfile +# 3.361. spoolfile # # Type: path # Default: (empty) @@ -4624,7 +5339,7 @@ set sort_aux=last-date-received set spoolfile="=inbox" -# 3.321. ssl_ca_certificates_file +# 3.362. ssl_ca_certificates_file # # Type: path # Default: (empty) @@ -4640,7 +5355,7 @@ set spoolfile="=inbox" set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" -# 3.322. ssl_client_cert +# 3.363. ssl_client_cert # # Type: path # Default: (empty) @@ -4649,10 +5364,10 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.323. ssl_force_tls +# 3.364. ssl_force_tls # # Type: boolean -# Default: no +# Default: yes # # If this variable is set, Mutt will require that all connections to remote # servers be encrypted. Furthermore it will attempt to negotiate TLS even if the @@ -4661,7 +5376,7 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.324. ssl_min_dh_prime_bits +# 3.365. ssl_min_dh_prime_bits # # Type: number # Default: 0 @@ -4672,7 +5387,7 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.325. ssl_starttls +# 3.366. ssl_starttls # # Type: quadoption # Default: yes @@ -4681,61 +5396,75 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # the capability. When unset, mutt will not attempt to use STARTTLS regardless of # the server's capabilities. # +# Note that STARTTLS is subject to many kinds of attacks, including the ability +# of a machine-in-the-middle to suppress the advertising of support. Setting +# $ssl_force_tls is recommended if you rely on STARTTLS. +# -# 3.326. ssl_use_sslv2 +# 3.367. ssl_use_sslv2 # # Type: boolean # Default: no # -# This variable specifies whether to attempt to use SSLv2 in the SSL -# authentication process. Note that SSLv2 and SSLv3 are now considered -# fundamentally insecure and are no longer recommended. (OpenSSL only) +# If set , Mutt will use SSLv2 when communicating with servers that request it. +# N.B. As of 2011, SSLv2 is considered insecure, and using is inadvisable. See +# https://tools.ietf.org/html/rfc6176 . (OpenSSL only) # -# 3.327. ssl_use_sslv3 +# 3.368. ssl_use_sslv3 # # Type: boolean # Default: no # -# This variable specifies whether to attempt to use SSLv3 in the SSL -# authentication process. Note that SSLv2 and SSLv3 are now considered -# fundamentally insecure and are no longer recommended. +# If set , Mutt will use SSLv3 when communicating with servers that request it. +# N.B. As of 2015, SSLv3 is considered insecure, and using it is inadvisable. See +# https://tools.ietf.org/html/rfc7525 . # -# 3.328. ssl_use_tlsv1 +# 3.369. ssl_use_tlsv1 # # Type: boolean -# Default: yes +# Default: no +# +# If set , Mutt will use TLSv1.0 when communicating with servers that request it. +# N.B. As of 2015, TLSv1.0 is considered insecure, and using it is inadvisable. +# See https://tools.ietf.org/html/rfc7525 . +# + + +# 3.370. ssl_use_tlsv1_1 +# +# Type: boolean +# Default: no # -# This variable specifies whether to attempt to use TLSv1.0 in the SSL -# authentication process. +# If set , Mutt will use TLSv1.1 when communicating with servers that request it. +# N.B. As of 2015, TLSv1.1 is considered insecure, and using it is inadvisable. +# See https://tools.ietf.org/html/rfc7525 . # -# 3.329. ssl_use_tlsv1_1 +# 3.371. ssl_use_tlsv1_2 # # Type: boolean # Default: yes # -# This variable specifies whether to attempt to use TLSv1.1 in the SSL -# authentication process. +# If set , Mutt will use TLSv1.2 when communicating with servers that request it. # -# 3.330. ssl_use_tlsv1_2 +# 3.372. ssl_use_tlsv1_3 # # Type: boolean # Default: yes # -# This variable specifies whether to attempt to use TLSv1.2 in the SSL -# authentication process. +# If set , Mutt will use TLSv1.3 when communicating with servers that request it. # -# 3.331. ssl_usesystemcerts +# 3.373. ssl_usesystemcerts # # Type: boolean # Default: yes @@ -4746,7 +5475,7 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.332. ssl_verify_dates +# 3.374. ssl_verify_dates # # Type: boolean # Default: yes @@ -4757,7 +5486,7 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.333. ssl_verify_host +# 3.375. ssl_verify_host # # Type: boolean # Default: yes @@ -4768,7 +5497,19 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.334. ssl_verify_partial_chains +# 3.376. ssl_verify_host_override +# +# Type: string +# Default: (empty) +# +# Defines an alternate host name to verify the server certificate against. This +# should not be set unless you are sure what you are doing, but it might be +# useful for connection to a .onion host without a properly configured host name +# in the certificate. See $ssl_verify_host. +# + + +# 3.377. ssl_verify_partial_chains # # Type: boolean # Default: no @@ -4785,12 +5526,12 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.335. ssl_ciphers +# 3.378. ssl_ciphers # # Type: string # Default: (empty) # -# Contains a colon-seperated list of ciphers to use when using SSL. For OpenSSL, +# Contains a colon-separated list of ciphers to use when using SSL. For OpenSSL, # see ciphers(1) for the syntax of the string. # # For GnuTLS, this option will be used in place of "NORMAL" at the start of the @@ -4799,7 +5540,7 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.336. status_chars +# 3.379. status_chars # # Type: string # Default: “-*%A” @@ -4816,11 +5557,12 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # -# 3.337. status_format +# 3.380. status_format # -# Type: string +# Type: string (localized) # Default: “-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? -# Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---” +# Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?B? Back:%B?%?l? %l?]---(%s/%S) +# -%>-(%P)---” # # Controls the format of the status line displayed in the “index” menu. This # string is similar to $index_format, but has its own set of printf(3)-like @@ -4829,6 +5571,8 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # ┌───┬─────────────────────────────────────────────────────────────────────────┐ # │%b │number of mailboxes with new mail * │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ +# │%B │number of backgrounded editing sessions * │ +# ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%d │number of deleted messages * │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%f │the full pathname of the current mailbox │ @@ -4837,10 +5581,10 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" # ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%h │local hostname │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ -# │%l │size (in bytes) of the current mailbox * │ +# │%l │size (in bytes) of the current mailbox (see formatstrings-size) * │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%L │size (in bytes) of the messages shown (i.e., which match the current │ -# │ │limit) * │ +# │ │limit) (see formatstrings-size) * │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ # │%m │the number of messages in the mailbox * │ # ├───┼─────────────────────────────────────────────────────────────────────────┤ @@ -4918,7 +5662,7 @@ set ssl_ca_certificates_file="/etc/ssl/certs/ca-certificates.crt" set status_format=" %r %f [m:%?M?%M/?%m%?n? n:%n?%?o? o:%o?%?d? d:%d?%?F? f:%F?%?t? t:%t?%?p? p:%p?%?b? i:%b?%?l? %l?] %?V?%V ?(%s/%S) %> (%P) " -# 3.338. status_on_top +# 3.381. status_on_top # # Type: boolean # Default: no @@ -4929,7 +5673,7 @@ set status_format=" %r %f [m:%?M?%M/?%m%?n? n:%n?%?o? o:%o?%?d? d:%d?%?F? f:%F?% # -# 3.339. strict_threads +# 3.382. strict_threads # # Type: boolean # Default: no @@ -4944,7 +5688,7 @@ set status_format=" %r %f [m:%?M?%M/?%m%?n? n:%n?%?o? o:%o?%?d? d:%d?%?F? f:%F?% set strict_threads=yes -# 3.340. suspend +# 3.383. suspend # # Type: boolean # Default: yes @@ -4955,7 +5699,7 @@ set strict_threads=yes # -# 3.341. text_flowed +# 3.384. text_flowed # # Type: boolean # Default: no @@ -4965,18 +5709,22 @@ set strict_threads=yes # software, and generally just looks like ordinary text. To actually make use of # this format's features, you'll need support in your editor. # +# The option only controls newly composed messages. Postponed messages, resent +# messages, and draft messages (via -H on the command line) will use the +# content-type of the source message. +# # Note that $indent_string is ignored when this option is set. # set text_flowed=yes -# 3.342. thorough_search +# 3.385. thorough_search # # Type: boolean # Default: yes # -# Affects the ~b and ~h search operations described in section “patterns”. If set -# , the headers and body/attachments of messages to be searched are decoded +# Affects the ~b, ~B, and ~h search operations described in section “patterns”. +# If set, the headers and body/attachments of messages to be searched are decoded # before searching. If unset, messages are searched as they appear in the folder. # # Users searching attachments or for non-ASCII characters should set this value @@ -4988,7 +5736,7 @@ set text_flowed=yes set thorough_search=yes -# 3.343. thread_received +# 3.386. thread_received # # Type: boolean # Default: no @@ -4999,7 +5747,7 @@ set thorough_search=yes set thread_received=yes -# 3.344. tilde +# 3.387. tilde # # Type: boolean # Default: no @@ -5010,7 +5758,7 @@ set thread_received=yes set tilde=yes -# 3.345. time_inc +# 3.388. time_inc # # Type: number # Default: 0 @@ -5025,7 +5773,7 @@ set tilde=yes set time_inc=250 -# 3.346. timeout +# 3.389. timeout # # Type: number # Default: 600 @@ -5042,19 +5790,19 @@ set time_inc=250 # -# 3.347. tmpdir +# 3.390. tmpdir # # Type: path # Default: (empty) # # This variable allows you to specify where Mutt will place its temporary files # needed for displaying and composing messages. If this variable is not set, the -# environment variable $TMPDIR is used. If $TMPDIR is not set then “/tmp” is +# environment variable $TMPDIR is used. If $TMPDIR is not set then “/var/tmp” is # used. # -# 3.348. to_chars +# 3.391. to_chars # # Type: string # Default: “ +TCFL” @@ -5071,7 +5819,7 @@ set time_inc=250 # -# 3.349. trash +# 3.392. trash # # Type: path # Default: (empty) @@ -5084,9 +5832,9 @@ set time_inc=250 # -# 3.350. ts_icon_format +# 3.393. ts_icon_format # -# Type: string +# Type: string (localized) # Default: “M%?n?AIL&ail?” # # Controls the format of the icon title, as long as “$ts_enabled” is set. This @@ -5094,7 +5842,7 @@ set time_inc=250 # -# 3.351. ts_enabled +# 3.394. ts_enabled # # Type: boolean # Default: no @@ -5105,9 +5853,9 @@ set time_inc=250 set ts_enabled=yes -# 3.352. ts_status_format +# 3.395. ts_status_format # -# Type: string +# Type: string (localized) # Default: “Mutt with %?m?%m messages&no messages?%?n? [%n NEW]?” # # Controls the format of the terminal status line (or window title), provided @@ -5117,7 +5865,7 @@ set ts_enabled=yes set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?" -# 3.353. tunnel +# 3.396. tunnel # # Type: string # Default: (empty) @@ -5137,7 +5885,24 @@ set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?" # -# 3.354. uncollapse_jump +# 3.397. tunnel_is_secure +# +# Type: boolean +# Default: yes +# +# When set, Mutt will assume the $tunnel connection does not need STARTTLS to be +# enabled. It will also allow IMAP PREAUTH server responses inside a tunnel to +# proceed. This is appropriate if $tunnel uses ssh or directly invokes the server +# locally. +# +# When unset, Mutt will negotiate STARTTLS according to the ssl_starttls and +# ssl_force_tls variables. If ssl_force_tls is set, Mutt will abort connecting if +# an IMAP server responds with PREAUTH. This setting is appropriate if $tunnel +# does not provide security and could be tampered with by attackers. +# + + +# 3.398. uncollapse_jump # # Type: boolean # Default: no @@ -5147,7 +5912,7 @@ set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?" # -# 3.355. uncollapse_new +# 3.399. uncollapse_new # # Type: boolean # Default: yes @@ -5158,7 +5923,7 @@ set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?" # -# 3.356. use_8bitmime +# 3.400. use_8bitmime # # Type: boolean # Default: no @@ -5172,7 +5937,7 @@ set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?" # -# 3.357. use_domain +# 3.401. use_domain # # Type: boolean # Default: yes @@ -5182,7 +5947,7 @@ set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?" # -# 3.358. use_envelope_from +# 3.402. use_envelope_from # # Type: boolean # Default: no @@ -5199,7 +5964,7 @@ set ts_status_format="[`tty|sed -re 's,.+pts/,,'`]mutt@%h%r %f%?V?[%V]&?" set use_envelope_from=yes -# 3.359. use_from +# 3.403. use_from # # Type: boolean # Default: yes @@ -5210,7 +5975,7 @@ set use_envelope_from=yes # -# 3.360. use_ipv6 +# 3.404. use_ipv6 # # Type: boolean # Default: yes @@ -5221,17 +5986,17 @@ set use_envelope_from=yes # -# 3.361. user_agent +# 3.405. user_agent # # Type: boolean -# Default: yes +# Default: no # # When set, mutt will add a “User-Agent:” header to outgoing messages, indicating # which version of mutt was used for composing them. # -# 3.362. visual +# 3.406. visual # # Type: path # Default: (empty) @@ -5241,7 +6006,7 @@ set use_envelope_from=yes # -# 3.363. wait_key +# 3.407. wait_key # # Type: boolean # Default: yes @@ -5260,17 +6025,19 @@ set use_envelope_from=yes set wait_key=no -# 3.364. weed +# 3.408. weed # # Type: boolean # Default: yes # -# When set, mutt will weed headers when displaying, forwarding, printing, or -# replying to messages. +# When set, mutt will weed headers when displaying, forwarding, or replying to +# messages. +# +# Also see $copy_decode_weed, $pipe_decode_weed, $print_decode_weed. # -# 3.365. wrap +# 3.409. wrap # # Type: number # Default: 0 @@ -5285,7 +6052,7 @@ set wait_key=no set wrap=$reflow_wrap -# 3.366. wrap_headers +# 3.410. wrap_headers # # Type: number # Default: 78 @@ -5299,7 +6066,7 @@ set wrap=$reflow_wrap # -# 3.367. wrap_search +# 3.411. wrap_search # # Type: boolean # Default: yes @@ -5311,7 +6078,7 @@ set wrap=$reflow_wrap # -# 3.368. wrapmargin +# 3.412. wrapmargin # # Type: number # Default: 0 @@ -5320,19 +6087,28 @@ set wrap=$reflow_wrap # -# 3.369. write_bcc +# 3.413. write_bcc # # Type: boolean -# Default: yes +# Default: no # # Controls whether mutt writes out the “Bcc:” header when preparing messages to -# be sent. Exim users may wish to unset this. If mutt is set to deliver directly -# via SMTP (see $smtp_url), this option does nothing: mutt will never write out -# the “Bcc:” header in this case. +# be sent. Some MTAs, such as Exim and Courier, do not strip the “Bcc:” header; +# so it is advisable to leave this unset unless you have a particular need for +# the header to be in the sent message. +# +# If mutt is set to deliver directly via SMTP (see $smtp_url), this option does +# nothing: mutt will never write out the “Bcc:” header in this case. +# +# Note this option only affects the sending of messages. Fcc'ed copies of a +# message will always contain the “Bcc:” header if one exists. +# +# On Debian systems, exim4 and postfix strip BCC headers by default. The above +# warning applies to exim3 users, see /etc/Muttrc. # -# 3.370. write_inc +# 3.414. write_inc # # Type: number # Default: 10