# System configuration file for Mutt
#
-# default list of header fields to weed when displaying
-#
-ignore "from " received content- mime-version status x-status message-id
-ignore sender references return-path lines
+# Default list of header fields to weed when displaying.
+# Ignore all lines by default...
+ignore *
+
+# ... then allow these through.
+unignore from: subject to cc date x-mailer x-url user-agent
+
+# Display the fields in this order
+hdr_order date from to cc subject
# imitate the old search-body function
macro index \eb "<search>~b " "search in message bodies"
#
# set use_8bitmime
+# Use mime.types to look up handlers for application/octet-stream. Can
+# be undone with unmime_lookup.
+mime_lookup application/octet-stream
+
##
## *** DEFAULT SETTINGS FOR THE ATTACHMENTS PATCH ***
##
## line is unnecessary if you already have "attach-allow */.*", of
## course. These are off by default! The MIME elements contained
## within a message/* or multipart/* are still examined, even if the
-## containers themseves don't qualify.
+## containers themselves don't qualify.
##
#attachments +A message/.* multipart/.*
#attachments +I message/.* multipart/.*
# Default: "~/.muttrc"
#
#
-# The default file in which to save aliases created by the
-# ``create-alias'' function.
+# The default file in which to save aliases created by the
+# <create-alias> function. Entries added to this file are
+# encoded in the character set specified by $config_charset if it
+# is set or the current character set otherwise.
#
# Note: Mutt will not automatically source this file; you must
-# explicitly use the ``source'' command for it to be executed.
+# explicitly use the ``source'' command for it to be executed in case
+# this option points to a dedicated alias file.
#
# The default for this option is the currently used muttrc file, or
# ``~/.muttrc'' if no user muttrc was found.
# Default: "%4n %2f %t %-10a %r"
#
#
-# Specifies the format of the data displayed for the `alias' menu. The
+# Specifies the format of the data displayed for the ``alias'' menu. The
# following printf(3)-style sequences are available:
-#
# %a alias name
-# %f flags - currently, a "d" for an alias marked for deletion
+# %f flags - currently, a ``d'' for an alias marked for deletion
# %n index number
# %r address which alias expands to
# %t character which indicates if the alias is tagged for inclusion
# Default: no
#
#
-# Controls whether ANSI color codes in messages (and color tags in
+# Controls whether ANSI color codes in messages (and color tags in
# rich text messages) are to be interpreted.
# Messages containing these codes are rare, but if this option is set,
# their text will be colored accordingly. Note that this may override
# your color choices, and even present a security problem, since a
-# message could include a line like "[-- PGP output follows ..." and
-# give it the same color as your attachment color.
+# message could include a line like
+# [-- PGP output follows ...
+#
+# and give it the same color as your attachment color (see also
+# $crypt_timestamp).
#
#
# set arrow_cursor=no
# Header field values and message body content without character encoding
# indication would be assumed that they are written in one of this list.
# By default, all the header fields and message body without any charset
-# indication are assumed to be in "us-ascii".
+# indication are assumed to be in ``us-ascii''.
#
# For example, Japanese users might prefer this:
-#
# set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
#
# However, only the first content is valid for the message body.
#
#
# This variable is a colon-separated list of character encoding
-# schemes for text file attachments.
-# If unset, $charset value will be used instead.
+# 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:
-#
# set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
#
-# Note: "iso-2022-*" must be put at the head of the value as shown above
-# if included.
+# Note: for Japanese users, ``iso-2022-*'' must be put at the head
+# of the value as shown above if included.
#
#
# set attach_format="%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
# Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "
#
#
-# This variable describes the format of the `attachment' menu. The
-# following printf-style sequences are understood:
-#
+# This variable describes the format of the ``attachment'' menu. The
+# following printf(3)-style sequences are understood:
# %C charset
-# %c requires charset conversion (n or c)
+# %c requires charset conversion (``n'' or ``c'')
# %D deleted flag
# %d description
# %e MIME content-transfer-encoding
# %f filename
-# %I disposition (I=inline, A=attachment)
+# %I disposition (``I'' for inline, ``A'' for attachment)
# %m major MIME type
# %M MIME subtype
# %n attachment number
-# %Q "Q", if MIME part qualifies for attachment counting
+# %Q ``Q'', if MIME part qualifies for attachment counting
# %s size
# %t tagged flag
# %T graphic tree characters
# %u unlink (=to delete) flag
# %X number of qualifying MIME parts in this part and its children
# (please see the ``attachments'' section for possible speed effects)
-# %>X right justify the rest of the string and pad with character "X"
-# %|X pad to the end of the line with character "X"
-# %*X soft-fill with character "X" as pad
+# %>X right justify the rest of the string and pad with character ``X''
+# %|X pad to the end of the line with character ``X''
+# %*X soft-fill with character ``X'' as pad
#
#
-# For an explanation of `soft-fill', see the ``$index_format'' documentation.
+# For an explanation of ``soft-fill'', see the $index_format documentation.
#
#
# set attach_sep="\n"
# If this variable is unset, when operating (saving, printing, piping,
# etc) on a list of tagged attachments, Mutt will concatenate the
# attachments and will operate on them as a single attachment. The
-# ``$attach_sep'' separator is added after each attachment. When set,
+# $attach_sep separator is added after each attachment. When set,
# Mutt will operate on the attachments one by one.
#
#
#
#
# This is the string that will precede a message which has been included
-# in a reply. For a full listing of defined printf()-like sequences see
-# the section on ``$index_format''.
+# in a reply. For a full listing of defined printf(3)-like sequences see
+# the section on $index_format.
#
#
-# set autoedit=no
+# set auto_tag=no
#
-# Name: autoedit
+# Name: auto_tag
# Type: boolean
# Default: no
#
#
-# When set along with ``$edit_headers'', Mutt will skip the initial
-# send-menu and allow you to immediately begin editing the body of your
-# message. The send-menu may still be accessed once you have finished
-# editing the body of your message.
-#
-# Also see ``$fast_reply''.
+# 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 <tag-prefix> function (bound to ``;''
+# by default) to make the next function apply to all tagged messages.
#
#
-# set auto_tag=no
+# set autoedit=no
#
-# Name: auto_tag
+# Name: autoedit
# 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 tag-prefix function (default: ";") to
-# make the next function apply to all tagged messages.
+# When set along with $edit_headers, Mutt will skip the initial
+# send-menu (prompting for subject and recipients) and allow you to
+# immediately begin editing the body of your
+# message. The send-menu may still be accessed once you have finished
+# editing the body of your message.
+#
+# 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.
+#
+# Also see $fast_reply.
#
#
# set beep=yes
#
# When this variable is set, mutt will beep whenever it prints a message
# notifying you of new mail. This is independent of the setting of the
-# ``$beep'' variable.
+# $beep variable.
#
#
# set bounce=ask-yes
#
#
# When this variable is set, mutt will place the cursor at the beginning
-# of the current line in menus, even when the arrow_cursor variable
-# is unset, making it easier for blind persons using Braille displays to
-# follow these menus. The option is disabled by default because many
+# of the current line in menus, even when the $arrow_cursor variable
+# is unset, making it easier for blind persons using Braille displays to
+# follow these menus. The option is unset by default because many
# 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.
+# 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.
+#
+# Example:
+# set certificate_file=~/.mutt/certificates
#
#
# set charset=""
# Character set your terminal uses to display and enter textual data.
# It is also the fallback for $send_charset.
#
+# Upon startup Mutt tries to derive this value from environment variables
+# such as $LC_CTYPE or $LANG.
+#
+# Note: It should only be set in case Mutt isn't able to determine the
+# 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
#
# mailbox is open. Especially with MH mailboxes, this operation can
# take quite some time since it involves scanning the directory and
# checking each file to see if it has already been looked at. If
-# check_new is unset, no check for new mail is performed
+# this variable is unset, no check for new mail is performed
# while the mailbox is open.
#
#
# 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
# Default: "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-"
#
#
-# Controls the format of the status line displayed in the Compose
-# menu. This string is similar to ``$status_format'', but has its own
-# set of printf()-like sequences:
-#
-# %a total number of attachments
+# Controls the format of the status line displayed in the ``compose''
+# menu. This string is similar to $status_format, but has its own
+# set of printf(3)-like sequences:
+# %a total number of attachments
# %h local hostname
# %l approximate size (in bytes) of the current message
# %v Mutt version string
#
#
-# See the text describing the ``$status_format'' option for more
-# information on how to set ``$compose_format''.
+# See the text describing the $status_format option for more
+# information on how to set $compose_format.
#
#
# set config_charset=""
#
#
# When defined, Mutt will recode commands in rc files from this
-# encoding.
+# encoding to the current character set as specified by $charset
+# and aliases written to $alias_file from the current character set.
+#
+# Please note that if setting $charset it must be done before
+# setting $config_charset.
+#
+# Recoding should be avoided as it may render unconvertable
+# characters as question marks which can lead to undesired
+# side effects (for example in regular expressions).
#
#
# set confirmappend=yes
# Default: 30
#
#
-# Causes Mutt to timeout a network connection (for IMAP or POP) after this
+# Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
# many seconds if the connection is not able to be established. A negative
-# value causes Mutt to wait indefinitely for the connection to succeed.
+# value causes Mutt to wait indefinitely for the connection attempt to succeed.
#
#
# set content_type="text/plain"
#
#
# This variable controls whether or not copies of your outgoing messages
-# will be saved for later references. Also see ``$record'',
-# ``$save_name'', ``$force_name'' and ``fcc-hook''.
+# will be saved for later references. Also see $record,
+# $save_name, $force_name and ``fcc-hook''.
#
#
-# set crypt_use_gpgme=no
+# set crypt_autoencrypt=no
#
-# Name: crypt_use_gpgme
+# Name: crypt_autoencrypt
# 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.
+# 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_use_pka=no
+# set crypt_autopgp=yes
#
-# Name: crypt_use_pka
+# Name: crypt_autopgp
# Type: boolean
-# Default: no
+# Default: yes
#
#
-# (http://www.g10code.de/docs/pka-intro.de.pdf) during signature
-# verification (only supported by the GPGME backend).
+# This variable controls whether or not mutt may automatically enable
+# PGP encryption/signing for messages. See also $crypt_autoencrypt,
+# $crypt_replyencrypt,
+# $crypt_autosign, $crypt_replysign and $smime_is_default.
#
#
-# set crypt_autopgp=yes
+# set crypt_autosign=no
#
-# Name: crypt_autopgp
+# Name: crypt_autosign
# Type: boolean
-# Default: yes
+# Default: no
#
#
-# This variable controls whether or not mutt may automatically enable
-# PGP encryption/signing for messages. See also ``$crypt_autoencrypt'',
-# ``$crypt_replyencrypt'',
-# ``$crypt_autosign'', ``$crypt_replysign'' and ``$smime_is_default''.
+# 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
#
#
# This variable controls whether or not mutt may automatically enable
-# S/MIME encryption/signing for messages. See also ``$crypt_autoencrypt'',
-# ``$crypt_replyencrypt'',
-# ``$crypt_autosign'', ``$crypt_replysign'' and ``$smime_is_default''.
+# S/MIME encryption/signing for messages. See also $crypt_autoencrypt,
+# $crypt_replyencrypt,
+# $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 ``no'', never attempt to verify cryptographic signatures.
+# (Crypto only)
#
#
# set date_format="!%a, %b %d, %Y at %I:%M:%S%p %Z"
#
#
# This variable controls the format of the date printed by the ``%d''
-# sequence in ``$index_format''. This is passed to the strftime
-# call to process the date. See the man page for strftime(3) for
-# the proper syntax.
+# sequence in $index_format. This is passed to the strftime(3)
+# function to process the date, see the man page for the proper syntax.
#
# Unless the first character in the string is a bang (``!''), the month
# and week day names are expanded according to the locale specified in
-# the variable ``$locale''. If the first character in the string is a
+# the variable $locale. If the first character in the string is a
# bang, the bang is discarded, and the month and week day names in the
# rest of the string are expanded in the C locale (that is in US
# English).
# Default: "~f %s !~P | (~P ~C %s)"
#
#
-# This variable controls how message-hooks, reply-hooks, send-hooks,
-# send2-hooks, save-hooks, and fcc-hooks will
+# This variable controls how ``message-hook'', ``reply-hook'', ``send-hook'',
+# ``send2-hook'', ``save-hook'', and ``fcc-hook'' will
# be interpreted if they are specified with only a simple regexp,
# instead of a matching pattern. The hooks are expanded when they are
# declared, so a hook will be interpreted according to the value of this
-# variable at the time the hook is declared. The default value matches
+# variable at the time the hook is declared.
+#
+# The default value matches
# if the message is either from a user matching the regular expression
# given, or if it is from you (if the from address matches
# ``alternates'') and is to or cc'ed to a user matching the given
#
#
# If this option is set, mutt's received-attachments menu will not show the subparts of
-# individual messages in a multipart/digest. To see these subparts, press 'v' on that menu.
+# individual messages in a multipart/digest. To see these subparts, press ``v'' on that menu.
#
#
# set display_filter=""
# Default: "/usr/local/bin/mutt_dotlock"
#
#
-# Contains the path of the mutt_dotlock (8) binary to be used by
+# Contains the path of the mutt_dotlock(8) binary to be used by
# mutt.
#
#
# delay, to be notified of message delays, success, to be
# notified of successful transmission.
#
-# Example: set dsn_notify="failure,delay"
+# Example:
+# set dsn_notify="failure,delay"
#
# Note: when using $sendmail for delivery, you should not enable
# this unless you are either using Sendmail 8.8.x or greater or a MTA
# providing a sendmail(1)-compatible interface supporting the -N option
-# for DSN. For SMTP delivery, it depends on the server whether DSN is
-# supported or not.
+# for DSN. For SMTP delivery, DSN support is auto-detected so that it
+# depends on the server whether DSN will be used or not.
#
#
# set dsn_return=""
# messages. It may be set to either hdrs to return just the
# message header, or full to return the full message.
#
-# Example: set dsn_return=hdrs
+# Example:
+# set dsn_return=hdrs
#
# Note: when using $sendmail for delivery, you should not enable
# this unless you are either using Sendmail 8.8.x or greater or a MTA
# providing a sendmail(1)-compatible interface supporting the -R option
-# for DSN. For SMTP delivery, it depends on the server whether DSN is
-# supported or not.
+# for DSN. For SMTP delivery, DSN support is auto-detected so that it
+# depends on the server whether DSN will be used or not.
#
#
# set duplicate_threads=yes
# Default: yes
#
#
-# This variable controls whether mutt, when sorting by threads, threads
-# messages with the same message-id together. If it is set, it will indicate
+# This variable controls whether mutt, when $sort is set to threads, threads
+# messages with the same Message-Id together. If it is set, it will indicate
# that it thinks they are duplicates of each other with an equals sign
-# in the thread diagram.
+# in the thread tree.
#
#
# set edit_headers=no
#
#
# This variable specifies which editor is used by mutt.
-# It defaults to the value of the VISUAL, or EDITOR, environment
-# variable, or to the string "vi" if neither of those are set.
+# It defaults to the value of the $VISUAL, or $EDITOR, environment
+# variable, or to the string ``vi'' if neither of those are set.
#
#
# set encode_from=no
#
#
# When set, mutt will quoted-printable encode messages when
-# they contain the string "From " in the beginning of a line.
-# Useful to avoid the tampering certain mail delivery and transport
-# agents tend to do with messages.
+# they contain the string ``From '' (note the trailing space) in the beginning of a line.
+# This is useful to avoid the tampering certain mail delivery and transport
+# agents tend to do with messages (in order to prevent tools from
+# 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=""
#
#
# Manually sets the envelope sender for outgoing messages.
-# This value is ignored if ``$use_envelope_from'' is unset.
+# This value is ignored if $use_envelope_from is unset.
#
#
# set escape="~"
# Default: "~"
#
#
-# Escape character to use for functions in the builtin editor.
+# Escape character to use for functions in the built-in editor.
#
#
# set fast_reply=no
# when replying to messages, and the initial prompt for subject is
# skipped when forwarding messages.
#
-# Note: this variable has no effect when the ``$autoedit''
+# Note: this variable has no effect when the $autoedit
# variable is set.
#
#
# set fcc_attach=yes
#
# Name: fcc_attach
-# Type: boolean
+# Type: quadoption
# Default: yes
#
#
# Default: "~/Mail"
#
#
-# Specifies the default location of your mailboxes. A `+' or `=' at the
+# Specifies the default location of your mailboxes. A ``+'' or ``='' at the
# beginning of a pathname will be expanded to the value of this
-# variable. Note that if you change this variable from the default
+# variable. Note that if you change this variable (from the default)
# value you need to make sure that the assignment occurs before
-# you use `+' or `=' for any other variables since expansion takes place
-# during the `set' command.
+# you use ``+'' or ``='' for any other variables since expansion takes place
+# when handling the ``mailboxes'' command.
#
#
# set folder_format="%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"
#
#
# This variable allows you to customize the file browser display to your
-# personal taste. This string is similar to ``$index_format'', but has
-# its own set of printf()-like sequences:
-#
+# personal taste. This string is similar to $index_format, but has
+# its own set of printf(3)-like sequences:
# %C current file number
# %d date/time folder was last modified
-# %f filename
+# %D date/time folder was last modified using $date_format.
+# %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
# %N N if folder has new mail, blank otherwise
# %s size in bytes
-# %t * if the file is tagged, blank otherwise
+# %t ``*'' if the file is tagged, blank otherwise
# %u owner name (or numeric uid, if missing)
-# %>X right justify the rest of the string and pad with character "X"
-# %|X pad to the end of the line with character "X"
-# %*X soft-fill with character "X" as pad
+# %>X right justify the rest of the string and pad with character ``X''
+# %|X pad to the end of the line with character ``X''
+# %*X soft-fill with character ``X'' as pad
#
#
-# For an explanation of `soft-fill', see the ``$index_format'' documentation.
+# For an explanation of ``soft-fill'', see the $index_format documentation.
#
#
# set followup_to=yes
# Default: yes
#
#
-# Controls whether or not the Mail-Followup-To header field is
+# Controls whether or not the ``Mail-Followup-To:'' header field is
# generated when sending mail. When set, Mutt will generate this
# field when you are replying to a known mailing list, specified with
# the ``subscribe'' or ``lists'' commands.
# receiving duplicate copies of replies to messages which you send
# to mailing lists, and second, ensuring that you do get a reply
# separately for any messages sent to known lists to which you are
-# not subscribed. The header will contain only the list's address
+# not subscribed.
+#
+# The header will contain only the list's address
# for subscribed lists, and both the list address and your own
# email address for unsubscribed lists. Without this header, a
# group reply to your message sent to a subscribed list will be
# Default: no
#
#
-# This variable is similar to ``$save_name'', except that Mutt will
+# This variable is similar to $save_name, except that Mutt will
# store a copy of your outgoing message by the username of the address
# you are sending to even if that mailbox does not exist.
#
-# Also see the ``$record'' variable.
+# Also see the $record variable.
#
#
# set forward_decode=yes
#
# Controls the decoding of complex MIME messages into text/plain when
# forwarding a message. The message header is also RFC2047 decoded.
-# This variable is only used, if ``$mime_forward'' is unset,
-# otherwise ``$mime_forward_decode'' is used instead.
+# This variable is only used, if $mime_forward is unset,
+# 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
#
#
# This variable controls the default subject when forwarding a message.
-# It uses the same format sequences as the ``$index_format'' variable.
+# It uses the same format sequences as the $index_format variable.
#
#
# set forward_quote=no
# Default: no
#
#
-# When set forwarded messages included in the main body of the
-# message (when ``$mime_forward'' is unset) will be quoted using
-# ``$indent_string''.
+# When set, forwarded messages included in the main body of the
+# message (when $mime_forward is unset) will be quoted using
+# $indent_string.
#
#
# set from=""
#
#
# When set, this variable contains a default from address. It
-# can be overridden using my_hdr (including from send-hooks) and
-# ``$reverse_name''. This variable is ignored if ``$use_from''
-# is unset.
+# can be overridden using ``my_hdr'' (including from a ``send-hook'') and
+# $reverse_name. This variable is ignored if $use_from is unset.
#
-# Defaults to the contents of the environment variable EMAIL.
+# This setting defaults to the contents of the environment variable $EMAIL.
#
#
# set gecos_mask="^[^,]*"
#
#
# A regular expression used by mutt to parse the GECOS field of a password
-# entry when expanding the alias. By default the regular expression is set
-# to "^[^,]*" which will return the string up to the first "," encountered.
-# If the GECOS field contains a string like "lastname, firstname" then you
-# should set the gecos_mask=".*".
-#
-# This can be useful if you see the following behavior: you address a 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
+# entry when expanding the alias. The default value
+# will return the string up to the first ``,'' encountered.
+# 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 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
-# "Franklin" to "Franklin, Steve".
+# ``Franklin'' to ``Franklin, Steve''.
#
#
# set hdrs=yes
#
# When set, this variable causes Mutt to include the header
# of the message you are replying to into the edit buffer.
-# The ``$weed'' setting applies.
+# The $weed setting applies.
#
#
-# set help=yes
+# set header_cache=""
#
-# Name: help
-# Type: boolean
-# Default: yes
+# Name: header_cache
+# Type: path
+# Default: ""
#
#
-# When set, help lines describing the bindings for the major functions
-# provided by each menu are displayed on the first line of the screen.
+# 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.
#
-# Note: The binding will not be displayed correctly if the
-# function is bound to a sequence rather than a single keystroke. Also,
-# the help line may not be updated if a binding is changed while Mutt is
-# running. Since this variable is primarily aimed at new users, neither
-# of these should present a major problem.
+# Header caching can greatly improve speed when opening POP, IMAP
+# MH or Maildir folders, see ``caching'' for details.
#
#
-# set hidden_host=no
+# set header_cache_compress=yes
#
-# Name: hidden_host
+# Name: header_cache_compress
# Type: boolean
-# Default: no
+# Default: yes
#
#
-# When set, mutt will skip the host name part of ``$hostname'' variable
-# when adding the domain part to addresses. This variable does not
-# affect the generation of Message-IDs, and it will not lead to the
-# cut-off of first-level domains.
+# 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 decompression can result in a
+# slower opening of cached folder(s) which in general is still
+# much faster than opening non header cached folders.
#
#
-# set hide_limited=no
+# set header_cache_pagesize="16384"
#
-# Name: hide_limited
-# Type: boolean
-# Default: no
-#
+# 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
+# Default: yes
+#
+#
+# When set, help lines describing the bindings for the major functions
+# provided by each menu are displayed on the first line of the screen.
+#
+# Note: The binding will not be displayed correctly if the
+# function is bound to a sequence rather than a single keystroke. Also,
+# the help line may not be updated if a binding is changed while Mutt is
+# running. Since this variable is primarily aimed at new users, neither
+# of these should present a major problem.
+#
+#
+# set hidden_host=no
+#
+# Name: hidden_host
+# Type: boolean
+# Default: no
+#
+#
+# When set, mutt will skip the host name part of $hostname variable
+# when adding the domain part to addresses. This variable does not
+# affect the generation of Message-IDs, and it will not lead to the
+# cut-off of first-level domains.
+#
+#
+# set hide_limited=no
+#
+# Name: hide_limited
+# Type: boolean
+# Default: no
+#
#
# When set, mutt will not show the presence of messages that are hidden
# by limiting, in the thread tree.
#
#
# This variable controls the size (in number of strings remembered) of
-# the string history buffer. The buffer is cleared each time the
+# the string history buffer per category. The buffer is cleared each time the
# variable is set.
#
#
# 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
# can be compiled with a fixed domain name in which case a detected
# one is not used.
#
-# Also see ``$use_domain'' and ``$hidden_host''.
+# Also see $use_domain and $hidden_host.
#
#
# set ignore_linear_white_space=no
#
#
# This option replaces linear-white-space between encoded-word
-# and *text to a single space to prevent the display of MIME-encoded
-# ``Subject'' field from being divided into multiple lines.
+# and text to a single space to prevent the display of MIME-encoded
+# ``Subject:'' field from being divided into multiple lines.
#
#
# set ignore_list_reply_to=no
# Default: no
#
#
-# Affects the behaviour of the reply function when replying to
+# Affects the behavior of the <reply> function when replying to
# messages from mailing lists (as defined by the ``subscribe'' or
# ``lists'' commands). When set, if the ``Reply-To:'' field is
# set to the same value as the ``To:'' field, Mutt assumes that the
# ``Reply-To:'' field was set by the mailing list to automate responses
# to the list, and will ignore this field. To direct a response to the
-# mailing list when this option is set, use the list-reply
-# function; group-reply will reply to both the sender and the
+# mailing list when this option is set, use the <list-reply>
+# function; <group-reply> will reply to both the sender and the
# list.
#
#
#
# This is a colon-delimited list of authentication methods mutt may
# attempt to use to log in to an IMAP server, in the order mutt should
-# try them. Authentication methods are either 'login' or the right
-# side of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5', 'gssapi'
-# or 'cram-md5'. This parameter is case-insensitive. If this
-# parameter is unset (the default) mutt will try all available methods,
+# try them. Authentication methods are either ``login'' or the right
+# side of an IMAP ``AUTH=xxx'' capability string, e.g. ``digest-md5'', ``gssapi''
+# or ``cram-md5''. This option is case-insensitive. If it's
+# unset (the default) mutt will try all available methods,
# in order from most-secure to least-secure.
#
-# Example: set imap_authenticators="gssapi:cram-md5:login"
+# Example:
+# set imap_authenticators="gssapi:cram-md5:login"
#
# Note: Mutt will only fall back to other authentication methods if
# the previous methods are unavailable. If a method is available but
#
# When set, mutt will fetch the set of subscribed folders from
# your server on connection, and add them to the set of mailboxes
-# it polls for new mail. See also the ``mailboxes'' command.
+# it polls for new mail just as if you had issued individual ``mailboxes''
+# commands.
#
#
# set imap_delim_chars="/."
#
# This contains the list of characters which you would like to treat
# as folder separators for displaying IMAP paths. In particular it
-# helps in using the '=' shortcut for your folder variable.
+# helps in using the ``='' shortcut for your folder variable.
#
#
# set imap_headers=""
#
#
# Mutt requests these header fields in addition to the default headers
-# ("DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE
-# CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL") from IMAP
+# (``Date:'', ``From:'', ``Subject:'', ``To:'', ``Cc:'', ``Message-Id:'',
+# ``References:'', ``Content-Type:'', ``Content-Description:'', ``In-Reply-To:'',
+# ``Reply-To:'', ``Lines:'', ``List-Post:'', ``X-Label:'') from IMAP
# servers before displaying the index menu. You may want to add more
-# headers for spam detection. Note: This is a space separated list.
+# headers for spam detection.
+#
+# Note: This is a space separated list, items should be uppercase
+# and not contain the colon, e.g. ``X-BOGOSITY X-SPAM-STATUS'' for the
+# ``X-Bogosity:'' and ``X-Spam-Status:'' header fields.
#
#
# set imap_idle=no
#
# This variable configures whether IMAP folder browsing will look for
# only subscribed folders or all folders. This can be toggled in the
-# IMAP browser with the toggle-subscribed function.
+# IMAP browser with the <toggle-subscribed> function.
#
#
# set imap_login=""
#
# Your login name on the IMAP server.
#
-# This variable defaults to the value of imap_user.
+# This variable defaults to the value of $imap_user.
#
#
# set imap_pass=""
#
#
# Specifies the password for your IMAP account. If unset, Mutt will
-# prompt you for your password when you invoke the fetch-mail function.
+# prompt you for your password when you invoke the <imap-fetch-mail> function
+# or try to open an IMAP folder.
+#
# 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.
# exists to appease speed freaks.
#
#
+# set imap_pipeline_depth=15
+#
+# Name: imap_pipeline_depth
+# Type: number
+# Default: 15
+#
+#
+# Controls the number of IMAP commands that may be queued up before they
+# are sent to the server. A deeper pipeline reduces the amount of time
+# mutt must wait for the server, and can make IMAP servers feel much
+# more responsive. But not all servers correctly handle pipelined commands,
+# so if you have problems you might want to try setting this variable to 0.
+#
+# Note: Changes to this variable have no effect on open connections.
+#
+#
# set imap_servernoise=yes
#
# Name: imap_servernoise
#
#
# If set to ``yes'', mutt will look for a mailcap entry with the
-# copiousoutput flag set for every MIME attachment it doesn't have
+# ``copiousoutput'' flag set for every MIME attachment it doesn't have
# an internal viewer defined for. If such an entry is found, mutt will
# use the viewer defined in that entry to convert the body part to text
# form.
# 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()-style sequences.
+# $index_format for supported printf(3)-style sequences.
#
#
# set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
# This variable allows you to customize the message index display to
# your personal taste.
#
-# ``Format strings'' are similar to the strings used in the ``C''
-# function printf to format output (see the man page for more detail).
+# ``Format strings'' are similar to the strings used in the C
+# function printf(3) to format output (see the man page for more details).
# The following sequences are defined in Mutt:
-#
# %a address of the author
# %A reply-to address (if present; otherwise: address of author)
-# %b filename of the original message folder (think mailBox)
+# %b filename of the original message folder (think mailbox)
# %B the list to which the letter was sent, or else the folder name (%b).
# %c number of characters (bytes) in the message
# %C current message number
# %d date and time of the message in the format specified by
-# ``date_format'' converted to sender's time zone
+# $date_format converted to sender's time zone
# %D date and time of the message in the format specified by
-# ``date_format'' converted to the local time zone
+# $date_format converted to the local time zone
# %e current message number in thread
# %E number of messages in current thread
# %f sender (address + real name), either From: or Return-Path:
# %i message-id of the current message
# %l number of lines in the message (does not work with maildir,
# mh, and possibly IMAP folders)
-# %L If an address in the To or CC header field matches an address
+# %L If an address in the ``To:'' or ``Cc:'' header field matches an address
# defined by the users ``subscribe'' command, this displays
# "To <list-name>", otherwise the same as %F.
# %m total number of message in the mailbox
# %M number of hidden messages if the thread is collapsed.
# %N message score
# %n author's real name (or address if missing)
-# %O (_O_riginal save folder) Where mutt would formerly have
-# stashed the message: list name or recipient name if no list
-# %P progress indicator for the builtin pager (how much of the file has been displayed)
+# %O original save folder where mutt would formerly have
+# stashed the message: list name or recipient name
+# if not sent to a list
+# %P progress indicator for the built-in pager (how much of the file has been displayed)
# %s subject of the message
-# %S status of the message (N/D/d/!/r/*)
-# %t `to:' field (recipients)
+# %S status of the message (``N''/``D''/``d''/``!''/``r''/*)
+# %t ``To:'' field (recipients)
# %T the appropriate character from the $to_chars string
# %u user (login) name of the author
# %v first name of the author, or the recipient if the message is from you
# %X number of attachments
# (please see the ``attachments'' section for possible speed effects)
-# %y `x-label:' field, if present
-# %Y `x-label' field, if present, and (1) not at part of a thread tree,
-# (2) at the top of a thread, or (3) `x-label' is different from
-# preceding message's `x-label'.
+# %y ``X-Label:'' field, if present
+# %Y ``X-Label:'' field, if present, and (1) not at part of a thread tree,
+# (2) at the top of a thread, or (3) ``X-Label:'' is different from
+# preceding message's ``X-Label:''.
# %Z message status flags
# %{fmt} the date and time of the message is converted to sender's
# time zone, and ``fmt'' is expanded by the library function
-# ``strftime''; a leading bang disables locales
+# strftime(3); a leading bang disables locales
# %[fmt] the date and time of the message is converted to the local
# time zone, and ``fmt'' is expanded by the library function
-# ``strftime''; a leading bang disables locales
+# strftime(3); a leading bang disables locales
# %(fmt) the local date and time when the message was received.
-# ``fmt'' is expanded by the library function ``strftime'';
+# ``fmt'' is expanded by the library function strftime(3);
# a leading bang disables locales
# %<fmt> the current local time. ``fmt'' is expanded by the library
-# function ``strftime''; a leading bang disables locales.
-# %>X right justify the rest of the string and pad with character "X"
-# %|X pad to the end of the line with character "X"
-# %*X soft-fill with character "X" as pad
+# function strftime(3); a leading bang disables locales.
+# %>X right justify the rest of the string and pad with character ``X''
+# %|X pad to the end of the line with character ``X''
+# %*X soft-fill with character ``X'' as pad
#
#
-# `Soft-fill' deserves some explanation. Normal right-justification
-# will print everything to the left of the %>, displaying padding and
-# the whatever lies to the right only if there's room. By contrast,
+# ``Soft-fill'' deserves some explanation: Normal right-justification
+# will print everything to the left of the ``%>'', displaying padding and
+# whatever lies to the right only if there's room. By contrast,
# soft-fill gives priority to the right-hand side, guaranteeing space
# to display it and showing padding only if there's still room. If
# necessary, soft-fill will eat text leftwards to make room for
# rightward text.
#
-# Note that these expandos are supported in
+# Note that these expandos are supported in
# ``save-hook'', ``fcc-hook'' and ``fcc-save-hook'', too.
#
-# See also: ``$to_chars''.
-#
#
# set ispell="ispell"
#
#
#
# If set, read messages marked as flagged will not be moved
-# from your spool mailbox to your ``$mbox'' mailbox, or as a result of
+# from your spool mailbox to your $mbox mailbox, or as a result of
# a ``mbox-hook'' command.
#
#
#
#
# The locale used by strftime(3) to format dates. Legal values are
-# the strings your system accepts for the locale variable LC_TIME.
+# the strings your system accepts for the locale environment variable $LC_TIME.
#
#
# set mail_check=5
#
#
# This variable configures how often (in seconds) mutt should look for
-# new mail. Also see the ``$timeout'' variable.
+# new mail. Also see the $timeout variable.
+#
+#
+# set mail_check_recent=yes
+#
+# Name: mail_check_recent
+# Type: boolean
+# Default: yes
+#
+#
+# When set, Mutt will only notify you about new mail that has been received
+# since the last time you opened the mailbox. When unset, Mutt will notify you
+# if any new mail exists in the mailbox, regardless of whether you have visited it
+# recently.
+#
+# When $mark_old is set, Mutt does not consider the mailbox to contain new
+# mail if only old messages exist.
#
#
# set mailcap_path=""
# DOING!
#
#
-# set header_cache=""
-#
-# Name: header_cache
-# Type: path
-# Default: ""
-#
-#
-# The header_cache variable points to the header cache database.
-# If header_cache points to a directory it will contain a header cache
-# database per folder. If header_cache points to a file that file will
-# be a single global header cache. By default it is unset so no header
-# caching will be used.
-#
-#
# set maildir_header_cache_verify=yes
#
# Name: maildir_header_cache_verify
#
# Check for Maildir unaware programs other than mutt having modified maildir
# files when the header cache is in use. This incurs one stat(2) per
-# message every time the folder is opened.
-#
-#
-# 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 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).
+# message every time the folder is opened (which can be very slow for NFS
+# folders).
#
#
# set maildir_trash=no
#
#
# If set, messages marked as deleted will be saved with the maildir
-# (T)rashed flag instead of unlinked. NOTE: this only applies
+# trashed flag instead of unlinked. Note: this only applies
# to maildir-style mailboxes. Setting it will have no effect on other
# mailbox types.
#
# Controls whether or not mutt marks new unread
# messages as old if you exit a mailbox without reading them.
# With this option set, the next time you start mutt, the messages
-# will show up with an "O" next to them in the index menu,
+# will show up with an ``O'' next to them in the index menu,
# indicating that they are old.
#
#
#
#
# Controls the display of wrapped lines in the internal pager. If set, a
-# ``+'' marker is displayed at the beginning of wrapped lines. Also see
-# the ``$smart_wrap'' variable.
+# ``+'' marker is displayed at the beginning of wrapped lines.
+#
+# Also see the $smart_wrap variable.
#
#
# set mask="!^\\.[^.]"
# Default: "~/mbox"
#
#
-# This specifies the folder into which read mail in your ``$spoolfile''
+# This specifies the folder into which read mail in your $spoolfile
# folder will be appended.
#
+# Also see the $move variable.
+#
#
# set mbox_type=mbox
#
#
#
# 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 overridden by the
+# -m command-line option.
#
#
# set menu_context=0
#
#
# This variable controls the number of lines of context that are given
-# when scrolling through menus. (Similar to ``$pager_context''.)
+# when scrolling through menus. (Similar to $pager_context.)
#
#
# set menu_move_off=yes
# (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
#
#
# If set, forces Mutt to interpret keystrokes with the high bit (bit 8)
-# set as if the user had pressed the ESC key and whatever key remains
+# set as if the user had pressed the Esc key and whatever key remains
# after having the high bit removed. For example, if the key pressed
# has an ASCII value of 0xf8, then this is treated as if the user had
-# pressed ESC then ``x''. This is because the result of removing the
-# high bit from ``0xf8'' is ``0x78'', which is the ASCII character
+# pressed Esc then ``x''. This is because the result of removing the
+# high bit from 0xf8 is 0x78, which is the ASCII character
# ``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
# Default: no
#
#
-# When unset, mutt will mimic mh's behaviour and rename deleted messages
+# When unset, mutt will mimic mh's behavior and rename deleted messages
# to ,<old file name> in mh folders instead of really deleting
-# them. If the variable is set, the message files will simply be
+# them. This leaves the message on disk but makes programs reading the folder
+# ignore it. If the variable is set, the message files will simply be
# deleted.
#
+# This option is similar to $maildir_trash for Maildir folders.
+#
#
# set mh_seq_flagged="flagged"
#
#
#
# When set, the message you are forwarding will be attached as a
-# separate MIME part instead of included in the main body of the
+# separate message/rfc822 MIME part instead of included in the main body of the
# message. This is useful for forwarding MIME messages so the receiver
# can properly view the message as it was delivered to you. If you like
# to switch between MIME and not MIME from mail to mail, set this
-# variable to ask-no or ask-yes.
+# variable to ``ask-no'' or ``ask-yes''.
#
-# Also see ``$forward_decode'' and ``$mime_forward_decode''.
+# Also see $forward_decode and $mime_forward_decode.
#
#
# set mime_forward_decode=no
#
#
# Controls the decoding of complex MIME messages into text/plain when
-# forwarding a message while ``$mime_forward'' is set. Otherwise
-# ``$forward_decode'' is used instead.
+# forwarding a message while $mime_forward is set. Otherwise
+# $forward_decode is used instead.
#
#
# set mime_forward_rest=yes
# Default: yes
#
#
-# When forwarding multiple attachments of a MIME message from the recvattach
+# When forwarding multiple attachments of a MIME message from the attachment
# menu, attachments which cannot be decoded in a reasonable manner will
# be attached to the newly composed message if this option is set.
#
#
#
# This variable describes the format of a remailer line on the mixmaster
-# chain selection screen. The following printf-like sequences are
+# chain selection screen. The following printf(3)-like sequences are
# supported:
-#
# %n The running number on the menu.
# %c Remailer capabilities.
# %s The remailer's short name.
# mixmaster chain.
#
#
-# set move=ask-no
+# set move=no
#
# Name: move
# Type: quadoption
-# Default: ask-no
+# Default: no
#
#
# Controls whether or not Mutt will move read messages
-# from your spool mailbox to your ``$mbox'' mailbox, or as a result of
+# from your spool mailbox to your $mbox mailbox, or as a result of
# 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, for instance if stale entries accumulate because you have
-# deleted messages with another mail client.
-#
-#
-# set message_cache_clean=no
-#
-# Name: message_cache_clean
-# Type: boolean
-# Default: no
-#
-#
-# If set, mutt will clean out obsolete entries from the 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.
-#
-#
-# 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()-like sequences see the section on ``$index_format''.
-#
-#
# set narrow_tree=no
#
# Name: narrow_tree
#
#
# Operations that expect to transfer a large amount of data over the
-# network will update their progress every net_inc kilobytes.
+# network will update their progress every $net_inc kilobytes.
# If set to 0, no progress messages will be displayed.
#
-# See also ``$read_inc'' and ``$write_inc''.
+# See also $read_inc, $write_inc and $net_inc.
#
#
# set pager="builtin"
#
#
# This variable specifies which pager you would like to use to view
-# messages. builtin means to use the builtin pager, otherwise this
+# messages. The value ``builtin'' means to use the built-in pager, otherwise this
# variable should specify the pathname of the external pager you would
# like to use.
#
# 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)"
#
#
# This variable controls the format of the one-line message ``status''
# displayed before each message in either the internal or an external
-# pager. The valid sequences are listed in the ``$index_format''
+# pager. The valid sequences are listed in the $index_format
# section.
#
#
# giving the reader the context of a few messages before and after the
# message. This is useful, for example, to determine how many messages
# remain to be read in the current thread. One of the lines is reserved
-# for the status bar from the index, so a pager_index_lines of 6
+# for the status bar from the index, so a setting of 6
# will only show 5 lines of the actual index. A value of 0 results in
# no index being shown. If the number of messages in the current folder
-# is less than pager_index_lines, then the index will only use as
+# is less than $pager_index_lines, then the index will only use as
# many lines as it needs.
#
#
#
#
# When set, the internal-pager will not move to the next message
-# when you are at the end of a message and invoke the next-page
+# when you are at the end of a message and invoke the <next-page>
# 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.
-# (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 <check-traditional-pgp> 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.
-# (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.
#
-# set pgp_ignore_subkeys=yes
-#
-# Name: pgp_ignore_subkeys
-# Type: boolean
-# Default: yes
+# 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.
#
+# Also see the $pgp_mime_auto variable.
#
-# 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.
+# Also note that using the old-style PGP message format is strongly
+# deprecated.
# (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: ""
+#
#
+# This command is used to decrypt a PGP encrypted message.
#
-# If set, mutt will use a possibly-running gpg-agent process.
+# 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 ``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 manage 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"
#
#
# This variable allows you to customize the PGP key selection menu to
-# your personal taste. This string is similar to ``$index_format'', but
-# has its own set of printf()-like sequences:
-#
+# your personal taste. This string is similar to $index_format, but
+# has its own set of printf(3)-like sequences:
# %n number
# %k key id
# %u user id
# (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
# (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. Unset uses 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
+# Name: pgp_list_secring_command
+# 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.
+#
+# This is a format string, see the $pgp_decode_command command for
+# possible printf(3)-like sequences.
+# (PGP only)
+#
+#
+# set pgp_long_ids=no
+#
+# Name: pgp_long_ids
# Type: boolean
# Default: no
#
#
-# 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.
+# If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs.
+# (PGP only)
#
-# 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.
-# See also: ``$pgp_mime_auto''.
+#
+# 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.
# 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
+# 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.
# 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.
-# See also: ``$pgp_mime_auto''.
+#
+# Also see the $pgp_mime_auto variable.
#
# Also note that using the old-style PGP message format is strongly
# deprecated.
# (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
#
# If you have more than one key pair, this option allows you to specify
# which of your private keys to use. It is recommended that you use the
-# keyid form to specify your key (e.g., ``0x00112233'').
+# keyid form to specify your key (e.g. 0x00112233).
# (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)
#
#
# Default: address
#
#
-# Specifies how the entries in the `pgp keys' menu are sorted. The
+# Specifies how the entries in the pgp menu are sorted. The
# following are legal values:
-#
# address sort alphabetically by user id
# keyid sort alphabetically by key id
# date sort by key creation date
#
#
# If you prefer reverse order of the above values, prefix it with
-# `reverse-'.
+# ``reverse-''.
# (PGP only)
#
#
-# set pgp_mime_auto=ask-yes
+# set pgp_strict_enc=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
-#
-# 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 check-traditional-pgp 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-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*.rc and gpg.rc 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.
-# %r is the only printf-like sequence used with this format.
+# If set, mutt will use a possibly-running gpg-agent(1) process.
# (PGP only)
#
#
#
#
# This command is used to verify PGP signatures.
+#
+# This is a format string, see the $pgp_decode_command command for
+# possible printf(3)-like sequences.
# (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.
-# (PGP only)
+# Used in connection with the <pipe-message> 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.
-# (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.
-# (PGP only)
+# Used in connection with the <pipe-message> function following
+# <tag-prefix>. 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.
-# (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.
-# (PGP only)
+# 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, e.g. ``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"
#
-# 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.
-# (PGP only)
+# This variable configures how often (in seconds) mutt should look for
+# new mail in the currently selected mailbox if it is a POP mailbox.
#
#
-# 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.
-# (PGP only)
+# If set, Mutt will delete successfully downloaded messages from the POP
+# server when using the <fetch-mail> 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.
+# The name of your POP server for the <fetch-mail> function. You
+# can also specify an alternative port, username and password, i.e.:
+# [pop[s]://][username[:password]@]popserver[:port]
#
-# This format is also generated by the pgpring utility which comes
-# with mutt.
-# (PGP only)
+# where ``[...]'' denotes an optional part.
#
#
-# set pgp_list_pubring_command=""
+# set pop_last=no
#
-# Name: pgp_list_pubring_command
-# Type: string
-# Default: ""
-#
+# Name: pop_last
+# Type: boolean
+# Default: no
#
-# 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 format is also generated by the pgpring utility which comes
-# with mutt.
-# (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 <fetch-mail> 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 there is no pubring/secring as with PGP, mutt has to handle
-# storage ad 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 one 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 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 one 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-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.
-# (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.
-# (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.
-# (S/MIME only)
+# Used in connection with the <print-message> 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.
-# (S/MIME only)
+# Used in connection with the <print-message> 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 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.
-# (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).
-# (S/MIME only)
+# This specifies the command Mutt will use to make external address
+# queries. The string may contain a ``%s'', which will be substituted
+# with the query string the user types. Mutt will add quotes around the
+# string substituted for ``%s'' automatically according to shell quoting
+# rules, so you should avoid adding your own. If no ``%s'' is found in
+# the string, Mutt will append the user's query to the end of the string.
+# 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.
-# (S/MIME only)
#
+# 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
#
-# set smime_get_signer_cert_command=""
-#
-# Name: smime_get_signer_cert_command
-# Type: string
-# Default: ""
#
+# For an explanation of ``soft-fill'', see the $index_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.
-# (S/MIME only)
+# * = can be optionally printed if nonzero, see the $status_format documentation.
#
#
-# set smime_import_cert_command=""
+# set quit=yes
#
-# Name: smime_import_cert_command
-# Type: string
-# Default: ""
+# Name: quit
+# Type: quadoption
+# Default: yes
#
#
-# This command is used to import a certificate via smime_keys.
-# (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_get_cert_email_command=""
+# set quote_regexp="^([ \t]*[|>:}#])+"
#
-# Name: smime_get_cert_email_command
-# Type: string
-# Default: ""
-#
-#
-# 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).
-# (S/MIME only)
+# Name: quote_regexp
+# Type: regular expression
+# Default: "^([ \t]*[|>:}#])+"
#
#
-# set smime_default_key=""
-#
-# Name: smime_default_key
-# Type: string
-# Default: ""
+# 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 <toggle-quoted> command, or colored according to the
+# ``color quoted'' family of directives.
#
+# 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.
#
-# 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)
+# Match detection may be overridden by the $smileys regular expression.
#
#
-# set ssl_client_cert=""
+# set read_inc=10
#
-# Name: ssl_client_cert
-# Type: path
-# Default: ""
+# Name: read_inc
+# Type: number
+# Default: 10
#
#
-# The file containing a client certificate and its associated private
-# key.
+# 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.
#
-# set ssl_force_tls=no
+#
+# set read_only=no
#
-# Name: ssl_force_tls
+# Name: read_only
# 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''.
+# If set, all folders are opened in read-only mode.
#
#
-# set ssl_starttls=yes
+# set realname=""
#
-# Name: ssl_starttls
-# Type: quadoption
-# Default: yes
+# Name: realname
+# Type: string
+# Default: ""
#
#
-# 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.
+# 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.
#
#
-# set certificate_file="~/.mutt_certificates"
+# set recall=ask-yes
#
-# Name: certificate_file
-# Type: path
-# Default: "~/.mutt_certificates"
+# Name: recall
+# Type: quadoption
+# Default: ask-yes
#
#
-# 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.
+# Controls whether or not Mutt recalls postponed messages
+# when composing a new message.
#
-# You can also manually add CA certificates in this file. Any server
-# certificate that is signed with one of these CA certificates are
-# also automatically accepted.
+# Setting this variable to is not generally useful, and thus not
+# recommended.
#
-# Example: set certificate_file=~/.mutt/certificates
+# Also see $postponed variable.
#
#
-# set ssl_usesystemcerts=yes
+# set record="~/sent"
#
-# Name: ssl_usesystemcerts
-# Type: boolean
-# Default: yes
+# Name: record
+# Type: path
+# Default: "~/sent"
#
#
-# If set to yes, mutt will use CA certificates in the
-# system-wide certificate store when checking if server certificate
-# is signed by a trusted CA.
+# 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 entropy_file=""
+#
+# set reply_regexp="^(re([\\[0-9\\]+])*|aw):[ \t]*"
#
-# Name: entropy_file
-# Type: path
-# Default: ""
+# Name: reply_regexp
+# Type: regular expression
+# Default: "^(re([\\[0-9\\]+])*|aw):[ \t]*"
#
#
-# The file which includes random data that is used to initialize SSL
-# library functions.
+# 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 ssl_use_sslv2=yes
+# set reply_self=no
#
-# Name: ssl_use_sslv2
+# Name: reply_self
# Type: boolean
-# Default: yes
+# Default: no
#
#
-# This variables specifies whether to attempt to use SSLv2 in the
-# SSL authentication process.
+# 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_sslv3=yes
+#
+# set reply_to=ask-yes
#
-# Name: ssl_use_sslv3
-# Type: boolean
-# Default: yes
+# Name: reply_to
+# Type: quadoption
+# Default: ask-yes
#
#
-# This variables specifies whether to attempt to use SSLv3 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_tlsv1=yes
+# set resolve=yes
#
-# Name: ssl_use_tlsv1
+# Name: resolve
# Type: boolean
# Default: yes
#
#
-# This variables specifies whether to attempt to use TLSv1 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_min_dh_prime_bits=0
+# set reverse_alias=no
#
-# Name: ssl_min_dh_prime_bits
-# Type: number
-# Default: 0
+# Name: reverse_alias
+# Type: boolean
+# Default: no
#
#
-# 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.
+# 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
#
-# set ssl_ca_certificates_file=""
+# 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: 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 are 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 pipe-message command and the ``tag-
-# prefix'' operator. If this variable is unset, when piping a list of
-# tagged messages Mutt will concatenate the messages and will pipe them
-# as a single folder. 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 behavior of the $reverse_name feature.
+# When it is set, mutt will use the address from incoming messages as-is,
+# possibly including eventual real names. When it is unset, mutt will
+# override any such real names with the setting of the $realname variable.
#
#
-# set pipe_decode=no
+# set rfc2047_parameters=no
#
-# Name: pipe_decode
+# Name: rfc2047_parameters
# Type: boolean
# Default: no
#
#
-# Used in connection with the pipe-message command. When unset,
-# Mutt will pipe the messages without any preprocessing. When set, Mutt
-# will weed headers and will attempt to PGP/MIME 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 parameter is case-insensitive. If this parameter 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 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 fetch-mail 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 fetch-mail function. You
-# can also specify an alternative port, username and password, ie:
+# 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.
#
-# [pop[s]://][username[:password]@]popserver[:port]
+# 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 fetch-mail 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 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 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. Also see the
-# ``$recall'' variable.
+# 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.
#
#
-# 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: ""
+# Name: sendmail_wait
+# Type: number
+# Default: 0
#
#
-# 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:
+# Specifies the number of seconds to wait for the $sendmail process
+# to finish before giving up and putting delivery in the background.
#
-# preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net
-# sleep 20 < /dev/null > /dev/null"
+# 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
#
-# Mailbox 'foo' on mailhost.net can now be reached
-# as '{localhost:1234}foo'.
#
-# NOTE: For this example to work, you must be able to log in to the
-# remote machine without having to enter a password.
+# 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=ask-no
+# set shell=""
#
-# Name: print
-# Type: quadoption
-# Default: ask-no
+# Name: shell
+# Type: path
+# Default: ""
#
#
-# Controls whether or not Mutt really prints messages.
-# This is set to ask-no by default, because some people
-# accidentally hit ``p'' often (like me).
-#
-#
-# set print_command="lpr"
-#
-# Name: print_command
-# Type: path
-# Default: "lpr"
-#
-#
-# 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 print-message 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 built-in 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 print-message 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-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
-#
-#
-# For an explanation of `soft-fill', see the ``$index_format'' documentation.
-#
-# * = can be optionally printed if nonzero, see the ``$status_format'' documentation.
-#
-#
-# set quit=yes
-#
-# Name: quit
-# Type: quadoption
-# Default: yes
-#
-#
-# This variable controls whether ``quit'' and ``exit'' actually quit
-# from mutt. If it set to yes, they do quit, if it is set to no, 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 quote_regexp="^([ \t]*[|>:}#])+"
-#
-# Name: quote_regexp
-# Type: regular expression
-# Default: "^([ \t]*[|>:}#])+"
+# Default: "~f %s | ~s %s"
#
#
-# A regular expression used in the internal-pager to determine quoted
-# sections of text in the body of a message.
+# 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.
#
-# Note: In order to use the quotedx patterns in the
-# internal pager, you need to set this to a regular expression that
-# matches exactly the quote characters at the beginning of quoted
-# lines.
+# 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 read_inc=10
+# set sleep_time=1
#
-# Name: read_inc
+# Name: sleep_time
# Type: number
-# Default: 10
-#
+# Default: 1
#
-# 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
-# read_inc 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'' variable and the ``Tuning'' section of the
-# manual for performance considerations.
+# 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 read_only=no
+# set smart_wrap=yes
#
-# Name: read_only
+# Name: smart_wrap
# Type: boolean
-# Default: no
-#
-#
-# If set, all folders are opened in read-only mode.
-#
-#
-# set realname=""
-#
-# Name: realname
-# Type: string
-# 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.
-#
-#
-# set recall=ask-yes
-#
-# Name: recall
-# Type: quadoption
-# Default: ask-yes
-#
-#
-# Controls whether or not Mutt recalls postponed messages
-# when composing a new message. Also see ``$postponed''.
-#
-# Setting this variable to ``yes'' is not generally useful, and thus not
-# recommended.
-#
-#
-# set record="~/sent"
-#
-# Name: record
-# Type: path
-# Default: "~/sent"
+# Default: yes
#
#
-# 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.
+# 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 reply_regexp="^(re([\\[0-9\\]+])*|aw):[ \t]*"
+# set smileys="(>From )|(:[-^]?[][)(><}{|/DP])"
#
-# Name: reply_regexp
+# Name: smileys
# Type: regular expression
-# Default: "^(re([\\[0-9\\]+])*|aw):[ \t]*"
+# Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
#
#
-# A regular expression used to recognize reply messages when threading
-# and replying. The default value corresponds to the English "Re:" and
-# the German "Aw:".
+# 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 reply_self=no
+# set smime_ask_cert_label=yes
#
-# Name: reply_self
+# Name: smime_ask_cert_label
# Type: boolean
-# Default: no
+# Default: yes
#
#
-# 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.
+# 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 reply_to=ask-yes
+# set smime_ca_location=""
#
-# Name: reply_to
-# Type: quadoption
-# Default: ask-yes
+# Name: smime_ca_location
+# Type: path
+# Default: ""
#
#
-# 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.
+# This variable contains the name of either a directory, or a file which
+# contains trusted certificates for use with OpenSSL.
+# (S/MIME only)
#
#
-# set resolve=yes
+# set smime_certificates=""
#
-# Name: resolve
-# Type: boolean
-# Default: yes
+# Name: smime_certificates
+# Type: path
+# Default: ""
#
#
-# When set, the cursor will be automatically advanced to the next
-# (possibly undeleted) message whenever a command that modifies the
-# current message is executed.
+# 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)
#
#
-# set reverse_alias=no
+# set smime_decrypt_command=""
#
-# 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
+# Name: smime_decrypt_command
+# Type: string
+# Default: ""
#
-# 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 (like CompuServe addresses).
#
+# This format string specifies a command which is used to decrypt
+# application/x-pkcs7-mime attachments.
#
-# set reverse_name=no
-#
-# Name: reverse_name
-# Type: boolean
-# Default: no
+# 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.
+# 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 RFC-2047-encoded MIME
-# parameters. You want to set this variable when mutt suggests you
-# to save attachments to files named like this:
-# =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
-#
-# When this variable is set interactively, the change doesn't have
-# the desired effect before you have changed folders.
-#
-# Note that this use of RFC 2047'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 RFC 2231.
+# 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 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 friends 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 behavior 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 ``-- '' 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 stdout.
+# 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 ~
-# operators. See ``patterns'' for more information on search patterns.
#
-# 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.
-# For the default value it would be:
+# 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.
#
-# ~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 in 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=""
#
# This is a colon-delimited list of authentication methods mutt may
# attempt to use to log in to an SMTP server, in the order mutt should
-# try them. Authentication methods are any SASL mechanism, eg
+# try them. Authentication methods are any SASL mechanism, e.g.
# ``digest-md5'', ``gssapi'' or ``cram-md5''.
-# This parameter is case-insensitive. If this parameter is unset
+# This option is case-insensitive. If it is ``unset''
# (the default) mutt will try all available methods, in order from
# most-secure to least-secure.
#
-# Example: set smtp_authenticators="digest-md5:cram-md5"
+# Example:
+# set smtp_authenticators="digest-md5:cram-md5"
#
#
# set smtp_pass=""
#
# Specifies the password for your SMTP account. If unset, Mutt will
# prompt you for your password when you first send mail via SMTP.
-# See ``smtp_url'' to configure mutt to send mail via SMTP.
+# See $smtp_url to configure mutt to send mail via SMTP.
+#
# 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.
# Default: ""
#
#
-# Defines the SMTP ``smart'' host where sent messages should relayed for
-# delivery. This should take the form of an SMTP URL, eg:
+# Defines the SMTP smarthost where sent messages should relayed for
+# delivery. This should take the form of an SMTP URL, e.g.:
+# smtp[s]://[user[:pass]@]host[:port]
#
-# smtp[s]://[user[:pass]@]host[:port]/
-#
-# Setting this variable overrides the value of the ``$sendmail''
+# where ``[...]'' denotes an optional part.
+# Setting this variable overrides the value of the $sendmail
# variable.
#
#
# Default: date
#
#
-# Specifies how to sort messages in the index menu. Valid values
+# Specifies how to sort messages in the ``index'' menu. Valid values
# are:
+# - date or date-sent
+# - date-received
+# - from
+# - mailbox-order (unsorted)
+# - score
+# - size
+# - spam
+# - subject
+# - threads
+# - to
#
-# date or date-sent
-# date-received
-# from
-# mailbox-order (unsorted)
-# score
-# size
-# spam
-# subject
-# threads
-# to
#
-# You may optionally use the reverse- prefix to specify reverse sorting
-# order (example: set sort=reverse-date-sent).
+# You may optionally use the ``reverse-'' prefix to specify reverse sorting
+# order (example: ``set sort=reverse-date-sent'').
#
#
# set sort_alias=alias
# Default: alias
#
#
-# Specifies how the entries in the `alias' menu are sorted. The
+# Specifies how the entries in the ``alias'' menu are sorted. The
# following are legal values:
-#
-# address (sort alphabetically by email address)
-# alias (sort alphabetically by alias name)
-# unsorted (leave in order specified in .muttrc)
+# - address (sort alphabetically by email address)
+# - alias (sort alphabetically by alias name)
+# - unsorted (leave in order specified in .muttrc)
#
#
# set sort_aux=date
#
# When sorting by threads, this variable controls how threads are sorted
# in relation to other threads, and how the branches of the thread trees
-# are sorted. This can be set to any value that ``$sort'' can, except
-# threads (in that case, mutt will just use date-sent). You can also
-# specify the last- prefix in addition to the reverse- prefix, but last-
-# must come after reverse-. The last- prefix causes messages to be
+# are sorted. This can be set to any value that $sort can, except
+# ``threads'' (in that case, mutt will just use ``date-sent''). You can also
+# specify the ``last-'' prefix in addition to the ``reverse-'' prefix, but ``last-''
+# must come after ``reverse-''. The ``last-'' prefix causes messages to be
# sorted against its siblings by which has the last descendant, using
-# the rest of sort_aux as an ordering. For instance, set sort_aux=last-
-# date-received would mean that if a new message is received in a
+# the rest of $sort_aux as an ordering. For instance,
+# set sort_aux=last-date-received
+#
+# would mean that if a new message is received in a
# thread, that thread becomes the last one displayed (or the first, if
-# you have set sort=reverse-threads.) Note: For reversed ``$sort''
+# you have ``set sort=reverse-threads''.)
+#
+# Note: For reversed $sort
# order $sort_aux is reversed again (which is not the right thing to do,
# but kept to not break any existing configuration setting).
#
#
# Specifies how to sort entries in the file browser. By default, the
# entries are sorted alphabetically. Valid values:
+# - alpha (alphabetically)
+# - date
+# - size
+# - unsorted
#
-# alpha (alphabetically)
-# date
-# size
-# unsorted
#
-# You may optionally use the reverse- prefix to specify reverse sorting
-# order (example: set sort_browser=reverse-date).
+# You may optionally use the ``reverse-'' prefix to specify reverse sorting
+# order (example: ``set sort_browser=reverse-date'').
#
#
# set sort_re=yes
#
#
# This variable is only useful when sorting by threads with
-# ``$strict_threads'' unset. In that case, it changes the heuristic
-# mutt uses to thread messages by subject. With sort_re set, mutt will
+# $strict_threads unset. In that case, it changes the heuristic
+# mutt uses to thread messages by subject. With $sort_re set, mutt will
# only attach a message as the child of another message by subject if
# the subject of the child message starts with a substring matching the
-# setting of ``$reply_regexp''. With sort_re unset, mutt will attach
+# setting of $reply_regexp. With $sort_re unset, mutt will attach
# the message whether or not this is the case, as long as the
-# non-``$reply_regexp'' parts of both messages are identical.
+# non-$reply_regexp parts of both messages are identical.
#
#
# set spam_separator=","
# Default: ","
#
#
-# ``spam_separator'' controls what happens when multiple spam headers
+# This variable controls what happens when multiple spam headers
# are matched: if unset, each successive header will overwrite any
# previous matches value for the spam label. If set, each successive
-# match will append to the previous, using ``spam_separator'' as a
+# match will append to the previous, using this variable's value as a
# separator.
#
#
#
# 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
+# <account-hook> 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 <account-hook> function.
#
#
# set status_chars="-*%A"
# Default: "-*%A"
#
#
-# Controls the characters used by the "%r" indicator in
-# ``$status_format''. The first character is used when the mailbox is
+# Controls the characters used by the ``%r'' indicator in
+# $status_format. The first character is used when the mailbox is
# unchanged. The second is used when the mailbox has been changed, and
# it needs to be resynchronized. The third is used if the mailbox is in
# read-only mode, or if the mailbox will not be written when exiting
# that mailbox (You can toggle whether to write changes to a mailbox
-# with the toggle-write operation, bound by default to "%"). The fourth
+# with the <toggle-write> operation, bound by default to ``%''). The fourth
# is used to indicate that the current folder has been opened in attach-
# message mode (Certain operations like composing a new mail, replying,
# forwarding, etc. are not permitted in this mode).
# Default: "-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---"
#
#
-# Controls the format of the status line displayed in the index
-# menu. This string is similar to ``$index_format'', but has its own
-# set of printf()-like sequences:
-#
+# Controls the format of the status line displayed in the ``index''
+# menu. This string is similar to $index_format, but has its own
+# set of printf(3)-like sequences:
# %b number of mailboxes with new mail *
# %d number of deleted messages *
# %f the full pathname of the current mailbox
# %F number of flagged messages *
# %h local hostname
# %l size (in bytes) of the current mailbox *
-# %L size (in bytes) of the messages shown
+# %L size (in bytes) of the messages shown
# (i.e., which match the current limit) *
# %m the number of messages in the mailbox *
# %M the number of messages shown (i.e., which match the current limit) *
# %u number of unread messages *
# %v Mutt version string
# %V currently active limit pattern, if any *
-# %>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
+# %>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
#
#
-# For an explanation of `soft-fill', see the ``$index_format'' documentation.
+# For an explanation of ``soft-fill'', see the $index_format documentation.
#
# * = can be optionally printed if nonzero
#
#
# Here is an example illustrating how to optionally print the number of
# new messages in a mailbox:
+#
# %?n?%n new messages.?
#
# You can also switch between two strings using the following construct:
# If the value of sequence_char is non-zero, if_string will
# be expanded, otherwise else_string will be expanded.
#
-# You can force the result of any printf-like sequence to be lowercase
-# by prefixing the sequence character with an underscore (_) sign.
+# You can force the result of any printf(3)-like sequence to be lowercase
+# by prefixing the sequence character with an underscore (``_'') sign.
# For example, if you want to display the local hostname in lowercase,
-# you would use:
-# %_h
+# you would use: ``%_h''.
#
-# If you prefix the sequence character with a colon (:) character, mutt
-# will replace any dots in the expansion by underscores. This might be helpful
+# If you prefix the sequence character with a colon (``:'') character, mutt
+# will replace any dots in the expansion by underscores. This might be helpful
# with IMAP folders that don't like dots in folder names.
#
#
#
#
# Setting this variable causes the ``status bar'' to be displayed on
-# the first line of the screen rather than near the bottom.
+# the first line of the screen rather than near the bottom. If $help
+# is set, too it'll be placed at the bottom.
#
#
# set strict_threads=no
#
#
# If set, threading will only make use of the ``In-Reply-To'' and
-# ``References'' fields when you ``$sort'' by message threads. By
+# ``References:'' fields when you $sort by message threads. By
# default, messages with the same subject are grouped together in
# ``pseudo threads.''. This may not always be desirable, such as in a
# personal mailbox where you might have several unrelated messages with
-# the subject ``hi'' which will get grouped together. See also
-# ``$sort_re'' for a less drastic way of controlling this
-# behaviour.
+# the subjects like ``hi'' which will get grouped together. See also
+# $sort_re for a less drastic way of controlling this
+# behavior.
#
#
# set suspend=yes
#
#
# When unset, mutt won't stop when the user presses the terminal's
-# susp key, usually ``control-Z''. This is useful if you run mutt
-# inside an xterm using a command like xterm -e mutt.
+# susp key, usually ``^Z''. This is useful if you run mutt
+# inside an xterm using a command like ``xterm -e mutt''.
#
#
# set text_flowed=no
# Default: no
#
#
-# When set, mutt will generate text/plain; format=flowed attachments.
+# When set, mutt will generate ``format=flowed'' bodies with a content type
+# of ``text/plain; format=flowed''.
# This format is easier to handle for some mailing software, and generally
-# just looks like ordinary text. To actually make use of this format's
+# just looks like ordinary text. To actually make use of this format's
# features, you'll need support in your editor.
#
# Note that $indent_string is ignored when this option is set.
#
#
-# set thread_received=no
+# set thorough_search=yes
#
-# Name: thread_received
+# Name: thorough_search
# Type: boolean
-# Default: no
+# Default: yes
#
#
-# When set, mutt uses the date received rather than the date sent
-# to thread messages by subject.
+# Affects the ~b and ~h search operations described in
+# section ``patterns''. If set, the headers and body/attachments of
+# messages to be searched are decoded before searching. If unset,
+# messages are searched as they appear in the folder.
+#
+# Users searching attachments or for non-ASCII characters should set
+# this value because decoding also includes MIME parsing/decoding and possible
+# character set conversions. Otherwise mutt will attempt to match against the
+# raw message received (for example quoted-printable encoded or with encoded
+# headers) which may lead to incorrect search results.
#
#
-# set thorough_search=no
+# set thread_received=no
#
-# Name: thorough_search
+# Name: thread_received
# Type: boolean
# Default: no
#
#
-# Affects the ~b and ~h search operations described in
-# section ``patterns'' above. If set, the headers and attachments of
-# messages to be searched are decoded before searching. If unset,
-# messages are searched as they appear in the folder.
+# When set, mutt uses the date received rather than the date sent
+# to thread messages by subject.
#
#
# set tilde=no
#
#
# When set, the internal-pager will pad blank lines to the bottom of the
-# screen with a tilde (~).
+# screen with a tilde (``~'').
#
#
# set time_inc=0
# Default: 0
#
#
-# Along with ``read_inc'', ``write_inc'', and ``net_inc'', this
+# Along with $read_inc, $write_inc, and $net_inc, this
# variable controls the frequency with which progress updates are
-# displayed. It suppresses updates less than ``time_inc'' milliseconds
+# displayed. It suppresses updates less than $time_inc milliseconds
# apart. This can improve throughput on systems with slow terminals,
# or when running mutt on a remote system.
#
+# Also see the ``tuning'' section of the manual for performance considerations.
+#
#
# set timeout=600
#
# Default: 600
#
#
-# When Mutt is waiting for user input either idleing in menus or
+# When Mutt is waiting for user input either idling in menus or
# in an interactive prompt, Mutt would block until input is
# present. Depending on the context, this would prevent certain
# operations from working, like checking for new mail or keeping
#
# This variable allows you to specify where Mutt will place its
# temporary files needed for displaying and composing messages. If
-# this variable is not set, the environment variable TMPDIR is
-# used. If TMPDIR is not set then "/tmp" is used.
+# this variable is not set, the environment variable $TMPDIR is
+# used. If $TMPDIR is not set then ``/tmp'' is used.
#
#
# set to_chars=" +TCFL"
#
#
# Controls the character used to indicate mail addressed to you. The
-# first character is the one used when the mail is NOT addressed to your
-# address (default: space). The second is used when you are the only
-# recipient of the message (default: +). The third is when your address
-# appears in the TO header field, but you are not the only recipient of
-# the message (default: T). The fourth character is used when your
-# address is specified in the CC header field, but you are not the only
+# first character is the one used when the mail is not addressed to your
+# address. The second is used when you are the only
+# recipient of the message. The third is when your address
+# appears in the ``To:'' header field, but you are not the only recipient of
+# the message. The fourth character is used when your
+# address is specified in the ``Cc:'' header field, but you are not the only
# recipient. The fifth character is used to indicate mail that was sent
# by you. The sixth character is used to indicate when a mail
-# was sent to a mailing-list you subscribe to (default: L).
+# was sent to a mailing-list you subscribe to.
#
#
# set tunnel=""
#
# Setting this variable will cause mutt to open a pipe to a command
# instead of a raw socket. You may be able to use this to set up
-# preauthenticated connections to your IMAP/POP3 server. Example:
+# preauthenticated connections to your IMAP/POP3/SMTP server. Example:
+# set tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
#
-# tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
-#
-# NOTE: For this example to work you must be able to log in to the remote
+# 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
#
# of sendmail which supports the -B8BITMIME flag (such as sendmail
# 8.8.x) or you may not be able to send mail.
#
-# When set, Mutt will invoke ``$sendmail'' with the -B8BITMIME
+# When set, Mutt will invoke $sendmail with the -B8BITMIME
# flag when sending 8-bit messages to enable ESMTP negotiation.
#
#
#
#
# When set, Mutt will qualify all local addresses (ones without the
-# @host portion) with the value of ``$hostname''. If unset, no
+# ``@host'' portion) with the value of $hostname. If unset, no
# addresses will be qualified.
#
#
#
#
# When set, mutt will set the envelope sender of the message.
-# If ``$envelope_from_address'' is set, it will be used as the sender
-# address. If not, mutt will attempt to derive the sender from the
-# "From:" header.
+# If $envelope_from_address is set, it will be used as the sender
+# address. If unset, mutt will attempt to derive the sender from the
+# ``From:'' header.
#
# Note that this information is passed to sendmail command using the
-# "-f" command line switch. Therefore setting this option is not useful
-# if the ``$sendmail'' variable already contains "-f" or if the
-# executable pointed to by $sendmail doesn't support the "-f" switch.
+# -f command line switch. Therefore setting this option is not useful
+# if the $sendmail variable already contains -f or if the
+# executable pointed to by $sendmail doesn't support the -f switch.
#
#
# set use_from=yes
# Default: yes
#
#
-# When set, Mutt will generate the `From:' header field when
-# sending messages. If unset, no `From:' header field will be
+# When set, Mutt will generate the ``From:'' header field when
+# sending messages. If unset, no ``From:'' header field will be
# generated unless the user explicitly sets one using the ``my_hdr''
# command.
#
# Default: yes
#
#
-# When set, mutt will add a "User-Agent" header to outgoing
+# When set, mutt will add a ``User-Agent:'' header to outgoing
# messages, indicating which version of mutt was used for composing
# them.
#
# Default: ""
#
#
-# Specifies the visual editor to invoke when the ~v command is
-# given in the builtin editor.
+# Specifies the visual editor to invoke when the ``~v'' command is
+# given in the built-in editor.
#
#
# set wait_key=yes
# Default: yes
#
#
-# Controls whether Mutt will ask you to press a key after shell-
-# escape, pipe-message, pipe-entry, print-message,
-# and print-entry commands.
+# Controls whether Mutt will ask you to press a key after an external command
+# has been invoked by these functions: <shell-escape>,
+# <pipe-message>, <pipe-entry>, <print-message>,
+# and <print-entry> commands.
#
# It is also used when viewing attachments with ``auto_view'', provided
# that the corresponding mailcap entry has a needsterminal flag,
#
# When set to a positive value, mutt will wrap text at $wrap characters.
# When set to a negative value, mutt will wrap text so that there are $wrap
-# characters of empty space on the right side of the terminal.
+# characters of empty space on the right side of the terminal. Setting it
+# to zero makes mutt wrap at the terminal width.
+#
+#
+# set wrap_headers=78
+#
+# Name: wrap_headers
+# Type: number
+# Default: 78
+#
+#
+# This option specifies the number of characters to use for wrapping
+# an outgoing message's headers. Allowed values are between 78 and 998
+# inclusive.
+#
+# Note: This option usually shouldn't be changed. RFC5233
+# recommends a line length of 78 (the default), so please only change
+# this setting when you know what you're doing.
#
#
# set wrap_search=yes
# Default: yes
#
#
-# Controls whether searches wrap around the end of the mailbox.
+# Controls whether searches wrap around the end.
#
-# When set, searches will wrap around the first (or last) message. When
-# unset, searches will not wrap.
+# When set, searches will wrap around the first (or last) item. When
+# unset, incremental searches will not wrap.
#
#
# set wrapmargin=0
# Default: 0
#
#
-# (DEPRECATED) Equivalent to setting wrap with a negative value.
+# (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
#
#
# When writing a mailbox, a message will be printed every
-# write_inc messages to indicate progress. If set to 0, only a
+# $write_inc messages to indicate progress. If set to 0, only a
# single message will be displayed before writing a mailbox.
#
-# Also see the ``$read_inc'' variable.
-#
-#
-# 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.
+# Also see the $read_inc, $net_inc and $time_inc variables and the
+# ``tuning'' section of the manual for performance considerations.
#
#
projects / software / mutt-debian.git / blobdiff