Table of Contents
+
Table of Contents
Running mutt with no arguments will make Mutt attempt to read your spool
mailbox. However, it is possible to read other mailboxes and
to send messages from the command line as well.
-
- -
Table 8.1. Command line options
| Option | Description |
|---|---|
| -A | expand an alias |
| -a | attach a file to a message |
| -b | specify a blind carbon-copy (BCC) address |
| -c | specify a carbon-copy (Cc) address |
| -D | print the value of all mutt variables to stdout |
| -e | specify a config command to be run after initialization files are read |
| -f | specify a mailbox to load |
| -F | specify an alternate file to read initialization commands |
| -h | print help on command line options |
| -H | specify a draft file from which to read a header and body |
| -i | specify a file to include in a message composition |
| -m | specify a default mailbox type |
| -n | do not read the system Muttrc |
| -p | recall a postponed message |
| -Q | query a configuration variable |
| -R | open mailbox in read-only mode |
| -s | specify a subject (enclose in quotes if it contains spaces) |
| -v | show version number and compile-time definitions |
| -x | simulate the mailx(1) compose mode |
| -y | show a menu containing the files specified by the mailboxes command |
| -z | exit immediately if there are no messages in the mailbox |
| -Z | open the first folder with new message,exit immediately if none |
-
-
+
Table 8.1. Command line options
| Option | Description |
|---|---|
| -A | expand an alias |
| -a | attach a file to a message |
| -b | specify a blind carbon-copy (BCC) address |
| -c | specify a carbon-copy (Cc) address |
| -D | print the value of all mutt variables to stdout |
| -e | specify a config command to be run after initialization files are read |
| -f | specify a mailbox to load |
| -F | specify an alternate file to read initialization commands |
| -h | print help on command line options |
| -H | specify a draft file from which to read a header and body |
| -i | specify a file to include in a message composition |
| -m | specify a default mailbox type |
| -n | do not read the system Muttrc |
| -p | recall a postponed message |
| -Q | query a configuration variable |
| -R | open mailbox in read-only mode |
| -s | specify a subject (enclose in quotes if it contains spaces) |
| -v | show version number and compile-time definitions |
| -x | simulate the mailx(1) compose mode |
| -y | show a menu containing the files specified by the mailboxes command |
| -z | exit immediately if there are no messages in the mailbox |
| -Z | open the first folder with new message,exit immediately if none |
To read messages in a mailbox -
-mutt [ -nz ] [ -F muttrc ] [ -m type ] [ -f mailbox ]
-
+
mutt [-nz] [-F
+muttrc
+] [-m
+type
+] [-f
+mailbox
+]
To compose a new message -
-mutt [ -n ] [ -F muttrc ] [ -a file ] [ -c address ] [ -i filename ] [ -s subject ]
-[ [ file ... ] -- ] address [ address ... ]
-
-Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect +
mutt [-n] [-F
+muttrc
+] [-a
+file
+] [-c
+address
+] [-i
+filename
+] [-s
+subject
+] [
+[
+file
+...]
+ --
+]
+address
+ [
+address
+...]
+Mutt also supports a âbatchâ mode to send prepared messages. Simply redirect input from the file you wish to send. For example,
mutt -s "data set for run #2" professor@bigschool.edu
< Ë/run2.dat
-This command will send a message to ``professor@bigschool.edu'' with a subject -of ``data set for run #2''. In the body of the message will be the contents -of the file ``Ë/run2.dat''. +This command will send a message to âprofessor@bigschool.eduâ with a subject +of âdata set for run #2â. In the body of the message will be the contents +of the file âË/run2.datâ.
All files passed with -a file will be attached as a MIME
-part to the message. To attach several files, use ``--'' to separate files and
+part to the message. To attach several files, use â--â to separate files and
recipient addresses: mutt -a *.png -- some@one.org
The following are the commands understood by mutt. -
- -
-account-hook pattern command
-
-alias [ -group name [ ... ] ] key address [ , address, ... ]
-
-unalias [ * | key ... ]
-
-alternates [ -group name [ ... ] ] regexp [ regexp ... ]
-
-unalternates [ * | regexp ... ]
-
-alternative-order mimetype [ mimetype ... ]
-
-unalternative-order mimetype [ mimetype ... ]
-
-auto_view mimetype [ mimetype ... ]
-
-unauto_view mimetype [ mimetype ... ]
-
-bind map key function
-
-charset-hook alias charset
-
-iconv-hook charset local-charset
-
-color object foreground background [ regexp ]
-
-uncolor index pattern [ pattern ... ]
-
-exec function [ function ... ]
-
-fcc-hook pattern mailbox
-
-fcc-save-hook pattern mailbox
-
-folder-hook pattern command
-
-hdr_order header [ header ... ]
-
-unhdr_order header [ header ... ]
-
-ignore pattern [ pattern ... ]
-
-unignore pattern [ pattern ... ]
-
-lists [ -group name [ ... ] ] regexp [ regexp ... ]
-
-unlists regexp [ regexp ... ]
-
-macro menu key sequence [ description ]
-
-mailboxes filename [ filename ... ]
-
-mbox-hook pattern mailbox
-
-message-hook pattern command
-
-mime_lookup mimetype [ mimetype ... ]
-
-unmime_lookup mimetype [ mimetype ... ]
-
-mono object attribute [ regexp ]
-
-unmono index pattern [ pattern ... ]
-
-my_hdr string
-
-unmy_hdr field [ field ... ]
-
-crypt-hook pattern key-id
-
-push string
-
-reset variable [variable ... ]
-
-save-hook regexp filename
-
-score pattern value
-
-unscore pattern [ pattern ... ]
-
-reply-hook pattern command
-
-send-hook pattern command
-
-send2-hook pattern command
-
-set [no|inv]variable[=value] [ variable ... ]
-
-unset variable [variable ... ]
-
-source filename
-
-spam pattern format
-
-nospam pattern
-
-subscribe [ -group name [ ... ] ] regexp [ regexp ... ]
-
-unsubscribe regexp [ regexp ... ]
-
-toggle variable [variable ... ]
-
-unhook hook-type
-
- -
Type:Â quadoption
+
account-hook
+pattern
+command
+
alias [
+-group
+name
+...]
+key
+
+address
+ [
+address
+...]
unalias [
+-group
+name
+...] {
+*
+ |
+key
+... }
alternates [
+-group
+name
+...]
+regexp
+ [
+regexp
+...]
unalternates [
+-group
+name
+...] {
+*
+ |
+regexp
+... }
alternative-order
+mimetype
+ [
+mimetype
+...]
unalternative-order {
+*
+ |
+mimetype
+... }
auto-view
+mimetype
+ [
+mimetype
+...]
unauto-view {
+*
+ |
+mimetype
+... }
bind
+map
+
+key
+
+function
+
charset-hook
+alias
+
+charset
+
iconv-hook
+charset
+
+local-charset
+
color
+object
+
+foreground
+
+background
+
color {
+header
+ |
+body
+ }
+foreground
+
+background
+
+regexp
+
color
+index
+
+foreground
+
+background
+
+pattern
+
uncolor
+index
+
+pattern
+...
exec
+function
+ [
+function
+...]
fcc-hook
+[!]pattern
+
+mailbox
+
fcc-save-hook
+[!]pattern
+
+mailbox
+
folder-hook
+[!]regexp
+
+command
+
group [
+-group
+name
+...] {
+-rx
+expr
+... |
+-addr
+expr
+... }
ungroup [
+-group
+name
+...] {
+*
+ |
+-rx
+expr
+... |
+-addr
+expr
+... }
hdr_order
+header
+ [
+header
+...]
unhdr_order {
+*
+ |
+header
+... }
ignore
+pattern
+ [
+pattern
+...]
unignore {
+*
+ |
+pattern
+... }
lists [
+-group
+name
+]
+regexp
+ [
+regexp
+...]
unlists [
+-group
+name
+...] {
+*
+ |
+regexp
+... }
macro
+menu
+
+key
+
+sequence
+ [
+description
+]
mailboxes
+mailbox
+ [
+mailbox
+...]
unmailboxes {
+*
+ |
+mailbox
+... }
mbox-hook
+[!]pattern
+
+mailbox
+
message-hook
+[!]pattern
+
+command
+
mime-lookup
+mimetype
+ [
+mimetype
+...]
unmime-lookup {
+*
+ |
+mimetype
+... }
mono
+object
+
+attribute
+
mono {
+header
+ |
+body
+ }
+attribute
+
+regexp
+
mono
+index
+
+attribute
+
+pattern
+
unmono
+index
+ {
+*
+ |
+pattern
+... }
my_hdr
+string
+
unmy_hdr {
+*
+ |
+field
+... }
crypt-hook
+pattern
+
+keyid
+
push
+string
+
reset
+variable
+ [
+variable
+...]
save-hook
+[!]pattern
+
+mailbox
+
score
+pattern
+
+value
+
unscore {
+*
+ |
+pattern
+... }
reply-hook
+[!]pattern
+
+command
+
send-hook
+[!]pattern
+
+command
+
send2-hook
+[!]pattern
+
+command
+
set {
+[ no | inv ]
+variable
+ |
+variable=value
+ } [...]
unset
+variable
+ [
+variable
+...]
source
+filename
+
spam
+pattern
+
+format
+
nospam {
+*
+ |
+pattern
+ }
subscribe [
+-group
+name
+...]
+regexp
+ [
+regexp
+...]
unsubscribe [
+-group
+name
+...] {
+*
+ |
+regexp
+... }
toggle
+variable
+ [
+variable
+...]
unhook {
+*
+ |
+hook-type
+ }
Type:Â quadoption
Default:Â ask-yes
If set to yes, when composing messages and no subject is given at the subject prompt, composition will be aborted. If set to @@ -154,153 +377,162 @@ editing the message body if no changes are made to the file (this check only happens after the first edit of the file). When set to no, composition will never be aborted.
Type:Â path
-Default:Â "Ë/.muttrc"
-The default file in which to save aliases created by the
-``create-alias'' function.
+Default: âË/.muttrcâ
+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. +âË/.muttrcâ if no user muttrc was found.
Type:Â string
-Default: "%4n %2f %t %-10a   %r"
-Specifies the format of the data displayed for the `alias' menu. The -following printf(3)-style sequences are available: -
+Default: â%4n %2f %t %-10a   %râ
+Specifies the format of the data displayed for the âaliasâ menu. The
+following printf(3)-style sequences are available:
alias name -
flags - currently, a "d" for an alias marked for deletion +
flags - currently, a âdâ for an alias marked for deletion
index number
address which alias expands to
character which indicates if the alias is tagged for inclusion -
-
Type:Â boolean
Default:Â yes
Controls whether 8-bit data is converted to 7-bit using either Quoted- Printable or Base64 encoding when sending mail.
Type:Â boolean
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, +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).
Type:Â boolean
Default:Â no
-When set, an arrow (``->'') will be used to indicate the current entry +When set, an arrow (â->â) will be used to indicate the current entry in menus instead of highlighting the whole line. On slow network or modem links this will make response faster because there is less that has to be redrawn on the screen when moving to the next or previous entries in the menu.
Type:Â boolean
Default:Â no
-If set, Mutt will use plain ASCII characters when displaying thread +If set, Mutt will use plain ASCII characters when displaying thread and attachment trees, instead of the default ACS characters.
Type:Â boolean
Default:Â no
-If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients +If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients before editing an outgoing message.
Type:Â boolean
Default:Â no
-If set, Mutt will prompt you for carbon-copy (Cc) recipients before +If set, Mutt will prompt you for carbon-copy (Cc) recipients before editing the body of an outgoing message.
This variable is a colon-separated list of character encoding schemes for messages without character encoding indication. 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.
Type:Â string
-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: -
+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(3)-style sequences are understood:
charset -
requires charset conversion (n or c) +
requires charset conversion (ânâ or âcâ)
deleted flag
description
MIME content-transfer-encoding
filename -
disposition (I=inline, A=attachment) +
disposition (âIâ for inline, âAâ for attachment)
major MIME type
MIME subtype
attachment number -
"Q", if MIME part qualifies for attachment counting +
âQâ, if MIME part qualifies for attachment counting
size
tagged flag
graphic tree characters
unlink (=to delete) flag
number of qualifying MIME parts in this part and its children -(please see the ``attachments'' section for possible speed effects) -
right justify the rest of the string and pad with character "X" -
pad to the end of the line with character "X" -
soft-fill with character "X" as pad +(please see the âattachmentsâ section for possible speed effects) +
right justify the rest of the string and pad with character âXâ +
pad to the end of the line with character â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.
The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments.
Type:Â boolean
Default:Â yes
-If this variable is unset, when operating (saving, printing, piping, +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.
Type:Â string
-Default: "On %d, %n wrote:"
+Default: âOn %d, %n wrote:â
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.
Type:Â boolean
Default:Â no
-When set along with ``$edit_headers'', Mutt will skip the initial -send-menu and allow you to immediately begin editing the body of your +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.
Type:Â boolean
Default:Â no
-When set, functions in the index menu which affect a message
+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.
Type:Â boolean
Default:Â yes
-When this variable is set, mutt will beep when an error occurs. +When this variable is set, mutt will beep when an error occurs.
Type:Â boolean
Default:Â no
-When this variable is set, mutt will beep whenever it prints a message +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.
Type:Â quadoption
Default:Â ask-yes
Controls whether you will be asked to confirm bouncing messages. @@ -309,23 +541,38 @@ message. Setting this variable to no is n and thus not recommended, because you are unable to bounce messages.
Type:Â boolean
Default:Â yes
-When this variable is set, mutt will include Delivered-To headers when -bouncing messages. Postfix users may wish to unset this variable. +When this variable is set, mutt will include Delivered-To headers when +bouncing messages. Postfix users may wish to unset this variable.
Type:Â boolean
Default:Â no
-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 +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 unset by default because many visual terminals don't permit making the cursor invisible.
Type:Â boolean
Default:Â no
-When this variable is set, mutt will use file size attribute instead of -access time when checking for new mail. +When this variable is set, mutt will use file size attribute instead of +access time when checking for new mail in mbox and mmdf folders. +
+This variable is unset by default and should only be enabled when +new mail detection for these folder types is unreliable or doesn't work. +
+Note that enabling this variable should happen before any âmailboxesâ +directives occur in configuration files regarding mbox or mmdf folders +because mutt needs to determine the initial new mail status of such a +mailbox by performing a fast mailbox scan when it is defined. +Afterwards the new mail status is tracked by file size changes.
Character set your terminal uses to display and enter textual data. -It is also the fallback for $send_charset. +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.
Type:Â boolean
Default:Â yes
Note: this option only affects maildir and MH style @@ -335,7 +582,7 @@ When set, Mutt will check for new mail de 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.
When set, Mutt will jump to the next unread message, if any, when the current thread is uncollapsed.
Type:Â string
-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: -
+Default: â-- Mutt: Compose  [Approx. msg size: %l   Atts: %a]%>-â
+Controls the format of the status line displayed in the âcomposeâ
+menu. This string is similar to $status_format, but has its own
+set of printf(3)-like sequences:
-
total number of attachments +
total number of attachments
local hostname
approximate size (in bytes) of the current message
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.
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).
Type:Â boolean
Default:Â yes
-When set, Mutt will prompt for confirmation when appending messages to +When set, Mutt will prompt for confirmation when appending messages to an existing mailbox.
Type:Â boolean
Default:Â yes
-When set, Mutt will prompt for confirmation when saving messages to a +When set, Mutt will prompt for confirmation when saving messages to a mailbox which does not yet exist before creating it.
Type:Â number
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.
Sets the default Content-Type for the body of newly composed messages.
Type:Â quadoption
Default:Â yes
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â.
Type:Â boolean
Default:Â no
This variable controls the use of the GPGME-enabled crypto backends. -If it is set and Mutt was built with gpgme support, the gpgme code for +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.
Type:Â boolean
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).
Type:Â boolean
Default:Â yes
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.
Type:Â boolean
Default:Â 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.
Type:Â string
-Default: "!%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.
+Default: â!%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(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 +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).
Type:Â string
-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
+Default: âËf %s !ËP | (ËP ËC %s)â
+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 +âalternatesâ) and is to or cc'ed to a user matching the given regular expression.
Type:Â quadoption
Default:Â ask-yes
@@ -448,18 +702,18 @@ or when you save it to another folder.
Type:Â boolean
Default:Â yes
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.
When set, specifies a command used to filter messages. When a message -is viewed it is passed as standard input to $display_filter, and the +is viewed it is passed as standard input to $display_filter, and the filtered message is read from the standard output.
Type:Â path
-Default:Â "/usr/local/bin/mutt_dotlock"
-Contains the path of the mutt_dotlock (8) binary to be used by
+Default:Â â/usr/local/bin/mutt_dotlockâ
+Contains the path of the mutt_dotlock(8) binary to be used by
mutt.
This variable sets the request for when notification is returned. The string consists of a comma separated list (no spaces!) of one or more of the following: never, to never request notification, @@ -467,32 +721,40 @@ of the following: never, to never request delay, to be notified of message delays, success, to be notified of successful transmission.
-Example: set dsn_notify="failure,delay" -
-Note: when using $sendmail for delivery, you should not enable +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.
+providing a sendmail(1)-compatible interface supporting the -N option
+for DSN. For SMTP delivery, DSN support is autodetected so that it
+depends on the server whether DSN will be used or not.
This variable controls how much of your message is returned in DSN 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 -
-Note: when using $sendmail for delivery, you should not enable +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.
+providing a sendmail(1)-compatible interface supporting the -R option
+for DSN. For SMTP delivery, DSN support is autodetected so that it
+depends on the server whether DSN will be used or not.
Type:Â boolean
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.
Type:Â boolean
Default:Â no
This option allows you to edit the header of your outgoing messages @@ -501,55 +763,55 @@ along with the body of your message. Note that changes made to the References: and Date: headers are ignored for interoperability reasons.
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.
Type:Â boolean
Default:Â 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).
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.
Escape character to use for functions in the builtin editor.
Type:Â boolean
Default:Â no
-When set, the initial prompt for recipients and subject are skipped +When set, the initial prompt for recipients and subject are skipped when replying to messages, and the initial prompt for subject is skipped when forwarding messages.
-Note: this variable has no effect when the ``$autoedit'' -variable is set. +Note: this variable has no effect when the $autoedit +variable is set.
Type:Â boolean
Default:Â yes
This variable controls whether or not attachments on outgoing messages are saved along with the main body of your message.
Type:Â boolean
Default:Â no
-When this variable is set, FCCs will be stored unencrypted and +When this variable is set, FCCs will be stored unencrypted and unsigned, even when the actual message is encrypted and/or signed. (PGP only)
Type:Â path
-Default:Â "Ë/Mail"
-Specifies the default location of your mailboxes. A `+' or `=' at the
+Default: âË/Mailâ
+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.
Type:Â string
-Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"
+Default: â%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:
current file number
date/time folder was last modified @@ -559,27 +821,27 @@ its own set of printf()-like sequences:
number of hard links
N if folder has new mail, blank otherwise
size in bytes -
* if the file is tagged, blank otherwise +
â*â if the file is tagged, blank otherwise
owner name (or numeric uid, if missing) -
right justify the rest of the string and pad with character "X" -
pad to the end of the line with character "X" -
soft-fill with character "X" as pad +
right justify the rest of the string and pad with character âXâ +
pad to the end of the line with character â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.
Type:Â boolean
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. +the âsubscribeâ or âlistsâ commands.
This field has two purposes. First, preventing you from 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 @@ -587,66 +849,65 @@ sent to both the list and your address, resulting in two copies of the same email for you.
Type:Â boolean
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.
Type:Â boolean
Default:Â yes
-Controls the decoding of complex MIME messages into text/plain when
+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.
Type:Â quadoption
Default:Â yes
This quadoption controls whether or not the user is automatically placed in the editor when forwarding messages. For those who always want -to forward with no modification, use a setting of ``no''. +to forward with no modification, use a setting of ânoâ.
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.
Type:Â boolean
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.
Type: e-mail address
-Default:Â ""
-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. +Default:Â (empty)
+When set, this variable contains a default from address. It +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.
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â.
Type:Â boolean
Default:Â yes
-When unset, the header fields normally added by the ``my_hdr'' +When unset, the header fields normally added by the âmy_hdrâ command are not created. This variable must be unset before -composing a new message or replying in order to take effect. If set, +composing a new message or replying in order to take effect. If set, the user defined header fields are added to every new message.
Type:Â boolean
Default:Â no
-When set, this variable causes Mutt to include the header +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.
Type:Â boolean
Default:Â yes
-When set, help lines describing the bindings for the major functions +When set, help lines describing the bindings for the major functions provided by each menu are displayed on the first line of the screen.
Note: The binding will not be displayed correctly if the @@ -656,89 +917,93 @@ running. Since this variable is primarily aimed at new users, neither of these should present a major problem.
Type:Â boolean
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.
Type:Â boolean
Default:Â no
-When set, mutt will not show the presence of messages that are hidden +When set, mutt will not show the presence of messages that are hidden by limiting, in the thread tree.
Type:Â boolean
Default:Â yes
-When set, mutt will not show the presence of missing messages in the +When set, mutt will not show the presence of missing messages in the thread tree.
Type:Â boolean
Default:Â yes
-When set, mutt will not show the subject of messages in the thread +When set, mutt will not show the subject of messages in the thread tree that have the same subject as their parent or closest previously displayed sibling.
Type:Â boolean
Default:Â no
-When set, mutt will not show the presence of messages that are hidden +When set, mutt will not show the presence of messages that are hidden by limiting, at the top of threads in the thread tree. Note that when -$hide_limited is set, this option will have no effect. +$hide_limited is set, this option will have no effect.
Type:Â boolean
Default:Â yes
-When set, mutt will not show the presence of missing messages at the -top of threads in the thread tree. Note that when $hide_missing is -set, this option will have no effect. +When set, mutt will not show the presence of missing messages at the +top of threads in the thread tree. Note that when $hide_missing is +set, this option will have no effect.
Type:Â number
Default:Â 10
This variable controls the size (in number of strings remembered) of -the string history buffer. The buffer is cleared each time the +the string history buffer per category. The buffer is cleared each time the variable is set.
The file in which Mutt will save its history.
Type:Â quadoption
Default:Â yes
This variable controls whether or not a Mail-Followup-To header is honored when group-replying to a message.
Specifies the fully-qualified hostname of the system mutt is running on containing the host's name and the DNS domain it belongs to. It is used -as the domain part (after ``@'') for local email addresses as well as +as the domain part (after â@â) for local email addresses as well as Message-Id headers.
Its value is determined at startup as follows: If the node's name
-as returned by the uname(3) function contains the hostname and the
-domain, these are used to construct $hostname. If there is no
-domain part returned, Mutt will look for a ``domain'' or ``search''
-line in /etc/resolv.conf to determine the domain. Optionally, Mutt
+as returned by the uname(3) function contains the hostname and the
+domain, these are used to construct $hostname. If there is no
+domain part returned, Mutt will look for a âdomainâ or âsearchâ
+line in /etc/resolv.conf to determine the domain. Optionally, Mutt
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.
Type:Â boolean
Default:Â 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.
Type:Â boolean
Default:Â no
-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
+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 authentication fails, mutt will not connect to the IMAP server. @@ -746,19 +1011,25 @@ authentication fails, mutt will not connect to the IMAP server. Default:Â no
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.
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.
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.
Type:Â boolean
Default:Â no
When set, mutt will attempt to use the IMAP IDLE extension @@ -779,16 +1050,18 @@ getting disconnected from your IMAP server due to inactivity. Default:Â 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.
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.
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. @@ -805,62 +1078,74 @@ When set, mutt will avoid implicitly mark you fetch a message from the server. This is generally a good thing, but can make closing an IMAP folder somewhat slower. This option exists to appease speed freaks. -
Type:Â boolean
+
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. +
Type:Â boolean
Default:Â yes
When set, mutt will display warning messages from the IMAP server as error messages. Since these messages are often harmless, or generated due to configuration problems on the server which are out of the users' hands, you may wish to suppress them at some point. -
Type:Â string
+Default:Â (empty)
The name of the user whose mail you intend to access on the IMAP server.
This variable defaults to your user name on the local machine. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-If set to ``yes'', mutt will look for a mailcap entry with the
-copiousoutput flag set for every MIME attachment it doesn't have
+If set to âyesâ, mutt will look for a mailcap entry with the
+â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.
-
Type:Â quadoption
+
Type:Â quadoption
Default:Â ask-yes
Controls whether or not a copy of the message(s) you are replying to is included in your reply. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
Controls whether or not Mutt includes only the first attachment of the message you are replying. -
Type:Â string
+Default:Â â>Â â
Specifies the string to prepend to each line of text quoted in a message to which you are replying. You are strongly encouraged not to 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. -
Type:Â string
-Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"
+$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.
+
Type:Â string
+Default: â%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:
-
address of the author
reply-to address (if present; otherwise: address of author) -
filename of the original message folder (think mailBox) +
filename of the original message folder (think mailbox)
the list to which the letter was sent, or else the folder name (%b).
number of characters (bytes) in the message
current message number
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
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
current message number in thread
number of messages in current thread
sender (address + real name), either From: or Return-Path: @@ -869,259 +1154,271 @@ The following sequences are defined in Mutt:
message-id of the current message
number of lines in the message (does not work with maildir, mh, and possibly IMAP folders) -
If an address in the To or CC header field matches an address -defined by the users ``subscribe'' command, this displays +
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.
total number of message in the mailbox
number of hidden messages if the thread is collapsed.
message score
author's real name (or address if missing) -
(_O_riginal save folder) Where mutt would formerly have -stashed the message: list name or recipient name if no list +
original save folder where mutt would formerly have +stashed the message: list name or recipient name +if not sent to a list
progress indicator for the builtin pager (how much of the file has been displayed)
subject of the message -
status of the message (N/D/d/!/r/*) -
`to:' field (recipients) -
the appropriate character from the $to_chars string +
status of the message (âNâ/âDâ/âdâ/â!â/ârâ/*) +
âTo:â field (recipients) +
the appropriate character from the $to_chars string
user (login) name of the author
first name of the author, or the recipient if the message is from you
number of attachments -(please see the ``attachments'' section for possible speed effects) -
`x-label:' field, if present -
`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'. +(please see the âattachmentsâ section for possible speed effects) +
âX-Label:â field, if present +
â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:â.
message status flags
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
+time zone, and âfmtâ is expanded by the library function
+strftime(3); a leading bang disables locales
the date and time of the message is converted to the local
-time zone, and ``fmt'' is expanded by the library function
-``strftime''; a leading bang disables locales
+time zone, and âfmtâ is expanded by the library function
+strftime(3); a leading bang disables locales
the local date and time when the message was received.
-``fmt'' is expanded by the library function ``strftime'';
+âfmtâ is expanded by the library function strftime(3);
a leading bang disables locales
-
the current local time. ``fmt'' is expanded by the library -function ``strftime''; a leading bang disables locales. -
right justify the rest of the string and pad with character "X" -
pad to the end of the line with character "X" -
soft-fill with character "X" as pad +
the current local time. âfmtâ is expanded by the library
+function strftime(3); a leading bang disables locales.
+
right justify the rest of the string and pad with character âXâ +
pad to the end of the line with character â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 -``save-hook'', ``fcc-hook'' and ``fcc-save-hook'', too. -
-See also: ``$to_chars''. -
Type:Â path
-Default:Â "ispell"
+Note that these expandos are supported in +âsave-hookâ, âfcc-hookâ and âfcc-save-hookâ, too. +
Type:Â path
+Default:Â âispellâ
How to invoke ispell (GNU's spell-checking software). -
Type:Â boolean
-Default:Â no
-If set, read messages marked as flagged will not be moved -from your spool mailbox to your ``$mbox'' mailbox, or as a result of -a ``mbox-hook'' command. -
Type:Â string
-Default:Â "C"
-The locale used by strftime(3) to format dates. Legal values are -the strings your system accepts for the locale variable LC_TIME. -
Type:Â number
+
Type:Â boolean
+Default:Â no
+If set, read messages marked as flagged will not be moved +from your spool mailbox to your $mbox mailbox, or as a result of +a âmbox-hookâ command. +
Type:Â string
+Default:Â âCâ
+The locale used by strftime(3) to format dates. Legal values are
+the strings your system accepts for the locale environment variable $LC_TIME.
+
Type:Â number
Default:Â 5
This variable configures how often (in seconds) mutt should look for -new mail. Also see the ``$timeout'' variable. -
Type:Â string
+Default:Â (empty)
This variable specifies which files to consult when attempting to display MIME bodies not directly supported by Mutt. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-If set, mutt will restrict possible characters in mailcap % expandos +If set, mutt will restrict possible characters in mailcap % expandos to a well-defined set of safe characters. This is the safe setting, but we are not sure it doesn't break some more advanced MIME stuff.
DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE DOING! -
Type:Â path
-Default:Â ""
-The header_cache variable points to the header cache database. -If header_cache points to a directory it will contain a header cache -database per folder. If header_cache points to a file that file will -be a single global header cache. By default it is unset so no header +
Type:Â path
+Default:Â (empty)
+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. -
Type:Â boolean
+
+Header caching can greatly improve speed when opening POP, IMAP +MH or Maildir folders, see âcachingâ for details. +
Type:Â boolean
Default:Â 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. -
Type:Â string
-Default:Â "16384"
+files when the header cache is in use. This incurs one stat(2) per
+message every time the folder is opened (which can be very slow for NFS
+folders).
+
Type:Â string
+Default:Â â16384â
When mutt is compiled with either gdbm or bdb4 as the header cache backend, this option changes the database page size. Too large or too small values can waste space, memory, or CPU time. The default should be more or less optimal for most use cases. -
Type:Â boolean
+
Type:Â boolean
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). -
Type:Â boolean
+slower opening of cached folder(s) which in general is still
+much faster than opening non header cached folders.
+
Type:Â boolean
Default:Â no
-If set, messages marked as deleted will be saved with the maildir -(T)rashed flag instead of unlinked. NOTE: this only applies +If set, messages marked as deleted will be saved with the maildir +trashed flag instead of unlinked. Note: this only applies to maildir-style mailboxes. Setting it will have no effect on other mailbox types. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
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, +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, indicating that they are old. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
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. -
Type: regular expression
-Default:Â "!^\.[^.]"
+â+â marker is displayed at the beginning of wrapped lines. +
+Also see the $smart_wrap variable. +
Type: regular expression
+Default:Â â!^\.[^.]â
A regular expression used in the file browser, optionally preceded by -the not operator ``!''. Only files whose names match this mask +the not operator â!â. Only files whose names match this mask will be shown. The match is always case-sensitive. -
Type:Â path
-Default:Â "Ë/mbox"
-This specifies the folder into which read mail in your ``$spoolfile'' +
Type:Â path
+Default: âË/mboxâ
+This specifies the folder into which read mail in your $spoolfile folder will be appended. -
Type: folder magic
+
+Also see the $move variable. +
Type: folder magic
Default:Â mbox
The default mailbox type used when creating new folders. May be any of -mbox, MMDF, MH and Maildir. -
Type:Â boolean
+âmboxâ, âMMDFâ, âMHâ and âMaildirâ.
+
Type:Â boolean
Default:Â no
-If unset, Mutt will remove your address (see the ``alternates'' +If unset, Mutt will remove your address (see the âalternatesâ command) from the list of recipients when replying to a message. -
Type:Â number
+
Type:Â number
Default:Â 0
This variable controls the number of lines of context that are given -when scrolling through menus. (Similar to ``$pager_context''.) -
Type:Â boolean
+when scrolling through menus. (Similar to $pager_context.)
+
Type:Â boolean
Default:Â yes
When unset, the bottom entry of menus will never scroll up past the bottom of the screen, unless there are less entries than lines. When set, the bottom entry may move off the bottom. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
When set, menus will be scrolled up or down one line when you attempt to move across a screen boundary. If unset, the screen is cleared and the next or previous page of the menu is displayed (useful for slow links to avoid many redraws). -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-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 +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 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 -``x''. -
Type:Â boolean
+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
+âxâ.
+
Type:Â boolean
Default:Â no
-When unset, mutt will mimic mh's behaviour and rename deleted messages +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. -
Type:Â string
-Default:Â "flagged"
+
+This option is similar to $maildir_trash for Maildir folders. +
Type:Â string
+Default:Â âflaggedâ
The name of the MH sequence used for flagged messages. -
Type:Â string
+Default:Â ârepliedâ
The name of the MH sequence used to tag replied messages. -
Type:Â string
+Default:Â âunseenâ
The name of the MH sequence used for unseen messages. -
Type:Â quadoption
+
Type:Â quadoption
Default:Â no
-When set, the message you are forwarding will be attached as a
-separate MIME part instead of included in the main body of the
+When set, the message you are forwarding will be attached as a
+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''. -
Type:Â boolean
+Also see $forward_decode and $mime_forward_decode.
+
Type:Â boolean
Default:Â 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. -
Type:Â quadoption
+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.
+
Type:Â quadoption
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. -
Type:Â string
-Default: "%4n %c %-16s %a"
+be attached to the newly composed message if this option is set. +
Type:Â string
+Default: â%4n %c %-16s %aâ
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:
-
The running number on the menu.
Remailer capabilities.
The remailer's short name.
The remailer's e-mail address. -
-
Type:Â path
+Default:Â âmixmasterâ
This variable contains the path to the Mixmaster binary on your system. It is used with various sets of parameters to gather the list of known remailers, and to finally send a message through the mixmaster chain. -
Type:Â quadoption
+Default:Â no
Controls whether or not Mutt will move read messages -from your spool mailbox to your ``$mbox'' mailbox, or as a result of -a ``mbox-hook'' command. -
Type:Â path
-Default:Â ""
+from your spool mailbox to your $mbox mailbox, or as a result of +a âmbox-hookâ command. +
Type:Â path
+Default:Â (empty)
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. -
Type:Â boolean
+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. +
Type:Â boolean
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. -
Type:Â string
-Default:Â "%s"
-This is the string displayed in the ``attachment'' menu for -attachments of type message/rfc822. For a full listing of defined -printf()-like sequences see the section on ``$index_format''. -
Type:Â boolean
-Default:Â no
-This variable, when set, makes the thread tree narrower, allowing +every once in a while, since it can be a little slow +(especially for large folders). +
Type:Â string
+Default:Â â%sâ
+This is the string displayed in the âattachmentâ menu for
+attachments of type message/rfc822. For a full listing of defined
+printf(3)-like sequences see the section on $index_format.
+
Type:Â boolean
+Default:Â no
+This variable, when set, makes the thread tree narrower, allowing deeper threads to fit on the screen. -
Type:Â number
+
Type:Â number
Default:Â 10
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''. -
Type:Â path
+Default:Â â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.
@@ -1129,19 +1426,19 @@ Using an external pager may have some disadvantages: Additional keystrokes are necessary because you can't call mutt functions directly from the pager, and screen resizes cause lines longer than the screen width to be badly formatted in the help menu. -
Type:Â number
+
Type:Â number
Default:Â 0
This variable controls the number of lines of context that are given when displaying the next or previous page in the internal pager. By default, Mutt will display the line after the last one on the screen at the top of the next page (0 lines of context). -
Type:Â string
-Default: "-%Z- %C/%m: %-20.20n   %s%*  -- (%P)"
-This variable controls the format of the one-line message ``status'' +
Type:Â string
+Default: â-%Z- %C/%m: %-20.20n   %s%*  -- (%P)â
+This variable controls the format of the one-line message âstatusâ displayed before each message in either the internal or an external -pager. The valid sequences are listed in the ``$index_format'' +pager. The valid sequences are listed in the $index_format section. -
Type:Â number
+
Type:Â number
Default:Â 0
Determines the number of lines of a mini-index which is shown when in the pager. The current message, unless near the top or bottom of the @@ -1149,106 +1446,105 @@ folder, will be roughly one third of the way down this mini-index, 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. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-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 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>
function.
-
Type:Â boolean
+
Type:Â boolean
Default:Â no
Setting this variable will cause Mutt to always attempt to cryptographically sign outgoing messages. This can be overridden -by use of the pgp-menu, when signing is not required or -encryption is requested as well. If ``$smime_is_default'' is set, +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) -
Type:Â boolean
+
Type:Â boolean
Default:Â no
Setting this variable will cause Mutt to always attempt to PGP encrypt outgoing messages. This is probably only useful in -connection to the send-hook command. It can be overridden -by use of the pgp-menu, when encryption is not required or -signing is requested as well. IF ``$smime_is_default'' is set, +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) -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead, -the principal key will inherit the subkeys' capabilities. Unset this +the principal key will inherit the subkeys' capabilities. Unset this if you want to play interesting key selection games. (PGP only) -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-If set, automatically PGP or OpenSSL encrypt replies to messages which are +If set, automatically PGP or OpenSSL encrypt replies to messages which are encrypted. (Crypto only) -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-If set, automatically PGP or OpenSSL sign replies to messages which are +If set, automatically PGP or OpenSSL sign replies to messages which are signed.
Note: this does not work on messages that are encrypted -and signed! +and signed! (Crypto only) -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-If set, automatically PGP or OpenSSL sign replies to messages +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) -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-If set, mutt will include a time stamp in the lines surrounding +If set, mutt will include a time stamp in the lines surrounding PGP or S/MIME output, so spoofing such lines is more difficult. If you are using colors to mark these lines, and rely on these, -you may unset this setting. +you may unset this setting. (Crypto only) -
Type:Â boolean
+
Type:Â boolean
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)
-
Type:Â quadoption
+
Type:Â quadoption
Default:Â yes
-If ``yes'', always attempt to verify PGP or S/MIME signatures. -If ``ask'', ask whether or not to verify the signature. -If ``no'', never attempt to verify cryptographic signatures. +If âyesâ, always attempt to verify PGP or S/MIME signatures. +If âask-*â, ask whether or not to verify the signature. +If \Fiânoâ, never attempt to verify cryptographic signatures. (Crypto only) -
Type:Â boolean
+
Type:Â boolean
Default:Â no
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 +operations. To override and to use OpenSSL instead this must be set. +However, this has no effect while replying, since mutt will automatically select the same application that was used to sign/encrypt the original -message. (Note that this variable can be overridden by unsetting $crypt_autosmime.) +message. (Note that this variable can be overridden by unsetting $crypt_autosmime.) (S/MIME only) -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
This flag controls whether you want to be asked to enter a label for a certificate about to be added to the database or not. It is -set by default. +set by default. (S/MIME only) -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-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 set (default) this tells mutt to use the default key for decryption. Otherwise, +if managing multiple certificate-key-pairs, mutt will try to use the mailbox-address to determine the key to use. It will ask you to supply a key, if it can't find one. (S/MIME only) -
Type:Â string
+Default: â%4n %t%f %4l/0x%k %-4a %2c %uâ
This variable allows you to customize the PGP key selection menu to -your personal taste. This string is similar to ``$index_format'', but -has its own set of printf()-like sequences: -
+your personal taste. This string is similar to $index_format, but
+has its own set of printf(3)-like sequences:
number
key id @@ -1258,59 +1554,58 @@ has its own set of printf()-like sequences:
flags
capabilities
trust/validity of the key-uid association -
date of the key where <s> is an strftime(3) expression +
date of the key where <s> is an strftime(3) expression
- -
(PGP only) -
Type: regular expression
+Default:Â (empty)
If you assign a text to this variable, then a PGP signature is only -considered verified if the output from $pgp_verify_command contains +considered verified if the output from $pgp_verify_command contains the text. Use this variable if the exit code from the command is 0 even for bad signatures. (PGP only) -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-If set, mutt will check the exit code of the PGP subprocess when +If set, mutt will check the exit code of the PGP subprocess when signing or encrypting. A non-zero exit code means that the subprocess failed. (PGP only) -
Type:Â boolean
+
Type:Â boolean
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) -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-If set, signed and encrypted messages will consist of nested
-multipart/signed and multipart/encrypted body parts.
+If set, signed and encrypted messages will consist of nested
+multipart/signed and multipart/encrypted body parts.
This is useful for applications like encrypted and signed mailing
-lists, where the outer layer (multipart/encrypted) can be easily
-removed, while the inner multipart/signed part is retained.
+lists, where the outer layer (multipart/encrypted) can be easily
+removed, while the inner multipart/signed part is retained.
(PGP only)
-
Type:Â boolean
+
Type:Â boolean
Default:Â no
This option controls whether Mutt generates old-style inline (traditional) PGP encrypted or signed messages under certain -circumstances. This can be overridden by use of the pgp-menu, +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. (PGP only) -
Type:Â boolean
+
Type:Â boolean
Default:Â no
Setting this variable will cause Mutt to always attempt to create an inline (traditional) message when replying to a message which is PGP encrypted/signed inline. This can be -overridden by use of the pgp-menu, when inline is not +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. @@ -1319,52 +1614,50 @@ 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. (PGP only) -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-If set, mutt will display non-usable keys on the PGP key selection +If set, mutt will display non-usable keys on the PGP key selection menu. This includes keys which have been revoked, have expired, or -have been marked as ``disabled'' by the user. +have been marked as âdisabledâ by the user. (PGP only) -
Type:Â string
+Default:Â (empty)
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)
-
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-If set, Mutt will automatically encode PGP/MIME signed messages as -quoted-printable. Please note that unsetting this variable may +If set, Mutt will automatically encode PGP/MIME signed messages as +quoted-printable. Please note that unsetting this variable may lead to problems with non-verifyable PGP signatures, so only change this if you know what you are doing. (PGP only) -
Type:Â number
+
Type:Â number
Default:Â 300
The number of seconds after which a cached passphrase will expire if not used. (PGP only) -
Type: sort order
+
Type: sort order
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: -
sort alphabetically by user id
sort alphabetically by key id
sort by key creation date
sort by the trust of the key
- -
If you prefer reverse order of the above values, prefix it with -`reverse-'. +âreverse-â. (PGP only) -
Type:Â quadoption
+
Type:Â quadoption
Default:Â ask-yes
This option controls whether Mutt will prompt you for automatically sending a (signed/encrypted) message using @@ -1373,648 +1666,742 @@ PGP/MIME when inline (traditional) fails (for any reason). Also note that using the old-style PGP message format is strongly deprecated. (PGP only) -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-If set, mutt will automatically attempt to decrypt traditional PGP
+If set, mutt will automatically attempt to decrypt traditional PGP
messages whenever the user performs an operation which ordinarily would
result in the contents of the message being operated on. For example,
if the user displays a pgp-traditional message which has not been manually
-checked with the check-traditional-pgp function, mutt will automatically
+checked with the <check-traditional-pgp> function, mutt will automatically
check the message for traditional pgp.
-
Type:Â string
-Default:Â ""
-This format strings specifies a command which is used to decode +
Type:Â string
+Default:Â (empty)
+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:
Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty string otherwise. Note: This may be used with a %? construct.
Expands to the name of a file containing a message.
Expands to the name of a file containing the signature part - of a multipart/signed attachment when verifying it. -
The value of $pgp_sign_as.
+ of a multipart/signed attachment when verifying it.
+
The value of $pgp_sign_as.
One or more key IDs.
- -
For examples on how to configure these formats for the various versions
-of PGP which are floating around, see the pgp*.rc and gpg.rc files in
-the samples/ subdirectory which has been installed on your system
+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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
-Default:Â ""
-This format is used to create a old-style "clearsigned" PGP +
Type:Â string
+Default:Â (empty)
+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)
-
Type:Â string
-Default:Â ""
-This command is used to create the detached PGP signature for a -multipart/signed PGP/MIME body part. +
Type:Â string
+Default:Â (empty)
+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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
-Default:Â ""
-This command is used to import a key from a message into +
Type:Â string
+Default:Â (empty)
+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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â boolean
+
Type:Â boolean
Default:Â yes
Controls the handling of encrypted messages when forwarding a message. -When set, the outer layer of encryption is stripped off. This -variable is only used if ``$mime_forward'' is set and -``$mime_forward_decode'' is unset. +When set, the outer layer of encryption is stripped off. This +variable is only used if $mime_forward is set and +$mime_forward_decode is unset. (PGP only) -
Type:Â number
+
Type:Â number
Default:Â 300
The number of seconds after which a cached passphrase will expire if not used. (S/MIME only) -
Type:Â string
+Default:Â (empty)
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) -
Type:Â path
-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, +
Type:Â path
+Default:Â (empty)
+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) -
Type:Â path
+Default:Â (empty)
This variable contains the name of either a directory, or a file which contains trusted certificates for use with OpenSSL. (S/MIME only) -
Type:Â path
-Default:Â ""
-Since there is no pubring/secring as with PGP, mutt has to handle +
Type:Â path
+Default:Â (empty)
+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) -
Type:Â string
+Default:Â (empty)
This format string specifies a command which is used to decrypt
-application/x-pkcs7-mime attachments.
+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:
-
Expands to the name of a file containing a message.
Expands to the name of a file containing the signature part - of a multipart/signed attachment when verifying it. -
The key-pair specified with $smime_default_key
+ of a multipart/signed attachment when verifying it.
+
The key-pair specified with $smime_default_key
One or more certificate IDs.
The algorithm used for encryption. -
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". +
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â.
- -
-For examples on how to configure these formats, see the smime.rc in
-the samples/ subdirectory which has been installed on your system
+For examples on how to configure these formats, see the smime.rc in
+the samples/ subdirectory which has been installed on your system
alongside the documentation.
(S/MIME only)
-
Type:Â string
-Default:Â ""
-This command is used to verify S/MIME signatures of type multipart/signed. +
Type:Â string
+Default:Â (empty)
+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)
-
Type:Â string
+Default:Â (empty)
This command is used to verify S/MIME signatures of type
-application/x-pkcs7-mime.
+application/x-pkcs7-mime.
+
+This is a format string, see the $smime_decrypt_command command for
+possible printf(3)-like sequences.
(S/MIME only)
-
Type:Â string
+Default:Â (empty)
This command is used to created S/MIME signatures of type
-multipart/signed, which can be read by all mail clients.
+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)
-
Type:Â string
+Default:Â (empty)
This command is used to created S/MIME signatures of type
-application/x-pkcs7-signature, which can only be handled by mail
+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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
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)
-
Type:Â string
+Default:Â (empty)
This is the default key-pair to use for signing. This must be set to the keyid (the hash-value that OpenSSL generates) to work properly (S/MIME only) -
Type:Â path
+Default:Â (empty)
The file containing a client certificate and its associated private key. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-If this variable is set, Mutt will require that all connections +If this variable is set, Mutt will require that all connections to remote servers be encrypted. Furthermore it will attempt to negotiate TLS even if the server does not advertise the capability, since it would otherwise have to abort the connection anyway. This -option supersedes ``$ssl_starttls''. -
Type:Â quadoption
-Default:Â yes
-If set (the default), mutt will attempt to use STARTTLS on servers -advertising the capability. When unset, mutt will not attempt to -use STARTTLS regardless of the server's capabilities. -
Type:Â path
-Default:Â "Ë/.mutt_certificates"
+option supersedes $ssl_starttls. +
Type:Â quadoption
+Default:Â yes
+If set (the default), mutt will attempt to use STARTTLS on servers
+advertising the capability. When unset, mutt will not attempt to
+use STARTTLS regardless of the server's capabilities.
+
Type:Â path
+Default: âË/.mutt_certificatesâ
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 -
Type:Â boolean
+Example:
+
+
+set certificate_file=~/.mutt/certificates + +
Type:Â boolean
Default:Â 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. -
Type:Â path
+Default:Â (empty)
The file which includes random data that is used to initialize SSL library functions. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
This variables specifies whether to attempt to use SSLv2 in the SSL authentication process. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
This variables specifies whether to attempt to use SSLv3 in the SSL authentication process. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
This variables specifies whether to attempt to use TLSv1 in the SSL authentication process. -
Type:Â number
+
Type:Â number
Default:Â 0
This variable specifies the minimum acceptable prime size (in bits) for use in any Diffie-Hellman key exchange. A value of 0 will use the default from the GNUTLS library. -
Type:Â path
+Default:Â (empty)
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 -
Type:Â boolean
+Example:
+
+
+set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt + +
Type:Â boolean
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.
-
Type:Â boolean
+and the $pipe_sep separator is added after each message.
+
Type:Â boolean
Default:Â no
-Used in connection with the pipe-message command. When unset,
-Mutt will pipe the messages without any preprocessing. When set, Mutt
-will weed headers and will attempt to PGP/MIME decode the messages
+Used in connection with the <pipe-message> command. When unset,
+Mutt will pipe the messages without any preprocessing. When set, Mutt
+will weed headers and will attempt to decode the messages
first.
-
Type:Â string
+Default:Â â\nâ
The separator to add between messages when piping a list of tagged messages to an external Unix command. -
Type:Â string
+Default:Â (empty)
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" -
Type:Â boolean
+Example:
+
+
+set pop_authenticators="digest-md5:apop:user" + +
Type:Â boolean
Default:Â yes
-If set, Mutt will try all available methods. When unset, Mutt will -only fall back to other authentication methods if the previous -methods are unavailable. If a method is available but authentication -fails, Mutt will not connect to the POP server. -
Type:Â number
+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.
+
Type:Â number
Default:Â 60
This variable configures how often (in seconds) mutt should look for new mail in the currently selected mailbox if it is a POP mailbox. -
Type:Â quadoption
+
Type:Â quadoption
Default:Â ask-no
-If set, Mutt will delete successfully downloaded messages from the POP
-server when using the fetch-mail function. When unset, Mutt will
+If set, Mutt will delete successfully downloaded messages from the POP
+server when using the <fetch-mail> function. When unset, Mutt will
download messages but also leave them on the POP server.
-
Type:Â string
-Default:Â ""
-The name of your POP server for the fetch-mail function. You +
Type:Â string
+Default:Â (empty)
+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] -
Type:Â boolean
+
+
+where â[...]â denotes an optional part. +
Type:Â boolean
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.
-
Type:Â quadoption
+the <fetch-mail> function.
+
Type:Â quadoption
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. -
Type:Â string
+Default:Â (empty)
Your login name on the POP server.
This variable defaults to your user name on the local machine. -
Type:Â string
-Default:Â ""
-Specifies the password for your POP account. If unset, Mutt will -prompt you for your password when you open POP mailbox. +
Type:Â string
+Default:Â (empty)
+Specifies the password for your POP account. If unset, Mutt will +prompt you for your password when you open a POP mailbox. +
Warning: you should only use this option when you are on a fairly secure machine, because the superuser can read your muttrc even if you are the only one who can read the file. -
Type:Â string
-Default:Â ""
-Similar to the ``$attribution'' variable, Mutt will append this +
Type:Â string
+Default:Â (empty)
+Similar to the $attribution variable, Mutt will append this string after the inclusion of a message which is being replied to. -
Type:Â quadoption
+
Type:Â quadoption
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. -
Type:Â path
-Default:Â "Ë/postponed"
-Mutt allows you to indefinitely ``postpone sending a message'' which +Controls whether or not messages are saved in the $postponed +mailbox when you elect not to send immediately. +
+Also see the $recall variable. +
Type:Â path
+Default: âË/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. -
Type:Â string
-Default:Â ""
-If set, a shell command to be executed if mutt fails to establish +in the mailbox specified by this variable. +
+Also see the $postpone variable. +
Type:Â string
+Default:Â (empty)
+If set, a shell command to be executed if mutt fails to establish
a connection to the server. This is useful for setting up secure
-connections, e.g. with ssh(1). If the command returns a nonzero
+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. -
Type:Â quadoption
+
Type:Â quadoption
Default:Â ask-no
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). -
Type:Â path
-Default:Â "lpr"
+This is set to âask-noâ by default, because some people +accidentally hit âpâ often. +
Type:Â path
+Default:Â âlprâ
This specifies the command pipe that should be used to print messages. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-Used in connection with the print-message command. If this
-option is set, the message is decoded before it is passed to the
-external command specified by $print_command. If this option
-is unset, no processing will be applied to the message when
+Used in connection with the <print-message> command. If this
+option is set, the message is decoded before it is passed to the
+external command specified by $print_command. If this option
+is unset, no processing will be applied to the message when
printing it. The latter setting may be useful if you are using
some advanced printer filter which is able to properly format
e-mail messages for printing.
-
Type:Â boolean
+
Type:Â boolean
Default:Â no
-Used in connection with the print-message command. If this option
-is set, the command specified by $print_command is executed once for
-each message which is to be printed. If this option is unset,
-the command specified by $print_command is executed only once, and
+Used in connection with the <print-message> command. If this option
+is set, the command specified by $print_command is executed once for
+each message which is to be printed. If this option is unset,
+the command specified by $print_command is executed only once, and
all the messages are concatenated, with a form feed as the message
separator.
-Those who use the enscript(1) program's mail-printing mode will -most likely want to set this option. -
Type:Â boolean
+Those who use the enscript(1) program's mail-printing mode will
+most likely want to set this option.
+
Type:Â boolean
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 +than returning to the index menu. If unset, Mutt will return to the index menu when the external pager exits. -
Type:Â path
+Default:Â (empty)
This specifies the command that mutt will use to make external address -queries. The string should contain a %s, which will be substituted -with the query string the user types. See ``query'' for more +queries. The string should contain a â%sâ, which will be substituted +with the query string the user types. See âqueryâ for more information. -
Type:Â string
-Default: "%4c %t %-25.25a %-25.25n %?e?(%e)?"
-This variable describes the format of the `query' menu. The -following printf-style sequences are understood: -
+
Type:Â string
+Default: â%4c %t %-25.25a %-25.25n %?e?(%e)?â
+This variable describes the format of the âqueryâ menu. The
+following printf(3)-style sequences are understood:
destination address
current entry number
extra information *
destination name -
``*'' if current entry is tagged, a space otherwise -
right justify the rest of the string and pad with "X" -
pad to the end of the line with "X" -
soft-fill with character "X" as pad +
â*â if current entry is tagged, a space otherwise +
right justify the rest of the string and pad with âXâ +
pad to the end of the line with â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. -
Type:Â quadoption
+* = can be optionally printed if nonzero, see the $status_format documentation.
+
Type:Â quadoption
Default:Â yes
-This variable controls whether ``quit'' and ``exit'' actually quit -from mutt. If it set to yes, they do quit, if it is set to no, they -have no effect, and if it is set to ask-yes or ask-no, you are +This variable controls whether âquitâ and âexitâ actually quit +from mutt. If this option is set, they do quit, if it is unset, they +have no effect, and if it is set to ask-yes or ask-no, you are prompted for confirmation when you try to quit. -
Type: regular expression
-Default:Â "^([Â \t]*[|>:}#])+"
-A regular expression used in the internal-pager to determine quoted -sections of text in the body of a message. -
-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. -
Type:Â number
+
Type: regular expression
+Default:Â â^([Â \t]*[|>:}#])+â
+A regular expression used in the internal pager to determine quoted
+sections of text in the body of a message. Quoted text may be filtered
+out using the <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. +
+Match detection may be overridden by the $smileys regular expression. +
Type:Â number
Default:Â 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. -
Type:Â boolean
+Also see the $write_inc, $net_inc and $time_inc variables and the
+âtuningâ section of the manual for performance considerations.
+
Type:Â string
-Default:Â ""
-This variable specifies what "real" or "personal" name should be used +If set, all folders are opened in read-only mode. +
Type:Â string
+Default:Â (empty)
+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
+By default, this is the GECOS field from /etc/passwd. Note that this
variable will not be used when the user has set a real name
-in the $from variable.
-
Type:Â quadoption
+in the $from variable.
+
Type:Â quadoption
Default:Â ask-yes
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. -
Type:Â path
+Default: âË/sentâ
This specifies the file into which your outgoing messages should be appended. (This is meant as the primary method for saving a copy of -your messages, but another way to do this is using the ``my_hdr'' -command to create a Bcc: field with your email address in it.) +your messages, but another way to do this is using the âmy_hdrâ +command to create a âBcc:â field with your email address in it.)
-The value of $record is overridden by the ``$force_name'' and -``$save_name'' variables, and the ``fcc-hook'' command. -
Type: regular expression
-Default:Â "^(re([\[0-9\]+])*|aw):[Â \t]*"
+The value of $record is overridden by the $force_name and +$save_name variables, and the âfcc-hookâ command. +
Type: regular expression
+Default:Â â^(re([\[0-9\]+])*|aw):[Â \t]*â
A regular expression used to recognize reply messages when threading and replying. The default value corresponds to the English "Re:" and the German "Aw:". -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-If unset and you are replying to a message sent by you, Mutt will +If unset and you are replying to a message sent by you, Mutt will assume that you want to reply to the recipients of that message rather than to yourself. -
Type:Â quadoption
+
+Also see the âalternatesâ command. +
Type:Â quadoption
Default:Â ask-yes
-If set, when replying to a message, Mutt will use the address listed -in the Reply-to: header as the recipient of the reply. If unset, +If set, when replying to a message, Mutt will use the address listed +in the Reply-to: header as the recipient of the reply. If unset, it will use the address in the From: header field instead. This option is useful for reading a mailing list that sets the Reply-To: header field to the list address and you want to send a private message to the author of a message. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-When set, the cursor will be automatically advanced to the next +When set, the cursor will be automatically advanced to the next (possibly undeleted) message whenever a command that modifies the current message is executed. -
Type:Â boolean
+
Type:Â boolean
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). -
Type:Â boolean
+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.
+
Type:Â boolean
Default:Â no
It may sometimes arrive that you receive mail to a certain machine, move the messages to another machine, and reply to some the messages -from there. If this variable is set, the default From: line of +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. -
Type:Â boolean
+
+Also see the âalternatesâ command. +
Type:Â boolean
Default:Â yes
-This variable fine-tunes the behaviour of the reverse_name feature. -When it is set, mutt will use the address from incoming messages as-is, -possibly including eventual real names. When it is unset, mutt will -override any such real names with the setting of the realname variable. -
Type:Â boolean
+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.
+
Type:Â boolean
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 won't be +active until you change folders.
-When this variable is set interactively, the change doesn't have -the desired effect before you have changed folders. -
-Note that this use of RFC 2047's encoding is explicitly, +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. -
Type:Â boolean
+unconditionally use the encoding specified in RFC2231.
+
Type:Â boolean
Default:Â 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. -
Type:Â boolean
+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.
+
Type:Â boolean
Default:Â yes
-When unset, mailboxes which contain no saved messages will be removed -when closed (the exception is ``$spoolfile'' which is never removed). -If set, mailboxes are never removed. +When unset, mailboxes which contain no saved messages will be removed +when closed (the exception is $spoolfile which is never removed). +If set, mailboxes are never removed.
Note: This only applies to mbox and MMDF folders, Mutt does not delete MH and Maildir directories. -
Type:Â number
+
Type:Â number
Default:Â 0
-This variable controls the size of the history saved in the -``$history_file'' file. -
Type:Â boolean
+This variable controls the size of the history (per category) saved in the
+$history_file file.
+
Type:Â boolean
Default:Â 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 +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. -
Type:Â boolean
+Also see the $force_name variable.
+
Type:Â boolean
Default:Â yes
When this variable is unset, scoring is turned off. This can be useful to selectively disable scoring for certain folders when the -``$score_threshold_delete'' variable and friends are used. -
Type:Â number
+$score_threshold_delete variable and related are used.
+
Type:Â number
Default:Â -1
Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked for deletion by mutt. Since mutt scores are always greater than or equal to zero, the default setting of this variable will never mark a message for deletion. -
Type:Â number
+
Type:Â number
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". -
Type:Â number
+
Type:Â number
Default:Â -1
Messages which have been assigned a score equal to or lower than the value of this variable are automatically marked as read by mutt. Since mutt scores are always greater than or equal to zero, the default setting of this variable will never mark a message read. -
Type:Â string
+Default:Â âus-ascii:iso-8859-1:utf-8â
A colon-delimited list of character sets for outgoing messages. Mutt will use the first character set into which the text can be converted exactly. -If your ``$charset'' is not iso-8859-1 and recipients may not -understand UTF-8, it is advisable to include in the list an +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. -
Type:Â path
-Default: "/usr/sbin/sendmail -oem -oi"
+mutt uses $charset as a fallback. +
Type:Â path
+Default: â/usr/sbin/sendmail -oem -oiâ
Specifies the program and arguments used to deliver mail sent by Mutt. Mutt expects that the specified program interprets additional arguments as recipient addresses. -
Type:Â number
+
Type:Â number
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: @@ -2023,194 +2410,197 @@ Mutt interprets the value of this variable as follows:
wait forever for sendmail to finish
always put sendmail in the background without waiting
- -
Note that if you specify a value other than 0, the output of the child process will be put in a temporary file. If there is some error, you will be informed as to where to find the output. -
Type:Â path
+Default:Â (empty)
Command to use when spawning a subshell. By default, the user's login -shell from /etc/passwd is used. -
Type:Â boolean
+shell from /etc/passwd is used.
+
Type:Â boolean
Default:Â yes
-If set, a line containing ``-- '' will be inserted before your -``$signature''. It is strongly recommended that you not unset -this variable unless your ``signature'' contains just your name. The -reason for this is because many software packages use ``-- \n'' to +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. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-If set, the signature will be included before any quoted or forwarded +If set, the signature will be included before any quoted or forwarded text. It is strongly recommended that you do not set this variable unless you really know what you are doing, and are prepared to take some heat from netiquette guardians. -
Type:Â path
+Default: âË/.signatureâ
Specifies the filename of your signature, which is appended to all -outgoing messages. If the filename ends with a pipe (``|''), it is +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. -
Type:Â string
+Default: âËf %s | Ës %sâ
Specifies how Mutt should expand a simple search into a real search -pattern. A simple search is one that does not contain any of the Ë -operators. See ``patterns'' for more information on search patterns. +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 -
Type:Â boolean
+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â.
+
Type:Â boolean
Default:Â 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. -
Type: regular expression
-Default: "(>From )|(:[-^]?[][)(><}{|/DP])"
+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. +
Type: regular expression
+Default: â(>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 -
Type:Â number
+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.
+
Type:Â number
Default:Â 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. -
Type:Â string
+Default:Â (empty)
This is a colon-delimited list of authentication methods mutt may attempt to use to log in to an SMTP server, in the order mutt should try them. Authentication methods are any SASL mechanism, eg -``digest-md5'', ``gssapi'' or ``cram-md5''. -This parameter is case-insensitive. If this parameter is unset +âdigest-md5â, âgssapiâ or âcram-md5â. +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" -
Type:Â string
-Default:Â ""
+Example: + +
+set smtp_authenticators="digest-md5:cram-md5" + +
Type:Â string
+Default:Â (empty)
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. -
Type:Â string
-Default:Â ""
-Defines the SMTP ``smart'' host where sent messages should relayed for +
Type:Â string
+Default:Â (empty)
+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. -
Type: sort order
+
Type: sort order
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 -
-You may optionally use the reverse- prefix to specify reverse sorting -order (example: set sort=reverse-date-sent). -
Type: sort order
+
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â).
+
Type: sort order
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) - -
Type: sort order
+
address (sort alphabetically by email address) +
alias (sort alphabetically by alias name) +
unsorted (leave in order specified in .muttrc) +
Type: sort order
Default:Â 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''
-order $sort_aux is reversed again (which is not the right thing to do,
+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). -
Type: sort order
+
Type: sort order
Default:Â alpha
Specifies how to sort entries in the file browser. By default, the entries are sorted alphabetically. Valid values: -
-
- alpha (alphabetically) - date - size - unsorted - -
-You may optionally use the reverse- prefix to specify reverse sorting -order (example: set sort_browser=reverse-date). -
Type:Â boolean
+
alpha (alphabetically) +
date +
size +
unsorted +
+You may optionally use the âreverse-â prefix to specify reverse sorting
+order (example: âset sort_browser=reverse-dateâ).
+
Type:Â boolean
Default:Â 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. -
Type:Â string
-Default:Â ","
-``spam_separator'' 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 +non-$reply_regexp parts of both messages are identical. +
Type:Â string
+Default:Â â,â
+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 this variable's value as a separator. -
Type:Â path
+Default:Â (empty)
If your spool mailbox is in a non-default place where Mutt cannot find it, you can specify its location with this variable. Mutt will automatically set this variable to the value of the environment -variable $MAIL if it is not set. -
Type:Â string
-Default:Â "-*%A"
-Controls the characters used by the "%r" indicator in
-``$status_format''. The first character is used when the mailbox is
+variable $MAIL if it is not set.
+
Type:Â string
+Default:Â â-*%Aâ
+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).
-
Type:Â string
-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: -
+
Type:Â string
+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(3)-like sequences:
number of mailboxes with new mail *
number of deleted messages * @@ -2218,7 +2608,7 @@ set of printf()-like sequences:
number of flagged messages *
local hostname
size (in bytes) of the current mailbox * -
size (in bytes) of the messages shown +
size (in bytes) of the messages shown (i.e., which match the current limit) *
the number of messages in the mailbox *
the number of messages shown (i.e., which match the current limit) * @@ -2227,20 +2617,18 @@ set of printf()-like sequences:
number of postponed messages *
percentage of the way through the index
modified/read-only/won't-write/attach-message indicator, -according to $status_chars -
current sorting mode ($sort) -
current aux sorting method ($sort_aux) +according to $status_chars +
current sorting mode ($sort) +
current aux sorting method ($sort_aux)
number of tagged messages *
number of unread messages *
Mutt version string
currently active limit pattern, if any * -
right justify the rest of the string and pad with "X" -
pad to the end of the line with "X" -
soft-fill with character "X" as pad +
right justify the rest of the string and pad with âXâ +
pad to the end of the line with â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
@@ -2250,7 +2638,7 @@ number of flagged messages if such messages exist, since zero is not particularly meaningful. To optionally print a string based upon one of the above sequences, the following construct is used:
-%?<sequence_char>?<optional_string>?
+%?<sequence_char>?<optional_string>?
where sequence_char is a character from the table above, and optional_string is the string you would like printed if @@ -2260,73 +2648,83 @@ optional strings.
Here is an example illustrating how to optionally print the number of new messages in a mailbox: -%?n?%n new messages.? +
+%?n?%n new messages.?
You can also switch between two strings using the following construct:
-%?<sequence_char>?<if_string>&<else_string>?
+%?<sequence_char>?<if_string>&<else_string>?
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. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-Setting this variable causes the ``status bar'' to be displayed on -the first line of the screen rather than near the bottom. -
Type:Â boolean
+Setting this variable causes the âstatus barâ to be displayed on
+the first line of the screen rather than near the bottom. If $help
+is set, too it'll be placed at the bottom.
+
Type:Â boolean
Default:Â no
-If set, threading will only make use of the ``In-Reply-To'' and -``References'' fields when you ``$sort'' by message threads. By +If set, threading will only make use of the âIn-Reply-Toâ and +â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 +â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. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
When unset, mutt won't stop when the user presses the terminal's -susp key, usually ``control-Z''. This is useful if you run mutt -inside an xterm using a command like xterm -e mutt. -
Type:Â boolean
+susp key, usually â^Zâ. This is useful if you run mutt
+inside an xterm using a command like âxterm -e muttâ.
+
Type:Â boolean
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. -
Type:Â boolean
+Note that $indent_string is ignored when this option is set.
+
Type:Â boolean
Default:Â no
-When set, mutt uses the date received rather than the date sent +When set, mutt uses the date received rather than the date sent to thread messages by subject. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
-Affects the Ëb and Ëh search operations described in
-section ``patterns'' above. If set, the headers and attachments of
-messages to be searched are decoded before searching. If unset,
+Affects the Ëb and Ëh search operations described in
+section âpatternsâ. If set, the headers and body/attachments of
+messages to be searched are decoded before searching. If unset,
messages are searched as they appear in the folder.
-
Type:Â boolean
+
+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. +
Type:Â boolean
Default:Â no
-When set, the internal-pager will pad blank lines to the bottom of the -screen with a tilde (Ë). -
Type:Â number
+When set, the internal-pager will pad blank lines to the bottom of the
+screen with a tilde (âËâ).
+
Type:Â number
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. -
Type:Â number
+
+Also see the âtuningâ section of the manual for performance considerations. +
Type:Â number
Default:Â 600
When Mutt is waiting for user input either idleing in menus or in an interactive prompt, Mutt would block until input is @@ -2339,188 +2737,140 @@ until it aborts waiting for input, performs these operations and continues to wait for input.
A value of zero or less will cause Mutt to never time out. -
Type:Â path
+Default:Â (empty)
This variable allows you to specify where Mutt will place its temporary files needed for displaying and composing messages. If -this variable is not set, the environment variable TMPDIR is -used. If TMPDIR is not set then "/tmp" is used. -
Type:Â string
-Default:Â "Â +TCFL"
+this variable is not set, the environment variable $TMPDIR is
+used. If $TMPDIR is not set then â/tmpâ is used.
+
Type:Â string
+Default: â +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). -
Type:Â string
+Default:Â (empty)
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" -
-NOTE: For this example to work you must be able to log in to the remote +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 machine without having to enter a password. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
Warning: do not set this variable unless you are using a version
-of sendmail which supports the -B8BITMIME flag (such as sendmail
+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.
-
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-When set, Mutt will qualify all local addresses (ones without the -@host portion) with the value of ``$hostname''. If unset, no +When set, Mutt will qualify all local addresses (ones without the +â@hostâ portion) with the value of $hostname. If unset, no addresses will be qualified. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
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. -
Type:Â boolean
-Default:Â yes
-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''
+-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.
+
Type:Â boolean
+Default:Â yes
+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. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
When set, Mutt will show you international domain names decoded. Note: You can use IDNs for addresses even if this is unset. This variable only affects decoding. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
When set, Mutt will look for IPv6 addresses of hosts it tries to -contact. If this option is unset, Mutt will restrict itself to IPv4 addresses. +contact. If this option is unset, Mutt will restrict itself to IPv4 addresses. Normally, the default should work. -
Type:Â boolean
+
Type:Â boolean
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. -
Type:Â path
-Default:Â ""
-Specifies the visual editor to invoke when the Ëv command is +
Type:Â path
+Default:Â (empty)
+Specifies the visual editor to invoke when the âËvâ command is
given in the builtin editor.
-
Type:Â boolean
+
Type:Â boolean
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 +It is also used when viewing attachments with âauto_viewâ, provided that the corresponding mailcap entry has a needsterminal flag, and the external program is interactive.
-When set, Mutt will always ask for a key. When unset, Mutt will wait +When set, Mutt will always ask for a key. When unset, Mutt will wait for a key only if the external command returned a non-zero status. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
-When set, mutt will weed headers when displaying, forwarding, +When set, mutt will weed headers when displaying, forwarding, printing, or replying to messages. -
Type:Â number
+
Type:Â number
Default:Â 0
-When set to a positive value, mutt will wrap text at $wrap characters. -When set to a negative value, mutt will wrap text so that there are $wrap +When set to a positive value, mutt will wrap text at $wrap characters. +When set to a negative value, mutt will wrap text so that there are $wrap characters of empty space on the right side of the terminal. -
Type:Â boolean
+
Type:Â boolean
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. -
Type:Â number
+When set, searches will wrap around the first (or last) item. When
+unset, incremental searches will not wrap.
+
Type:Â number
Default:Â 0
-(DEPRECATED) Equivalent to setting wrap with a negative value. -
Type:Â number
+(DEPRECATED) Equivalent to setting $wrap with a negative value.
+
Type:Â number
Default:Â 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. -
Type:Â boolean
+Also see the $read_inc, $net_inc and $time_inc variables and the
+âtuningâ section of the manual for performance considerations.
+
Type:Â boolean
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.
The following is the list of available functions listed by the mapping in which they are available. The default key setting is given, and an explanation of what the function does. The key bindings of these -functions can be changed with the bind +functions can be changed with the bind command. -
+
The generic menu is not a real menu, but specifies common functions (such as movement) available in all menus except for pager and editor. Changing settings for this menu will affect the default bindings for all menus (except as noted). -
- -
Table 8.2. Default generic function bindings
| Function | Default key | Description |
|---|---|---|
| top-page | H | move to the top of the page |
| next-entry | j | move to the next entry |
| previous-entry | k | move to the previous entry |
| bottom-page | L | move to the bottom of the page |
| refresh | ^L | clear and redraw the screen |
| middle-page | M | move to the middle of the page |
| search-next | n | search for next match |
| exit | q | exit this menu |
| tag-entry | t | tag the current entry |
| next-page | z | move to the next page |
| previous-page | Z | move to the previous page |
| last-entry | * | move to the last entry |
| first-entry | = | move to the first entry |
| enter-command | : | enter a muttrc command |
| next-line | > | scroll down one line |
| previous-line | < | scroll up one line |
| half-up | [ | scroll up 1/2 page |
| half-down | ] | scroll down 1/2 page |
| help | ? | this screen |
| tag-prefix | ; | apply next function to tagged messages |
| tag-prefix-cond | not bound | apply next function ONLY to tagged messages |
| end-cond | not bound | end of conditional execution (noop) |
| shell-escape | ! | invoke a command in a subshell |
| select-entry | RET | select the current entry |
| search | / | search for a regular expression |
| search-reverse | ESC / | search backwards for a regular expression |
| search-opposite | not bound | search for next match in opposite direction |
| jump | not bound | jump to an index number |
| current-top | not bound | move entry to top of screen |
| current-middle | not bound | move entry to middle of screen |
| current-bottom | not bound | move entry to bottom of screen |
| what-key | not bound | display the keycode for a key press |
-
-
- -
Table 8.3. Default index function bindings
| Function | Default key | Description |
|---|---|---|
| create-alias | a | create an alias from a message sender |
| bounce-message | b | remail a message to another user |
| break-thread | # | break the thread in two |
| change-folder | c | open a different folder |
| change-folder-readonly | ESC c | open a different folder in read only mode |
| next-unread-mailbox | not bound | open next mailbox with new mail |
| collapse-thread | ESC v | collapse/uncollapse current thread |
| collapse-all | ESC V | collapse/uncollapse all threads |
| copy-message | C | copy a message to a file/mailbox |
| decode-copy | ESC C | make decoded (text/plain) copy |
| decode-save | ESC s | make decoded copy (text/plain) and delete |
| delete-message | d | delete the current entry |
| delete-pattern | D | delete messages matching a pattern |
| delete-thread | ^D | delete all messages in thread |
| delete-subthread | ESC d | delete all messages in subthread |
| edit | e | edit the raw message |
| edit-type | ^E | edit attachment content type |
| forward-message | f | forward a message with comments |
| flag-message | F | toggle a message's 'important' flag |
| group-reply | g | reply to all recipients |
| fetch-mail | G | retrieve mail from POP server |
| imap-fetch-mail | not bound | force retrieval of mail from IMAP server |
| display-toggle-weed | h | display message and toggle header weeding |
| next-undeleted | j | move to the next undeleted message |
| previous-undeleted | k | move to the previous undeleted message |
| limit | l | show only messages matching a pattern |
| link-threads | & | link tagged message to the current one |
| list-reply | L | reply to specified mailing list |
| m | compose a new mail message | |
| toggle-new | N | toggle a message's 'new' flag |
| toggle-write | % | toggle whether the mailbox will be rewritten |
| next-thread | ^N | jump to the next thread |
| next-subthread | ESC n | jump to the next subthread |
| query | Q | query external program for addresses |
| quit | q | save changes to mailbox and quit |
| reply | r | reply to a message |
| show-limit | ESC l | show currently active limit pattern |
| sort-mailbox | o | sort messages |
| sort-reverse | O | sort messages in reverse order |
| print-message | p | print the current entry |
| previous-thread | ^P | jump to previous thread |
| previous-subthread | ESC p | jump to previous subthread |
| recall-message | R | recall a postponed message |
| read-thread | ^R | mark the current thread as read |
| read-subthread | ESC r | mark the current subthread as read |
| resend-message | ESC e | use the current message as a template for a new one |
| save-message | s | save message/attachment to a file |
| tag-pattern | T | tag messages matching a pattern |
| tag-subthread | not bound | tag the current subthread |
| tag-thread | ESC t | tag the current thread |
| untag-pattern | ^T | untag messages matching a pattern |
| undelete-message | u | undelete the current entry |
| undelete-pattern | U | undelete messages matching a pattern |
| undelete-subthread | ESC u | undelete all messages in subthread |
| undelete-thread | ^U | undelete all messages in thread |
| view-attachments | v | show MIME attachments |
| show-version | V | show the Mutt version number and date |
| set-flag | w | set a status flag on a message |
| clear-flag | W | clear a status flag from a message |
| display-message | RET | display a message |
| buffy-list | . | list mailboxes with new mail |
| sync-mailbox | $ | save changes to mailbox |
| display-address | @ | display full address of sender |
| pipe-message | | | pipe message/attachment to a shell command |
| next-new | not bound | jump to the next new message |
| next-new-then-unread | TAB | jump to the next new or unread message |
| previous-new | not bound | jump to the previous new message |
| previous-new-then-unread | ESC TAB | jump to the previous new or unread message |
| next-unread | not bound | jump to the next unread message |
| previous-unread | not bound | jump to the previous unread message |
| parent-message | P | jump to parent message in thread |
| extract-keys | ^K | extract supported public keys |
| forget-passphrase | ^F | wipe passphrase(s) from memory |
| check-traditional-pgp | ESC P | check for classic PGP |
| mail-key | ESC k | mail a PGP public key |
| decrypt-copy | not bound | make decrypted copy |
| decrypt-save | not bound | make decrypted copy and delete |
-
-
- -
Table 8.4. Default pager function bindings
| Function | Default key | Description |
|---|---|---|
| break-thread | # | break the thread in two |
| create-alias | a | create an alias from a message sender |
| bounce-message | b | remail a message to another user |
| change-folder | c | open a different folder |
| change-folder-readonly | ESC c | open a different folder in read only mode |
| next-unread-mailbox | not bound | open next mailbox with new mail |
| copy-message | C | copy a message to a file/mailbox |
| decode-copy | ESC C | make decoded (text/plain) copy |
| delete-message | d | delete the current entry |
| delete-thread | ^D | delete all messages in thread |
| delete-subthread | ESC d | delete all messages in subthread |
| edit | e | edit the raw message |
| edit-type | ^E | edit attachment content type |
| forward-message | f | forward a message with comments |
| flag-message | F | toggle a message's 'important' flag |
| group-reply | g | reply to all recipients |
| imap-fetch-mail | not bound | force retrieval of mail from IMAP server |
| display-toggle-weed | h | display message and toggle header weeding |
| next-undeleted | j | move to the next undeleted message |
| next-entry | J | move to the next entry |
| previous-undeleted | k | move to the previous undeleted message |
| previous-entry | K | move to the previous entry |
| link-threads | & | link tagged message to the current one |
| list-reply | L | reply to specified mailing list |
| redraw-screen | ^L | clear and redraw the screen |
| m | compose a new mail message | |
| mark-as-new | N | toggle a message's 'new' flag |
| search-next | n | search for next match |
| next-thread | ^N | jump to the next thread |
| next-subthread | ESC n | jump to the next subthread |
| print-message | p | print the current entry |
| previous-thread | ^P | jump to previous thread |
| previous-subthread | ESC p | jump to previous subthread |
| quit | Q | save changes to mailbox and quit |
| exit | q | exit this menu |
| reply | r | reply to a message |
| recall-message | R | recall a postponed message |
| read-thread | ^R | mark the current thread as read |
| read-subthread | ESC r | mark the current subthread as read |
| resend-message | ESC e | use the current message as a template for a new one |
| save-message | s | save message/attachment to a file |
| skip-quoted | S | skip beyond quoted text |
| decode-save | ESC s | make decoded copy (text/plain) and delete |
| tag-message | t | tag the current entry |
| toggle-quoted | T | toggle display of quoted text |
| undelete-message | u | undelete the current entry |
| undelete-subthread | ESC u | undelete all messages in subthread |
| undelete-thread | ^U | undelete all messages in thread |
| view-attachments | v | show MIME attachments |
| show-version | V | show the Mutt version number and date |
| search-toggle | \\ | toggle search pattern coloring |
| display-address | @ | display full address of sender |
| next-new | not bound | jump to the next new message |
| pipe-message | | | pipe message/attachment to a shell command |
| help | ? | this screen |
| next-page | Space | move to the next page |
| previous-page | - | move to the previous page |
| top | ^ | jump to the top of the message |
| sync-mailbox | $ | save changes to mailbox |
| shell-escape | ! | invoke a command in a subshell |
| enter-command | : | enter a muttrc command |
| buffy-list | . | list mailboxes with new mail |
| search | / | search for a regular expression |
| search-reverse | ESC / | search backwards for a regular expression |
| search-opposite | not bound | search for next match in opposite direction |
| next-line | RET | scroll down one line |
| jump | not bound | jump to an index number |
| next-unread | not bound | jump to the next unread message |
| previous-new | not bound | jump to the previous new message |
| previous-unread | not bound | jump to the previous unread message |
| half-up | not bound | scroll up 1/2 page |
| half-down | not bound | scroll down 1/2 page |
| previous-line | not bound | scroll up one line |
| bottom | not bound | jump to the bottom of the message |
| parent-message | P | jump to parent message in thread |
| check-traditional-pgp | ESC P | check for classic PGP |
| mail-key | ESC k | mail a PGP public key |
| extract-keys | ^K | extract supported public keys |
| forget-passphrase | ^F | wipe passphrase(s) from memory |
| decrypt-copy | not bound | make decrypted copy |
| decrypt-save | not bound | make decrypted copy and delete |
-
-
- -
Table 8.5. Default alias function bindings
| Function | Default key | Description |
|---|---|---|
| delete-entry | d | delete the current entry |
| undelete-entry | u | undelete the current entry |
-
-
- -
Table 8.6. Default query function bindings
| Function | Default key | Description |
|---|---|---|
| create-alias | a | create an alias from a message sender |
| m | compose a new mail message | |
| query | Q | query external program for addresses |
| query-append | A | append new query results to current results |
-
-
- -
Table 8.7. Default attach function bindings
| Function | Default key | Description |
|---|---|---|
| bounce-message | b | remail a message to another user |
| display-toggle-weed | h | display message and toggle header weeding |
| edit-type | ^E | edit attachment content type |
| print-entry | p | print the current entry |
| save-entry | s | save message/attachment to a file |
| pipe-entry | | | pipe message/attachment to a shell command |
| view-mailcap | m | force viewing of attachment using mailcap |
| reply | r | reply to a message |
| resend-message | ESC e | use the current message as a template for a new one |
| group-reply | g | reply to all recipients |
| list-reply | L | reply to specified mailing list |
| forward-message | f | forward a message with comments |
| view-text | T | view attachment as text |
| view-attach | RET | view attachment using mailcap entry if necessary |
| delete-entry | d | delete the current entry |
| undelete-entry | u | undelete the current entry |
| collapse-parts | v | Toggle display of subparts |
| check-traditional-pgp | ESC P | check for classic PGP |
| extract-keys | ^K | extract supported public keys |
| forget-passphrase | ^F | wipe passphrase(s) from memory |
-
-
- -
Table 8.8. Default compose function bindings
| Function | Default key | Description |
|---|---|---|
| attach-file | a | attach file(s) to this message |
| attach-message | A | attach message(s) to this message |
| edit-bcc | b | edit the BCC list |
| edit-cc | c | edit the CC list |
| copy-file | C | save message/attachment to a file |
| detach-file | D | delete the current entry |
| toggle-disposition | ^D | toggle disposition between inline/attachment |
| edit-description | d | edit attachment description |
| edit-message | e | edit the message |
| edit-headers | E | edit the message with headers |
| edit-file | ^X e | edit the file to be attached |
| edit-encoding | ^E | edit attachment transfer-encoding |
| edit-from | ESC f | edit the from field |
| edit-fcc | f | enter a file to save a copy of this message in |
| filter-entry | F | filter attachment through a shell command |
| get-attachment | G | get a temporary copy of an attachment |
| display-toggle-weed | h | display message and toggle header weeding |
| ispell | i | run ispell on the message |
| print-entry | l | print the current entry |
| edit-mime | m | edit attachment using mailcap entry |
| new-mime | n | compose new attachment using mailcap entry |
| postpone-message | P | save this message to send later |
| edit-reply-to | r | edit the Reply-To field |
| rename-file | R | rename/move an attached file |
| edit-subject | s | edit the subject of this message |
| edit-to | t | edit the TO list |
| edit-type | ^T | edit attachment content type |
| write-fcc | w | write the message to a folder |
| toggle-unlink | u | toggle whether to delete file after sending it |
| toggle-recode | not bound | toggle recoding of this attachment |
| update-encoding | U | update an attachment's encoding info |
| view-attach | RET | view attachment using mailcap entry if necessary |
| send-message | y | send the message |
| pipe-entry | | | pipe message/attachment to a shell command |
| attach-key | ESC k | attach a PGP public key |
| pgp-menu | p | show PGP options |
| forget-passphrase | ^F | wipe passphrase(s) from memory |
| smime-menu | S | show S/MIME options |
| mix | M | send the message through a mixmaster remailer chain |
-
-
- -
Table 8.9. Default postpone function bindings
| Function | Default key | Description |
|---|---|---|
| delete-entry | d | delete the current entry |
| undelete-entry | u | undelete the current entry |
-
-
- -
Table 8.10. Default browser function bindings
| Function | Default key | Description |
|---|---|---|
| change-dir | c | change directories |
| display-filename | @ | display the currently selected file's name |
| enter-mask | m | enter a file mask |
| sort | o | sort messages |
| sort-reverse | O | sort messages in reverse order |
| select-new | N | select a new file in this directory |
| check-new | not bound | check mailboxes for new mail |
| toggle-mailboxes | TAB | toggle whether to browse mailboxes or all files |
| view-file | Space | view file |
| buffy-list | . | list mailboxes with new mail |
| create-mailbox | C | create a new mailbox (IMAP only) |
| delete-mailbox | d | delete the current mailbox (IMAP only) |
| rename-mailbox | r | rename the current mailbox (IMAP only) |
| subscribe | s | subscribe to current mailbox (IMAP only) |
| unsubscribe | u | unsubscribe from current mailbox (IMAP only) |
| toggle-subscribed | T | toggle view all/subscribed mailboxes (IMAP only) |
-
-
- -
Table 8.11. Default pgp function bindings
| Function | Default key | Description |
|---|---|---|
| verify-key | c | verify a PGP public key |
| view-name | % | view the key's user id |
-
-
- -
Table 8.12. Default smime function bindings
| Function | Default key | Description |
|---|---|---|
| verify-key | c | verify a PGP public key |
| view-name | % | view the key's user id |
-
-
- -
Table 8.13. Default mix function bindings
| Function | Default key | Description |
|---|---|---|
| accept | RET | Accept the chain constructed |
| append | a | Append a remailer to the chain |
| insert | i | Insert a remailer into the chain |
| delete | d | Delete a remailer from the chain |
| chain-prev | left | Select the previous element of the chain |
| chain-next | right | Select the next element of the chain |
-
-
- -
Table 8.14. Default editor function bindings
| Function | Default key | Description |
|---|---|---|
| bol | ^A | jump to the beginning of the line |
| backward-char | ^B | move the cursor one character to the left |
| backward-word | ESC b | move the cursor to the beginning of the word |
| capitalize-word | ESC c | capitalize the word |
| downcase-word | ESC l | convert the word to lower case |
| upcase-word | ESC u | convert the word to upper case |
| delete-char | ^D | delete the char under the cursor |
| eol | ^E | jump to the end of the line |
| forward-char | ^F | move the cursor one character to the right |
| forward-word | ESC f | move the cursor to the end of the word |
| backspace | Backspace | delete the char in front of the cursor |
| kill-eol | ^K | delete chars from cursor to end of line |
| kill-eow | ESC d | delete chars from the cursor to the end of the word |
| kill-line | ^U | delete all chars on the line |
| quote-char | ^V | quote the next typed key |
| kill-word | ^W | delete the word in front of the cursor |
| complete | TAB | complete filename or alias |
| complete-query | ^T | complete address with query |
| buffy-cycle | Space | cycle among incoming mailboxes |
| history-up | not bound | scroll up through the history list |
| history-down | not bound | scroll down through the history list |
| transpose-chars | not bound | transpose character under cursor with previous |
-
-
Table 8.2. Default generic function bindings
| Function | Default key | Description |
|---|---|---|
<top-page> | H | move to the top of the page |
<next-entry> | j | move to the next entry |
<previous-entry> | k | move to the previous entry |
<bottom-page> | L | move to the bottom of the page |
<refresh> | ^L | clear and redraw the screen |
<middle-page> | M | move to the middle of the page |
<search-next> | n | search for next match |
<exit> | q | exit this menu |
<tag-entry> | t | tag the current entry |
<next-page> | z | move to the next page |
<previous-page> | Z | move to the previous page |
<last-entry> | * | move to the last entry |
<first-entry> | = | move to the first entry |
<enter-command> | : | enter a muttrc command |
<next-line> | > | scroll down one line |
<previous-line> | < | scroll up one line |
<half-up> | [ | scroll up 1/2 page |
<half-down> | ] | scroll down 1/2 page |
<help> | ? | this screen |
<tag-prefix> | ; | apply next function to tagged messages |
<tag-prefix-cond> | Â | apply next function ONLY to tagged messages |
<end-cond> | Â | end of conditional execution (noop) |
<shell-escape> | ! | invoke a command in a subshell |
<select-entry> | <Return> | select the current entry |
<search> | / | search for a regular expression |
<search-reverse> | Esc / | search backwards for a regular expression |
<search-opposite> | Â | search for next match in opposite direction |
<jump> | Â | jump to an index number |
<current-top> | Â | move entry to top of screen |
<current-middle> | Â | move entry to middle of screen |
<current-bottom> | Â | move entry to bottom of screen |
<what-key> | Â | display the keycode for a key press |
Table 8.3. Default index function bindings
| Function | Default key | Description |
|---|---|---|
<create-alias> | a | create an alias from a message sender |
<bounce-message> | b | remail a message to another user |
<break-thread> | # | break the thread in two |
<change-folder> | c | open a different folder |
<change-folder-readonly> | Esc c | open a different folder in read only mode |
<next-unread-mailbox> | Â | open next mailbox with new mail |
<collapse-thread> | Esc v | collapse/uncollapse current thread |
<collapse-all> | Esc V | collapse/uncollapse all threads |
<copy-message> | C | copy a message to a file/mailbox |
<decode-copy> | Esc C | make decoded (text/plain) copy |
<decode-save> | Esc s | make decoded copy (text/plain) and delete |
<delete-message> | d | delete the current entry |
<delete-pattern> | D | delete messages matching a pattern |
<delete-thread> | ^D | delete all messages in thread |
<delete-subthread> | Esc d | delete all messages in subthread |
<edit> | e | edit the raw message |
<edit-type> | ^E | edit attachment content type |
<forward-message> | f | forward a message with comments |
<flag-message> | F | toggle a message's 'important' flag |
<group-reply> | g | reply to all recipients |
<fetch-mail> | G | retrieve mail from POP server |
<imap-fetch-mail> | Â | force retrieval of mail from IMAP server |
<display-toggle-weed> | h | display message and toggle header weeding |
<next-undeleted> | j | move to the next undeleted message |
<previous-undeleted> | k | move to the previous undeleted message |
<limit> | l | show only messages matching a pattern |
<link-threads> | & | link tagged message to the current one |
<list-reply> | L | reply to specified mailing list |
<mail> | m | compose a new mail message |
<toggle-new> | N | toggle a message's 'new' flag |
<toggle-write> | % | toggle whether the mailbox will be rewritten |
<next-thread> | ^N | jump to the next thread |
<next-subthread> | Esc n | jump to the next subthread |
<query> | Q | query external program for addresses |
<quit> | q | save changes to mailbox and quit |
<reply> | r | reply to a message |
<show-limit> | Esc l | show currently active limit pattern |
<sort-mailbox> | o | sort messages |
<sort-reverse> | O | sort messages in reverse order |
<print-message> | p | print the current entry |
<previous-thread> | ^P | jump to previous thread |
<previous-subthread> | Esc p | jump to previous subthread |
<recall-message> | R | recall a postponed message |
<read-thread> | ^R | mark the current thread as read |
<read-subthread> | Esc r | mark the current subthread as read |
<resend-message> | Esc e | use the current message as a template for a new one |
<save-message> | s | save message/attachment to a file |
<tag-pattern> | T | tag messages matching a pattern |
<tag-subthread> | Â | tag the current subthread |
<tag-thread> | Esc t | tag the current thread |
<untag-pattern> | ^T | untag messages matching a pattern |
<undelete-message> | u | undelete the current entry |
<undelete-pattern> | U | undelete messages matching a pattern |
<undelete-subthread> | Esc u | undelete all messages in subthread |
<undelete-thread> | ^U | undelete all messages in thread |
<view-attachments> | v | show MIME attachments |
<show-version> | V | show the Mutt version number and date |
<set-flag> | w | set a status flag on a message |
<clear-flag> | W | clear a status flag from a message |
<display-message> | <Return> | display a message |
<buffy-list> | . | list mailboxes with new mail |
<sync-mailbox> | $ | save changes to mailbox |
<display-address> | @ | display full address of sender |
<pipe-message> | | | pipe message/attachment to a shell command |
<next-new> | Â | jump to the next new message |
<next-new-then-unread> | <Tab> | jump to the next new or unread message |
<previous-new> | Â | jump to the previous new message |
<previous-new-then-unread> | Esc <Tab> | jump to the previous new or unread message |
<next-unread> | Â | jump to the next unread message |
<previous-unread> | Â | jump to the previous unread message |
<parent-message> | P | jump to parent message in thread |
<extract-keys> | ^K | extract supported public keys |
<forget-passphrase> | ^F | wipe passphrase(s) from memory |
<check-traditional-pgp> | Esc P | check for classic PGP |
<mail-key> | Esc k | mail a PGP public key |
<decrypt-copy> | Â | make decrypted copy |
<decrypt-save> | Â | make decrypted copy and delete |
Table 8.4. Default pager function bindings
| Function | Default key | Description |
|---|---|---|
<break-thread> | # | break the thread in two |
<create-alias> | a | create an alias from a message sender |
<bounce-message> | b | remail a message to another user |
<change-folder> | c | open a different folder |
<change-folder-readonly> | Esc c | open a different folder in read only mode |
<next-unread-mailbox> | Â | open next mailbox with new mail |
<copy-message> | C | copy a message to a file/mailbox |
<decode-copy> | Esc C | make decoded (text/plain) copy |
<delete-message> | d | delete the current entry |
<delete-thread> | ^D | delete all messages in thread |
<delete-subthread> | Esc d | delete all messages in subthread |
<edit> | e | edit the raw message |
<edit-type> | ^E | edit attachment content type |
<forward-message> | f | forward a message with comments |
<flag-message> | F | toggle a message's 'important' flag |
<group-reply> | g | reply to all recipients |
<imap-fetch-mail> | Â | force retrieval of mail from IMAP server |
<display-toggle-weed> | h | display message and toggle header weeding |
<next-undeleted> | j | move to the next undeleted message |
<next-entry> | J | move to the next entry |
<previous-undeleted> | k | move to the previous undeleted message |
<previous-entry> | K | move to the previous entry |
<link-threads> | & | link tagged message to the current one |
<list-reply> | L | reply to specified mailing list |
<redraw-screen> | ^L | clear and redraw the screen |
<mail> | m | compose a new mail message |
<mark-as-new> | N | toggle a message's 'new' flag |
<search-next> | n | search for next match |
<next-thread> | ^N | jump to the next thread |
<next-subthread> | Esc n | jump to the next subthread |
<print-message> | p | print the current entry |
<previous-thread> | ^P | jump to previous thread |
<previous-subthread> | Esc p | jump to previous subthread |
<quit> | Q | save changes to mailbox and quit |
<exit> | q | exit this menu |
<reply> | r | reply to a message |
<recall-message> | R | recall a postponed message |
<read-thread> | ^R | mark the current thread as read |
<read-subthread> | Esc r | mark the current subthread as read |
<resend-message> | Esc e | use the current message as a template for a new one |
<save-message> | s | save message/attachment to a file |
<skip-quoted> | S | skip beyond quoted text |
<decode-save> | Esc s | make decoded copy (text/plain) and delete |
<tag-message> | t | tag the current entry |
<toggle-quoted> | T | toggle display of quoted text |
<undelete-message> | u | undelete the current entry |
<undelete-subthread> | Esc u | undelete all messages in subthread |
<undelete-thread> | ^U | undelete all messages in thread |
<view-attachments> | v | show MIME attachments |
<show-version> | V | show the Mutt version number and date |
<search-toggle> | \\ | toggle search pattern coloring |
<display-address> | @ | display full address of sender |
<next-new> | Â | jump to the next new message |
<pipe-message> | | | pipe message/attachment to a shell command |
<help> | ? | this screen |
<next-page> | <Space> | move to the next page |
<previous-page> | - | move to the previous page |
<top> | ^ | jump to the top of the message |
<sync-mailbox> | $ | save changes to mailbox |
<shell-escape> | ! | invoke a command in a subshell |
<enter-command> | : | enter a muttrc command |
<buffy-list> | . | list mailboxes with new mail |
<search> | / | search for a regular expression |
<search-reverse> | Esc / | search backwards for a regular expression |
<search-opposite> | Â | search for next match in opposite direction |
<next-line> | <Return> | scroll down one line |
<jump> | Â | jump to an index number |
<next-unread> | Â | jump to the next unread message |
<previous-new> | Â | jump to the previous new message |
<previous-unread> | Â | jump to the previous unread message |
<half-up> | Â | scroll up 1/2 page |
<half-down> | Â | scroll down 1/2 page |
<previous-line> | Â | scroll up one line |
<bottom> | Â | jump to the bottom of the message |
<parent-message> | P | jump to parent message in thread |
<check-traditional-pgp> | Esc P | check for classic PGP |
<mail-key> | Esc k | mail a PGP public key |
<extract-keys> | ^K | extract supported public keys |
<forget-passphrase> | ^F | wipe passphrase(s) from memory |
<decrypt-copy> | Â | make decrypted copy |
<decrypt-save> | Â | make decrypted copy and delete |
<what-key> | Â | display the keycode for a key press |
Table 8.5. Default alias function bindings
| Function | Default key | Description |
|---|---|---|
<delete-entry> | d | delete the current entry |
<undelete-entry> | u | undelete the current entry |
Table 8.6. Default query function bindings
| Function | Default key | Description |
|---|---|---|
<create-alias> | a | create an alias from a message sender |
<mail> | m | compose a new mail message |
<query> | Q | query external program for addresses |
<query-append> | A | append new query results to current results |
Table 8.7. Default attach function bindings
| Function | Default key | Description |
|---|---|---|
<bounce-message> | b | remail a message to another user |
<display-toggle-weed> | h | display message and toggle header weeding |
<edit-type> | ^E | edit attachment content type |
<print-entry> | p | print the current entry |
<save-entry> | s | save message/attachment to a file |
<pipe-entry> | | | pipe message/attachment to a shell command |
<view-mailcap> | m | force viewing of attachment using mailcap |
<reply> | r | reply to a message |
<resend-message> | Esc e | use the current message as a template for a new one |
<group-reply> | g | reply to all recipients |
<list-reply> | L | reply to specified mailing list |
<forward-message> | f | forward a message with comments |
<view-text> | T | view attachment as text |
<view-attach> | <Return> | view attachment using mailcap entry if necessary |
<delete-entry> | d | delete the current entry |
<undelete-entry> | u | undelete the current entry |
<collapse-parts> | v | Toggle display of subparts |
<check-traditional-pgp> | Esc P | check for classic PGP |
<extract-keys> | ^K | extract supported public keys |
<forget-passphrase> | ^F | wipe passphrase(s) from memory |
Table 8.8. Default compose function bindings
| Function | Default key | Description |
|---|---|---|
<attach-file> | a | attach file(s) to this message |
<attach-message> | A | attach message(s) to this message |
<edit-bcc> | b | edit the BCC list |
<edit-cc> | c | edit the CC list |
<copy-file> | C | save message/attachment to a file |
<detach-file> | D | delete the current entry |
<toggle-disposition> | ^D | toggle disposition between inline/attachment |
<edit-description> | d | edit attachment description |
<edit-message> | e | edit the message |
<edit-headers> | E | edit the message with headers |
<edit-file> | ^X e | edit the file to be attached |
<edit-encoding> | ^E | edit attachment transfer-encoding |
<edit-from> | Esc f | edit the from field |
<edit-fcc> | f | enter a file to save a copy of this message in |
<filter-entry> | F | filter attachment through a shell command |
<get-attachment> | G | get a temporary copy of an attachment |
<display-toggle-weed> | h | display message and toggle header weeding |
<ispell> | i | run ispell on the message |
<print-entry> | l | print the current entry |
<edit-mime> | m | edit attachment using mailcap entry |
<new-mime> | n | compose new attachment using mailcap entry |
<postpone-message> | P | save this message to send later |
<edit-reply-to> | r | edit the Reply-To field |
<rename-file> | R | rename/move an attached file |
<edit-subject> | s | edit the subject of this message |
<edit-to> | t | edit the TO list |
<edit-type> | ^T | edit attachment content type |
<write-fcc> | w | write the message to a folder |
<toggle-unlink> | u | toggle whether to delete file after sending it |
<toggle-recode> | Â | toggle recoding of this attachment |
<update-encoding> | U | update an attachment's encoding info |
<view-attach> | <Return> | view attachment using mailcap entry if necessary |
<send-message> | y | send the message |
<pipe-entry> | | | pipe message/attachment to a shell command |
<attach-key> | Esc k | attach a PGP public key |
<pgp-menu> | p | show PGP options |
<forget-passphrase> | ^F | wipe passphrase(s) from memory |
<smime-menu> | S | show S/MIME options |
<mix> | M | send the message through a mixmaster remailer chain |
Table 8.9. Default postpone function bindings
| Function | Default key | Description |
|---|---|---|
<delete-entry> | d | delete the current entry |
<undelete-entry> | u | undelete the current entry |
Table 8.10. Default browser function bindings
| Function | Default key | Description |
|---|---|---|
<change-dir> | c | change directories |
<display-filename> | @ | display the currently selected file's name |
<enter-mask> | m | enter a file mask |
<sort> | o | sort messages |
<sort-reverse> | O | sort messages in reverse order |
<select-new> | N | select a new file in this directory |
<check-new> | Â | check mailboxes for new mail |
<toggle-mailboxes> | <Tab> | toggle whether to browse mailboxes or all files |
<view-file> | <Space> | view file |
<buffy-list> | . | list mailboxes with new mail |
<create-mailbox> | C | create a new mailbox (IMAP only) |
<delete-mailbox> | d | delete the current mailbox (IMAP only) |
<rename-mailbox> | r | rename the current mailbox (IMAP only) |
<subscribe> | s | subscribe to current mailbox (IMAP only) |
<unsubscribe> | u | unsubscribe from current mailbox (IMAP only) |
<toggle-subscribed> | T | toggle view all/subscribed mailboxes (IMAP only) |
Table 8.11. Default pgp function bindings
| Function | Default key | Description |
|---|---|---|
<verify-key> | c | verify a PGP public key |
<view-name> | % | view the key's user id |
Table 8.12. Default smime function bindings
| Function | Default key | Description |
|---|---|---|
<verify-key> | c | verify a PGP public key |
<view-name> | % | view the key's user id |
Table 8.13. Default mix function bindings
| Function | Default key | Description |
|---|---|---|
<accept> | <Return> | Accept the chain constructed |
<append> | a | Append a remailer to the chain |
<insert> | i | Insert a remailer into the chain |
<delete> | d | Delete a remailer from the chain |
<chain-prev> | <Left> | Select the previous element of the chain |
<chain-next> | <Right> | Select the next element of the chain |
Table 8.14. Default editor function bindings
| Function | Default key | Description |
|---|---|---|
<bol> | ^A | jump to the beginning of the line |
<backward-char> | ^B | move the cursor one character to the left |
<backward-word> | Esc b | move the cursor to the beginning of the word |
<capitalize-word> | Esc c | capitalize the word |
<downcase-word> | Esc l | convert the word to lower case |
<upcase-word> | Esc u | convert the word to upper case |
<delete-char> | ^D | delete the char under the cursor |
<eol> | ^E | jump to the end of the line |
<forward-char> | ^F | move the cursor one character to the right |
<forward-word> | Esc f | move the cursor to the end of the word |
<backspace> | <Backspace> | delete the char in front of the cursor |
<kill-eol> | ^K | delete chars from cursor to end of line |
<kill-eow> | Esc d | delete chars from the cursor to the end of the word |
<kill-line> | ^U | delete all chars on the line |
<quote-char> | ^V | quote the next typed key |
<kill-word> | ^W | delete the word in front of the cursor |
<complete> | <Tab> | complete filename or alias |
<complete-query> | ^T | complete address with query |
<buffy-cycle> | <Space> | cycle among incoming mailboxes |
<history-up> | Â | scroll up through the history list |
<history-down> | Â | scroll down through the history list |
<transpose-chars> | Â | transpose character under cursor with previous |