# 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 ***
##
# 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.
+# 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
# 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
+# 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.
#
-# Also see ``$fast_reply''.
+# Also see $fast_reply.
#
#
# set auto_tag=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.
+# unset, you must first use the <tag-prefix> function (bound to ``;''
+# by default) to make the next function apply to all tagged messages.
#
#
# 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.
#
#
#
#
# When this variable is set, mutt will use file size attribute instead of
-# access time when checking for new mail.
+# 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 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 abled to determine the
+# character set used correctly.
+#
#
# 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.
#
#
# 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
# 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
+# you need to set this option in .muttrc; it won't have any effect when
# used interactively.
#
#
# Default: no
#
#
-# (http://www.g10code.de/docs/pka-intro.de.pdf) during signature
+# Controls whether mutt uses PKA
+# (see 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''.
+# PGP encryption/signing for messages. See also $crypt_autoencrypt,
+# $crypt_replyencrypt,
+# $crypt_autosign, $crypt_replysign and $smime_is_default.
#
#
# 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 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 autodetected 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 autodetected 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 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="~"
# 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.
#
#
# 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
# %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_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=".*".
+# 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 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
+# 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
# Default: no
#
#
-# When set, mutt will skip the host name part of ``$hostname'' variable
+# 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
+# affect the generation of Message-IDs, and it will not lead to the
# cut-off of first-level domains.
#
#
#
#
# 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.
#
#
# 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 behaviour 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, eg ``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 <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.
# change this value, as it tends to agitate the more fanatical netizens.
#
# 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.
+#
+# Because for format=lowed style messages the quoting mechanism
+# is strictly defined, this setting is ignored if $text_flowed is
+# set.
#
#
# set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
# 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
+# %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 builtin 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 mailcap_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
+# This variable points to the header cache database.
+# If pointing to a directory Mutt will contain a header cache
+# database file per folder, if pointing to a file that file will
# be a single global header cache. By default it is unset so no header
# caching will be used.
#
+# Header caching can greatly improve speed when opening POP, IMAP
+# MH or Maildir folders, see ``caching'' for details.
+#
#
# set maildir_header_cache_verify=yes
#
#
# 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.
+# message every time the folder is opened (which can be very slow for NFS
+# folders).
#
#
# set header_cache_pagesize="16384"
# Default: yes
#
#
-# When mutt is compiled with qdbm as header cache backend,
+# When mutt is compiled with qdbm or tokyocabinet as header cache backend,
# this option determines whether the database will be compressed.
# Compression results in database files roughly being one fifth
# of the usual diskspace, but the uncompression can result in a
-# slower opening of cached folder(s).
+# slower opening of cached folder(s) which in general is still
+# much faster than opening non header cached 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.
+# ``mbox'', ``MMDF'', ``MH'' and ``Maildir''.
#
#
# set metoo=no
#
#
# 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
#
#
# 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''.
#
#
#
# When unset, mutt will mimic mh's behaviour 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 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.
+# time.
+#
+# When setting this variable to a directory, mutt needs to fetch every
+# remote message only once and can perform regular expression searches
+# as fast as for local folders.
+#
+# Also see the $message_cache_clean variable.
#
#
# set message_cache_clean=no
# Default: no
#
#
-# If set, mutt will clean out obsolete entries from the cache when
+# 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.
+# every once in a while, since it can be a little slow
+# (especially for large folders).
#
#
# set message_format="%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''.
+# printf(3)-like sequences see the section on $index_format.
#
#
# set narrow_tree=no
#
#
# 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 builtin pager, otherwise this
# variable should specify the pathname of the external pager you would
# like to use.
#
#
# 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.
#
#
#
# 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,
+# 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.
+# be overridden by use of the smime menu instead of the pgp menu.
# (Crypto only)
#
#
#
# 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,
+# 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.
+# settings can be overridden by use of the smime menu instead.
# (Crypto only)
#
#
#
# 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
+# $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
+# the problem noted in $crypt_replysign, that mutt is not able
# to find out whether an encrypted message is also signed.
# (Crypto only)
#
# Default: no
#
#
-# If set, mutt will use a possibly-running gpg-agent process.
+# If set, mutt will use a possibly-running gpg-agent(1) process.
# (PGP only)
#
#
#
#
# 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.
+# If ``ask-*'', ask whether or not to verify the signature.
+# If \Fi``no'', never attempt to verify cryptographic signatures.
# (Crypto only)
#
#
#
# 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
+# 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)
#
#
# 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
+# if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address
# to determine the key to use. It will ask you to supply a key, if it can't find one.
# (S/MIME only)
#
#
#
# This 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
# Default: no
#
#
-# If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs.
+# If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs.
# (PGP 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,
+# circumstances. This can be overridden by use of the pgp menu,
# when inline is not required.
#
# Note that Mutt might automatically use PGP/MIME for messages
# which consist of more than a single MIME part. Mutt can be
# configured to ask before sending PGP/MIME messages when inline
# (traditional) would not work.
-# 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.
# 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.
#
# 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)
#
#
# 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)
#
#
# 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
+# checked with the <check-traditional-pgp> function, mutt will automatically
# check the message for traditional pgp.
#
#
# Default: ""
#
#
-# This format strings specifies a command which is used to decode
+# 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:
-#
+# 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.
#
#
# 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
+# 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)
#
#
# This command is invoked whenever mutt will need public key information.
-# %r is the only printf-like sequence used with this format.
+# Of the sequences supported by $pgp_decode_command, %r is the only
+# printf(3)-like sequence used with this format.
# (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)
#
#
#
#
# This command is used to decrypt a PGP encrypted message.
+#
+# This is a format string, see the $pgp_decode_command command for
+# possible printf(3)-like sequences.
# (PGP only)
#
#
# Default: ""
#
#
-# This format is used to create a old-style "clearsigned" PGP
+# This format is used to create a old-style ``clearsigned'' PGP
# message. Note that the use of this format is strongly
# deprecated.
+#
+# This is a format string, see the $pgp_decode_command command for
+# possible printf(3)-like sequences.
# (PGP only)
#
#
# Default: ""
#
#
-# This command is used to create the detached PGP signature for a
+# This command is used to create the detached PGP signature for a
# multipart/signed PGP/MIME body part.
+#
+# This is a format string, see the $pgp_decode_command command for
+# possible printf(3)-like sequences.
# (PGP only)
#
#
#
#
# This command is used to both sign and encrypt a body part.
+#
+# This is a format string, see the $pgp_decode_command command for
+# possible printf(3)-like sequences.
# (PGP only)
#
#
#
#
# This command is used to encrypt a body part without signing it.
+#
+# This is a format string, see the $pgp_decode_command command for
+# possible printf(3)-like sequences.
# (PGP only)
#
#
# Default: ""
#
#
-# This command is used to import a key from a message into
+# 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)
#
#
#
# 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)
#
#
#
# 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)
#
#
#
#
# This command is used to list the secret key ring's contents. The
-# output format must be analogous to the one used by
+# 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
+# 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)
#
#
#
#
# This command is used to list the public key ring's contents. The
-# output format must be analogous to the one used by
+# 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
+# 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)
#
#
#
# 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.
+# variable is only used if $mime_forward is set and
+# $mime_forward_decode is unset.
# (PGP only)
#
#
#
#
# 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.
+# Valid choices are ``des'', ``des3'', ``rc2-40'', ``rc2-64'', ``rc2-128''.
+# If unset, ``3des'' (TripleDES) is used.
# (S/MIME only)
#
#
# 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,
+# 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 one points to the location of the private keys.
+# edited. This option points to the location of the private keys.
# (S/MIME only)
#
#
# Default: ""
#
#
-# Since there is no pubring/secring as with PGP, mutt has to handle
+# 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 one points to
+# keyid pairs, and which can be manually edited. This option points to
# the location of the certificates.
# (S/MIME only)
#
# 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
+# 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.
# %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".
+# points to a directory or file, this expands to
+# ``-CApath $smime_ca_location'' or ``-CAfile $smime_ca_location''.
#
#
# For examples on how to configure these formats, see the smime.rc in
#
#
# 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)
#
#
#
# This command is used to verify S/MIME signatures of type
# application/x-pkcs7-mime.
+#
+# This is a format string, see the $smime_decrypt_command command for
+# possible printf(3)-like sequences.
# (S/MIME only)
#
#
#
# This 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)
#
#
# 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.
+#
+# This is a format string, see the $smime_decrypt_command command for
+# possible printf(3)-like sequences.
# (S/MIME only)
#
#
#
#
# This command is used to create encrypted S/MIME messages.
+#
+# This is a format string, see the $smime_decrypt_command command for
+# possible printf(3)-like sequences.
# (S/MIME only)
#
#
#
# This command is used to extract PKCS7 structures of S/MIME signatures,
# in order to extract the public X509 certificate(s).
+#
+# This is a format string, see the $smime_decrypt_command command for
+# possible printf(3)-like sequences.
# (S/MIME only)
#
#
#
#
# This command is used to extract X509 certificates from a PKCS7 structure.
+#
+# This is a format string, see the $smime_decrypt_command command for
+# possible printf(3)-like sequences.
# (S/MIME only)
#
#
#
# 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.
+# email's ``From:'' field.
+#
+# This is a format string, see the $smime_decrypt_command command for
+# possible printf(3)-like sequences.
# (S/MIME only)
#
#
#
#
# This command is used to import a certificate via smime_keys.
+#
+# This is a format string, see the $smime_decrypt_command command for
+# possible printf(3)-like sequences.
# (S/MIME only)
#
#
# 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).
+#
+# This is a format string, see the $smime_decrypt_command command for
+# possible printf(3)-like sequences.
# (S/MIME only)
#
#
# 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''.
+# option supersedes $ssl_starttls.
#
#
# set ssl_starttls=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
+# 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 are
+# certificate that is signed with one of these CA certificates is
# also automatically accepted.
#
-# Example: set certificate_file=~/.mutt/certificates
+# Example:
+# set certificate_file=~/.mutt/certificates
#
#
# set ssl_usesystemcerts=yes
#
#
# If set to yes, mutt will use CA certificates in the
-# system-wide certificate store when checking if server certificate
+# system-wide certificate store when checking if a server certificate
# is signed by a trusted CA.
#
#
#
# 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.
+# certificates is also automatically accepted.
#
-# Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
+# Example:
+# set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
#
#
# set pipe_split=no
# Default: no
#
#
-# Used in connection with the pipe-message command and the ``tag-
-# prefix'' operator. If this variable is unset, when piping a list of
+# 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
-# as a single folder. When set, Mutt will pipe the messages one by one.
+# 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.
+# and the $pipe_sep separator is added after each message.
#
#
# set pipe_decode=no
# Default: no
#
#
-# Used in connection with the pipe-message command. When unset,
+# 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
+# will weed headers and will attempt to decode the messages
# first.
#
#
#
# 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
+# try them. Authentication methods are either ``user'', ``apop'' or any
+# SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''.
+# This option is case-insensitive. If this option is unset
# (the default) mutt will try all available methods, in order from
# most-secure to least-secure.
#
-# Example: set pop_authenticators="digest-md5:apop:user"
+# Example:
+# set pop_authenticators="digest-md5:apop:user"
#
#
# set pop_auth_try_all=yes
# 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.
+# If set, Mutt will try all available authentication methods.
+# When unset, Mutt will only fall back to other authentication
+# methods if the previous methods are unavailable. If a method is
+# available but authentication fails, Mutt will not connect to the POP server.
#
#
# set pop_checkinterval=60
#
#
# If set, Mutt will delete successfully downloaded messages from the POP
-# server when using the fetch-mail function. When unset, Mutt will
+# server when using the <fetch-mail> function. When unset, Mutt will
# download messages but also leave them on the POP server.
#
#
# Default: ""
#
#
-# The name of your POP server for the fetch-mail function. You
+# The name of your POP server for the <fetch-mail> function. You
# can also specify an alternative port, username and password, ie:
-#
# [pop[s]://][username[:password]@]popserver[:port]
#
+# where ``[...]'' denotes an optional part.
+#
#
# set pop_last=no
#
# Default: no
#
#
-# If this variable is set, mutt will try to use the "LAST" POP command
+# 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.
+# the <fetch-mail> function.
#
#
# set pop_reconnect=ask-yes
# Default: ask-yes
#
#
-# Controls whether or not Mutt will try to reconnect to POP server if
+# Controls whether or not Mutt will try to reconnect to the POP server if
# the connection is lost.
#
#
#
#
# Specifies the password for your POP account. If unset, Mutt will
-# prompt you for your password when you open POP mailbox.
+# 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.
# Default: ""
#
#
-# Similar to the ``$attribution'' variable, Mutt will append this
+# Similar to the $attribution variable, Mutt will append this
# string after the inclusion of a message which is being replied to.
#
#
# Default: ask-yes
#
#
-# Controls whether or not messages are saved in the ``$postponed''
-# mailbox when you elect not to send immediately. Also see the
-# ``$recall'' variable.
+# Controls whether or not messages are saved in the $postponed
+# mailbox when you elect not to send immediately.
+#
+# Also see the $recall variable.
#
#
# set postponed="~/postponed"
#
# 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.
+# in the mailbox specified by this variable.
+#
+# Also see the $postpone variable.
#
#
# set preconnect=""
# 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:
-#
-# preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net
+# 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'.
+# 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
+# Note: For this example to work, you must be able to log in to the
# remote machine without having to enter a password.
#
#
#
#
# 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).
+# This is set to ``ask-no'' by default, because some people
+# accidentally hit ``p'' often.
#
#
# set print_command="lpr"
# Default: yes
#
#
-# Used in connection with the print-message command. If this
+# 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
# Default: no
#
#
-# Used in connection with the print-message command. If this option
+# 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,
+# 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.
# Default: yes
#
#
-# If you use an external ``$pager'', setting this variable will
+# 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.
#
#
# This specifies the command that mutt will use to make external address
-# queries. The string should contain a %s, which will be substituted
+# queries. The string should contain a ``%s'', which will be substituted
# with the query string the user types. See ``query'' for more
# information.
#
# 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:
-#
+# 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
+# %>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, see the ``$status_format'' documentation.
+# * = can be optionally printed if nonzero, see the $status_format documentation.
#
#
# set quit=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
+# 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.
#
# Default: "^([ \t]*[|>:}#])+"
#
#
-# A regular expression used in the internal-pager to determine quoted
-# sections of text in the body of a message.
+# 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.
#
-# 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.
+# Match detection may be overridden by the $smileys regular expression.
#
#
# set read_inc=10
# 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
+# 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'' variable and the ``Tuning'' section of the
-# manual for performance considerations.
+# Also see the $write_inc, $net_inc and $time_inc variables and the
+# ``tuning'' section of the manual for performance considerations.
#
#
# set read_only=no
# Default: ""
#
#
-# This variable specifies what "real" or "personal" name should be used
+# 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
#
#
# Controls whether or not Mutt recalls postponed messages
-# when composing a new message. Also see ``$postponed''.
+# when composing a new message.
#
-# Setting this variable to ``yes'' is not generally useful, and thus not
+# Setting this variable to is not generally useful, and thus not
# recommended.
#
+# Also see $postponed variable.
+#
#
# set record="~/sent"
#
# This specifies the file into which your outgoing messages should be
# appended. (This is meant as the primary method for saving a copy of
# your messages, but another way to do this is using the ``my_hdr''
-# command to create a Bcc: field with your email address in it.)
+# 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.
+# The value of $record is overridden by the $force_name and
+# $save_name variables, and the ``fcc-hook'' command.
#
#
# set reply_regexp="^(re([\\[0-9\\]+])*|aw):[ \t]*"
# assume that you want to reply to the recipients of that message rather
# than to yourself.
#
+# Also see the ``alternates'' command.
+#
#
# set reply_to=ask-yes
#
# Default: no
#
#
-# This variable controls whether or not Mutt will display the "personal"
+# This variable controls whether or not Mutt will display the ``personal''
# name from your aliases in the index menu if it finds an alias that
# matches the message's sender. For example, if you have the following
# alias:
-#
# alias juser abd30425@somewhere.net (Joe User)
#
# and then you receive mail which contains the following header:
-#
# From: abd30425@somewhere.net
#
# It would be displayed in the index menu as ``Joe User'' instead of
# ``abd30425@somewhere.net.'' This is useful when the person's e-mail
-# address is not human friendly (like CompuServe addresses).
+# address is not human friendly.
#
#
# set reverse_name=no
# 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
+# ``alternates''. If the variable is unset, or the address that would be
+# used doesn't match your ``alternates'', the From: line will use
# your address on the current machine.
#
+# Also see the ``alternates'' command.
+#
#
# set reverse_realname=yes
#
# Default: yes
#
#
-# This variable fine-tunes the behaviour of the reverse_name feature.
+# 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.
+# override any such real names with the setting of the $realname variable.
#
#
# set rfc2047_parameters=no
# Default: no
#
#
-# When this variable is set, Mutt will decode RFC-2047-encoded MIME
+# 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 this:
+# to save attachments to files named like:
# =?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.
+# When this variable is set interactively, the change won't be
+# active until you change folders.
#
-# Note that this use of RFC 2047's encoding is explicitly,
+# Note that this use of RFC2047's encoding is explicitly
# prohibited by the standard, but nevertheless encountered in the
# wild.
-# Also note that setting this parameter will not have the effect
+#
+# 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.
+# unconditionally use the encoding specified in RFC2231.
#
#
# set save_address=no
#
#
# 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.
+# 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 save_empty=yes
#
#
# When unset, mailboxes which contain no saved messages will be removed
-# when closed (the exception is ``$spoolfile'' which is never removed).
+# when closed (the exception is $spoolfile which is never removed).
# If set, mailboxes are never removed.
#
# Note: This only applies to mbox and MMDF folders, Mutt does not
# Default: 0
#
#
-# This variable controls the size of the history saved in the
-# ``$history_file'' file.
+# This variable controls the size of the history (per category) saved in the
+# $history_file file.
#
#
# set save_name=no
# 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
+# 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.
+# $record mailbox.
#
-# Also see the ``$force_name'' variable.
+# Also see the $force_name variable.
#
#
# set score=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.
+# $score_threshold_delete variable and related are used.
#
#
# set score_threshold_delete=-1
# Default: 9999
#
#
-# Messages which have been assigned a score greater than or equal to this
+# Messages which have been assigned a score greater than or equal to this
# variable's value are automatically marked "flagged".
#
#
#
# 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
+# 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".
+# ``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.
+# mutt uses $charset as a fallback.
#
#
# set sendmail="/usr/sbin/sendmail -oem -oi"
# Default: 0
#
#
-# Specifies the number of seconds to wait for the ``$sendmail'' process
+# 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:
# 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
+# If set, a line containing ``-- '' (note the trailing space) will be inserted before your
+# $signature. It is strongly recommended that you not unset
+# this variable unless your signature contains just your name. The
# reason for this is because many software packages use ``-- \n'' to
# detect your signature. For example, Mutt has the ability to highlight
# the signature in a different color in the builtin pager.
# 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.
+# its standard output.
#
#
# set simple_search="~f %s | ~s %s"
#
#
# Specifies how Mutt should expand a simple search into a real search
-# pattern. A simple search is one that does not contain any of the ~
+# pattern. A simple search is one that does not contain any of the ``~'' pattern
# 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:
-#
-# ~f joe | ~s joe
+# 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 smart_wrap=yes
# 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.
+# $markers variable.
#
#
# set smileys="(>From )|(:[-^]?[][)(><}{|/DP])"
#
#
# The pager uses this variable to catch some common false
-# positives of ``$quote_regexp'', most notably smileys in the beginning
-# of a line
+# 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 sleep_time=1
#
# 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
+# messages from the current folder. The default is to pause one second, so
# a value of zero for this option suppresses the pause.
#
#
# attempt to use to log in to an SMTP server, in the order mutt should
# try them. Authentication methods are any SASL mechanism, eg
# ``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
+# Defines the SMTP smarthost where sent messages should relayed for
# delivery. This should take the form of an SMTP URL, eg:
-#
# 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.
#
#
# 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
+# the subjects like ``hi'' which will get grouped together. See also
+# $sort_re for a less drastic way of controlling this
# behaviour.
#
#
#
#
# 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.
#
#
# 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,
+# 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 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
#
#
# 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:
-#
-# tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
+# preauthenticated connections to your IMAP/POP3/SMTP server. Example:
+# set 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.
#
#
# 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
+# Specifies the visual editor to invoke when the ``~v'' command is
# given in the builtin editor.
#
#
# 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,
# 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_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.
+# Also see the $read_inc, $net_inc and $time_inc variables and the
+# ``tuning'' section of the manual for performance considerations.
#
#
# set write_bcc=yes
# Default: yes
#
#
-# Controls whether mutt writes out the Bcc header when preparing
+# 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
+# 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.
#
#
projects / software / mutt-debian.git / blobdiff