<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.21">
<TITLE>The Mutt E-Mail Client: Reference</TITLE>
<LINK HREF="manual-7.html" REL=next>
<LINK HREF="manual-5.html" REL=previous>
<LINK HREF="manual.html#toc6" REL=contents>
</HEAD>
<BODY>
<A HREF="manual-7.html">Next</A>
<A HREF="manual-5.html">Previous</A>
<A HREF="manual.html#toc6">Contents</A>
<HR>
<H2><A NAME="s6">6.</A> <A HREF="manual.html#toc6">Reference</A></H2>
<H2><A NAME="commandline"></A> <A NAME="ss6.1">6.1</A> <A HREF="manual.html#toc6.1">Command line options</A>
</H2>
<P>Running <CODE>mutt</CODE> 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.</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
-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
-e specify a config command to be run after initilization 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
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>To read messages in a mailbox</P>
<P><CODE>mutt</CODE> [ -nz ] [ -F <EM>muttrc</EM> ] [ -m <EM>type</EM> ] [ -f <EM>mailbox</EM> ] </P>
<P>To compose a new message</P>
<P><CODE>mutt</CODE> [ -n ] [ -F <EM>muttrc</EM> ] [ -a <EM>file</EM> ] [ -c <EM>address</EM> ] [ -i <EM>filename</EM> ] [ -s <EM>subject</EM> ] <EM>address</EM> [ <EM>address</EM> ... ] </P>
<P>Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect
input from the file you wish to send. For example,</P>
<P><CODE>mutt -s "data set for run #2" professor@bigschool.edu
< ~/run2.dat</CODE></P>
<P>This command will send a message to ``professor@bigschool.edu'' with a subject
of ``data set for run #2''. In the body of the message will be the contents
of the file ``~/run2.dat''.</P>
<H2><A NAME="commands"></A> <A NAME="ss6.2">6.2</A> <A HREF="manual.html#toc6.2">Configuration Commands</A>
</H2>
<P>The following are the commands understood by mutt.</P>
<P>
<UL>
<LI><CODE>
<A HREF="manual-4.html#account-hook">account-hook</A></CODE> <EM>pattern</EM> <EM>command</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#alias">alias</A></CODE> <EM>key</EM> <EM>address</EM> [ , <EM>address</EM>, ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#alias">unalias</A></CODE> [ * | <EM>key</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#alternates">alternates</A></CODE> <EM>regexp</EM> [ <EM>regexp</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#alternates">unalternates</A></CODE> [ * | <EM>regexp</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-5.html#alternative_order">alternative_order</A></CODE> <EM>mimetype</EM> [ <EM>mimetype</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-5.html#alternative_order">unalternative_order</A></CODE> <EM>mimetype</EM> [ <EM>mimetype</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-4.html#append-hook">append-hook</A></CODE> <EM>regexp</EM> "<EM>command</EM>"</LI>
<LI><CODE>
<A HREF="manual-5.html#auto_view">auto_view</A></CODE> <EM>mimetype</EM> [ <EM>mimetype</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-5.html#auto_view">unauto_view</A></CODE> <EM>mimetype</EM> [ <EM>mimetype</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#bind">bind</A></CODE> <EM>map</EM> <EM>key</EM> <EM>function</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#charset-hook">charset-hook</A></CODE> <EM>alias</EM> <EM>charset</EM></LI>
<LI><CODE>
<A HREF="manual-4.html#close-hook">close-hook</A></CODE> <EM>regexp</EM> "<EM>command</EM>"</LI>
<LI><CODE>
<A HREF="manual-3.html#color">color</A></CODE> <EM>object</EM> <EM>foreground</EM> <EM>background</EM> [ <EM>regexp</EM> ]</LI>
<LI><CODE>
<A HREF="manual-3.html#color">uncolor</A></CODE> <EM>index</EM> <EM>pattern</EM> [ <EM>pattern</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#exec">exec</A></CODE> <EM>function</EM> [ <EM>function</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#fcc-hook">fcc-hook</A></CODE> <EM>pattern</EM> <EM>mailbox</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#fcc-save-hook">fcc-save-hook</A></CODE> <EM>pattern</EM> <EM>mailbox</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#folder-hook">folder-hook</A></CODE> <EM>pattern</EM> <EM>command</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#hdr_order">hdr_order</A></CODE> <EM>header</EM> [ <EM>header</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#hdr_order">unhdr_order</A></CODE> <EM>header</EM> [ <EM>header</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#charset-hook">iconv-hook</A></CODE> <EM>charset</EM> <EM>local-charset</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#ignore">ignore</A></CODE> <EM>pattern</EM> [ <EM>pattern</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#ignore">unignore</A></CODE> <EM>pattern</EM> [ <EM>pattern</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#lists">lists</A></CODE> <EM>regexp</EM> [ <EM>regexp</EM> ... ] </LI>
<LI><CODE>
<A HREF="manual-3.html#lists">unlists</A></CODE> <EM>regexp</EM> [ <EM>regexp</EM> ... ] </LI>
<LI><CODE>
<A HREF="manual-3.html#macro">macro</A></CODE> <EM>menu</EM> <EM>key</EM> <EM>sequence</EM> [ <EM>description</EM> ] </LI>
<LI><CODE>
<A HREF="manual-3.html#mailboxes">mailboxes</A></CODE> <EM>filename</EM> [ <EM>filename</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#mbox-hook">mbox-hook</A></CODE> <EM>pattern</EM> <EM>mailbox</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#message-hook">message-hook</A></CODE> <EM>pattern</EM> <EM>command</EM></LI>
<LI><CODE>
<A HREF="manual-5.html#mime_lookup">mime_lookup</A></CODE> <EM>mimetype</EM> [ <EM>mimetype</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-5.html#mime_lookup">unmime_lookup</A></CODE> <EM>mimetype</EM> [ <EM>mimetype</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#color">mono</A></CODE> <EM>object attribute</EM> [ <EM>regexp</EM> ]</LI>
<LI><CODE>
<A HREF="manual-3.html#color">unmono</A></CODE> <EM>index</EM> <EM>pattern</EM> [ <EM>pattern</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#my_hdr">my_hdr</A></CODE> <EM>string</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#my_hdr">unmy_hdr</A></CODE> <EM>field</EM> [ <EM>field</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-4.html#open-hook">open-hook</A></CODE> <EM>regexp</EM> "<EM>command</EM>"</LI>
<LI><CODE>
<A HREF="manual-3.html#crypt-hook">crypt-hook</A></CODE> <EM>pattern</EM> <EM>key-id</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#push">push</A></CODE> <EM>string</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#set">reset</A></CODE> <EM>variable</EM> [<EM>variable</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#save-hook">save-hook</A></CODE> <EM>regexp</EM> <EM>filename</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#score-command">score</A></CODE> <EM>pattern</EM> <EM>value</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#score-command">unscore</A></CODE> <EM>pattern</EM> [ <EM>pattern</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#send-hook">send-hook</A></CODE> <EM>regexp</EM> <EM>command</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#reply-hook">reply-hook</A></CODE> <EM>regexp</EM> <EM>command</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#set">set</A></CODE> [no|inv]<EM>variable</EM>[=<EM>value</EM>] [ <EM>variable</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#set">unset</A></CODE> <EM>variable</EM> [<EM>variable</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#source">source</A></CODE> <EM>filename</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#spam">spam</A></CODE> <EM>pattern</EM> <EM>format</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#spam">nospam</A></CODE> <EM>pattern</EM></LI>
<LI><CODE>
<A HREF="manual-3.html#lists">subscribe</A></CODE> <EM>regexp</EM> [ <EM>regexp</EM> ... ] </LI>
<LI><CODE>
<A HREF="manual-3.html#lists">unsubscribe</A></CODE> <EM>regexp</EM> [ <EM>regexp</EM> ... ] </LI>
<LI><CODE>
<A HREF="manual-3.html#set">toggle</A></CODE> <EM>variable</EM> [<EM>variable</EM> ... ]</LI>
<LI><CODE>
<A HREF="manual-3.html#unhook">unhook</A></CODE> <EM>hook-type</EM></LI>
</UL>
</P>
<H2><A NAME="variables"></A> <A NAME="ss6.3">6.3</A> <A HREF="manual.html#toc6.3">Configuration variables</A>
</H2>
<H3><A NAME="abort_nosubject"></A> abort_nosubject</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>If set to <EM>yes</EM>, when composing messages and no subject is given
at the subject prompt, composition will be aborted. If set to
<EM>no</EM>, composing messages with no subject given at the subject
prompt will never be aborted.</P>
<H3><A NAME="abort_unmodified"></A> abort_unmodified</H3>
<P>Type: quadoption<BR>
Default: yes</P>
<P>If set to <EM>yes</EM>, composition will automatically abort after
editing the message body if no changes are made to the file (this
check only happens after the <EM>first</EM> edit of the file). When set
to <EM>no</EM>, composition will never be aborted.</P>
<H3><A NAME="alias_file"></A> alias_file</H3>
<P>Type: path<BR>
Default: "~/.muttrc"</P>
<P>The default file in which to save aliases created by the
``
<A HREF="manual-2.html#create-alias">create-alias</A>'' function.</P>
<P><B>Note:</B> Mutt will not automatically source this file; you must
explicitly use the ``
<A HREF="manual-3.html#source">source</A>'' command for it to be executed.</P>
<H3><A NAME="alias_format"></A> alias_format</H3>
<P>Type: string<BR>
Default: "%4n %2f %t %-10a %r"</P>
<P>Specifies the format of the data displayed for the `alias' menu. The
following printf(3)-style sequences are available:</P>
<P>
<DL>
<DT><B>%a </B><DD><P>alias name</P>
<DT><B>%f </B><DD><P>flags - currently, a "d" for an alias marked for deletion</P>
<DT><B>%n </B><DD><P>index number</P>
<DT><B>%r </B><DD><P>address which alias expands to</P>
<DT><B>%t </B><DD><P>character which indicates if the alias is tagged for inclusion</P>
</DL>
</P>
<H3><A NAME="allow_8bit"></A> allow_8bit</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Controls whether 8-bit data is converted to 7-bit using either Quoted-
Printable or Base64 encoding when sending mail.</P>
<H3><A NAME="allow_ansi"></A> allow_ansi</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Controls whether ANSI color codes in messages (and color tags in
rich text messages) are to be interpreted.
Messages containing these codes are rare, but if this option is set,
their text will be colored accordingly. Note that this may override
your color choices, and even present a security problem, since a
message could include a line like "[-- PGP output follows ..." and
give it the same color as your attachment color.</P>
<H3><A NAME="arrow_cursor"></A> arrow_cursor</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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.</P>
<H3><A NAME="ascii_chars"></A> ascii_chars</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, Mutt will use plain ASCII characters when displaying thread
and attachment trees, instead of the default <EM>ACS</EM> characters.</P>
<H3><A NAME="askbcc"></A> askbcc</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
before editing an outgoing message.</P>
<H3><A NAME="askcc"></A> askcc</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, Mutt will prompt you for carbon-copy (Cc) recipients before
editing the body of an outgoing message.</P>
<H3><A NAME="ask_follow_up"></A> ask_follow_up</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, Mutt will prompt you for follow-up groups before editing
the body of an outgoing message.</P>
<H3><A NAME="ask_x_comment_to"></A> ask_x_comment_to</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, Mutt will prompt you for x-comment-to field before editing
the body of an outgoing message.</P>
<H3><A NAME="attach_format"></A> attach_format</H3>
<P>Type: string<BR>
Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "</P>
<P>This variable describes the format of the `attachment' menu. The
following printf-style sequences are understood:</P>
<P>
<DL>
<DT><B>%C </B><DD><P>charset</P>
<DT><B>%c </B><DD><P>requires charset conversion (n or c)</P>
<DT><B>%D </B><DD><P>deleted flag</P>
<DT><B>%d </B><DD><P>description</P>
<DT><B>%e </B><DD><P>MIME content-transfer-encoding</P>
<DT><B>%f </B><DD><P>filename</P>
<DT><B>%I </B><DD><P>disposition (I=inline, A=attachment)</P>
<DT><B>%m </B><DD><P>major MIME type</P>
<DT><B>%M </B><DD><P>MIME subtype</P>
<DT><B>%n </B><DD><P>attachment number</P>
<DT><B>%s </B><DD><P>size</P>
<DT><B>%t </B><DD><P>tagged flag</P>
<DT><B>%T </B><DD><P>graphic tree characters</P>
<DT><B>%u </B><DD><P>unlink (=to delete) flag</P>
<DT><B>%>X </B><DD><P>right justify the rest of the string and pad with character "X"</P>
<DT><B>%|X </B><DD><P>pad to the end of the line with character "X"</P>
</DL>
</P>
<H3><A NAME="attach_sep"></A> attach_sep</H3>
<P>Type: string<BR>
Default: "\n"</P>
<P>The separator to add between attachments when operating (saving,
printing, piping, etc) on a list of tagged attachments.</P>
<H3><A NAME="attach_split"></A> attach_split</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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
``
<A HREF="#attach_sep">$attach_sep</A>'' separator is added after each attachment. When set,
Mutt will operate on the attachments one by one.</P>
<H3><A NAME="attribution"></A> attribution</H3>
<P>Type: string<BR>
Default: "On %d, %n wrote:"</P>
<P>This is the string that will precede a message which has been included
in a reply. For a full listing of defined printf()-like sequences see
the section on ``
<A HREF="#index_format">$index_format</A>''.</P>
<H3><A NAME="autoedit"></A> autoedit</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set along with ``
<A HREF="#edit_headers">$edit_headers</A>'', Mutt will skip the initial
send-menu and allow you to immediately begin editing the body of your
message. The send-menu may still be accessed once you have finished
editing the body of your message.</P>
<P>Also see ``
<A HREF="#fast_reply">$fast_reply</A>''.</P>
<H3><A NAME="auto_tag"></A> auto_tag</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, functions in the <EM>index</EM> menu which affect a message
will be applied to all tagged messages (if there are any). When
unset, you must first use the tag-prefix function (default: ";") to
make the next function apply to all tagged messages.</P>
<H3><A NAME="beep"></A> beep</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When this variable is set, mutt will beep when an error occurs.</P>
<H3><A NAME="beep_new"></A> beep_new</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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
``
<A HREF="#beep">$beep</A>'' variable.</P>
<H3><A NAME="bounce"></A> bounce</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>Controls whether you will be asked to confirm bouncing messages.
If set to <EM>yes</EM> you don't get asked if you want to bounce a
message. Setting this variable to <EM>no</EM> is not generally useful,
and thus not recommended, because you are unable to bounce messages.</P>
<H3><A NAME="bounce_delivered"></A> bounce_delivered</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When this variable is set, mutt will include Delivered-To headers when
bouncing messages. Postfix users may wish to unset this variable.</P>
<H3><A NAME="catchup_newsgroup"></A> catchup_newsgroup</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>If this variable is <EM>set</EM>, Mutt will mark all articles in newsgroup
as read when you quit the newsgroup (catchup newsgroup).</P>
<H3><A NAME="charset"></A> charset</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Character set your terminal uses to display and enter textual data.</P>
<H3><A NAME="check_new"></A> check_new</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P><B>Note:</B> this option only affects <EM>maildir</EM> and <EM>MH</EM> style
mailboxes.</P>
<P>When <EM>set</EM>, Mutt will check for new mail delivered while the
mailbox is open. Especially with MH mailboxes, this operation can
take quite some time since it involves scanning the directory and
checking each file to see if it has already been looked at. If
<EM>check_new</EM> is <EM>unset</EM>, no check for new mail is performed
while the mailbox is open.</P>
<H3><A NAME="collapse_unread"></A> collapse_unread</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When <EM>unset</EM>, Mutt will not collapse a thread if it contains any
unread messages.</P>
<H3><A NAME="uncollapse_jump"></A> uncollapse_jump</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When <EM>set</EM>, Mutt will jump to the next unread message, if any,
when the current thread is <EM>un</EM>collapsed.</P>
<H3><A NAME="compose_format"></A> compose_format</H3>
<P>Type: string<BR>
Default: "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-"</P>
<P>Controls the format of the status line displayed in the <EM>Compose</EM>
menu. This string is similar to ``
<A HREF="#status_format">$status_format</A>'', but has its own
set of printf()-like sequences:</P>
<P>
<DL>
<DT><B>%a </B><DD><P>total number of attachments </P>
<DT><B>%h </B><DD><P>local hostname</P>
<DT><B>%l </B><DD><P>approximate size (in bytes) of the current message</P>
<DT><B>%v </B><DD><P>Mutt version string</P>
</DL>
</P>
<P>See the text describing the ``
<A HREF="#status_format">$status_format</A>'' option for more
information on how to set ``
<A HREF="#compose_format">$compose_format</A>''.</P>
<H3><A NAME="config_charset"></A> config_charset</H3>
<P>Type: string<BR>
Default: ""</P>
<P>When defined, Mutt will recode commands in rc files from this
encoding.</P>
<H3><A NAME="confirmappend"></A> confirmappend</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When set, Mutt will prompt for confirmation when appending messages to
an existing mailbox.</P>
<H3><A NAME="confirmcreate"></A> confirmcreate</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When set, Mutt will prompt for confirmation when saving messages to a
mailbox which does not yet exist before creating it.</P>
<H3><A NAME="connect_timeout"></A> connect_timeout</H3>
<P>Type: number<BR>
Default: 30</P>
<P>Causes Mutt to timeout a network connection (for IMAP or POP) after this
many seconds if the connection is not able to be established. A negative
value causes Mutt to wait indefinitely for the connection to succeed.</P>
<H3><A NAME="content_type"></A> content_type</H3>
<P>Type: string<BR>
Default: "text/plain"</P>
<P>Sets the default Content-Type for the body of newly composed messages.</P>
<H3><A NAME="copy"></A> copy</H3>
<P>Type: quadoption<BR>
Default: yes</P>
<P>This variable controls whether or not copies of your outgoing messages
will be saved for later references. Also see ``
<A HREF="#record">$record</A>'',
``
<A HREF="#save_name">$save_name</A>'', ``
<A HREF="#force_name">$force_name</A>'' and ``
<A HREF="manual-3.html#fcc-hook">fcc-hook</A>''.</P>
<H3><A NAME="crypt_use_gpgme"></A> crypt_use_gpgme</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>This variable controls the use the GPGME enabled crypto backends.
If it is set and Mutt was build with gpgme support, the gpgme code for
S/MIME and PGP will be used instead of the classic code. Note, that
you need to use this option in .muttrc as it won't have any effect when
used interactively.</P>
<H3><A NAME="crypt_autopgp"></A> crypt_autopgp</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variable controls whether or not mutt may automatically enable
PGP encryption/signing for messages. See also ``
<A HREF="#crypt_autoencrypt">$crypt_autoencrypt</A>'',
``
<A HREF="#crypt_replyencrypt">$crypt_replyencrypt</A>'',
``
<A HREF="#crypt_autosign">$crypt_autosign</A>'', ``
<A HREF="#crypt_replysign">$crypt_replysign</A>'' and ``
<A HREF="#smime_is_default">$smime_is_default</A>''.</P>
<H3><A NAME="crypt_autosmime"></A> crypt_autosmime</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variable controls whether or not mutt may automatically enable
S/MIME encryption/signing for messages. See also ``
<A HREF="#crypt_autoencrypt">$crypt_autoencrypt</A>'',
``
<A HREF="#crypt_replyencrypt">$crypt_replyencrypt</A>'',
``
<A HREF="#crypt_autosign">$crypt_autosign</A>'', ``
<A HREF="#crypt_replysign">$crypt_replysign</A>'' and ``
<A HREF="#smime_is_default">$smime_is_default</A>''.</P>
<H3><A NAME="date_format"></A> date_format</H3>
<P>Type: string<BR>
Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"</P>
<P>This variable controls the format of the date printed by the ``%d''
sequence in ``
<A HREF="#index_format">$index_format</A>''. This is passed to the <EM>strftime</EM>
call to process the date. See the man page for <EM>strftime(3)</EM> for
the proper syntax.</P>
<P>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 ``
<A HREF="#locale">$locale</A>''. 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 <EM>C</EM> locale (that is in US
English).</P>
<H3><A NAME="default_hook"></A> default_hook</H3>
<P>Type: string<BR>
Default: "~f %s !~P | (~P ~C %s)"</P>
<P>This variable controls how send-hooks, message-hooks, save-hooks,
and fcc-hooks will
be interpreted if they are specified with only a simple regexp,
instead of a matching pattern. The hooks are expanded when they are
declared, so a hook will be interpreted according to the value of this
variable at the time the hook is declared. The default value matches
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
regular expression.</P>
<H3><A NAME="delete"></A> delete</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>Controls whether or not messages are really deleted when closing or
synchronizing a mailbox. If set to <EM>yes</EM>, messages marked for
deleting will automatically be purged without prompting. If set to
<EM>no</EM>, messages marked for deletion will be kept in the mailbox.</P>
<H3><A NAME="delete_untag"></A> delete_untag</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If this option is <EM>set</EM>, 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.</P>
<H3><A NAME="digest_collapse"></A> digest_collapse</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If this option is <EM>set</EM>, 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.</P>
<H3><A NAME="display_filter"></A> display_filter</H3>
<P>Type: path<BR>
Default: ""</P>
<P>When set, specifies a command used to filter messages. When a message
is viewed it is passed as standard input to
<A HREF="#display_filter">$display_filter</A>, and the
filtered message is read from the standard output.</P>
<H3><A NAME="dotlock_program"></A> dotlock_program</H3>
<P>Type: path<BR>
Default: "/usr/bin/mutt_dotlock"</P>
<P>Contains the path of the mutt_dotlock (8) binary to be used by
mutt.</P>
<H3><A NAME="dsn_notify"></A> dsn_notify</H3>
<P>Type: string<BR>
Default: ""</P>
<P><B>Note:</B> you should not enable this unless you are using Sendmail
8.8.x or greater.</P>
<P>This variable sets the request for when notification is returned. The
string consists of a comma separated list (no spaces!) of one or more
of the following: <EM>never</EM>, to never request notification,
<EM>failure</EM>, to request notification on transmission failure,
<EM>delay</EM>, to be notified of message delays, <EM>success</EM>, to be
notified of successful transmission.</P>
<P>Example: set dsn_notify="failure,delay"</P>
<H3><A NAME="dsn_return"></A> dsn_return</H3>
<P>Type: string<BR>
Default: ""</P>
<P><B>Note:</B> you should not enable this unless you are using Sendmail
8.8.x or greater.</P>
<P>This variable controls how much of your message is returned in DSN
messages. It may be set to either <EM>hdrs</EM> to return just the
message header, or <EM>full</EM> to return the full message.</P>
<P>Example: set dsn_return=hdrs</P>
<H3><A NAME="duplicate_threads"></A> duplicate_threads</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variable controls whether mutt, when sorting by threads, threads
messages with the same message-id together. If it is set, it will indicate
that it thinks they are duplicates of each other with an equals sign
in the thread diagram.</P>
<H3><A NAME="edit_headers"></A> edit_headers</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>This option allows you to edit the header of your outgoing messages
along with the body of your message.</P>
<H3><A NAME="editor"></A> editor</H3>
<P>Type: path<BR>
Default: ""</P>
<P>This variable specifies which editor is used by mutt.
It defaults to the value of the VISUAL, or EDITOR, environment
variable, or to the string "vi" if neither of those are set.</P>
<H3><A NAME="encode_from"></A> encode_from</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When <EM>set</EM>, mutt will quoted-printable encode messages when
they contain the string "From " in the beginning of a line.
Useful to avoid the tampering certain mail delivery and transport
agents tend to do with messages.</P>
<H3><A NAME="envelope_from"></A> envelope_from</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When <EM>set</EM>, mutt will try to derive the message's <EM>envelope</EM>
sender from the "From:" header. Note that this information is passed
to sendmail command using the "-f" command line switch, so don't set this
option if you are using that switch in
<A HREF="#sendmail">$sendmail</A> yourself,
or if the sendmail on your machine doesn't support that command
line switch.</P>
<H3><A NAME="escape"></A> escape</H3>
<P>Type: string<BR>
Default: "~"</P>
<P>Escape character to use for functions in the builtin editor.</P>
<H3><A NAME="fast_reply"></A> fast_reply</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, the initial prompt for recipients and subject are skipped
when replying to messages, and the initial prompt for subject is
skipped when forwarding messages.</P>
<P><B>Note:</B> this variable has no effect when the ``
<A HREF="#autoedit">$autoedit</A>''
variable is set.</P>
<H3><A NAME="fcc_attach"></A> fcc_attach</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variable controls whether or not attachments on outgoing messages
are saved along with the main body of your message.</P>
<H3><A NAME="fcc_clear"></A> fcc_clear</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When this variable is set, FCCs will be stored unencrypted and
unsigned, even when the actual message is encrypted and/or
signed.
(PGP only)</P>
<H3><A NAME="folder"></A> folder</H3>
<P>Type: path<BR>
Default: "~/Mail"</P>
<P>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 <EM>before</EM>
you use `+' or `=' for any other variables since expansion takes place
during the `set' command.</P>
<H3><A NAME="folder_format"></A> folder_format</H3>
<P>Type: string<BR>
Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"</P>
<P>This variable allows you to customize the file browser display to your
personal taste. This string is similar to ``
<A HREF="#index_format">$index_format</A>'', but has
its own set of printf()-like sequences:</P>
<P>
<DL>
<DT><B>%C </B><DD><P>current file number</P>
<DT><B>%d </B><DD><P>date/time folder was last modified</P>
<DT><B>%f </B><DD><P>filename</P>
<DT><B>%F </B><DD><P>file permissions</P>
<DT><B>%g </B><DD><P>group name (or numeric gid, if missing)</P>
<DT><B>%l </B><DD><P>number of hard links</P>
<DT><B>%N </B><DD><P>N if folder has new mail, blank otherwise</P>
<DT><B>%s </B><DD><P>size in bytes</P>
<DT><B>%t </B><DD><P>* if the file is tagged, blank otherwise</P>
<DT><B>%u </B><DD><P>owner name (or numeric uid, if missing)</P>
<DT><B>%>X </B><DD><P>right justify the rest of the string and pad with character "X"</P>
<DT><B>%|X </B><DD><P>pad to the end of the line with character "X"</P>
</DL>
</P>
<H3><A NAME="followup_to"></A> followup_to</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Controls whether or not the <EM>Mail-Followup-To</EM> header field is
generated when sending mail. When <EM>set</EM>, Mutt will generate this
field when you are replying to a known mailing list, specified with
the ``subscribe'' or ``
<A HREF="manual-3.html#lists">lists</A>'' commands.</P>
<P>This field has two purposes. First, preventing you from
receiving duplicate copies of replies to messages which you send
to mailing lists, and second, ensuring that you do get a reply
separately for any messages sent to known lists to which you are
not subscribed. The header will contain only the list's address
for subscribed lists, and both the list address and your own
email address for unsubscribed lists. Without this header, a
group reply to your message sent to a subscribed list will be
sent to both the list and your address, resulting in two copies
of the same email for you.</P>
<H3><A NAME="followup_to_poster"></A> followup_to_poster</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>If this variable is <EM>set</EM> and the keyword "poster" is present in
<EM>Followup-To</EM> header, follow-up to newsgroup function is not
permitted. The message will be mailed to the submitter of the
message via mail.</P>
<H3><A NAME="force_name"></A> force_name</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>This variable is similar to ``
<A HREF="#save_name">$save_name</A>'', 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.</P>
<P>Also see the ``
<A HREF="#record">$record</A>'' variable.</P>
<H3><A NAME="forward_decode"></A> forward_decode</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Controls the decoding of complex MIME messages into text/plain when
forwarding a message. The message header is also RFC2047 decoded.
This variable is only used, if ``
<A HREF="#mime_forward">$mime_forward</A>'' is <EM>unset</EM>,
otherwise ``
<A HREF="#mime_forward_decode">$mime_forward_decode</A>'' is used instead.</P>
<H3><A NAME="forward_edit"></A> forward_edit</H3>
<P>Type: quadoption<BR>
Default: yes</P>
<P>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''.</P>
<H3><A NAME="forward_format"></A> forward_format</H3>
<P>Type: string<BR>
Default: "[%a: %s]"</P>
<P>This variable controls the default subject when forwarding a message.
It uses the same format sequences as the ``
<A HREF="#index_format">$index_format</A>'' variable.</P>
<H3><A NAME="forward_quote"></A> forward_quote</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When <EM>set</EM> forwarded messages included in the main body of the
message (when ``
<A HREF="#mime_forward">$mime_forward</A>'' is <EM>unset</EM>) will be quoted using
``
<A HREF="#indent_string">$indent_string</A>''.</P>
<H3><A NAME="from"></A> from</H3>
<P>Type: e-mail address<BR>
Default: ""</P>
<P>When set, this variable contains a default from address. It
can be overridden using my_hdr (including from send-hooks) and
``
<A HREF="#reverse_name">$reverse_name</A>''. This variable is ignored if ``
<A HREF="#use_from">$use_from</A>''
is unset.</P>
<P>Defaults to the contents of the environment variable EMAIL.</P>
<H3><A NAME="gecos_mask"></A> gecos_mask</H3>
<P>Type: regular expression<BR>
Default: "^[^,]*"</P>
<P>A regular expression used by mutt to parse the GECOS field of a password
entry when expanding the alias. By default the regular expression is set
to "^[^,]*" which will return the string up to the first "," encountered.
If the GECOS field contains a string like "lastname, firstname" then you
should set the gecos_mask=".*".</P>
<P>This can be useful if you see the following behavior: you address a e-mail
to user ID stevef whose full name is Steve Franklin. If mutt expands
stevef to "Franklin" stevef@foo.bar then you should set the gecos_mask to
a regular expression that will match the whole name so mutt will expand
"Franklin" to "Franklin, Steve".</P>
<H3><A NAME="group_index_format"></A> group_index_format</H3>
<P>Type: string<BR>
Default: "%4C %M%N %5s %-45.45f %d"</P>
<P>This variable allows you to customize the newsgroup browser display to
your personal taste. This string is similar to ``
<A HREF="#index_format">index_format</A>'', but
has its own set of printf()-like sequences:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
%C current newsgroup number
%d description of newsgroup (becomes from server)
%f newsgroup name
%M - if newsgroup not allowed for direct post (moderated for example)
%N N if newsgroup is new, u if unsubscribed, blank otherwise
%n number of new articles in newsgroup
%s number of unread articles in newsgroup
%>X right justify the rest of the string and pad with character "X"
%|X pad to the end of the line with character "X"
</PRE>
</CODE></BLOCKQUOTE>
</P>
<H3><A NAME="hdrs"></A> hdrs</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When unset, the header fields normally added by the ``
<A HREF="manual-3.html#my_hdr">my_hdr</A>''
command are not created. This variable <EM>must</EM> 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.</P>
<H3><A NAME="header"></A> header</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, this variable causes Mutt to include the header
of the message you are replying to into the edit buffer.
The ``
<A HREF="#weed">$weed</A>'' setting applies.</P>
<H3><A NAME="help"></A> help</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When set, help lines describing the bindings for the major functions
provided by each menu are displayed on the first line of the screen.</P>
<P><B>Note:</B> The binding will not be displayed correctly if the
function is bound to a sequence rather than a single keystroke. Also,
the help line may not be updated if a binding is changed while Mutt is
running. Since this variable is primarily aimed at new users, neither
of these should present a major problem.</P>
<H3><A NAME="hidden_host"></A> hidden_host</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, mutt will skip the host name part of ``
<A HREF="#hostname">$hostname</A>'' 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.</P>
<H3><A NAME="hide_limited"></A> hide_limited</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, mutt will not show the presence of messages that are hidden
by limiting, in the thread tree.</P>
<H3><A NAME="hide_missing"></A> hide_missing</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When set, mutt will not show the presence of missing messages in the
thread tree.</P>
<H3><A NAME="hide_thread_subject"></A> hide_thread_subject</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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.</P>
<H3><A NAME="hide_top_limited"></A> hide_top_limited</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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
<A HREF="#hide_missing">$hide_missing</A> is set, this option will have no effect.</P>
<H3><A NAME="hide_top_missing"></A> hide_top_missing</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When set, mutt will not show the presence of missing messages at the
top of threads in the thread tree. Note that when
<A HREF="#hide_limited">$hide_limited</A> is
set, this option will have no effect.</P>
<H3><A NAME="history"></A> history</H3>
<P>Type: number<BR>
Default: 10</P>
<P>This variable controls the size (in number of strings remembered) of
the string history buffer. The buffer is cleared each time the
variable is set.</P>
<H3><A NAME="history_file"></A> history_file</H3>
<P>Type: path<BR>
Default: "~/.mutthistory"</P>
<P>The file in which Mutt will save its history.</P>
<H3><A NAME="honor_followup_to"></A> honor_followup_to</H3>
<P>Type: quadoption<BR>
Default: yes</P>
<P>This variable controls whether or not a Mail-Followup-To header is
honored when group-replying to a message.</P>
<H3><A NAME="hostname"></A> hostname</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Specifies the hostname to use after the ``@'' in local e-mail
addresses. This overrides the compile time definition obtained from
/etc/resolv.conf.</P>
<H3><A NAME="ignore_list_reply_to"></A> ignore_list_reply_to</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Affects the behaviour of the <EM>reply</EM> function when replying to
messages from mailing lists. 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 <EM>list-reply</EM>
function; <EM>group-reply</EM> will reply to both the sender and the
list.</P>
<H3><A NAME="imap_authenticators"></A> imap_authenticators</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This is a colon-delimited list of authentication methods mutt may
attempt to use to log in to an IMAP server, in the order mutt should
try them. Authentication methods are either 'login' or the right
side of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5', 'gssapi'
or 'cram-md5'. This parameter is case-insensitive. If this
parameter is unset (the default) mutt will try all available methods,
in order from most-secure to least-secure.</P>
<P>Example: set imap_authenticators="gssapi:cram-md5:login"</P>
<P><B>Note:</B> 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.</P>
<H3><A NAME="imap_delim_chars"></A> imap_delim_chars</H3>
<P>Type: string<BR>
Default: "/."</P>
<P>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 <EM>folder</EM> variable.</P>
<H3><A NAME="imap_force_ssl"></A> imap_force_ssl</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If this variable is set, Mutt will always use SSL when
connecting to IMAP servers.</P>
<H3><A NAME="imap_headers"></A> imap_headers</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Mutt requests these header fields in addition to the default headers
("DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE
CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL") from IMAP
servers before displaying the index menu. You may want to add more
headers for spam detection. <B>Note:</B> This is a space separated list.</P>
<H3><A NAME="imap_home_namespace"></A> imap_home_namespace</H3>
<P>Type: string<BR>
Default: ""</P>
<P>You normally want to see your personal folders alongside
your INBOX in the IMAP browser. If you see something else, you may set
this variable to the IMAP path to your folders.</P>
<H3><A NAME="imap_keepalive"></A> imap_keepalive</H3>
<P>Type: number<BR>
Default: 900</P>
<P>This variable specifies the maximum amount of time in seconds that mutt
will wait before polling open IMAP connections, to prevent the server
from closing them before mutt has finished with them. The default is
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.</P>
<H3><A NAME="imap_list_subscribed"></A> imap_list_subscribed</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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 <EM>toggle-subscribed</EM> function.</P>
<H3><A NAME="imap_pass"></A> imap_pass</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Specifies the password for your IMAP account. If unset, Mutt will
prompt you for your password when you invoke the fetch-mail function.
<B>Warning</B>: 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.</P>
<H3><A NAME="imap_passive"></A> imap_passive</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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.</P>
<H3><A NAME="imap_peek"></A> imap_peek</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If 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.</P>
<H3><A NAME="imap_servernoise"></A> imap_servernoise</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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.</P>
<H3><A NAME="imap_user"></A> imap_user</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Your login name on the IMAP server.</P>
<P>This variable defaults to your user name on the local machine.</P>
<H3><A NAME="implicit_autoview"></A> implicit_autoview</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set to ``yes'', mutt will look for a mailcap entry with the
copiousoutput flag set for <EM>every</EM> 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.</P>
<H3><A NAME="include"></A> include</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>Controls whether or not a copy of the message(s) you are replying to
is included in your reply.</P>
<H3><A NAME="include_onlyfirst"></A> include_onlyfirst</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Controls whether or not Mutt includes only the first attachment
of the message you are replying.</P>
<H3><A NAME="indent_string"></A> indent_string</H3>
<P>Type: string<BR>
Default: "> "</P>
<P>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.</P>
<H3><A NAME="index_format"></A> index_format</H3>
<P>Type: string<BR>
Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"</P>
<P>This variable allows you to customize the message index display to
your personal taste.</P>
<P>``Format strings'' are similar to the strings used in the ``C''
function printf to format output (see the man page for more detail).
The following sequences are defined in Mutt:</P>
<P>
<DL>
<DT><B>%a </B><DD><P>address of the author</P>
<DT><B>%A </B><DD><P>reply-to address (if present; otherwise: address of author)</P>
<DT><B>%b </B><DD><P>filename of the original message folder (think mailBox)</P>
<DT><B>%B </B><DD><P>the list to which the letter was sent, or else the folder name (%b).</P>
<DT><B>%c </B><DD><P>number of characters (bytes) in the message</P>
<DT><B>%C </B><DD><P>current message number</P>
<DT><B>%d </B><DD><P>date and time of the message in the format specified by
``date_format'' converted to sender's time zone</P>
<DT><B>%D </B><DD><P>date and time of the message in the format specified by
``date_format'' converted to the local time zone</P>
<DT><B>%e </B><DD><P>current message number in thread</P>
<DT><B>%E </B><DD><P>number of messages in current thread</P>
<DT><B>%f </B><DD><P>entire From: line (address + real name)</P>
<DT><B>%F </B><DD><P>author name, or recipient name if the message is from you</P>
<DT><B>%g </B><DD><P>newsgroup name (if compiled with nntp support)</P>
<DT><B>%H </B><DD><P>spam attribute(s) of this message</P>
<DT><B>%i </B><DD><P>message-id of the current message</P>
<DT><B>%l </B><DD><P>number of lines in the message (does not work with maildir,
mh, and possibly IMAP folders)</P>
<DT><B>%L </B><DD><P>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.</P>
<DT><B>%m </B><DD><P>total number of message in the mailbox</P>
<DT><B>%M </B><DD><P>number of hidden messages if the thread is collapsed.</P>
<DT><B>%N </B><DD><P>message score</P>
<DT><B>%n </B><DD><P>author's real name (or address if missing)</P>
<DT><B>%O </B><DD><P>(_O_riginal save folder) Where mutt would formerly have
stashed the message: list name or recipient name if no list</P>
<DT><B>%s </B><DD><P>subject of the message</P>
<DT><B>%S </B><DD><P>status of the message (N/D/d/!/r/*)</P>
<DT><B>%t </B><DD><P>`to:' field (recipients)</P>
<DT><B>%T </B><DD><P>the appropriate character from the
<A HREF="#to_chars">$to_chars</A> string</P>
<DT><B>%u </B><DD><P>user (login) name of the author</P>
<DT><B>%v </B><DD><P>first name of the author, or the recipient if the message is from you</P>
<DT><B>%W </B><DD><P>name of organization of author (`organization:' field)</P>
<DT><B>%y </B><DD><P>`x-label:' field, if present</P>
<DT><B>%Y </B><DD><P>`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'.</P>
<DT><B>%Z </B><DD><P>message status flags</P>
<DT><B>%{fmt} </B><DD><P>the date and time of the message is converted to sender's
time zone, and ``fmt'' is expanded by the library function
``strftime''; a leading bang disables locales</P>
<DT><B>%[fmt] </B><DD><P>the date and time of the message is converted to the local
time zone, and ``fmt'' is expanded by the library function
``strftime''; a leading bang disables locales</P>
<DT><B>%(fmt) </B><DD><P>the local date and time when the message was received.
``fmt'' is expanded by the library function ``strftime'';
a leading bang disables locales</P>
<DT><B>%<fmt> </B><DD><P>the current local time. ``fmt'' is expanded by the library
function ``strftime''; a leading bang disables locales.</P>
<DT><B>%>X </B><DD><P>right justify the rest of the string and pad with character "X"</P>
<DT><B>%|X </B><DD><P>pad to the end of the line with character "X"</P>
</DL>
</P>
<P>See also: ``
<A HREF="#to_chars">$to_chars</A>''.</P>
<H3><A NAME="inews"></A> inews</H3>
<P>Type: path<BR>
Default: ""</P>
<P>If set, specifies the program and arguments used to deliver news posted
by Mutt. Otherwise, mutt posts article using current connection to
news server. The following printf-style sequence is understood:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
%s newsserver name
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>Example: set inews="/usr/bin/inews -hS"</P>
<H3><A NAME="ispell"></A> ispell</H3>
<P>Type: path<BR>
Default: "ispell"</P>
<P>How to invoke ispell (GNU's spell-checking software).</P>
<H3><A NAME="keep_flagged"></A> keep_flagged</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, read messages marked as flagged will not be moved
from your spool mailbox to your ``
<A HREF="#mbox">$mbox</A>'' mailbox, or as a result of
a ``
<A HREF="manual-3.html#mbox-hook">mbox-hook</A>'' command.</P>
<H3><A NAME="locale"></A> locale</H3>
<P>Type: string<BR>
Default: "C"</P>
<P>The locale used by <EM>strftime(3)</EM> to format dates. Legal values are
the strings your system accepts for the locale variable <EM>LC_TIME</EM>.</P>
<H3><A NAME="mail_check"></A> mail_check</H3>
<P>Type: number<BR>
Default: 5</P>
<P>This variable configures how often (in seconds) mutt should look for
new mail.</P>
<H3><A NAME="mailcap_path"></A> mailcap_path</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This variable specifies which files to consult when attempting to
display MIME bodies not directly supported by Mutt.</P>
<H3><A NAME="mailcap_sanitize"></A> mailcap_sanitize</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If set, mutt will restrict possible characters in mailcap % expandos
to a well-defined set of safe characters. This is the safe setting,
but we are not sure it doesn't break some more advanced MIME stuff.</P>
<P><B>DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
DOING!</B></P>
<H3><A NAME="header_cache"></A> header_cache</H3>
<P>Type: path<BR>
Default: ""</P>
<P>The header_cache variable points to the header cache database.
If header_cache points to a directory it will contain a header cache
database per folder. If header_cache points to a file that file will
be a single global header cache. By default it is unset and so no
header caching will be used.</P>
<H3><A NAME="header_cache_pagesize"></A> header_cache_pagesize</H3>
<P>Type: string<BR>
Default: "16384"</P>
<P>Change the header cache database page size. Too large or to small values
can waste space, memory, or CPU time. The default should be more or
less the best you can get. For details google after mutt header
cache (first hit).</P>
<H3><A NAME="maildir_trash"></A> maildir_trash</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, messages marked as deleted will be saved with the maildir
(T)rashed flag instead of unlinked. <B>NOTE:</B> this only applies
to maildir-style mailboxes. Setting it will have no effect on other
mailbox types.</P>
<H3><A NAME="mark_old"></A> mark_old</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Controls whether or not mutt marks <EM>new</EM> <B>unread</B>
messages as <EM>old</EM> 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,
indicating that they are old.</P>
<H3><A NAME="markers"></A> markers</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Controls the display of wrapped lines in the internal pager. If set, a
``+'' marker is displayed at the beginning of wrapped lines. Also see
the ``
<A HREF="#smart_wrap">$smart_wrap</A>'' variable.</P>
<H3><A NAME="mask"></A> mask</H3>
<P>Type: regular expression<BR>
Default: "!^\.[^.]"</P>
<P>A regular expression used in the file browser, optionally preceded by
the <EM>not</EM> operator ``!''. Only files whose names match this mask
will be shown. The match is always case-sensitive.</P>
<H3><A NAME="mbox"></A> mbox</H3>
<P>Type: path<BR>
Default: "~/mbox"</P>
<P>This specifies the folder into which read mail in your ``
<A HREF="#spoolfile">$spoolfile</A>''
folder will be appended.</P>
<H3><A NAME="mbox_type"></A> mbox_type</H3>
<P>Type: folder magic<BR>
Default: mbox</P>
<P>The default mailbox type used when creating new folders. May be any of
mbox, MMDF, MH and Maildir.</P>
<H3><A NAME="metoo"></A> metoo</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If unset, Mutt will remove your address (see the ``alternates''
command) from the list of recipients when replying to a message.</P>
<H3><A NAME="menu_context"></A> menu_context</H3>
<P>Type: number<BR>
Default: 0</P>
<P>This variable controls the number of lines of context that are given
when scrolling through menus. (Similar to ``
<A HREF="#pager_context">$pager_context</A>''.)</P>
<H3><A NAME="menu_move_off"></A> menu_move_off</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When <EM>unset</EM>, the bottom entry of menus will never scroll up past
the bottom of the screen, unless there are less entries than lines.
When <EM>set</EM>, the bottom entry may move off the bottom.</P>
<H3><A NAME="menu_scroll"></A> menu_scroll</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When <EM>set</EM>, menus will be scrolled up or down one line when you
attempt to move across a screen boundary. If <EM>unset</EM>, the screen
is cleared and the next or previous page of the menu is displayed
(useful for slow links to avoid many redraws).</P>
<H3><A NAME="meta_key"></A> meta_key</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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 0xf4, then this is treated as if the user had
pressed ESC then ``x''. This is because the result of removing the
high bit from ``0xf4'' is ``0x74'', which is the ASCII character
``x''.</P>
<H3><A NAME="mh_purge"></A> mh_purge</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When unset, mutt will mimic mh's behaviour and rename deleted messages
to <EM>,<old file name></EM> in mh folders instead of really deleting
them. If the variable is set, the message files will simply be
deleted.</P>
<H3><A NAME="mh_seq_flagged"></A> mh_seq_flagged</H3>
<P>Type: string<BR>
Default: "flagged"</P>
<P>The name of the MH sequence used for flagged messages.</P>
<H3><A NAME="mh_seq_replied"></A> mh_seq_replied</H3>
<P>Type: string<BR>
Default: "replied"</P>
<P>The name of the MH sequence used to tag replied messages.</P>
<H3><A NAME="mh_seq_unseen"></A> mh_seq_unseen</H3>
<P>Type: string<BR>
Default: "unseen"</P>
<P>The name of the MH sequence used for unseen messages.</P>
<H3><A NAME="mime_forward"></A> mime_forward</H3>
<P>Type: quadoption<BR>
Default: no</P>
<P>When set, the message you are forwarding will be attached as a
separate 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.</P>
<P>Also see ``
<A HREF="#forward_decode">$forward_decode</A>'' and ``
<A HREF="#mime_forward_decode">$mime_forward_decode</A>''.</P>
<H3><A NAME="mime_forward_decode"></A> mime_forward_decode</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Controls the decoding of complex MIME messages into text/plain when
forwarding a message while ``
<A HREF="#mime_forward">$mime_forward</A>'' is <EM>set</EM>. Otherwise
``
<A HREF="#forward_decode">$forward_decode</A>'' is used instead.</P>
<H3><A NAME="mime_forward_rest"></A> mime_forward_rest</H3>
<P>Type: quadoption<BR>
Default: yes</P>
<P>When forwarding multiple attachments of a MIME message from the recvattach
menu, attachments which cannot be decoded in a reasonable manner will
be attached to the newly composed message if this option is set.</P>
<H3><A NAME="mime_subject"></A> mime_subject</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If <EM>unset</EM>, 8-bit ``subject:'' line in article header will not be
encoded according to RFC2047 to base64. This is useful when message
is Usenet article, because MIME for news is nonstandard feature.</P>
<H3><A NAME="mix_entry_format"></A> mix_entry_format</H3>
<P>Type: string<BR>
Default: "%4n %c %-16s %a"</P>
<P>This variable describes the format of a remailer line on the mixmaster
chain selection screen. The following printf-like sequences are
supported:</P>
<P>
<DL>
<DT><B>%n </B><DD><P>The running number on the menu.</P>
<DT><B>%c </B><DD><P>Remailer capabilities.</P>
<DT><B>%s </B><DD><P>The remailer's short name.</P>
<DT><B>%a </B><DD><P>The remailer's e-mail address.</P>
</DL>
</P>
<H3><A NAME="mixmaster"></A> mixmaster</H3>
<P>Type: path<BR>
Default: "mixmaster"</P>
<P>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.</P>
<H3><A NAME="move"></A> move</H3>
<P>Type: quadoption<BR>
Default: ask-no</P>
<P>Controls whether or not Mutt will move read messages
from your spool mailbox to your ``
<A HREF="#mbox">$mbox</A>'' mailbox, or as a result of
a ``
<A HREF="manual-3.html#mbox-hook">mbox-hook</A>'' command.</P>
<H3><A NAME="message_format"></A> message_format</H3>
<P>Type: string<BR>
Default: "%s"</P>
<P>This is the string displayed in the ``attachment'' menu for
attachments of type message/rfc822. For a full listing of defined
printf()-like sequences see the section on ``
<A HREF="#index_format">$index_format</A>''.</P>
<H3><A NAME="narrow_tree"></A> narrow_tree</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>This variable, when set, makes the thread tree narrower, allowing
deeper threads to fit on the screen.</P>
<H3><A NAME="news_cache_dir"></A> news_cache_dir</H3>
<P>Type: path<BR>
Default: "~/.mutt"</P>
<P>This variable pointing to directory where Mutt will save cached news
articles headers in. If <EM>unset</EM>, headers will not be saved at all
and will be reloaded each time when you enter to newsgroup.</P>
<H3><A NAME="news_server"></A> news_server</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This variable specifies domain name or address of NNTP server. It
defaults to the newsserver specified in the environment variable
$NNTPSERVER or contained in the file /etc/nntpserver. You can also
specify username and an alternative port for each newsserver, ie:</P>
<P>[nntp[s]://][username[:password]@]newsserver[:port]</P>
<H3><A NAME="newsrc"></A> newsrc</H3>
<P>Type: path<BR>
Default: "~/.newsrc"</P>
<P>The file, containing info about subscribed newsgroups - names and
indexes of read articles. The following printf-style sequence
is understood:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
%s newsserver name
</PRE>
</CODE></BLOCKQUOTE>
</P>
<H3><A NAME="nntp_context"></A> nntp_context</H3>
<P>Type: number<BR>
Default: 1000</P>
<P>This variable defines number of articles which will be in index when
newsgroup entered. If active newsgroup have more articles than this
number, oldest articles will be ignored. Also controls how many
articles headers will be saved in cache when you quit newsgroup.</P>
<H3><A NAME="nntp_load_description"></A> nntp_load_description</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variable controls whether or not descriptions for each newsgroup
must be loaded when newsgroup is added to list (first time list
loading or new newsgroup adding).</P>
<H3><A NAME="nntp_user"></A> nntp_user</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Your login name on the NNTP server. If <EM>unset</EM> and NNTP server requires
authentification, Mutt will prompt you for your account name when you
connect to newsserver.</P>
<H3><A NAME="nntp_pass"></A> nntp_pass</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Your password for NNTP account.</P>
<H3><A NAME="nntp_poll"></A> nntp_poll</H3>
<P>Type: number<BR>
Default: 60</P>
<P>The time in seconds until any operations on newsgroup except post new
article will cause recheck for new news. If set to 0, Mutt will
recheck newsgroup on each operation in index (stepping, read article,
etc.).</P>
<H3><A NAME="nntp_reconnect"></A> nntp_reconnect</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>Controls whether or not Mutt will try to reconnect to newsserver when
connection lost.</P>
<H3><A NAME="pager"></A> pager</H3>
<P>Type: path<BR>
Default: "builtin"</P>
<P>This variable specifies which pager you would like to use to view
messages. builtin means to use the builtin pager, otherwise this
variable should specify the pathname of the external pager you would
like to use.</P>
<P>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.</P>
<H3><A NAME="pager_context"></A> pager_context</H3>
<P>Type: number<BR>
Default: 0</P>
<P>This variable controls the number of lines of context that are given
when displaying the next or previous page in the internal pager. By
default, Mutt will display the line after the last one on the screen
at the top of the next page (0 lines of context).</P>
<H3><A NAME="pager_format"></A> pager_format</H3>
<P>Type: string<BR>
Default: "-%Z- %C/%m: %-20.20n %s"</P>
<P>This variable controls the format of the one-line message ``status''
displayed before each message in either the internal or an external
pager. The valid sequences are listed in the ``
<A HREF="#index_format">$index_format</A>''
section.</P>
<H3><A NAME="pager_index_lines"></A> pager_index_lines</H3>
<P>Type: number<BR>
Default: 0</P>
<P>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
folder, will be roughly one third of the way down this mini-index,
giving the reader the context of a few messages before and after the
message. This is useful, for example, to determine how many messages
remain to be read in the current thread. One of the lines is reserved
for the status bar from the index, so a <EM>pager_index_lines</EM> 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 <EM>pager_index_lines</EM>, then the index will only use as
many lines as it needs.</P>
<H3><A NAME="pager_stop"></A> pager_stop</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, the internal-pager will <B>not</B> move to the next message
when you are at the end of a message and invoke the <EM>next-page</EM>
function.</P>
<H3><A NAME="crypt_autosign"></A> crypt_autosign</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Setting this variable will cause Mutt to always attempt to
cryptographically sign outgoing messages. This can be overridden
by use of the <EM>pgp-menu</EM>, when signing is not required or
encryption is requested as well. If ``
<A HREF="#smime_is_default">$smime_is_default</A>'' is set,
then OpenSSL is used instead to create S/MIME messages and settings can
be overridden by use of the <EM>smime-menu</EM>.
(Crypto only)</P>
<H3><A NAME="crypt_autoencrypt"></A> crypt_autoencrypt</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Setting this variable will cause Mutt to always attempt to PGP
encrypt outgoing messages. This is probably only useful in
connection to the <EM>send-hook</EM> command. It can be overridden
by use of the <EM>pgp-menu</EM>, when encryption is not required or
signing is requested as well. IF ``
<A HREF="#smime_is_default">$smime_is_default</A>'' is set,
then OpenSSL is used instead to create S/MIME messages and
settings can be overridden by use of the <EM>smime-menu</EM>.
(Crypto only)</P>
<H3><A NAME="pgp_ignore_subkeys"></A> pgp_ignore_subkeys</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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)</P>
<H3><A NAME="crypt_replyencrypt"></A> crypt_replyencrypt</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If set, automatically PGP or OpenSSL encrypt replies to messages which are
encrypted.
(Crypto only)</P>
<H3><A NAME="crypt_replysign"></A> crypt_replysign</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, automatically PGP or OpenSSL sign replies to messages which are
signed.</P>
<P><B>Note:</B> this does not work on messages that are encrypted
<B>and</B> signed!
(Crypto only)</P>
<H3><A NAME="crypt_replysignencrypted"></A> crypt_replysignencrypted</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, automatically PGP or OpenSSL sign replies to messages
which are encrypted. This makes sense in combination with
``
<A HREF="#crypt_replyencrypt">$crypt_replyencrypt</A>'', because it allows you to sign all
messages which are automatically encrypted. This works around
the problem noted in ``
<A HREF="#crypt_replysign">$crypt_replysign</A>'', that mutt is not able
to find out whether an encrypted message is also signed.
(Crypto only)</P>
<H3><A NAME="crypt_timestamp"></A> crypt_timestamp</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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)</P>
<H3><A NAME="pgp_use_gpg_agent"></A> pgp_use_gpg_agent</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, mutt will use a possibly-running gpg-agent process.
(PGP only)</P>
<H3><A NAME="crypt_verify_sig"></A> crypt_verify_sig</H3>
<P>Type: quadoption<BR>
Default: yes</P>
<P>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)</P>
<H3><A NAME="smime_is_default"></A> smime_is_default</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>The default behaviour of mutt is to use PGP on all auto-sign/encryption
operations. To override and to use OpenSSL instead this must be set.
However, this has no effect while replying, since mutt will automatically
select the same application that was used to sign/encrypt the original
message. (Note that this variable can be overridden by unsetting
<A HREF="#crypt_autosmime">$crypt_autosmime</A>.)
(S/MIME only)</P>
<H3><A NAME="smime_ask_cert_label"></A> smime_ask_cert_label</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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)</P>
<H3><A NAME="smime_decrypt_use_default_key"></A> smime_decrypt_use_default_key</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If set (default) this tells mutt to use the default key for decryption. Otherwise,
if manage multiple certificate-key-pairs, mutt will try to use the mailbox-address
to determine the key to use. It will ask you to supply a key, if it can't find one.
(S/MIME only)</P>
<H3><A NAME="pgp_entry_format"></A> pgp_entry_format</H3>
<P>Type: string<BR>
Default: "%4n %t%f %4l/0x%k %-4a %2c %u"</P>
<P>This variable allows you to customize the PGP key selection menu to
your personal taste. This string is similar to ``
<A HREF="#index_format">$index_format</A>'', but
has its own set of printf()-like sequences:</P>
<P>
<DL>
<DT><B>%n </B><DD><P>number</P>
<DT><B>%k </B><DD><P>key id</P>
<DT><B>%u </B><DD><P>user id</P>
<DT><B>%a </B><DD><P>algorithm</P>
<DT><B>%l </B><DD><P>key length</P>
<DT><B>%f </B><DD><P>flags</P>
<DT><B>%c </B><DD><P>capabilities</P>
<DT><B>%t </B><DD><P>trust/validity of the key-uid association</P>
<DT><B>%[<s>] </B><DD><P>date of the key where <s> is an strftime(3) expression</P>
</DL>
</P>
<P>(PGP only)</P>
<H3><A NAME="pgp_good_sign"></A> pgp_good_sign</H3>
<P>Type: regular expression<BR>
Default: ""</P>
<P>If you assign a text to this variable, then a PGP signature is only
considered verified if the output from
<A HREF="#pgp_verify_command">$pgp_verify_command</A> contains
the text. Use this variable if the exit code from the command is 0
even for bad signatures.
(PGP only)</P>
<H3><A NAME="pgp_check_exit"></A> pgp_check_exit</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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)</P>
<H3><A NAME="pgp_long_ids"></A> pgp_long_ids</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs.
(PGP only)</P>
<H3><A NAME="pgp_retainable_sigs"></A> pgp_retainable_sigs</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, signed and encrypted messages will consist of nested
multipart/signed and multipart/encrypted body parts.</P>
<P>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)</P>
<H3><A NAME="pgp_autoinline"></A> pgp_autoinline</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>This option controls whether Mutt generates old-style inline
(traditional) PGP encrypted or signed messages under certain
circumstances. This can be overridden by use of the <EM>pgp-menu</EM>,
when inline is not required.</P>
<P>Note that Mutt might automatically use PGP/MIME for messages
which consist of more than a single MIME part. Mutt can be
configured to ask before sending PGP/MIME messages when inline
(traditional) would not work.
See also: ``
<A HREF="#pgp_mime_auto">$pgp_mime_auto</A>''.</P>
<P>Also note that using the old-style PGP message format is <B>strongly</B>
<B>deprecated</B>.
(PGP only)</P>
<H3><A NAME="pgp_replyinline"></A> pgp_replyinline</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Setting this variable will cause Mutt to always attempt to
create an inline (traditional) message when replying to a
message which is PGP encrypted/signed inline. This can be
overridden by use of the <EM>pgp-menu</EM>, when inline is not
required. This option does not automatically detect if the
(replied-to) message is inline; instead it relies on Mutt
internals for previously checked/flagged messages.</P>
<P>Note that Mutt might automatically use PGP/MIME for messages
which consist of more than a single MIME part. Mutt can be
configured to ask before sending PGP/MIME messages when inline
(traditional) would not work.
See also: ``
<A HREF="#pgp_mime_auto">$pgp_mime_auto</A>''.</P>
<P>Also note that using the old-style PGP message format is <B>strongly</B>
<B>deprecated</B>.
(PGP only)</P>
<H3><A NAME="pgp_show_unusable"></A> pgp_show_unusable</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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.
(PGP only)</P>
<H3><A NAME="pgp_sign_as"></A> pgp_sign_as</H3>
<P>Type: string<BR>
Default: ""</P>
<P>If you have more than one key pair, this option allows you to specify
which of your private keys to use. It is recommended that you use the
keyid form to specify your key (e.g., ``0x00112233'').
(PGP only)</P>
<H3><A NAME="pgp_strict_enc"></A> pgp_strict_enc</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If set, Mutt will automatically encode PGP/MIME signed messages as
<EM>quoted-printable</EM>. 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)</P>
<H3><A NAME="pgp_timeout"></A> pgp_timeout</H3>
<P>Type: number<BR>
Default: 300</P>
<P>The number of seconds after which a cached passphrase will expire if
not used.
(PGP only)</P>
<H3><A NAME="pgp_sort_keys"></A> pgp_sort_keys</H3>
<P>Type: sort order<BR>
Default: address</P>
<P>Specifies how the entries in the `pgp keys' menu are sorted. The
following are legal values:</P>
<P>
<DL>
<DT><B>address </B><DD><P>sort alphabetically by user id</P>
<DT><B>keyid </B><DD><P>sort alphabetically by key id</P>
<DT><B>date </B><DD><P>sort by key creation date</P>
<DT><B>trust </B><DD><P>sort by the trust of the key</P>
</DL>
</P>
<P>If you prefer reverse order of the above values, prefix it with
`reverse-'.
(PGP only)</P>
<H3><A NAME="pgp_mime_auto"></A> pgp_mime_auto</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>This option controls whether Mutt will prompt you for
automatically sending a (signed/encrypted) message using
PGP/MIME when inline (traditional) fails (for any reason).</P>
<P>Also note that using the old-style PGP message format is <B>strongly</B>
<B>deprecated</B>.
(PGP only)</P>
<H3><A NAME="pgp_auto_decode"></A> pgp_auto_decode</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, mutt will automatically attempt to decrypt traditional PGP
messages whenever the user performs an operation which ordinarily would
result in the contents of the message being operated on. For example,
if the user displays a pgp-traditional message which has not been manually
checked with the check-traditional-pgp function, mutt will automatically
check the message for traditional pgp.</P>
<H3><A NAME="pgp_decode_command"></A> pgp_decode_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This format strings specifies a command which is used to decode
application/pgp attachments.</P>
<P>The PGP command formats have their own set of printf-like sequences:</P>
<P>
<DL>
<DT><B>%p </B><DD><P>Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
string otherwise. Note: This may be used with a %? construct.</P>
<DT><B>%f </B><DD><P>Expands to the name of a file containing a message.</P>
<DT><B>%s </B><DD><P>Expands to the name of a file containing the signature part
of a multipart/signed attachment when verifying it.</P>
<DT><B>%a </B><DD><P>The value of
<A HREF="#pgp_sign_as">$pgp_sign_as</A>.</P>
<DT><B>%r </B><DD><P>One or more key IDs.</P>
</DL>
</P>
<P>For examples on how to configure these formats for the various versions
of PGP which are floating around, see the pgp*.rc and gpg.rc files in
the samples/ subdirectory which has been installed on your system
alongside the documentation.
(PGP only)</P>
<H3><A NAME="pgp_getkeys_command"></A> pgp_getkeys_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is invoked whenever mutt will need public key information.
%r is the only printf-like sequence used with this format.
(PGP only)</P>
<H3><A NAME="pgp_verify_command"></A> pgp_verify_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to verify PGP signatures.
(PGP only)</P>
<H3><A NAME="pgp_decrypt_command"></A> pgp_decrypt_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to decrypt a PGP encrypted message.
(PGP only)</P>
<H3><A NAME="pgp_clearsign_command"></A> pgp_clearsign_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This format is used to create a old-style "clearsigned" PGP
message. Note that the use of this format is <B>strongly</B>
<B>deprecated</B>.
(PGP only)</P>
<H3><A NAME="pgp_sign_command"></A> pgp_sign_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to create the detached PGP signature for a
multipart/signed PGP/MIME body part.
(PGP only)</P>
<H3><A NAME="pgp_encrypt_sign_command"></A> pgp_encrypt_sign_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to both sign and encrypt a body part.
(PGP only)</P>
<H3><A NAME="pgp_encrypt_only_command"></A> pgp_encrypt_only_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to encrypt a body part without signing it.
(PGP only)</P>
<H3><A NAME="pgp_import_command"></A> pgp_import_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to import a key from a message into
the user's public key ring.
(PGP only)</P>
<H3><A NAME="pgp_export_command"></A> pgp_export_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to export a public key from the user's
key ring.
(PGP only)</P>
<H3><A NAME="pgp_verify_key_command"></A> pgp_verify_key_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to verify key information from the key selection
menu.
(PGP only)</P>
<H3><A NAME="pgp_list_secring_command"></A> pgp_list_secring_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to list the secret key ring's contents. The
output format must be analogous to the one used by
gpg --list-keys --with-colons.</P>
<P>This format is also generated by the pgpring utility which comes
with mutt.
(PGP only)</P>
<H3><A NAME="pgp_list_pubring_command"></A> pgp_list_pubring_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to list the public key ring's contents. The
output format must be analogous to the one used by
gpg --list-keys --with-colons.</P>
<P>This format is also generated by the pgpring utility which comes
with mutt.
(PGP only)</P>
<H3><A NAME="forward_decrypt"></A> forward_decrypt</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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 ``
<A HREF="#mime_forward">$mime_forward</A>'' is <EM>set</EM> and
``
<A HREF="#mime_forward_decode">$mime_forward_decode</A>'' is <EM>unset</EM>.
(PGP only)</P>
<H3><A NAME="smime_timeout"></A> smime_timeout</H3>
<P>Type: number<BR>
Default: 300</P>
<P>The number of seconds after which a cached passphrase will expire if
not used.
(S/MIME only)</P>
<H3><A NAME="smime_encrypt_with"></A> smime_encrypt_with</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This sets the algorithm that should be used for encryption.
Valid choices are "des", "des3", "rc2-40", "rc2-64", "rc2-128".
If unset "3des" (TripleDES) is used.
(S/MIME only)</P>
<H3><A NAME="smime_keys"></A> smime_keys</H3>
<P>Type: path<BR>
Default: ""</P>
<P>Since there is no pubring/secring as with PGP, mutt has to handle
storage ad retrieval of keys/certs by itself. This is very basic right now,
and stores keys and certificates in two different directories, both
named as the hash-value retrieved from OpenSSL. There is an index file
which contains mailbox-address keyid pair, and which can be manually
edited. This one points to the location of the private keys.
(S/MIME only)</P>
<H3><A NAME="smime_ca_location"></A> smime_ca_location</H3>
<P>Type: path<BR>
Default: ""</P>
<P>This variable contains the name of either a directory, or a file which
contains trusted certificates for use with OpenSSL.
(S/MIME only)</P>
<H3><A NAME="smime_certificates"></A> smime_certificates</H3>
<P>Type: path<BR>
Default: ""</P>
<P>Since there is no pubring/secring as with PGP, mutt has to handle
storage and retrieval of keys by itself. This is very basic right
now, and keys and certificates are stored in two different
directories, both named as the hash-value retrieved from
OpenSSL. There is an index file which contains mailbox-address
keyid pairs, and which can be manually edited. This one points to
the location of the certificates.
(S/MIME only)</P>
<H3><A NAME="smime_decrypt_command"></A> smime_decrypt_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This format string specifies a command which is used to decrypt
application/x-pkcs7-mime attachments.</P>
<P>The OpenSSL command formats have their own set of printf-like sequences
similar to PGP's:</P>
<P>
<DL>
<DT><B>%f </B><DD><P>Expands to the name of a file containing a message.</P>
<DT><B>%s </B><DD><P>Expands to the name of a file containing the signature part
of a multipart/signed attachment when verifying it.</P>
<DT><B>%k </B><DD><P>The key-pair specified with
<A HREF="#smime_default_key">$smime_default_key</A></P>
<DT><B>%c </B><DD><P>One or more certificate IDs.</P>
<DT><B>%a </B><DD><P>The algorithm used for encryption.</P>
<DT><B>%C </B><DD><P>CA location: Depending on whether
<A HREF="#smime_ca_location">$smime_ca_location</A>
points to a directory or file, this expands to
"-CApath
<A HREF="#smime_ca_location">$smime_ca_location</A>" or "-CAfile
<A HREF="#smime_ca_location">$smime_ca_location</A>".</P>
</DL>
</P>
<P>For examples on how to configure these formats, see the smime.rc in
the samples/ subdirectory which has been installed on your system
alongside the documentation.
(S/MIME only)</P>
<H3><A NAME="smime_verify_command"></A> smime_verify_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to verify S/MIME signatures of type multipart/signed.
(S/MIME only)</P>
<H3><A NAME="smime_verify_opaque_command"></A> smime_verify_opaque_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to verify S/MIME signatures of type
application/x-pkcs7-mime.
(S/MIME only)</P>
<H3><A NAME="smime_sign_command"></A> smime_sign_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to created S/MIME signatures of type
multipart/signed, which can be read by all mail clients.
(S/MIME only)</P>
<H3><A NAME="smime_sign_opaque_command"></A> smime_sign_opaque_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to created S/MIME signatures of type
application/x-pkcs7-signature, which can only be handled by mail
clients supporting the S/MIME extension.
(S/MIME only)</P>
<H3><A NAME="smime_encrypt_command"></A> smime_encrypt_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to create encrypted S/MIME messages.
(S/MIME only)</P>
<H3><A NAME="smime_pk7out_command"></A> smime_pk7out_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to extract PKCS7 structures of S/MIME signatures,
in order to extract the public X509 certificate(s).
(S/MIME only)</P>
<H3><A NAME="smime_get_cert_command"></A> smime_get_cert_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to extract X509 certificates from a PKCS7 structure.
(S/MIME only)</P>
<H3><A NAME="smime_get_signer_cert_command"></A> smime_get_signer_cert_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to extract only the signers X509 certificate from a S/MIME
signature, so that the certificate's owner may get compared to the
email's 'From'-field.
(S/MIME only)</P>
<H3><A NAME="smime_import_cert_command"></A> smime_import_cert_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to import a certificate via smime_keys.
(S/MIME only)</P>
<H3><A NAME="smime_get_cert_email_command"></A> smime_get_cert_email_command</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This command is used to extract the mail address(es) used for storing
X509 certificates, and for verification purposes (to check whether the
certificate was issued for the sender's mailbox).
(S/MIME only)</P>
<H3><A NAME="smime_default_key"></A> smime_default_key</H3>
<P>Type: string<BR>
Default: ""</P>
<P>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)</P>
<H3><A NAME="ssl_client_cert"></A> ssl_client_cert</H3>
<P>Type: path<BR>
Default: ""</P>
<P>The file containing a client certificate and its associated private
key.</P>
<H3><A NAME="ssl_starttls"></A> ssl_starttls</H3>
<P>Type: quadoption<BR>
Default: yes</P>
<P>If set (the default), mutt will attempt to use STARTTLS on servers
advertising the capability. When unset, mutt will not attempt to
use STARTTLS regardless of the server's capabilities.</P>
<H3><A NAME="certificate_file"></A> certificate_file</H3>
<P>Type: path<BR>
Default: "~/.mutt_certificates"</P>
<P>This variable specifies the file where the certificates you trust
are saved. When an unknown certificate is encountered, you are asked
if you accept it or not. If you accept it, the certificate can also
be saved in this file and further connections are automatically
accepted.</P>
<P>You can also manually add CA certificates in this file. Any server
certificate that is signed with one of these CA certificates are
also automatically accepted.</P>
<P>Example: set certificate_file=~/.mutt/certificates</P>
<H3><A NAME="ssl_usesystemcerts"></A> ssl_usesystemcerts</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If set to <EM>yes</EM>, mutt will use CA certificates in the
system-wide certificate store when checking if server certificate
is signed by a trusted CA.</P>
<H3><A NAME="entropy_file"></A> entropy_file</H3>
<P>Type: path<BR>
Default: ""</P>
<P>The file which includes random data that is used to initialize SSL
library functions.</P>
<H3><A NAME="ssl_use_sslv2"></A> ssl_use_sslv2</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variables specifies whether to attempt to use SSLv2 in the
SSL authentication process.</P>
<H3><A NAME="ssl_use_sslv3"></A> ssl_use_sslv3</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variables specifies whether to attempt to use SSLv3 in the
SSL authentication process.</P>
<H3><A NAME="ssl_use_tlsv1"></A> ssl_use_tlsv1</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variables specifies whether to attempt to use TLSv1 in the
SSL authentication process.</P>
<H3><A NAME="pipe_split"></A> pipe_split</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Used in connection with the <EM>pipe-message</EM> command and the ``tag-
prefix'' operator. If this variable is unset, when piping a list of
tagged messages Mutt will concatenate the messages and will pipe them
as a single folder. When set, Mutt will pipe the messages one by one.
In both cases the messages are piped in the current sorted order,
and the ``
<A HREF="#pipe_sep">$pipe_sep</A>'' separator is added after each message.</P>
<H3><A NAME="pipe_decode"></A> pipe_decode</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Used in connection with the <EM>pipe-message</EM> command. When unset,
Mutt will pipe the messages without any preprocessing. When set, Mutt
will weed headers and will attempt to PGP/MIME decode the messages
first.</P>
<H3><A NAME="pipe_sep"></A> pipe_sep</H3>
<P>Type: string<BR>
Default: "\n"</P>
<P>The separator to add between messages when piping a list of tagged
messages to an external Unix command.</P>
<H3><A NAME="pop_authenticators"></A> pop_authenticators</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This is a colon-delimited list of authentication methods mutt may
attempt to use to log in to an POP server, in the order mutt should
try them. Authentication methods are either 'user', 'apop' or any
SASL mechanism, eg 'digest-md5', 'gssapi' or 'cram-md5'.
This parameter is case-insensitive. If this parameter is unset
(the default) mutt will try all available methods, in order from
most-secure to least-secure.</P>
<P>Example: set pop_authenticators="digest-md5:apop:user"</P>
<H3><A NAME="pop_auth_try_all"></A> pop_auth_try_all</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If set, Mutt will try all available methods. When unset, Mutt will
only fall back to other authentication methods if the previous
methods are unavailable. If a method is available but authentication
fails, Mutt will not connect to the POP server.</P>
<H3><A NAME="pop_checkinterval"></A> pop_checkinterval</H3>
<P>Type: number<BR>
Default: 60</P>
<P>This variable configures how often (in seconds) POP should look for
new mail.</P>
<H3><A NAME="pop_delete"></A> pop_delete</H3>
<P>Type: quadoption<BR>
Default: ask-no</P>
<P>If set, Mutt will delete successfully downloaded messages from the POP
server when using the fetch-mail function. When unset, Mutt will
download messages but also leave them on the POP server.</P>
<H3><A NAME="pop_host"></A> pop_host</H3>
<P>Type: string<BR>
Default: ""</P>
<P>The name of your POP server for the fetch-mail function. You
can also specify an alternative port, username and password, ie:</P>
<P>[pop[s]://][username[:password]@]popserver[:port]</P>
<H3><A NAME="pop_last"></A> pop_last</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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.</P>
<H3><A NAME="pop_reconnect"></A> pop_reconnect</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>Controls whether or not Mutt will try to reconnect to POP server when
connection lost.</P>
<H3><A NAME="pop_user"></A> pop_user</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Your login name on the POP server.</P>
<P>This variable defaults to your user name on the local machine.</P>
<H3><A NAME="pop_pass"></A> pop_pass</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Specifies the password for your POP account. If unset, Mutt will
prompt you for your password when you open POP mailbox.
<B>Warning</B>: 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.</P>
<H3><A NAME="post_indent_string"></A> post_indent_string</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Similar to the ``
<A HREF="#attribution">$attribution</A>'' variable, Mutt will append this
string after the inclusion of a message which is being replied to.</P>
<H3><A NAME="post_moderated"></A> post_moderated</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>If set to <EM>yes</EM>, Mutt will post article to newsgroup that have
not permissions to posting (e.g. moderated). <B>Note:</B> if newsserver
does not support posting to that newsgroup or totally read-only, that
posting will not have an effect.</P>
<H3><A NAME="postpone"></A> postpone</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>Controls whether or not messages are saved in the ``
<A HREF="#postponed">$postponed</A>''
mailbox when you elect not to send immediately.</P>
<H3><A NAME="postponed"></A> postponed</H3>
<P>Type: path<BR>
Default: "~/postponed"</P>
<P>Mutt allows you to indefinitely ``
<A HREF="#postpone">postpone</A> 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 ``
<A HREF="#postpone">$postpone</A>''
variable.</P>
<H3><A NAME="preconnect"></A> preconnect</H3>
<P>Type: string<BR>
Default: ""</P>
<P>If set, a shell command to be executed if mutt fails to establish
a connection to the server. This is useful for setting up secure
connections, e.g. with ssh(1). If the command returns a nonzero
status, mutt gives up opening the server. Example:</P>
<P>preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net
sleep 20 < /dev/null > /dev/null"</P>
<P>Mailbox 'foo' on mailhost.net can now be reached
as '{localhost:1234}foo'.</P>
<P>NOTE: For this example to work, you must be able to log in to the
remote machine without having to enter a password.</P>
<H3><A NAME="print"></A> print</H3>
<P>Type: quadoption<BR>
Default: ask-no</P>
<P>Controls whether or not Mutt really prints messages.
This is set to <EM>ask-no</EM> by default, because some people
accidentally hit ``p'' often (like me).</P>
<H3><A NAME="print_command"></A> print_command</H3>
<P>Type: path<BR>
Default: "lpr"</P>
<P>This specifies the command pipe that should be used to print messages.</P>
<H3><A NAME="print_decode"></A> print_decode</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Used in connection with the print-message command. If this
option is set, the message is decoded before it is passed to the
external command specified by
<A HREF="#print_command">$print_command</A>. 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.</P>
<H3><A NAME="print_split"></A> print_split</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Used in connection with the print-message command. If this option
is set, the command specified by
<A HREF="#print_command">$print_command</A> is executed once for
each message which is to be printed. If this option is unset,
the command specified by
<A HREF="#print_command">$print_command</A> is executed only once, and
all the messages are concatenated, with a form feed as the message
separator.</P>
<P>Those who use the <B>enscript</B>(1) program's mail-printing mode will
most likely want to set this option.</P>
<H3><A NAME="prompt_after"></A> prompt_after</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If you use an <EM>external</EM> ``
<A HREF="#pager">$pager</A>'', 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.</P>
<H3><A NAME="query_command"></A> query_command</H3>
<P>Type: path<BR>
Default: ""</P>
<P>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 ``
<A HREF="manual-4.html#query">query</A>'' for more
information.</P>
<H3><A NAME="quit"></A> quit</H3>
<P>Type: quadoption<BR>
Default: yes</P>
<P>This variable controls whether ``quit'' and ``exit'' actually quit
from mutt. If it set to yes, they do quit, if it is set to no, they
have no effect, and if it is set to ask-yes or ask-no, you are
prompted for confirmation when you try to quit.</P>
<H3><A NAME="quote_regexp"></A> quote_regexp</H3>
<P>Type: regular expression<BR>
Default: "^([ \t]*[|>:}#])+"</P>
<P>A regular expression used in the internal-pager to determine quoted
sections of text in the body of a message.</P>
<P><B>Note:</B> In order to use the <EM>quoted</EM><B>x</B> patterns in the
internal pager, you need to set this to a regular expression that
matches <EM>exactly</EM> the quote characters at the beginning of quoted
lines.</P>
<H3><A NAME="read_inc"></A> read_inc</H3>
<P>Type: number<BR>
Default: 10</P>
<P>If set to a value greater than 0, Mutt will display which message it
is currently on when reading a mailbox. The message is printed after
<EM>read_inc</EM> messages have been read (e.g., if set to 25, Mutt will
print a message when it reads message 25, and then again when it gets
to message 50). This variable is meant to indicate progress when
reading large mailboxes which may take some time.
When set to 0, only a single message will appear before the reading
the mailbox.</P>
<P>Also see the ``
<A HREF="#write_inc">$write_inc</A>'' variable.</P>
<H3><A NAME="read_only"></A> read_only</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, all folders are opened in read-only mode.</P>
<H3><A NAME="realname"></A> realname</H3>
<P>Type: string<BR>
Default: ""</P>
<P>This variable specifies what "real" or "personal" name should be used
when sending messages.</P>
<P>By default, this is the GECOS field from /etc/passwd. Note that this
variable will <EM>not</EM> be used when the user has set a real name
in the
<A HREF="#from">$from</A> variable.</P>
<H3><A NAME="recall"></A> recall</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>Controls whether or not Mutt recalls postponed messages
when composing a new message. Also see ``
<A HREF="#postponed">$postponed</A>''.</P>
<P>Setting this variable to ``yes'' is not generally useful, and thus not
recommended.</P>
<H3><A NAME="record"></A> record</H3>
<P>Type: path<BR>
Default: ""</P>
<P>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 ``
<A HREF="manual-3.html#my_hdr">my_hdr</A>''
command to create a <EM>Bcc:</EM> field with your email address in it.)</P>
<P>The value of <EM>
<A HREF="#record">$record</A></EM> is overridden by the ``
<A HREF="#force_name">$force_name</A>'' and
``
<A HREF="#save_name">$save_name</A>'' variables, and the ``
<A HREF="manual-3.html#fcc-hook">fcc-hook</A>'' command.</P>
<H3><A NAME="reply_regexp"></A> reply_regexp</H3>
<P>Type: regular expression<BR>
Default: "^(re([\[0-9\]+])*|aw):[ \t]*"</P>
<P>A regular expression used to recognize reply messages when threading
and replying. The default value corresponds to the English "Re:" and
the German "Aw:".</P>
<H3><A NAME="reply_self"></A> reply_self</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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.</P>
<H3><A NAME="reply_to"></A> reply_to</H3>
<P>Type: quadoption<BR>
Default: ask-yes</P>
<P>If set, when replying to a message, Mutt will use the address listed
in the Reply-to: header as the recipient of the reply. If unset,
it will use the address in the From: header field instead. This
option is useful for reading a mailing list that sets the Reply-To:
header field to the list address and you want to send a private
message to the author of a message.</P>
<H3><A NAME="resolve"></A> resolve</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When set, the cursor will be automatically advanced to the next
(possibly undeleted) message whenever a command that modifies the
current message is executed.</P>
<H3><A NAME="reverse_alias"></A> reverse_alias</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
alias juser abd30425@somewhere.net (Joe User)
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>and then you receive mail which contains the following header:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
From: abd30425@somewhere.net
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>It would be displayed in the index menu as ``Joe User'' instead of
``abd30425@somewhere.net.'' This is useful when the person's e-mail
address is not human friendly (like CompuServe addresses).</P>
<H3><A NAME="reverse_name"></A> reverse_name</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>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 <EM>From:</EM> line of
the reply messages is built using the address where you received the
messages you are replying to <B>if</B> that address matches your
alternates. If the variable is unset, or the address that would be
used doesn't match your alternates, the <EM>From:</EM> line will use
your address on the current machine.</P>
<H3><A NAME="reverse_realname"></A> reverse_realname</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variable fine-tunes the behaviour of the
<A HREF="#reverse_name">reverse_name</A> 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
<A HREF="#realname">realname</A> variable.</P>
<H3><A NAME="rfc2047_parameters"></A> rfc2047_parameters</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When this variable is set, Mutt will decode RFC-2047-encoded MIME
parameters. You want to set this variable when mutt suggests you
to save attachments to files named like this:
=?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=</P>
<P>When this variable is set interactively, the change doesn't have
the desired effect before you have changed folders.</P>
<P>Note that this use of RFC 2047's encoding is explicitly,
prohibited by the standard, but nevertheless encountered in the
wild.
Also note that setting this parameter will <EM>not</EM> have the effect
that mutt <EM>generates</EM> this kind of encoding. Instead, mutt will
unconditionally use the encoding specified in RFC 2231.</P>
<H3><A NAME="save_address"></A> save_address</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, mutt will take the sender's full address when choosing a
default folder for saving a mail. If ``
<A HREF="#save_name">$save_name</A>'' or ``
<A HREF="#force_name">$force_name</A>''
is set too, the selection of the fcc folder will be changed as well.</P>
<H3><A NAME="save_empty"></A> save_empty</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When unset, mailboxes which contain no saved messages will be removed
when closed (the exception is ``
<A HREF="#spoolfile">$spoolfile</A>'' which is never removed).
If set, mailboxes are never removed.</P>
<P><B>Note:</B> This only applies to mbox and MMDF folders, Mutt does not
delete MH and Maildir directories.</P>
<H3><A NAME="save_history"></A> save_history</H3>
<P>Type: number<BR>
Default: 0</P>
<P>This variable controls the size of the history saved in the
``
<A HREF="#history_file">$history_file</A>'' file.</P>
<H3><A NAME="save_name"></A> save_name</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>This variable controls how copies of outgoing messages are saved.
When set, a check is made to see if a mailbox specified by the
recipient address exists (this is done by searching for a mailbox in
the ``
<A HREF="#folder">$folder</A>'' directory with the <EM>username</EM> 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
``
<A HREF="#record">$record</A>'' mailbox.</P>
<P>Also see the ``
<A HREF="#force_name">$force_name</A>'' variable.</P>
<H3><A NAME="score"></A> score</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When this variable is <EM>unset</EM>, scoring is turned off. This can
be useful to selectively disable scoring for certain folders when the
``
<A HREF="#score_threshold_delete">$score_threshold_delete</A>'' variable and friends are used.</P>
<H3><A NAME="score_threshold_delete"></A> score_threshold_delete</H3>
<P>Type: number<BR>
Default: -1</P>
<P>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.</P>
<H3><A NAME="score_threshold_flag"></A> score_threshold_flag</H3>
<P>Type: number<BR>
Default: 9999</P>
<P>Messages which have been assigned a score greater than or equal to this
variable's value are automatically marked "flagged".</P>
<H3><A NAME="score_threshold_read"></A> score_threshold_read</H3>
<P>Type: number<BR>
Default: -1</P>
<P>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.</P>
<H3><A NAME="send_charset"></A> send_charset</H3>
<P>Type: string<BR>
Default: "us-ascii:iso-8859-1:utf-8"</P>
<P>A list of character sets for outgoing messages. Mutt will use the
first character set into which the text can be converted exactly.
If your ``
<A HREF="#charset">$charset</A>'' 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".</P>
<H3><A NAME="sendmail"></A> sendmail</H3>
<P>Type: path<BR>
Default: "/usr/sbin/sendmail -oem -oi"</P>
<P>Specifies the program and arguments used to deliver mail sent by Mutt.
Mutt expects that the specified program interprets additional
arguments as recipient addresses.</P>
<H3><A NAME="sendmail_wait"></A> sendmail_wait</H3>
<P>Type: number<BR>
Default: 0</P>
<P>Specifies the number of seconds to wait for the ``
<A HREF="#sendmail">$sendmail</A>'' process
to finish before giving up and putting delivery in the background.</P>
<P>Mutt interprets the value of this variable as follows:</P>
<P>
<DL>
<DT><B>>0 </B><DD><P>number of seconds to wait for sendmail to finish before continuing</P>
<DT><B>0 </B><DD><P>wait forever for sendmail to finish</P>
<DT><B><0 </B><DD><P>always put sendmail in the background without waiting</P>
</DL>
</P>
<P>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.</P>
<H3><A NAME="shell"></A> shell</H3>
<P>Type: path<BR>
Default: ""</P>
<P>Command to use when spawning a subshell. By default, the user's login
shell from /etc/passwd is used.</P>
<H3><A NAME="save_unsubscribed"></A> save_unsubscribed</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When <EM>set</EM>, info about unsubscribed newsgroups will be saved into
``newsrc'' file and into cache.</P>
<H3><A NAME="show_new_news"></A> show_new_news</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If <EM>set</EM>, newsserver will be asked for new newsgroups on entering
the browser. Otherwise, it will be done only once for a newsserver.
Also controls whether or not number of new articles of subscribed
newsgroups will be then checked.</P>
<H3><A NAME="show_only_unread"></A> show_only_unread</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If <EM>set</EM>, only subscribed newsgroups that contain unread articles
will be displayed in browser.</P>
<H3><A NAME="sig_dashes"></A> sig_dashes</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>If set, a line containing ``-- '' will be inserted before your
``
<A HREF="#signature">$signature</A>''. It is <B>strongly</B> recommended that you not unset
this variable unless your ``signature'' contains just your name. The
reason for this is because many software packages use ``-- \n'' to
detect your signature. For example, Mutt has the ability to highlight
the signature in a different color in the builtin pager.</P>
<H3><A NAME="sig_on_top"></A> sig_on_top</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, the signature will be included before any quoted or forwarded
text. It is <B>strongly</B> 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.</P>
<H3><A NAME="signature"></A> signature</H3>
<P>Type: path<BR>
Default: "~/.signature"</P>
<P>Specifies the filename of your signature, which is appended to all
outgoing messages. If the filename ends with a pipe (``|''), it is
assumed that filename is a shell command and input should be read from
its stdout.</P>
<H3><A NAME="simple_search"></A> simple_search</H3>
<P>Type: string<BR>
Default: "~f %s | ~s %s"</P>
<P>Specifies how Mutt should expand a simple search into a real search
pattern. A simple search is one that does not contain any of the ~
operators. See ``
<A HREF="manual-4.html#patterns">patterns</A>'' for more information on search patterns.</P>
<P>For example, if you simply type joe at a search or limit prompt, Mutt
will automatically expand it to the value specified by this variable.
For the default value it would be:</P>
<P>~f joe | ~s joe</P>
<H3><A NAME="smart_wrap"></A> smart_wrap</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>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
``
<A HREF="#markers">$markers</A>'' variable.</P>
<H3><A NAME="smileys"></A> smileys</H3>
<P>Type: regular expression<BR>
Default: "(>From )|(:[-^]?[][)(><}{|/DP])"</P>
<P>The <EM>pager</EM> uses this variable to catch some common false
positives of ``
<A HREF="#quote_regexp">$quote_regexp</A>'', most notably smileys in the beginning
of a line</P>
<H3><A NAME="sleep_time"></A> sleep_time</H3>
<P>Type: number<BR>
Default: 1</P>
<P>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.</P>
<H3><A NAME="sort"></A> sort</H3>
<P>Type: sort order<BR>
Default: date</P>
<P>Specifies how to sort messages in the <EM>index</EM> menu. Valid values
are:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
date or date-sent
date-received
from
mailbox-order (unsorted)
score
size
spam
subject
threads
to
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>You may optionally use the reverse- prefix to specify reverse sorting
order (example: set sort=reverse-date-sent).</P>
<H3><A NAME="sort_alias"></A> sort_alias</H3>
<P>Type: sort order<BR>
Default: alias</P>
<P>Specifies how the entries in the `alias' menu are sorted. The
following are legal values:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
address (sort alphabetically by email address)
alias (sort alphabetically by alias name)
unsorted (leave in order specified in .muttrc)
</PRE>
</CODE></BLOCKQUOTE>
</P>
<H3><A NAME="sort_aux"></A> sort_aux</H3>
<P>Type: sort order<BR>
Default: date</P>
<P>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 ``
<A HREF="#sort">$sort</A>'' can, except
threads (in that case, mutt will just use date-sent). You can also
specify the last- prefix in addition to the reverse- prefix, but last-
must come after reverse-. The last- prefix causes messages to be
sorted against its siblings by which has the last descendant, using
the rest of sort_aux as an ordering. For instance, set sort_aux=last-
date-received would mean that if a new message is received in a
thread, that thread becomes the last one displayed (or the first, if
you have set sort=reverse-threads.) Note: For reversed ``
<A HREF="#sort">$sort</A>''
order
<A HREF="#sort_aux">$sort_aux</A> is reversed again (which is not the right thing to do,
but kept to not break any existing configuration setting).</P>
<H3><A NAME="sort_browser"></A> sort_browser</H3>
<P>Type: sort order<BR>
Default: alpha</P>
<P>Specifies how to sort entries in the file browser. By default, the
entries are sorted alphabetically. Valid values:</P>
<P>
<BLOCKQUOTE><CODE>
<PRE>
alpha (alphabetically)
date
size
unsorted
</PRE>
</CODE></BLOCKQUOTE>
</P>
<P>You may optionally use the reverse- prefix to specify reverse sorting
order (example: set sort_browser=reverse-date).</P>
<H3><A NAME="sort_re"></A> sort_re</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>This variable is only useful when sorting by threads with
``
<A HREF="#strict_threads">$strict_threads</A>'' 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 ``
<A HREF="#reply_regexp">$reply_regexp</A>''. With sort_re unset, mutt will attach
the message whether or not this is the case, as long as the
non-``
<A HREF="#reply_regexp">$reply_regexp</A>'' parts of both messages are identical.</P>
<H3><A NAME="spam_separator"></A> spam_separator</H3>
<P>Type: string<BR>
Default: ","</P>
<P>``
<A HREF="#spam_separator">spam_separator</A>'' 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 ``
<A HREF="#spam_separator">spam_separator</A>'' as a
separator.</P>
<H3><A NAME="spoolfile"></A> spoolfile</H3>
<P>Type: path<BR>
Default: ""</P>
<P>If your spool mailbox is in a non-default place where Mutt cannot find
it, you can specify its location with this variable. Mutt will
automatically set this variable to the value of the environment
variable $MAIL if it is not set.</P>
<H3><A NAME="status_chars"></A> status_chars</H3>
<P>Type: string<BR>
Default: "-*%A"</P>
<P>Controls the characters used by the "%r" indicator in
``
<A HREF="#status_format">$status_format</A>''. The first character is used when the mailbox is
unchanged. The second is used when the mailbox has been changed, and
it needs to be resynchronized. The third is used if the mailbox is in
read-only mode, or if the mailbox will not be written when exiting
that mailbox (You can toggle whether to write changes to a mailbox
with the toggle-write operation, bound by default to "%"). The fourth
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).</P>
<H3><A NAME="status_format"></A> status_format</H3>
<P>Type: string<BR>
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)---"</P>
<P>Controls the format of the status line displayed in the <EM>index</EM>
menu. This string is similar to ``
<A HREF="#index_format">$index_format</A>'', but has its own
set of printf()-like sequences:</P>
<P>
<DL>
<DT><B>%b </B><DD><P>number of mailboxes with new mail *</P>
<DT><B>%d </B><DD><P>number of deleted messages *</P>
<DT><B>%f </B><DD><P>the full pathname of the current mailbox</P>
<DT><B>%F </B><DD><P>number of flagged messages *</P>
<DT><B>%h </B><DD><P>local hostname</P>
<DT><B>%l </B><DD><P>size (in bytes) of the current mailbox *</P>
<DT><B>%L </B><DD><P>size (in bytes) of the messages shown
(i.e., which match the current limit) *</P>
<DT><B>%m </B><DD><P>the number of messages in the mailbox *</P>
<DT><B>%M </B><DD><P>the number of messages shown (i.e., which match the current limit) *</P>
<DT><B>%n </B><DD><P>number of new messages in the mailbox *</P>
<DT><B>%o </B><DD><P>number of old unread messages *</P>
<DT><B>%p </B><DD><P>number of postponed messages *</P>
<DT><B>%P </B><DD><P>percentage of the way through the index</P>
<DT><B>%r </B><DD><P>modified/read-only/won't-write/attach-message indicator,
according to
<A HREF="#status_chars">$status_chars</A></P>
<DT><B>%s </B><DD><P>current sorting mode (
<A HREF="#sort">$sort</A>)</P>
<DT><B>%S </B><DD><P>current aux sorting method (
<A HREF="#sort_aux">$sort_aux</A>)</P>
<DT><B>%t </B><DD><P>number of tagged messages *</P>
<DT><B>%u </B><DD><P>number of unread messages *</P>
<DT><B>%v </B><DD><P>Mutt version string</P>
<DT><B>%V </B><DD><P>currently active limit pattern, if any *</P>
<DT><B>%>X </B><DD><P>right justify the rest of the string and pad with "X"</P>
<DT><B>%|X </B><DD><P>pad to the end of the line with "X"</P>
</DL>
</P>
<P>* = can be optionally printed if nonzero</P>
<P>Some of the above sequences can be used to optionally print a string
if their value is nonzero. For example, you may only want to see the
number of flagged messages if such messages exist, since zero is not
particularly meaningful. To optionally print a string based upon one
of the above sequences, the following construct is used</P>
<P>%?<sequence_char>?<optional_string>?</P>
<P>where <EM>sequence_char</EM> is a character from the table above, and
<EM>optional_string</EM> is the string you would like printed if
<EM>sequence_char</EM> is nonzero. <EM>optional_string</EM> <B>may</B> contain
other sequences as well as normal text, but you may <B>not</B> nest
optional strings.</P>
<P>Here is an example illustrating how to optionally print the number of
new messages in a mailbox:
%?n?%n new messages.?</P>
<P>Additionally you can switch between two strings, the first one, if a
value is zero, the second one, if the value is nonzero, by using the
following construct:
%?<sequence_char>?<if_string>&<else_string>?</P>
<P>You can additionally force the result of any printf-like sequence to
be lowercase by prefixing the sequence character with an underscore
(_) sign. For example, if you want to display the local hostname in
lowercase, you would use:
%_h</P>
<P>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.</P>
<H3><A NAME="status_on_top"></A> status_on_top</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Setting this variable causes the ``status bar'' to be displayed on
the first line of the screen rather than near the bottom.</P>
<H3><A NAME="strict_threads"></A> strict_threads</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If set, threading will only make use of the ``In-Reply-To'' and
``References'' fields when you ``
<A HREF="#sort">$sort</A>'' by message threads. By
default, messages with the same subject are grouped together in
``pseudo threads.'' This may not always be desirable, such as in a
personal mailbox where you might have several unrelated messages with
the subject ``hi'' which will get grouped together.</P>
<H3><A NAME="suspend"></A> suspend</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When <EM>unset</EM>, mutt won't stop when the user presses the terminal's
<EM>susp</EM> key, usually ``control-Z''. This is useful if you run mutt
inside an xterm using a command like xterm -e mutt.</P>
<H3><A NAME="text_flowed"></A> text_flowed</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, mutt will generate text/plain; format=flowed attachments.
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.</P>
<P>Note that
<A HREF="#indent_string">$indent_string</A> is ignored when this option is set.</P>
<H3><A NAME="thread_received"></A> thread_received</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, mutt uses the date received rather than the date sent
to thread messages by subject.</P>
<H3><A NAME="thorough_search"></A> thorough_search</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Affects the <EM>~b</EM> and <EM>~h</EM> search operations described in
section ``
<A HREF="manual-4.html#patterns">patterns</A>'' above. If set, the headers and attachments of
messages to be searched are decoded before searching. If unset,
messages are searched as they appear in the folder.</P>
<H3><A NAME="tilde"></A> tilde</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>When set, the internal-pager will pad blank lines to the bottom of the
screen with a tilde (~).</P>
<H3><A NAME="timeout"></A> timeout</H3>
<P>Type: number<BR>
Default: 600</P>
<P>This variable controls the <EM>number of seconds</EM> Mutt will wait
for a key to be pressed in the main menu before timing out and
checking for new mail. A value of zero or less will cause Mutt
to never time out.</P>
<H3><A NAME="tmpdir"></A> tmpdir</H3>
<P>Type: path<BR>
Default: ""</P>
<P>This variable allows you to specify where Mutt will place its
temporary files needed for displaying and composing messages. If
this variable is not set, the environment variable TMPDIR is
used. If TMPDIR is not set then "/tmp" is used.</P>
<H3><A NAME="to_chars"></A> to_chars</H3>
<P>Type: string<BR>
Default: " +TCFL"</P>
<P>Controls the character used to indicate mail addressed to you. The
first character is the one used when the mail is NOT addressed to your
address (default: space). The second is used when you are the only
recipient of the message (default: +). The third is when your address
appears in the TO header field, but you are not the only recipient of
the message (default: T). The fourth character is used when your
address is specified in the CC header field, but you are not the only
recipient. The fifth character is used to indicate mail that was sent
by <EM>you</EM>. The sixth character is used to indicate when a mail
was sent to a mailing-list you subscribe to (default: L).</P>
<H3><A NAME="tunnel"></A> tunnel</H3>
<P>Type: string<BR>
Default: ""</P>
<P>Setting this variable will cause mutt to open a pipe to a command
instead of a raw socket. You may be able to use this to set up
preauthenticated connections to your IMAP/POP3 server. Example:</P>
<P>tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"</P>
<P>NOTE: For this example to work you must be able to log in to the remote
machine without having to enter a password.</P>
<H3><A NAME="use_8bitmime"></A> use_8bitmime</H3>
<P>Type: boolean<BR>
Default: no</P>
<P><B>Warning:</B> do not set this variable unless you are using a version
of sendmail which supports the -B8BITMIME flag (such as sendmail
8.8.x) or you may not be able to send mail.</P>
<P>When <EM>set</EM>, Mutt will invoke ``
<A HREF="#sendmail">$sendmail</A>'' with the -B8BITMIME
flag when sending 8-bit messages to enable ESMTP negotiation.</P>
<H3><A NAME="use_domain"></A> use_domain</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When set, Mutt will qualify all local addresses (ones without the
@host portion) with the value of ``
<A HREF="#hostname">$hostname</A>''. If <EM>unset</EM>, no
addresses will be qualified.</P>
<H3><A NAME="use_from"></A> use_from</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When <EM>set</EM>, Mutt will generate the `From:' header field when
sending messages. If <EM>unset</EM>, no `From:' header field will be
generated unless the user explicitly sets one using the ``
<A HREF="manual-3.html#my_hdr">my_hdr</A>''
command.</P>
<H3><A NAME="use_idn"></A> use_idn</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When <EM>set</EM>, Mutt will show you international domain names decoded.
Note: You can use IDNs for addresses even if this is <EM>unset</EM>.
This variable only affects decoding.</P>
<H3><A NAME="use_ipv6"></A> use_ipv6</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When <EM>set</EM>, Mutt will look for IPv6 addresses of hosts it tries to
contact. If this option is unset, Mutt will restrict itself to IPv4 addresses.
Normally, the default should work.</P>
<H3><A NAME="user_agent"></A> user_agent</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When <EM>set</EM>, mutt will add a "User-Agent" header to outgoing
messages, indicating which version of mutt was used for composing
them.</P>
<H3><A NAME="visual"></A> visual</H3>
<P>Type: path<BR>
Default: ""</P>
<P>Specifies the visual editor to invoke when the <EM>~v</EM> command is
given in the builtin editor.</P>
<H3><A NAME="wait_key"></A> wait_key</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Controls whether Mutt will ask you to press a key after <EM>shell-
escape</EM>, <EM>pipe-message</EM>, <EM>pipe-entry</EM>, <EM>print-message</EM>,
and <EM>print-entry</EM> commands.</P>
<P>It is also used when viewing attachments with ``
<A HREF="manual-5.html#auto_view">auto_view</A>'', provided
that the corresponding mailcap entry has a <EM>needsterminal</EM> flag,
and the external program is interactive.</P>
<P>When set, Mutt will always ask for a key. When unset, Mutt will wait
for a key only if the external command returned a non-zero status.</P>
<H3><A NAME="weed"></A> weed</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>When set, mutt will weed headers when displaying, forwarding,
printing, or replying to messages.</P>
<H3><A NAME="wrap_search"></A> wrap_search</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Controls whether searches wrap around the end of the mailbox.</P>
<P>When set, searches will wrap around the first (or last) message. When
unset, searches will not wrap.</P>
<H3><A NAME="wrapmargin"></A> wrapmargin</H3>
<P>Type: number<BR>
Default: 0</P>
<P>Controls the size of the margin remaining at the right side of
the terminal when mutt's pager does smart wrapping.</P>
<H3><A NAME="write_inc"></A> write_inc</H3>
<P>Type: number<BR>
Default: 10</P>
<P>When writing a mailbox, a message will be printed every
<EM>write_inc</EM> messages to indicate progress. If set to 0, only a
single message will be displayed before writing a mailbox.</P>
<P>Also see the ``
<A HREF="#read_inc">$read_inc</A>'' variable.</P>
<H3><A NAME="write_bcc"></A> write_bcc</H3>
<P>Type: boolean<BR>
Default: yes</P>
<P>Controls whether mutt writes out the Bcc header when preparing
messages to be sent. Exim users may wish to unset this.</P>
<H3><A NAME="x_comment_to"></A> x_comment_to</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>If <EM>set</EM>, Mutt will add ``X-Comment-To:'' field (that contains full
name of original article author) to article that followuped to newsgroup.</P>
<H3><A NAME="xterm_icon"></A> xterm_icon</H3>
<P>Type: string<BR>
Default: "M%?n?AIL&ail?"</P>
<P>Controls the format of the icon title, as long as xterm_set_titles
is enabled. This string is identical in formatting to the one used by
``
<A HREF="#status_format">$status_format</A>''.</P>
<H3><A NAME="xterm_set_titles"></A> xterm_set_titles</H3>
<P>Type: boolean<BR>
Default: no</P>
<P>Controls whether mutt sets the xterm title bar and icon name
(as long as you're in an appropriate terminal). The default must
be off to force in the validity checking.</P>
<H3><A NAME="xterm_title"></A> xterm_title</H3>
<P>Type: string<BR>
Default: "Mutt with %?m?%m messages&no messages?%?n? [%n NEW]?"</P>
<P>Controls the format of the title bar of the xterm provided that
xterm_set_titles has been set. This string is identical in formatting
to the one used by ``
<A HREF="#status_format">$status_format</A>''.</P>
<H2><A NAME="functions"></A> <A NAME="ss6.4">6.4</A> <A HREF="manual.html#toc6.4">Functions</A>
</H2>
<P>The following is the list of available functions listed by the mapping
in which they are available. The default key setting is given, and an
explanation of what the function does. The key bindings of these
functions can be changed with the
<A HREF="manual-3.html#bind">bind</A>
command.</P>
<H3>generic</H3>
<P>The <EM>generic</EM> menu is not a real menu, but specifies common functions
(such as movement) available in all menus except for <EM>pager</EM> and
<EM>editor</EM>. Changing settings for this menu will affect the default
bindings for all menus (except as noted).</P>
<P>
<PRE>
bottom-page L move to the bottom of the page
current-bottom not bound move current entry to bottom of page
current-middle not bound move current entry to middle of page
current-top not bound move current entry to top of page
enter-command : enter a muttrc command
exit q exit this menu
first-entry = move to the first entry
half-down ] scroll down 1/2 page
half-up [ scroll up 1/2 page
help ? this screen
jump number jump to an index number
last-entry * move to the last entry
middle-page M move to the middle of the page
next-entry j move to the next entry
next-line > scroll down one line
next-page z move to the next page
previous-entry k move to the previous entry
previous-line < scroll up one line
previous-page Z move to the previous page
refresh ^L clear and redraw the screen
search / search for a regular expression
search-next n search for next match
search-opposite not bound search for next match in opposite direction
search-reverse ESC / search backwards for a regular expression
select-entry RET select the current entry
shell-escape ! run a program in a subshell
tag-entry t toggle the tag on the current entry
tag-prefix ; apply next command to tagged entries
tag-prefix-cond not bound apply next function ONLY to tagged messages
top-page H move to the top of the page
what-key not bound display the keycode for a key press
</PRE>
</P>
<H3>index</H3>
<P>
<PRE>
bounce-message b remail a message to another user
change-folder c open a different folder
change-folder-readonly ESC c open a different folder in read only mode
check-traditional-pgp ESC P check for classic pgp
clear-flag W clear a status flag from a message
copy-message C copy a message to a file/mailbox
create-alias a create an alias from a message sender
decode-copy ESC C decode a message and copy it to a file/mailbox
decode-save ESC s decode a message and save it to a file/mailbox
delete-message d delete the current entry
delete-pattern D delete messages matching a pattern
delete-subthread ESC d delete all messages in subthread
delete-thread ^D delete all messages in thread
display-address @ display full address of sender
display-toggle-weed h display message and toggle header weeding
display-message RET display a message
edit e edit the current message
edit-type ^E edit the current message's Content-Type
exit x exit without saving changes
extract-keys ^K extract PGP public keys
fetch-mail G retrieve mail from POP server
flag-message F toggle a message's 'important' flag
forget-passphrase ^F wipe PGP passphrase from memory
forward-message f forward a message with comments
group-reply g reply to all recipients
limit l show only messages matching a pattern
list-reply L reply to specified mailing list
mail m compose a new mail message
mail-key ESC k mail a PGP public key
next-new TAB jump to the next new message
next-subthread ESC n jump to the next subthread
next-thread ^N jump to the next thread
next-undeleted j move to the next undeleted message
next-unread not bound jump to the next unread message
parent-message P jump to parent message in thread
pipe-message | pipe message/attachment to a shell command
previous-new ESC TAB jump to the previous new message
previous-page Z move to the previous page
previous-subthread ESC p jump to previous subthread
previous-thread ^P jump to previous thread
previous-undeleted k move to the last undelete message
previous-unread not bound jump to the previous unread message
print-message p print the current entry
query Q query external program for addresses
quit q save changes to mailbox and quit
read-subthread ESC r mark the current subthread as read
read-thread ^R mark the current thread as read
recall-message R recall a postponed message
reply r reply to a message
resend-message ESC e resend message and preserve MIME structure
save-message s save message/attachment to a file
set-flag w set a status flag on a message
show-version V show the Mutt version number and date
show-limit ESC l show currently active limit pattern, if any
sort-mailbox o sort messages
sort-reverse O sort messages in reverse order
sync-mailbox $ save changes to mailbox
tag-pattern T tag messages matching a pattern
tag-thread ESC t tag/untag all messages in the current thread
toggle-new N toggle a message's 'new' flag
toggle-write % toggle whether the mailbox will be rewritten
undelete-message u undelete the current entry
undelete-pattern U undelete messages matching a pattern
undelete-subthread ESC u undelete all messages in subthread
undelete-thread ^U undelete all messages in thread
untag-pattern ^T untag messages matching a pattern
view-attachments v show MIME attachments
</PRE>
</P>
<H3>pager</H3>
<P>
<PRE>
bottom not bound jump to the bottom of the message
bounce-message b remail a message to another user
change-folder c open a different folder
change-folder-readonly ESC c open a different folder in read only mode
check-traditional-pgp ESC P check for classic pgp
copy-message C copy a message to a file/mailbox
create-alias a create an alias from a message sender
decode-copy ESC C decode a message and copy it to a file/mailbox
decode-save ESC s decode a message and save it to a file/mailbox
delete-message d delete the current entry
delete-subthread ESC d delete all messages in subthread
delete-thread ^D delete all messages in thread
display-address @ display full address of sender
display-toggle-weed h display message and toggle header weeding
edit e edit the current message
edit-type ^E edit the current message's Content-Type
enter-command : enter a muttrc command
exit i return to the main-menu
extract-keys ^K extract PGP public keys
flag-message F toggle a message's 'important' flag
forget-passphrase ^F wipe PGP passphrase from memory
forward-message f forward a message with comments
group-reply g reply to all recipients
half-up not bound move up one-half page
half-down not bound move down one-half page
help ? this screen
list-reply L reply to specified mailing list
mail m compose a new mail message
mail-key ESC k mail a PGP public key
mark-as-new N toggle a message's 'new' flag
next-line RET scroll down one line
next-entry J move to the next entry
next-new TAB jump to the next new message
next-page move to the next page
next-subthread ESC n jump to the next subthread
next-thread ^N jump to the next thread
next-undeleted j move to the next undeleted message
next-unread not bound jump to the next unread message
parent-message P jump to parent message in thread
pipe-message | pipe message/attachment to a shell command
previous-line BackSpace scroll up one line
previous-entry K move to the previous entry
previous-new not bound jump to the previous new message
previous-page - move to the previous page
previous-subthread ESC p jump to previous subthread
previous-thread ^P jump to previous thread
previous-undeleted k move to the last undelete message
previous-unread not bound jump to the previous unread message
print-message p print the current entry
quit Q save changes to mailbox and quit
read-subthread ESC r mark the current subthread as read
read-thread ^R mark the current thread as read
recall-message R recall a postponed message
redraw-screen ^L clear and redraw the screen
reply r reply to a message
save-message s save message/attachment to a file
search / search for a regular expression
search-next n search for next match
search-opposite not bound search for next match in opposite direction
search-reverse ESC / search backwards for a regular expression
search-toggle \ toggle search pattern coloring
shell-escape ! invoke a command in a subshell
show-version V show the Mutt version number and date
skip-quoted S skip beyond quoted text
sync-mailbox $ save changes to mailbox
tag-message t tag a message
toggle-quoted T toggle display of quoted text
top ^ jump to the top of the message
undelete-message u undelete the current entry
undelete-subthread ESC u undelete all messages in subthread
undelete-thread ^U undelete all messages in thread
view-attachments v show MIME attachments
</PRE>
</P>
<H3>alias</H3>
<P>
<PRE>
search / search for a regular expression
search-next n search for next match
search-reverse ESC / search backwards for a regular expression
</PRE>
</P>
<H3>query</H3>
<P>
<PRE>
create-alias a create an alias from a message sender
mail m compose a new mail message
query Q query external program for addresses
query-append A append new query results to current results
search / search for a regular expression
search-next n search for next match
search-opposite not bound search for next match in opposite direction
search-reverse ESC / search backwards for a regular expression
</PRE>
</P>
<H3>attach</H3>
<P>
<PRE>
bounce-message b remail a message to another user
collapse-parts v toggle display of subparts
delete-entry d delete the current entry
display-toggle-weed h display message and toggle header weeding
edit-type ^E edit the current entry's Content-Type
extract-keys ^K extract PGP public keys
forward-message f forward a message with comments
group-reply g reply to all recipients
list-reply L reply to specified mailing list
pipe-entry | pipe message/attachment to a shell command
print-entry p print the current entry
reply r reply to a message
resend-message ESC e resend message and preserve MIME structure
save-entry s save message/attachment to a file
undelete-entry u undelete the current entry
view-attach RET view attachment using mailcap entry if necessary
view-mailcap m force viewing of attachment using mailcap
view-text T view attachment as text
</PRE>
</P>
<H3>compose</H3>
<P>
<PRE>
attach-file a attach a file(s) to this message
attach-message A attach message(s) to this message
attach-key ESC k attach a PGP public key
copy-file C save message/attachment to a file
detach-file D delete the current entry
display-toggle-weed h display message and toggle header weeding
edit-bcc b edit the BCC list
edit-cc c edit the CC list
edit-description d edit attachment description
edit-encoding ^E edit attachment transfer-encoding
edit-fcc f enter a file to save a copy of this message in
edit-from ESC f edit the from: field
edit-file ^X e edit the file to be attached
edit-headers E edit the message with headers
edit e edit the message
edit-mime m edit attachment using mailcap entry
edit-reply-to r edit the Reply-To field
edit-subject s edit the subject of this message
edit-to t edit the TO list
edit-type ^T edit attachment type
filter-entry F filter attachment through a shell command
forget-passphrase ^F wipe PGP passphrase from memory
ispell i run ispell on the message
new-mime n compose new attachment using mailcap entry
pgp-menu p show PGP options
pipe-entry | pipe message/attachment to a shell command
postpone-message P save this message to send later
print-entry l print the current entry
rename-file R rename/move an attached file
send-message y send the message
toggle-unlink u toggle whether to delete file after sending it
view-attach RET view attachment using mailcap entry if necessary
write-fcc w write the message to a folder
</PRE>
</P>
<H3>postpone</H3>
<P>
<PRE>
delete-entry d delete the current entry
undelete-entry u undelete the current entry
</PRE>
</P>
<H3>browser</H3>
<P>
<PRE>
change-dir c change directories
check-new TAB check mailboxes for new mail
enter-mask m enter a file mask
search / search for a regular expression
search-next n search for next match
search-reverse ESC / search backwards for a regular expression
select-new N select a new file in this directory
sort o sort messages
sort-reverse O sort messages in reverse order
toggle-mailboxes TAB toggle whether to browse mailboxes or all files
view-file SPACE view file
subscribe s subscribe to current mailbox (IMAP Only)
unsubscribe u unsubscribe to current mailbox (IMAP Only)
toggle-subscribed T toggle view all/subscribed mailboxes (IMAP Only)
</PRE>
</P>
<H3>pgp</H3>
<P>
<PRE>
view-name % view the key's user id
verify-key c verify a PGP public key
</PRE>
</P>
<H3>editor</H3>
<P>
<PRE>
backspace BackSpace delete the char in front of the cursor
backward-char ^B move the cursor one character to the left
backward-word ESC b move the cursor to the previous word
bol ^A jump to the beginning of the line
buffy-cycle Space cycle among incoming mailboxes
capitalize-word ESC c uppercase the first character in the word
complete TAB complete filename or alias
complete-query ^T complete address with query
delete-char ^D delete the char under the cursor
downcase-word ESC l lowercase all characters in current word
eol ^E jump to the end of the line
forward-char ^F move the cursor one character to the right
forward-word ESC f move the cursor to the next word
history-down not bound scroll down through the history list
history-up not bound scroll up through the history list
kill-eol ^K delete chars from cursor to end of line
kill-eow ESC d delete chars from cursor to end of word
kill-line ^U delete all chars on the line
kill-word ^W delete the word in front of the cursor
quote-char ^V quote the next typed key
transpose-chars not bound transpose character under cursor with previous
upcase-word ESC u uppercase all characters in current word
</PRE>
</P>
<HR>
<A HREF="manual-7.html">Next</A>
<A HREF="manual-5.html">Previous</A>
<A HREF="manual.html#toc6">Contents</A>
</BODY>
</HTML>
