X-Git-Url: https://git.llucax.com/software/mutt-debian.git/blobdiff_plain/44c01adf506b1087bff724dcb65b92a12b012836..2df9cdc41c20e4e6afd99c0ae688c7c7baa4343b:/doc/reference.html?ds=inline diff --git a/doc/reference.html b/doc/reference.html index 03e316d..cd6ebf1 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -1,6 +1,6 @@ -
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 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 9.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
@@ -52,32 +54,42 @@ To compose a new message
file
[...]
--
-]
+]
address
-...
-Mutt also supports a âbatchâ mode to send prepared messages. Simply redirect
-input from the file you wish to send. For example,
+ |
+mailto_url
+ ...
+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
-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 a single or several files, use â--â to separate files and
-recipient addresses:
+mutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat
+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 a single or
+several files, use â--â to separate files and recipient
+addresses:
mutt -a image.png -- some@one.org
or
-mutt -a *.png -- some@one.org
+mutt -a *.png -- some@one.org
The -a
option must be last in the option list.
-
+In addition to accepting a list of email addresses, Mutt also accepts a URL with
+the mailto:
schema as specified in RFC2368. This is useful
+when configuring a web browser to launch Mutt when clicking on mailto links.
+
+mutt mailto:some@one.org?subject=test&cc=other@one.org
The following are the commands understood by Mutt: -
account-hook
pattern
command
-
alias
[
+
alias
[
-group
name
...]
@@ -93,7 +105,7 @@ The following are the commands understood by Mutt:
*
|
key
-... }
alternates
[
+... }
alternates
[
-group
name
...]
@@ -107,7 +119,7 @@ The following are the commands understood by Mutt:
*
|
regexp
-... }
alternative-order
+... }
alternative-order
mimetype
[
mimetype
@@ -115,7 +127,7 @@ The following are the commands understood by Mutt:
*
|
mimetype
-... }
attachments
+... }
attachments
{ + | - }disposition
mime-type
@@ -123,29 +135,29 @@ The following are the commands understood by Mutt:
{ + | - }disposition
mime-type
-
auto_view
mimetype
[
mimetype
-...]unauto-view
{
+...]unauto_view
{
*
|
mimetype
-... }
bind
+... }
bind
map
key
function
-
charset-hook
alias
charset
-
iconv-hook
charset
local-charset
-
color
+
color
object
foreground
@@ -179,27 +191,27 @@ The following are the commands understood by Mutt:
*
|
pattern
-... }
crypt-hook
+... }
crypt-hook
pattern
keyid
-
exec
+
exec
function
[
function
-...]
fcc-hook
+...]
fcc-hook
[!]pattern
mailbox
-
fcc-save-hook
[!]pattern
mailbox
-
folder-hook
[!]regexp
command
-
group
[
+
group
[
-group
name
...] {
@@ -219,23 +231,23 @@ The following are the commands understood by Mutt:
... |
-addr
expr
-... }
hdr_order
+... }
hdr_order
header
[
header
-...]unhdr_order
{
+...]unhdr_order
{
*
|
header
-... }
ignore
+... }
lists
[
+... }
lists
[
-group
name
]
@@ -249,7 +261,7 @@ The following are the commands understood by Mutt:
*
|
regexp
-... }
macro
+... }
macro
menu
key
@@ -257,7 +269,7 @@ The following are the commands understood by Mutt:
sequence
[
description
-]
mailboxes
+]
mailboxes
mailbox
[
mailbox
@@ -265,15 +277,15 @@ The following are the commands understood by Mutt:
*
|
mailbox
-... }
mbox-hook
+... }
mbox-hook
[!]pattern
mailbox
-
message-hook
[!]pattern
command
-
mime-lookup
mimetype
[
mimetype
@@ -281,7 +293,7 @@ The following are the commands understood by Mutt:
*
|
mimetype
-... }
mono
+... }
mono
object
attribute
@@ -309,39 +321,39 @@ The following are the commands understood by Mutt:
*
|
pattern
-... }
my_hdr
+... }
push
+... }
push
string
-
save-hook
[!]pattern
mailbox
-
score
+
reply-hook
+... }
reply-hook
[!]pattern
command
-
send-hook
[!]pattern
command
-
send2-hook
[!]pattern
command
-
set
{
+
set
{
[ no
| inv
]
variable
|
@@ -358,9 +370,9 @@ The following are the commands understood by Mutt:
variable
[
variable
-...]
source
+...]
source
filename
-
spam
+
spam
pattern
format
@@ -368,7 +380,7 @@ The following are the commands understood by Mutt:
*
|
pattern
- }
subscribe
[
+ }
subscribe
[
-group
name
...]
@@ -382,50 +394,50 @@ The following are the commands understood by Mutt:
*
|
regexp
-... }
unhook
{
+... }
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 no, composing messages with no subject given at the subject prompt will never be aborted. -
Type:Â quadoption
+
Type:Â quadoption
Default:Â yes
If set to yes, composition will automatically abort after 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. 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 in case +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. -
Type:Â string
-Default: â%4n %2f %t %-10a   %r
â
-Specifies the format of the data displayed for the âaliasâ menu. The +â~/.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:
%a | alias name - |
%f | flags - currently, a âdâ for an alias marked for deletion + |
%f | flags - currently, a âdâ for an alias marked for deletion |
%n | index number |
%r | address which alias expands to |
%t | character which indicates if the alias is tagged for inclusion - |
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
+
Type:Â boolean
Default:Â no
Controls whether ANSI color codes in messages (and color tags in rich text messages) are to be interpreted. @@ -439,33 +451,33 @@ message could include a line like
and give it the same color as your attachment color (see also $crypt_timestamp). -
Type:Â boolean
+
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
+
Type:Â boolean
Default:Â no
If set, Mutt will use plain ASCII characters when displaying thread and attachment trees, instead of the default ACS characters. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients before editing an outgoing message. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
If set, Mutt will prompt you for carbon-copy (Cc) recipients before editing the body of an outgoing message. -
Type:Â string
+
Type:Â string
Default:Â (empty)
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: @@ -473,12 +485,12 @@ 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. -
Type:Â string
+
Type:Â string
Default:Â (empty)
This variable is a colon-separated list of character encoding schemes for text file attachments. Mutt uses this setting to guess which encoding files being attached are encoded in to convert them to -a proper character set given in $send_charset. +a proper character set given in $send_charset.
If unset, the value of $charset will be used instead. For example, the following configuration would work for Japanese @@ -487,58 +499,58 @@ text handling:
set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
-Note: for Japanese users, âiso-2022-*â must be put at the head +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 +
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(3)
-style sequences are understood:
%C | charset - |
%c | requires charset conversion (ânâ or âcâ) + |
%c | requires charset conversion (ânâ or âcâ) |
%D | deleted flag |
%d | description |
%e | MIME content-transfer-encoding |
%f | filename - |
%I | disposition (âIâ for inline, âAâ for attachment) + |
%I | disposition (âIâ for inline, âAâ for attachment) |
%m | major MIME type |
%M | MIME subtype |
%n | attachment number - |
%Q | âQâ, if MIME part qualifies for attachment counting + |
%Q | âQâ, if MIME part qualifies for attachment counting |
%s | size |
%t | tagged flag |
%T | graphic tree characters |
%u | unlink (=to delete) flag |
%X | number of qualifying MIME parts in this part and its children -(please see the âattachmentsâ section for possible speed effects) - |
%>X | right justify the rest of the string and pad with character âXâ - |
%|X | pad to the end of the line with character âXâ - |
%*X | soft-fill with character âXâ as pad +(please see the âattachmentsâ section for possible speed effects) + |
%>X | right justify the rest of the string and pad with character âXâ + |
%|X | pad to the end of the line with character âXâ + |
%*X | soft-fill with character âXâ as pad |
-For an explanation of âsoft-fillâ, see the $index_format documentation. -
Type:Â string
-Default:Â â\n
â
+For an explanation of âsoft-fillâ, see the $index_format documentation. +
Type:Â string
+Default:Â â\n
â
The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
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, Mutt will operate on the attachments one by one. -
Type:Â string
+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(3)
-like sequences see
the section on $index_format.
-
Type:Â boolean
+
Type:Â boolean
Default:Â no
When set, functions in the index menu which affect a message
will be applied to all tagged messages (if there are any). When
-unset, you must first use the <tag-prefix>
function (bound to â;â
+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
+
Type:Â boolean
Default:Â no
When set along with $edit_headers, Mutt will skip the initial send-menu (prompting for subject and recipients) and allow you to @@ -551,33 +563,33 @@ on the recipients when composing a new (non-reply) message, as the initial list of recipients is empty.
Also see $fast_reply. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
When this variable is set, mutt will beep when an error occurs. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
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. -
Type:Â quadoption
+
Type:Â quadoption
Default:Â ask-yes
Controls whether you will be asked to confirm bouncing messages. If set to yes you don't get asked if you want to bounce a message. Setting this variable to no is not generally useful, and thus not recommended, because you are unable to bounce messages. -
Type:Â boolean
+
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. -
Type:Â boolean
+
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 unset by default because many visual terminals don't permit making the cursor invisible. -
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 @@ -592,17 +604,17 @@ Example:
set certificate_file=~/.mutt/certificates -
Type:Â string
+
Type:Â string
Default:Â (empty)
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 +Note: It should only be set in case Mutt isn't able to determine the character set used correctly. -
Type:Â boolean
+
Type:Â boolean
Default:Â no
When this variable is set, mutt will use file size attribute instead of access time when checking for new mail in mbox and mmdf folders. @@ -610,12 +622,12 @@ 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â +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. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
Note: this option only affects maildir and MH style mailboxes. @@ -626,14 +638,14 @@ take quite some time since it involves scanning the directory and checking each file to see if it has already been looked at. If this variable is unset, no check for new mail is performed while the mailbox is open. -
Type:Â boolean
+
Type:Â boolean
Default:Â yes
When unset, Mutt will not collapse a thread if it contains any unread messages. -
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 +
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(3)
-like sequences:
%a | total number of attachments
@@ -641,9 +653,9 @@ set of printf(3) -like sequences:
|
%l | approximate size (in bytes) of the current message |
%v | Mutt version string |
-See the text describing the $status_format option for more +See the text describing the $status_format option for more information on how to set $compose_format. -
Type:Â string
+
Type:Â string
Default:Â (empty)
When defined, Mutt will recode commands in rc files from this
encoding to the current character set as specified by $charset
@@ -655,64 +667,64 @@ setting Type:Â boolean Type:Â boolean
When set, Mutt will prompt for confirmation when appending messages to
an existing mailbox.
- Type:Â boolean Type:Â boolean
When set, Mutt will prompt for confirmation when saving messages to a
mailbox which does not yet exist before creating it.
- Type:Â number Type:Â number
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 attempt to succeed.
- Type:Â string
Sets the default Content-Type for the body of newly composed messages.
- Type:Â quadoption Type:Â quadoption
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â.
- Type:Â boolean Type:Â boolean
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
+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,
+signing is requested as well. If $smime_is_default is set,
then OpenSSL is used instead to create S/MIME messages and
settings can be overridden by use of the smime menu instead.
(Crypto only)
- Type:Â boolean Type:Â boolean
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.
- Type:Â boolean Type:Â boolean
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,
+encryption is requested as well. If $smime_is_default is set,
then OpenSSL is used instead to create S/MIME messages and settings can
be overridden by use of the smime menu instead of the pgp menu.
(Crypto only)
- Type:Â boolean Type:Â boolean
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.
- Type:Â boolean Type:Â boolean
If set, automatically PGP or OpenSSL encrypt replies to messages which are
encrypted.
(Crypto only)
- Type:Â boolean Type:Â boolean
If set, automatically PGP or OpenSSL sign replies to messages which are
signed.
@@ -720,7 +732,7 @@ signed.
Note: this does not work on messages that are encrypted
and signed!
(Crypto only)
- Type:Â boolean Type:Â boolean
If set, automatically PGP or OpenSSL sign replies to messages
which are encrypted. This makes sense in combination with
@@ -729,47 +741,47 @@ messages which are automatically encrypted. This works around
the problem noted in $crypt_replysign, that mutt is not able
to find out whether an encrypted message is also signed.
(Crypto only)
- Type:Â boolean Type:Â boolean
If set, mutt will include a time stamp in the lines surrounding
PGP or S/MIME output, so spoofing such lines is more difficult.
If you are using colors to mark these lines, and rely on these,
you may unset this setting.
(Crypto only)
- Type:Â boolean Type:Â boolean
This variable controls the use of the GPGME-enabled crypto backends.
If it is set and Mutt was built with gpgme support, the gpgme code for
S/MIME and PGP will be used instead of the classic code. Note that
you need to set this option in .muttrc; it won't have any effect when
used interactively.
- Type:Â boolean Type:Â boolean
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:Â quadoption Type:Â quadoption
-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.
+If âyesâ, always attempt to verify PGP or S/MIME signatures.
+If âask-*â, ask whether or not to verify the signature.
+If ânoâ, never attempt to verify cryptographic signatures.
(Crypto only)
- Type:Â string
-This variable controls the format of the date printed by the â%dâ
+ Type:Â string
+This variable controls the format of the date printed by the â%dâ
sequence in $index_format. This is passed to the
-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
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
-This variable controls how âmessage-hookâ, âreply-hookâ, âsend-hookâ,
-âsend2-hookâ, âsave-hookâ, and âfcc-hookâ will
+ Type:Â string
+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
@@ -778,33 +790,33 @@ 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 Type:Â quadoption
Controls whether or not messages are really deleted when closing or
synchronizing a mailbox. If set to yes, messages marked for
deleting will automatically be purged without prompting. If set to
no, messages marked for deletion will be kept in the mailbox.
- Type:Â boolean Type:Â boolean
If this option is set, mutt will untag messages when marking them
for deletion. This applies when you either explicitly delete a message,
or when you save it to another folder.
- Type:Â boolean Type:Â boolean
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.
- Type:Â path Type:Â path
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
filtered message is read from the standard output.
- Type:Â path
Contains the path of the Type:Â string Type:Â string
This variable sets the request for when notification is returned. The
string consists of a comma separated list (no spaces!) of one or more
@@ -818,12 +830,12 @@ Example:
-Note: when using $sendmail for delivery, you should not enable
+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 Type:Â string Type:Â string
This variable controls how much of your message is returned in DSN
messages. It may be set to either hdrs to return just the
@@ -834,48 +846,48 @@ Example:
-Note: when using $sendmail for delivery, you should not enable
+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 Type:Â boolean Type:Â boolean
-This variable controls whether mutt, when $sort is set to threads, threads
+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 tree.
- Type:Â boolean Type:Â boolean
This option allows you to edit the header of your outgoing messages
along with the body of your message.
Note that changes made to the References: and Date: headers are
ignored for interoperability reasons.
- Type:Â path Type:Â path
This variable specifies which editor is used by mutt.
It defaults to the value of the Type:Â boolean Type:Â boolean
When set, mutt will quoted-printable encode messages when
-they contain the string âFrom â (note the trailing space) in the beginning of a line.
+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).
- Type:Â path Type:Â path
The file which includes random data that is used to initialize SSL
library functions.
- Type: e-mail address Type: e-mail address
Manually sets the envelope sender for outgoing messages.
-This value is ignored if $use_envelope_from is unset.
- Type:Â string
-Escape character to use for functions in the builtin editor.
- Type:Â boolean Type:Â string
+Escape character to use for functions in the built-in editor.
+ Type:Â boolean
When set, the initial prompt for recipients and subject are skipped
when replying to messages, and the initial prompt for subject is
@@ -883,53 +895,54 @@ skipped when forwarding messages.
Note: this variable has no effect when the $autoedit
variable is set.
- Type:Â quadoption Type:Â quadoption
This variable controls whether or not attachments on outgoing messages
are saved along with the main body of your message.
- Type:Â boolean Type:Â boolean
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
-Specifies the default location of your mailboxes. A â+â or â=â at the
+ Type:Â path
+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)
value you need to make sure that the assignment occurs before
-you use â+â or â=â for any other variables since expansion takes place
-when handling the âmailboxesâ command.
- Type:Â string
+you use â+â or â=â for any other variables since expansion takes place
+when handling the âmailboxesâ command.
+ Type:Â string
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
-For an explanation of âsoft-fillâ, see the $index_format documentation.
- Type:Â boolean Type:Â boolean
-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
@@ -943,72 +956,72 @@ email address for unsubscribed lists. Without this header, a
group reply to your message sent to a subscribed list will be
sent to both the list and your address, resulting in two copies
of the same email for you.
- Type:Â boolean Type:Â boolean
-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.
- Type:Â boolean Type:Â boolean
Controls the decoding of complex MIME messages into Type:Â boolean Type:Â boolean
Controls the handling of encrypted messages when forwarding a message.
When set, the outer layer of encryption is stripped off. This
-variable is only used if $mime_forward is set and
-$mime_forward_decode is unset.
+variable is only used if $mime_forward is set and
+$mime_forward_decode is unset.
(PGP only)
- Type:Â quadoption Type:Â quadoption
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â.
- Type:Â string
+to forward with no modification, use a setting of ânoâ.
+ Type:Â string
This variable controls the default subject when forwarding a message.
It uses the same format sequences as the $index_format variable.
- Type:Â boolean Type:Â boolean
When set, forwarded messages included in the main body of the
-message (when $mime_forward is unset) will be quoted using
+message (when $mime_forward is unset) will be quoted using
$indent_string.
- Type: e-mail address Type: e-mail address
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.
+can be overridden using âmy_hdrâ (including from a âsend-hookâ) and
+$reverse_name. This variable is ignored if $use_from is unset.
This setting defaults to the contents of the environment variable Type: regular expression
A regular expression used by mutt to parse the GECOS field of a password
entry when expanding the alias. The default value
-will return the string up to the first â,â encountered.
-If the GECOS field contains a string like âlastname, firstnameâ then you
-should set it to â
This can be useful if you see the following behavior: you address an e-mail
-to user ID âstevefâ whose full name is âSteve Franklinâ. If mutt expands
-âstevefâ to â"Franklin" stevef@foo.barâ then you should set the $gecos_mask to
+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â.
- Type:Â boolean Type:Â boolean
-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,
the user defined header fields are added to every new message.
- Type:Â boolean Type:Â boolean
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.
- Type:Â path Type:Â path
This variable points to the header cache database.
If pointing to a directory Mutt will contain a header cache
@@ -1017,22 +1030,22 @@ be a single global header cache. By default it is uns
caching will be used.
Header caching can greatly improve speed when opening POP, IMAP
-MH or Maildir folders, see âcachingâ for details.
- Type:Â boolean Type:Â boolean
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
+of the usual diskspace, but the decompression can result in a
slower opening of cached folder(s) which in general is still
much faster than opening non header cached folders.
- Type:Â string
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
When set, help lines describing the bindings for the major functions
provided by each menu are displayed on the first line of the screen.
@@ -1042,95 +1055,95 @@ function is bound to a sequence rather than a single keystroke. Also,
the help line may not be updated if a binding is changed while Mutt is
running. Since this variable is primarily aimed at new users, neither
of these should present a major problem.
- Type:Â boolean Type:Â boolean
When set, mutt will skip the host name part of $hostname variable
when adding the domain part to addresses. This variable does not
affect the generation of Message-IDs, and it will not lead to the
cut-off of first-level domains.
- Type:Â boolean Type:Â boolean
When set, mutt will not show the presence of messages that are hidden
by limiting, in the thread tree.
- Type:Â boolean Type:Â boolean
When set, mutt will not show the presence of missing messages in the
thread tree.
- Type:Â boolean Type:Â boolean
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 Type:Â boolean
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.
- Type:Â boolean Type:Â boolean
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 Type:Â number
This variable controls the size (in number of strings remembered) of
the string history buffer per category. The buffer is cleared each time the
variable is set.
- Type:Â path
The file in which Mutt will save its history.
- Type:Â boolean Type:Â boolean
When set, Mutt will not display attachments with a
-disposition of âattachmentâ inline even if it could
+disposition of âattachmentâ inline even if it could
render the part to plain text. These MIME parts can only
be viewed from the attachment menu.
If unset, Mutt will render all MIME parts it can
properly transform to plain text.
- Type:Â quadoption Type:Â quadoption
This variable controls whether or not a Mail-Followup-To header is
honored when group-replying to a message.
- Type:Â string Type:Â string
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
-Also see $use_domain and $hidden_host.
- Type:Â boolean Type:Â boolean
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.
- Type:Â boolean
-Affects the behaviour of the Type:Â boolean
+Affects the behavior of the Type:Â string Type:Â string
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 option is case-insensitive. If it's
+try them. Authentication methods are either âloginâ or the right
+side of an IMAP âAUTH=xxxâ capability string, e.g. âdigest-md5â, âgssapiâ
+or âcram-md5â. This option is case-insensitive. If it's
unset (the default) mutt will try all available methods,
in order from most-secure to least-secure.
@@ -1142,37 +1155,37 @@ 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.
- Type:Â boolean Type:Â boolean
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 just as if you had issued individual âmailboxesâ
+it polls for new mail just as if you had issued individual âmailboxesâ
commands.
- Type:Â string
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.
- Type:Â string Type:Â string
Mutt requests these header fields in addition to the default headers
-(âDate:â, âFrom:â, âSubject:â, âTo:â, âCc:â, âMessage-Id:â,
-âReferences:â, âContent-Type:â, âContent-Description:â, âIn-Reply-To:â,
-âReply-To:â, âLines:â, âList-Post:â, âX-Label:â) from IMAP
+(â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, 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 Type:Â boolean
When set, mutt will attempt to use the IMAP IDLE extension
to check for new mail in the current mailbox. Some servers
(dovecot was the inspiration for this option) react badly
to mutt's implementation. If your connection seems to freeze
up periodically, try unsetting this.
- Type:Â number Type:Â number
This variable specifies the maximum amount of time in seconds that mutt
will wait before polling open IMAP connections, to prevent the server
@@ -1181,17 +1194,17 @@ well within the RFC-specified minimum amount of time (30 minutes) before
a server is allowed to do this, but in practice the RFC does get
violated every now and then. Reduce this number if you find yourself
getting disconnected from your IMAP server due to inactivity.
- Type:Â boolean Type:Â boolean
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 Type:Â string Type:Â string
Your login name on the IMAP server.
This variable defaults to the value of $imap_user.
- Type:Â string Type:Â string
Specifies the password for your IMAP account. If unset, Mutt will
prompt you for your password when you invoke the Type:Â boolean Type:Â boolean
When set, mutt will not open new IMAP connections to check for new
mail. Mutt will only check for new mail over existing IMAP
connections. This is useful if you don't want to be prompted to
user/password pairs on mutt invocation, or if opening the connection
is slow.
- Type:Â boolean Type:Â boolean
When set, mutt will avoid implicitly marking your mail as read whenever
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:Â number Type:Â number
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
@@ -1222,51 +1235,51 @@ 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 Type:Â boolean
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 Type:Â string
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
-If set to âyesâ, mutt will look for a mailcap entry with the
-â Type:Â quadoption Type:Â quadoption
Controls whether or not a copy of the message(s) you are replying to
is included in your reply.
- Type:Â boolean Type:Â boolean
Controls whether or not Mutt includes only the first attachment
of the message you are replying.
- Type:Â string
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.
-The value of this option is ignored if $text_flowed is set, too because
+The value of this option is ignored if $text_flowed is set, too because
the quoting mechanism is strictly defined for format=flowed.
This option is a format string, please see the description of
$index_format for supported Type:Â string
+ Type:Â string
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
+âFormat stringsâ are similar to the strings used in the C
function
-âSoft-fillâ deserves some explanation: Normal right-justification
-will print everything to the left of the â%>â, displaying padding and
+â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
@@ -1336,28 +1349,37 @@ 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.
- Type:Â path
+âsave-hookâ, âfcc-hookâ and âfcc-save-hookâ, too.
+ Type:Â path
How to invoke ispell (GNU's spell-checking software).
- Type:Â boolean Type:Â boolean
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
+from your spool mailbox to your $mbox mailbox, or as a result of
+a âmbox-hookâ command.
+ Type:Â string
The locale used by Type:Â number Type:Â number
This variable configures how often (in seconds) mutt should look for
-new mail. Also see the $timeout variable.
- Type:Â string Type:Â boolean
+When set, Mutt will only notify you about new mail that has been received
+since the last time you opened the mailbox. When unset, Mutt will notify you
+if any new mail exists in the mailbox, regardless of whether you have visited it
+recently.
+
+When $mark_old is set, Mutt does not consider the mailbox to contain new
+mail if only old messages exist.
+ Type:Â string
This variable specifies which files to consult when attempting to
display MIME bodies not directly supported by Mutt.
- Type:Â boolean Type:Â boolean
If set, mutt will restrict possible characters in mailcap % expandos
to a well-defined set of safe characters. This is the safe setting,
@@ -1365,69 +1387,69 @@ 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:Â boolean Type:Â boolean
Check for Maildir unaware programs other than mutt having modified maildir
files when the header cache is in use. This incurs one Type:Â boolean Type:Â boolean
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
Controls whether or not mutt marks new unread
messages as old if you exit a mailbox without reading them.
With this option set, the next time you start mutt, the messages
-will show up with an âOâ next to them in the index menu,
+will show up with an âOâ next to them in the index menu,
indicating that they are old.
- Type:Â boolean Type:Â boolean
Controls the display of wrapped lines in the internal pager. If set, a
-â+â marker is displayed at the beginning of wrapped lines.
+â+â marker is displayed at the beginning of wrapped lines.
-Also see the $smart_wrap variable.
- Type: regular expression
+Also see the $smart_wrap variable.
+ Type: regular expression
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
-This specifies the folder into which read mail in your $spoolfile
+ Type:Â path
+This specifies the folder into which read mail in your $spoolfile
folder will be appended.
-Also see the $move variable.
- Type: folder magic Type: folder magic
The default mailbox type used when creating new folders. May be any of
-âmboxâ, âMMDFâ, âMHâ and âMaildirâ. This is overriden by the
+âmboxâ, âMMDFâ, âMHâ and âMaildirâ. This is overridden by the
Type:Â number Type:Â number
This variable controls the number of lines of context that are given
-when scrolling through menus. (Similar to $pager_context.)
- Type:Â boolean Type:Â boolean
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
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
If set, mutt will clean out obsolete entries from the message cache when
the mailbox is synchronized. You probably only want to set it
every once in a while, since it can be a little slow
(especially for large folders).
- Type:Â path Type:Â path
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
@@ -1437,65 +1459,65 @@ 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:Â string
-This is the string displayed in the âattachmentâ menu for
+Also see the $message_cache_clean variable.
+ Type:Â string
+This is the string displayed in the âattachmentâ menu for
attachments of type Type:Â boolean Type:Â boolean
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 Type:Â boolean Type:Â boolean
-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:Â boolean Type:Â boolean
-When unset, mutt will mimic mh's behaviour and rename deleted messages
+When unset, mutt will mimic mh's behavior and rename deleted messages
to ,<old file name> in mh folders instead of really deleting
them. This leaves the message on disk but makes programs reading the folder
ignore it. If the variable is set, the message files will simply be
deleted.
-This option is similar to $maildir_trash for Maildir folders.
- Type:Â string
+This option is similar to $maildir_trash for Maildir folders.
+ Type:Â string
The name of the MH sequence used for flagged messages.
- Type:Â string
The name of the MH sequence used to tag replied messages.
- Type:Â string
The name of the MH sequence used for unseen messages.
- Type:Â quadoption Type:Â quadoption
When set, the message you are forwarding will be attached as a
separate
-Also see $forward_decode and $mime_forward_decode.
- Type:Â boolean Type:Â boolean
Controls the decoding of complex MIME messages into Type:Â quadoption Type:Â quadoption
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
This variable describes the format of a remailer line on the mixmaster
chain selection screen. The following Type:Â path
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 Type:Â quadoption
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:Â boolean Type:Â boolean
This variable, when set, makes the thread tree narrower, allowing
deeper threads to fit on the screen.
- Type:Â number Type:Â number
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, $write_inc and $net_inc.
- Type:Â path
This variable specifies which pager you would like to use to view
-messages. The value âbuiltinâ means to use the builtin pager, otherwise this
+messages. The value âbuiltinâ means to use the built-in pager, otherwise this
variable should specify the pathname of the external pager you would
like to use.
@@ -1537,7 +1559,7 @@ 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
This variable controls the number of lines of context that are given
when displaying the next or previous page in the internal pager. By
@@ -1547,13 +1569,13 @@ at the top of the next page (0 lines of context).
This variable also specifies the amount of context given for search
results. If positive, this many lines will be given before a match,
if 0, the match will be top-aligned.
- Type:Â string
-This variable controls the format of the one-line message âstatusâ
+ Type:Â string
+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
section.
- Type:Â number Type:Â number
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
@@ -1564,14 +1586,14 @@ remain to be read in the current thread. One of the lines is reserved
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
When set, the internal-pager will not move to the next message
when you are at the end of a message and invoke the Type:Â boolean Type:Â boolean
If set, mutt will automatically attempt to decrypt traditional PGP
messages whenever the user performs an operation which ordinarily would
@@ -1579,7 +1601,7 @@ 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 Type:Â boolean Type:Â boolean
This option controls whether Mutt generates old-style inline
(traditional) PGP encrypted or signed messages under certain
@@ -1591,27 +1613,27 @@ which consist of more than a single MIME part. Mutt can be
configured to ask before sending PGP/MIME messages when inline
(traditional) would not work.
-Also see the $pgp_mime_auto variable.
+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
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:Â string Type:Â string
-This format is used to create an old-style âclearsignedâ PGP
+This format is used to create an 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
+This is a format string, see the $pgp_decode_command command for
possible Type:Â string Type:Â string
This format strings specifies a command which is used to decode
application/pgp attachments.
@@ -1623,7 +1645,7 @@ string otherwise. Note: This may be used with a %? construct.
For examples on how to configure these formats for the various versions
@@ -1631,29 +1653,29 @@ of PGP which are floating around, see the pgp and gpg sample configuration files
the Type:Â string Type:Â string
This command is used to decrypt a PGP encrypted message.
-This is a format string, see the $pgp_decode_command command for
+This is a format string, see the $pgp_decode_command command for
possible Type:Â string Type:Â string
This command is used to encrypt a body part without signing it.
-This is a format string, see the $pgp_decode_command command for
+This is a format string, see the $pgp_decode_command command for
possible Type:Â string Type:Â string
This command is used to both sign and encrypt a body part.
-This is a format string, see the $pgp_decode_command command for
+This is a format string, see the $pgp_decode_command command for
possible Type:Â string
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
(PGP only)
- Type:Â string Type:Â string
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
+This is a format string, see the $pgp_decode_command command for
possible Type:Â string Type:Â string
This command is invoked whenever mutt will need public key information.
-Of the sequences supported by $pgp_decode_command, %r is the only
+Of the sequences supported by $pgp_decode_command, %r is the only
Type: regular expression Type: regular expression
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
Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
the principal key will inherit the subkeys' capabilities. Unset this
if you want to play interesting key selection games.
(PGP only)
- Type:Â string Type:Â string
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
+This is a format string, see the $pgp_decode_command command for
possible Type:Â string Type:Â string
This command is used to list the public key ring's contents. The
output format must be analogous to the one used by
@@ -1715,10 +1737,10 @@ gpg --list-keys --with-colons.
This format is also generated by the
-This is a format string, see the $pgp_decode_command command for
+This is a format string, see the $pgp_decode_command command for
possible Type:Â string Type:Â string
This command is used to list the secret key ring's contents. The
output format must be analogous to the one used by:
@@ -1729,14 +1751,14 @@ gpg --list-keys --with-colons.
This format is also generated by the
-This is a format string, see the $pgp_decode_command command for
+This is a format string, see the $pgp_decode_command command for
possible Type:Â boolean Type:Â boolean
If set, use 64 bit PGP key IDs, if unset use the normal 32 bit key IDs.
(PGP only)
- Type:Â quadoption Type:Â quadoption
This option controls whether Mutt will prompt you for
automatically sending a (signed/encrypted) message using
@@ -1745,7 +1767,7 @@ 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
Setting this variable will cause Mutt to always attempt to
create an inline (traditional) message when replying to a
@@ -1760,12 +1782,12 @@ which consist of more than a single MIME part. Mutt can be
configured to ask before sending PGP/MIME messages when inline
(traditional) would not work.
-Also see the $pgp_mime_auto variable.
+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
If set, signed and encrypted messages will consist of nested
Type:Â boolean Type:Â boolean
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 Type:Â string
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. Type:Â string Type:Â string
This command is used to create the detached PGP signature for a
-This is a format string, see the $pgp_decode_command command for
+This is a format string, see the $pgp_decode_command command for
possible Type: sort order Type: sort order
Specifies how the entries in the pgp menu are sorted. The
following are legal values:
@@ -1805,69 +1827,69 @@ following are legal values:
If you prefer reverse order of the above values, prefix it with
-âreverse-â.
+âreverse-â.
(PGP only)
- Type:Â boolean Type:Â boolean
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
The number of seconds after which a cached passphrase will expire if
not used.
(PGP only)
- Type:Â boolean Type:Â boolean
If set, mutt will use a possibly-running Type:Â string Type:Â string
This command is used to verify PGP signatures.
-This is a format string, see the $pgp_decode_command command for
+This is a format string, see the $pgp_decode_command command for
possible Type:Â string Type:Â string
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
+This is a format string, see the $pgp_decode_command command for
possible Type:Â boolean Type:Â boolean
Used in connection with the Type:Â string
The separator to add between messages when piping a list of tagged
messages to an external Unix command.
- Type:Â boolean Type:Â boolean
Used in connection with the Type:Â boolean Type:Â boolean
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:Â string Type:Â string
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â.
+try them. Authentication methods are either âuserâ, âapopâ or any
+SASL mechanism, e.g. âdigest-md5â, âgssapiâ or âcram-md5â.
This option is case-insensitive. If this option is unset
(the default) mutt will try all available methods, in order from
most-secure to least-secure.
@@ -1876,30 +1898,30 @@ Example:
Type:Â number Type:Â number
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
If set, Mutt will delete successfully downloaded messages from the POP
server when using the Type:Â string Type:Â string
The name of your POP server for the
-where â[...]â denotes an optional part.
- Type:Â boolean Type:Â boolean
-If this variable is set, mutt will try to use the â Type:Â string Type:Â string
Specifies the password for your POP account. If unset, Mutt will
prompt you for your password when you open a POP mailbox.
@@ -1907,33 +1929,33 @@ 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:Â quadoption Type:Â quadoption
Controls whether or not Mutt will try to reconnect to the POP server if
the connection is lost.
- Type:Â string Type:Â string
Your login name on the POP server.
This variable defaults to your user name on the local machine.
- Type:Â string Type:Â string
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
-Controls whether or not messages are saved in the $postponed
+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
-Mutt allows you to indefinitely âpostpone sending a messageâ which
+Also see the $recall variable.
+ Type:Â path
+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 Type:Â string
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
@@ -1944,88 +1966,91 @@ status, mutt gives up opening the server. Example:
set preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net \
sleep 20 < /dev/null > /dev/null"
-Mailbox âfooâ on âmailhost.netâ can now be reached
-as â{localhost:1234}fooâ.
+Mailbox âfooâ on âmailhost.netâ can now be reached
+as â{localhost:1234}fooâ.
Note: For this example to work, you must be able to log in to the
remote machine without having to enter a password.
- Type:Â quadoption Type:Â quadoption
Controls whether or not Mutt really prints messages.
-This is set to âask-noâ by default, because some people
-accidentally hit âpâ often.
- Type:Â path
+This is set to âask-noâ by default, because some people
+accidentally hit âpâ often.
+ Type:Â path
This specifies the command pipe that should be used to print messages.
- Type:Â boolean Type:Â boolean
Used in connection with the Type:Â boolean Type:Â boolean
Used in connection with the
Those who use the Type:Â boolean Type:Â boolean
-If you use an external $pager, setting this variable will
+If you use an external $pager, setting this variable will
cause Mutt to prompt you for a command when the pager exits rather
than returning to the index menu. If unset, Mutt will return to the
index menu when the external pager exits.
- Type:Â path
-This specifies the command that mutt will use to make external address
-queries. The string should contain a â%sâ, which will be substituted
-with the query string the user types. See âqueryâ for more
-information.
- Type:Â string
-This variable describes the format of the âqueryâ menu. The
+ Type:Â path
+This specifies the command Mutt will use to make external address
+queries. The string may contain a â%sâ, which will be substituted
+with the query string the user types. Mutt will add quotes around the
+string substituted for â%sâ automatically according to shell quoting
+rules, so you should avoid adding your own. If no â%sâ is found in
+the string, Mutt will append the user's query to the end of the string.
+See âqueryâ for more information.
+ Type:Â string
+This variable describes the format of the âqueryâ menu. The
following
-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 Type:Â quadoption
-This variable controls whether âquitâ and âexitâ actually quit
+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
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
-Higher levels of quoting may be colored differently (âcolor quoted1â,
-âcolor quoted2â, etc.). The quoting level is determined by removing
+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 Type:Â number
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
@@ -2037,20 +2062,20 @@ reading or searching large mailboxes which may take some time.
When set to 0, only a single message will appear before the reading
the mailbox.
-Also see the $write_inc, $net_inc and $time_inc variables and the
-âtuningâ section of the manual for performance considerations.
- Type:Â boolean Type:Â string Type:Â string
-This variable specifies what ârealâ or âpersonalâ name should be used
+This variable specifies what ârealâ or âpersonalâ name should be used
when sending messages.
By default, this is the GECOS field from Type:Â quadoption Type:Â quadoption
Controls whether or not Mutt recalls postponed messages
when composing a new message.
@@ -2058,29 +2083,29 @@ when composing a new message.
Setting this variable to is not generally useful, and thus not
recommended.
-Also see $postponed variable.
- Type:Â path
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
+The value of $record is overridden by the $force_name and
+$save_name variables, and the âfcc-hookâ command.
+ Type: regular expression
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
If unset and you are replying to a message sent by you, Mutt will
assume that you want to reply to the recipients of that message rather
than to yourself.
-Also see the âalternatesâ command.
- Type:Â quadoption Type:Â quadoption
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,
@@ -2088,14 +2113,14 @@ 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
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
-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:
@@ -2108,28 +2133,28 @@ and then you receive mail which contains the following header:
-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
+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 Type:Â boolean
It may sometimes arrive that you receive mail to a certain machine,
move the messages to another machine, and reply to some the messages
from there. If this variable is set, the default From: line of
the reply messages is built using the address where you received the
messages you are replying to if that address matches your
-âalternatesâ. If the variable is unset, or the address that would be
-used doesn't match your âalternatesâ, the From: line will use
+âalternatesâ. If the variable is unset, or the address that would be
+used doesn't match your âalternatesâ, the From: line will use
your address on the current machine.
-Also see the âalternatesâ command.
- Type:Â boolean Type:Â boolean
-This variable fine-tunes the behaviour of the $reverse_name feature.
+This variable fine-tunes the behavior of the $reverse_name feature.
When it is set, mutt will use the address from incoming messages as-is,
possibly including eventual real names. When it is unset, mutt will
-override any such real names with the setting of the $realname variable.
- Type:Â boolean Type:Â boolean
When this variable is set, Mutt will decode RFC2047-encoded MIME
parameters. You want to set this variable when mutt suggests you
@@ -2148,24 +2173,24 @@ wild.
Also note that setting this parameter will not have the effect
that mutt generates this kind of encoding. Instead, mutt will
unconditionally use the encoding specified in RFC2231.
- Type:Â boolean 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
+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 Type:Â boolean
When unset, mailboxes which contain no saved messages will be removed
-when closed (the exception is $spoolfile which is never removed).
+when closed (the exception is $spoolfile which is never removed).
If set, mailboxes are never removed.
Note: This only applies to mbox and MMDF folders, Mutt does not
delete MH and Maildir directories.
- Type:Â number Type:Â number
This variable controls the size of the history (per category) saved in the
$history_file file.
- Type:Â boolean Type:Â boolean
This variable controls how copies of outgoing messages are saved.
When set, a check is made to see if a mailbox specified by the
@@ -2173,54 +2198,54 @@ recipient address exists (this is done by searching for a mailbox in
the $folder directory with the username part of the
recipient address). If the mailbox exists, the outgoing message will
be saved to that mailbox, otherwise the message is saved to the
-$record mailbox.
+$record mailbox.
Also see the $force_name variable.
- Type:Â boolean Type:Â boolean
When this variable is unset, scoring is turned off. This can
be useful to selectively disable scoring for certain folders when the
-$score_threshold_delete variable and related are used.
- Type:Â number Type:Â number
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
Messages which have been assigned a score greater than or equal to this
variable's value are automatically marked "flagged".
- Type:Â number Type:Â number
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:Â number Type:Â number
For the pager, this variable specifies the number of lines shown
before search results. By default, search results will be top-aligned.
- Type:Â string
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
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
-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:
@@ -2232,70 +2257,70 @@ Mutt interprets the value of this variable as follows:
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 Type:Â path
Command to use when spawning a subshell. By default, the user's login
shell from Type:Â boolean Type:Â boolean
-If set, a line containing â-- â (note the trailing space) will be inserted before your
-$signature. It is strongly recommended that you not unset
+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
+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
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
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 standard output.
- Type:Â string
Specifies how Mutt should expand a simple search into a real search
-pattern. A simple search is one that does not contain any of the âËâ pattern
-operators. See âpatternsâ for more information on search patterns.
+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
+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:Â number Type:Â number
Specifies time, in seconds, to pause while displaying certain informational
messages, while moving from folder to folder and after expunging
messages from the current folder. The default is to pause one second, so
a value of zero for this option suppresses the pause.
- Type:Â boolean Type:Â boolean
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
+$markers variable.
+ Type: regular expression
The pager uses this variable to catch some common false
-positives of $quote_regexp, most notably smileys and not consider
-a line quoted text if it also matches $smileys. This mostly
+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:Â boolean Type:Â boolean
This flag controls whether you want to be asked to enter a label
for a certificate about to be added to the database or not. It is
set by default.
(S/MIME only)
- Type:Â path Type:Â path
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 Type:Â path
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
@@ -2305,7 +2330,7 @@ OpenSSL. There is an index file which contains mailbox-address
keyid pairs, and which can be manually edited. This option points to
the location of the certificates.
(S/MIME only)
- Type:Â string Type:Â string
This format string specifies a command which is used to decrypt
For examples on how to configure these formats, see the Type:Â boolean Type:Â boolean
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 Type:Â string
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:Â string Type:Â string
This command is used to create encrypted S/MIME messages.
-This is a format string, see the $smime_decrypt_command command for
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â string Type:Â string
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:Â string Type:Â string
This command is used to extract X509 certificates from a PKCS7 structure.
-This is a format string, see the $smime_decrypt_command command for
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â string Type:Â string
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
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â string Type:Â string
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
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â string Type:Â string
This command is used to import a certificate via smime_keys.
-This is a format string, see the $smime_decrypt_command command for
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â boolean Type:Â boolean
-The default behaviour of mutt is to use PGP on all auto-sign/encryption
+The default behavior of mutt is to use PGP on all auto-sign/encryption
operations. To override and to use OpenSSL instead this must be set.
However, this has no effect while replying, since mutt will automatically
select the same application that was used to sign/encrypt the original
message. (Note that this variable can be overridden by unsetting $crypt_autosmime.)
(S/MIME only)
- Type:Â path Type:Â path
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,
@@ -2400,58 +2425,58 @@ named as the hash-value retrieved from OpenSSL. There is an index file
which contains mailbox-address keyid pair, and which can be manually
edited. This option points to the location of the private keys.
(S/MIME only)
- Type:Â string Type:Â string
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
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â string Type:Â string
This command is used to created S/MIME signatures of type
-This is a format string, see the $smime_decrypt_command command for
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â string Type:Â string
This command is used to created S/MIME signatures of type
-This is a format string, see the $smime_decrypt_command command for
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â number Type:Â number
The number of seconds after which a cached passphrase will expire if
not used.
(S/MIME only)
- Type:Â string Type:Â string
This command is used to verify S/MIME signatures of type
-This is a format string, see the $smime_decrypt_command command for
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â string Type:Â string
This command is used to verify S/MIME signatures of type
-This is a format string, see the $smime_decrypt_command command for
+This is a format string, see the $smime_decrypt_command command for
possible Type:Â string Type:Â string
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 option is case-insensitive. If it is âunsetâ
+try them. Authentication methods are any SASL mechanism, e.g.
+â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.
@@ -2459,109 +2484,109 @@ Example:
Type:Â string Type:Â string
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 Type:Â string
Defines the SMTP smarthost where sent messages should relayed for
-delivery. This should take the form of an SMTP URL, eg:
+delivery. This should take the form of an SMTP URL, e.g.:
-where â[...]â denotes an optional part.
-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
-Specifies how to sort messages in the âindexâ menu. Valid values
+Specifies how to sort messages in the âindexâ menu. Valid values
are:
- date or date-sent
- date-received
- from
- mailbox-order (unsorted)
- score
- size
- spam
- subject
- threads
- to
+ date or date-sent
+ date-received
+ from
+ mailbox-order (unsorted)
+ score
+ size
+ spam
+ subject
+ threads
+ to
-You may optionally use the âreverse-â prefix to specify reverse sorting
-order (example: â Type: sort order Type: sort order
-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
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,
+the rest of $sort_aux as an ordering. For instance,
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 â
-Note: For reversed $sort
-order $sort_aux is reversed again (which is not the right thing to do,
+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
Specifies how to sort entries in the file browser. By default, the
entries are sorted alphabetically. Valid values:
- alpha (alphabetically)
- date
- size
- unsorted
+ alpha (alphabetically)
+ date
+ size
+ unsorted
-You may optionally use the âreverse-â prefix to specify reverse sorting
-order (example: â Type:Â boolean Type:Â boolean
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
+non-$reply_regexp parts of both messages are identical.
+ Type:Â string
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 Type:Â path
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
initially set this variable to the value of the environment
variable Type:Â path Type:Â path
This variable specifies a file containing trusted CA certificates.
Any server certificate that is signed with one of these CA
@@ -2571,71 +2596,71 @@ Example:
Type:Â path Type:Â path
The file containing a client certificate and its associated private
key.
- Type:Â boolean Type:Â boolean
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:Â number Type:Â number
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:Â quadoption Type:Â quadoption
If set (the default), mutt will attempt to use Type:Â boolean Type:Â boolean
This variable specifies whether to attempt to use SSLv2 in the
SSL authentication process.
- Type:Â boolean Type:Â boolean
This variable specifies whether to attempt to use SSLv3 in the
SSL authentication process.
- Type:Â boolean Type:Â boolean
This variable specifies whether to attempt to use TLSv1 in the
SSL authentication process.
- Type:Â boolean Type:Â boolean
If set to yes, mutt will use CA certificates in the
system-wide certificate store when checking if a server certificate
is signed by a trusted CA.
- Type:Â boolean Type:Â boolean
If set (the default), mutt will not automatically accept a server
certificate that is either not yet valid or already expired. You should
only unset this for particular known hosts, using the
Type:Â boolean Type:Â boolean
If set (the default), mutt will not automatically accept a server
certificate whose host name does not match the host used in your folder
URL. You should only unset this for particular known hosts, using
the Type:Â string
-Controls the characters used by the â%râ indicator in
-$status_format. The first character is used when the mailbox is
+ Type:Â string
+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 Type:Â string
-Controls the format of the status line displayed in the âindexâ
+ Type:Â string
+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
-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
@@ -2696,46 +2721,46 @@ If the value of sequence_char is non-zero
be expanded, otherwise else_string will be expanded.
You can force the result of any
-If you prefix the sequence character with a colon (â:â) character, mutt
+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
-Setting this variable causes the âstatus barâ to be displayed on
+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 Type:Â boolean
-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 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
When unset, mutt won't stop when the user presses the terminal's
-susp key, usually â^Zâ. This is useful if you run mutt
-inside an xterm using a command like â Type:Â boolean Type:Â boolean
-When set, mutt will generate âformat=flowedâ bodies with a content type
-of â
Note that $indent_string is ignored when this option is set.
- Type:Â boolean
-Affects the Type:Â boolean
+Affects the
@@ -2744,26 +2769,26 @@ 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 Type:Â boolean
When set, mutt uses the date received rather than the date sent
to thread messages by subject.
- Type:Â boolean Type:Â boolean
When set, the internal-pager will pad blank lines to the bottom of the
-screen with a tilde (âËâ).
- Type:Â number Type:Â number
-Along with $read_inc, $write_inc, and $net_inc, this
+Along with $read_inc, $write_inc, and $net_inc, this
variable controls the frequency with which progress updates are
-displayed. It suppresses updates less than $time_inc milliseconds
+displayed. It suppresses updates less than $time_inc milliseconds
apart. This can improve throughput on systems with slow terminals,
or when running mutt on a remote system.
-Also see the âtuningâ section of the manual for performance considerations.
- Type:Â number Type:Â number
-When Mutt is waiting for user input either idleing in menus or
+When Mutt is waiting for user input either idling in menus or
in an interactive prompt, Mutt would block until input is
present. Depending on the context, this would prevent certain
operations from working, like checking for new mail or keeping
@@ -2774,25 +2799,25 @@ 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 Type:Â path
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 Type:Â string
+used. If Type:Â string
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. 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
+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
+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.
- Type:Â string Type:Â string
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
@@ -2805,116 +2830,126 @@ Note: For this example to work you must be able to log in to the remote
machine without having to enter a password.
When set, Mutt uses the tunnel for all remote connections.
-Please see âaccount-hookâ in the manual for how to use different
+Please see âaccount-hookâ in the manual for how to use different
tunnel commands per connection.
- Type:Â boolean Type:Â boolean
When set, Mutt will jump to the next unread message, if any,
when the current thread is uncollapsed.
- Type:Â boolean Type:Â boolean
Warning: do not set this variable unless you are using a version
of sendmail which supports the
-When set, Mutt will invoke $sendmail with the Type:Â boolean Type:Â boolean
When set, Mutt will qualify all local addresses (ones without the
-â@hostâ portion) with the value of $hostname. If unset, no
+â@hostâ portion) with the value of $hostname. If unset, no
addresses will be qualified.
- Type:Â boolean Type:Â boolean
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 unset, mutt will attempt to derive the sender from the
-âFrom:â header.
+âFrom:â header.
Note that this information is passed to sendmail command using the
Type:Â boolean Type:Â boolean
-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â
+When set, Mutt will generate the âFrom:â header field when
+sending messages. If unset, no âFrom:â header field will be
+generated unless the user explicitly sets one using the âmy_hdrâ
command.
-
+
Default:Â yes
+
Default:Â yes
+
Default:Â 30
+Default:Â âtext/plain
â
+
Default:Â yes
+will be saved for later references. Also see $record,
+$save_name, $force_name and âfcc-hookâ.
+
Default:Â no
+
Default:Â yes
+$crypt_autosign, $crypt_replysign and $smime_is_default.
+
Default:Â no
+
Default:Â yes
+$crypt_autosign, $crypt_replysign and $smime_is_default.
+
Default:Â yes
+
Default:Â no
+
Default:Â no
+
Default:Â yes
+
Default:Â no
+
Default:Â no
+
Default:Â yes
-Default: â!%a, %b %d, %Y at %I:%M:%S%p %Z
â
+Default: â!%a, %b %d, %Y at %I:%M:%S%p %Z
âstrftime(3)
function to process the date, see the man page for the proper syntax.
-Default: âËf %s !ËP | (ËP ËC %s)
â
+Default: â~f %s !~P | (~P ~C %s)
â
+
Default:Â ask-yes
+
Default:Â yes
+
Default:Â yes
+individual messages in a multipart/digest. To see these subparts, press âvâ on that menu.
+
Default:Â (empty)
+Default:Â â/usr/local/bin/mutt_dotlock
âmutt_dotlock(8)
binary to be used by
mutt.
-
+
Default:Â (empty)
set dsn_notify="failure,delay"
sendmail(1)
-compatible interface supporting the -N
option
-for DSN. For SMTP delivery, DSN support is autodetected so that it
+for DSN. For SMTP delivery, DSN support is auto-detected so that it
depends on the server whether DSN will be used or not.
-
+
Default:Â (empty)
set dsn_return=hdrs
sendmail(1)
-compatible interface supporting the -R
option
-for DSN. For SMTP delivery, DSN support is autodetected so that it
+for DSN. For SMTP delivery, DSN support is auto-detected so that it
depends on the server whether DSN will be used or not.
-
+
Default:Â yes
+
Default:Â no
+
Default:Â (empty)$VISUAL
, or $EDITOR
, environment
-variable, or to the string âviâ if neither of those are set.
-
+variable, or to the string âviâ if neither of those are set.
+
Default:Â no
+
Default:Â (empty)
+
Default:Â (empty)
-Default: âË
â
+This value is ignored if $use_envelope_from is unset.
+
+Default:Â â~
â
Default:Â no
+
Default:Â yes
+
Default:Â no
-Default: âË/Mail
â
+Default:Â â~/Mail
â
-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
âprintf(3)
-like sequences:
%C current file number
%d date/time folder was last modified
- %f filename (â/â is appended to directory names,
-â@â to symbolic links and â*â to executable
+ %D date/time folder was last modified using $date_format.
+ %f filename (â/â is appended to directory names,
+â@â to symbolic links and â*â to executable
files)
%F file permissions
%g group name (or numeric gid, if missing)
%l number of hard links
%N N if folder has new mail, blank otherwise
%s size in bytes
- %t â*â if the file is tagged, blank otherwise
+ %t â*â if the file is tagged, blank otherwise
%u owner name (or numeric uid, if missing)
- %>X right justify the rest of the string and pad with character âXâ
- %|X pad to the end of the line with character âXâ
- %*X soft-fill with character âXâ as pad
+ %>X right justify the rest of the string and pad with character âXâ
+ %|X pad to the end of the line with character âXâ
+ %*X soft-fill with character âXâ as pad
+For an explanation of âsoft-fillâ, see the $index_format documentation.
+
Default:Â yes
+
Default:Â no
+Also see the $record variable.
+
Default:Â yestext/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.
+
Default:Â yes
+
Default:Â yes
-Default:Â â[%a:Â %s]
â
+Default:Â â[%a:Â %s]
â
+
Default:Â no
+
Default:Â (empty)$EMAIL
.
-
+Default:Â â^[^,]*
â.*
â.
+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 â.*
â.
+âFranklinâ to âFranklin, Steveâ.
+
Default:Â yes
+
Default:Â no
+The $weed setting applies.
+
Default:Â (empty)
+MH or Maildir folders, see âcachingâ for details.
+
Default:Â yes
+Default:Â â16384
â
+
Default: yes 3.83. hidden_host
+ 3.83. hidden_host
Default:Â no
+
Default:Â no
+
Default:Â yes
+
Default:Â yes
+
Default:Â no
+
Default:Â yes
+
Default:Â 10
+Default:Â â~/.mutthistory
â
+
Default:Â no
+
Default:Â yes
+
Default:Â (empty)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â
+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.
+
Default:Â no
-Default:Â no<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
+âSubject:â field from being divided into multiple lines.
+
+Default:Â no<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
list.
-
+
Default:Â (empty)
+
Default:Â no
+Default:Â â/.
â
+helps in using the â=â shortcut for your folder variable.
+
Default:Â (empty)
+and not contain the colon, e.g. âX-BOGOSITY X-SPAM-STATUSâ for the
+âX-Bogosity:â and âX-Spam-Status:â header fields.
+
Default:Â no
+
Default:Â 900
+
Default:Â no<toggle-subscribed>
function.
-
+
Default:Â (empty)
+
Default:Â (empty)<imap-fetch-mail>
function
@@ -1200,20 +1213,20 @@ 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.
-
+
Default:Â yes
+
Default:Â yes
+
Default:Â 15
+
Default:Â yes
+
Default:Â (empty)
+
Default:Â nocopiousoutput
â 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.
-
+
Default:Â ask-yes
+
Default:Â no
+Default:Â â>Â
âprintf(3)
-style sequences.
-
-Default: â%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s
â
+Default: â%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s
âprintf(3)
to format output (see the man page for more details).
The following sequences are defined in Mutt:
@@ -1288,8 +1301,8 @@ The following sequences are defined in Mutt:
%i message-id of the current message
%l number of lines in the message (does not work with maildir,
mh, and possibly IMAP folders)
- %L If an address in the âTo:â or âCc:â header field matches an address
-defined by the users âsubscribeâ command, this displays
+ %L If an address in the âTo:â or âCc:â header field matches an address
+defined by the users âsubscribeâ command, this displays
"To <list-name>", otherwise the same as %F.
%m total number of message in the mailbox
%M number of hidden messages if the thread is collapsed.
@@ -1298,37 +1311,37 @@ defined by the users âNâ/âDâ/âdâ/â!â/ârâ/*)
- %t âTo:â field (recipients)
- %T the appropriate character from the $to_chars string
+ %S status of the message (âNâ/âDâ/âdâ/â!â/ârâ/*)
+ %t âTo:â field (recipients)
+ %T the appropriate character from the $to_chars string
%u user (login) name of the author
%v first name of the author, or the recipient if the message is from you
%X number of attachments
-(please see the âattachmentsâ section for possible speed effects)
- %y âX-Label:â field, if present
- %Y âX-Label:â field, if present, and (1) not at part of a thread tree,
-(2) at the top of a thread, or (3) âX-Label:â is different from
-preceding message's âX-Label:â.
+(please see the âattachmentsâ section for possible speed effects)
+ %y âX-Label:â field, if present
+ %Y âX-Label:â field, if present, and (1) not at part of a thread tree,
+(2) at the top of a thread, or (3) âX-Label:â is different from
+preceding message's âX-Label:â.
%Z message status flags
%{fmt} the date and time of the message is converted to sender's
-time zone, and âfmtâ is expanded by the library function
+time zone, and âfmtâ is expanded by the library function
strftime(3)
; a leading bang disables locales
%[fmt] the date and time of the message is converted to the local
-time zone, and âfmtâ is expanded by the library function
+time zone, and âfmtâ is expanded by the library function
strftime(3)
; a leading bang disables locales
%(fmt) the local date and time when the message was received.
-âfmtâ is expanded by the library function strftime(3)
;
+âfmtâ is expanded by the library function strftime(3)
;
a leading bang disables locales
-%<fmt> the current local time. âfmtâ is expanded by the library
+ %<fmt> the current local time. âfmtâ is expanded by the library
function strftime(3)
; a leading bang disables locales.
-%>X right justify the rest of the string and pad with character âXâ
- %|X pad to the end of the line with character âXâ
- %*X soft-fill with character âXâ as pad
+ %>X right justify the rest of the string and pad with character âXâ
+ %|X pad to the end of the line with character âXâ
+ %*X soft-fill with character âXâ as pad
-Default:Â âispell
â
+Default:Â âispell
â
+
Default:Â no
-Default:Â âC
â
+Default:Â âC
âstrftime(3)
to format dates. Legal values are
the strings your system accepts for the locale environment variable $LC_TIME
.
-
+
Default:Â 5
+new mail. Also see the $timeout variable.
+
+Default:Â yes
Default:Â (empty)
+
Default:Â yes
+
Default:Â yesstat(2)
per
message every time the folder is opened (which can be very slow for NFS
folders).
-
+
Default:Â no
+
Default:Â yes
+
Default:Â yes
-Default:Â â!^\.[^.]
â
+Default:Â â!^\.[^.]
â
-Default: âË/mbox
â
+Default:Â â~/mbox
â
+Also see the $move variable.
+
Default:Â mbox-m
command-line option.
-
+
Default:Â 0
+when scrolling through menus. (Similar to $pager_context.)
+
Default:Â yes
+
Default:Â no
+
Default:Â no
+
Default:Â (empty)
-Default:Â â%s
â
+Default:Â â%s
âmessage/rfc822
. For a full listing of defined
printf(3)
-like sequences see the section on $index_format.
-
+
Default:Â no0xf8
, then this is treated as if the user had
-pressed Esc then âxâ. This is because the result of removing the
+pressed Esc then âxâ. This is because the result of removing the
high bit from 0xf8
is 0x78
, which is the ASCII character
-âxâ.
-
+âxâ.
+
Default:Â no
+
Default:Â no
-Default:Â âflagged
â
+Default:Â âflagged
â
+Default:Â âreplied
â
+Default:Â âunseen
â
+
Default:Â nomessage/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.
+
Default:Â notext/plain
when
-forwarding a message while $mime_forward is set. Otherwise
+forwarding a message while $mime_forward is set. Otherwise
$forward_decode is used instead.
-
+
Default:Â yes
+Default: â%4n %c %-16s %a
âprintf(3)
-like sequences are
supported:
@@ -1504,32 +1526,32 @@ supported:
%c Remailer capabilities.
%s The remailer's short name.
%a The remailer's e-mail address.
-
+Default:Â âmixmaster
â
+
Default:Â no
+from your spool mailbox to your $mbox mailbox, or as a result of
+a âmbox-hookâ command.
+
Default:Â no
+
Default:Â 10
+Default:Â âbuiltin
â
+
Default:Â 0
-Default: â-%Z- %C/%m: %-20.20n   %s%*  -- (%P)
â
+Default: â-%Z- %C/%m: %-20.20n   %s%*  -- (%P)
â
+
Default:Â 0
+
Default:Â no<next-page>
function.
-
+
Default:Â no<check-traditional-pgp>
function, mutt will automatically
check the message for traditional pgp.
-
+
Default:Â no
+
Default:Â yes
+
Default:Â (empty)printf(3)
-like sequences.
(PGP only)
-
+
Default:Â (empty)%f Expands to the name of a file containing a message.
%s Expands to the name of a file containing the signature part
of a multipart/signed
attachment when verifying it.
-%a The value of $pgp_sign_as.
+ %a The value of $pgp_sign_as.
%r One or more key IDs.
samples/
subdirectory which has been installed on your system
alongside the documentation.
(PGP only)
-
+
Default:Â (empty)printf(3)
-like sequences.
(PGP only)
-
+
Default:Â (empty)printf(3)
-like sequences.
(PGP only)
-
+
Default:Â (empty)printf(3)
-like sequences.
(PGP only)
-
+Default: â%4n %t%f %4l/0x%k %-4a %2c %u
âprintf(3)
-like sequences:
@@ -1669,42 +1691,42 @@ has its own set of printf(3)
-like sequences:
%[<s>] date of the key where <s> is an strftime(3)
expression
+
Default:Â (empty)printf(3)
-like sequences.
(PGP only)
-
+
Default:Â (empty)printf(3)
-like sequence used with this format.
(PGP only)
-
+
Default:Â (empty)
+
Default:Â yes
+
Default:Â (empty)printf(3)
-like sequences.
(PGP only)
-
+
Default:Â (empty)pgpring
utility which comes
with mutt.
printf(3)
-like sequences.
(PGP only)
-
+
Default:Â (empty)pgpring
utility which comes
with mutt.
printf(3)
-like sequences.
(PGP only)
-
+
Default:Â no
+
Default:Â ask-yes
+
Default:Â no
+
Default:Â nomultipart/signed
and multipart/encrypted
body parts.
@@ -1774,27 +1796,27 @@ This is useful for applications like encrypted and signed mailing
lists, where the outer layer (multipart/encrypted
) can be easily
removed, while the inner multipart/signed
part is retained.
(PGP only)
-
+
Default:Â yes
+
Default:Â (empty)0x00112233
).
(PGP only)
-
+
Default:Â (empty)multipart/signed
PGP/MIME body part.
printf(3)
-like sequences.
(PGP only)
-
+
Default:Â addresstrust sort by the trust of the key
+
Default:Â yes
+
Default:Â 300
+
Default:Â nogpg-agent(1)
process.
(PGP only)
-
+
Default:Â (empty)printf(3)
-like sequences.
(PGP only)
-
+
Default:Â (empty)printf(3)
-like sequences.
(PGP only)
-
+
Default:Â no<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.
-
+Default:Â â\n
â
+
Default:Â no<pipe-message>
function following
<tag-prefix>
. If this variable is unset, when piping a list of
tagged messages Mutt will concatenate the messages and will pipe them
all concatenated. When set, Mutt will pipe the messages one by one.
In both cases the messages are piped in the current sorted order,
-and the $pipe_sep separator is added after each message.
-
+and the $pipe_sep separator is added after each message.
+
Default:Â yes
+
Default:Â (empty)
set pop_authenticators="digest-md5:apop:user"
-
+
Default:Â 60
+
Default:Â ask-no<fetch-mail>
function. When unset, Mutt will
download messages but also leave them on the POP server.
-
+
Default:Â (empty)<fetch-mail>
function. You
-can also specify an alternative port, username and password, ie:
+can also specify an alternative port, username and password, i.e.:
[pop[s]://][username[:password]@]popserver[:port]
+where â[...]â denotes an optional part.
+
Default:Â noLAST
â 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.
-
+
Default:Â (empty)
+
Default:Â ask-yes
+
Default:Â (empty)
+
Default:Â (empty)
+
Default:Â ask-yes
-Default: âË/postponed
â
+Default:Â â~/postponed
â
+Also see the $postpone variable.
+
Default:Â (empty)
+
Default:Â ask-no
-Default:Â âlpr
â
+Default:Â âlpr
â
+
Default:Â yes<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
+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.
-
+
Default:Â no<print-message>
command. If this option
-is set, the command specified by $print_command is executed once for
+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
+the command specified by $print_command is executed only once, and
all the messages are concatenated, with a form feed as the message
separator.
enscript
(1) program's mail-printing mode will
most likely want to set this option.
-
+
Default:Â yes
-Default:Â (empty)
-Default: â%4c %t %-25.25a %-25.25n %?e?(%e)?
â
+Default:Â (empty)
+Default: â%4c %t %-25.25a %-25.25n %?e?(%e)?
âprintf(3)
-style sequences are understood:
%a destination address
%c current entry number
%e extra information *
%n destination name
- %t â*â if current entry is tagged, a space otherwise
- %>X right justify the rest of the string and pad with âXâ
- %|X pad to the end of the line with âXâ
- %*X soft-fill with character âXâ as pad
+ %t â*â if current entry is tagged, a space otherwise
+ %>X right justify the rest of the string and pad with âXâ
+ %|X pad to the end of the line with âXâ
+ %*X soft-fill with character âXâ as pad
+* = can be optionally printed if nonzero, see the $status_format documentation.
+
Default:Â yes
+Default:Â â^([Â \t]*[|>:}#])+
â<toggle-quoted>
command, or colored according to the
-âcolor quotedâ family of directives.
+âcolor quotedâ family of directives.
+Match detection may be overridden by the $smileys regular expression.
+
Default:Â 10
+Also see the $write_inc, $net_inc and $time_inc variables and the
+âtuningâ section of the manual for performance considerations.
+
+
Default:Â (empty)/etc/passwd
. Note that this
variable will not be used when the user has set a real name
in the $from variable.
-
+
Default:Â ask-yes
+Default:Â â~/sent
â 3.212. reply_regexp
-Default:Â â^(re([\[0-9\]+])*|aw):[Â \t]*
â 3.213. reply_regexp
+Default:Â â^(re([\[0-9\]+])*|aw):[Â \t]*
â 3.213. reply_self
+ 3.214. reply_self
Default: no 3.214. reply_to
+Also see the âalternatesâ command.
+ 3.215. reply_to
Default:Â ask-yes
+
Default:Â yes
+
Default:Â no
From: abd30425@somewhere.net
+
Default:Â no
+Also see the âalternatesâ command.
+
Default:Â yes
+override any such real names with the setting of the $realname variable.
+
Default:Â no
+
Default:Â no
+
Default:Â yes
+
Default:Â 0
+
Default:Â no
+
Default:Â yes
+$score_threshold_delete variable and related are used.
+
Default:Â -1
+
Default:Â 9999
+
Default:Â -1
+
Default:Â 0
+Default:Â âus-ascii:iso-8859-1:utf-8
â
+Default: â/usr/sbin/sendmail -oem -oi
â
+
Default:Â 0
+
Default:Â (empty)/etc/passwd
is used.
-
+
Default:Â yes
+the signature in a different color in the built-in pager.
+
Default:Â no
+Default:Â â~/.signature
â
+Default: â~f %s | ~s %s
â
+replacing â%sâ with the supplied string.
+For the default value, âjoeâ would be expanded to: â~f joe | ~s joeâ.
+
Default:Â 1
+
Default:Â yes
-Default: â(>From )|(:[-^]?[][)(><}{|/DP])
â
+Default: â(>From )|(:[-^]?[][)(><}{|/DP])
â
+
Default:Â yes
+
Default:Â (empty)
+
Default:Â (empty)
+
Default:Â (empty)application/x-pkcs7-mime
attachments.
@@ -2316,82 +2341,82 @@ similar to PGP's:
%f Expands to the name of a file containing a message.
%s Expands to the name of a file containing the signature part
of a multipart/signed
attachment when verifying it.
-%k The key-pair specified with $smime_default_key
+ %k The key-pair specified with $smime_default_key
%c One or more certificate IDs.
%a The algorithm used for encryption.
- %C CA location: Depending on whether $smime_ca_location
+ %C CA location: Depending on whether $smime_ca_location
points to a directory or file, this expands to
- â-CApath $smime_ca_locationâ or â-CAfile $smime_ca_locationâ.
+ â-CApath $smime_ca_locationâ or â-CAfile $smime_ca_locationâ.
smime.rc
in
the samples/
subdirectory which has been installed on your system
alongside the documentation.
(S/MIME only)
-
+
Default:Â yes
+
Default:Â (empty)
+
Default:Â (empty)printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â (empty)
+
Default:Â (empty)printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â (empty)printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â (empty)printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â (empty)printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â no
+
Default:Â (empty)
+
Default:Â (empty)printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â (empty)multipart/signed
, which can be read by all mail clients.
printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â (empty)application/x-pkcs7-signature
, which can only be handled by mail
clients supporting the S/MIME extension.
printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â 300
+
Default:Â (empty)multipart/signed
.
printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â (empty)application/x-pkcs7-mime
.
printf(3)
-like sequences.
(S/MIME only)
-
+
Default:Â (empty)
set smtp_authenticators="digest-md5:cram-md5"
-
+
Default:Â (empty)
+
Default:Â (empty)
-smtp[s]://[user[:pass]@]host[:port]/
+smtp[s]://[user[:pass]@]host[:port]
+
Default:Â dateset sort=reverse-date-sent
â).
-
+You may optionally use the âreverse-â prefix to specify reverse sorting
+order (example: âset sort=reverse-date-sent
â).
+
Default:Â alias
+
Default:Â date
set sort_aux=last-date-received
set sort=reverse-threads
â.)
+you have âset sort=reverse-threads
â.)
+
Default:Â alphaset sort_browser=reverse-date
â).
-
+You may optionally use the âreverse-â prefix to specify reverse sorting
+order (example: âset sort_browser=reverse-date
â).
+
Default:Â yes
-Default:Â â,
â
+Default:Â â,
â
+
Default:Â (empty)$MAIL
or $MAILDIR
if either is defined.
-
+
Default:Â (empty)
set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
-
+
Default:Â (empty)
+
Default:Â no
+option supersedes $ssl_starttls.
+
Default:Â 0
+
Default:Â yesSTARTTLS
on servers
advertising the capability. When unset, mutt will not attempt to
use STARTTLS
regardless of the server's capabilities.
-
+
Default:Â no
+
Default:Â yes
+
Default:Â yes
+
Default:Â yes
+
Default:Â yes<account-hook>
function.
-
+
Default:Â yes<account-hook>
function.
-
-Default:Â â-*%A
â
+Default:Â â-*%A
â<toggle-write>
operation, bound by default to â%â). The fourth
+with the <toggle-write>
operation, bound by default to â%â). The fourth
is used to indicate that the current folder has been opened in attach-
message mode (Certain operations like composing a new mail, replying,
forwarding, etc. are not permitted in this mode).
-
-Default: â-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---
â
+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)---
âprintf(3)
-like sequences:
@@ -2654,18 +2679,18 @@ set of printf(3)
-like sequences:
%p number of postponed messages *
%P percentage of the way through the index
%r modified/read-only/won't-write/attach-message indicator,
-according to $status_chars
- %s current sorting mode ($sort)
- %S current aux sorting method ($sort_aux)
+according to $status_chars
+ %s current sorting mode ($sort)
+ %S current aux sorting method ($sort_aux)
%t number of tagged messages *
%u number of unread messages *
%v Mutt version string
%V currently active limit pattern, if any *
- %>X right justify the rest of the string and pad with âXâ
- %|X pad to the end of the line with âXâ
- %*X soft-fill with character âXâ as pad
+ %>X right justify the rest of the string and pad with âXâ
+ %|X pad to the end of the line with âXâ
+ %*X soft-fill with character âXâ as pad
printf(3)
-like sequence to be lowercase
-by prefixing the sequence character with an underscore (â_â) sign.
+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
â.
+
Default:Â no
+
Default:Â no
+the subjects like âhiâ which will get grouped together. See also
+$sort_re for a less drastic way of controlling this
+behavior.
+
Default:Â yesxterm -e mutt
â.
-
+susp key, usually â^Zâ. This is useful if you run mutt
+inside an xterm using a command like âxterm -e mutt
â.
+
Default:Â notext/plain; format=flowed
â.
+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
features, you'll need support in your editor.
-Default:Â noËb
and Ëh
search operations described in
-section âpatternsâ. If set, the headers and body/attachments of
+
+Default:Â yes~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.
+
Default:Â no
+
Default:Â no
+screen with a tilde (â~â).
+
Default:Â 0
+Also see the âtuningâ section of the manual for performance considerations.
+
Default:Â 600
+
Default:Â (empty)$TMPDIR
is
-used. If $TMPDIR
is not set then â/tmp
â is used.
-
-Default: â +TCFL
â$TMPDIR
is not set then â/tmp
â is used.
+
+Default: â +TCFL
â
+
Default:Â (empty)
+
Default:Â no
+
Default:Â no-B8BITMIME
flag (such as sendmail
8.8.x) or you may not be able to send mail.
-B8BITMIME
+When set, Mutt will invoke $sendmail with the -B8BITMIME
flag when sending 8-bit messages to enable ESMTP negotiation.
-
+
Default:Â yes
+
Default:Â no-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.
-
+if the $sendmail variable already contains -f
or if the
+executable pointed to by $sendmail doesn't support the -f
switch.
+
Default:Â yes