X-Git-Url: https://git.llucax.com/software/mutt-debian.git/blobdiff_plain/19304f7c526fbe36ba0db2fb80bcaf3bd974d81d..bc03f37c91e5464c1632fb37ab3c98edaac11d91:/doc/Muttrc?ds=inline diff --git a/doc/Muttrc b/doc/Muttrc index d5606a8..40ac02c 100644 --- a/doc/Muttrc +++ b/doc/Muttrc @@ -268,7 +268,10 @@ attachments -I message/external-body # # # This variable is a colon-separated list of character encoding -# schemes for text file attachments. +# schemes for text file attachments. Mutt uses this setting to guess +# which encoding files being attached are encoded in to convert them to +# a proper character set given in $send_charset. +# # If unset, the value of $charset will be used instead. # For example, the following configuration would work for Japanese # text handling: @@ -349,6 +352,19 @@ attachments -I message/external-body # the section on $index_format. # # +# set auto_tag=no +# +# Name: auto_tag +# Type: boolean +# Default: no +# +# +# When set, functions in the index menu which affect a message +# will be applied to all tagged messages (if there are any). When +# unset, you must first use the function (bound to ``;'' +# by default) to make the next function apply to all tagged messages. +# +# # set autoedit=no # # Name: autoedit @@ -362,20 +378,11 @@ attachments -I message/external-body # message. The send-menu may still be accessed once you have finished # editing the body of your message. # -# Also see $fast_reply. -# +# Note: when this option is set, you cannot use send-hooks that depend +# on the recipients when composing a new (non-reply) message, as the initial +# list of recipients is empty. # -# set auto_tag=no -# -# Name: auto_tag -# Type: boolean -# Default: no -# -# -# When set, functions in the index menu which affect a message -# will be applied to all tagged messages (if there are any). When -# unset, you must first use the function (bound to ``;'' -# by default) to make the next function apply to all tagged messages. +# Also see $fast_reply. # # # set beep=yes @@ -438,24 +445,25 @@ attachments -I message/external-body # visual terminals don't permit making the cursor invisible. # # -# set check_mbox_size=no +# set certificate_file="~/.mutt_certificates" # -# Name: check_mbox_size -# Type: boolean -# Default: no +# Name: certificate_file +# Type: path +# Default: "~/.mutt_certificates" # # -# When this variable is set, mutt will use file size attribute instead of -# access time when checking for new mail in mbox and mmdf folders. +# This variable specifies the file where the certificates you trust +# are saved. When an unknown certificate is encountered, you are asked +# if you accept it or not. If you accept it, the certificate can also +# be saved in this file and further connections are automatically +# accepted. # -# This variable is unset by default and should only be enabled when -# new mail detection for these folder types is unreliable or doesn't work. +# You can also manually add CA certificates in this file. Any server +# certificate that is signed with one of these CA certificates is +# also automatically accepted. # -# Note that enabling this variable should happen before any ``mailboxes'' -# directives occur in configuration files regarding mbox or mmdf folders -# because mutt needs to determine the initial new mail status of such a -# mailbox by performing a fast mailbox scan when it is defined. -# Afterwards the new mail status is tracked by file size changes. +# Example: +# set certificate_file=~/.mutt/certificates # # # set charset="" @@ -475,6 +483,26 @@ attachments -I message/external-body # character set used correctly. # # +# set check_mbox_size=no +# +# Name: check_mbox_size +# Type: boolean +# Default: no +# +# +# When this variable is set, mutt will use file size attribute instead of +# access time when checking for new mail in mbox and mmdf folders. +# +# This variable is unset by default and should only be enabled when +# new mail detection for these folder types is unreliable or doesn't work. +# +# Note that enabling this variable should happen before any ``mailboxes'' +# directives occur in configuration files regarding mbox or mmdf folders +# because mutt needs to determine the initial new mail status of such a +# mailbox by performing a fast mailbox scan when it is defined. +# Afterwards the new mail status is tracked by file size changes. +# +# # set check_new=yes # # Name: check_new @@ -504,17 +532,6 @@ attachments -I message/external-body # unread messages. # # -# set uncollapse_jump=no -# -# Name: uncollapse_jump -# Type: boolean -# Default: no -# -# -# When set, Mutt will jump to the next unread message, if any, -# when the current thread is uncollapsed. -# -# # set compose_format="-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-" # # Name: compose_format @@ -610,30 +627,21 @@ attachments -I message/external-body # $save_name, $force_name and ``fcc-hook''. # # -# set crypt_use_gpgme=no -# -# Name: crypt_use_gpgme -# Type: boolean -# Default: no -# -# -# This variable controls the use of the GPGME-enabled crypto backends. -# If it is set and Mutt was built with gpgme support, the gpgme code for -# S/MIME and PGP will be used instead of the classic code. Note that -# you need to set this option in .muttrc; it won't have any effect when -# used interactively. -# -# -# set crypt_use_pka=no +# set crypt_autoencrypt=no # -# Name: crypt_use_pka +# Name: crypt_autoencrypt # Type: boolean # Default: no # # -# Controls whether mutt uses PKA -# (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature -# verification (only supported by the GPGME backend). +# Setting this variable will cause Mutt to always attempt to PGP +# encrypt outgoing messages. This is probably only useful in +# connection to the ``send-hook'' command. It can be overridden +# by use of the pgp menu, when encryption is not required or +# signing is requested as well. If $smime_is_default is set, +# then OpenSSL is used instead to create S/MIME messages and +# settings can be overridden by use of the smime menu instead. +# (Crypto only) # # # set crypt_autopgp=yes @@ -649,6 +657,22 @@ attachments -I message/external-body # $crypt_autosign, $crypt_replysign and $smime_is_default. # # +# set crypt_autosign=no +# +# Name: crypt_autosign +# Type: boolean +# Default: no +# +# +# Setting this variable will cause Mutt to always attempt to +# cryptographically sign outgoing messages. This can be overridden +# by use of the pgp menu, when signing is not required or +# encryption is requested as well. If $smime_is_default is set, +# then OpenSSL is used instead to create S/MIME messages and settings can +# be overridden by use of the smime menu instead of the pgp menu. +# (Crypto only) +# +# # set crypt_autosmime=yes # # Name: crypt_autosmime @@ -662,6 +686,102 @@ attachments -I message/external-body # $crypt_autosign, $crypt_replysign and $smime_is_default. # # +# set crypt_replyencrypt=yes +# +# Name: crypt_replyencrypt +# Type: boolean +# Default: yes +# +# +# If set, automatically PGP or OpenSSL encrypt replies to messages which are +# encrypted. +# (Crypto only) +# +# +# set crypt_replysign=no +# +# Name: crypt_replysign +# Type: boolean +# Default: no +# +# +# If set, automatically PGP or OpenSSL sign replies to messages which are +# signed. +# +# Note: this does not work on messages that are encrypted +# and signed! +# (Crypto only) +# +# +# set crypt_replysignencrypted=no +# +# Name: crypt_replysignencrypted +# Type: boolean +# Default: no +# +# +# If set, automatically PGP or OpenSSL sign replies to messages +# which are encrypted. This makes sense in combination with +# $crypt_replyencrypt, because it allows you to sign all +# messages which are automatically encrypted. This works around +# the problem noted in $crypt_replysign, that mutt is not able +# to find out whether an encrypted message is also signed. +# (Crypto only) +# +# +# set crypt_timestamp=yes +# +# Name: crypt_timestamp +# Type: boolean +# Default: yes +# +# +# If set, mutt will include a time stamp in the lines surrounding +# PGP or S/MIME output, so spoofing such lines is more difficult. +# If you are using colors to mark these lines, and rely on these, +# you may unset this setting. +# (Crypto only) +# +# +# set crypt_use_gpgme=no +# +# Name: crypt_use_gpgme +# Type: boolean +# Default: no +# +# +# This variable controls the use of the GPGME-enabled crypto backends. +# If it is set and Mutt was built with gpgme support, the gpgme code for +# S/MIME and PGP will be used instead of the classic code. Note that +# you need to set this option in .muttrc; it won't have any effect when +# used interactively. +# +# +# set crypt_use_pka=no +# +# Name: crypt_use_pka +# Type: boolean +# Default: no +# +# +# Controls whether mutt uses PKA +# (see http://www.g10code.de/docs/pka-intro.de.pdf) during signature +# verification (only supported by the GPGME backend). +# +# +# set crypt_verify_sig=yes +# +# Name: crypt_verify_sig +# Type: quadoption +# Default: yes +# +# +# If ``yes'', always attempt to verify PGP or S/MIME signatures. +# If ``ask-*'', ask whether or not to verify the signature. +# If \Fi``no'', never attempt to verify cryptographic signatures. +# (Crypto only) +# +# # set date_format="!%a, %b %d, %Y at %I:%M:%S%p %Z" # # Name: date_format @@ -859,6 +979,17 @@ attachments -I message/external-body # misinterpreting the line as a mbox message separator). # # +# set entropy_file="" +# +# Name: entropy_file +# Type: path +# Default: "" +# +# +# The file which includes random data that is used to initialize SSL +# library functions. +# +# # set envelope_from_address="" # # Name: envelope_from_address @@ -898,7 +1029,7 @@ attachments -I message/external-body # set fcc_attach=yes # # Name: fcc_attach -# Type: boolean +# Type: quadoption # Default: yes # # @@ -946,7 +1077,9 @@ attachments -I message/external-body # its own set of printf(3)-like sequences: # %C current file number # %d date/time folder was last modified -# %f filename +# %f filename (``/'' is appended to directory names, +# ``@'' to symbolic links and ``*'' to executable +# files) # %F file permissions # %g group name (or numeric gid, if missing) # %l number of hard links @@ -1015,6 +1148,20 @@ attachments -I message/external-body # otherwise $mime_forward_decode is used instead. # # +# set forward_decrypt=yes +# +# Name: forward_decrypt +# Type: boolean +# 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) +# +# # set forward_edit=yes # # Name: forward_edit @@ -1077,7 +1224,7 @@ attachments -I message/external-body # If the GECOS field contains a string like ``lastname, firstname'' then you # should set it to ``.*''. # -# This can be useful if you see the following behavior: you address a e-mail +# This can be useful if you see the following behavior: you address an e-mail # to user ID ``stevef'' whose full name is ``Steve Franklin''. If mutt expands # ``stevef'' to ``"Franklin" stevef@foo.bar'' then you should set the $gecos_mask to # a regular expression that will match the whole name so mutt will expand @@ -1109,7 +1256,52 @@ attachments -I message/external-body # The $weed setting applies. # # -# set help=yes +# set header_cache="" +# +# Name: header_cache +# Type: path +# Default: "" +# +# +# This variable points to the header cache database. +# If pointing to a directory Mutt will contain a header cache +# database file per folder, if pointing to a file that file will +# be a single global header cache. By default it is unset so no header +# caching will be used. +# +# Header caching can greatly improve speed when opening POP, IMAP +# MH or Maildir folders, see ``caching'' for details. +# +# +# set header_cache_compress=yes +# +# Name: header_cache_compress +# Type: boolean +# Default: yes +# +# +# When mutt is compiled with qdbm or tokyocabinet as header cache backend, +# this option determines whether the database will be compressed. +# Compression results in database files roughly being one fifth +# of the usual diskspace, but the uncompression can result in a +# slower opening of cached folder(s) which in general is still +# much faster than opening non header cached folders. +# +# +# set header_cache_pagesize="16384" +# +# Name: header_cache_pagesize +# Type: string +# 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 waste space, memory, or CPU time. The default should be more +# or less optimal for most use cases. +# +# +# set help=yes # # Name: help # Type: boolean @@ -1219,6 +1411,22 @@ attachments -I message/external-body # The file in which Mutt will save its history. # # +# set honor_disposition=no +# +# Name: honor_disposition +# Type: boolean +# Default: no +# +# +# When set, Mutt will not display attachments with a +# disposition of ``attachment'' inline even if it could +# render the part to plain text. These MIME parts can only +# be viewed from the attachment menu. +# +# If unset, Mutt will render all MIME parts it can +# properly transform to plain text. +# +# # set honor_followup_to=yes # # Name: honor_followup_to @@ -1412,7 +1620,7 @@ attachments -I message/external-body # # # Specifies the password for your IMAP account. If unset, Mutt will -# prompt you for your password when you invoke the function +# prompt you for your password when you invoke the function # or try to open an IMAP folder. # # Warning: you should only use this option when you are on a @@ -1537,13 +1745,12 @@ attachments -I message/external-body # message to which you are replying. You are strongly encouraged not to # change this value, as it tends to agitate the more fanatical netizens. # +# The value of this option is ignored if $text_flowed is set, too because +# the quoting mechanism is strictly defined for format=flowed. +# # This option is a format string, please see the description of # $index_format for supported printf(3)-style sequences. # -# Because for format=lowed style messages the quoting mechanism -# is strictly defined, this setting is ignored if $text_flowed is -# set. -# # # set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s" # @@ -1698,23 +1905,6 @@ attachments -I message/external-body # DOING! # # -# set header_cache="" -# -# Name: header_cache -# Type: path -# Default: "" -# -# -# This variable points to the header cache database. -# If pointing to a directory Mutt will contain a header cache -# database file per folder, if pointing to a file that file will -# be a single global header cache. By default it is unset so no header -# caching will be used. -# -# Header caching can greatly improve speed when opening POP, IMAP -# MH or Maildir folders, see ``caching'' for details. -# -# # set maildir_header_cache_verify=yes # # Name: maildir_header_cache_verify @@ -1728,34 +1918,6 @@ attachments -I message/external-body # folders). # # -# set header_cache_pagesize="16384" -# -# Name: header_cache_pagesize -# Type: string -# 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 waste space, memory, or CPU time. The default should be more -# or less optimal for most use cases. -# -# -# set header_cache_compress=yes -# -# Name: header_cache_compress -# Type: boolean -# Default: yes -# -# -# When mutt is compiled with qdbm or tokyocabinet as header cache backend, -# this option determines whether the database will be compressed. -# Compression results in database files roughly being one fifth -# of the usual diskspace, but the uncompression can result in a -# slower opening of cached folder(s) which in general is still -# much faster than opening non header cached folders. -# -# # set maildir_trash=no # # Name: maildir_trash @@ -1829,18 +1991,8 @@ attachments -I message/external-body # # # The default mailbox type used when creating new folders. May be any of -# ``mbox'', ``MMDF'', ``MH'' and ``Maildir''. -# -# -# set metoo=no -# -# Name: metoo -# Type: boolean -# Default: no -# -# -# If unset, Mutt will remove your address (see the ``alternates'' -# command) from the list of recipients when replying to a message. +# ``mbox'', ``MMDF'', ``MH'' and ``Maildir''. This is overriden by the +# -m command-line option. # # # set menu_context=0 @@ -1879,6 +2031,49 @@ attachments -I message/external-body # (useful for slow links to avoid many redraws). # # +# set message_cache_clean=no +# +# Name: message_cache_clean +# Type: boolean +# Default: no +# +# +# If set, mutt will clean out obsolete entries from the message cache when +# the mailbox is synchronized. You probably only want to set it +# every once in a while, since it can be a little slow +# (especially for large folders). +# +# +# set message_cachedir="" +# +# Name: message_cachedir +# Type: path +# Default: "" +# +# +# Set this to a directory and mutt will cache copies of messages from +# your IMAP and POP servers here. You are free to remove entries at any +# time. +# +# When setting this variable to a directory, mutt needs to fetch every +# remote message only once and can perform regular expression searches +# as fast as for local folders. +# +# Also see the $message_cache_clean variable. +# +# +# set message_format="%s" +# +# Name: message_format +# Type: string +# Default: "%s" +# +# +# This is the string displayed in the ``attachment'' menu for +# attachments of type message/rfc822. For a full listing of defined +# printf(3)-like sequences see the section on $index_format. +# +# # set meta_key=no # # Name: meta_key @@ -1895,6 +2090,17 @@ attachments -I message/external-body # ``x''. # # +# set metoo=no +# +# Name: metoo +# Type: boolean +# Default: no +# +# +# If unset, Mutt will remove your address (see the ``alternates'' +# command) from the list of recipients when replying to a message. +# +# # set mh_purge=no # # Name: mh_purge @@ -2023,49 +2229,6 @@ attachments -I message/external-body # a ``mbox-hook'' command. # # -# set message_cachedir="" -# -# Name: message_cachedir -# Type: path -# Default: "" -# -# -# Set this to a directory and mutt will cache copies of messages from -# your IMAP and POP servers here. You are free to remove entries at any -# time. -# -# When setting this variable to a directory, mutt needs to fetch every -# remote message only once and can perform regular expression searches -# as fast as for local folders. -# -# Also see the $message_cache_clean variable. -# -# -# set message_cache_clean=no -# -# Name: message_cache_clean -# Type: boolean -# Default: no -# -# -# If set, mutt will clean out obsolete entries from the message cache when -# the mailbox is synchronized. You probably only want to set it -# every once in a while, since it can be a little slow -# (especially for large folders). -# -# -# set message_format="%s" -# -# Name: message_format -# Type: string -# Default: "%s" -# -# -# This is the string displayed in the ``attachment'' menu for -# attachments of type message/rfc822. For a full listing of defined -# printf(3)-like sequences see the section on $index_format. -# -# # set narrow_tree=no # # Name: narrow_tree @@ -2121,6 +2284,10 @@ attachments -I message/external-body # default, Mutt will display the line after the last one on the screen # at the top of the next page (0 lines of context). # +# This variable also specifies the amount of context given for search +# results. If positive, this many lines will be given before a match, +# if 0, the match will be top-aligned. +# # # set pager_format="-%Z- %C/%m: %-20.20n %s%* -- (%P)" # @@ -2167,172 +2334,141 @@ attachments -I message/external-body # function. # # -# set crypt_autosign=no +# set pgp_auto_decode=no # -# Name: crypt_autosign +# Name: pgp_auto_decode # Type: boolean # Default: no # # -# Setting this variable will cause Mutt to always attempt to -# cryptographically sign outgoing messages. This can be overridden -# by use of the pgp menu, when signing is not required or -# encryption is requested as well. If $smime_is_default is set, -# then OpenSSL is used instead to create S/MIME messages and settings can -# be overridden by use of the smime menu instead of the pgp menu. -# (Crypto only) +# If set, mutt will automatically attempt to decrypt traditional PGP +# messages whenever the user performs an operation which ordinarily would +# result in the contents of the message being operated on. For example, +# if the user displays a pgp-traditional message which has not been manually +# checked with the function, mutt will automatically +# check the message for traditional pgp. # # -# set crypt_autoencrypt=no +# set pgp_autoinline=no # -# Name: crypt_autoencrypt +# Name: pgp_autoinline # Type: boolean # Default: no # # -# Setting this variable will cause Mutt to always attempt to PGP -# encrypt outgoing messages. This is probably only useful in -# connection to the ``send-hook'' command. It can be overridden -# by use of the pgp menu, when encryption is not required or -# signing is requested as well. If $smime_is_default is set, -# then OpenSSL is used instead to create S/MIME messages and -# settings can be overridden by use of the smime menu instead. -# (Crypto only) +# This option controls whether Mutt generates old-style inline +# (traditional) PGP encrypted or signed messages under certain +# circumstances. This can be overridden by use of the pgp menu, +# when inline is not required. # +# Note that Mutt might automatically use PGP/MIME for messages +# which consist of more than a single MIME part. Mutt can be +# configured to ask before sending PGP/MIME messages when inline +# (traditional) would not work. # -# set pgp_ignore_subkeys=yes -# -# Name: pgp_ignore_subkeys -# Type: boolean -# Default: yes +# Also see the $pgp_mime_auto variable. # +# Also note that using the old-style PGP message format is strongly +# deprecated. +# (PGP only) # -# Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, -# the principal key will inherit the subkeys' capabilities. Unset this -# if you want to play interesting key selection games. -# (PGP only) # -# -# set crypt_replyencrypt=yes +# set pgp_check_exit=yes # -# Name: crypt_replyencrypt +# Name: pgp_check_exit # Type: boolean # Default: yes # # -# If set, automatically PGP or OpenSSL encrypt replies to messages which are -# encrypted. -# (Crypto only) +# If set, mutt will check the exit code of the PGP subprocess when +# signing or encrypting. A non-zero exit code means that the +# subprocess failed. +# (PGP only) # # -# set crypt_replysign=no +# set pgp_clearsign_command="" # -# Name: crypt_replysign -# Type: boolean -# Default: no +# Name: pgp_clearsign_command +# Type: string +# Default: "" # # -# If set, automatically PGP or OpenSSL sign replies to messages which are -# signed. +# This format is used to create an old-style ``clearsigned'' PGP +# message. Note that the use of this format is strongly +# deprecated. # -# Note: this does not work on messages that are encrypted -# and signed! -# (Crypto only) +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. +# (PGP only) # # -# set crypt_replysignencrypted=no +# set pgp_decode_command="" # -# Name: crypt_replysignencrypted -# Type: boolean -# Default: no -# +# Name: pgp_decode_command +# Type: string +# Default: "" # -# If set, automatically PGP or OpenSSL sign replies to messages -# which are encrypted. This makes sense in combination with -# $crypt_replyencrypt, because it allows you to sign all -# messages which are automatically encrypted. This works around -# the problem noted in $crypt_replysign, that mutt is not able -# to find out whether an encrypted message is also signed. -# (Crypto only) # +# This format strings specifies a command which is used to decode +# application/pgp attachments. # -# set crypt_timestamp=yes -# -# Name: crypt_timestamp -# Type: boolean -# Default: yes +# The PGP command formats have their own set of printf(3)-like sequences: +# %p Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty +# string otherwise. Note: This may be used with a %? construct. +# %f Expands to the name of a file containing a message. +# %s Expands to the name of a file containing the signature part +# of a multipart/signed attachment when verifying it. +# %a The value of $pgp_sign_as. +# %r One or more key IDs. # # -# If set, mutt will include a time stamp in the lines surrounding -# PGP or S/MIME output, so spoofing such lines is more difficult. -# If you are using colors to mark these lines, and rely on these, -# you may unset this setting. -# (Crypto only) +# For examples on how to configure these formats for the various versions +# of PGP which are floating around, see the pgp and gpg sample configuration files in +# the samples/ subdirectory which has been installed on your system +# alongside the documentation. +# (PGP only) # # -# set pgp_use_gpg_agent=no +# set pgp_decrypt_command="" # -# Name: pgp_use_gpg_agent -# Type: boolean -# Default: no +# Name: pgp_decrypt_command +# Type: string +# Default: "" # # -# If set, mutt will use a possibly-running gpg-agent(1) process. +# This command is used to decrypt a PGP encrypted message. +# +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. # (PGP only) # # -# set crypt_verify_sig=yes +# set pgp_encrypt_only_command="" # -# Name: crypt_verify_sig -# Type: quadoption -# Default: yes -# -# -# If ``yes'', always attempt to verify PGP or S/MIME signatures. -# If ``ask-*'', ask whether or not to verify the signature. -# If \Fi``no'', never attempt to verify cryptographic signatures. -# (Crypto only) -# +# Name: pgp_encrypt_only_command +# Type: string +# Default: "" # -# set smime_is_default=no -# -# Name: smime_is_default -# Type: boolean -# Default: no # +# This command is used to encrypt a body part without signing it. # -# The default behaviour of mutt is to use PGP on all auto-sign/encryption -# operations. To override and to use OpenSSL instead this must be set. -# However, this has no effect while replying, since mutt will automatically -# select the same application that was used to sign/encrypt the original -# message. (Note that this variable can be overridden by unsetting $crypt_autosmime.) -# (S/MIME only) +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. +# (PGP only) # # -# set smime_ask_cert_label=yes +# set pgp_encrypt_sign_command="" # -# Name: smime_ask_cert_label -# Type: boolean -# Default: yes -# -# -# This flag controls whether you want to be asked to enter a label -# for a certificate about to be added to the database or not. It is -# set by default. -# (S/MIME only) -# +# Name: pgp_encrypt_sign_command +# Type: string +# Default: "" # -# set smime_decrypt_use_default_key=yes -# -# Name: smime_decrypt_use_default_key -# Type: boolean -# Default: yes # +# This command is used to both sign and encrypt a body part. # -# If set (default) this tells mutt to use the default key for decryption. Otherwise, -# if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address -# to determine the key to use. It will ask you to supply a key, if it can't find one. -# (S/MIME only) +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. +# (PGP only) # # # set pgp_entry_format="%4n %t%f %4l/0x%k %-4a %2c %u" @@ -2359,6 +2495,34 @@ attachments -I message/external-body # (PGP only) # # +# set pgp_export_command="" +# +# Name: pgp_export_command +# Type: string +# Default: "" +# +# +# This command is used to export a public key from the user's +# key ring. +# +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. +# (PGP only) +# +# +# set pgp_getkeys_command="" +# +# Name: pgp_getkeys_command +# Type: string +# Default: "" +# +# +# This command is invoked whenever mutt will need public key information. +# Of the sequences supported by $pgp_decode_command, %r is the only +# printf(3)-like sequence used with this format. +# (PGP only) +# +# # set pgp_good_sign="" # # Name: pgp_good_sign @@ -2373,83 +2537,112 @@ attachments -I message/external-body # (PGP only) # # -# set pgp_check_exit=yes +# set pgp_ignore_subkeys=yes # -# Name: pgp_check_exit +# Name: pgp_ignore_subkeys # Type: boolean # Default: yes # # -# If set, mutt will check the exit code of the PGP subprocess when -# signing or encrypting. A non-zero exit code means that the -# subprocess failed. +# Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, +# the principal key will inherit the subkeys' capabilities. Unset this +# if you want to play interesting key selection games. # (PGP only) # # -# set pgp_long_ids=no +# set pgp_import_command="" # -# Name: pgp_long_ids -# Type: boolean -# Default: no +# Name: pgp_import_command +# Type: string +# Default: "" # # -# If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs. +# This command is used to import a key from a message into +# the user's public key ring. +# +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. # (PGP only) # # -# set pgp_retainable_sigs=no +# set pgp_list_pubring_command="" # -# Name: pgp_retainable_sigs -# Type: boolean -# Default: no +# Name: pgp_list_pubring_command +# Type: string +# Default: "" # # -# If set, signed and encrypted messages will consist of nested -# multipart/signed and multipart/encrypted body parts. +# This command is used to list the public key ring's contents. The +# output format must be analogous to the one used by +# gpg --list-keys --with-colons. # -# This is useful for applications like encrypted and signed mailing -# lists, where the outer layer (multipart/encrypted) can be easily -# removed, while the inner multipart/signed part is retained. +# This format is also generated by the pgpring utility which comes +# with mutt. +# +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. # (PGP only) # # -# set pgp_autoinline=no +# set pgp_list_secring_command="" # -# Name: pgp_autoinline -# Type: boolean -# Default: no -# +# Name: pgp_list_secring_command +# Type: string +# Default: "" # -# This option controls whether Mutt generates old-style inline -# (traditional) PGP encrypted or signed messages under certain -# circumstances. This can be overridden by use of the pgp menu, -# when inline is not required. # -# Note that Mutt might automatically use PGP/MIME for messages -# which consist of more than a single MIME part. Mutt can be -# configured to ask before sending PGP/MIME messages when inline -# (traditional) would not work. +# This command is used to list the secret key ring's contents. The +# output format must be analogous to the one used by: +# gpg --list-keys --with-colons. # -# Also see the $pgp_mime_auto variable. +# This format is also generated by the pgpring utility which comes +# with mutt. # -# Also note that using the old-style PGP message format is strongly -# deprecated. +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. # (PGP only) # # -# set pgp_replyinline=no +# set pgp_long_ids=no # -# Name: pgp_replyinline +# Name: pgp_long_ids # Type: boolean # Default: no # # -# Setting this variable will cause Mutt to always attempt to -# create an inline (traditional) message when replying to a -# message which is PGP encrypted/signed inline. This can be -# overridden by use of the pgp menu, when inline is not -# required. This option does not automatically detect if the -# (replied-to) message is inline; instead it relies on Mutt +# If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs. +# (PGP only) +# +# +# set pgp_mime_auto=ask-yes +# +# Name: pgp_mime_auto +# Type: quadoption +# Default: ask-yes +# +# +# This option controls whether Mutt will prompt you for +# automatically sending a (signed/encrypted) message using +# PGP/MIME when inline (traditional) fails (for any reason). +# +# Also note that using the old-style PGP message format is strongly +# deprecated. +# (PGP only) +# +# +# set pgp_replyinline=no +# +# Name: pgp_replyinline +# Type: boolean +# Default: no +# +# +# Setting this variable will cause Mutt to always attempt to +# create an inline (traditional) message when replying to a +# message which is PGP encrypted/signed inline. This can be +# overridden by use of the pgp menu, when inline is not +# required. This option does not automatically detect if the +# (replied-to) message is inline; instead it relies on Mutt # internals for previously checked/flagged messages. # # Note that Mutt might automatically use PGP/MIME for messages @@ -2464,6 +2657,22 @@ attachments -I message/external-body # (PGP only) # # +# set pgp_retainable_sigs=no +# +# Name: pgp_retainable_sigs +# Type: boolean +# Default: no +# +# +# If set, signed and encrypted messages will consist of nested +# multipart/signed and multipart/encrypted body parts. +# +# This is useful for applications like encrypted and signed mailing +# lists, where the outer layer (multipart/encrypted) can be easily +# removed, while the inner multipart/signed part is retained. +# (PGP only) +# +# # set pgp_show_unusable=yes # # Name: pgp_show_unusable @@ -2490,29 +2699,18 @@ attachments -I message/external-body # (PGP only) # # -# set pgp_strict_enc=yes +# set pgp_sign_command="" # -# Name: pgp_strict_enc -# Type: boolean -# Default: yes -# -# -# If set, Mutt will automatically encode PGP/MIME signed messages as -# quoted-printable. Please note that unsetting this variable may -# lead to problems with non-verifyable PGP signatures, so only change -# this if you know what you are doing. -# (PGP only) -# +# Name: pgp_sign_command +# Type: string +# Default: "" # -# set pgp_timeout=300 -# -# Name: pgp_timeout -# Type: number -# Default: 300 # +# This command is used to create the detached PGP signature for a +# multipart/signed PGP/MIME body part. # -# The number of seconds after which a cached passphrase will expire if -# not used. +# This is a format string, see the $pgp_decode_command command for +# possible printf(3)-like sequences. # (PGP only) # # @@ -2536,74 +2734,40 @@ attachments -I message/external-body # (PGP only) # # -# set pgp_mime_auto=ask-yes -# -# Name: pgp_mime_auto -# Type: quadoption -# Default: ask-yes -# -# -# This option controls whether Mutt will prompt you for -# automatically sending a (signed/encrypted) message using -# PGP/MIME when inline (traditional) fails (for any reason). -# -# Also note that using the old-style PGP message format is strongly -# deprecated. -# (PGP only) -# -# -# set pgp_auto_decode=no +# set pgp_strict_enc=yes # -# Name: pgp_auto_decode +# Name: pgp_strict_enc # Type: boolean -# Default: no +# Default: yes # # -# If set, mutt will automatically attempt to decrypt traditional PGP -# messages whenever the user performs an operation which ordinarily would -# result in the contents of the message being operated on. For example, -# if the user displays a pgp-traditional message which has not been manually -# checked with the function, mutt will automatically -# check the message for traditional pgp. +# If set, Mutt will automatically encode PGP/MIME signed messages as +# quoted-printable. Please note that unsetting this variable may +# lead to problems with non-verifyable PGP signatures, so only change +# this if you know what you are doing. +# (PGP only) # # -# set pgp_decode_command="" +# set pgp_timeout=300 # -# Name: pgp_decode_command -# Type: string -# Default: "" -# -# -# This format strings specifies a command which is used to decode -# application/pgp attachments. -# -# The PGP command formats have their own set of printf(3)-like sequences: -# %p Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty -# string otherwise. Note: This may be used with a %? construct. -# %f Expands to the name of a file containing a message. -# %s Expands to the name of a file containing the signature part -# of a multipart/signed attachment when verifying it. -# %a The value of $pgp_sign_as. -# %r One or more key IDs. +# Name: pgp_timeout +# Type: number +# Default: 300 # # -# For examples on how to configure these formats for the various versions -# of PGP which are floating around, see the pgp and gpg sample configuration files in -# the samples/ subdirectory which has been installed on your system -# alongside the documentation. +# The number of seconds after which a cached passphrase will expire if +# not used. # (PGP only) # # -# set pgp_getkeys_command="" +# set pgp_use_gpg_agent=no # -# Name: pgp_getkeys_command -# Type: string -# Default: "" +# Name: pgp_use_gpg_agent +# Type: boolean +# Default: no # # -# This command is invoked whenever mutt will need public key information. -# Of the sequences supported by $pgp_decode_command, %r is the only -# printf(3)-like sequence used with this format. +# If set, mutt will use a possibly-running gpg-agent(1) process. # (PGP only) # # @@ -2621,1404 +2785,1160 @@ attachments -I message/external-body # (PGP only) # # -# set pgp_decrypt_command="" +# set pgp_verify_key_command="" # -# Name: pgp_decrypt_command +# Name: pgp_verify_key_command # Type: string # Default: "" # # -# This command is used to decrypt a PGP encrypted message. +# This command is used to verify key information from the key selection +# menu. # # This is a format string, see the $pgp_decode_command command for # possible printf(3)-like sequences. # (PGP only) # # -# set pgp_clearsign_command="" +# set pipe_decode=no # -# Name: pgp_clearsign_command -# Type: string -# Default: "" -# +# Name: pipe_decode +# Type: boolean +# Default: no # -# This format is used to create a old-style ``clearsigned'' PGP -# message. Note that the use of this format is strongly -# deprecated. # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) +# 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. # # -# set pgp_sign_command="" +# set pipe_sep="\n" # -# Name: pgp_sign_command +# Name: pipe_sep # Type: string -# Default: "" -# +# Default: "\n" # -# This command is used to create the detached PGP signature for a -# multipart/signed PGP/MIME body part. # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) +# The separator to add between messages when piping a list of tagged +# messages to an external Unix command. # # -# set pgp_encrypt_sign_command="" +# set pipe_split=no # -# Name: pgp_encrypt_sign_command -# Type: string -# Default: "" -# +# Name: pipe_split +# Type: boolean +# Default: no # -# This command is used to both sign and encrypt a body part. # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) +# Used in connection with the function following +# . If this variable is unset, when piping a list of +# tagged messages Mutt will concatenate the messages and will pipe them +# all concatenated. When set, Mutt will pipe the messages one by one. +# In both cases the messages are piped in the current sorted order, +# and the $pipe_sep separator is added after each message. # # -# set pgp_encrypt_only_command="" +# set pop_auth_try_all=yes # -# Name: pgp_encrypt_only_command -# Type: string -# Default: "" -# +# Name: pop_auth_try_all +# Type: boolean +# Default: yes # -# This command is used to encrypt a body part without signing it. # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) +# If set, Mutt will try all available authentication methods. +# When unset, Mutt will only fall back to other authentication +# methods if the previous methods are unavailable. If a method is +# available but authentication fails, Mutt will not connect to the POP server. # # -# set pgp_import_command="" +# set pop_authenticators="" # -# Name: pgp_import_command +# Name: pop_authenticators # Type: string # Default: "" # # -# This command is used to import a key from a message into -# the user's public key ring. +# This is a colon-delimited list of authentication methods mutt may +# attempt to use to log in to an POP server, in the order mutt should +# try them. Authentication methods are either ``user'', ``apop'' or any +# SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''. +# This option is case-insensitive. If this option is unset +# (the default) mutt will try all available methods, in order from +# most-secure to least-secure. # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) +# Example: +# set pop_authenticators="digest-md5:apop:user" # # -# set pgp_export_command="" +# set pop_checkinterval=60 # -# Name: pgp_export_command -# Type: string -# Default: "" +# Name: pop_checkinterval +# Type: number +# Default: 60 # # -# This command is used to export a public key from the user's -# key ring. +# This variable configures how often (in seconds) mutt should look for +# new mail in the currently selected mailbox if it is a POP mailbox. # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) # -# -# set pgp_verify_key_command="" +# set pop_delete=ask-no # -# Name: pgp_verify_key_command -# Type: string -# Default: "" -# +# Name: pop_delete +# Type: quadoption +# Default: ask-no # -# This command is used to verify key information from the key selection -# menu. # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) +# If set, Mutt will delete successfully downloaded messages from the POP +# server when using the function. When unset, Mutt will +# download messages but also leave them on the POP server. # # -# set pgp_list_secring_command="" +# set pop_host="" # -# Name: pgp_list_secring_command +# Name: pop_host # Type: string # Default: "" # # -# This command is used to list the secret key ring's contents. The -# output format must be analogous to the one used by: -# gpg --list-keys --with-colons. -# -# This format is also generated by the pgpring utility which comes -# with mutt. +# The name of your POP server for the function. You +# can also specify an alternative port, username and password, ie: +# [pop[s]://][username[:password]@]popserver[:port] # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) +# where ``[...]'' denotes an optional part. # # -# set pgp_list_pubring_command="" +# set pop_last=no # -# Name: pgp_list_pubring_command -# Type: string -# Default: "" -# -# -# This command is used to list the public key ring's contents. The -# output format must be analogous to the one used by -# gpg --list-keys --with-colons. +# Name: pop_last +# Type: boolean +# Default: no # -# This format is also generated by the pgpring utility which comes -# with mutt. # -# This is a format string, see the $pgp_decode_command command for -# possible printf(3)-like sequences. -# (PGP only) +# If this variable is set, mutt will try to use the ``LAST'' POP command +# for retrieving only unread messages from the POP server when using +# the function. # # -# set forward_decrypt=yes +# set pop_pass="" # -# Name: forward_decrypt -# Type: boolean -# Default: yes +# Name: pop_pass +# Type: string +# Default: "" # # -# 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) +# Specifies the password for your POP account. If unset, Mutt will +# prompt you for your password when you open a POP mailbox. +# +# Warning: you should only use this option when you are on a +# fairly secure machine, because the superuser can read your muttrc +# even if you are the only one who can read the file. # # -# set smime_timeout=300 +# set pop_reconnect=ask-yes # -# Name: smime_timeout -# Type: number -# Default: 300 +# Name: pop_reconnect +# Type: quadoption +# Default: ask-yes # # -# The number of seconds after which a cached passphrase will expire if -# not used. -# (S/MIME only) +# Controls whether or not Mutt will try to reconnect to the POP server if +# the connection is lost. # # -# set smime_encrypt_with="" +# set pop_user="" # -# Name: smime_encrypt_with +# Name: pop_user # Type: string # Default: "" # # -# This sets the algorithm that should be used for encryption. -# Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``rc2-128''. -# If unset, ``3des'' (TripleDES) is used. -# (S/MIME only) +# Your login name on the POP server. +# +# This variable defaults to your user name on the local machine. # # -# set smime_keys="" +# set post_indent_string="" # -# Name: smime_keys -# Type: path +# Name: post_indent_string +# Type: string # Default: "" # # -# Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle -# storage and retrieval of keys/certs by itself. This is very basic right now, -# and stores keys and certificates in two different directories, both -# named as the hash-value retrieved from OpenSSL. There is an index file -# which contains mailbox-address keyid pair, and which can be manually -# edited. This option points to the location of the private keys. -# (S/MIME only) +# Similar to the $attribution variable, Mutt will append this +# string after the inclusion of a message which is being replied to. # # -# set smime_ca_location="" +# set postpone=ask-yes # -# Name: smime_ca_location -# Type: path -# Default: "" +# Name: postpone +# Type: quadoption +# Default: ask-yes # # -# This variable contains the name of either a directory, or a file which -# contains trusted certificates for use with OpenSSL. -# (S/MIME only) +# Controls whether or not messages are saved in the $postponed +# mailbox when you elect not to send immediately. +# +# Also see the $recall variable. # # -# set smime_certificates="" +# set postponed="~/postponed" # -# Name: smime_certificates +# Name: postponed # Type: path -# Default: "" +# Default: "~/postponed" # # -# Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle -# storage and retrieval of keys by itself. This is very basic right -# now, and keys and certificates are stored in two different -# directories, both named as the hash-value retrieved from -# OpenSSL. There is an index file which contains mailbox-address -# keyid pairs, and which can be manually edited. This option points to -# the location of the certificates. -# (S/MIME only) +# Mutt allows you to indefinitely ``postpone sending a message'' which +# you are editing. When you choose to postpone a message, Mutt saves it +# in the mailbox specified by this variable. # +# Also see the $postpone variable. # -# set smime_decrypt_command="" +# +# set preconnect="" # -# Name: smime_decrypt_command +# Name: preconnect # Type: string # Default: "" # # -# This format string specifies a command which is used to decrypt -# application/x-pkcs7-mime attachments. -# -# The OpenSSL command formats have their own set of printf(3)-like sequences -# similar to PGP's: -# %f Expands to the name of a file containing a message. -# %s Expands to the name of a file containing the signature part -# of a multipart/signed attachment when verifying it. -# %k The key-pair specified with $smime_default_key -# %c One or more certificate IDs. -# %a The algorithm used for encryption. -# %C CA location: Depending on whether $smime_ca_location -# points to a directory or file, this expands to -# ``-CApath $smime_ca_location'' or ``-CAfile $smime_ca_location''. +# If set, a shell command to be executed if mutt fails to establish +# a connection to the server. This is useful for setting up secure +# connections, e.g. with ssh(1). If the command returns a nonzero +# status, mutt gives up opening the server. Example: +# set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \ +# sleep 20 < /dev/null > /dev/null" # +# Mailbox ``foo'' on ``mailhost.net'' can now be reached +# as ``{localhost:1234}foo''. # -# For examples on how to configure these formats, see the smime.rc in -# the samples/ subdirectory which has been installed on your system -# alongside the documentation. -# (S/MIME only) +# Note: For this example to work, you must be able to log in to the +# remote machine without having to enter a password. # # -# set smime_verify_command="" +# set print=ask-no # -# Name: smime_verify_command -# Type: string -# Default: "" -# +# Name: print +# Type: quadoption +# Default: ask-no # -# This command is used to verify S/MIME signatures of type multipart/signed. # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# Controls whether or not Mutt really prints messages. +# This is set to ``ask-no'' by default, because some people +# accidentally hit ``p'' often. # # -# set smime_verify_opaque_command="" +# set print_command="lpr" # -# Name: smime_verify_opaque_command -# Type: string -# Default: "" -# +# Name: print_command +# Type: path +# Default: "lpr" # -# This command is used to verify S/MIME signatures of type -# application/x-pkcs7-mime. # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# This specifies the command pipe that should be used to print messages. # # -# set smime_sign_command="" +# set print_decode=yes # -# Name: smime_sign_command -# Type: string -# Default: "" -# +# Name: print_decode +# Type: boolean +# Default: yes # -# This command is used to created S/MIME signatures of type -# multipart/signed, which can be read by all mail clients. # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# 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 $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. # # -# set smime_sign_opaque_command="" +# set print_split=no # -# Name: smime_sign_opaque_command -# Type: string -# Default: "" +# Name: print_split +# Type: boolean +# Default: no # # -# This command is used to created S/MIME signatures of type -# application/x-pkcs7-signature, which can only be handled by mail -# clients supporting the S/MIME extension. +# 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. # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# Those who use the enscript(1) program's mail-printing mode will +# most likely want to set this option. # # -# set smime_encrypt_command="" +# set prompt_after=yes # -# Name: smime_encrypt_command -# Type: string -# Default: "" -# +# Name: prompt_after +# Type: boolean +# Default: yes # -# This command is used to create encrypted S/MIME messages. # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# If you use an external $pager, setting this variable will +# cause Mutt to prompt you for a command when the pager exits rather +# than returning to the index menu. If unset, Mutt will return to the +# index menu when the external pager exits. # # -# set smime_pk7out_command="" +# set query_command="" # -# Name: smime_pk7out_command -# Type: string +# Name: query_command +# Type: path # Default: "" # # -# This command is used to extract PKCS7 structures of S/MIME signatures, -# in order to extract the public X509 certificate(s). -# -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# This specifies the command that mutt will use to make external address +# queries. The string should contain a ``%s'', which will be substituted +# with the query string the user types. See ``query'' for more +# information. # # -# set smime_get_cert_command="" +# set query_format="%4c %t %-25.25a %-25.25n %?e?(%e)?" # -# Name: smime_get_cert_command +# Name: query_format # Type: string -# Default: "" +# Default: "%4c %t %-25.25a %-25.25n %?e?(%e)?" # # -# This command is used to extract X509 certificates from a PKCS7 structure. +# This variable describes the format of the ``query'' menu. The +# following printf(3)-style sequences are understood: +# %a destination address +# %c current entry number +# %e extra information * +# %n destination name +# %t ``*'' if current entry is tagged, a space otherwise +# %>X right justify the rest of the string and pad with ``X'' +# %|X pad to the end of the line with ``X'' +# %*X soft-fill with character ``X'' as pad # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) # +# For an explanation of ``soft-fill'', see the $index_format documentation. # -# set smime_get_signer_cert_command="" -# -# Name: smime_get_signer_cert_command -# Type: string -# Default: "" +# * = can be optionally printed if nonzero, see the $status_format documentation. # # -# This command is used to extract only the signers X509 certificate from a S/MIME -# signature, so that the certificate's owner may get compared to the -# email's ``From:'' field. +# set quit=yes +# +# Name: quit +# Type: quadoption +# Default: yes # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# +# This variable controls whether ``quit'' and ``exit'' actually quit +# from mutt. If this option is set, they do quit, if it is unset, they +# have no effect, and if it is set to ask-yes or ask-no, you are +# prompted for confirmation when you try to quit. # # -# set smime_import_cert_command="" +# set quote_regexp="^([ \t]*[|>:}#])+" # -# Name: smime_import_cert_command -# Type: string -# Default: "" +# Name: quote_regexp +# Type: regular expression +# Default: "^([ \t]*[|>:}#])+" # # -# This command is used to import a certificate via smime_keys. +# A regular expression used in the internal pager to determine quoted +# sections of text in the body of a message. Quoted text may be filtered +# out using the command, or colored according to the +# ``color quoted'' family of directives. # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# Higher levels of quoting may be colored differently (``color quoted1'', +# ``color quoted2'', etc.). The quoting level is determined by removing +# the last character from the matched text and recursively reapplying +# the regular expression until it fails to produce a match. # +# Match detection may be overridden by the $smileys regular expression. # -# set smime_get_cert_email_command="" +# +# set read_inc=10 # -# Name: smime_get_cert_email_command -# Type: string -# Default: "" +# Name: read_inc +# Type: number +# Default: 10 # # -# This command is used to extract the mail address(es) used for storing -# X509 certificates, and for verification purposes (to check whether the -# certificate was issued for the sender's mailbox). +# If set to a value greater than 0, Mutt will display which message it +# is currently on when reading a mailbox or when performing search actions +# such as search and limit. The message is printed after +# this many messages have been read or searched (e.g., if set to 25, Mutt will +# print a message when it is at message 25, and then again when it gets +# to message 50). This variable is meant to indicate progress when +# reading or searching large mailboxes which may take some time. +# When set to 0, only a single message will appear before the reading +# the mailbox. # -# This is a format string, see the $smime_decrypt_command command for -# possible printf(3)-like sequences. -# (S/MIME only) +# Also see the $write_inc, $net_inc and $time_inc variables and the +# ``tuning'' section of the manual for performance considerations. # # -# set smime_default_key="" +# set read_only=no # -# Name: smime_default_key -# Type: string -# Default: "" +# Name: read_only +# Type: boolean +# Default: no # # -# This is the default key-pair to use for signing. This must be set to the -# keyid (the hash-value that OpenSSL generates) to work properly -# (S/MIME only) +# If set, all folders are opened in read-only mode. # # -# set ssl_client_cert="" +# set realname="" # -# Name: ssl_client_cert -# Type: path +# Name: realname +# Type: string # Default: "" # # -# The file containing a client certificate and its associated private -# key. -# -# -# set ssl_force_tls=no -# -# Name: ssl_force_tls -# Type: boolean -# Default: no -# +# This variable specifies what ``real'' or ``personal'' name should be used +# when sending messages. # -# 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 server does not advertise the capability, -# since it would otherwise have to abort the connection anyway. This -# option supersedes $ssl_starttls. +# By default, this is the GECOS field from /etc/passwd. Note that this +# variable will not be used when the user has set a real name +# in the $from variable. # # -# set ssl_starttls=yes +# set recall=ask-yes # -# Name: ssl_starttls +# Name: recall # Type: quadoption -# Default: yes +# Default: ask-yes # # -# If set (the default), mutt will attempt to use STARTTLS on servers -# advertising the capability. When unset, mutt will not attempt to -# use STARTTLS regardless of the server's capabilities. +# Controls whether or not Mutt recalls postponed messages +# when composing a new message. +# +# Setting this variable to is not generally useful, and thus not +# recommended. +# +# Also see $postponed variable. # # -# set certificate_file="~/.mutt_certificates" +# set record="~/sent" # -# Name: certificate_file +# Name: record # Type: path -# Default: "~/.mutt_certificates" -# +# Default: "~/sent" # -# This variable specifies the file where the certificates you trust -# are saved. When an unknown certificate is encountered, you are asked -# if you accept it or not. If you accept it, the certificate can also -# be saved in this file and further connections are automatically -# accepted. # -# You can also manually add CA certificates in this file. Any server -# certificate that is signed with one of these CA certificates is -# also automatically accepted. +# This specifies the file into which your outgoing messages should be +# appended. (This is meant as the primary method for saving a copy of +# your messages, but another way to do this is using the ``my_hdr'' +# command to create a ``Bcc:'' field with your email address in it.) # -# Example: -# set certificate_file=~/.mutt/certificates +# The value of $record is overridden by the $force_name and +# $save_name variables, and the ``fcc-hook'' command. # # -# set ssl_usesystemcerts=yes +# set reply_regexp="^(re([\\[0-9\\]+])*|aw):[ \t]*" # -# Name: ssl_usesystemcerts -# Type: boolean -# Default: yes +# Name: reply_regexp +# Type: regular expression +# Default: "^(re([\\[0-9\\]+])*|aw):[ \t]*" # # -# If set to yes, mutt will use CA certificates in the -# system-wide certificate store when checking if a server certificate -# is signed by a trusted CA. +# A regular expression used to recognize reply messages when threading +# and replying. The default value corresponds to the English "Re:" and +# the German "Aw:". # # -# set entropy_file="" +# set reply_self=no # -# Name: entropy_file -# Type: path -# Default: "" +# Name: reply_self +# Type: boolean +# Default: no # # -# The file which includes random data that is used to initialize SSL -# library functions. +# If unset and you are replying to a message sent by you, Mutt will +# assume that you want to reply to the recipients of that message rather +# than to yourself. +# +# Also see the ``alternates'' command. # # -# set ssl_use_sslv2=yes +# set reply_to=ask-yes # -# Name: ssl_use_sslv2 -# Type: boolean -# Default: yes +# Name: reply_to +# Type: quadoption +# Default: ask-yes # # -# This variables specifies whether to attempt to use SSLv2 in the -# SSL authentication process. +# If set, when replying to a message, Mutt will use the address listed +# in the Reply-to: header as the recipient of the reply. If unset, +# it will use the address in the From: header field instead. This +# option is useful for reading a mailing list that sets the Reply-To: +# header field to the list address and you want to send a private +# message to the author of a message. # # -# set ssl_use_sslv3=yes +# set resolve=yes # -# Name: ssl_use_sslv3 +# Name: resolve # Type: boolean # Default: yes # # -# This variables specifies whether to attempt to use SSLv3 in the -# SSL authentication process. +# When set, the cursor will be automatically advanced to the next +# (possibly undeleted) message whenever a command that modifies the +# current message is executed. # # -# set ssl_use_tlsv1=yes +# set reverse_alias=no # -# Name: ssl_use_tlsv1 +# Name: reverse_alias # Type: boolean -# Default: yes +# Default: no # # -# This variables specifies whether to attempt to use TLSv1 in the -# SSL authentication process. -# -# -# set ssl_min_dh_prime_bits=0 -# -# Name: ssl_min_dh_prime_bits -# Type: number -# Default: 0 +# This variable controls whether or not Mutt will display the ``personal'' +# name from your aliases in the index menu if it finds an alias that +# matches the message's sender. For example, if you have the following +# alias: +# alias juser abd30425@somewhere.net (Joe User) # +# and then you receive mail which contains the following header: +# From: abd30425@somewhere.net # -# This variable specifies the minimum acceptable prime size (in bits) -# for use in any Diffie-Hellman key exchange. A value of 0 will use -# the default from the GNUTLS library. +# It would be displayed in the index menu as ``Joe User'' instead of +# ``abd30425@somewhere.net.'' This is useful when the person's e-mail +# address is not human friendly. # # -# set ssl_ca_certificates_file="" +# set reverse_name=no # -# Name: ssl_ca_certificates_file -# Type: path -# Default: "" +# Name: reverse_name +# Type: boolean +# Default: no # # -# This variable specifies a file containing trusted CA certificates. -# Any server certificate that is signed with one of these CA -# certificates is also automatically accepted. +# It may sometimes arrive that you receive mail to a certain machine, +# move the messages to another machine, and reply to some the messages +# from there. If this variable is set, the default From: line of +# the reply messages is built using the address where you received the +# messages you are replying to if that address matches your +# ``alternates''. If the variable is unset, or the address that would be +# used doesn't match your ``alternates'', the From: line will use +# your address on the current machine. # -# Example: -# set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt +# Also see the ``alternates'' command. # # -# set pipe_split=no +# set reverse_realname=yes # -# Name: pipe_split +# Name: reverse_realname # Type: boolean -# Default: no +# Default: yes # # -# Used in connection with the function following -# . If this variable is unset, when piping a list of -# tagged messages Mutt will concatenate the messages and will pipe them -# all concatenated. When set, Mutt will pipe the messages one by one. -# In both cases the messages are piped in the current sorted order, -# and the $pipe_sep separator is added after each message. +# This variable fine-tunes the behaviour 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. # # -# set pipe_decode=no +# set rfc2047_parameters=no # -# Name: pipe_decode +# Name: rfc2047_parameters # 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. -# +# When this variable is set, Mutt will decode RFC2047-encoded MIME +# parameters. You want to set this variable when mutt suggests you +# to save attachments to files named like: +# =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?= # -# set pipe_sep="\n" -# -# Name: pipe_sep -# Type: string -# Default: "\n" +# When this variable is set interactively, the change won't be +# active until you change folders. # +# Note that this use of RFC2047's encoding is explicitly +# prohibited by the standard, but nevertheless encountered in the +# wild. # -# The separator to add between messages when piping a list of tagged -# messages to an external Unix command. +# Also note that setting this parameter will not have the effect +# that mutt generates this kind of encoding. Instead, mutt will +# unconditionally use the encoding specified in RFC2231. # # -# set pop_authenticators="" +# set save_address=no # -# Name: pop_authenticators -# Type: string -# Default: "" -# +# Name: save_address +# Type: boolean +# Default: no # -# This is a colon-delimited list of authentication methods mutt may -# attempt to use to log in to an POP server, in the order mutt should -# try them. Authentication methods are either ``user'', ``apop'' or any -# SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''. -# This option is case-insensitive. If this option is unset -# (the default) mutt will try all available methods, in order from -# most-secure to least-secure. # -# Example: -# set pop_authenticators="digest-md5:apop:user" +# If set, mutt will take the sender's full address when choosing a +# default folder for saving a mail. If $save_name or $force_name +# is set too, the selection of the Fcc folder will be changed as well. # # -# set pop_auth_try_all=yes +# set save_empty=yes # -# Name: pop_auth_try_all +# Name: save_empty # Type: boolean # Default: yes # # -# If set, Mutt will try all available authentication methods. -# When unset, Mutt will only fall back to other authentication -# methods if the previous methods are unavailable. If a method is -# available but authentication fails, Mutt will not connect to the POP server. -# -# -# set pop_checkinterval=60 -# -# Name: pop_checkinterval -# Type: number -# Default: 60 -# +# When unset, mailboxes which contain no saved messages will be removed +# when closed (the exception is $spoolfile which is never removed). +# If set, mailboxes are never removed. # -# This variable configures how often (in seconds) mutt should look for -# new mail in the currently selected mailbox if it is a POP mailbox. +# Note: This only applies to mbox and MMDF folders, Mutt does not +# delete MH and Maildir directories. # # -# set pop_delete=ask-no +# set save_history=0 # -# Name: pop_delete -# Type: quadoption -# Default: ask-no +# Name: save_history +# Type: number +# Default: 0 # # -# If set, Mutt will delete successfully downloaded messages from the POP -# server when using the function. When unset, Mutt will -# download messages but also leave them on the POP server. +# This variable controls the size of the history (per category) saved in the +# $history_file file. # # -# set pop_host="" +# set save_name=no # -# Name: pop_host -# Type: string -# Default: "" +# Name: save_name +# Type: boolean +# Default: no # # -# The name of your POP server for the function. You -# can also specify an alternative port, username and password, ie: -# [pop[s]://][username[:password]@]popserver[:port] +# This variable controls how copies of outgoing messages are saved. +# When set, a check is made to see if a mailbox specified by the +# recipient address exists (this is done by searching for a mailbox in +# the $folder directory with the username part of the +# recipient address). If the mailbox exists, the outgoing message will +# be saved to that mailbox, otherwise the message is saved to the +# $record mailbox. # -# where ``[...]'' denotes an optional part. +# Also see the $force_name variable. # # -# set pop_last=no +# set score=yes # -# Name: pop_last +# Name: score # Type: boolean -# Default: no +# Default: yes # # -# If this variable is set, mutt will try to use the ``LAST'' POP command -# for retrieving only unread messages from the POP server when using -# the function. +# When this variable is unset, scoring is turned off. This can +# be useful to selectively disable scoring for certain folders when the +# $score_threshold_delete variable and related are used. # # -# set pop_reconnect=ask-yes +# set score_threshold_delete=-1 # -# Name: pop_reconnect -# Type: quadoption -# Default: ask-yes +# Name: score_threshold_delete +# Type: number +# Default: -1 # # -# Controls whether or not Mutt will try to reconnect to the POP server if -# the connection is lost. +# Messages which have been assigned a score equal to or lower than the value +# of this variable are automatically marked for deletion by mutt. Since +# mutt scores are always greater than or equal to zero, the default setting +# of this variable will never mark a message for deletion. # # -# set pop_user="" +# set score_threshold_flag=9999 # -# Name: pop_user -# Type: string -# Default: "" -# +# Name: score_threshold_flag +# Type: number +# Default: 9999 # -# Your login name on the POP server. # -# This variable defaults to your user name on the local machine. +# Messages which have been assigned a score greater than or equal to this +# variable's value are automatically marked "flagged". # # -# set pop_pass="" +# set score_threshold_read=-1 # -# Name: pop_pass -# Type: string -# Default: "" -# +# Name: score_threshold_read +# Type: number +# Default: -1 # -# Specifies the password for your POP account. If unset, Mutt will -# prompt you for your password when you open a POP mailbox. # -# Warning: you should only use this option when you are on a -# fairly secure machine, because the superuser can read your muttrc -# even if you are the only one who can read the file. +# Messages which have been assigned a score equal to or lower than the value +# of this variable are automatically marked as read by mutt. Since +# mutt scores are always greater than or equal to zero, the default setting +# of this variable will never mark a message read. # # -# set post_indent_string="" +# set search_context=0 # -# Name: post_indent_string -# Type: string -# Default: "" +# Name: search_context +# Type: number +# Default: 0 # # -# Similar to the $attribution variable, Mutt will append this -# string after the inclusion of a message which is being replied to. +# For the pager, this variable specifies the number of lines shown +# before search results. By default, search results will be top-aligned. # # -# set postpone=ask-yes +# set send_charset="us-ascii:iso-8859-1:utf-8" # -# Name: postpone -# Type: quadoption -# Default: ask-yes +# Name: send_charset +# Type: string +# Default: "us-ascii:iso-8859-1:utf-8" # # -# Controls whether or not messages are saved in the $postponed -# mailbox when you elect not to send immediately. +# A colon-delimited list of character sets for outgoing messages. Mutt will use the +# first character set into which the text can be converted exactly. +# If your $charset is not ``iso-8859-1'' and recipients may not +# understand ``UTF-8'', it is advisable to include in the list an +# appropriate widely used standard character set (such as +# ``iso-8859-2'', ``koi8-r'' or ``iso-2022-jp'') either instead of or after +# ``iso-8859-1''. # -# Also see the $recall variable. +# In case the text cannot be converted into one of these exactly, +# mutt uses $charset as a fallback. # # -# set postponed="~/postponed" +# set sendmail="/usr/sbin/sendmail -oem -oi" # -# Name: postponed +# Name: sendmail # Type: path -# Default: "~/postponed" +# Default: "/usr/sbin/sendmail -oem -oi" # # -# Mutt allows you to indefinitely ``postpone sending a message'' which -# you are editing. When you choose to postpone a message, Mutt saves it -# in the mailbox specified by this variable. -# -# Also see the $postpone variable. +# Specifies the program and arguments used to deliver mail sent by Mutt. +# Mutt expects that the specified program interprets additional +# arguments as recipient addresses. # # -# set preconnect="" +# set sendmail_wait=0 # -# Name: preconnect -# Type: string -# Default: "" -# -# -# If set, a shell command to be executed if mutt fails to establish -# a connection to the server. This is useful for setting up secure -# connections, e.g. with ssh(1). If the command returns a nonzero -# status, mutt gives up opening the server. Example: -# set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \ -# sleep 20 < /dev/null > /dev/null" -# -# Mailbox ``foo'' on ``mailhost.net'' can now be reached -# as ``{localhost:1234}foo''. +# Name: sendmail_wait +# Type: number +# Default: 0 # -# Note: For this example to work, you must be able to log in to the -# remote machine without having to enter a password. # +# Specifies the number of seconds to wait for the $sendmail process +# to finish before giving up and putting delivery in the background. # -# set print=ask-no -# -# Name: print -# Type: quadoption -# Default: ask-no +# Mutt interprets the value of this variable as follows: +# >0 number of seconds to wait for sendmail to finish before continuing +# 0 wait forever for sendmail to finish +# <0 always put sendmail in the background without waiting # # -# Controls whether or not Mutt really prints messages. -# This is set to ``ask-no'' by default, because some people -# accidentally hit ``p'' often. +# Note that if you specify a value other than 0, the output of the child +# process will be put in a temporary file. If there is some error, you +# will be informed as to where to find the output. # # -# set print_command="lpr" +# set shell="" # -# Name: print_command +# Name: shell # Type: path -# Default: "lpr" +# Default: "" # # -# This specifies the command pipe that should be used to print messages. +# Command to use when spawning a subshell. By default, the user's login +# shell from /etc/passwd is used. # # -# set print_decode=yes +# set sig_dashes=yes # -# Name: print_decode +# Name: sig_dashes # 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 $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. +# If set, a line containing ``-- '' (note the trailing space) will be inserted before your +# $signature. It is strongly recommended that you not unset +# this variable unless your signature contains just your name. The +# reason for this is because many software packages use ``-- \n'' to +# detect your signature. For example, Mutt has the ability to highlight +# the signature in a different color in the builtin pager. # # -# set print_split=no +# set sig_on_top=no # -# Name: print_split +# Name: sig_on_top # 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. -# -# Those who use the enscript(1) program's mail-printing mode will -# most likely want to set this option. -# -# -# set prompt_after=yes -# -# Name: prompt_after -# Type: boolean -# Default: yes -# -# -# If you use an external $pager, setting this variable will -# cause Mutt to prompt you for a command when the pager exits rather -# than returning to the index menu. If unset, Mutt will return to the -# index menu when the external pager exits. +# If set, the signature will be included before any quoted or forwarded +# text. It is strongly recommended that you do not set this variable +# unless you really know what you are doing, and are prepared to take +# some heat from netiquette guardians. # # -# set query_command="" +# set signature="~/.signature" # -# Name: query_command +# Name: signature # Type: path -# Default: "" +# Default: "~/.signature" # # -# This specifies the command that mutt will use to make external address -# queries. The string should contain a ``%s'', which will be substituted -# with the query string the user types. See ``query'' for more -# information. +# Specifies the filename of your signature, which is appended to all +# outgoing messages. If the filename ends with a pipe (``|''), it is +# assumed that filename is a shell command and input should be read from +# its standard output. # # -# set query_format="%4c %t %-25.25a %-25.25n %?e?(%e)?" +# set simple_search="~f %s | ~s %s" # -# Name: query_format +# Name: simple_search # Type: string -# Default: "%4c %t %-25.25a %-25.25n %?e?(%e)?" -# -# -# This variable describes the format of the ``query'' menu. The -# following printf(3)-style sequences are understood: -# %a destination address -# %c current entry number -# %e extra information * -# %n destination name -# %t ``*'' if current entry is tagged, a space otherwise -# %>X right justify the rest of the string and pad with ``X'' -# %|X pad to the end of the line with ``X'' -# %*X soft-fill with character ``X'' as pad +# Default: "~f %s | ~s %s" # # -# For an explanation of ``soft-fill'', see the $index_format documentation. +# 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. See ``patterns'' for more information on search patterns. # -# * = can be optionally printed if nonzero, see the $status_format documentation. +# For example, if you simply type ``joe'' at a search or limit prompt, Mutt +# will automatically expand it to the value specified by this variable by +# replacing ``%s'' with the supplied string. +# For the default value, ``joe'' would be expanded to: ``~f joe | ~s joe''. # # -# set quit=yes +# set sleep_time=1 # -# Name: quit -# Type: quadoption -# Default: yes +# Name: sleep_time +# Type: number +# Default: 1 # # -# This variable controls whether ``quit'' and ``exit'' actually quit -# from mutt. If this option is set, they do quit, if it is unset, they -# have no effect, and if it is set to ask-yes or ask-no, you are -# prompted for confirmation when you try to quit. +# Specifies time, in seconds, to pause while displaying certain informational +# messages, while moving from folder to folder and after expunging +# messages from the current folder. The default is to pause one second, so +# a value of zero for this option suppresses the pause. # # -# set quote_regexp="^([ \t]*[|>:}#])+" +# set smart_wrap=yes # -# Name: quote_regexp -# Type: regular expression -# Default: "^([ \t]*[|>:}#])+" -# -# -# A regular expression used in the internal pager to determine quoted -# sections of text in the body of a message. Quoted text may be filtered -# out using the command, or colored according to the -# ``color quoted'' family of directives. +# Name: smart_wrap +# Type: boolean +# Default: yes # -# Higher levels of quoting may be colored differently (``color quoted1'', -# ``color quoted2'', etc.). The quoting level is determined by removing -# the last character from the matched text and recursively reapplying -# the regular expression until it fails to produce a match. # -# Match detection may be overridden by the $smileys regular expression. +# Controls the display of lines longer than the screen width in the +# internal pager. If set, long lines are wrapped at a word boundary. If +# unset, lines are simply wrapped at the screen edge. Also see the +# $markers variable. # # -# set read_inc=10 +# set smileys="(>From )|(:[-^]?[][)(><}{|/DP])" # -# Name: read_inc -# Type: number -# Default: 10 -# +# Name: smileys +# Type: regular expression +# Default: "(>From )|(:[-^]?[][)(><}{|/DP])" # -# If set to a value greater than 0, Mutt will display which message it -# is currently on when reading a mailbox or when performing search actions -# such as search and limit. The message is printed after -# this many messages have been read or searched (e.g., if set to 25, Mutt will -# print a message when it is at message 25, and then again when it gets -# to message 50). This variable is meant to indicate progress when -# reading or searching large mailboxes which may take some time. -# When set to 0, only a single message will appear before the reading -# the mailbox. # -# Also see the $write_inc, $net_inc and $time_inc variables and the -# ``tuning'' section of the manual for performance considerations. +# The pager uses this variable to catch some common false +# positives of $quote_regexp, most notably smileys and not consider +# a line quoted text if it also matches $smileys. This mostly +# happens at the beginning of a line. # # -# set read_only=no +# set smime_ask_cert_label=yes # -# Name: read_only +# Name: smime_ask_cert_label # Type: boolean -# Default: no +# Default: yes # # -# If set, all folders are opened in read-only mode. +# This flag controls whether you want to be asked to enter a label +# for a certificate about to be added to the database or not. It is +# set by default. +# (S/MIME only) # # -# set realname="" +# set smime_ca_location="" # -# Name: realname -# Type: string +# Name: smime_ca_location +# Type: path # Default: "" # # -# This variable specifies what ``real'' or ``personal'' name should be used -# when sending messages. -# -# By default, this is the GECOS field from /etc/passwd. Note that this -# variable will not be used when the user has set a real name -# in the $from variable. +# This variable contains the name of either a directory, or a file which +# contains trusted certificates for use with OpenSSL. +# (S/MIME only) # # -# set recall=ask-yes +# set smime_certificates="" # -# Name: recall -# Type: quadoption -# Default: ask-yes +# Name: smime_certificates +# Type: path +# Default: "" # # -# Controls whether or not Mutt recalls postponed messages -# when composing a new message. +# Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle +# storage and retrieval of keys by itself. This is very basic right +# now, and keys and certificates are stored in two different +# directories, both named as the hash-value retrieved from +# OpenSSL. There is an index file which contains mailbox-address +# keyid pairs, and which can be manually edited. This option points to +# the location of the certificates. +# (S/MIME only) # -# Setting this variable to is not generally useful, and thus not -# recommended. # -# Also see $postponed variable. +# set smime_decrypt_command="" +# +# Name: smime_decrypt_command +# Type: string +# Default: "" # # -# set record="~/sent" -# -# Name: record -# Type: path -# Default: "~/sent" -# -# -# This specifies the file into which your outgoing messages should be -# appended. (This is meant as the primary method for saving a copy of -# your messages, but another way to do this is using the ``my_hdr'' -# command to create a ``Bcc:'' field 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. -# -# -# set reply_regexp="^(re([\\[0-9\\]+])*|aw):[ \t]*" -# -# Name: reply_regexp -# Type: regular expression -# Default: "^(re([\\[0-9\\]+])*|aw):[ \t]*" -# -# -# A regular expression used to recognize reply messages when threading -# and replying. The default value corresponds to the English "Re:" and -# the German "Aw:". -# -# -# set reply_self=no -# -# Name: reply_self -# Type: boolean -# Default: no -# -# -# If unset and you are replying to a message sent by you, Mutt will -# assume that you want to reply to the recipients of that message rather -# than to yourself. -# -# Also see the ``alternates'' command. -# -# -# set reply_to=ask-yes -# -# Name: reply_to -# Type: quadoption -# Default: ask-yes -# -# -# If set, when replying to a message, Mutt will use the address listed -# in the Reply-to: header as the recipient of the reply. If unset, -# it will use the address in the From: header field instead. This -# option is useful for reading a mailing list that sets the Reply-To: -# header field to the list address and you want to send a private -# message to the author of a message. -# -# -# set resolve=yes -# -# Name: resolve -# Type: boolean -# Default: yes -# -# -# When set, the cursor will be automatically advanced to the next -# (possibly undeleted) message whenever a command that modifies the -# current message is executed. -# -# -# set reverse_alias=no -# -# Name: reverse_alias -# Type: boolean -# Default: no -# -# -# This variable controls whether or not Mutt will display the ``personal'' -# name from your aliases in the index menu if it finds an alias that -# matches the message's sender. For example, if you have the following -# alias: -# alias juser abd30425@somewhere.net (Joe User) -# -# and then you receive mail which contains the following header: -# From: abd30425@somewhere.net -# -# It would be displayed in the index menu as ``Joe User'' instead of -# ``abd30425@somewhere.net.'' This is useful when the person's e-mail -# address is not human friendly. -# -# -# set reverse_name=no -# -# Name: reverse_name -# Type: boolean -# Default: no +# This format string specifies a command which is used to decrypt +# application/x-pkcs7-mime attachments. # +# The OpenSSL command formats have their own set of printf(3)-like sequences +# similar to PGP's: +# %f Expands to the name of a file containing a message. +# %s Expands to the name of a file containing the signature part +# of a multipart/signed attachment when verifying it. +# %k The key-pair specified with $smime_default_key +# %c One or more certificate IDs. +# %a The algorithm used for encryption. +# %C CA location: Depending on whether $smime_ca_location +# points to a directory or file, this expands to +# ``-CApath $smime_ca_location'' or ``-CAfile $smime_ca_location''. # -# It may sometimes arrive that you receive mail to a certain machine, -# move the messages to another machine, and reply to some the messages -# from there. If this variable is set, the default From: line of -# the reply messages is built using the address where you received the -# messages you are replying to if that address matches your -# ``alternates''. If the variable is unset, or the address that would be -# used doesn't match your ``alternates'', the From: line will use -# your address on the current machine. # -# Also see the ``alternates'' command. +# For examples on how to configure these formats, see the smime.rc in +# the samples/ subdirectory which has been installed on your system +# alongside the documentation. +# (S/MIME only) # # -# set reverse_realname=yes +# set smime_decrypt_use_default_key=yes # -# Name: reverse_realname +# Name: smime_decrypt_use_default_key # Type: boolean # Default: yes # # -# This variable fine-tunes the behaviour 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. -# -# -# set rfc2047_parameters=no -# -# Name: rfc2047_parameters -# Type: boolean -# Default: no -# -# -# When this variable is set, Mutt will decode RFC2047-encoded MIME -# parameters. You want to set this variable when mutt suggests you -# to save attachments to files named like: -# =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?= -# -# When this variable is set interactively, the change won't be -# active until you change folders. -# -# Note that this use of RFC2047's encoding is explicitly -# prohibited by the standard, but nevertheless encountered in the -# wild. -# -# Also note that setting this parameter will not have the effect -# that mutt generates this kind of encoding. Instead, mutt will -# unconditionally use the encoding specified in RFC2231. +# If set (default) this tells mutt to use the default key for decryption. Otherwise, +# if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address +# to determine the key to use. It will ask you to supply a key, if it can't find one. +# (S/MIME only) # # -# set save_address=no +# set smime_default_key="" # -# Name: save_address -# Type: boolean -# Default: no +# Name: smime_default_key +# Type: string +# Default: "" # # -# If set, mutt will take the sender's full address when choosing a -# default folder for saving a mail. If $save_name or $force_name -# is set too, the selection of the Fcc folder will be changed as well. +# This is the default key-pair to use for signing. This must be set to the +# keyid (the hash-value that OpenSSL generates) to work properly +# (S/MIME only) # # -# set save_empty=yes +# set smime_encrypt_command="" # -# Name: save_empty -# Type: boolean -# Default: yes +# Name: smime_encrypt_command +# Type: string +# Default: "" # # -# When unset, mailboxes which contain no saved messages will be removed -# when closed (the exception is $spoolfile which is never removed). -# If set, mailboxes are never removed. +# This command is used to create encrypted S/MIME messages. # -# Note: This only applies to mbox and MMDF folders, Mutt does not -# delete MH and Maildir directories. +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # -# set save_history=0 +# set smime_encrypt_with="" # -# Name: save_history -# Type: number -# Default: 0 +# Name: smime_encrypt_with +# Type: string +# Default: "" # # -# This variable controls the size of the history (per category) saved in the -# $history_file file. +# This sets the algorithm that should be used for encryption. +# Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``rc2-128''. +# If unset, ``3des'' (TripleDES) is used. +# (S/MIME only) # # -# set save_name=no +# set smime_get_cert_command="" # -# Name: save_name -# Type: boolean -# Default: no +# Name: smime_get_cert_command +# Type: string +# Default: "" # # -# This variable controls how copies of outgoing messages are saved. -# When set, a check is made to see if a mailbox specified by the -# recipient address exists (this is done by searching for a mailbox in -# the $folder directory with the username part of the -# recipient address). If the mailbox exists, the outgoing message will -# be saved to that mailbox, otherwise the message is saved to the -# $record mailbox. +# This command is used to extract X509 certificates from a PKCS7 structure. # -# Also see the $force_name variable. +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # -# set score=yes +# set smime_get_cert_email_command="" # -# Name: score -# Type: boolean -# Default: yes -# -# -# When this variable is unset, scoring is turned off. This can -# be useful to selectively disable scoring for certain folders when the -# $score_threshold_delete variable and related are used. -# +# Name: smime_get_cert_email_command +# Type: string +# Default: "" # -# set score_threshold_delete=-1 -# -# Name: score_threshold_delete -# Type: number -# Default: -1 # +# This command is used to extract the mail address(es) used for storing +# X509 certificates, and for verification purposes (to check whether the +# certificate was issued for the sender's mailbox). # -# Messages which have been assigned a score equal to or lower than the value -# of this variable are automatically marked for deletion by mutt. Since -# mutt scores are always greater than or equal to zero, the default setting -# of this variable will never mark a message for deletion. +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # -# set score_threshold_flag=9999 +# set smime_get_signer_cert_command="" # -# Name: score_threshold_flag -# Type: number -# Default: 9999 -# -# -# Messages which have been assigned a score greater than or equal to this -# variable's value are automatically marked "flagged". -# +# Name: smime_get_signer_cert_command +# Type: string +# Default: "" # -# set score_threshold_read=-1 -# -# Name: score_threshold_read -# Type: number -# Default: -1 # +# This command is used to extract only the signers X509 certificate from a S/MIME +# signature, so that the certificate's owner may get compared to the +# email's ``From:'' field. # -# Messages which have been assigned a score equal to or lower than the value -# of this variable are automatically marked as read by mutt. Since -# mutt scores are always greater than or equal to zero, the default setting -# of this variable will never mark a message read. +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # -# set send_charset="us-ascii:iso-8859-1:utf-8" +# set smime_import_cert_command="" # -# Name: send_charset +# Name: smime_import_cert_command # Type: string -# Default: "us-ascii:iso-8859-1:utf-8" -# -# -# A colon-delimited list of character sets for outgoing messages. Mutt will use the -# first character set into which the text can be converted exactly. -# If your $charset is not ``iso-8859-1'' and recipients may not -# understand ``UTF-8'', it is advisable to include in the list an -# appropriate widely used standard character set (such as -# ``iso-8859-2'', ``koi8-r'' or ``iso-2022-jp'') either instead of or after -# ``iso-8859-1''. -# -# In case the text cannot be converted into one of these exactly, -# mutt uses $charset as a fallback. +# Default: "" # # -# set sendmail="/usr/sbin/sendmail -oem -oi" -# -# Name: sendmail -# Type: path -# Default: "/usr/sbin/sendmail -oem -oi" -# +# This command is used to import a certificate via smime_keys. # -# Specifies the program and arguments used to deliver mail sent by Mutt. -# Mutt expects that the specified program interprets additional -# arguments as recipient addresses. +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # -# set sendmail_wait=0 +# set smime_is_default=no # -# Name: sendmail_wait -# Type: number -# Default: 0 -# -# -# Specifies the number of seconds to wait for the $sendmail process -# to finish before giving up and putting delivery in the background. -# -# Mutt interprets the value of this variable as follows: -# >0 number of seconds to wait for sendmail to finish before continuing -# 0 wait forever for sendmail to finish -# <0 always put sendmail in the background without waiting +# Name: smime_is_default +# Type: boolean +# Default: no # # -# Note that if you specify a value other than 0, the output of the child -# process will be put in a temporary file. If there is some error, you -# will be informed as to where to find the output. +# The default behaviour of mutt is to use PGP on all auto-sign/encryption +# operations. To override and to use OpenSSL instead this must be set. +# However, this has no effect while replying, since mutt will automatically +# select the same application that was used to sign/encrypt the original +# message. (Note that this variable can be overridden by unsetting $crypt_autosmime.) +# (S/MIME only) # # -# set shell="" +# set smime_keys="" # -# Name: shell +# Name: smime_keys # Type: path # Default: "" # # -# Command to use when spawning a subshell. By default, the user's login -# shell from /etc/passwd is used. +# Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle +# storage and retrieval of keys/certs by itself. This is very basic right now, +# and stores keys and certificates in two different directories, both +# named as the hash-value retrieved from OpenSSL. There is an index file +# which contains mailbox-address keyid pair, and which can be manually +# edited. This option points to the location of the private keys. +# (S/MIME only) # # -# set sig_dashes=yes +# set smime_pk7out_command="" # -# Name: sig_dashes -# Type: boolean -# Default: yes -# -# -# If set, a line containing ``-- '' (note the trailing space) will be inserted before your -# $signature. It is strongly recommended that you not unset -# this variable unless your signature contains just your name. The -# reason for this is because many software packages use ``-- \n'' to -# detect your signature. For example, Mutt has the ability to highlight -# the signature in a different color in the builtin pager. +# Name: smime_pk7out_command +# Type: string +# Default: "" # # -# set sig_on_top=no -# -# Name: sig_on_top -# Type: boolean -# Default: no -# +# This command is used to extract PKCS7 structures of S/MIME signatures, +# in order to extract the public X509 certificate(s). # -# If set, the signature will be included before any quoted or forwarded -# text. It is strongly recommended that you do not set this variable -# unless you really know what you are doing, and are prepared to take -# some heat from netiquette guardians. +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # -# set signature="~/.signature" +# set smime_sign_command="" # -# Name: signature -# Type: path -# Default: "~/.signature" +# Name: smime_sign_command +# Type: string +# Default: "" # # -# Specifies the filename of your signature, which is appended to all -# outgoing messages. If the filename ends with a pipe (``|''), it is -# assumed that filename is a shell command and input should be read from -# its standard output. +# This command is used to created S/MIME signatures of type +# multipart/signed, which can be read by all mail clients. +# +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # -# set simple_search="~f %s | ~s %s" +# set smime_sign_opaque_command="" # -# Name: simple_search +# Name: smime_sign_opaque_command # Type: string -# Default: "~f %s | ~s %s" +# Default: "" # # -# 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. See ``patterns'' for more information on search patterns. +# This command is used to created S/MIME signatures of type +# application/x-pkcs7-signature, which can only be handled by mail +# clients supporting the S/MIME extension. # -# For example, if you simply type ``joe'' at a search or limit prompt, Mutt -# will automatically expand it to the value specified by this variable by -# replacing ``%s'' with the supplied string. -# For the default value, ``joe'' would be expanded to: ``~f joe | ~s joe''. +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # -# set smart_wrap=yes +# set smime_timeout=300 # -# Name: smart_wrap -# Type: boolean -# Default: yes +# Name: smime_timeout +# Type: number +# Default: 300 # # -# Controls the display of lines longer than the screen width in the -# internal pager. If set, long lines are wrapped at a word boundary. If -# unset, lines are simply wrapped at the screen edge. Also see the -# $markers variable. +# The number of seconds after which a cached passphrase will expire if +# not used. +# (S/MIME only) # # -# set smileys="(>From )|(:[-^]?[][)(><}{|/DP])" +# set smime_verify_command="" # -# Name: smileys -# Type: regular expression -# Default: "(>From )|(:[-^]?[][)(><}{|/DP])" +# Name: smime_verify_command +# Type: string +# Default: "" # # -# The pager uses this variable to catch some common false -# positives of $quote_regexp, most notably smileys and not consider -# a line quoted text if it also matches $smileys. This mostly -# happens at the beginning of a line. +# This command is used to verify S/MIME signatures of type multipart/signed. # +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # -# set sleep_time=1 +# +# set smime_verify_opaque_command="" # -# Name: sleep_time -# Type: number -# Default: 1 +# Name: smime_verify_opaque_command +# Type: string +# Default: "" # # -# Specifies time, in seconds, to pause while displaying certain informational -# messages, while moving from folder to folder and after expunging -# messages from the current folder. The default is to pause one second, so -# a value of zero for this option suppresses the pause. +# This command is used to verify S/MIME signatures of type +# application/x-pkcs7-mime. +# +# This is a format string, see the $smime_decrypt_command command for +# possible printf(3)-like sequences. +# (S/MIME only) # # # set smtp_authenticators="" @@ -4067,7 +3987,7 @@ attachments -I message/external-body # delivery. This should take the form of an SMTP URL, eg: # smtp[s]://[user[:pass]@]host[:port]/ # -# ... where ``[...]'' denotes an optional part. +# where ``[...]'' denotes an optional part. # Setting this variable overrides the value of the $sendmail # variable. # @@ -4196,8 +4116,143 @@ attachments -I message/external-body # # If your spool mailbox is in a non-default place where Mutt cannot find # it, you can specify its location with this variable. Mutt will -# automatically set this variable to the value of the environment -# variable $MAIL if it is not set. +# initially set this variable to the value of the environment +# variable $MAIL or $MAILDIR if either is defined. +# +# +# set ssl_ca_certificates_file="" +# +# Name: ssl_ca_certificates_file +# Type: path +# Default: "" +# +# +# This variable specifies a file containing trusted CA certificates. +# Any server certificate that is signed with one of these CA +# certificates is also automatically accepted. +# +# Example: +# set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt +# +# +# set ssl_client_cert="" +# +# Name: ssl_client_cert +# Type: path +# Default: "" +# +# +# The file containing a client certificate and its associated private +# key. +# +# +# set ssl_force_tls=no +# +# Name: ssl_force_tls +# Type: boolean +# Default: no +# +# +# 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 server does not advertise the capability, +# since it would otherwise have to abort the connection anyway. This +# option supersedes $ssl_starttls. +# +# +# set ssl_min_dh_prime_bits=0 +# +# Name: ssl_min_dh_prime_bits +# Type: number +# Default: 0 +# +# +# This variable specifies the minimum acceptable prime size (in bits) +# for use in any Diffie-Hellman key exchange. A value of 0 will use +# the default from the GNUTLS library. +# +# +# set ssl_starttls=yes +# +# Name: ssl_starttls +# Type: quadoption +# Default: yes +# +# +# If set (the default), mutt will attempt to use STARTTLS on servers +# advertising the capability. When unset, mutt will not attempt to +# use STARTTLS regardless of the server's capabilities. +# +# +# set ssl_use_sslv2=no +# +# Name: ssl_use_sslv2 +# Type: boolean +# Default: no +# +# +# This variable specifies whether to attempt to use SSLv2 in the +# SSL authentication process. +# +# +# set ssl_use_sslv3=yes +# +# Name: ssl_use_sslv3 +# Type: boolean +# Default: yes +# +# +# This variable specifies whether to attempt to use SSLv3 in the +# SSL authentication process. +# +# +# set ssl_use_tlsv1=yes +# +# Name: ssl_use_tlsv1 +# Type: boolean +# Default: yes +# +# +# This variable specifies whether to attempt to use TLSv1 in the +# SSL authentication process. +# +# +# set ssl_usesystemcerts=yes +# +# Name: ssl_usesystemcerts +# Type: boolean +# Default: yes +# +# +# If set to yes, mutt will use CA certificates in the +# system-wide certificate store when checking if a server certificate +# is signed by a trusted CA. +# +# +# set ssl_verify_dates=yes +# +# Name: ssl_verify_dates +# Type: boolean +# Default: yes +# +# +# If set (the default), mutt will not automatically accept a server +# certificate that is either not yet valid or already expired. You should +# only unset this for particular known hosts, using the +# function. +# +# +# set ssl_verify_host=yes +# +# Name: ssl_verify_host +# Type: boolean +# Default: yes +# +# +# If set (the default), mutt will not automatically accept a server +# certificate whose host name does not match the host used in your folder +# URL. You should only unset this for particular known hosts, using +# the function. # # # set status_chars="-*%A" @@ -4353,17 +4408,6 @@ attachments -I message/external-body # Note that $indent_string is ignored when this option is set. # # -# set thread_received=no -# -# Name: thread_received -# Type: boolean -# Default: no -# -# -# When set, mutt uses the date received rather than the date sent -# to thread messages by subject. -# -# # set thorough_search=no # # Name: thorough_search @@ -4383,6 +4427,17 @@ attachments -I message/external-body # headers) which may lead to incorrect search results. # # +# set thread_received=no +# +# Name: thread_received +# Type: boolean +# Default: no +# +# +# When set, mutt uses the date received rather than the date sent +# to thread messages by subject. +# +# # set tilde=no # # Name: tilde @@ -4477,6 +4532,21 @@ attachments -I message/external-body # Note: For this example to work you must be able to log in to the remote # machine without having to enter a password. # +# When set, Mutt uses the tunnel for all remote connections. +# Please see ``account-hook'' in the manual for how to use different +# tunnel commands per connection. +# +# +# set uncollapse_jump=no +# +# Name: uncollapse_jump +# Type: boolean +# Default: no +# +# +# When set, Mutt will jump to the next unread message, if any, +# when the current thread is uncollapsed. +# # # set use_8bitmime=no # @@ -4649,6 +4719,20 @@ attachments -I message/external-body # (DEPRECATED) Equivalent to setting $wrap with a negative value. # # +# set write_bcc=yes +# +# Name: write_bcc +# Type: boolean +# Default: yes +# +# +# 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. +# +# # set write_inc=10 # # Name: write_inc @@ -4664,17 +4748,3 @@ attachments -I message/external-body # ``tuning'' section of the manual for performance considerations. # # -# set write_bcc=yes -# -# Name: write_bcc -# Type: boolean -# Default: yes -# -# -# 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. -# -#