<sect1 id="homepage">
<title>Mutt Home Page</title>
- <para>The official homepage can be found at
+ <para>The official homepage can be found at
<ulink url="http://www.mutt.org/">http://www.mutt.org/</ulink>.</para>
</sect1>
<sect1 id="distribution">
<title>Getting Mutt</title>
- <para>Mutt releases can be downloaded from
+ <para>Mutt releases can be downloaded from
<ulink url="ftp://ftp.mutt.org/mutt/">ftp://ftp.mutt.org/mutt/</ulink>.
- For a list of mirror sites, please refer to
+ For a list of mirror sites, please refer to
<ulink url="http://www.mutt.org/download.html">
http://www.mutt.org/download.html</ulink>.</para>
<para>For nightly tarballs and version control access, please refer to
- the
+ the
<ulink url="http://dev.mutt.org/">Mutt development site</ulink>.</para>
</sect1>
<varlistentry>
<term>Bug Tracking System</term>
<listitem>
- <para>The official Mutt bug tracking system can be found at
+ <para>The official Mutt bug tracking system can be found at
<ulink url="http://bugs.mutt.org/">
http://bugs.mutt.org/</ulink></para>
</listitem>
<varlistentry>
<term>Wiki</term>
<listitem>
- <para>An (unofficial) wiki can be found at
+ <para>An (unofficial) wiki can be found at
<ulink url="http://wiki.mutt.org/">
http://wiki.mutt.org/</ulink>.</para>
</listitem>
<varlistentry>
<term>IRC</term>
<listitem>
- <para>For the IRC user community, visit channel
- <emphasis>#mutt</emphasis>on
+ <para>For the IRC user community, visit channel
+ <emphasis>#mutt</emphasis>on
<ulink url="http://freenode.net/">irc.freenode.net</ulink>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>USENET</term>
<listitem>
- <para>For USENET, see the newsgroup
+ <para>For USENET, see the newsgroup
<ulink url="news:comp.mail.mutt">comp.mail.mutt</ulink>.</para>
</listitem>
</varlistentry>
appreciated, the Mutt developers always look for skilled translators that
help improve and continue to maintain stale translations.</para>
<para>For contributing code patches for new features and bug fixes,
- please refer to the developer pages at
+ please refer to the developer pages at
<ulink url="http://dev.mutt.org/">http://dev.mutt.org/</ulink>for more
details.</para>
</sect1>
<sect1 id="typo">
<title>Typographical Conventions</title>
<para>This section lists typographical conventions followed throughout
- this manual. See table
+ this manual. See table
<xref linkend="tab-typo" />for typographical conventions for special
terms.</para>
<entry>
<literal>printf(3)</literal>
</entry>
- <entry>UNIX manual pages, execute
+ <entry>UNIX manual pages, execute
<literal>man 3 printf</literal></entry>
</row>
<row>
<sect1 id="copyright">
<title>Copyright</title>
- <para>Mutt is Copyright © 1996-2016 Michael R. Elkins
+ <para>Mutt is Copyright © 1996-2016 Michael R. Elkins
<email>me@mutt.org</email>and others.</para>
<para>This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as published
<para>This section is intended as a brief overview of how to use Mutt.
There are many other features which are described elsewhere in the manual.
There is even more information available in the Mutt FAQ and various web
- pages. See the
+ pages. See the
<ulink url="http://www.mutt.org/">Mutt homepage</ulink>for more
details.</para>
<para>The keybindings described in this section are the defaults as
distributed. Your local system administrator may have altered the defaults
- for your site. You can always type
+ for your site. You can always type
<quote>?</quote>in any menu to display the current bindings.</para>
- <para>The first thing you need to do is invoke Mutt, simply by typing
+ <para>The first thing you need to do is invoke Mutt, simply by typing
<literal>mutt</literal>at the command line. There are various command-line
- options, see either the Mutt man page or the
+ options, see either the Mutt man page or the
<link linkend="commandline">reference</link>.</para>
<sect1 id="core-concepts">
<title>Core Concepts</title>
<para>Mutt is a text-based application which interacts with users through
different menus which are mostly line-/entry-based or page-based. A
- line-based menu is the so-called
+ line-based menu is the so-called
<quote>index</quote>menu (listing all messages of the currently opened
- folder) or the
+ folder) or the
<quote>alias</quote>menu (allowing you to select recipients from a list).
- Examples for page-based menus are the
- <quote>pager</quote>(showing one message at a time) or the
+ Examples for page-based menus are the
+ <quote>pager</quote>(showing one message at a time) or the
<quote>help</quote>menu listing all available key bindings.</para>
<para>The user interface consists of a context sensitive help line at the
top, the menu's contents followed by a context sensitive status line and
Mutt supports a rich config file syntax to make even complex
configuration files readable and commentable.</para>
<para>Because Mutt allows for customizing almost all key bindings, there
- are so-called
+ are so-called
<quote>functions</quote>which can be executed manually (using the command
line) or in macros. Macros allow the user to bind a sequence of commands
to a single key or a short key sequence instead of repeating a sequence
of actions over and over.</para>
<para>Many commands (such as saving or copying a message to another
folder) can be applied to a single message or a set of messages
- (so-called
+ (so-called
<quote>tagged</quote>messages). To help selecting messages, Mutt provides
a rich set of message patterns (such as recipients, sender, body
contents, date sent/received, etc.) which can be combined into complex
- expressions using the boolean
- <emphasis>and</emphasis>and
+ expressions using the boolean
+ <emphasis>and</emphasis>and
<emphasis>or</emphasis>operations as well as negating. These patterns can
also be used to (for example) search for messages or to limit the index
to show only matching messages.</para>
- <para>Mutt supports a
+ <para>Mutt supports a
<quote>hook</quote>concept which allows the user to execute arbitrary
configuration commands and functions in certain situations such as
entering a folder, starting a new message or replying to an existing one.
even implementing auto-archiving based on a per-folder basis and much
more.</para>
<para>Besides an interactive mode, Mutt can also be used as a
- command-line tool only send messages. It also supports a
- <literal>mailx(1)</literal>-compatible interface, see
+ command-line tool only send messages. It also supports a
+ <literal>mailx(1)</literal>-compatible interface, see
<xref linkend="tab-commandline-options" />for a complete list of
command-line options.</para>
</sect1>
turned on and off, it can be themed and the list style can be
configured.</para>
<para>This part of the manual is suitable for beginners. If you already
- know Mutt you could skip ahead to the main
+ know Mutt you could skip ahead to the main
<link linkend="sidebar">Sidebar guide</link>. If you just want to get
- started, you could use the sample
+ started, you could use the sample
<link linkend="sidebar-muttrc">Sidebar muttrc</link>.</para>
- <para>To check if Mutt supports
- <quote>Sidebar</quote>, look for the string
+ <para>To check if Mutt supports
+ <quote>Sidebar</quote>, look for the string
<literal>+USE_SIDEBAR</literal>in the mutt version.</para>
<screen>mutt -v</screen>
<para>
|
|
</screen>
- <para>This user has four mailboxes:
- <quote>Fruit</quote>,
- <quote>Cars</quote>,
- <quote>Animals</quote>and
+ <para>This user has four mailboxes:
+ <quote>Fruit</quote>,
+ <quote>Cars</quote>,
+ <quote>Animals</quote>and
<quote>Seas</quote>.</para>
- <para>The current, open, mailbox is
+ <para>The current, open, mailbox is
<quote>Fruit</quote>. We can also see information about the other
- mailboxes. For example: The
+ mailboxes. For example: The
<quote>Animals</quote>mailbox contains, 1 flagged email, 2 new emails
out of a total of 6 emails.</para>
<sect3 id="intro-sidebar-navigation">
<title>Navigation</title>
- <para>The Sidebar adds some new
+ <para>The Sidebar adds some new
<link linkend="sidebar-functions">functions</link>to Mutt.</para>
- <para>The user pressed the
- <quote>c</quote>key to
- <literal><change-folder></literal>to the
+ <para>The user pressed the
+ <quote>c</quote>key to
+ <literal><change-folder></literal>to the
<quote>Animals</quote>mailbox. The Sidebar automatically updated the
indicator to match.</para>
<screen>
bind index,pager \CN sidebar-next <emphasis role="comment"># Ctrl-Shift-N - Next Mailbox</emphasis>
bind index,pager \CO sidebar-open <emphasis role="comment"># Ctrl-Shift-O - Open Highlighted Mailbox</emphasis>
</screen>
- <para>Press
- <quote>Ctrl-Shift-N</quote>(Next mailbox) twice will move the Sidebar
- <emphasis role="bold">highlight</emphasis>to down to the
+ <para>Press
+ <quote>Ctrl-Shift-N</quote>(Next mailbox) twice will move the Sidebar
+ <emphasis role="bold">highlight</emphasis>to down to the
<quote>Seas</quote>mailbox.</para>
<screen>
Fruit [1] 3/8| 1 Jan 03 Tia Gibson (362) Caiman
|
</screen>
<note>
- <para>Functions
- <literal><sidebar-next></literal>and
- <literal><sidebar-prev></literal>move the Sidebar
- <emphasis role="bold">highlight</emphasis>. They
+ <para>Functions
+ <literal><sidebar-next></literal>and
+ <literal><sidebar-prev></literal>move the Sidebar
+ <emphasis role="bold">highlight</emphasis>. They
<emphasis role="bold">do not</emphasis>change the open
mailbox.</para>
</note>
- <para>Press
+ <para>Press
<quote>Ctrl-Shift-O</quote>(
<literal><sidebar-open></literal>) to open the highlighted
mailbox.</para>
<sect4 id="intro-sidebar-basics">
<title>Sidebar Basics</title>
- <para>The most important variable is
- <literal>$sidebar_visible</literal>. You can set this in your
- <quote>muttrc</quote>, or bind a key to the function
+ <para>The most important variable is
+ <literal>$sidebar_visible</literal>. You can set this in your
+ <quote>muttrc</quote>, or bind a key to the function
<literal><sidebar-toggle-visible></literal>.</para>
<screen>
set sidebar_visible <emphasis role="comment"># Make the Sidebar visible by default</emphasis>
<title>Sidebar Format String</title>
<para>
<literal>$sidebar_format</literal>allows you to customize the
- Sidebar display. For an introduction, read
+ Sidebar display. For an introduction, read
<link linkend="index-format">format strings</link>including the
- section about
+ section about
<link linkend="formatstrings-conditionals">
conditionals</link>.</para>
- <para>The default value is:
+ <para>The default value is:
<literal>%B%* %n</literal></para>
- <para>A more detailed value is:
+ <para>A more detailed value is:
<literal>%B%?F? [%F]?%* %?N?%N/?%S</literal></para>
<itemizedlist>
<title>Which breaks down as:</title>
</listitem>
<listitem>
<para>
- <literal>%?F? [%F]?</literal>- If flagged emails
+ <literal>%?F? [%F]?</literal>- If flagged emails
<literal>[%F]</literal>, otherwise nothing</para>
</listitem>
<listitem>
</listitem>
<listitem>
<para>
- <literal>%?N?%N/?</literal>- If new emails
+ <literal>%?N?%N/?</literal>- If new emails
<literal>%N/</literal>, otherwise nothing</para>
</listitem>
<listitem>
<row>
<entry>%n</entry>
<entry>*</entry>
- <entry>If there's new mail, display
+ <entry>If there's new mail, display
<quote>N</quote>, otherwise nothing</entry>
</row>
<row>
<entry>%!</entry>
<entry></entry>
<entry>
- <quote>!</quote>: one flagged message;
- <quote>!!</quote>: two flagged messages;
+ <quote>!</quote>: one flagged message;
+ <quote>!!</quote>: two flagged messages;
<quote>n!</quote>: n flagged messages (for n > 2).
Otherwise prints nothing.</entry>
</row>
<row>
<entry>%>X</entry>
<entry></entry>
- <entry>Right justify the rest of the string and pad with
+ <entry>Right justify the rest of the string and pad with
<quote>X</quote></entry>
</row>
<row>
<entry>%|X</entry>
<entry></entry>
- <entry>Pad to the end of the line with
+ <entry>Pad to the end of the line with
<quote>X</quote></entry>
</row>
<row>
<entry>%*X</entry>
<entry></entry>
- <entry>Soft-fill with character
+ <entry>Soft-fill with character
<quote>X</quote>as pad</entry>
</row>
</tbody>
</tgroup>
</table>
<para>* = Can be optionally printed if nonzero</para>
- <para>† = To use this expandos, you must first:
+ <para>† = To use this expandos, you must first:
<screen>set mail_check_stats</screen></para>
<para>‡ = Only applicable to the current folder</para>
<para>Here are some examples. They show the number of (F)lagged,
<title>Abbreviating Mailbox Names</title>
<para>
<literal>$sidebar_delim_chars</literal>tells Sidebar how to split
- up mailbox paths. For local directories use
- <quote>/</quote>; for IMAP folders use
+ up mailbox paths. For local directories use
+ <quote>/</quote>; for IMAP folders use
<quote>.</quote></para>
<sect5 id="intro-sidebar-abbrev-ex1">
<sect4 id="intro-sidebar-limit">
<title>Limiting the Number of Mailboxes</title>
<para>If you have a lot of mailboxes, sometimes it can be useful to
- hide the ones you aren't using.
+ hide the ones you aren't using.
<literal>$sidebar_new_mail_only</literal>tells Sidebar to only show
mailboxes that contain new, or flagged, email.</para>
- <para>If you want some mailboxes to be always visible, then use the
+ <para>If you want some mailboxes to be always visible, then use the
<literal>sidebar_whitelist</literal>command. It takes a list of
mailboxes as parameters.</para>
<screen>
color sidebar_new green default <emphasis role="comment"># Green</emphasis>
color sidebar_ordinary default default <emphasis role="comment"># Default colors</emphasis>
color sidebar_flagged red default <emphasis role="comment"># Red</emphasis>
-color sidebar_divider color8 default
+color sidebar_divider color8 default
<emphasis role="comment"># Dark grey</emphasis>
</screen>
<para>There is a priority order when coloring Sidebar mailboxes. e.g.
- If a mailbox has new mail it will have the
+ If a mailbox has new mail it will have the
<literal>sidebar_new</literal>color, even if it also contains flagged
mails.</para>
<sect1 id="menus">
<title>Moving Around in Menus</title>
<para>The most important navigation keys common to line- or entry-based
- menus are shown in
- <xref linkend="tab-keys-nav-line" />and in
+ menus are shown in
+ <xref linkend="tab-keys-nav-line" />and in
<xref linkend="tab-keys-nav-page" />for page-based menus.</para>
<table id="tab-keys-nav-line">
<title>Introduction</title>
<para>Mutt has a built-in line editor for inputting text, e.g. email
addresses or filenames. The keys used to manipulate text input are very
- similar to those of Emacs. See
+ similar to those of Emacs. See
<xref linkend="tab-keys-editor" />for a full reference of available
functions, their default key bindings, and short descriptions.</para>
</tbody>
</tgroup>
</table>
- <para>You can remap the
- <emphasis>editor</emphasis>functions using the
+ <para>You can remap the
+ <emphasis>editor</emphasis>functions using the
<link linkend="bind">
<command>bind</command>
</link>command. For example, to make the <Delete> key delete the
<sect2 id="editing-history">
<title>History</title>
<para>Mutt maintains a history for the built-in editor. The number of
- items is controlled by the
+ items is controlled by the
<link linkend="history">$history</link>variable and can be made
- persistent using an external file specified using
+ persistent using an external file specified using
<link linkend="history-file">$history_file</link>. You may cycle
- through them at an editor prompt by using the
- <literal><history-up></literal>and/or
+ through them at an editor prompt by using the
+ <literal><history-up></literal>and/or
<literal><history-down></literal>commands. Mutt will remember the
currently entered text as you cycle through history, and will wrap
around to the initial entry line.</para>
<title>Reading Mail</title>
<para>Similar to many other mail clients, there are two modes in which
mail is read in Mutt. The first is a list of messages in the mailbox,
- which is called the
+ which is called the
<quote>index</quote>menu in Mutt. The second mode is the display of the
- message contents. This is called the
+ message contents. This is called the
<quote>pager.</quote></para>
<para>The next few sections describe the functions provided in each of
these modes.</para>
<sect2 id="index-menu">
<title>The Message Index</title>
<para>Common keys used to navigate through and manage messages in the
- index are shown in
+ index are shown in
<xref linkend="tab-key-index" />. How messages are presented in the
- index menu can be customized using the
+ index menu can be customized using the
<link linkend="index-format">$index_format</link>variable.</para>
<table id="tab-key-index">
</table>
<para>In addition to who sent the message and the subject, a short
summary of the disposition of each message is printed beside the
- message number. Zero or more of the
- <quote>flags</quote>in
+ message number. Zero or more of the
+ <quote>flags</quote>in
<xref linkend="tab-msg-status-flags" />may appear, some of which can be
- turned on or off using these functions:
- <literal><set-flag></literal>and
- <literal><clear-flag></literal>bound by default to
- <quote>w</quote>and
+ turned on or off using these functions:
+ <literal><set-flag></literal>and
+ <literal><clear-flag></literal>bound by default to
+ <quote>w</quote>and
<quote>W</quote>respectively.</para>
- <para>Furthermore, the flags in
+ <para>Furthermore, the flags in
<xref linkend="tab-msg-recip-flags" />reflect who the message is
- addressed to. They can be customized with the
+ addressed to. They can be customized with the
<link linkend="to-chars">$to_chars</link>variable.</para>
<table id="tab-msg-status-flags">
<sect2 id="pager-menu">
<title>The Pager</title>
<para>By default, Mutt uses its built-in pager to display the contents
- of messages (an external pager such as
- <literal>less(1)</literal>can be configured, see
+ of messages (an external pager such as
+ <literal>less(1)</literal>can be configured, see
<link linkend="pager">$pager</link>variable). The pager is very similar
- to the Unix program
+ to the Unix program
<literal>less(1)</literal>though not nearly as featureful.</para>
<table id="tab-key-pager">
</tbody>
</tgroup>
</table>
- <para>In addition to key bindings in
+ <para>In addition to key bindings in
<xref linkend="tab-key-pager" />, many of the functions from the index
- menu are also available in the pager, such as
- <literal><delete-message></literal>or
+ menu are also available in the pager, such as
+ <literal><delete-message></literal>or
<literal><copy-message></literal>(this is one advantage over
using an external pager to view messages).</para>
<para>Also, the internal pager supports a couple other advanced
- features. For one, it will accept and translate the
+ features. For one, it will accept and translate the
<quote>standard</quote>nroff sequences for bold and underline. These
sequences are a series of either the letter, backspace (
- <quote>^H</quote>), the letter again for bold or the letter, backspace,
+ <quote>^H</quote>), the letter again for bold or the letter, backspace,
<quote>_</quote>for denoting underline. Mutt will attempt to display
these in bold and underline respectively if your terminal supports
- them. If not, you can use the bold and underline
- <link linkend="color">color</link>objects to specify a
+ them. If not, you can use the bold and underline
+ <link linkend="color">color</link>objects to specify a
<command>color</command>or mono attribute for them.</para>
<para>Additionally, the internal pager supports the ANSI escape
sequences for character attributes. Mutt translates them into the
<emphasis>Ps</emphasis>;
<emphasis>Ps</emphasis>;..
<emphasis>Ps</emphasis>;m</screen>
- <para>where
- <emphasis>Ps</emphasis>can be one of the codes shown in
+ <para>where
+ <emphasis>Ps</emphasis>can be one of the codes shown in
<xref linkend="tab-ansi-esc" />.</para>
<table id="tab-ansi-esc">
<row>
<entry>3
<emphasis><color></emphasis></entry>
- <entry>Foreground color is
- <emphasis><color></emphasis>(see
+ <entry>Foreground color is
+ <emphasis><color></emphasis>(see
<xref linkend="tab-color" />)</entry>
</row>
<row>
<entry>4
<emphasis><color></emphasis></entry>
- <entry>Background color is
- <emphasis><color></emphasis>(see
+ <entry>Background color is
+ <emphasis><color></emphasis>(see
<xref linkend="tab-color" />)</entry>
</row>
</tbody>
</tbody>
</tgroup>
</table>
- <para>Mutt uses these attributes for handling
+ <para>Mutt uses these attributes for handling
<literal>text/enriched</literal>messages, and they can also be used by
- an external
+ an external
<link linkend="auto-view">autoview</link>script for highlighting
purposes.</para>
<note>
</note>
<note>
<para>Note that the search commands in the pager take regular
- expressions, which are not quite the same as the more complex
+ expressions, which are not quite the same as the more complex
<link linkend="patterns">patterns</link>used by the search command in
the index. This is because patterns are used to select messages by
criteria whereas the pager already displays a selected
<sect2 id="threads">
<title>Threaded Mode</title>
- <para>So-called
+ <para>So-called
<quote>threads</quote>provide a hierarchy of messages where replies are
linked to their parent message(s). This organizational form is
extremely useful in mailing lists where different parts of the
discussion diverge. Mutt displays threads as a tree structure.</para>
- <para>In Mutt, when a mailbox is
- <link linkend="sort">sorted</link>by
+ <para>In Mutt, when a mailbox is
+ <link linkend="sort">sorted</link>by
<emphasis>threads</emphasis>, there are a few additional functions
- available in the
- <emphasis>index</emphasis>and
- <emphasis>pager</emphasis>modes as shown in
+ available in the
+ <emphasis>index</emphasis>and
+ <emphasis>pager</emphasis>modes as shown in
<xref linkend="tab-key-threads" />.</para>
<table id="tab-key-threads">
<para>Collapsing a thread displays only the first message in the thread
and hides the others. This is useful when threads contain so many
messages that you can only see a handful of threads on the screen. See
- %M in
+ %M in
<link linkend="index-format">$index_format</link>. For example, you
- could use
- <quote>%?M?(#%03M)&(%4l)?</quote>in
+ could use
+ <quote>%?M?(#%03M)&(%4l)?</quote>in
<link linkend="index-format">$index_format</link>to optionally display
- the number of hidden messages if the thread is collapsed. The
+ the number of hidden messages if the thread is collapsed. The
<literal>
%?<char>?<if-part>&<else-part>?</literal>syntax
- is explained in detail in
+ is explained in detail in
<link linkend="formatstrings-conditionals">format string
conditionals</link>.</para>
<para>Technically, every reply should contain a list of its parent
messages in the thread tree, but not all do. In these cases, Mutt
- groups them by subject which can be controlled using the
+ groups them by subject which can be controlled using the
<link linkend="strict-threads">$strict_threads</link>variable.</para>
</sect2>
<sect2 id="reading-misc">
<title>Miscellaneous Functions</title>
- <para>In addition, the
- <emphasis>index</emphasis>and
+ <para>In addition, the
+ <emphasis>index</emphasis>and
<emphasis>pager</emphasis>menus have these interesting
functions:</para>
<variablelist>
<anchor id="create-alias" />(default: a)</term>
<listitem>
<para>Creates a new alias based upon the current message (or
- prompts for a new one). Once editing is complete, an
+ prompts for a new one). Once editing is complete, an
<link linkend="alias">
<command>alias</command>
- </link>command is added to the file specified by the
+ </link>command is added to the file specified by the
<link linkend="alias-file">$alias_file</link>variable for future
use</para>
<note>
- <para>Mutt does not read the
+ <para>Mutt does not read the
<link linkend="alias-file">$alias_file</link>upon startup so
- you must explicitly
+ you must explicitly
<link linkend="source">
<command>source</command>
</link>the file.</para>
<anchor id="check-traditional-pgp" />(default: Esc P)</term>
<listitem>
<para>This function will search the current message for content
- signed or encrypted with PGP the
+ signed or encrypted with PGP the
<quote>traditional</quote>way, that is, without proper MIME
tagging. Technically, this function will temporarily change the
MIME content types of the body parts containing PGP data; this is
- similar to the
+ similar to the
<link linkend="edit-type">
<literal><edit-type></literal>
</link>function's effect.</para>
content type to fix, for instance, bogus character set
parameters. When invoked from the index or from the pager, you'll
have the opportunity to edit the top-level attachment's content
- type. On the
+ type. On the
<link linkend="attach-menu">attachment menu</link>, you can
change any attachment's content type. These changes are not
persistent, and get lost upon changing folders.</para>
- <para>Note that this command is also available on the
+ <para>Note that this command is also available on the
<link linkend="compose-menu">compose menu</link>. There, it's
used to fine-tune the properties of attachments you are going to
send.</para>
<varlistentry>
<term>
<literal><enter-command></literal>
- <anchor id="enter-command" />(default:
+ <anchor id="enter-command" />(default:
<quote>:</quote>)</term>
<listitem>
<para>This command is used to execute any command you would
normally put in a configuration file. A common use is to check
- the settings of variables, or in conjunction with
+ the settings of variables, or in conjunction with
<link linkend="macro">macros</link>to change settings on the
fly.</para>
</listitem>
<anchor id="list-reply" />(default: L)</term>
<listitem>
<para>Reply to the current or tagged message(s) by extracting any
- addresses which match the regular expressions given by the
+ addresses which match the regular expressions given by the
<link linkend="lists">
- <command>lists</command>or
- <command>subscribe</command></link>commands, but also honor any
- <literal>Mail-Followup-To</literal>header(s) if the
+ <command>lists</command>or
+ <command>subscribe</command></link>commands, but also honor any
+ <literal>Mail-Followup-To</literal>header(s) if the
<link linkend="honor-followup-to">
$honor_followup_to</link>configuration variable is set. In
- addition, the
- <literal>List-Post</literal>header field is examined for
+ addition, the
+ <literal>List-Post</literal>header field is examined for
<literal>mailto:</literal>URLs specifying a mailing list address.
Using this when replying to messages posted to mailing lists
helps avoid duplicate copies being sent to the author of the
<anchor id="pipe-message" />(default: |)</term>
<listitem>
<para>Asks for an external Unix command and pipes the current or
- tagged message(s) to it. The variables
- <link linkend="pipe-decode">$pipe_decode</link>,
- <link linkend="pipe-split">$pipe_split</link>,
- <link linkend="pipe-sep">$pipe_sep</link>and
+ tagged message(s) to it. The variables
+ <link linkend="pipe-decode">$pipe_decode</link>,
+ <link linkend="pipe-split">$pipe_split</link>,
+ <link linkend="pipe-sep">$pipe_sep</link>and
<link linkend="wait-key">$wait_key</link>control the exact
behavior of this function.</para>
</listitem>
message. This function is best described as "recall from
arbitrary folders". It can conveniently be used to forward MIME
messages while preserving the original mail structure. Note that
- the amount of headers included here depends on the value of the
+ the amount of headers included here depends on the value of the
<link linkend="weed">$weed</link>variable.</para>
<para>This function is also available from the attachment menu.
You can use this to easily resend a message which was included
- with a bounce message as a
+ with a bounce message as a
<literal>message/rfc822</literal>body part.</para>
</listitem>
</varlistentry>
<literal><shell-escape></literal>
<anchor id="shell-escape" />(default: !)</term>
<listitem>
- <para>Asks for an external Unix command and executes it. The
+ <para>Asks for an external Unix command and executes it. The
<link linkend="wait-key">$wait_key</link>can be used to control
whether Mutt will wait for a key to be pressed when the command
returns (presumably to let the user read the output of the
<literal><toggle-quoted></literal>
<anchor id="toggle-quoted" />(default: T)</term>
<listitem>
- <para>The pager uses the
+ <para>The pager uses the
<link linkend="quote-regexp">$quote_regexp</link>variable to
detect quoted text when displaying the body of the message. This
function toggles the display of the quoted material in the
<sect2 id="sending-intro">
<title>Introduction</title>
- <para>The bindings shown in
- <xref linkend="tab-key-send" />are available in the
- <emphasis>index</emphasis>and
+ <para>The bindings shown in
+ <xref linkend="tab-key-send" />are available in the
+ <emphasis>index</emphasis>and
<emphasis>pager</emphasis>to start a new message.</para>
<table id="tab-key-send">
</table>
<para>
<emphasis>Bouncing</emphasis>a message sends the message as-is to the
- recipient you specify.
+ recipient you specify.
<emphasis>Forwarding</emphasis>a message allows you to add comments or
modify the message you are forwarding. These items are discussed in
- greater detail in the next section
+ greater detail in the next section
<quote>
<link linkend="forwarding-mail">Forwarding and Bouncing
Mail</link>.</quote></para>
- <para>Mutt will then enter the
+ <para>Mutt will then enter the
<emphasis>compose</emphasis>menu and prompt you for the recipients to
- place on the
- <quote>To:</quote>header field when you hit
+ place on the
+ <quote>To:</quote>header field when you hit
<literal>m</literal>to start a new message. Next, it will ask you for
- the
+ the
<quote>Subject:</quote>field for the message, providing a default if
you are replying to or forwarding a message. You again have the chance
to adjust recipients, subject, and security settings right before
- actually sending the message. See also
- <link linkend="askcc">$askcc</link>,
- <link linkend="askbcc">$askbcc</link>,
- <link linkend="autoedit">$autoedit</link>,
- <link linkend="bounce">$bounce</link>,
- <link linkend="fast-reply">$fast_reply</link>, and
+ actually sending the message. See also
+ <link linkend="askcc">$askcc</link>,
+ <link linkend="askbcc">$askbcc</link>,
+ <link linkend="autoedit">$autoedit</link>,
+ <link linkend="bounce">$bounce</link>,
+ <link linkend="fast-reply">$fast_reply</link>, and
<link linkend="include">$include</link>for changing how and if Mutt
asks these questions.</para>
<para>When replying, Mutt fills these fields with proper values
<term>Group reply</term>
<listitem>
<para>Reply to the author as well to all recipients except you;
- this consults
+ this consults
<link linkend="alternates">
<command>alternates</command>
</link>.</para>
<term>List reply</term>
<listitem>
<para>Reply to all mailing list addresses found, either specified
- via configuration or auto-detected. See
+ via configuration or auto-detected. See
<xref linkend="lists" />for details.</para>
</listitem>
</varlistentry>
</variablelist>
<para>After getting recipients for new messages, forwards or replies,
- Mutt will then automatically start your
- <link linkend="editor">$editor</link>on the message body. If the
+ Mutt will then automatically start your
+ <link linkend="editor">$editor</link>on the message body. If the
<link linkend="edit-headers">$edit_headers</link>variable is set, the
headers will be at the top of the message in your editor; the message
body should start on a new line after the existing blank line at the
end of headers. Any messages you are replying to will be added in sort
- order to the message, with appropriate
- <link linkend="attribution">$attribution</link>,
- <link linkend="indent-string">$indent_string</link>and
+ order to the message, with appropriate
+ <link linkend="attribution">$attribution</link>,
+ <link linkend="indent-string">$indent_string</link>and
<link linkend="post-indent-string">$post_indent_string</link>. When
- forwarding a message, if the
+ forwarding a message, if the
<link linkend="mime-forward">$mime_forward</link>variable is unset, a
- copy of the forwarded message will be included. If you have specified a
+ copy of the forwarded message will be included. If you have specified a
<link linkend="signature">$signature</link>, it will be appended to the
message.</para>
<para>Once you have finished editing the body of your mail message, you
- are returned to the
- <emphasis>compose</emphasis>menu providing the functions shown in
+ are returned to the
+ <emphasis>compose</emphasis>menu providing the functions shown in
<xref linkend="tab-func-compose" />to modify, send or postpone the
message.</para>
<entry>
<literal><edit-fcc></literal>
</entry>
- <entry>specify an
+ <entry>specify an
<quote>Fcc</quote>mailbox</entry>
</row>
<row>
</tgroup>
</table>
<para>The compose menu is also used to edit the attachments for a
- message which can be either files or other messages. The
+ message which can be either files or other messages. The
<literal><attach-message></literal>function to will prompt you
for a folder to attach messages from. You can now tag messages in that
folder and they will be attached to the message you are sending.</para>
<note>
<para>Note that certain operations like composing a new mail,
replying, forwarding, etc. are not permitted when you are in that
- folder. The %r in
- <link linkend="status-format">$status_format</link>will change to a
+ folder. The %r in
+ <link linkend="status-format">$status_format</link>will change to a
<quote>A</quote>to indicate that you are in attach-message
mode.</para>
</note>
<sect2 id="edit-header">
<title>Editing the Message Header</title>
- <para>When editing the header because of
+ <para>When editing the header because of
<link linkend="edit-headers">$edit_headers</link>being set, there are a
several pseudo headers available which will not be included in sent
messages but trigger special Mutt behavior.</para>
<literal>Fcc:</literal>
<emphasis>filename</emphasis>
</para>
- <para>as a header, Mutt will pick up
- <emphasis>filename</emphasis>just as if you had used the
- <literal><edit-fcc></literal>function in the
+ <para>as a header, Mutt will pick up
+ <emphasis>filename</emphasis>just as if you had used the
+ <literal><edit-fcc></literal>function in the
<emphasis>compose</emphasis>menu. It can later be changed from the
compose menu.</para>
</sect3>
<para>You can also attach files to your message by specifying</para>
<para>
<literal>Attach:</literal>
- <emphasis>filename</emphasis>[
+ <emphasis>filename</emphasis>[
<emphasis>description</emphasis>]</para>
- <para>where
- <emphasis>filename</emphasis>is the file to attach and
+ <para>where
+ <emphasis>filename</emphasis>is the file to attach and
<emphasis>description</emphasis>is an optional string to use as the
description of the attached file. Spaces in filenames have to be
escaped using backslash (
<title>Pgp: Pseudo Header</title>
<para>If you want to use PGP, you can specify</para>
<para>
- <literal>Pgp:</literal>[
- <literal>E</literal>|
- <literal>S</literal>|
+ <literal>Pgp:</literal>[
+ <literal>E</literal>|
+ <literal>S</literal>|
<literal>S</literal>
<emphasis><id></emphasis>]</para>
<para>
- <quote>E</quote>selects encryption,
- <quote>S</quote>selects signing and
- <quote>S<id></quote>selects signing with the given key, setting
+ <quote>E</quote>selects encryption,
+ <quote>S</quote>selects signing and
+ <quote>S<id></quote>selects signing with the given key, setting
<link linkend="pgp-sign-as">$pgp_sign_as</link>permanently. The
selection can later be changed in the compose menu.</para>
</sect3>
<sect3 id="in-reply-to-header">
<title>In-Reply-To: Header</title>
- <para>When replying to messages, the
+ <para>When replying to messages, the
<emphasis>In-Reply-To:</emphasis>header contains the Message-Id of
the message(s) you reply to. If you remove or modify its value, Mutt
- will not generate a
+ will not generate a
<emphasis>References:</emphasis>field, which allows you to create a
new message thread, for example to create a new message to a mailing
list without having to enter the mailing list's address.</para>
<para>If you intend to start a new thread by replying, please make
- really sure you remove the
+ really sure you remove the
<emphasis>In-Reply-To:</emphasis>header in your editor. Otherwise,
though you'll produce a technically valid reply, some netiquette
- guardians will be annoyed by this so-called
+ guardians will be annoyed by this so-called
<quote>thread hijacking</quote>.</para>
</sect3>
</sect2>
<para>In these cases, you are dropped into a menu with a list of keys
from which you can select one. When you quit this menu, or Mutt can't
find any matching keys, you are prompted for a user ID. You can, as
- usually, abort this prompt using
+ usually, abort this prompt using
<literal>^G</literal>. When you do so, Mutt will return to the compose
screen.</para>
<para>Once you have successfully finished the key selection, the
message will be encrypted using the selected public keys when sent
out.</para>
- <para>Most fields of the entries in the key selection menu (see also
+ <para>Most fields of the entries in the key selection menu (see also
<link linkend="pgp-entry-format">$pgp_entry_format</link>) have obvious
meanings. But some explanations on the capabilities, flags, and
validity fields are in order.</para>
<para>The flags sequence (
- <quote>%f</quote>) will expand to one of the flags in
+ <quote>%f</quote>) will expand to one of the flags in
<xref linkend="tab-pgp-menuflags" />.</para>
<table id="tab-pgp-menuflags">
<quote>-</quote>) means that the key cannot be used for encryption. A
dot (
<quote>.</quote>) means that it's marked as a signature key in one of
- the user IDs, but may also be used for encryption. The letter
+ the user IDs, but may also be used for encryption. The letter
<quote>e</quote>indicates that this key can be used for
encryption.</para>
<para>The second character indicates the key's signing capabilities.
- Once again, a
- <quote>-</quote>implies
- <quote>not for signing</quote>,
+ Once again, a
+ <quote>-</quote>implies
+ <quote>not for signing</quote>,
<quote>.</quote>implies that the key is marked as an encryption key in
- one of the user-ids, and
+ one of the user-ids, and
<quote>s</quote>denotes a key which can be used for signing.</para>
<para>Finally, the validity field (
<quote>%t</quote>) indicates how well-certified a user-id is. A
<sect3 id="ff-concept">
<title>Concept</title>
<para>
- <literal>format=flowed</literal>-style messages (or
- <literal>f=f</literal>for short) are
+ <literal>format=flowed</literal>-style messages (or
+ <literal>f=f</literal>for short) are
<literal>text/plain</literal>messages that consist of paragraphs
which a receiver's mail client may reformat to its own needs which
mostly means to customize line lengths regardless of what the sender
- sent. Technically this is achieved by letting lines of a
+ sent. Technically this is achieved by letting lines of a
<quote>flowable</quote>paragraph end in spaces except for the last
line.</para>
<para>While for text-mode clients like Mutt it's the best way to
<sect3 id="ff-support">
<title>Mutt Support</title>
- <para>Mutt only supports setting the required
+ <para>Mutt only supports setting the required
<literal>format=flowed</literal>MIME parameter on outgoing messages
- if the
+ if the
<link linkend="text-flowed">$text_flowed</link>variable is set,
specifically it does not add the trailing spaces.</para>
<para>After editing the initial message text and before entering the
- compose menu, Mutt properly space-stuffs the message.
- <emphasis>Space-stuffing</emphasis>is required by RfC3676 defining
+ compose menu, Mutt properly space-stuffs the message.
+ <emphasis>Space-stuffing</emphasis>is required by RfC3676 defining
<literal>format=flowed</literal>and means to prepend a space
to:</para>
<itemizedlist>
<para>all lines starting with a space</para>
</listitem>
<listitem>
- <para>lines starting with the word
+ <para>lines starting with the word
<quote>
<literal>From</literal>
</quote>followed by space</para>
</listitem>
<listitem>
- <para>all lines starting with
+ <para>all lines starting with
<quote>
<literal>></literal>
</quote>which is not intended to be a quote character</para>
<note>
<para>Mutt only supports space-stuffing for the first two types of
lines but not for the third: It is impossible to safely detect
- whether a leading
+ whether a leading
<literal>></literal>character starts a quote or not.
- Furthermore, Mutt only applies space-stuffing
+ Furthermore, Mutt only applies space-stuffing
<emphasis>once</emphasis>after the initial edit is finished.</para>
</note>
<para>All leading spaces are to be removed by receiving clients to
<sect3 id="ff-editor">
<title>Editor Considerations</title>
- <para>As Mutt provides no additional features to compose
+ <para>As Mutt provides no additional features to compose
<literal>f=f</literal>messages, it's completely up to the user and
his editor to produce proper messages. Please consider your editor's
- documentation if you intend to send
+ documentation if you intend to send
<literal>f=f</literal>messages.</para>
<para>Please note that when editing messages from the compose menu
several times before really sending a mail, it's up to the user to
ensure that the message is properly space-stuffed.</para>
- <para>For example,
- <emphasis>vim</emphasis>provides the
- <literal>w</literal>flag for its
- <literal>formatoptions</literal>setting to assist in creating
- <literal>f=f</literal>messages, see
+ <para>For example,
+ <emphasis>vim</emphasis>provides the
+ <literal>w</literal>flag for its
+ <literal>formatoptions</literal>setting to assist in creating
+ <literal>f=f</literal>messages, see
<literal>:help fo-table</literal>for details.</para>
</sect3>
<sect3 id="ff-pager">
<title>Reformatting</title>
<para>Mutt has some support for reformatting when viewing and
- replying to
+ replying to
<literal>format=flowed</literal>messages. In order to take advantage
- of these,
+ of these,
<link linkend="reflow-text">$reflow_text</link>must be set.</para>
<itemizedlist>
<listitem>
<para>Paragraphs are automatically reflowed and wrapped at a
- width specified by
+ width specified by
<link linkend="reflow-wrap">$reflow_wrap</link>.</para>
</listitem>
<listitem>
- <para>In its original format, the quoting style of
+ <para>In its original format, the quoting style of
<literal>format=flowed</literal>messages can be difficult to
- read, and doesn't intermix well with non-flowed replies. Setting
+ read, and doesn't intermix well with non-flowed replies. Setting
<link linkend="reflow-space-quotes">
$reflow_space_quotes</link>adds spaces after each level of
quoting when in the pager and replying in a non-flowed format
- (i.e. with
+ (i.e. with
<link linkend="text-flowed">$text_flowed</link>unset).</para>
</listitem>
<listitem>
- <para>If
+ <para>If
<link linkend="reflow-space-quotes">$reflow_space_quotes</link>is
unset, mutt will still add one trailing space after all the
quotes in the pager (but not when replying).</para>
a message to alternative addresses as if they were the message's original
recipients specified in the Bcc header. Forwarding a message, on the
other hand, allows you to modify the message before it is resent (for
- example, by adding your own comments). Bouncing is done using the
- <literal><bounce></literal>function and forwarding using the
- <literal><forward></literal>function bound to
- <quote>b</quote>and
+ example, by adding your own comments). Bouncing is done using the
+ <literal><bounce></literal>function and forwarding using the
+ <literal><forward></literal>function bound to
+ <quote>b</quote>and
<quote>f</quote>respectively.</para>
<para>Forwarding can be done by including the original message in the new
message's body (surrounded by indicating lines) or including it as a MIME
- attachment, depending on the value of the
+ attachment, depending on the value of the
<link linkend="mime-forward">$mime_forward</link>variable. Decoding of
- attachments, like in the pager, can be controlled by the
- <link linkend="forward-decode">$forward_decode</link>and
+ attachments, like in the pager, can be controlled by the
+ <link linkend="forward-decode">$forward_decode</link>and
<link linkend="mime-forward-decode">$mime_forward_decode</link>variables,
respectively. The desired forwarding format may depend on the content,
- therefore
+ therefore
<link linkend="mime-forward">$mime_forward</link>is a quadoption which,
- for example, can be set to
+ for example, can be set to
<quote>ask-no</quote>.</para>
<para>The inclusion of headers is controlled by the current setting of
- the
- <link linkend="weed">$weed</link>variable, unless
+ the
+ <link linkend="weed">$weed</link>variable, unless
<link linkend="mime-forward">$mime_forward</link>is set.</para>
<para>By default a forwarded message does not reference the messages it
- contains. When
+ contains. When
<link linkend="forward-references">$forward_references</link>is set, a
- forwarded message includes the
- <quote>In-Reply-To:</quote>and
+ forwarded message includes the
+ <quote>In-Reply-To:</quote>and
<quote>References:</quote>headers, just like a reply would. Hence the
forwarded message becomes part of the original thread instead of starting
a new one.</para>
<sect1 id="postponing-mail">
<title>Postponing Mail</title>
<para>At times it is desirable to delay sending a message that you have
- already begun to compose. When the
- <literal><postpone-message></literal>function is used in the
+ already begun to compose. When the
+ <literal><postpone-message></literal>function is used in the
<emphasis>compose</emphasis>menu, the body of your message and
- attachments are stored in the mailbox specified by the
+ attachments are stored in the mailbox specified by the
<link linkend="postponed">$postponed</link>variable. This means that you
can recall the message even if you exit Mutt and then restart it at a
later time.</para>
<para>Once a message is postponed, there are several ways to resume it.
- From the command line you can use the
- <quote>-p</quote>option, or if you compose a new message from the
- <emphasis>index</emphasis>or
+ From the command line you can use the
+ <quote>-p</quote>option, or if you compose a new message from the
+ <emphasis>index</emphasis>or
<emphasis>pager</emphasis>you will be prompted if postponed messages
- exist. If multiple messages are currently postponed, the
+ exist. If multiple messages are currently postponed, the
<emphasis>postponed</emphasis>menu will pop up and you can select which
message you would like to resume.</para>
<note>
it. Also, you must be in the same folder with the message you replied
to for the status of the message to be updated.</para>
</note>
- <para>See also the
+ <para>See also the
<link linkend="postpone">$postpone</link>quad-option.</para>
</sect1>
</chapter>
<sect1 id="configuration-files">
<title>Location of Initialization Files</title>
- <para>When Mutt starts up it looks for two configuration files -- one
- <quote>system</quote>file and one
+ <para>When Mutt starts up it looks for two configuration files -- one
+ <quote>system</quote>file and one
<quote>user</quote>file.</para>
<para>Mutt searches for several different file names when looking for
config. It looks for NeoMutt config files before Mutt config files and
<sect2 id="muttrc-system">
<title>Location of system config files</title>
- <para>Mutt will search for a system config file in a
+ <para>Mutt will search for a system config file in a
<literal>mutt</literal>directory in several places. First it searches
- the locations specified in the
+ the locations specified in the
<literal>XDG_CONFIG_DIRS</literal>environment variable, which defaults
- to
- <literal>/etc/xdg</literal>. Next, it looks in
- <literal>/etc</literal>. Finally, it tries
+ to
+ <literal>/etc/xdg</literal>. Next, it looks in
+ <literal>/etc</literal>. Finally, it tries
<literal>/usr/share</literal>.</para>
- <para>The system config file will not be read if the
- <quote>-n</quote>option is used on the
+ <para>The system config file will not be read if the
+ <quote>-n</quote>option is used on the
<link linkend="commandline">command line</link>.</para>
<para>Mutt will read just one file, the first file it finds, from the
list below.</para>
<sect2 id="muttrc-user">
<title>Location of user config files</title>
<para>Mutt will search for a user config file in several places. First
- it looks in the directory specified in the
+ it looks in the directory specified in the
<literal>XDG_CONFIG_HOME</literal>environment variable, which defaults
- to
- <literal>~/.config/mutt</literal>. Next, it looks in
- <literal>~</literal>(your home directory). Finally, it tries
+ to
+ <literal>~/.config/mutt</literal>. Next, it looks in
+ <literal>~</literal>(your home directory). Finally, it tries
<literal>~/.mutt</literal>.</para>
<para>You may specify your own location for the user config file using
- the
- <quote>-F</quote>option on the
+ the
+ <quote>-F</quote>option on the
<link linkend="commandline">command line</link>.</para>
<para>Mutt will read just one file, the first file it finds, from the
list below.</para>
<sect1 id="muttrc-syntax" xreflabel="Syntax of Initialization Files">
<title>Syntax of Initialization Files</title>
- <para>An initialization file consists of a series of
+ <para>An initialization file consists of a series of
<link linkend="commands">commands</link>. Each line of the file may
contain one or more commands. When multiple commands are used, they must
be separated by a semicolon (
<screen>set realname='Mutt user' ; ignore x-</screen>
</example>
<para>The hash mark, or pound sign (
- <quote>#</quote>), is used as a
+ <quote>#</quote>), is used as a
<quote>comment</quote>character. You can use it to annotate your
initialization file. All text after the comment character to the end of
the line is ignored.</para>
<example id="ex-ec-comment">
<title>Commenting configuration files</title>
- <screen>my_hdr X-Disclaimer: Why are you listening to me?
+ <screen>my_hdr X-Disclaimer: Why are you listening to me?
<emphasis role="comment"># This is a comment</emphasis></screen>
</example>
<para>Single quotes (
quote is used to specify a literal string (one that is not interpreted
for shell variables or quoting with a backslash [see next paragraph]),
while double quotes indicate a string for which should be evaluated. For
- example, backticks are evaluated inside of double quotes, but
+ example, backticks are evaluated inside of double quotes, but
<emphasis>not</emphasis>for single quotes.</para>
<para>
<quote>\</quote>quotes the next character, just as in shells such as bash
- and zsh. For example, if want to put quotes
- <quote>"</quote>inside of a string, you can use
+ and zsh. For example, if want to put quotes
+ <quote>"</quote>inside of a string, you can use
<quote>\</quote>to force the next character to be a literal instead of
interpreted character.</para>
<example id="ex-rc-quote">
<screen>set realname="Michael \"MuttDude\" Elkins"</screen>
</example>
<para>
- <quote>\\</quote>means to insert a literal
- <quote>\</quote>into the line.
- <quote>\n</quote>and
+ <quote>\\</quote>means to insert a literal
+ <quote>\</quote>into the line.
+ <quote>\n</quote>and
<quote>\r</quote>have their usual C meanings of linefeed and
carriage-return, respectively.</para>
- <para>A
+ <para>A
<quote>\</quote>at the end of a line can be used to split commands over
- multiple lines as it
+ multiple lines as it
<quote>escapes</quote>the line end, provided that the split points don't
appear in the middle of command names. Lines are first concatenated
before interpretation so that a multi-line can be commented by commenting
</example>
<para>It is also possible to substitute the output of a Unix command in
an initialization file. This is accomplished by enclosing the command in
- backticks (``). In
- <xref linkend="ex-rc-backtick" />, the output of the Unix command
+ backticks (``). In
+ <xref linkend="ex-rc-backtick" />, the output of the Unix command
<quote>uname -a</quote>will be substituted before the line is parsed.
Since initialization files are line oriented, only the first line of
output from the Unix command will be substituted.</para>
<screen>my_hdr X-Operating-System: `uname -a`</screen>
</example>
<para>Both environment variables and Mutt variables can be accessed by
- prepending
+ prepending
<quote>$</quote>to the name of the variable. For example,</para>
<example id="ex-rc-env">
<title>Using environment variables in configuration files</title>
<screen>set record=+sent_on_$HOSTNAME</screen>
</example>
- <para>will cause Mutt to save outgoing messages to a folder named
- <quote>sent_on_kremvax</quote>if the environment variable
- <literal>$HOSTNAME</literal>is set to
- <quote>kremvax.</quote>(See
+ <para>will cause Mutt to save outgoing messages to a folder named
+ <quote>sent_on_kremvax</quote>if the environment variable
+ <literal>$HOSTNAME</literal>is set to
+ <quote>kremvax.</quote>(See
<link linkend="record">$record</link>for details.)</para>
<para>Mutt expands the variable when it is assigned, not when it is used.
If the value of a variable on the right-hand side of an assignment
changes after the assignment, the variable on the left-hand side will not
be affected.</para>
<para>The commands understood by Mutt are explained in the next
- paragraphs. For a complete list, see the
+ paragraphs. For a complete list, see the
<link linkend="commands">command reference</link>.</para>
<para>All configuration files are expected to be in the current locale as
- specified by the
+ specified by the
<link linkend="charset">$charset</link>variable which doesn't have a
default value since it's determined by Mutt at startup. If a
- configuration file is not encoded in the same character set the
+ configuration file is not encoded in the same character set the
<link linkend="config-charset">$config_charset</link>variable should be
- used: all lines starting with the next are recoded from
- <link linkend="config-charset">$config_charset</link>to
+ used: all lines starting with the next are recoded from
+ <link linkend="config-charset">$config_charset</link>to
<link linkend="charset">$charset</link>.</para>
<para>This mechanism should be avoided if possible as it has the
following implications:</para>
<itemizedlist>
<listitem>
<para>These variables should be set early in a configuration file
- with
- <link linkend="charset">$charset</link>preceding
+ with
+ <link linkend="charset">$charset</link>preceding
<link linkend="config-charset">$config_charset</link>so Mutt knows
what character set to convert to.</para>
</listitem>
<listitem>
- <para>If
+ <para>If
<link linkend="config-charset">$config_charset</link>is set, it
should be set in each configuration file because the value is global
- and
+ and
<emphasis>not</emphasis>per configuration file.</para>
</listitem>
<listitem>
</cmdsynopsis>
<para>Mutt supports grouping addresses logically into named groups. An
address or address pattern can appear in several groups at the same time.
- These groups can be used in
+ These groups can be used in
<link linkend="patterns">patterns</link>(for searching, limiting and
tagging) and in hooks by using group patterns. This can be useful to
classify mail and take certain actions depending on in what groups the
message is. For example, the mutt user's mailing list would fit into the
- categories
- <quote>mailing list</quote>and
- <quote>mutt-related</quote>. Using
+ categories
+ <quote>mailing list</quote>and
+ <quote>mutt-related</quote>. Using
<link linkend="send-hook">
<literal>send-hook</literal>
</link>, the sender can be set to a dedicated one for writing mailing
list messages, and the signature could be set to a mutt-related one for
writing to a mutt list — for other lists, the list sender setting still
applies but a different signature can be selected. Or, given a group only
- containing recipients known to accept encrypted mail,
+ containing recipients known to accept encrypted mail,
<quote>auto-encryption</quote>can be achieved easily.</para>
- <para>The
+ <para>The
<command>group</command>command is used to directly add either addresses
or regular expressions to the specified group or groups. The different
- categories of arguments to the
- <command>group</command>command can be in any order. The flags
- <literal>-rx</literal>and
+ categories of arguments to the
+ <command>group</command>command can be in any order. The flags
+ <literal>-rx</literal>and
<literal>-addr</literal>specify what the following strings (that cannot
begin with a hyphen) should be interpreted as: either a regular
expression or an email address, respectively.</para>
- <para>These address groups can also be created implicitly by the
+ <para>These address groups can also be created implicitly by the
<link linkend="alias">
<command>alias</command>
- </link>,
+ </link>,
<link linkend="lists">
<command>lists</command>
- </link>,
+ </link>,
<link linkend="lists">
<command>subscribe</command>
- </link>and
+ </link>and
<link linkend="alternates">
<command>alternates</command>
- </link>commands by specifying the optional
+ </link>commands by specifying the optional
<literal>-group</literal>option. For example,</para>
<screen>
alternates -group me address1 address2
alternates -group me -group work address3
</screen>
- <para>would create a group named
- <quote>me</quote>which contains all your addresses and a group named
- <quote>work</quote>which contains only your work address
+ <para>would create a group named
+ <quote>me</quote>which contains all your addresses and a group named
+ <quote>work</quote>which contains only your work address
<emphasis>address3</emphasis>. Besides many other possibilities, this
could be used to automatically mark your own messages in a mailing list
folder as read or use a special signature for work-related
messages.</para>
- <para>The
+ <para>The
<command>ungroup</command>command is used to remove addresses or regular
expressions from the specified group or groups. The syntax is similar to
- the
- <command>group</command>command, however the special character
+ the
+ <command>group</command>command, however the special character
<literal>*</literal>can be used to empty a group of all of its contents.
As soon as a group gets empty because all addresses and regular
expressions have been removed, it'll internally be removed, too (i.e.
there cannot be an empty group). When removing regular expressions from a
- group, the pattern must be specified exactly as given to the
- <command>group</command>command or
+ group, the pattern must be specified exactly as given to the
+ <command>group</command>command or
<literal>-group</literal>argument.</para>
</sect1>
</group>
</cmdsynopsis>
<para>It's usually very cumbersome to remember or type out the address of
- someone you are communicating with. Mutt allows you to create
+ someone you are communicating with. Mutt allows you to create
<quote>aliases</quote>which map a short string to a full address.</para>
<note>
- <para>If you want to create an alias for more than one address, you
+ <para>If you want to create an alias for more than one address, you
<emphasis>must</emphasis>separate the addresses with a comma (
<quote>,</quote>).</para>
</note>
- <para>The optional
- <literal>-group</literal>argument to
+ <para>The optional
+ <literal>-group</literal>argument to
<command>alias</command>causes the aliased address(es) to be added to the
- named
+ named
<emphasis>group</emphasis>.</para>
<para>To remove an alias or aliases (
<quote>*</quote>means all aliases):</para>
alias theguys manny, moe, jack
</screen>
<para>Unlike other mailers, Mutt doesn't require aliases to be defined in
- a special file. The
+ a special file. The
<command>alias</command>command can appear anywhere in a configuration
- file, as long as this file is
+ file, as long as this file is
<link linkend="source">
<command>source</command>d</link>. Consequently, you can have multiple
- alias files, or you can have all aliases defined in your
+ alias files, or you can have all aliases defined in your
<literal>.muttrc</literal>.</para>
- <para>On the other hand, the
+ <para>On the other hand, the
<link linkend="create-alias">
<literal><create-alias></literal>
- </link>function can use only one file, the one pointed to by the
- <link linkend="alias-file">$alias_file</link>variable (which is
+ </link>function can use only one file, the one pointed to by the
+ <link linkend="alias-file">$alias_file</link>variable (which is
<literal>~/.muttrc</literal>by default). This file is not special either,
in the sense that Mutt will happily append aliases to any file, but in
- order for the new aliases to take effect you need to explicitly
+ order for the new aliases to take effect you need to explicitly
<link linkend="source">
<command>source</command>
</link>this file too.</para>
</screen>
</example>
<para>To use aliases, you merely use the alias at any place in Mutt where
- Mutt prompts for addresses, such as the
- <emphasis>To:</emphasis>or
+ Mutt prompts for addresses, such as the
+ <emphasis>To:</emphasis>or
<emphasis>Cc:</emphasis>prompt. You can also enter aliases in your editor
- at the appropriate headers if you have the
+ at the appropriate headers if you have the
<link linkend="edit-headers">$edit_headers</link>variable set.</para>
<para>In addition, at the various address prompts, you can use the tab
character to expand a partial alias to the full alias. If there are
without a partial alias, such as at the beginning of the prompt or after
a comma denoting multiple addresses.</para>
<para>In the alias menu, you can select as many aliases as you want with
- the
- <literal>select-entry</literal>key (default: <Return>), and use the
+ the
+ <literal>select-entry</literal>key (default: <Return>), and use the
<emphasis>exit</emphasis>key (default: q) to return to the address
prompt.</para>
</sect1>
the other menus except for the pager and editor modes. If a key is
not defined in another menu, Mutt will look for a binding to use in
this menu. This allows you to bind a key to a certain function in
- multiple menus instead of having multiple
+ multiple menus instead of having multiple
<command>bind</command>statements to accomplish the same
task.</para>
</listitem>
<term>alias</term>
<listitem>
<para>The alias menu is the list of your personal aliases as
- defined in your
+ defined in your
<literal>.muttrc</literal>. It is the mapping from a short alias
name to the full email address(es) of the recipient(s).</para>
</listitem>
<term>editor</term>
<listitem>
<para>The editor is used to allow the user to enter a single line
- of text, such as the
- <emphasis>To</emphasis>or
- <emphasis>Subject</emphasis>prompts in the
+ of text, such as the
+ <emphasis>To</emphasis>or
+ <emphasis>Subject</emphasis>prompts in the
<literal>compose</literal>menu.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>query</term>
<listitem>
- <para>The query menu is the browser for results returned by
+ <para>The query menu is the browser for results returned by
<link linkend="query-command">$query_command</link>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>key</emphasis>is the key (or key sequence) you wish to bind. To
- specify a control character, use the sequence
- <emphasis>\Cx</emphasis>, where
+ specify a control character, use the sequence
+ <emphasis>\Cx</emphasis>, where
<emphasis>x</emphasis>is the letter of the control character (for
- example, to specify control-A use
- <quote>\Ca</quote>). Note that the case of
- <emphasis>x</emphasis>as well as
- <emphasis>\C</emphasis>is ignored, so that
- <emphasis>\CA</emphasis>,
- <emphasis>\Ca</emphasis>,
- <emphasis>\cA</emphasis>and
+ example, to specify control-A use
+ <quote>\Ca</quote>). Note that the case of
+ <emphasis>x</emphasis>as well as
+ <emphasis>\C</emphasis>is ignored, so that
+ <emphasis>\CA</emphasis>,
+ <emphasis>\Ca</emphasis>,
+ <emphasis>\cA</emphasis>and
<emphasis>\ca</emphasis>are all equivalent. An alternative form is to
- specify the key as a three digit octal number prefixed with a
- <quote>\</quote>(for example
- <emphasis>\177</emphasis>is equivalent to
- <emphasis>\c?</emphasis>). In addition,
- <emphasis>key</emphasis>may be a symbolic name as shown in
+ specify the key as a three digit octal number prefixed with a
+ <quote>\</quote>(for example
+ <emphasis>\177</emphasis>is equivalent to
+ <emphasis>\c?</emphasis>). In addition,
+ <emphasis>key</emphasis>may be a symbolic name as shown in
<xref linkend="tab-key-names" />.</para>
<table id="tab-key-names">
</tbody>
</tgroup>
</table>
- <para>The
+ <para>The
<literal><what-key></literal>function can be used to explore
keycode and symbolic names for other keys on your keyboard. Executing
this function will display information about each key pressed, until
- terminated by
+ terminated by
<literal>^G</literal>.</para>
<para>
<emphasis>key</emphasis>does not need to be enclosed in quotes unless it
<quote> </quote>) or semi-colon (
<quote>;</quote>).</para>
<para>
- <emphasis>function</emphasis>specifies which action to take when
+ <emphasis>function</emphasis>specifies which action to take when
<emphasis>key</emphasis>is pressed. For a complete list of functions, see
- the
- <link linkend="functions">reference</link>. Note that the
- <command>bind</command>expects
+ the
+ <link linkend="functions">reference</link>. Note that the
+ <command>bind</command>expects
<emphasis>function</emphasis>to be specified without angle
brackets.</para>
- <para>The special function
+ <para>The special function
<literal><noop></literal>unbinds the specified key sequence.</para>
</sect1>
<replaceable class="parameter">local-charset</replaceable>
</arg>
</cmdsynopsis>
- <para>The
+ <para>The
<command>charset-hook</command>command defines an alias for a character
set. This is useful to properly display messages which are tagged with a
character set name not known to Mutt.</para>
- <para>The
+ <para>The
<command>iconv-hook</command>command defines a system-specific name for a
character set. This is helpful when your systems character conversion
library insists on using strange, system-specific names for character
</arg>
</cmdsynopsis>
<para>It is often desirable to change settings based on which mailbox you
- are reading. The
+ are reading. The
<command>folder-hook</command>command provides a method by which you can
- execute any configuration command.
+ execute any configuration command.
<emphasis>regexp</emphasis>is a regular expression specifying in which
- mailboxes to execute
- <emphasis>command</emphasis>before loading. If a mailbox matches multiple
+ mailboxes to execute
+ <emphasis>command</emphasis>before loading. If a mailbox matches multiple
<command>folder-hook</command>s, they are executed in the order given in
- the
+ the
<literal>.muttrc</literal>.</para>
- <para>The regexp parameter has
+ <para>The regexp parameter has
<link linkend="shortcuts">mailbox shortcut</link>expansion performed on
- the first character. See
+ the first character. See
<xref linkend="mailbox-hook" />for more details.</para>
<note>
- <para>If you use the
- <quote>!</quote>shortcut for
+ <para>If you use the
+ <quote>!</quote>shortcut for
<link linkend="spoolfile">$spoolfile</link>at the beginning of the
pattern, you must place it inside of double or single quotes in order
- to distinguish it from the logical
+ to distinguish it from the logical
<emphasis>not</emphasis>operator for the expression.</para>
</note>
<note>
- <para>Settings are
+ <para>Settings are
<emphasis>not</emphasis>restored when you leave the mailbox. For
example, a command action to perform is to change the sorting method
based upon the mailbox being read:</para>
<screen>folder-hook mutt "set sort=threads"</screen>
<para>However, the sorting method is not restored to its previous value
- when reading a different mailbox. To specify a
- <emphasis>default</emphasis>command, use the pattern
- <quote>.</quote>before other
+ when reading a different mailbox. To specify a
+ <emphasis>default</emphasis>command, use the pattern
+ <quote>.</quote>before other
<command>folder-hook</command>s adjusting a value on a per-folder basis
- because
+ because
<command>folder-hook</command>s are evaluated in the order given in the
configuration file.</para>
</note>
<note>
<para>The keyboard buffer will not be processed until after all hooks
- are run; multiple
- <link linkend="push">push</link>or
+ are run; multiple
+ <link linkend="push">push</link>or
<link linkend="exec">exec</link>commands will end up being processed in
reverse order.</para>
</note>
- <para>The following example will set the
- <link linkend="sort">sort</link>variable to
- <literal>date-sent</literal>for all folders but to
- <literal>threads</literal>for all folders containing
+ <para>The following example will set the
+ <link linkend="sort">sort</link>variable to
+ <literal>date-sent</literal>for all folders but to
+ <literal>threads</literal>for all folders containing
<quote>mutt</quote>in their name.</para>
<example id="ex-folder-sorting">
<title>Setting sort method based on mailbox name</title>
</arg>
</cmdsynopsis>
<para>Macros are useful when you would like a single key to perform a
- series of actions. When you press
- <emphasis>key</emphasis>in menu
- <emphasis>menu</emphasis>, Mutt will behave as if you had typed
+ series of actions. When you press
+ <emphasis>key</emphasis>in menu
+ <emphasis>menu</emphasis>, Mutt will behave as if you had typed
<emphasis>sequence</emphasis>. So if you have a common sequence of
commands you type, you can create a macro to execute those commands with
a single key or fewer keys.</para>
<para>
- <emphasis>menu</emphasis>is the
+ <emphasis>menu</emphasis>is the
<link linkend="maps">map</link>which the macro will be bound in. Multiple
maps may be specified by separating multiple menu arguments by commas.
Whitespace may not be used in between the menu arguments and the commas
separating them.</para>
<para>
- <emphasis>key</emphasis>and
- <emphasis>sequence</emphasis>are expanded by the same rules as the
+ <emphasis>key</emphasis>and
+ <emphasis>sequence</emphasis>are expanded by the same rules as the
<link linkend="bind">key bindings</link>with some additions. The first is
- that control characters in
- <emphasis>sequence</emphasis>can also be specified as
+ that control characters in
+ <emphasis>sequence</emphasis>can also be specified as
<emphasis>^x</emphasis>. In order to get a caret (
- <quote>^</quote>) you need to use
- <emphasis>^^</emphasis>. Secondly, to specify a certain key such as
+ <quote>^</quote>) you need to use
+ <emphasis>^^</emphasis>. Secondly, to specify a certain key such as
<emphasis>up</emphasis>or to invoke a function directly, you can use the
- format
- <emphasis><key name></emphasis>and
+ format
+ <emphasis><key name></emphasis>and
<emphasis><function name></emphasis>. For a listing of key names
- see the section on
- <link linkend="bind">key bindings</link>. Functions are listed in the
+ see the section on
+ <link linkend="bind">key bindings</link>. Functions are listed in the
<link linkend="functions">reference</link>.</para>
<para>The advantage with using function names directly is that the macros
will work regardless of the current key bindings, so they are not
dependent on the user having particular key definitions. This makes them
more robust and portable, and also facilitates defining of macros in
files used by more than one user (e.g., the system Muttrc).</para>
- <para>Optionally you can specify a descriptive text after
+ <para>Optionally you can specify a descriptive text after
<emphasis>sequence</emphasis>, which is shown in the help screens if they
contain a description.</para>
<note>
</cmdsynopsis>
<para>If your terminal supports color, you can spice up Mutt by creating
your own color scheme. To define the color of an object (type of
- information), you must specify both a foreground color
+ information), you must specify both a foreground color
<emphasis>and</emphasis>a background color (it is not possible to only
specify one or the other).</para>
<para>
- <emphasis>header</emphasis>and
- <emphasis>body</emphasis>match
- <emphasis>regexp</emphasis>in the header/body of a message,
- <emphasis>index-object</emphasis>can match
- <emphasis>pattern</emphasis>(see
+ <emphasis>header</emphasis>and
+ <emphasis>body</emphasis>match
+ <emphasis>regexp</emphasis>in the header/body of a message,
+ <emphasis>index-object</emphasis>can match
+ <emphasis>pattern</emphasis>(see
<xref linkend="patterns" />) in the message index. Note that IMAP
server-side searches (=b, =B, =h) are not supported for color index
patterns.</para>
pager)</para>
</listitem>
<listitem>
- <para>index_author (color of the author name in the index, uses
+ <para>index_author (color of the author name in the index, uses
<emphasis>pattern</emphasis>)</para>
</listitem>
<listitem>
index)</para>
</listitem>
<listitem>
- <para>index_subject (color of the subject in the index, uses
+ <para>index_subject (color of the subject in the index, uses
<emphasis>pattern</emphasis>)</para>
</listitem>
<listitem>
menu)</para>
</listitem>
<listitem>
- <para>markers (the
+ <para>markers (the
<quote>+</quote>markers at the beginning of wrapped lines in the
pager)</para>
</listitem>
<para>prompt</para>
</listitem>
<listitem>
- <para>quoted (text matching
+ <para>quoted (text matching
<link linkend="quote-regexp">$quote_regexp</link>in the body of a
message)</para>
</listitem>
message)</para>
</listitem>
<listitem>
- <para>tilde (the
+ <para>tilde (the
<quote>~</quote>used to pad blank lines in the pager)</para>
</listitem>
<listitem>
<emphasis>index-object</emphasis>can be one of the following:</para>
<itemizedlist>
<listitem>
- <para>index (default highlighting of the entire index line, uses
+ <para>index (default highlighting of the entire index line, uses
<emphasis>pattern</emphasis>)</para>
</listitem>
<listitem>
<para>index_date (the date field)</para>
</listitem>
<listitem>
- <para>index_flags (the message flags, %S %Z, uses
+ <para>index_flags (the message flags, %S %Z, uses
<emphasis>pattern</emphasis>)</para>
</listitem>
<listitem>
%M)</para>
</listitem>
<listitem>
- <para>index_author (the author name, %A %a %F %L %n, uses
+ <para>index_author (the author name, %A %a %F %L %n, uses
<emphasis>pattern</emphasis>)</para>
</listitem>
<listitem>
- <para>index_subject (the subject, %s, uses
+ <para>index_subject (the subject, %s, uses
<emphasis>pattern</emphasis>)</para>
</listitem>
<listitem>
<para>index_tags (the transformed message tags, %g)</para>
</listitem>
<listitem>
- <para>index_tag (an individual message tag, %G, uses
+ <para>index_tag (an individual message tag, %G, uses
<emphasis>pattern / tag name</emphasis>)</para>
</listitem>
</itemizedlist>
<para>
- <emphasis>foreground</emphasis>and
+ <emphasis>foreground</emphasis>and
<emphasis>background</emphasis>can be one of the following:</para>
<itemizedlist>
<listitem>
</itemizedlist>
<para>
<emphasis>foreground</emphasis>can optionally be prefixed with the
- keyword
- <literal>bright</literal>to make the foreground color boldfaced (e.g.,
+ keyword
+ <literal>bright</literal>to make the foreground color boldfaced (e.g.,
<literal>brightred</literal>).</para>
- <para>If your terminal supports it, the special keyword
- <emphasis>default</emphasis>can be used as a transparent color. The value
+ <para>If your terminal supports it, the special keyword
+ <emphasis>default</emphasis>can be used as a transparent color. The value
<emphasis>brightdefault</emphasis>is also valid. If Mutt is linked
- against the
- <emphasis>S-Lang</emphasis>library, you also need to set the
+ against the
+ <emphasis>S-Lang</emphasis>library, you also need to set the
<literal>$COLORFGBG</literal>environment variable to the default colors
of your terminal for this to work; for example (for Bourne-like
shells):</para>
export COLORFGBG
</screen>
<note>
- <para>The
- <emphasis>S-Lang</emphasis>library requires you to use the
- <emphasis>lightgray</emphasis>and
- <emphasis>brown</emphasis>keywords instead of
- <emphasis>white</emphasis>and
+ <para>The
+ <emphasis>S-Lang</emphasis>library requires you to use the
+ <emphasis>lightgray</emphasis>and
+ <emphasis>brown</emphasis>keywords instead of
+ <emphasis>white</emphasis>and
<emphasis>yellow</emphasis>when setting this variable.</para>
</note>
<note>
- <para>The
+ <para>The
<command>uncolor</command>command can be applied to the index, header
- and body objects only. It removes entries from the list. You
- <emphasis>must</emphasis>specify the same pattern specified in the
- <command>color</command>command for it to be removed. The pattern
+ and body objects only. It removes entries from the list. You
+ <emphasis>must</emphasis>specify the same pattern specified in the
+ <command>color</command>command for it to be removed. The pattern
<quote>*</quote>is a special token which means to clear the color list
of all entries.</para>
</note>
- <para>Mutt also recognizes the keywords
- <emphasis>color0</emphasis>,
- <emphasis>color1</emphasis>, ...,
+ <para>Mutt also recognizes the keywords
+ <emphasis>color0</emphasis>,
+ <emphasis>color1</emphasis>, ...,
<emphasis>color</emphasis>
<emphasis>N-1</emphasis>(
<emphasis>N</emphasis>being the number of colors supported by your
terminal). This is useful when you remap the colors for your display (for
- example by changing the color associated with
+ example by changing the color associated with
<emphasis>color2</emphasis>for your xterm), since color names may then
lose their normal meaning.</para>
<anchor id="mono" />
<para>If your terminal does not support color, it is still possible
- change the video attributes through the use of the
+ change the video attributes through the use of the
<quote>mono</quote>command. Usage:</para>
<cmdsynopsis>
<command>mono</command>
</arg>
</group>
</cmdsynopsis>
- <para>For
- <emphasis>object</emphasis>, see the
- <command>color</command>command.
+ <para>For
+ <emphasis>object</emphasis>, see the
+ <command>color</command>command.
<emphasis>attribute</emphasis>can be one of the following:</para>
<itemizedlist>
<listitem>
<sect2 id="hdr-folding">
<title>Header Display</title>
<para>When displaying a message in the pager, Mutt folds long header
- lines at
+ lines at
<link linkend="wrap">$wrap</link>columns. Though there're precise rules
about where to break and how, Mutt always folds headers using a tab for
readability. (Note that the sending side is not affected by this, Mutt
screen. This command allows you to specify header fields which you
don't normally want to see in the pager.</para>
<para>You do not need to specify the full header field name. For
- example,
+ example,
<quote>ignore content-</quote>will ignore all header fields that begin
- with the pattern
- <quote>content-</quote>.
+ with the pattern
+ <quote>content-</quote>.
<quote>ignore *</quote>will ignore all headers.</para>
- <para>To remove a previously added token from the list, use the
- <quote>unignore</quote>command. The
+ <para>To remove a previously added token from the list, use the
+ <quote>unignore</quote>command. The
<quote>unignore</quote>command will make Mutt display headers with the
- given pattern. For example, if you do
- <quote>ignore x-</quote>it is possible to
+ given pattern. For example, if you do
+ <quote>ignore x-</quote>it is possible to
<quote>unignore x-mailer</quote>.</para>
<para>
<quote>unignore *</quote>will remove all tokens from the ignore
</arg>
</group>
</cmdsynopsis>
- <para>With the
+ <para>With the
<command>hdr_order</command>command you can specify an order in which
Mutt will attempt to present these headers to you when viewing
messages.</para>
someone else. For instance, when replying to a message that you sent to a
different party, Mutt will automatically suggest to send the response to
the original message's recipients — responding to yourself won't make
- much sense in many cases. (See
+ much sense in many cases. (See
<link linkend="reply-to">$reply_to</link>.)</para>
<para>Many users receive e-mail under a number of different addresses. To
fully use Mutt's features here, the program must be able to recognize
- what e-mail addresses you receive mail under. That's the purpose of the
+ what e-mail addresses you receive mail under. That's the purpose of the
<command>alternates</command>command: It takes a list of regular
expressions, each of which can identify an address under which you
receive e-mail.</para>
precise as possible to avoid mismatches. For example, if you
specify:</para>
<screen>alternates user@example</screen>
- <para>Mutt will consider
+ <para>Mutt will consider
<quote>
<literal>some-user@example</literal>
</quote>as being your address, too which may not be desired. As a
solution, in such cases addresses should be specified as:</para>
<screen>alternates '^user@example$'</screen>
- <para>The
+ <para>The
<literal>-group</literal>flag causes all of the subsequent regular
expressions to be added to the named group.</para>
- <para>The
- <command>unalternates</command>command can be used to write exceptions to
+ <para>The
+ <command>unalternates</command>command can be used to write exceptions to
<command>alternates</command>patterns. If an address matches something in
- an
+ an
<command>alternates</command>command, but you nonetheless do not think it
- is from you, you can list a more precise pattern under an
+ is from you, you can list a more precise pattern under an
<command>unalternates</command>command.</para>
- <para>To remove a regular expression from the
- <command>alternates</command>list, use the
- <command>unalternates</command>command with exactly the same
- <emphasis>regexp</emphasis>. Likewise, if the
- <emphasis>regexp</emphasis>for an
- <command>alternates</command>command matches an entry on the
- <command>unalternates</command>list, that
- <command>unalternates</command>entry will be removed. If the
- <emphasis>regexp</emphasis>for
- <command>unalternates</command>is
- <quote>*</quote>,
- <emphasis>all entries</emphasis>on
+ <para>To remove a regular expression from the
+ <command>alternates</command>list, use the
+ <command>unalternates</command>command with exactly the same
+ <emphasis>regexp</emphasis>. Likewise, if the
+ <emphasis>regexp</emphasis>for an
+ <command>alternates</command>command matches an entry on the
+ <command>unalternates</command>list, that
+ <command>unalternates</command>entry will be removed. If the
+ <emphasis>regexp</emphasis>for
+ <command>unalternates</command>is
+ <quote>*</quote>,
+ <emphasis>all entries</emphasis>on
<command>alternates</command>will be removed.</para>
</sect1>
</arg>
</group>
</cmdsynopsis>
- <para>Mutt has a few nice features for
+ <para>Mutt has a few nice features for
<link linkend="using-lists">handling mailing lists</link>. In order to
take advantage of them, you must specify which addresses belong to
mailing lists, and which mailing lists you are subscribed to. Mutt also
- has limited support for auto-detecting mailing lists: it supports parsing
- <literal>mailto:</literal>links in the common
+ has limited support for auto-detecting mailing lists: it supports parsing
+ <literal>mailto:</literal>links in the common
<literal>List-Post:</literal>header which has the same effect as
- specifying the list address via the
+ specifying the list address via the
<command>lists</command>command (except the group feature). Once you have
- done this, the
+ done this, the
<link linkend="list-reply">
<literal><list-reply></literal>
</link>function will work for all known lists. Additionally, when you
<para>The Mail-Followup-To header is a non-standard extension which is
not supported by all mail user agents. Adding it is not bullet-proof
against receiving personal CCs of list messages. Also note that the
- generation of the Mail-Followup-To header is controlled by the
+ generation of the Mail-Followup-To header is controlled by the
<link linkend="followup-to">$followup_to</link>configuration variable
since it's common practice on some mailing lists to send Cc upon
replies (which is more a group- than a list-reply).</para>
</note>
<para>More precisely, Mutt maintains lists of patterns for the addresses
of known and subscribed mailing lists. Every subscribed mailing list is
- known. To mark a mailing list as known, use the
- <command>list</command>command. To mark it as subscribed, use
+ known. To mark a mailing list as known, use the
+ <command>list</command>command. To mark it as subscribed, use
<command>subscribe</command>.</para>
<para>You can use regular expressions with both commands. To mark all
messages sent to a specific bug report's address on Debian's bug tracking
e-mail address.</para>
<para>Specify as much of the address as you need to to remove ambiguity.
For example, if you've subscribed to the Mutt mailing list, you will
- receive mail addressed to
+ receive mail addressed to
<literal>mutt-users@mutt.org</literal>. So, to tell Mutt that this is a
- mailing list, you could add
+ mailing list, you could add
<literal>lists mutt-users@</literal>to your initialization file. To tell
- Mutt that you are subscribed to it, add
+ Mutt that you are subscribed to it, add
<literal>
<command>subscribe</command>mutt-users</literal>to your initialization
file instead. If you also happen to get mail from someone whose address
- is
- <literal>mutt-users@example.com</literal>, you could use
+ is
+ <literal>mutt-users@example.com</literal>, you could use
<literal>
- <command>lists</command>^mutt-users@mutt\\.org$</literal>or
+ <command>lists</command>^mutt-users@mutt\\.org$</literal>or
<literal>
<command>subscribe</command>^mutt-users@mutt\\.org$</literal>to match
only mail from the actual list.</para>
- <para>The
+ <para>The
<literal>-group</literal>flag adds all of the subsequent regular
- expressions to the named
+ expressions to the named
<link linkend="addrgroup">address group</link>in addition to adding to
the specified address list.</para>
- <para>The
+ <para>The
<quote>unlists</quote>command is used to remove a token from the list of
- known and subscribed mailing-lists. Use
+ known and subscribed mailing-lists. Use
<quote>unlists *</quote>to remove all tokens.</para>
<para>To remove a mailing list from the list of subscribed mailing lists,
- but keep it on the list of known mailing lists, use
+ but keep it on the list of known mailing lists, use
<command>unsubscribe</command>.</para>
</sect1>
</arg>
</cmdsynopsis>
<para>This command is used to move read messages from a specified mailbox
- to a different mailbox automatically when you quit or change folders.
+ to a different mailbox automatically when you quit or change folders.
<emphasis>regexp</emphasis>is a regular expression specifying the mailbox
- to treat as a
- <quote>spool</quote>mailbox and
+ to treat as a
+ <quote>spool</quote>mailbox and
<emphasis>mailbox</emphasis>specifies where mail should be saved when
read.</para>
- <para>The regexp parameter has
+ <para>The regexp parameter has
<link linkend="shortcuts">mailbox shortcut</link>expansion performed on
- the first character. See
+ the first character. See
<xref linkend="mailbox-hook" />for more details.</para>
- <para>Unlike some of the other
- <emphasis>hook</emphasis>commands, only the
+ <para>Unlike some of the other
+ <emphasis>hook</emphasis>commands, only the
<emphasis>first</emphasis>matching regexp is used (it is not possible to
save read mail in more than a single mailbox).</para>
</sect1>
<para>
<emphasis>folder</emphasis>can either be a local file or directory
(Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP
- support,
+ support,
<emphasis>folder</emphasis>can also be a POP/IMAP folder URL. The URL
- syntax is described in
- <xref linkend="url-syntax" />, POP and IMAP are described in
- <xref linkend="pop" />and
+ syntax is described in
+ <xref linkend="url-syntax" />, POP and IMAP are described in
+ <xref linkend="pop" />and
<xref linkend="imap" />respectively.</para>
<para>Mutt provides a number of advanced features for handling (possibly
- many) folders and new mail within them, please refer to
+ many) folders and new mail within them, please refer to
<xref linkend="new-mail" />for details (including in what situations and
how often Mutt checks for new mail).</para>
- <para>The
+ <para>The
<quote>unmailboxes</quote>command is used to remove a token from the list
- of folders which receive mail. Use
+ of folders which receive mail. Use
<quote>unmailboxes *</quote>to remove all tokens.</para>
<note>
- <para>The folders in the
+ <para>The folders in the
<command>mailboxes</command>command are resolved when the command is
- executed, so if these names contain
- <link linkend="shortcuts">shortcut characters</link>(such as
- <quote>=</quote>and
+ executed, so if these names contain
+ <link linkend="shortcuts">shortcut characters</link>(such as
+ <quote>=</quote>and
<quote>!</quote>), any variable definition that affects these
- characters (like
- <link linkend="folder">$folder</link>and
- <link linkend="spoolfile">$spoolfile</link>) should be set before the
+ characters (like
+ <link linkend="folder">$folder</link>and
+ <link linkend="spoolfile">$spoolfile</link>) should be set before the
<command>mailboxes</command>command. If none of these shortcuts are
used, a local path should be absolute as otherwise Mutt tries to find
it relative to the directory from where Mutt was started which may not
</arg>
</group>
</cmdsynopsis>
- <para>The
+ <para>The
<command>my_hdr</command>command allows you to create your own header
fields which will be added to every message you send and appear in the
- editor if
+ editor if
<link linkend="edit-headers">$edit_headers</link>is set.</para>
- <para>For example, if you would like to add an
+ <para>For example, if you would like to add an
<quote>Organization:</quote>header field to all of your outgoing
- messages, you can put the command something like shown in
- <xref linkend="ex-my-hdr" />in your
+ messages, you can put the command something like shown in
+ <xref linkend="ex-my-hdr" />in your
<literal>.muttrc</literal>.</para>
<example id="ex-my-hdr">
<title>Defining custom headers</title>
<screen>my_hdr Organization: A Really Big Company, Anytown, USA</screen>
</example>
<note>
- <para>Space characters are
+ <para>Space characters are
<emphasis>not</emphasis>allowed between the keyword and the colon (
<quote>:</quote>). The standard for electronic mail (RFC2822) says that
space is illegal there, so Mutt enforces the rule.</para>
</note>
<para>If you would like to add a header field to a single message, you
- should either set the
- <link linkend="edit-headers">$edit_headers</link>variable, or use the
- <literal><edit-headers></literal>function (default:
+ should either set the
+ <link linkend="edit-headers">$edit_headers</link>variable, or use the
+ <literal><edit-headers></literal>function (default:
<quote>E</quote>) in the compose menu so that you can edit the header of
your message along with the body.</para>
- <para>To remove user defined header fields, use the
+ <para>To remove user defined header fields, use the
<command>unmy_hdr</command>command. You may specify an asterisk (
<quote>*</quote>) to remove all header fields, or the fields to remove.
- For example, to remove all
- <quote>To</quote>and
+ For example, to remove all
+ <quote>To</quote>and
<quote>Cc</quote>header fields, you could use:</para>
<screen>unmy_hdr to cc</screen>
</sect1>
</arg>
</cmdsynopsis>
<para>This command is used to override the default mailbox used when
- saving messages.
+ saving messages.
<emphasis>mailbox</emphasis>will be used as the default if the message
- matches
- <emphasis>pattern</emphasis>, see
+ matches
+ <emphasis>pattern</emphasis>, see
<xref linkend="pattern-hook" />for information on the exact
format.</para>
<para>To provide more flexibility and good defaults, Mutt applies the
- expandos of
- <link linkend="index-format">$index_format</link>to
+ expandos of
+ <link linkend="index-format">$index_format</link>to
<emphasis>mailbox</emphasis>after it was expanded.</para>
<example id="ex-save-hook-exando">
- <title>Using %-expandos in
+ <title>Using %-expandos in
<command>save-hook</command></title>
<screen>
<emphasis role="comment"># default: save all to ~/Mail/<author name></emphasis>
save-hook aol\\.com$ +spam
</screen>
</example>
- <para>Also see the
+ <para>Also see the
<link linkend="fcc-save-hook">
<command>fcc-save-hook</command>
</link>command.</para>
<replaceable class="parameter">mailbox</replaceable>
</arg>
</cmdsynopsis>
- <para>This command is used to save outgoing mail in a mailbox other than
+ <para>This command is used to save outgoing mail in a mailbox other than
<link linkend="record">$record</link>. Mutt searches the initial list of
- message recipients for the first matching
- <emphasis>pattern</emphasis>and uses
+ message recipients for the first matching
+ <emphasis>pattern</emphasis>and uses
<emphasis>mailbox</emphasis>as the default Fcc: mailbox. If no match is
- found the message will be saved to
+ found the message will be saved to
<link linkend="record">$record</link>mailbox.</para>
<para>To provide more flexibility and good defaults, Mutt applies the
- expandos of
- <link linkend="index-format">$index_format</link>to
+ expandos of
+ <link linkend="index-format">$index_format</link>to
<emphasis>mailbox</emphasis>after it was expanded.</para>
- <para>See
- <xref linkend="pattern-hook" />for information on the exact format of
+ <para>See
+ <xref linkend="pattern-hook" />for information on the exact format of
<emphasis>pattern</emphasis>.</para>
<screen>fcc-hook [@.]aol\\.com$ +spammers</screen>
<para>...will save a copy of all messages going to the aol.com domain to
- the `+spammers' mailbox by default. Also see the
+ the `+spammers' mailbox by default. Also see the
<link linkend="fcc-save-hook">
<command>fcc-save-hook</command>
</link>command.</para>
<replaceable class="parameter">mailbox</replaceable>
</arg>
</cmdsynopsis>
- <para>This command is a shortcut, equivalent to doing both a
+ <para>This command is a shortcut, equivalent to doing both a
<link linkend="fcc-hook">
<command>fcc-hook</command>
- </link>and a
+ </link>and a
<link linkend="save-hook">
<command>save-hook</command>
- </link>with its arguments, including %-expansion on
- <emphasis>mailbox</emphasis>according to
+ </link>with its arguments, including %-expansion on
+ <emphasis>mailbox</emphasis>according to
<link linkend="index-format">$index_format</link>.</para>
</sect1>
</arg>
</cmdsynopsis>
<para>These commands can be used to execute arbitrary configuration
- commands based upon recipients of the message.
- <emphasis>pattern</emphasis>is used to match the message, see
- <xref linkend="pattern-hook" />for details.
- <emphasis>command</emphasis>is executed when
+ commands based upon recipients of the message.
+ <emphasis>pattern</emphasis>is used to match the message, see
+ <xref linkend="pattern-hook" />for details.
+ <emphasis>command</emphasis>is executed when
<emphasis>pattern</emphasis>matches.</para>
<para>
- <command>reply-hook</command>is matched against the message you are
- <emphasis>replying to</emphasis>, instead of the message you are
- <emphasis>sending</emphasis>.
- <command>send-hook</command>is matched against all messages, both
- <emphasis>new</emphasis>and
+ <command>reply-hook</command>is matched against the message you are
+ <emphasis>replying to</emphasis>, instead of the message you are
+ <emphasis>sending</emphasis>.
+ <command>send-hook</command>is matched against all messages, both
+ <emphasis>new</emphasis>and
<emphasis>replies</emphasis>.</para>
<note>
<para>
- <command>reply-hook</command>s are matched
- <emphasis>before</emphasis>the
- <command>send-hook</command>,
+ <command>reply-hook</command>s are matched
+ <emphasis>before</emphasis>the
+ <command>send-hook</command>,
<emphasis>regardless</emphasis>of the order specified in the user's
- configuration file. However, you can inhibit
- <command>send-hook</command>in the reply case by using the pattern
+ configuration file. However, you can inhibit
+ <command>send-hook</command>in the reply case by using the pattern
<literal>'! ~Q'</literal>(
- <emphasis>not replied</emphasis>, see
- <xref linkend="pattern-hook" />) in the
- <command>send-hook</command>to tell when
+ <emphasis>not replied</emphasis>, see
+ <xref linkend="pattern-hook" />) in the
+ <command>send-hook</command>to tell when
<command>reply-hook</command>have been executed.</para>
</note>
<para>
<command>send2-hook</command>is matched every time a message is changed,
either by editing it, or by using the compose menu to change its
- recipients or subject.
- <command>send2-hook</command>is executed after
+ recipients or subject.
+ <command>send2-hook</command>is executed after
<command>send-hook</command>, and can, e.g., be used to set parameters
- such as the
+ such as the
<link linkend="sendmail">$sendmail</link>variable depending on the
message's sender address.</para>
- <para>For each type of
- <command>send-hook</command>or
+ <para>For each type of
+ <command>send-hook</command>or
<command>reply-hook</command>, when multiple matches occur, commands are
- executed in the order they are specified in the
+ executed in the order they are specified in the
<literal>.muttrc</literal>(for that type of hook).</para>
- <para>Example:
+ <para>Example:
<literal>
<command>send-hook</command>mutt "
<command>set</command>mime_forward signature=''"</literal></para>
- <para>Another typical use for this command is to change the values of the
- <link linkend="attribution">$attribution</link>,
- <link linkend="attribution-locale">$attribution_locale</link>, and
+ <para>Another typical use for this command is to change the values of the
+ <link linkend="attribution">$attribution</link>,
+ <link linkend="attribution-locale">$attribution_locale</link>, and
<link linkend="signature">$signature</link>variables in order to change
the language of the attributions and signatures based upon the
recipients.</para>
<para>
<command>send-hook</command>'s are only executed once after getting the
initial list of recipients. Adding a recipient after replying or
- editing the message will not cause any
- <command>send-hook</command>to be executed, similarly if
+ editing the message will not cause any
+ <command>send-hook</command>to be executed, similarly if
<link linkend="autoedit">$autoedit</link>is set (as then the initial
- list of recipients is empty). Also note that
+ list of recipients is empty). Also note that
<link linkend="my-hdr">
<command>my_hdr</command>
</link>commands which modify recipient headers, or the message's
subject, don't have any effect on the current message when executed
- from a
+ from a
<command>send-hook</command>.</para>
</note>
</sect1>
</cmdsynopsis>
<para>This command can be used to execute arbitrary configuration
commands before viewing or formatting a message based upon information
- about the message.
- <emphasis>command</emphasis>is executed if the
+ about the message.
+ <emphasis>command</emphasis>is executed if the
<emphasis>pattern</emphasis>matches the message to be displayed. When
multiple matches occur, commands are executed in the order they are
- specified in the
+ specified in the
<literal>.muttrc</literal>.</para>
- <para>See
- <xref linkend="pattern-hook" />for information on the exact format of
+ <para>See
+ <xref linkend="pattern-hook" />for information on the exact format of
<emphasis>pattern</emphasis>.</para>
<para>Example:</para>
<screen>
associate a certain key with a given e-mail address automatically, either
because the recipient's public key can't be deduced from the destination
address, or because, for some reasons, you need to override the key Mutt
- would normally use. The
+ would normally use. The
<command>crypt-hook</command>command provides a method by which you can
specify the ID of the public key to be used when encrypting messages to a
certain recipient. You may use multiple crypt-hooks with the same regexp;
multiple matching crypt-hooks result in the use of multiple keyids for a
recipient. During key selection, Mutt will confirm whether each
- crypt-hook is to be used (unless the
+ crypt-hook is to be used (unless the
<link linkend="crypt-confirmhook">$crypt_confirmhook</link>option is
unset). If all crypt-hooks for a recipient are declined, Mutt will use
the original recipient address for key selection instead.</para>
- <para>The meaning of
+ <para>The meaning of
<emphasis>keyid</emphasis>is to be taken broadly in this context: You can
either put a numerical key ID or fingerprint here, an e-mail address, or
even just a real name.</para>
</cmdsynopsis>
<para>This command adds the named string to the beginning of the keyboard
buffer. The string may contain control characters, key names and function
- names like the sequence string in the
+ names like the sequence string in the
<link linkend="macro">macro</link>command. You may use it to
automatically run a sequence of commands at startup, or when entering
- certain folders. For example,
+ certain folders. For example,
<xref linkend="ex-folder-hook-push" />shows how to automatically collapse
all threads when entering a folder.</para>
<example id="ex-folder-hook-push">
- <title>Embedding
- <command>push</command>in
+ <title>Embedding
+ <command>push</command>in
<command>folder-hook</command></title>
<screen>folder-hook . 'push <collapse-all>'</screen>
</example>
<para>For using functions like shown in the example, it's important to
use angle brackets (
- <quote><</quote>and
+ <quote><</quote>and
<quote>></quote>) to make Mutt recognize the input as a function name.
- Otherwise it will simulate individual just keystrokes, i.e.
+ Otherwise it will simulate individual just keystrokes, i.e.
<quote>
<literal>push collapse-all</literal>
- </quote>would be interpreted as if you had typed
- <quote>c</quote>, followed by
- <quote>o</quote>, followed by
+ </quote>would be interpreted as if you had typed
+ <quote>c</quote>, followed by
+ <quote>o</quote>, followed by
<quote>l</quote>, ..., which is not desired and may lead to very
unexpected behavior.</para>
<para>Keystrokes can be used, too, but are less portable because of
equivalent to the above example:</para>
<screen>folder-hook . 'push \eV'</screen>
<para>because it simulates that Esc+V was pressed (which is the default
- binding of
+ binding of
<literal><collapse-all></literal>).</para>
</sect1>
</arg>
</cmdsynopsis>
<para>This command can be used to execute any function. Functions are
- listed in the
- <link linkend="functions">function reference</link>.
+ listed in the
+ <link linkend="functions">function reference</link>.
<quote>
<command>exec</command>
<literal>function</literal>
- </quote>is equivalent to
+ </quote>is equivalent to
<quote>
<literal>push <function></literal>
</quote>.</para>
</arg>
</group>
</cmdsynopsis>
- <para>The
- <command>score</command>commands adds
- <emphasis>value</emphasis>to a message's score if
- <emphasis>pattern</emphasis>matches it.
- <emphasis>pattern</emphasis>is a string in the format described in the
+ <para>The
+ <command>score</command>commands adds
+ <emphasis>value</emphasis>to a message's score if
+ <emphasis>pattern</emphasis>matches it.
+ <emphasis>pattern</emphasis>is a string in the format described in the
<link linkend="patterns">patterns</link>section (note: For efficiency
reasons, patterns which scan information not available in the index, such
- as
- <literal>~b</literal>,
- <literal>~B</literal>,
- <literal>~h</literal>, or
- <literal>~X</literal>may not be used).
+ as
+ <literal>~b</literal>,
+ <literal>~B</literal>,
+ <literal>~h</literal>, or
+ <literal>~X</literal>may not be used).
<emphasis>value</emphasis>is a positive or negative integer. A message's
- final score is the sum total of all matching
- <command>score</command>entries. However, you may optionally prefix
+ final score is the sum total of all matching
+ <command>score</command>entries. However, you may optionally prefix
<emphasis>value</emphasis>with an equal sign (
<quote>=</quote>) to cause evaluation to stop at a particular entry if
there is a match. Negative final scores are rounded up to 0.</para>
- <para>The
+ <para>The
<command>unscore</command>command removes score entries from the list.
- You
- <emphasis>must</emphasis>specify the same pattern specified in the
- <command>score</command>command for it to be removed. The pattern
+ You
+ <emphasis>must</emphasis>specify the same pattern specified in the
+ <command>score</command>command for it to be removed. The pattern
<quote>*</quote>is a special token which means to clear the list of all
score entries.</para>
</sect1>
</group>
</cmdsynopsis>
<para>Mutt has generalized support for external spam-scoring filters. By
- defining your spam patterns with the
- <command>spam</command>and
- <literal>nospam</literal>commands, you can
- <emphasis>limit</emphasis>,
- <emphasis>search</emphasis>, and
+ defining your spam patterns with the
+ <command>spam</command>and
+ <literal>nospam</literal>commands, you can
+ <emphasis>limit</emphasis>,
+ <emphasis>search</emphasis>, and
<emphasis>sort</emphasis>your mail based on its spam attributes, as
determined by the external filter. You also can display the spam
- attributes in your index display using the
- <literal>%H</literal>selector in the
- <link linkend="index-format">$index_format</link>variable. (Tip: try
+ attributes in your index display using the
+ <literal>%H</literal>selector in the
+ <link linkend="index-format">$index_format</link>variable. (Tip: try
<literal>%?H?[%H] ?</literal>to display spam tags only when they are
defined for a given message.)</para>
<para>Your first step is to define your external filter's spam patterns
- using the
- <command>spam</command>command.
+ using the
+ <command>spam</command>command.
<emphasis>pattern</emphasis>should be a regular expression that matches a
header in a mail message. If any message in the mailbox matches this
- regular expression, it will receive a
- <quote>spam tag</quote>or
- <quote>spam attribute</quote>(unless it also matches a
+ regular expression, it will receive a
+ <quote>spam tag</quote>or
+ <quote>spam attribute</quote>(unless it also matches a
<command>nospam</command>pattern — see below.) The appearance of this
- attribute is entirely up to you, and is governed by the
- <emphasis>format</emphasis>parameter.
+ attribute is entirely up to you, and is governed by the
+ <emphasis>format</emphasis>parameter.
<emphasis>format</emphasis>can be any static text, but it also can
- include back-references from the
- <emphasis>pattern</emphasis>expression. (A regular expression
+ include back-references from the
+ <emphasis>pattern</emphasis>expression. (A regular expression
<quote>back-reference</quote>refers to a sub-expression contained within
- parentheses.)
+ parentheses.)
<literal>%1</literal>is replaced with the first back-reference in the
- regex,
+ regex,
<literal>%2</literal>with the second, etc.</para>
<para>To match spam tags, mutt needs the corresponding header information
which is always the case for local and POP folders but not for IMAP in
- the default configuration. Depending on the spam header to be analyzed,
+ the default configuration. Depending on the spam header to be analyzed,
<link linkend="imap-headers">$imap_headers</link>may need to be
adjusted.</para>
<para>If you're using multiple spam filters, a message can have more than
- one spam-related header. You can define
+ one spam-related header. You can define
<command>spam</command>patterns for each filter you use. If a message
- matches two or more of these patterns, and the
+ matches two or more of these patterns, and the
<link linkend="spam-separator">$spam_separator</link>variable is set to a
- string, then the message's spam tag will consist of all the
- <emphasis>format</emphasis>strings joined together, with the value of
+ string, then the message's spam tag will consist of all the
+ <emphasis>format</emphasis>strings joined together, with the value of
<link linkend="spam-separator">$spam_separator</link>separating
them.</para>
<para>For example, suppose one uses DCC, SpamAssassin, and PureMessage,
- then the configuration might look like in
+ then the configuration might look like in
<xref linkend="ex-spam" />.</para>
<example id="ex-spam">
<title>Configuring spam detection</title>
set spam_separator=", "
</screen>
</example>
- <para>If then a message is received that DCC registered with
- <quote>many</quote>hits under the
+ <para>If then a message is received that DCC registered with
+ <quote>many</quote>hits under the
<quote>Fuz2</quote>checksum, and that PureMessage registered with a 97%
- probability of being spam, that message's spam tag would read
- <literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before
+ probability of being spam, that message's spam tag would read
+ <literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before
<quote>=many</quote>in a DCC report indicate the checksum used — in this
- case,
+ case,
<quote>Fuz2</quote>.)</para>
- <para>If the
+ <para>If the
<link linkend="spam-separator">$spam_separator</link>variable is unset,
then each spam pattern match supersedes the previous one. Instead of
- getting joined
+ getting joined
<emphasis>format</emphasis>strings, you'll get only the last one to
match.</para>
- <para>The spam tag is what will be displayed in the index when you use
- <literal>%H</literal>in the
+ <para>The spam tag is what will be displayed in the index when you use
+ <literal>%H</literal>in the
<link linkend="index-format">$index_format</link>variable. It's also the
- string that the
- <literal>~H</literal>pattern-matching expression matches against for
- <literal><search></literal>and
+ string that the
+ <literal>~H</literal>pattern-matching expression matches against for
+ <literal><search></literal>and
<literal><limit></literal>functions. And it's what sorting by spam
attribute will use as a sort key.</para>
<para>That's a pretty complicated example, and most people's actual
environments will have only one spam filter. The simpler your
configuration, the more effective Mutt can be, especially when it comes
to sorting.</para>
- <para>Generally, when you sort by spam tag, Mutt will sort
+ <para>Generally, when you sort by spam tag, Mutt will sort
<emphasis>lexically</emphasis>— that is, by ordering strings
alphanumerically. However, if a spam tag begins with a number, Mutt will
sort numerically first, and lexically only when two numbers are equal in
- value. (This is like UNIX's
+ value. (This is like UNIX's
<literal>sort -n</literal>.) A message with no spam attributes at all —
- that is, one that didn't match
- <emphasis>any</emphasis>of your
+ that is, one that didn't match
+ <emphasis>any</emphasis>of your
<command>spam</command>patterns — is sorted at lowest priority. Numbers
are sorted next, beginning with 0 and ranging upward. Finally,
- non-numeric strings are sorted, with
- <quote>a</quote>taking lower priority than
+ non-numeric strings are sorted, with
+ <quote>a</quote>taking lower priority than
<quote>z</quote>. Clearly, in general, sorting by spam tags is most
effective when you can coerce your filter to give you a raw number. But
in case you can't, Mutt can still do something useful.</para>
- <para>The
- <command>nospam</command>command can be used to write exceptions to
+ <para>The
+ <command>nospam</command>command can be used to write exceptions to
<command>spam</command>patterns. If a header pattern matches something in
- a
+ a
<command>spam</command>command, but you nonetheless do not want it to
- receive a spam tag, you can list a more precise pattern under a
+ receive a spam tag, you can list a more precise pattern under a
<command>nospam</command>command.</para>
- <para>If the
- <emphasis>pattern</emphasis>given to
- <command>nospam</command>is exactly the same as the
- <emphasis>pattern</emphasis>on an existing
+ <para>If the
+ <emphasis>pattern</emphasis>given to
+ <command>nospam</command>is exactly the same as the
+ <emphasis>pattern</emphasis>on an existing
<command>spam</command>list entry, the effect will be to remove the entry
- from the spam list, instead of adding an exception. Likewise, if the
- <emphasis>pattern</emphasis>for a
- <command>spam</command>command matches an entry on the
- <command>nospam</command>list, that nospam entry will be removed. If the
- <emphasis>pattern</emphasis>for
- <command>nospam</command>is
- <quote>*</quote>,
+ from the spam list, instead of adding an exception. Likewise, if the
+ <emphasis>pattern</emphasis>for a
+ <command>spam</command>command matches an entry on the
+ <command>nospam</command>list, that nospam entry will be removed. If the
+ <emphasis>pattern</emphasis>for
+ <command>nospam</command>is
+ <quote>*</quote>,
<emphasis>all entries on both lists</emphasis>will be removed. This might
- be the default action if you use
- <command>spam</command>and
- <command>nospam</command>in conjunction with a
+ be the default action if you use
+ <command>spam</command>and
+ <command>nospam</command>in conjunction with a
<command>folder-hook</command>.</para>
- <para>You can have as many
- <command>spam</command>or
+ <para>You can have as many
+ <command>spam</command>or
<command>nospam</command>commands as you like. You can even do your own
- primitive
+ primitive
<command>spam</command>detection within Mutt — for example, if you
- consider all mail from
- <literal>MAILER-DAEMON</literal>to be spam, you can use a
+ consider all mail from
+ <literal>MAILER-DAEMON</literal>to be spam, you can use a
<command>spam</command>command like this:</para>
<screen>spam "^From: .*MAILER-DAEMON" "999"</screen>
</sect1>
<varlistentry>
<term>boolean</term>
<listitem>
- <para>A boolean expression, either
- <quote>yes</quote>or
+ <para>A boolean expression, either
+ <quote>yes</quote>or
<quote>no</quote>.</para>
</listitem>
</varlistentry>
<term>path</term>
<listitem>
<para>A specialized string for representing paths including
- support for mailbox shortcuts (see
+ support for mailbox shortcuts (see
<xref linkend="shortcuts" />) as well as tilde (
<quote>~</quote>) for a user's home directory and more.</para>
</listitem>
<varlistentry>
<term>quadoption</term>
<listitem>
- <para>Like a boolean but triggers a prompt when set to
- <quote>ask-yes</quote>or
- <quote>ask-no</quote>with
- <quote>yes</quote>and
+ <para>Like a boolean but triggers a prompt when set to
+ <quote>ask-yes</quote>or
+ <quote>ask-no</quote>with
+ <quote>yes</quote>and
<quote>no</quote>preselected respectively.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>regular expression</term>
<listitem>
- <para>A regular expression, see
+ <para>A regular expression, see
<xref linkend="regexp" />for an introduction.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>folder magic</term>
<listitem>
- <para>Specifies the type of folder to use:
- <emphasis>mbox</emphasis>,
- <emphasis>mmdf</emphasis>,
- <emphasis>mh</emphasis>or
+ <para>Specifies the type of folder to use:
+ <emphasis>mbox</emphasis>,
+ <emphasis>mmdf</emphasis>,
+ <emphasis>mh</emphasis>or
<emphasis>maildir</emphasis>. Currently only used to determine
the type for newly created folders.</para>
</listitem>
<term>e-mail address</term>
<listitem>
<para>An e-mail address either with or without realname. The
- older
+ older
<quote>
<literal>user@example.org (Joe User)</literal>
</quote>form is supported but strongly deprecated.</para>
<varlistentry>
<term>user-defined</term>
<listitem>
- <para>Arbitrary text, see
+ <para>Arbitrary text, see
<xref linkend="set-myvar" />for details.</para>
</listitem>
</varlistentry>
<replaceable class="parameter">variable</replaceable>
</arg>
</cmdsynopsis>
- <para>This command is used to set (and unset)
+ <para>This command is used to set (and unset)
<link linkend="variables">configuration variables</link>. There are
- four basic types of variables: boolean, number, string and quadoption.
- <emphasis>boolean</emphasis>variables can be
- <emphasis>set</emphasis>(true) or
- <emphasis>unset</emphasis>(false).
+ four basic types of variables: boolean, number, string and quadoption.
+ <emphasis>boolean</emphasis>variables can be
+ <emphasis>set</emphasis>(true) or
+ <emphasis>unset</emphasis>(false).
<emphasis>number</emphasis>variables can be assigned a positive integer
- value.
+ value.
<emphasis>string</emphasis>variables consist of any number of printable
characters and must be enclosed in quotes if they contain spaces or
- tabs. You may also use the escape sequences
- <quote>\n</quote>and
- <quote>\t</quote>for newline and tab, respectively.
+ tabs. You may also use the escape sequences
+ <quote>\n</quote>and
+ <quote>\t</quote>for newline and tab, respectively.
<emphasis>quadoption</emphasis>variables are used to control whether or
not to be prompted for certain actions, or to specify a default action.
- A value of
+ A value of
<emphasis>yes</emphasis>will cause the action to be carried out
automatically as if you had answered yes to the question. Similarly, a
- value of
+ value of
<emphasis>no</emphasis>will cause the action to be carried out as if
- you had answered
- <quote>no.</quote>A value of
+ you had answered
+ <quote>no.</quote>A value of
<emphasis>ask-yes</emphasis>will cause a prompt with a default answer
- of
- <quote>yes</quote>and
- <emphasis>ask-no</emphasis>will provide a default answer of
+ of
+ <quote>yes</quote>and
+ <emphasis>ask-no</emphasis>will provide a default answer of
<quote>no.</quote></para>
- <para>Prefixing a variable with
- <quote>no</quote>will unset it. Example:
+ <para>Prefixing a variable with
+ <quote>no</quote>will unset it. Example:
<literal>
<command>set</command>noaskbcc</literal>.</para>
- <para>For
+ <para>For
<emphasis>boolean</emphasis>variables, you may optionally prefix the
- variable name with
+ variable name with
<literal>inv</literal>to toggle the value (on or off). This is useful
- when writing macros. Example:
+ when writing macros. Example:
<literal>
<command>set</command>invsmart_wrap</literal>.</para>
- <para>The
- <command>toggle</command>command automatically prepends the
+ <para>The
+ <command>toggle</command>command automatically prepends the
<literal>inv</literal>prefix to all specified variables.</para>
- <para>The
- <command>unset</command>command automatically prepends the
+ <para>The
+ <command>unset</command>command automatically prepends the
<literal>no</literal>prefix to all specified variables.</para>
- <para>Using the
- <literal><enter-command></literal>function in the
+ <para>Using the
+ <literal><enter-command></literal>function in the
<emphasis>index</emphasis>menu, you can query the value of a variable
by prefixing the name of the variable with a question mark:</para>
<screen>set ?allow_8bit</screen>
<para>The question mark is actually only required for boolean and
quadoption variables.</para>
- <para>The
+ <para>The
<command>reset</command>command resets all given variables to the
compile time defaults (hopefully mentioned in this manual). If you use
- the command
- <command>set</command>and prefix the variable with
- <quote>&</quote>this has the same behavior as the
+ the command
+ <command>set</command>and prefix the variable with
+ <quote>&</quote>this has the same behavior as the
<command>reset</command>command.</para>
- <para>With the
- <command>reset</command>command there exists the special variable
+ <para>With the
+ <command>reset</command>command there exists the special variable
<quote>all</quote>, which allows you to reset all variables to their
system defaults.</para>
</sect2>
<sect3 id="set-myvar-intro">
<title>Introduction</title>
- <para>Along with the variables listed in the
+ <para>Along with the variables listed in the
<link linkend="variables">Configuration variables</link>section, Mutt
- supports user-defined variables with names starting with
- <literal>my_</literal>as in, for example,
+ supports user-defined variables with names starting with
+ <literal>my_</literal>as in, for example,
<literal>my_cfgdir</literal>.</para>
- <para>The
- <command>set</command>command either creates a custom
+ <para>The
+ <command>set</command>command either creates a custom
<literal>my_</literal>variable or changes its value if it does exist
- already. The
- <command>unset</command>and
+ already. The
+ <command>unset</command>and
<command>reset</command>commands remove the variable entirely.</para>
<para>Since user-defined variables are expanded in the same way that
- environment variables are (except for the
+ environment variables are (except for the
<link linkend="shell-escape">shell-escape</link>command and backtick
expansion), this feature can be used to make configuration files more
readable.</para>
<sect3 id="set-myvar-examples">
<title>Examples</title>
- <para>The following example defines and uses the variable
- <literal>my_cfgdir</literal>to abbreviate the calls of the
+ <para>The following example defines and uses the variable
+ <literal>my_cfgdir</literal>to abbreviate the calls of the
<link linkend="source">
<command>source</command>
</link>command:</para>
</example>
<para>A custom variable can also be used in macros to backup the
current value of another variable. In the following example, the
- value of the
+ value of the
<link linkend="delete">$delete</link>is changed temporarily while its
- original value is saved as
+ original value is saved as
<literal>my_delete</literal>. After the macro has executed all
- commands, the original value of
+ commands, the original value of
<link linkend="delete">$delete</link>is restored.</para>
<example id="ex-myvar2">
<title>Using user-defined variables for backing up other config
</screen>
</example>
<para>Since Mutt expands such values already when parsing the
- configuration file(s), the value of
+ configuration file(s), the value of
<literal>$my_delete</literal>in the last example would be the value
- of
+ of
<link linkend="delete">$delete</link>exactly as it was at that point
during parsing the configuration file. If another statement would
- change the value for
+ change the value for
<link linkend="delete">$delete</link>later in the same or another
- file, it would have no effect on
+ file, it would have no effect on
<literal>$my_delete</literal>. However, the expansion can be deferred
to runtime, as shown in the next example, when escaping the dollar
sign.</para>
<enter-command> unset my_old_pager_stop<Enter>"
</screen>
</example>
- <para>Note that there is a space between
- <literal><enter-command></literal>and the
+ <para>Note that there is a space between
+ <literal><enter-command></literal>and the
<command>set</command>configuration command, preventing Mutt from
- recording the
+ recording the
<command>macro</command>'s commands into its history.</para>
</sect3>
</sect2>
back into string. As a result, any variable can be assigned any value
given that its content is valid for the target. This also counts for
custom variables which are of type string. In case of parsing errors,
- Mutt will print error messages.
+ Mutt will print error messages.
<xref linkend="ex-myvar4" />demonstrates type conversions.</para>
<example id="ex-myvar4">
<title>Type conversions using variables</title>
set my_sort = "date-received" <emphasis role="comment"># value is string "date-received"</emphasis>
set sort = "last-$my_sort" <emphasis role="comment"># value is sort last-date-received</emphasis>
set my_inc = $read_inc <emphasis role="comment"># value is string "10" (default of $read_inc)</emphasis>
-set my_foo = $my_inc
+set my_foo = $my_inc
<emphasis role="comment"># value is string "10"</emphasis>
</screen>
</example>
- <para>These assignments are all valid. If, however, the value of
- <literal>$my_lines</literal>would have been
+ <para>These assignments are all valid. If, however, the value of
+ <literal>$my_lines</literal>would have been
<quote>five</quote>(or something else that cannot be parsed into a
- number), the assignment to
+ number), the assignment to
<literal>$pager_index_lines</literal>would have produced an error
message.</para>
<para>Type conversion applies to all configuration commands which take
set my_number = "10"
<emphasis role="comment"># same as: score ~A +10</emphasis>
score $my_pattern +$my_number</screen>
- <para>What does
+ <para>What does
<emphasis>not</emphasis>work is:</para>
<screen>
set my_mx = "+mailbox1 +mailbox2"
mailboxes $my_mx +mailbox3</screen>
- <para>because the value of
- <literal>$my_mx</literal>is interpreted as a single mailbox named
+ <para>because the value of
+ <literal>$my_mx</literal>is interpreted as a single mailbox named
<quote>+mailbox1 +mailbox2</quote>and not two distinct
mailboxes.</para>
</sect2>
</arg>
</cmdsynopsis>
<para>This command allows the inclusion of initialization commands from
- other files. For example, I place all of my aliases in
- <literal>~/.mail_aliases</literal>so that I can make my
+ other files. For example, I place all of my aliases in
+ <literal>~/.mail_aliases</literal>so that I can make my
<literal>~/.muttrc</literal>readable and keep my aliases private.</para>
<para>If the filename begins with a tilde (
<quote>~</quote>), it will be expanded to the path of your home
directory.</para>
<para>If the filename ends with a vertical bar (
- <quote>|</quote>), then
+ <quote>|</quote>), then
<emphasis>filename</emphasis>is considered to be an executable program
- from which to read input (e.g.
+ from which to read input (e.g.
<literal>
<command>source</command>~/bin/myscript|</literal>).</para>
</sect1>
</group>
</cmdsynopsis>
<para>This command permits you to flush hooks you have previously
- defined. You can either remove all hooks by giving the
+ defined. You can either remove all hooks by giving the
<quote>*</quote>character as an argument, or you can remove all hooks of
- a specific type by saying something like
+ a specific type by saying something like
<literal>
<command>unhook</command>send-hook</literal>.</para>
</sect1>
<sect2 id="formatstrings-basics">
<title>Basic usage</title>
<para>Format strings are a general concept you'll find in several
- locations through the Mutt configuration, especially in the
- <link linkend="index-format">$index_format</link>,
- <link linkend="pager-format">$pager_format</link>,
+ locations through the Mutt configuration, especially in the
+ <link linkend="index-format">$index_format</link>,
+ <link linkend="pager-format">$pager_format</link>,
<link linkend="status-format">$status_format</link>, and other related
variables. These can be very straightforward, and it's quite possible
you already know how to use them.</para>
<para>The most basic format string element is a percent symbol followed
- by another character. For example,
- <literal>%s</literal>represents a message's Subject: header in the
- <link linkend="index-format">$index_format</link>variable. The
+ by another character. For example,
+ <literal>%s</literal>represents a message's Subject: header in the
+ <link linkend="index-format">$index_format</link>variable. The
<quote>expandos</quote>available are documented with each format
variable, but there are general modifiers available with all formatting
expandos, too. Those are our concern here.</para>
<para>Some of the modifiers are borrowed right out of C (though you
might know them from Perl, Python, shell, or another language). These
- are the
- <literal>[-]m.n</literal>modifiers, as in
+ are the
+ <literal>[-]m.n</literal>modifiers, as in
<literal>%-12.12s</literal>. As with such programming languages, these
modifiers allow you to specify the minimum and maximum size of the
- resulting string, as well as its justification. If the
+ resulting string, as well as its justification. If the
<quote>-</quote>sign follows the percent, the string will be
left-justified instead of right-justified. If there's a number
immediately following that, it's the minimum amount of space the
follow, that's the maximum space allowable — the string will not be
permitted to exceed that width, no matter its natural size. Each of
these three elements is optional, so that all these are legal format
- strings:
- <literal>%-12s</literal>,
- <literal>%4c</literal>,
- <literal>%.15F</literal>and
+ strings:
+ <literal>%-12s</literal>,
+ <literal>%4c</literal>,
+ <literal>%.15F</literal>and
<literal>%-12.15L</literal>.</para>
<para>Mutt adds some other modifiers to format strings. If you use an
equals symbol (
<literal>=</literal>) as a numeric prefix (like the minus above), it
will force the string to be centered within its minimum space range.
- For example,
+ For example,
<literal>%=14y</literal>will reserve 14 characters for the %y expansion
— that's the set of message keywords (formerly X-Label). If the
expansion results in a string less than 14 characters, it will be
- centered in a 14-character space. If the X-Label for a message were
- <quote>test</quote>, that expansion would look like
+ centered in a 14-character space. If the X-Label for a message were
+ <quote>test</quote>, that expansion would look like
<quote>
     test     </quote>.</para>
<para>There are two very little-known modifiers that affect the way
optionally print a string based upon one of the above sequences, the
following construct is used:</para>
<screen>%?<sequence_char>?<optional_string>?</screen>
- <para>where
- <emphasis>sequence_char</emphasis>is an expando, and
+ <para>where
+ <emphasis>sequence_char</emphasis>is an expando, and
<emphasis>optional_string</emphasis>is the string you would like
- printed if
- <emphasis>sequence_char</emphasis>is nonzero.
+ printed if
+ <emphasis>sequence_char</emphasis>is nonzero.
<emphasis>optional_string</emphasis>may contain other sequences as well
as normal text, but you may not nest optional strings.</para>
<para>Here is an example illustrating how to optionally print the
- number of new messages in a mailbox in
+ number of new messages in a mailbox in
<link linkend="status-format">$status_format</link>:</para>
<screen>%?n?%n new messages.?</screen>
<para>You can also switch between two strings using the following
construct:</para>
<screen>%?<sequence_char>?<if_string>&<else_string>?</screen>
- <para>If the value of
- <emphasis>sequence_char</emphasis>is non-zero,
- <emphasis>if_string</emphasis>will be expanded, otherwise
+ <para>If the value of
+ <emphasis>sequence_char</emphasis>is non-zero,
+ <emphasis>if_string</emphasis>will be expanded, otherwise
<emphasis>else_string</emphasis>will be expanded.</para>
<para>The conditional sequences can also be nested by using the %<
and > operators. The %? notation can still be used but requires
%<x?true&false>
%<x?%<y?%<z?xyz&xy>&x>&none>
</screen>
- <para>For more examples, see
+ <para>For more examples, see
<xref linkend="nested-if" /></para>
</sect2>
<title>Using external filters in format strings</title>
<screen>set status_format="script.sh '%r %f (%L)'|"</screen>
</example>
- <para>will make Mutt expand
- <literal>%r</literal>,
- <literal>%f</literal>and
+ <para>will make Mutt expand
+ <literal>%r</literal>,
+ <literal>%f</literal>and
<literal>%L</literal>before calling the script. The example also shows
that arguments can be quoted: the script will receive the expanded
string between the single quotes as the only argument.</para>
- <para>A practical example is the
- <literal>mutt_xtitle</literal>script installed in the
+ <para>A practical example is the
+ <literal>mutt_xtitle</literal>script installed in the
<literal>samples</literal>subdirectory of the Mutt documentation: it
- can be used as filter for
+ can be used as filter for
<link linkend="status-format">$status_format</link>to set the current
terminal's title, if supported.</para>
</sect2>
</term>
<listitem>
<para>When this occurs, Mutt will fill the rest of the line with
- the character
+ the character
<literal>X</literal>. For example, filling the rest of the line
with dashes is done by setting:</para>
<screen>set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</screen>
</term>
<listitem>
<para>Since the previous expando stops at the end of line, there
- must be a way to fill the gap between two items via the
- <literal>%>X</literal>expando: it puts as many characters
+ must be a way to fill the gap between two items via the
+ <literal>%>X</literal>expando: it puts as many characters
<literal>X</literal>in between two items so that the rest of the
line will be right-justified. For example, to not put the version
string and hostname the above example on the left but on the
right and fill the gap with spaces, one might use (note the space
- after
+ after
<literal>%></literal>):</para>
<screen>set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</screen>
</listitem>
</term>
<listitem>
<para>Normal right-justification will print everything to the
- left of the
+ left of the
<literal>%></literal>, displaying padding and whatever lies to
- the right only if there's room. By contrast,
+ the right only if there's room. By contrast,
<quote>soft-fill</quote>gives priority to the right-hand side,
guaranteeing space to display it and showing padding only if
there's still room. If necessary, soft-fill will eat text
leftwards to make room for rightward text. For example, to
right-justify the subject making sure as much as possible of it
- fits on screen, one might use (note two spaces after
+ fits on screen, one might use (note two spaces after
<literal>%*</literal>: the second ensures there's a space between
the truncated right-hand side and the subject):</para>
<screen>set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"</screen>
on how recent the message is. This is especially useful in combination
with David Champion's patch to allow if-else sequences to be
nested.</para>
- <para>For example, using
+ <para>For example, using
<literal>
%<[y?%<[d?%[%H:%M]&%[%m/%d]>&%[%y.%m]></literal>for
- the date in the
+ the date in the
<literal>$index_format</literal>will produce a display like:</para>
<screen>
1 + 14.12 Grace Hall ( 13) Gulliver's Travels
</group>
</cmdsynopsis>
<para>As a security measure, Mutt will only add user-approved header
- fields from a
+ fields from a
<literal>mailto:</literal>URL. This is necessary since Mutt will handle
- certain header fields, such as
- <literal>Attach:</literal>, in a special way. The
- <literal>mailto_allow</literal>and
+ certain header fields, such as
+ <literal>Attach:</literal>, in a special way. The
+ <literal>mailto_allow</literal>and
<literal>unmailto_allow</literal>commands allow the user to modify the
list of approved headers.</para>
- <para>Mutt initializes the default list to contain only the
- <literal>Subject</literal>and
+ <para>Mutt initializes the default list to contain only the
+ <literal>Subject</literal>and
<literal>Body</literal>header fields, which are the only requirement
- specified by the
+ specified by the
<literal>mailto:</literal>specification in RFC2368.</para>
</sect1>
</chapter>
<sect1 id="charset-handling">
<title>Character Set Handling</title>
- <para>A
+ <para>A
<quote>character set</quote>is basically a mapping between bytes and
glyphs and implies a certain character encoding scheme. For example, for
the ISO 8859 family of character sets, an encoding of 8bit per character
encoding. There exists no way to reliably deduce the character set a
plain text file has. Interoperability is gained by the use of
well-defined environment variables. The full set can be printed by
- issuing
+ issuing
<literal>locale</literal>on the command line.</para>
<para>Upon startup, Mutt determines the character set on its own using
routines that inspect locale-specific environment variables. Therefore,
- it is generally not necessary to set the
+ it is generally not necessary to set the
<literal>$charset</literal>variable in Mutt. It may even be
counter-productive as Mutt uses system and library functions that derive
the character set themselves and on which Mutt has no influence. It's
expectations about the character set between Mutt and external
programs.</para>
<para>The terminal emulator used also must be properly configured for the
- current locale. Terminal emulators usually do
+ current locale. Terminal emulators usually do
<emphasis>not</emphasis>derive the locale from environment variables,
they need to be configured separately. If the terminal is incorrectly
configured, Mutt may display random and unexpected characters (question
marks, octal codes, or just random glyphs), format strings may not work
as expected, you may not be abled to enter non-ascii characters, and
possible more. Data is always represented using bytes and so a correct
- setup is very important as to the machine, all character sets
+ setup is very important as to the machine, all character sets
<quote>look</quote>the same.</para>
<para>Warning: A mismatch between what system and library functions think
the locale is and what Mutt was told what the locale is may make it
behave badly with non-ascii input: it will fail at seemingly random
places. This warning is to be taken seriously since not only local mail
handling may suffer: sent messages may carry wrong character set
- information the
- <emphasis>receiver</emphasis>has too deal with. The need to set
+ information the
+ <emphasis>receiver</emphasis>has too deal with. The need to set
<literal>$charset</literal>directly in most cases points at terminal and
environment variable setup problems, not Mutt problems.</para>
<para>A list of officially assigned and known character sets can be found
- at
+ at
<ulink url="http://www.iana.org/assignments/character-sets">IANA</ulink>,
- a list of locally supported locales can be obtained by running
+ a list of locally supported locales can be obtained by running
<literal>locale -a</literal>.</para>
</sect1>
<sect1 id="regexp">
<title>Regular Expressions</title>
- <para>All string patterns in Mutt including those in more complex
+ <para>All string patterns in Mutt including those in more complex
<link linkend="patterns">patterns</link>must be specified using regular
- expressions (regexp) in the
+ expressions (regexp) in the
<quote>POSIX extended</quote>syntax (which is more or less the syntax
used by egrep and GNU awk). For your convenience, we have included below
a brief description of this syntax.</para>
<note>
<para>
<quote>\</quote>must be quoted if used for a regular expression in an
- initialization command:
+ initialization command:
<quote>\\</quote>.</para>
</note>
<para>A regular expression is a pattern that describes a set of strings.
<note>
<para>The regular expression can be enclosed/delimited by either " or '
which is useful if the regular expression includes a white-space
- character. See
+ character. See
<xref linkend="muttrc-syntax" />for more information on " and '
delimiter processing. To match a literal " or ' you must preface it
with \ (backslash).</para>
digits, are regular expressions that match themselves. Any metacharacter
with special meaning may be quoted by preceding it with a
backslash.</para>
- <para>The period
- <quote>.</quote>matches any single character. The caret
- <quote>^</quote>and the dollar sign
+ <para>The period
+ <quote>.</quote>matches any single character. The caret
+ <quote>^</quote>and the dollar sign
<quote>$</quote>are metacharacters that respectively match the empty
string at the beginning and end of a line.</para>
- <para>A list of characters enclosed by
- <quote>[</quote>and
+ <para>A list of characters enclosed by
+ <quote>[</quote>and
<quote>]</quote>matches any single character in that list; if the first
- character of the list is a caret
- <quote>^</quote>then it matches any character
- <emphasis>not</emphasis>in the list. For example, the regular expression
+ character of the list is a caret
+ <quote>^</quote>then it matches any character
+ <emphasis>not</emphasis>in the list. For example, the regular expression
<emphasis>[0123456789]</emphasis>matches any single digit. A range of
ASCII characters may be specified by giving the first and last
- characters, separated by a hyphen
+ characters, separated by a hyphen
<quote>-</quote>. Most metacharacters lose their special meaning inside
- lists. To include a literal
+ lists. To include a literal
<quote>]</quote>place it first in the list. Similarly, to include a
- literal
+ literal
<quote>^</quote>place it anywhere but first. Finally, to include a
- literal hyphen
+ literal hyphen
<quote>-</quote>place it last.</para>
<para>Certain named classes of characters are predefined. Character
- classes consist of
- <quote>[:</quote>, a keyword denoting the class, and
+ classes consist of
+ <quote>[:</quote>, a keyword denoting the class, and
<quote>:]</quote>. The following classes are defined by the POSIX
- standard in
+ standard in
<xref linkend="posix-regex-char-classes" /></para>
<table id="posix-regex-char-classes">
<row>
<entry>[:graph:]</entry>
<entry>Characters that are both printable and visible. (A space
- is printable, but not visible, while an
+ is printable, but not visible, while an
<quote>a</quote>is both)</entry>
</row>
<row>
<note>
<para>Note that the brackets in these class names are part of the
symbolic names, and must be included in addition to the brackets
- delimiting the bracket list. For example,
- <emphasis>[[:digit:]]</emphasis>is equivalent to
+ delimiting the bracket list. For example,
+ <emphasis>[[:digit:]]</emphasis>is equivalent to
<emphasis>[0-9]</emphasis>.</para>
</note>
<para>Two additional special sequences can appear in character lists.
<term>Collating Symbols</term>
<listitem>
<para>A collating symbol is a multi-character collating element
- enclosed in
- <quote>[.</quote>and
- <quote>.]</quote>. For example, if
- <quote>ch</quote>is a collating element, then
+ enclosed in
+ <quote>[.</quote>and
+ <quote>.]</quote>. For example, if
+ <quote>ch</quote>is a collating element, then
<emphasis>[[.ch.]]</emphasis>is a regexp that matches this
- collating element, while
- <emphasis>[ch]</emphasis>is a regexp that matches either
- <quote>c</quote>or
+ collating element, while
+ <emphasis>[ch]</emphasis>is a regexp that matches either
+ <quote>c</quote>or
<quote>h</quote>.</para>
</listitem>
</varlistentry>
<term>Equivalence Classes</term>
<listitem>
<para>An equivalence class is a locale-specific name for a list of
- characters that are equivalent. The name is enclosed in
- <quote>[=</quote>and
- <quote>=]</quote>. For example, the name
- <quote>e</quote>might be used to represent all of
+ characters that are equivalent. The name is enclosed in
+ <quote>[=</quote>and
+ <quote>=]</quote>. For example, the name
+ <quote>e</quote>might be used to represent all of
<quote>e</quote>with grave (
- <quote>è</quote>),
+ <quote>è</quote>),
<quote>e</quote>with acute (
- <quote>é</quote>) and
- <quote>e</quote>. In this case,
- <emphasis>[[=e=]]</emphasis>is a regexp that matches any of:
+ <quote>é</quote>) and
+ <quote>e</quote>. In this case,
+ <emphasis>[[=e=]]</emphasis>is a regexp that matches any of:
<quote>e</quote>with grave (
- <quote>è</quote>),
+ <quote>è</quote>),
<quote>e</quote>with acute (
- <quote>é</quote>) and
+ <quote>é</quote>) and
<quote>e</quote>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>A regular expression matching a single character may be followed by
- one of several repetition operators described in
+ one of several repetition operators described in
<xref linkend="regex-repeat" />.</para>
<table id="regex-repeat">
</row>
<row>
<entry>{n}</entry>
- <entry>The preceding item is matched exactly
+ <entry>The preceding item is matched exactly
<emphasis>n</emphasis>times</entry>
</row>
<row>
<entry>{n,}</entry>
- <entry>The preceding item is matched
+ <entry>The preceding item is matched
<emphasis>n</emphasis>or more times</entry>
</row>
<row>
<entry>{,m}</entry>
- <entry>The preceding item is matched at most
+ <entry>The preceding item is matched at most
<emphasis>m</emphasis>times</entry>
</row>
<row>
<entry>{n,m}</entry>
- <entry>The preceding item is matched at least
- <emphasis>n</emphasis>times, but no more than
+ <entry>The preceding item is matched at least
+ <emphasis>n</emphasis>times, but no more than
<emphasis>m</emphasis>times</entry>
</row>
</tbody>
<para>Two regular expressions may be concatenated; the resulting regular
expression matches any string formed by concatenating two substrings that
respectively match the concatenated subexpressions.</para>
- <para>Two regular expressions may be joined by the infix operator
+ <para>Two regular expressions may be joined by the infix operator
<quote>|</quote>; the resulting regular expression matches any string
matching either subexpression.</para>
<para>Repetition takes precedence over concatenation, which in turn takes
<note>
<para>If you compile Mutt with the included regular expression engine,
the following operators may also be used in regular expressions as
- described in
+ described in
<xref linkend="regex-gnu-ext" />.</para>
</note>
<sect2 id="patterns-modifier">
<title>Pattern Modifier</title>
<para>Many of Mutt's commands allow you to specify a pattern to match (
- <literal>limit</literal>,
- <literal>tag-pattern</literal>,
- <literal>delete-pattern</literal>, etc.).
+ <literal>limit</literal>,
+ <literal>tag-pattern</literal>,
+ <literal>delete-pattern</literal>, etc.).
<xref linkend="tab-patterns" />shows several ways to select
messages.</para>
<entry>all messages</entry>
</row>
<row>
- <entry>~b
+ <entry>~b
<emphasis>EXPR</emphasis></entry>
- <entry>messages which contain
+ <entry>messages which contain
<emphasis>EXPR</emphasis>in the message body</entry>
</row>
<row>
- <entry>=b
+ <entry>=b
<emphasis>STRING</emphasis></entry>
- <entry>messages which contain
+ <entry>messages which contain
<emphasis>STRING</emphasis>in the message body. If IMAP is
- enabled, searches for
+ enabled, searches for
<emphasis>STRING</emphasis>on the server, rather than
downloading each message and searching it locally.</entry>
</row>
<row>
- <entry>~B
+ <entry>~B
<emphasis>EXPR</emphasis></entry>
- <entry>messages which contain
+ <entry>messages which contain
<emphasis>EXPR</emphasis>in the whole message</entry>
</row>
<row>
- <entry>=B
+ <entry>=B
<emphasis>STRING</emphasis></entry>
- <entry>messages which contain
+ <entry>messages which contain
<emphasis>STRING</emphasis>in the whole message. If IMAP is
- enabled, searches for
+ enabled, searches for
<emphasis>STRING</emphasis>on the server, rather than
downloading each message and searching it locally.</entry>
</row>
<row>
- <entry>~c
+ <entry>~c
<emphasis>EXPR</emphasis></entry>
- <entry>messages carbon-copied to
+ <entry>messages carbon-copied to
<emphasis>EXPR</emphasis></entry>
</row>
<row>
- <entry>%c
+ <entry>%c
<emphasis>GROUP</emphasis></entry>
- <entry>messages carbon-copied to any member of
+ <entry>messages carbon-copied to any member of
<emphasis>GROUP</emphasis></entry>
</row>
<row>
- <entry>~C
+ <entry>~C
<emphasis>EXPR</emphasis></entry>
- <entry>messages either to: or cc:
+ <entry>messages either to: or cc:
<emphasis>EXPR</emphasis></entry>
</row>
<row>
- <entry>%C
+ <entry>%C
<emphasis>GROUP</emphasis></entry>
- <entry>messages either to: or cc: to any member of
+ <entry>messages either to: or cc: to any member of
<emphasis>GROUP</emphasis></entry>
</row>
<row>
<entry>~d [
<emphasis>MIN</emphasis>]-[
<emphasis>MAX</emphasis>]</entry>
- <entry>messages with
+ <entry>messages with
<quote>date-sent</quote>in a Date range</entry>
</row>
<row>
<entry>deleted messages</entry>
</row>
<row>
- <entry>~e
+ <entry>~e
<emphasis>EXPR</emphasis></entry>
- <entry>messages which contains
- <emphasis>EXPR</emphasis>in the
+ <entry>messages which contains
+ <emphasis>EXPR</emphasis>in the
<quote>Sender</quote>field</entry>
</row>
<row>
- <entry>%e
+ <entry>%e
<emphasis>GROUP</emphasis></entry>
- <entry>messages which contain a member of
- <emphasis>GROUP</emphasis>in the
+ <entry>messages which contain a member of
+ <emphasis>GROUP</emphasis>in the
<quote>Sender</quote>field</entry>
</row>
<row>
<entry>flagged messages</entry>
</row>
<row>
- <entry>~f
+ <entry>~f
<emphasis>EXPR</emphasis></entry>
- <entry>messages originating from
+ <entry>messages originating from
<emphasis>EXPR</emphasis></entry>
</row>
<row>
- <entry>%f
+ <entry>%f
<emphasis>GROUP</emphasis></entry>
- <entry>messages originating from any member of
+ <entry>messages originating from any member of
<emphasis>GROUP</emphasis></entry>
</row>
<row>
<entry>cryptographically encrypted messages</entry>
</row>
<row>
- <entry>~h
+ <entry>~h
<emphasis>EXPR</emphasis></entry>
- <entry>messages which contain
+ <entry>messages which contain
<emphasis>EXPR</emphasis>in the message header</entry>
</row>
<row>
- <entry>=h
+ <entry>=h
<emphasis>STRING</emphasis></entry>
- <entry>messages which contain
+ <entry>messages which contain
<emphasis>STRING</emphasis>in the message header. If IMAP is
- enabled, searches for
+ enabled, searches for
<emphasis>STRING</emphasis>on the server, rather than
- downloading each message and searching it locally;
- <emphasis>STRING</emphasis>must be of the form
+ downloading each message and searching it locally;
+ <emphasis>STRING</emphasis>must be of the form
<quote>header: substring</quote>(see below).</entry>
</row>
<row>
- <entry>~H
+ <entry>~H
<emphasis>EXPR</emphasis></entry>
- <entry>messages with a spam attribute matching
+ <entry>messages with a spam attribute matching
<emphasis>EXPR</emphasis></entry>
</row>
<row>
- <entry>~i
+ <entry>~i
<emphasis>EXPR</emphasis></entry>
- <entry>messages which match
- <emphasis>EXPR</emphasis>in the
+ <entry>messages which match
+ <emphasis>EXPR</emphasis>in the
<quote>Message-ID</quote>field</entry>
</row>
<row>
<entry>messages which contain PGP key material</entry>
</row>
<row>
- <entry>~L
+ <entry>~L
<emphasis>EXPR</emphasis></entry>
- <entry>messages either originated or received by
+ <entry>messages either originated or received by
<emphasis>EXPR</emphasis></entry>
</row>
<row>
- <entry>%L
+ <entry>%L
<emphasis>GROUP</emphasis></entry>
- <entry>message either originated or received by any member of
+ <entry>message either originated or received by any member of
<emphasis>GROUP</emphasis></entry>
</row>
<row>
<entry>~m [
<emphasis>MIN</emphasis>]-[
<emphasis>MAX</emphasis>]</entry>
- <entry>messages with numbers in the range
- <emphasis>MIN</emphasis>to
+ <entry>messages with numbers in the range
+ <emphasis>MIN</emphasis>to
<emphasis>MAX</emphasis>***)</entry>
</row>
<row>
<entry>~m <[
<emphasis>MAX</emphasis>]</entry>
- <entry>messages with numbers less than
+ <entry>messages with numbers less than
<emphasis>MAX</emphasis>***)</entry>
</row>
<row>
<entry>~m >[
<emphasis>MIN</emphasis>]</entry>
- <entry>messages with numbers greater than
+ <entry>messages with numbers greater than
<emphasis>MIN</emphasis>***)</entry>
</row>
<row>
<entry>~m [
<emphasis>M</emphasis>]</entry>
- <entry>just message number
+ <entry>just message number
<emphasis>M</emphasis>***)</entry>
</row>
<row>
<emphasis>MIN</emphasis>],[
<emphasis>MAX</emphasis>]</entry>
<entry>messages with offsets (from selected message) in the
- range
- <emphasis>MIN</emphasis>to
+ range
+ <emphasis>MIN</emphasis>to
<emphasis>MAX</emphasis>***)</entry>
</row>
<row>
<entry>~n [
<emphasis>MIN</emphasis>]-[
<emphasis>MAX</emphasis>]</entry>
- <entry>messages with a score in the range
- <emphasis>MIN</emphasis>to
+ <entry>messages with a score in the range
+ <emphasis>MIN</emphasis>to
<emphasis>MAX</emphasis>*)</entry>
</row>
<row>
</row>
<row>
<entry>~p</entry>
- <entry>messages addressed to you (consults
+ <entry>messages addressed to you (consults
<command>alternates</command>)</entry>
</row>
<row>
<entry>~P</entry>
- <entry>messages from you (consults
+ <entry>messages from you (consults
<command>alternates</command>)</entry>
</row>
<row>
<entry>~r [
<emphasis>MIN</emphasis>]-[
<emphasis>MAX</emphasis>]</entry>
- <entry>messages with
+ <entry>messages with
<quote>date-received</quote>in a Date range</entry>
</row>
<row>
<entry>read messages</entry>
</row>
<row>
- <entry>~s
+ <entry>~s
<emphasis>EXPR</emphasis></entry>
- <entry>messages having
- <emphasis>EXPR</emphasis>in the
+ <entry>messages having
+ <emphasis>EXPR</emphasis>in the
<quote>Subject</quote>field.</entry>
</row>
<row>
<entry>superseded messages</entry>
</row>
<row>
- <entry>~t
+ <entry>~t
<emphasis>EXPR</emphasis></entry>
- <entry>messages addressed to
+ <entry>messages addressed to
<emphasis>EXPR</emphasis></entry>
</row>
<row>
<entry>cryptographically verified messages</entry>
</row>
<row>
- <entry>~x
+ <entry>~x
<emphasis>EXPR</emphasis></entry>
- <entry>messages which contain
- <emphasis>EXPR</emphasis>in the
- <quote>References</quote>or
+ <entry>messages which contain
+ <emphasis>EXPR</emphasis>in the
+ <quote>References</quote>or
<quote>In-Reply-To</quote>field</entry>
</row>
<row>
<entry>~X [
<emphasis>MIN</emphasis>]-[
<emphasis>MAX</emphasis>]</entry>
- <entry>messages with
- <emphasis>MIN</emphasis>to
+ <entry>messages with
+ <emphasis>MIN</emphasis>to
<emphasis>MAX</emphasis>attachments *)</entry>
</row>
<row>
- <entry>~y
+ <entry>~y
<emphasis>EXPR</emphasis></entry>
- <entry>messages which contain
+ <entry>messages which contain
<emphasis>EXPR</emphasis>in their keywords</entry>
</row>
<row>
<entry>~z [
<emphasis>MIN</emphasis>]-[
<emphasis>MAX</emphasis>]</entry>
- <entry>messages with a size in the range
- <emphasis>MIN</emphasis>to
+ <entry>messages with a size in the range
+ <emphasis>MIN</emphasis>to
<emphasis>MAX</emphasis>*) **)</entry>
</row>
<row>
<entry>~=</entry>
- <entry>duplicated messages (see
+ <entry>duplicated messages (see
<link linkend="duplicate-threads">
$duplicate_threads</link>)</entry>
</row>
<row>
<entry>~(
<emphasis>PATTERN</emphasis>)</entry>
- <entry>messages in threads containing messages matching
+ <entry>messages in threads containing messages matching
<emphasis>PATTERN</emphasis>, e.g. all threads containing
messages from you: ~(~P)</entry>
</row>
</tbody>
</tgroup>
</table>
- <para>Where
- <emphasis>EXPR</emphasis>is a
- <link linkend="regexp">regular expression</link>, and
- <emphasis>GROUP</emphasis>is an
+ <para>Where
+ <emphasis>EXPR</emphasis>is a
+ <link linkend="regexp">regular expression</link>, and
+ <emphasis>GROUP</emphasis>is an
<link linkend="addrgroup">address group</link>.</para>
- <para>*) The forms
+ <para>*) The forms
<quote><[
- <emphasis>MAX</emphasis>]</quote>,
+ <emphasis>MAX</emphasis>]</quote>,
<quote>>[
- <emphasis>MIN</emphasis>]</quote>,
+ <emphasis>MIN</emphasis>]</quote>,
<quote>[
- <emphasis>MIN</emphasis>]-</quote>and
+ <emphasis>MIN</emphasis>]-</quote>and
<quote>-[
<emphasis>MAX</emphasis>]</quote>are allowed, too.</para>
- <para>**) The suffixes
- <quote>K</quote>and
+ <para>**) The suffixes
+ <quote>K</quote>and
<quote>M</quote>are allowed to specify kilobyte and megabyte
respectively.</para>
- <para>***) The message number ranges (introduced by
+ <para>***) The message number ranges (introduced by
<literal>~m</literal>) are even more general and powerful than the
- other types of ranges. Read on and see
+ other types of ranges. Read on and see
<xref linkend="message-ranges" />below.</para>
<para>Special attention has to be payed when using regular expressions
inside of patterns. Specifically, Mutt's parser for these patterns will
<quote>\</quote>), which is normally used for quoting. If it is your
intention to use a backslash in the regular expression, you will need
to use two backslashes instead (
- <quote>\\</quote>). You can force Mutt to treat
+ <quote>\\</quote>). You can force Mutt to treat
<emphasis>EXPR</emphasis>as a simple string instead of a regular
- expression by using = instead of ~ in the pattern name. For example,
+ expression by using = instead of ~ in the pattern name. For example,
<literal>=b *.*</literal>will find all messages that contain the
- literal string
+ literal string
<quote>*.*</quote>. Simple string matches are less powerful than
regular expressions but can be considerably faster. This is especially
true for IMAP folders, because string matches can be performed on the
- server instead of by fetching every message. IMAP treats
- <literal>=h</literal>specially: it must be of the form
+ server instead of by fetching every message. IMAP treats
+ <literal>=h</literal>specially: it must be of the form
<quote>header: substring</quote>and will not partially match header
names. The substring part may be omitted if you simply wish to find
messages containing a particular header without regard to its
<para>Patterns matching lists of addresses (notably c, C, p, P and t)
match if there is at least one match in the whole list. If you want to
make sure that all elements of that list match, you need to prefix your
- pattern with
+ pattern with
<quote>^</quote>. This example matches all mails which only has
recipients from Germany.</para>
<example id="ex-recips">
<sect3 id="message-ranges">
<title>Message Ranges</title>
<para>If a message number range (from now on: MNR) contains a comma (
- <literal>,</literal>), it is a
- <emphasis>relative</emphasis>MNR. That means the numbers denote
+ <literal>,</literal>), it is a
+ <emphasis>relative</emphasis>MNR. That means the numbers denote
<emphasis>offsets</emphasis>from the highlighted message. For
example:</para>
</tgroup>
</table>
<para>Lastly, you can also leave either side of the range blank, to
- make it extend as far as possible. For example,
- <literal>~m ,1</literal>has the same meaning as the last example in
+ make it extend as far as possible. For example,
+ <literal>~m ,1</literal>has the same meaning as the last example in
<xref linkend="mnrs-shortcuts" />.</para>
- <para>Otherwise, if a MNR
+ <para>Otherwise, if a MNR
<emphasis>doesn't</emphasis>contain a comma, the meaning is similar
to other ranges, except that the shortcuts are still available.
Examples:</para>
<sect2 id="simple-searches">
<title>Simple Searches</title>
- <para>Mutt supports two versions of so called
+ <para>Mutt supports two versions of so called
<quote>simple searches</quote>. These are issued if the query entered
for searching, limiting and similar operations does not seem to contain
a valid pattern modifier (i.e. it does not contain one of these
- characters:
- <quote>~</quote>,
- <quote>=</quote>or
+ characters:
+ <quote>~</quote>,
+ <quote>=</quote>or
<quote>%</quote>). If the query is supposed to contain one of these
special characters, they must be escaped by prepending a backslash (
<quote>\</quote>).</para>
<para>The first type is by checking whether the query string equals a
- keyword case-insensitively from
+ keyword case-insensitively from
<xref linkend="tab-simplesearch-keywords" />: If that is the case, Mutt
will use the shown pattern modifier instead. If a keyword would
conflict with your search keyword, you need to turn it into a regular
expression to avoid matching the keyword table. For example, if you
- want to find all messages matching
- <quote>flag</quote>(using
+ want to find all messages matching
+ <quote>flag</quote>(using
<link linkend="simple-search">$simple_search</link>) but don't want to
- match flagged messages, simply search for
+ match flagged messages, simply search for
<quote>
<literal>[f]lag</literal>
</quote>.</para>
</tgroup>
</table>
<para>The second type of simple search is to build a complex search
- pattern using
+ pattern using
<link linkend="simple-search">$simple_search</link>as a template. Mutt
will insert your query properly quoted and search for the composed
complex query.</para>
<para>Logical AND is performed by specifying more than one criterion.
For example:</para>
<screen>~t mutt ~f elkins</screen>
- <para>would select messages which contain the word
- <quote>mutt</quote>in the list of recipients
- <emphasis>and</emphasis>that have the word
- <quote>elkins</quote>in the
+ <para>would select messages which contain the word
+ <quote>mutt</quote>in the list of recipients
+ <emphasis>and</emphasis>that have the word
+ <quote>elkins</quote>in the
<quote>From</quote>header field.</para>
<para>Mutt also recognizes the following operators to create more
complex search patterns:</para>
</listitem>
</itemizedlist>
<para>Here is an example illustrating a complex search pattern. This
- pattern will select all messages which do not contain
- <quote>mutt</quote>in the
- <quote>To</quote>or
- <quote>Cc</quote>field and which are from
+ pattern will select all messages which do not contain
+ <quote>mutt</quote>in the
+ <quote>To</quote>or
+ <quote>Cc</quote>field and which are from
<quote>elkins</quote>.</para>
<example id="ex-pattern-bool">
<title>Using boolean operators in patterns</title>
<screen>!(~t mutt|~c mutt) ~f elkins</screen>
</example>
<para>Here is an example using white space in the regular expression
- (note the
- <quote>'</quote>and
+ (note the
+ <quote>'</quote>and
<quote>"</quote>delimiters). For this to match, the mail's subject must
- match the
- <quote>^Junk +From +Me$</quote>and it must be from either
- <quote>Jim +Somebody</quote>or
+ match the
+ <quote>^Junk +From +Me$</quote>and it must be from either
+ <quote>Jim +Somebody</quote>or
<quote>Ed +SomeoneElse</quote>:</para>
<screen>'~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'</screen>
<note>
<para>If a regular expression contains parenthesis, or a vertical bar
- ("|"), you
+ ("|"), you
<emphasis>must</emphasis>enclose the expression in double or single
quotes since those characters are also used to separate different
- parts of Mutt's pattern language. For example:
+ parts of Mutt's pattern language. For example:
<literal>~f "me@(mutt\.org|cs\.hmc\.edu)"</literal>Without the
quotes, the parenthesis wouldn't end. This would be separated to two
- OR'd patterns:
- <emphasis>~f me@(mutt\.org</emphasis>and
+ OR'd patterns:
+ <emphasis>~f me@(mutt\.org</emphasis>and
<emphasis>cs\.hmc\.edu)</emphasis>. They are never what you
want.</para>
</note>
<sect2 id="date-patterns">
<title>Searching by Date</title>
- <para>Mutt supports two types of dates,
- <emphasis>absolute</emphasis>and
+ <para>Mutt supports two types of dates,
+ <emphasis>absolute</emphasis>and
<emphasis>relative</emphasis>.</para>
<sect3 id="date-absolute">
<title>Absolute Dates</title>
- <para>Dates
+ <para>Dates
<emphasis>must</emphasis>be in DD/MM/YY format (month and year are
optional, defaulting to the current month and year). An example of a
valid range of dates is:</para>
<screen>Limit to messages matching: ~d 20/1/95-31/10</screen>
- <para>If you omit the minimum (first) date, and just specify
- <quote>-DD/MM/YY</quote>, all messages
+ <para>If you omit the minimum (first) date, and just specify
+ <quote>-DD/MM/YY</quote>, all messages
<emphasis>before</emphasis>the given date will be selected. If you
- omit the maximum (second) date, and specify
- <quote>DD/MM/YY-</quote>, all messages
+ omit the maximum (second) date, and specify
+ <quote>DD/MM/YY-</quote>, all messages
<emphasis>after</emphasis>the given date will be selected. If you
specify a single date with no dash (
<quote>-</quote>), only messages sent on the given date will be
selected.</para>
<para>You can add error margins to absolute dates. An error margin is
- a sign (+ or -), followed by a digit, followed by one of the units in
+ a sign (+ or -), followed by a digit, followed by one of the units in
<xref linkend="tab-date-units" />. As a special case, you can replace
- the sign by a
+ the sign by a
<quote>*</quote>character, which is equivalent to giving identical
plus and minus error margins.</para>
<itemizedlist>
<listitem>
<para>>
- <emphasis>offset</emphasis>for messages older than
+ <emphasis>offset</emphasis>for messages older than
<emphasis>offset</emphasis>units</para>
</listitem>
<listitem>
<para><
- <emphasis>offset</emphasis>for messages newer than
+ <emphasis>offset</emphasis>for messages newer than
<emphasis>offset</emphasis>units</para>
</listitem>
<listitem>
<para>=
- <emphasis>offset</emphasis>for messages exactly
+ <emphasis>offset</emphasis>for messages exactly
<emphasis>offset</emphasis>units old</para>
</listitem>
</itemizedlist>
<para>
<emphasis>offset</emphasis>is specified as a positive number with one
- of the units from
+ of the units from
<xref linkend="tab-date-units" />.</para>
<para>Example: to select messages less than 1 month old, you would
use</para>
<screen>Limit to messages matching: ~d <1m</screen>
<note>
- <para>All dates used when searching are relative to the
+ <para>All dates used when searching are relative to the
<emphasis>local</emphasis>time zone, so unless you change the
- setting of your
- <link linkend="index-format">$index_format</link>to include a
- <literal>%[...]</literal>format, these are
+ setting of your
+ <link linkend="index-format">$index_format</link>to include a
+ <literal>%[...]</literal>format, these are
<emphasis>not</emphasis>the dates shown in the main index.</para>
</note>
</sect3>
<title>Marking Messages</title>
<para>There are times that it's useful to ask Mutt to "remember" which
message you're currently looking at, while you move elsewhere in your
- mailbox. You can do this with the
- <quote>mark-message</quote>operator, which is bound to the
+ mailbox. You can do this with the
+ <quote>mark-message</quote>operator, which is bound to the
<quote>~</quote>key by default. Press this key to enter an identifier for
- the marked message. When you want to return to this message, press
+ the marked message. When you want to return to this message, press
<quote>'</quote>and the name that you previously entered.</para>
<para>(Message marking is really just a shortcut for defining a macro
that returns you to the current message by searching for its Message-ID.
- You can choose a different prefix by setting the
+ You can choose a different prefix by setting the
<link linkend="mark-macro-prefix">
$mark_macro_prefix</link>variable.)</para>
</sect1>
messages all at once rather than one at a time. An example might be to
save messages to a mailing list to a separate folder, or to delete all
messages with a given subject. To tag all messages matching a pattern,
- use the
- <literal><tag-pattern></literal>function, which is bound to
+ use the
+ <literal><tag-pattern></literal>function, which is bound to
<quote>shift-T</quote>by default. Or you can select individual messages
- by hand using the
- <literal><tag-message></literal>function, which is bound to
- <quote>t</quote>by default. See
+ by hand using the
+ <literal><tag-message></literal>function, which is bound to
+ <quote>t</quote>by default. See
<link linkend="patterns">patterns</link>for Mutt's pattern matching
syntax.</para>
- <para>Once you have tagged the desired messages, you can use the
- <quote>tag-prefix</quote>operator, which is the
- <quote>;</quote>(semicolon) key by default. When the
- <quote>tag-prefix</quote>operator is used, the
+ <para>Once you have tagged the desired messages, you can use the
+ <quote>tag-prefix</quote>operator, which is the
+ <quote>;</quote>(semicolon) key by default. When the
+ <quote>tag-prefix</quote>operator is used, the
<emphasis>next</emphasis>operation will be applied to all tagged messages
- if that operation can be used in that manner. If the
+ if that operation can be used in that manner. If the
<link linkend="auto-tag">$auto_tag</link>variable is set, the next
operation applies to the tagged messages automatically, without requiring
- the
+ the
<quote>tag-prefix</quote>.</para>
- <para>In
+ <para>In
<link linkend="macro">
- <command>macro</command>s</link>or
+ <command>macro</command>s</link>or
<link linkend="push">
<command>push</command>
- </link>commands, you can use the
+ </link>commands, you can use the
<literal><tag-prefix-cond></literal>operator. If there are no
- tagged messages, Mutt will
+ tagged messages, Mutt will
<quote>eat</quote>the rest of the macro to abort it's execution. Mutt
- will stop
- <quote>eating</quote>the macro when it encounters the
+ will stop
+ <quote>eating</quote>the macro when it encounters the
<literal><end-cond></literal>operator; after this operator the rest
of the macro will be executed as normal.</para>
</sect1>
<sect1 id="hooks">
<title>Using Hooks</title>
- <para>A
+ <para>A
<emphasis>hook</emphasis>is a concept found in many other programs which
allows you to execute arbitrary commands before performing some
operation. For example, you may wish to tailor your configuration based
upon which mailbox you are reading, or to whom you are sending mail. In
- the Mutt world, a
- <emphasis>hook</emphasis>consists of a
- <link linkend="regexp">regular expression</link>or
+ the Mutt world, a
+ <emphasis>hook</emphasis>consists of a
+ <link linkend="regexp">regular expression</link>or
<link linkend="patterns">pattern</link>along with a configuration
- option/command. See:
+ option/command. See:
<itemizedlist>
<listitem>
<para>
</link>
</para>
</listitem>
- </itemizedlist>for specific details on each type of
+ </itemizedlist>for specific details on each type of
<emphasis>hook</emphasis>available.</para>
<note>
<para>If a hook changes configuration settings, these changes remain
effective until the end of the current Mutt session. As this is
- generally not desired, a
+ generally not desired, a
<quote>default</quote>hook needs to be added before all other hooks of
that type to restore configuration defaults.</para>
</note>
<example id="ex-default-hook">
- <title>Specifying a
+ <title>Specifying a
<quote>default</quote>hook</title>
<screen>
send-hook . 'unmy_hdr From:'
send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
</screen>
</example>
- <para>In
- <xref linkend="ex-default-hook" />, by default the value of
- <link linkend="from">$from</link>and
+ <para>In
+ <xref linkend="ex-default-hook" />, by default the value of
+ <link linkend="from">$from</link>and
<link linkend="realname">$realname</link>is not overridden. When sending
- messages either To: or Cc: to
- <literal><b@b.b></literal>, the From: header is changed to
+ messages either To: or Cc: to
+ <literal><b@b.b></literal>, the From: header is changed to
<literal><c@c.c></literal>.</para>
<sect2 id="pattern-hook" xreflabel="Message Matching in Hooks">
<title>Message Matching in Hooks</title>
<para>Hooks that act upon messages (
- <command>message-hook</command>,
- <command>reply-hook</command>,
- <command>send-hook</command>,
- <command>send2-hook</command>,
- <command>save-hook</command>,
+ <command>message-hook</command>,
+ <command>reply-hook</command>,
+ <command>send-hook</command>,
+ <command>send2-hook</command>,
+ <command>save-hook</command>,
<command>fcc-hook</command>) are evaluated in a slightly different
- manner. For the other types of hooks, a
+ manner. For the other types of hooks, a
<link linkend="regexp">regular expression</link>is sufficient. But in
dealing with messages a finer grain of control is needed for matching
since for different purposes you want to match different
criteria.</para>
- <para>Mutt allows the use of the
+ <para>Mutt allows the use of the
<link linkend="patterns">search pattern</link>language for matching
messages in hook commands. This works in exactly the same way as it
- would when
- <emphasis>limiting</emphasis>or
+ would when
+ <emphasis>limiting</emphasis>or
<emphasis>searching</emphasis>the mailbox, except that you are
restricted to those operators which match information Mutt extracts
from the header of the message (i.e., from, to, cc, date, subject,
<para>For example, if you wanted to set your return address based upon
sending mail to a specific address, you could do something like:</para>
<screen>send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'</screen>
- <para>which would execute the given command when sending mail to
+ <para>which would execute the given command when sending mail to
<emphasis>me@cs.hmc.edu</emphasis>.</para>
<para>However, it is not required that you write the pattern to match
- using the full searching language. You can still specify a simple
+ using the full searching language. You can still specify a simple
<emphasis>regular expression</emphasis>like the other hooks, in which
case Mutt will translate your pattern into the full language, using the
- translation specified by the
+ translation specified by the
<link linkend="default-hook">$default_hook</link>variable. The pattern
- is translated at the time the hook is declared, so the value of
+ is translated at the time the hook is declared, so the value of
<link linkend="default-hook">$default_hook</link>that is in effect at
that time will be used.</para>
</sect2>
<sect2 id="mailbox-hook" xreflabel="Mailbox Matching in Hooks">
<title>Mailbox Matching in Hooks</title>
<para>Hooks that match against mailboxes (
- <command>folder-hook</command>,
- <command>mbox-hook</command>) apply both
- <link linkend="regexp">regular expression</link>syntax as well as
+ <command>folder-hook</command>,
+ <command>mbox-hook</command>) apply both
+ <link linkend="regexp">regular expression</link>syntax as well as
<link linkend="shortcuts">mailbox shortcut</link>expansion on the
regexp parameter. There is some overlap between these, so special
attention should be paid to the first character of the regexp.</para>
<sect1 id="setenv">
<title>Managing the Environment</title>
<para>You can alter the environment that Mutt passes on to its child
- processes using the
- <quote>setenv</quote>and
+ processes using the
+ <quote>setenv</quote>and
<quote>unsetenv</quote>operators. (N.B. These follow Mutt-style syntax,
not shell-style!) You can also query current environment values by
- prefixing a
+ prefixing a
<quote>?</quote>character.</para>
<screen>
setenv TERM vt100
<title>External Address Queries</title>
<para>Mutt supports connecting to external directory databases such as
LDAP, ph/qi, bbdb, or NIS through a wrapper script which connects to Mutt
- using a simple interface. Using the
+ using a simple interface. Using the
<link linkend="query-command">$query_command</link>variable, you specify
the wrapper command to use. For example:</para>
<screen>set query_command = "mutt_ldap_query.pl %s"</screen>
roessler@does-not-exist.org Thomas Roessler mutt pgp
</screen>
<para>There are two mechanisms for accessing the query function of Mutt.
- One is to do a query from the index menu using the
+ One is to do a query from the index menu using the
<literal><query></literal>function (default: Q). This will prompt
for a query, then bring up the query menu which will list the matching
responses. From the query menu, you can select addresses to create
query, or have a new query appended to the current responses.</para>
<para>The other mechanism for accessing the query function is for address
completion, similar to the alias completion. In any prompt for address
- entry, you can use the
+ entry, you can use the
<literal><complete-query></literal>function (default: ^T) to run a
query based on the current address you have typed. Like aliases, Mutt
will look for what you have typed back to the last space or comma. If
<para>Mutt supports reading and writing of four different local mailbox
formats: mbox, MMDF, MH and Maildir. The mailbox type is auto detected,
so there is no need to use a flag for different mailbox types. When
- creating new mailboxes, Mutt uses the default specified with the
+ creating new mailboxes, Mutt uses the default specified with the
<link linkend="mbox-type">$mbox_type</link>variable. A short description
of the formats follows.</para>
<para>
form:</para>
<screen>From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</screen>
<para>to denote the start of a new message (this is often referred to as
- the
+ the
<quote>From_</quote>line). The mbox format requires mailbox locking, is
prone to mailbox corruption with concurrently writing clients or
misinterpreted From_ lines. Depending on the environment, new mail
detection can be unreliable. Mbox folders are fast to open and easy to
archive.</para>
<para>
- <emphasis>MMDF</emphasis>. This is a variant of the
+ <emphasis>MMDF</emphasis>. This is a variant of the
<emphasis>mbox</emphasis>format. Each message is surrounded by lines
- containing
+ containing
<quote>^A^A^A^A</quote>(four times control-A's). The same problems as for
mbox apply (also with finding the right message separator as four
control-A's may appear in message bodies).</para>
<para>
- <emphasis>MH</emphasis>. A radical departure from
- <emphasis>mbox</emphasis>and
+ <emphasis>MH</emphasis>. A radical departure from
+ <emphasis>mbox</emphasis>and
<emphasis>MMDF</emphasis>, a mailbox consists of a directory and each
message is stored in a separate file. The filename indicates the message
number (however, this is may not correspond to the message number Mutt
displays). Deleted messages are renamed with a comma (
<quote>,</quote>) prepended to the filename. Mutt detects this type of
- mailbox by looking for either
- <literal>.mh_sequences</literal>or
+ mailbox by looking for either
+ <literal>.mh_sequences</literal>or
<literal>.xmhcache</literal>files (needed to distinguish normal
directories from MH mailboxes). MH is more robust with concurrent clients
writing the mailbox, but still may suffer from lost flags; message
corruption is less likely to occur than with mbox/mmdf. It's usually
slower to open compared to mbox/mmdf since many small files have to be
- read (Mutt provides
+ read (Mutt provides
<xref linkend="header-caching" />to greatly speed this process up).
Depending on the environment, MH is not very disk-space efficient.</para>
<para>
<emphasis>Maildir</emphasis>. The newest of the mailbox formats, used by
- the Qmail MTA (a replacement for sendmail). Similar to
+ the Qmail MTA (a replacement for sendmail). Similar to
<emphasis>MH</emphasis>, except that it adds three subdirectories of the
- mailbox:
- <emphasis>tmp</emphasis>,
- <emphasis>new</emphasis>and
+ mailbox:
+ <emphasis>tmp</emphasis>,
+ <emphasis>new</emphasis>and
<emphasis>cur</emphasis>. Filenames for the messages are chosen in such a
way they are unique, even when two programs are writing the mailbox over
NFS, which means that no file locking is needed and corruption is very
<entry>
<literal>!</literal>
</entry>
- <entry>your
+ <entry>your
<link linkend="spoolfile">$spoolfile</link>(incoming)
mailbox</entry>
</row>
<entry>
<literal>></literal>
</entry>
- <entry>your
+ <entry>your
<link linkend="mbox">$mbox</link>file</entry>
</row>
<row>
<entry>
<literal><</literal>
</entry>
- <entry>your
+ <entry>your
<link linkend="record">$record</link>file</entry>
</row>
<row>
</row>
<row>
<entry>
- <literal>-</literal>or
+ <literal>-</literal>or
<literal>!!</literal></entry>
<entry>the file you've last visited</entry>
</row>
</row>
<row>
<entry>
- <literal>=</literal>or
+ <literal>=</literal>or
<literal>+</literal></entry>
- <entry>your
+ <entry>your
<link linkend="folder">$folder</link>directory</entry>
</row>
<row>
<entry>
<emphasis>@alias</emphasis>
</entry>
- <entry>to the
+ <entry>to the
<link linkend="save-hook">default save folder</link>as determined
by the address of the alias</entry>
</row>
</tgroup>
</table>
<para>For example, to store a copy of outgoing messages in the folder
- they were composed in, a
+ they were composed in, a
<link linkend="folder-hook">
<command>folder-hook</command>
- </link>can be used to set
+ </link>can be used to set
<link linkend="record">$record</link>:</para>
<screen>folder-hook . 'set record=^'</screen>
</sect1>
what addresses you consider to be mailing lists (technically this does
not have to be a mailing list, but that is what it is most often used
for), and what lists you are subscribed to. This is accomplished through
- the use of the
+ the use of the
<link linkend="lists">
- <command>lists</command>and
- <command>subscribe</command></link>commands in your
+ <command>lists</command>and
+ <command>subscribe</command></link>commands in your
<literal>.muttrc</literal>.</para>
<para>Now that Mutt knows what your mailing lists are, it can do several
things, the first of which is the ability to show the name of a list
- through which you received a message (i.e., of a subscribed list) in the
+ through which you received a message (i.e., of a subscribed list) in the
<emphasis>index</emphasis>menu display. This is useful to distinguish
- between personal and list mail in the same mailbox. In the
- <link linkend="index-format">$index_format</link>variable, the expando
- <quote>%L</quote>will print the string
- <quote>To <list></quote>when
- <quote>list</quote>appears in the
- <quote>To</quote>field, and
- <quote>Cc <list></quote>when it appears in the
+ between personal and list mail in the same mailbox. In the
+ <link linkend="index-format">$index_format</link>variable, the expando
+ <quote>%L</quote>will print the string
+ <quote>To <list></quote>when
+ <quote>list</quote>appears in the
+ <quote>To</quote>field, and
+ <quote>Cc <list></quote>when it appears in the
<quote>Cc</quote>field (otherwise it prints the name of the
author).</para>
- <para>Often times the
- <quote>To</quote>and
+ <para>Often times the
+ <quote>To</quote>and
<quote>Cc</quote>fields in mailing list messages tend to get quite large.
Most people do not bother to remove the author of the message they reply
to from the list, resulting in two or more copies being sent to that
- person. The
+ person. The
<literal><list-reply></literal>function, which by default is bound
- to
- <quote>L</quote>in the
- <emphasis>index</emphasis>menu and
+ to
+ <quote>L</quote>in the
+ <emphasis>index</emphasis>menu and
<emphasis>pager</emphasis>, helps reduce the clutter by only replying to
the known mailing list addresses instead of all recipients (except as
- specified by
+ specified by
<literal>Mail-Followup-To</literal>, see below).</para>
- <para>Mutt also supports the
+ <para>Mutt also supports the
<literal>Mail-Followup-To</literal>header. When you send a message to a
list of recipients which includes one or several subscribed mailing
- lists, and if the
+ lists, and if the
<link linkend="followup-to">$followup_to</link>option is set, Mutt will
generate a Mail-Followup-To header which contains all the recipients to
whom you send this message, but not your address. This indicates that
- group-replies or list-replies (also known as
+ group-replies or list-replies (also known as
<quote>followups</quote>) to this message should only be sent to the
original recipients of the message, and not separately to you - you'll
receive your copy through one of the mailing lists you are subscribed
to.</para>
<para>Conversely, when group-replying or list-replying to a message which
- has a
+ has a
<literal>Mail-Followup-To</literal>header, Mutt will respect this header
- if the
+ if the
<link linkend="honor-followup-to">$honor_followup_to</link>configuration
- variable is set. Using
+ variable is set. Using
<link linkend="list-reply">list-reply</link>will in this case also make
sure that the reply goes to the mailing list, even if it's not specified
- in the list of recipients in the
+ in the list of recipients in the
<literal>Mail-Followup-To</literal>.</para>
<note>
- <para>When header editing is enabled, you can create a
+ <para>When header editing is enabled, you can create a
<literal>Mail-Followup-To</literal>header manually. Mutt will only
auto-generate this header if it doesn't exist when you send the
message.</para>
</note>
- <para>The other method some mailing list admins use is to generate a
+ <para>The other method some mailing list admins use is to generate a
<quote>Reply-To</quote>field which points back to the mailing list
address rather than the author of the message. This can create problems
when trying to reply directly to the author in private, since most mail
- clients will automatically reply to the address given in the
- <quote>Reply-To</quote>field. Mutt uses the
+ clients will automatically reply to the address given in the
+ <quote>Reply-To</quote>field. Mutt uses the
<link linkend="reply-to">$reply_to</link>variable to help decide which
- address to use. If set to
- <emphasis>ask-yes</emphasis>or
+ address to use. If set to
+ <emphasis>ask-yes</emphasis>or
<emphasis>ask-no</emphasis>, you will be prompted as to whether or not
- you would like to use the address given in the
+ you would like to use the address given in the
<quote>Reply-To</quote>field, or reply directly to the address given in
- the
- <quote>From</quote>field. When set to
- <emphasis>yes</emphasis>, the
+ the
+ <quote>From</quote>field. When set to
+ <emphasis>yes</emphasis>, the
<quote>Reply-To</quote>field will be used when present.</para>
- <para>You can change or delete the
- <quote>X-Label:</quote>field within Mutt using the
- <quote>edit-label</quote>command, bound to the
+ <para>You can change or delete the
+ <quote>X-Label:</quote>field within Mutt using the
+ <quote>edit-label</quote>command, bound to the
<quote>y</quote>key by default. This works for tagged messages, too.
While in the edit-label function, pressing the <complete> binding
(TAB, by default) will perform completion against all labels currently in
use.</para>
- <para>Lastly, Mutt has the ability to
- <link linkend="sort">sort</link>the mailbox into
+ <para>Lastly, Mutt has the ability to
+ <link linkend="sort">sort</link>the mailbox into
<link linkend="threads">threads</link>. A thread is a group of messages
which all relate to the same subject. This is usually organized into a
tree-like structure where a message and all of its replies are
<para>Mutt has supported textual labels (usually known as X-Labels after
the header that we use to store them) for many years. Since we initially
added support for X-Labels, however, the larger community has evolved
- more common ways of using and managing such labels, often known as
- <quote>keywords</quote>or
+ more common ways of using and managing such labels, often known as
+ <quote>keywords</quote>or
<quote>tags</quote>.</para>
<para>If you are new to Mutt or to using keywords in Mutt, you only need
to know that the <edit-label> binding will edit keywords, and that
- you can search for keywords using the
- <literal>~y</literal>pattern, and use the
- <literal>%y</literal>expando to display it in your
+ you can search for keywords using the
+ <literal>~y</literal>pattern, and use the
+ <literal>%y</literal>expando to display it in your
<literal>$index_format</literal>. You also can sort by keyword. Keywords
- that you set will be stored to the
+ that you set will be stored to the
<literal>X-Label:</literal>header by default.</para>
<para>If you've been using X-Labels for a while, things have grown
slightly. Mutt still supports X-Labels much as it has since 2000, but the
<varlistentry>
<term>X-Label</term>
<listitem>
- <para>Mutt-specific design; freeform text (but see
+ <para>Mutt-specific design; freeform text (but see
<link linkend="xlabel-delimiter">$xlabel_delimiter</link>)</para>
</listitem>
</varlistentry>
<para>Two boolean variables control how keywords are saved when writing
messages to a mailbox. The default settings preserve backward
compatibility within mutt completely, but by changing these values you
- can transition to more standard keyword storage.
+ can transition to more standard keyword storage.
<link linkend="keywords-legacy">$keywords_legacy</link>, if set, will
- tell mutt to use only "legacy" headers -- i.e.,
- <literal>X-Keywords:</literal>,
- <literal>X-Mozilla-Keys</literal>,
- <literal>Keywords</literal>, or
+ tell mutt to use only "legacy" headers -- i.e.,
+ <literal>X-Keywords:</literal>,
+ <literal>X-Mozilla-Keys</literal>,
+ <literal>Keywords</literal>, or
<literal>X-Label:</literal>. Keywords will be saved to whichever header
- was in use by the message the keyword was read from. If
+ was in use by the message the keyword was read from. If
<link linkend="keywords-standard">$keywords_standard</link>is set,
- keywords will be saved without exception to the standard
+ keywords will be saved without exception to the standard
<literal>Keywords:</literal>header. (If both are set, both will be used;
- if both are unset, legacy headers are used.) Additionally,
+ if both are unset, legacy headers are used.) Additionally,
<link linkend="xlabel-delimiter">$xlabel_delimiter</link>is used to
format the X-Label: header on saves.</para>
- <para>To migrate completely to the new standard, unset
- <literal>$keywords_legacy</literal>and set
- <literal>$keywords_standard</literal>, and set
+ <para>To migrate completely to the new standard, unset
+ <literal>$keywords_legacy</literal>and set
+ <literal>$keywords_standard</literal>, and set
<literal>$xlabel_delimiter</literal>either to what you currently use to
- delimit keywords in X-Labels, or to
+ delimit keywords in X-Labels, or to
<quote>, </quote>(comma space).</para>
- <para>Note that it is common practice to insert
+ <para>Note that it is common practice to insert
<literal>X-Label:</literal>or other keyword headers from proxmail or
other mail filters. This is a useful trick for categorizing messages en
masse as they are delivered to your inbox, and it is fully compatible
</group>
</cmdsynopsis>
<para>
- <literal>subjectrx</literal>specifies a regular expression
+ <literal>subjectrx</literal>specifies a regular expression
<quote>pattern</quote>which, if detected in a message subject, causes the
- subject to be replaced with the
+ subject to be replaced with the
<quote>replacement</quote>value. The replacement is subject to
- substitutions in the same way as for the
- <link linkend="spam">spam</link>command:
- <literal>%L</literal>for the text to the left of the match,
- <literal>%R</literal>for text to the right of the match, and
+ substitutions in the same way as for the
+ <link linkend="spam">spam</link>command:
+ <literal>%L</literal>for the text to the left of the match,
+ <literal>%R</literal>for text to the right of the match, and
<literal>%1</literal>for the first subgroup in the match (etc). If you
- simply want to erase the match, set it to
- <quote>%L%R</quote>. Any number of
+ simply want to erase the match, set it to
+ <quote>%L%R</quote>. Any number of
<literal>subjectrx</literal>commands may coexist.</para>
- <para>Note this well: the
+ <para>Note this well: the
<quote>replacement</quote>value replaces the entire subject, not just the
match!</para>
<para>
<literal>unsubjectrx</literal>removes a given subjectrx from the
- substitution list. If
+ substitution list. If
<literal>*</literal>is used as the pattern, all substitutions will be
removed.</para>
<example id="ex-subjectrx">
<sect1 id="new-mail">
<title>New Mail Detection</title>
<para>Mutt supports setups with multiple folders, allowing all of them to
- be monitored for new mail (see
+ be monitored for new mail (see
<xref linkend="mailboxes" />for details).</para>
<sect2 id="new-mail-formats">
<para>For Mbox and Mmdf folders, new mail is detected by comparing
access and/or modification times of files: Mutt assumes a folder has
new mail if it wasn't accessed after it was last modified. Utilities
- like
- <literal>biff</literal>or
+ like
+ <literal>biff</literal>or
<literal>frm</literal>or any other program which accesses the mailbox
might cause Mutt to never detect new mail for that mailbox if they do
not properly reset the access time. Other possible causes of Mutt not
detecting new mail in these folders are backup tools (updating access
times) or filesystems mounted without access time update support (for
- Linux systems, see the
+ Linux systems, see the
<literal>relatime</literal>option).</para>
<note>
<para>Contrary to older Mutt releases, it now maintains the new mail
deleted, nor marked as old.</para>
</note>
<para>In cases where new mail detection for Mbox or Mmdf folders
- appears to be unreliable, the
+ appears to be unreliable, the
<link linkend="check-mbox-size">$check_mbox_size</link>option can be
used to make Mutt track and consult file sizes for new mail detection
instead which won't work for size-neutral changes.</para>
- <para>New mail for Maildir is assumed if there is one message in the
- <literal>new/</literal>subdirectory which is not marked deleted (see
+ <para>New mail for Maildir is assumed if there is one message in the
+ <literal>new/</literal>subdirectory which is not marked deleted (see
<link linkend="maildir-trash">$maildir_trash</link>). For MH folders, a
mailbox is considered having new mail if there's at least one message
- in the
- <quote>unseen</quote>sequence as specified by
- <link linkend="mh-seq-unseen">$mh_seq_unseen</link>. Optionally,
+ in the
+ <quote>unseen</quote>sequence as specified by
+ <link linkend="mh-seq-unseen">$mh_seq_unseen</link>. Optionally,
<link linkend="new-mail-command">$new_mail_command</link>can be
configured to execute an external program every time new mail is
detected in the current inbox.</para>
periodically checks the currently opened folder (if it's a POP3
folder).</para>
<para>For IMAP, by default Mutt uses recent message counts provided by
- the server to detect new mail. If the
+ the server to detect new mail. If the
<link linkend="imap-idle">$imap_idle</link>option is set, it'll use the
IMAP IDLE extension if advertised by the server.</para>
- <para>The
+ <para>The
<link linkend="mail-check-recent">$mail_check_recent</link>option
changes whether Mutt will notify you of new mail in an already visited
mailbox. When set (the default) it will only notify you of new mail
<sect2 id="new-mail-polling">
<title>Polling For New Mail</title>
- <para>When in the index menu and being idle (also see
+ <para>When in the index menu and being idle (also see
<link linkend="timeout">$timeout</link>), Mutt periodically checks for
- new mail in all folders which have been configured via the
+ new mail in all folders which have been configured via the
<command>mailboxes</command>command. The interval depends on the folder
- type: for local/IMAP folders it consults
- <link linkend="mail-check">$mail_check</link>and
+ type: for local/IMAP folders it consults
+ <link linkend="mail-check">$mail_check</link>and
<link linkend="pop-checkinterval">$pop_checkinterval</link>for POP
folders.</para>
<para>Outside the index menu the directory browser supports checking
- for new mail using the
+ for new mail using the
<literal><check-new></literal>function which is unbound by
default. Pressing TAB will bring up a menu showing the files specified
- by the
+ by the
<command>mailboxes</command>command, and indicate which contain new
messages. Mutt will automatically enter this mode when invoked from the
- command line with the
+ command line with the
<literal>-y</literal>option.</para>
<para>For the pager, index and directory browser menus, Mutt contains
- the
- <literal><buffy-list></literal>function (bound to
+ the
+ <literal><buffy-list></literal>function (bound to
<quote>.</quote>by default) which will print a list of folders with new
mail in the command line at the bottom of the screen.</para>
<para>For the index, by default Mutt displays the number of mailboxes
- with new mail in the status bar, please refer to the
+ with new mail in the status bar, please refer to the
<link linkend="status-format">$status_format</link>variable for
details.</para>
<para>When changing folders, Mutt fills the prompt with the first
- folder from the mailboxes list containing new mail (if any), pressing
+ folder from the mailboxes list containing new mail (if any), pressing
<literal><Space></literal>will cycle through folders with new
- mail. The (by default unbound) function
+ mail. The (by default unbound) function
<literal><next-unread-mailbox></literal>in the index can be used
to immediately open the next folder with unread mail (if any).</para>
</sect2>
<sect2 id="calc-mailbox-counts">
<title>Calculating Mailbox Message Counts</title>
- <para>If
+ <para>If
<link linkend="mail-check-stats">$mail_check_stats</link>is set, Mutt
will periodically calculate the unread, flagged, and total message
- counts for each mailbox watched by the
+ counts for each mailbox watched by the
<command>mailboxes</command>command. This calculation takes place at
the same time as new mail polling, but is controlled by a separate
- timer:
+ timer:
<link linkend="mail-check-stats-interval">
$mail_check_stats_interval</link>.</para>
- <para>The sidebar can display these message counts. See
+ <para>The sidebar can display these message counts. See
<link linkend="sidebar-format">$sidebar_format</link>.</para>
</sect2>
</sect1>
<sect2 id="link-threads">
<title>Linking Threads</title>
- <para>Some mailers tend to
- <quote>forget</quote>to correctly set the
- <quote>In-Reply-To:</quote>and
+ <para>Some mailers tend to
+ <quote>forget</quote>to correctly set the
+ <quote>In-Reply-To:</quote>and
<quote>References:</quote>headers when replying to a message. This
results in broken discussions because Mutt has not enough information
to guess the correct threading. You can fix this by tagging the reply,
- then moving to the parent message and using the
+ then moving to the parent message and using the
<literal><link-threads></literal>function (bound to & by
default). The reply will then be connected to this parent
message.</para>
<para>You can also connect multiple children at once, tagging them and
- using the
+ using the
<literal><tag-prefix></literal>command (
- <quote>;</quote>) or the
+ <quote>;</quote>) or the
<link linkend="auto-tag">$auto_tag</link>option.</para>
</sect2>
<sect2 id="break-threads">
<title>Breaking Threads</title>
<para>On mailing lists, some people are in the bad habit of starting a
- new discussion by hitting
+ new discussion by hitting
<quote>reply</quote>to any message from the list and changing the
subject to a totally unrelated one. You can fix such threads by using
- the
+ the
<literal><break-thread></literal>function (bound by default to
#), which will turn the subthread starting from the current message
into a whole different thread.</para>
<title>Delivery Status Notification (DSN) Support</title>
<para>RFC1894 defines a set of MIME content types for relaying
information about the status of electronic mail messages. These can be
- thought of as
+ thought of as
<quote>return receipts.</quote></para>
- <para>To support DSN, there are two variables.
+ <para>To support DSN, there are two variables.
<link linkend="dsn-notify">$dsn_notify</link>is used to request receipts
- for different results (such as failed message, message delivered, etc.).
+ for different results (such as failed message, message delivered, etc.).
<link linkend="dsn-return">$dsn_return</link>requests how much of your
message should be returned with the receipt (headers or full
message).</para>
- <para>When using
+ <para>When using
<link linkend="sendmail">$sendmail</link>for mail delivery, you need to
use either Berkeley sendmail 8.8.x (or greater) a MTA supporting DSN
command line options compatible to Sendmail: The -N and -R options can be
used by the mail client to make requests as to what type of status
messages should be returned. Please consider your MTA documentation
whether DSN is supported.</para>
- <para>For SMTP delivery using
+ <para>For SMTP delivery using
<link linkend="smtp-url">$smtp_url</link>, it depends on the capabilities
announced by the server whether Mutt will attempt to request DSN or
not.</para>
<title>Start a WWW Browser on URLs</title>
<para>If a message contains URLs, it is efficient to get a menu with all
the URLs and start a WWW browser on one of them. This functionality is
- provided by the external urlview program which can be retrieved at
+ provided by the external urlview program which can be retrieved at
<ulink url="ftp://ftp.mutt.org/mutt/contrib/">
ftp://ftp.mutt.org/mutt/contrib/</ulink>and the configuration
commands:</para>
<term>Address normalization</term>
<listitem>
<para>Mutt normalizes all e-mail addresses to the simplest form
- possible. If an address contains a realname, the form
+ possible. If an address contains a realname, the form
<emphasis>Joe User <joe@example.com></emphasis>is used and
- the pure e-mail address without angle brackets otherwise, i.e. just
+ the pure e-mail address without angle brackets otherwise, i.e. just
<emphasis>joe@example.com</emphasis>.</para>
<para>This normalization affects all headers Mutt generates
including aliases.</para>
<term>Initial folder selection</term>
<listitem>
<para>The folder Mutt opens at startup is determined as follows:
- the folder specified in the
+ the folder specified in the
<literal>$MAIL</literal>environment variable if present. Otherwise,
- the value of
+ the value of
<literal>$MAILDIR</literal>is taken into account. If that isn't
present either, Mutt takes the user's mailbox in the mailspool as
determined at compile-time (which may also reside in the home
- directory). The
+ directory). The
<link linkend="spoolfile">$spoolfile</link>setting overrides this
- selection. Highest priority has the mailbox given with the
+ selection. Highest priority has the mailbox given with the
<literal>-f</literal>command line option.</para>
</listitem>
</varlistentry>
text-mode MIME MUA. Every effort has been made to provide the functionality
that the discerning MIME user requires, and the conformance to the
standards wherever possible. When configuring Mutt for MIME, there are two
- extra types of configuration files which Mutt uses. One is the
+ extra types of configuration files which Mutt uses. One is the
<literal>mime.types</literal>file, which contains the mapping of file
- extensions to IANA MIME types. The other is the
+ extensions to IANA MIME types. The other is the
<literal>mailcap</literal>file, which specifies the external commands to
use for handling specific MIME types.</para>
<sect2 id="mime-overview">
<title>MIME Overview</title>
- <para>MIME is short for
+ <para>MIME is short for
<quote>Multipurpose Internet Mail Extension</quote>and describes
mechanisms to internationalize and structure mail messages. Before the
introduction of MIME, messages had a single text part and were limited
for sender names, recipients and subjects.</para>
<para>Besides the handling of non-ascii characters in message headers,
to Mutt the most important aspect of MIME are so-called MIME types.
- These are constructed using a
- <emphasis>major</emphasis>and
+ These are constructed using a
+ <emphasis>major</emphasis>and
<emphasis>minor</emphasis>type separated by a forward slash. These
specify details about the content that follows. Based upon these, Mutt
- decides how to handle this part. The most popular major type is
+ decides how to handle this part. The most popular major type is
<quote>
<literal>text</literal>
</quote>with minor types for plain text, HTML and various other
formats. Major types also exist for images, audio, video and of course
general application data (e.g. to separate cryptographically signed
data with a signature, send office documents, and in general arbitrary
- binary data). There's also the
+ binary data). There's also the
<literal>multipart</literal>major type which represents the root of a
- subtree of MIME parts. A list of supported MIME types can be found in
+ subtree of MIME parts. A list of supported MIME types can be found in
<xref linkend="supported-mime-types" />.</para>
<para>MIME also defines a set of encoding schemes for transporting MIME
- content over the network:
- <literal>7bit</literal>,
- <literal>8bit</literal>,
- <literal>quoted-printable</literal>,
- <literal>base64</literal>and
+ content over the network:
+ <literal>7bit</literal>,
+ <literal>8bit</literal>,
+ <literal>quoted-printable</literal>,
+ <literal>base64</literal>and
<literal>binary</literal>. There're some rules when to choose what for
encoding headers and/or body (if needed), and Mutt will in general make
a good choice.</para>
<para>When you select a message from the index and view it in the
pager, Mutt decodes as much of a message as possible to a text
representation. Mutt internally supports a number of MIME types,
- including the
- <literal>text</literal>major type (with all minor types), the
- <literal>message/rfc822</literal>(mail messages) type and some
+ including the
+ <literal>text</literal>major type (with all minor types), the
+ <literal>message/rfc822</literal>(mail messages) type and some
<literal>multipart</literal>types. In addition, it recognizes a variety
- of PGP MIME types, including PGP/MIME and
+ of PGP MIME types, including PGP/MIME and
<literal>application/pgp</literal>.</para>
<para>Mutt will denote attachments with a couple lines describing them.
These lines are of the form:</para>
[-- Attachment #1: Description --]
[-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
</screen>
- <para>Where the
+ <para>Where the
<emphasis>Description</emphasis>is the description or filename given
- for the attachment, and the
+ for the attachment, and the
<emphasis>Encoding</emphasis>is one of the already mentioned content
encodings.</para>
<para>If Mutt cannot deal with a MIME type, it will display a message
<sect2 id="attach-menu">
<title>The Attachment Menu</title>
- <para>The default binding for
- <literal><view-attachments></literal>is
+ <para>The default binding for
+ <literal><view-attachments></literal>is
<quote>v</quote>, which displays the attachment menu for a message. The
attachment menu displays a list of the attachments in a message. From
the attachment menu, you can save, print, pipe, delete, and view
attachments. You can apply these operations to a group of attachments
- at once, by tagging the attachments and by using the
+ at once, by tagging the attachments and by using the
<literal><tag-prefix></literal>operator. You can also reply to
the current message from this menu, and only the current attachment (or
the attachments tagged) will be quoted in your reply. You can view
attachments as text, or view them using the mailcap viewer definition
(the mailcap mechanism is explained later in detail).</para>
- <para>Finally, you can apply the usual message-related functions (like
+ <para>Finally, you can apply the usual message-related functions (like
<link linkend="resend-message">
<literal><resend-message></literal>
- </link>, and the
- <literal><reply></literal>and
- <literal><forward></literal>functions) to attachments of type
+ </link>, and the
+ <literal><reply></literal>and
+ <literal><forward></literal>functions) to attachments of type
<literal>message/rfc822</literal>.</para>
- <para>See table
+ <para>See table
<xref linkend="tab-attachment-bindings" />for all available
functions.</para>
</sect2>
- 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description>
</screen>
- <para>The
+ <para>The
<quote>-</quote>denotes that Mutt will delete the file after sending
- (or postponing, or canceling) the message. It can be toggled with the
+ (or postponing, or canceling) the message. It can be toggled with the
<literal><toggle-unlink></literal>command (default: u). The next
- field is the MIME content-type, and can be changed with the
+ field is the MIME content-type, and can be changed with the
<literal><edit-type></literal>command (default: ^T). The next
field is the encoding for the attachment, which allows a binary message
to be encoded for transmission on 7bit links. It can be changed with
- the
+ the
<literal><edit-encoding></literal>command (default: ^E). The next
field is the size of the attachment, rounded to kilobytes or megabytes.
- The next field is the filename, which can be changed with the
+ The next field is the filename, which can be changed with the
<literal><rename-file></literal>command (default: R). The final
- field is the description of the attachment, and can be changed with the
- <literal><edit-description></literal>command (default: d). See
+ field is the description of the attachment, and can be changed with the
+ <literal><edit-description></literal>command (default: d). See
<link linkend="attach-format">$attach_format</link>for a full list of
available expandos to format this display to your needs.</para>
</sect2>
</sect1>
<sect1 id="mime-types">
- <title>MIME Type Configuration with
+ <title>MIME Type Configuration with
<literal>mime.types</literal></title>
<para>To get most out of MIME, it's important that a MIME part's content
type matches the content as closely as possible so that the recipient's
However, there's no reliable for Mutt to know how to detect every
possible file type. Instead, it uses a simple plain text mapping file
that specifies what file extension corresponds to what MIME type. This
- file is called
+ file is called
<literal>mime.types</literal>.</para>
<para>When you add an attachment to your mail message, Mutt searches your
- personal
- <literal>mime.types</literal>file at
- <literal>$HOME/.mime.types</literal>, and then the system
- <literal>mime.types</literal>file at
- <literal>/usr/local/share/mutt/mime.types</literal>or
+ personal
+ <literal>mime.types</literal>file at
+ <literal>$HOME/.mime.types</literal>, and then the system
+ <literal>mime.types</literal>file at
+ <literal>/usr/local/share/mutt/mime.types</literal>or
<literal>/etc/mime.types</literal></para>
<para>Each line starts with the full MIME type, followed by a space and
space-separated list of file extensions. For example you could
audio/x-aiff aif aifc aiff
</screen>
</example>
- <para>A sample
+ <para>A sample
<literal>mime.types</literal>file comes with the Mutt distribution, and
should contain most of the MIME types you are likely to use.</para>
<para>If Mutt can not determine the MIME type by the extension of the
file you attach, it will look at the file. If the file is free of binary
- information, Mutt will assume that the file is plain text, and mark it as
+ information, Mutt will assume that the file is plain text, and mark it as
<literal>text/plain</literal>. If the file contains binary information,
- then Mutt will mark it as
+ then Mutt will mark it as
<literal>application/octet-stream</literal>. You can change the MIME type
- that Mutt assigns to an attachment by using the
+ that Mutt assigns to an attachment by using the
<literal><edit-type></literal>command from the compose menu
- (default: ^T), see
+ (default: ^T), see
<xref linkend="supported-mime-types" />for supported major types. Mutt
- recognizes all of these if the appropriate entry is found in the
+ recognizes all of these if the appropriate entry is found in the
<literal>mime.types</literal>file. Non-recognized mime types should only
be used if the recipient of the message is likely to be expecting such
attachments.</para>
</tbody>
</tgroup>
</table>
- <para>MIME types are not arbitrary, they need to be assigned by
+ <para>MIME types are not arbitrary, they need to be assigned by
<ulink url="http://www.iana.org/assignments/media-types/">
IANA</ulink>.</para>
</sect1>
<title>MIME Viewer Configuration with Mailcap</title>
<para>Mutt supports RFC 1524 MIME Configuration, in particular the Unix
specific format specified in Appendix A of RFC 1524. This file format is
- commonly referred to as the
+ commonly referred to as the
<quote>mailcap</quote>format. Many MIME compliant programs utilize the
mailcap format, allowing you to specify handling for all MIME types in
one place for all programs. Programs known to use this format include
</para>
</listitem>
</orderedlist>
- <para>where
- <literal>$HOME</literal>is your home directory. The
- <literal>$PKGDATADIR</literal>and the
+ <para>where
+ <literal>$HOME</literal>is your home directory. The
+ <literal>$PKGDATADIR</literal>and the
<literal>$SYSCONFDIR</literal>directories depend on where Mutt is
installed: the former is the default for shared data, the latter for
system configuration files.</para>
command:</para>
<screen>mutt -nF /dev/null -Q mailcap_path</screen>
<para>In particular, the metamail distribution will install a mailcap
- file, usually as
+ file, usually as
<literal>/usr/local/etc/mailcap</literal>, which contains some baseline
entries.</para>
<para>A blank line is blank.</para>
<para>A definition line consists of a content type, a view command, and
any number of optional fields. Each field of a definition line is
- divided by a semicolon
+ divided by a semicolon
<quote>;</quote>character.</para>
- <para>The content type is specified in the MIME standard
- <quote>type/subtype</quote>notation. For example,
- <literal>text/plain</literal>,
- <literal>text/html</literal>,
+ <para>The content type is specified in the MIME standard
+ <quote>type/subtype</quote>notation. For example,
+ <literal>text/plain</literal>,
+ <literal>text/html</literal>,
<literal>image/gif</literal>, etc. In addition, the mailcap format
- includes two formats for wildcards, one using the special
+ includes two formats for wildcards, one using the special
<quote>*</quote>subtype, the other is the implicit wild, where you only
- include the major type. For example,
- <literal>image/*</literal>, or
+ include the major type. For example,
+ <literal>image/*</literal>, or
<literal>video</literal>will match all image types and video types,
respectively.</para>
<para>The view command is a Unix command for viewing the type
specified. There are two different types of commands supported. The
default is to send the body of the MIME message to the command on
- stdin. You can change this behavior by using
+ stdin. You can change this behavior by using
<literal>%s</literal>as a parameter to your view command. This will
cause Mutt to save the body of the MIME message to a temporary file,
- and then call the view command with the
+ and then call the view command with the
<literal>%s</literal>replaced by the name of the temporary file. In
both cases, Mutt will turn over the terminal to the view program until
the program quits, at which time Mutt will remove the temporary file if
- it exists. This means that mailcap does
+ it exists. This means that mailcap does
<emphasis>not</emphasis>work out of the box with programs which detach
- themselves from the terminal right after starting, like
+ themselves from the terminal right after starting, like
<literal>open</literal>on Mac OS X. In order to nevertheless use these
programs with mailcap, you probably need custom shell scripts.</para>
- <para>So, in the simplest form, you can send a
+ <para>So, in the simplest form, you can send a
<literal>text/plain</literal>message to the external pager more on
standard input:</para>
<screen>text/plain; more</screen>
<para>Or, you could send the message as a file:</para>
<screen>text/plain; more %s</screen>
- <para>Perhaps you would like to use lynx to interactively view a
+ <para>Perhaps you would like to use lynx to interactively view a
<literal>text/html</literal>message:</para>
<screen>text/html; lynx %s</screen>
<para>In this case, lynx does not support viewing a file from standard
- input, so you must use the
+ input, so you must use the
<literal>%s</literal>syntax.</para>
<note>
<para>
<emphasis>Some older versions of lynx contain a bug where they will
- check the mailcap file for a viewer for
+ check the mailcap file for a viewer for
<literal>text/html</literal>. They will find the line which calls
lynx, and run it. This causes lynx to continuously spawn itself to
view the object.</emphasis>
</para>
</note>
<para>On the other hand, maybe you don't want to use lynx
- interactively, you just want to have it convert the
- <literal>text/html</literal>to
+ interactively, you just want to have it convert the
+ <literal>text/html</literal>to
<literal>text/plain</literal>, then you can use:</para>
<screen>text/html; lynx -dump %s | more</screen>
- <para>Perhaps you wish to use lynx to view
+ <para>Perhaps you wish to use lynx to view
<literal>text/html</literal>files, and a pager on all other text
formats, then you would use the following:</para>
<screen>
<title>Secure Use of Mailcap</title>
<para>The interpretation of shell meta-characters embedded in MIME
parameters can lead to security problems in general. Mutt tries to
- quote parameters in expansion of
+ quote parameters in expansion of
<literal>%s</literal>syntaxes properly, and avoids risky characters by
- substituting them, see the
+ substituting them, see the
<link linkend="mailcap-sanitize">
$mailcap_sanitize</link>variable.</para>
<para>Although Mutt's procedures to invoke programs with mailcap seem
<para>If you have to use the %-expandos' values in context where you
need quoting or backtick expansions, put that value into a shell
variable and reference the shell variable where necessary, as in the
- following example (using
+ following example (using
<literal>$charset</literal>inside the backtick expansion is safe, since
it is not itself subject to any further expansion):</para>
<screen>
<sect3 id="optional-mailcap-fields">
<title>Optional Fields</title>
<para>In addition to the required content-type and view command
- fields, you can add semi-colon
+ fields, you can add semi-colon
<quote>;</quote>separated fields to set flags and other options. Mutt
recognizes the following optional fields:</para>
<variablelist>
invoke a pager (either the internal pager or the external pager
defined by the pager variable) on the output of the view
command. Without this flag, Mutt assumes that the command is
- interactive. One could use this to replace the pipe to
- <literal>more</literal>in the
+ interactive. One could use this to replace the pipe to
+ <literal>more</literal>in the
<literal>lynx -dump</literal>example in the Basic
section:</para>
<screen>text/html; lynx -dump %s ; copiousoutput</screen>
- <para>This will cause lynx to format the
- <literal>text/html</literal>output as
+ <para>This will cause lynx to format the
+ <literal>text/html</literal>output as
<literal>text/plain</literal>and Mutt will use your standard
pager to display the results.</para>
- <para>Mutt will set the
+ <para>Mutt will set the
<literal>COLUMNS</literal>environment variable to the width of
the pager. Some programs make use of this environment variable
automatically. Others provide a command line argument that can
use this to set the output width:</para>
<screen>text/html; lynx -dump -width ${COLUMNS:-80} %s; copiousoutput</screen>
- <para>Note that when using the built-in pager,
+ <para>Note that when using the built-in pager,
<emphasis>only</emphasis>entries with this flag will be
considered a handler for a MIME type — all other entries will
be ignored.</para>
<varlistentry>
<term>needsterminal</term>
<listitem>
- <para>Mutt uses this flag when viewing attachments with
+ <para>Mutt uses this flag when viewing attachments with
<link linkend="auto-view">
<command>auto_view</command>
</link>, in order to decide whether it should honor the setting
- of the
+ of the
<link linkend="wait-key">$wait_key</link>variable or not. When
an attachment is viewed using an interactive program, and the
- corresponding mailcap entry has a
- <emphasis>needsterminal</emphasis>flag, Mutt will use
+ corresponding mailcap entry has a
+ <emphasis>needsterminal</emphasis>flag, Mutt will use
<link linkend="wait-key">$wait_key</link>and the exit status of
the program to decide if it will ask you to press a key after
the external program has exited. In all other situations it
<para>This flag specifies the command to use to edit a specific
MIME type. Mutt supports this from the compose menu, and also
uses it to compose new attachments. Mutt will default to the
- defined
+ defined
<link linkend="editor">$editor</link>for text
attachments.</para>
</listitem>
<varlistentry>
<term>nametemplate=<template></term>
<listitem>
- <para>This field specifies the format for the file denoted by
+ <para>This field specifies the format for the file denoted by
<literal>%s</literal>in the command fields. Certain programs
will require a certain file extension, for instance, to
correctly view a file. For instance, lynx will only interpret a
- file as
- <literal>text/html</literal>if the file ends in
- <literal>.html</literal>. So, you would specify lynx as a
+ file as
+ <literal>text/html</literal>if the file ends in
+ <literal>.html</literal>. So, you would specify lynx as a
<literal>text/html</literal>viewer with a line in the mailcap
file like:</para>
<screen>text/html; lynx %s; nametemplate=%s.html</screen>
text/html; firefox -remote 'openURL(%s)' ; test=RunningX
text/html; lynx %s
</screen>
- <para>In this example, Mutt will run the program
+ <para>In this example, Mutt will run the program
<literal>RunningX</literal>which will return 0 if the X Window
- manager is running, and non-zero if it isn't. If
+ manager is running, and non-zero if it isn't. If
<literal>RunningX</literal>returns 0, then Mutt will run
- firefox to display the
+ firefox to display the
<literal>text/html</literal>object. If RunningX doesn't return
0, then Mutt will go on to the next entry and use lynx to
- display the
+ display the
<literal>text/html</literal>object.</para>
</listitem>
</varlistentry>
<title>Search Order</title>
<para>When searching for an entry in the mailcap file, Mutt will
search for the most useful entry for its purpose. For instance, if
- you are attempting to print an
+ you are attempting to print an
<literal>image/gif</literal>, and you have the following entries in
your mailcap file, Mutt will search for an entry with the print
command:</para>
image/gif; ; print= anytopnm %s | pnmtops | lpr; \
nametemplate=%s.gif
</screen>
- <para>Mutt will skip the
- <literal>image/*</literal>entry and use the
+ <para>Mutt will skip the
+ <literal>image/*</literal>entry and use the
<literal>image/gif</literal>entry with the print command.</para>
- <para>In addition, you can use this with
+ <para>In addition, you can use this with
<link linkend="auto-view">
<command>auto_view</command>
</link>to denote two commands for viewing an attachment, one to be
viewed automatically, the other to be viewed interactively from the
- attachment menu using the
- <literal><view-mailcap></literal>function (bound to
+ attachment menu using the
+ <literal><view-mailcap></literal>function (bound to
<quote>m</quote>by default). In addition, you can then use the test
feature to determine which viewer to use interactively depending on
your environment.</para>
text/html; lynx %s; nametemplate=%s.html
text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
</screen>
- <para>For
+ <para>For
<link linkend="auto-view">
<command>auto_view</command>
- </link>, Mutt will choose the third entry because of the
+ </link>, Mutt will choose the third entry because of the
<literal>copiousoutput</literal>tag. For interactive viewing, Mutt
- will run the program
+ will run the program
<literal>RunningX</literal>to determine if it should use the first
entry. If the program returns non-zero, Mutt will use the second
entry for interactive viewing. The last entry is for inline display
- in the pager and the
+ in the pager and the
<literal><view-attach></literal>function in the attachment
menu.</para>
- <para>Entries with the
+ <para>Entries with the
<literal>copiousoutput</literal>tag should always be specified as the
last one per type. For non-interactive use, the last entry will then
actually be the first matching one with the tag set. For
- non-interactive use, only
+ non-interactive use, only
<literal>copiousoutput</literal>-tagged entries are considered. For
interactive use, Mutt ignores this tag and treats all entries
equally. Therefore, if not specified last, all following entries
- without this tag would never be considered for
- <literal><view-attach></literal>because the
+ without this tag would never be considered for
+ <literal><view-attach></literal>because the
<literal>copiousoutput</literal>before them matched already.</para>
</sect3>
<sect3 id="mailcap-command-expansion">
<title>Command Expansion</title>
<para>The various commands defined in the mailcap files are passed to
- the
- <literal>/bin/sh</literal>shell using the
- <literal>system(3)</literal>function. Before the command is passed to
+ the
+ <literal>/bin/sh</literal>shell using the
+ <literal>system(3)</literal>function. Before the command is passed to
<literal>/bin/sh -c</literal>, it is parsed to expand various special
parameters with information from Mutt. The keywords Mutt expands
are:</para>
<varlistentry>
<term>%t</term>
<listitem>
- <para>Mutt will expand
+ <para>Mutt will expand
<literal>%t</literal>to the text representation of the content
type of the message in the same form as the first parameter of
- the mailcap definition line, i.e.
- <literal>text/html</literal>or
+ the mailcap definition line, i.e.
+ <literal>text/html</literal>or
<literal>image/gif</literal>.</para>
</listitem>
</varlistentry>
parameter from the Content-Type: line of the mail message. For
instance, if your mail message contains:</para>
<screen>Content-Type: text/plain; charset=iso-8859-1</screen>
- <para>then Mutt will expand
- <literal>%{charset}</literal>to
+ <para>then Mutt will expand
+ <literal>%{charset}</literal>to
<quote>iso-8859-1</quote>. The default metamail mailcap file
uses this feature to test the charset to spawn an xterm using
the right charset to view the message.</para>
<varlistentry>
<term>\%</term>
<listitem>
- <para>This will be replaced by a literal
+ <para>This will be replaced by a literal
<literal>%</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
- <para>Mutt does not currently support the
- <literal>%F</literal>and
+ <para>Mutt does not currently support the
+ <literal>%F</literal>and
<literal>%n</literal>keywords specified in RFC 1524. The main purpose
of these parameters is for multipart messages, which is handled
internally by Mutt.</para>
Mutt has support for automatically viewing MIME attachments while in the
pager.</para>
<para>For this to work, you must define a viewer in the mailcap file
- which uses the
+ which uses the
<literal>copiousoutput</literal>option to denote that it is
non-interactive. Usually, you also use the entry to convert the
attachment to a text representation which you can view in the
pager.</para>
- <para>You then use the
+ <para>You then use the
<command>auto_view</command>configuration command to list the
content-types that you wish to view automatically. For instance, if you
set it to:</para>
</screen>
<para>
<command>unauto_view</command>can be used to remove previous entries from
- the
- <command>auto_view</command>list. This can be used with
+ the
+ <command>auto_view</command>list. This can be used with
<link linkend="message-hook">
<command>message-hook</command>
- </link>to autoview messages based on size, etc.
+ </link>to autoview messages based on size, etc.
<quote>
<command>unauto_view</command>*</quote>will remove all previous
entries.</para>
<sect1 id="alternative-order">
<title>MIME Multipart/Alternative</title>
- <para>The
+ <para>The
<literal>multipart/alternative</literal>container type only has child
MIME parts which represent the same content in an alternative way. This
is often used to send HTML messages which contain an alternative plain
text representation.</para>
- <para>Mutt has some heuristics for determining which attachment of a
+ <para>Mutt has some heuristics for determining which attachment of a
<literal>multipart/alternative</literal>type to display:</para>
<orderedlist>
<listitem>
- <para>First, Mutt will check the
+ <para>First, Mutt will check the
<command>alternative_order</command>list to determine if one of the
available types is preferred. It consists of a number of MIME types
in order, including support for implicit and explicit wildcards. For
</screen>
</listitem>
<listitem>
- <para>Next, Mutt will check if any of the types have a defined
+ <para>Next, Mutt will check if any of the types have a defined
<link linkend="auto-view">
<command>auto_view</command>
</link>, and use that.</para>
handle.</para>
</listitem>
</orderedlist>
- <para>To remove a MIME type from the
- <command>alternative_order</command>list, use the
+ <para>To remove a MIME type from the
+ <command>alternative_order</command>list, use the
<command>unalternative_order</command>command.</para>
</sect1>
attachment-counting and -searching support might be for you. You can make
your message index display the number of qualifying attachments in each
message, or search for messages by attachment count. You also can
- configure what kinds of attachments qualify for this feature with the
- <command>attachments</command>and
+ configure what kinds of attachments qualify for this feature with the
+ <command>attachments</command>and
<command>unattachments</command>commands.</para>
<para>In order to provide this information, Mutt needs to fully
MIME-parse all messages affected first. This can slow down operation
especially for remote mail folders such as IMAP because all messages have
to be downloaded first regardless whether the user really wants to view
- them or not though using
+ them or not though using
<xref linkend="body-caching" />usually means to download the message just
once.</para>
<para>The syntax is:</para>
</cmdsynopsis>
<para>
<emphasis>disposition</emphasis>is the attachment's Content-Disposition
- type — either
- <literal>inline</literal>or
- <literal>attachment</literal>. You can abbreviate this to
- <literal>I</literal>or
+ type — either
+ <literal>inline</literal>or
+ <literal>attachment</literal>. You can abbreviate this to
+ <literal>I</literal>or
<literal>A</literal>.</para>
- <para>Disposition is prefixed by either a
- <quote>+</quote>symbol or a
- <quote>-</quote>symbol. If it's a
+ <para>Disposition is prefixed by either a
+ <quote>+</quote>symbol or a
+ <quote>-</quote>symbol. If it's a
<quote>+</quote>, you're saying that you want to allow this disposition
- and MIME type to qualify. If it's a
+ and MIME type to qualify. If it's a
<quote>-</quote>, you're saying that this disposition and MIME type is an
- exception to previous
+ exception to previous
<quote>+</quote>rules. There are examples below of how this is
useful.</para>
<para>
<emphasis>mime-type</emphasis>is the MIME type of the attachment you want
- the command to affect. A MIME type is always of the format
- <literal>major/minor</literal>, where
+ the command to affect. A MIME type is always of the format
+ <literal>major/minor</literal>, where
<literal>major</literal>describes the broad category of document you're
- looking at, and
+ looking at, and
<literal>minor</literal>describes the specific type within that category.
- The major part of mime-type must be literal text (or the special token
+ The major part of mime-type must be literal text (or the special token
<quote>
<literal>*</literal>
- </quote>), but the minor part may be a regular expression. (Therefore,
+ </quote>), but the minor part may be a regular expression. (Therefore,
<quote>
<literal>*/.*</literal>
</quote>matches any MIME type.)</para>
- <para>The MIME types you give to the
+ <para>The MIME types you give to the
<command>attachments</command>directive are a kind of pattern. When you
- use the
+ use the
<command>attachments</command>directive, the patterns you specify are
- added to a list. When you use
+ added to a list. When you use
<command>unattachments</command>, the pattern is removed from the list.
The patterns are not expanded and matched to specific MIME types at this
time — they're just text in a list. They're only matched when actually
attachments -I message/external-body
</screen>
</example>
- <para>Entering the command
+ <para>Entering the command
<quote>
<command>attachments</command>?</quote>as a command will list your
current settings in Muttrc format, so that it can be pasted
</arg>
</group>
</cmdsynopsis>
- <para>Mutt's
+ <para>Mutt's
<command>mime_lookup</command>list specifies a list of MIME types that
- should
+ should
<emphasis>not</emphasis>be treated according to their mailcap entry. This
- option is designed to deal with binary types such as
+ option is designed to deal with binary types such as
<literal>application/octet-stream</literal>. When an attachment's MIME
- type is listed in
+ type is listed in
<command>mime_lookup</command>, then the extension of the filename will
- be compared to the list of extensions in the
+ be compared to the list of extensions in the
<literal>mime.types</literal>file. The MIME type associated with this
extension will then be used to process the attachment according to the
rules in the mailcap file and according to any other configuration
- options (such as
+ options (such as
<command>auto_view</command>) specified. Common usage would be:</para>
<screen>mime_lookup application/octet-stream application/X-Lotus-Manuscript</screen>
- <para>In addition, the
+ <para>In addition, the
<literal>unmime_lookup</literal>command may be used to disable this
feature for any particular MIME type if it had been set, for example, in
- a global
+ a global
<literal>.muttrc</literal>.</para>
</sect1>
</chapter>
<sect2 id="compile-time-features">
<title>Enabling/Disabling Features</title>
<para>Mutt supports several of optional features which can be enabled
- or disabled at compile-time by giving the
+ or disabled at compile-time by giving the
<emphasis>configure</emphasis>script certain arguments. These are
- listed in the
- <quote>Optional features</quote>section of the
+ listed in the
+ <quote>Optional features</quote>section of the
<emphasis>configure --help</emphasis>output.</para>
<para>Which features are enabled or disabled can later be determined
- from the output of
- <literal>mutt -v</literal>. If a compile option starts with
- <quote>+</quote>it is enabled and disabled if prefixed with
+ from the output of
+ <literal>mutt -v</literal>. If a compile option starts with
+ <quote>+</quote>it is enabled and disabled if prefixed with
<quote>-</quote>. For example, if Mutt was compiled using GnuTLS for
- encrypted communication instead of OpenSSL,
+ encrypted communication instead of OpenSSL,
<literal>mutt -v</literal>would contain:</para>
<screen>-USE_SSL_OPENSSL +USE_SSL_GNUTLS</screen>
</sect2>
<sect2 id="mutt-patches">
<title>Mutt Patches</title>
- <para>Mutt may also be
+ <para>Mutt may also be
<quote>patched</quote>to support smaller features. These patches should
- add a free-form string to the end Mutt's version string. Running
- <literal>mutt -v</literal>might show:
+ add a free-form string to the end Mutt's version string. Running
+ <literal>mutt -v</literal>might show:
<screen>patch-1.8.1.sidebar.20170414</screen></para>
</sect2>
<title>URL Syntax</title>
<para>Mutt optionally supports the IMAP, POP3 and SMTP protocols which
require to access servers using URLs. The canonical syntax for
- specifying URLs in Mutt is (an item enclosed in
+ specifying URLs in Mutt is (an item enclosed in
<literal>[]</literal>means it is optional and may be omitted):</para>
<screen>proto[s]://[username[:password]@]server[:port][/path]</screen>
<para>
- <emphasis>proto</emphasis>is the communication protocol:
- <literal>imap</literal>for IMAP,
- <literal>pop</literal>for POP3 and
- <literal>smtp</literal>for SMTP. If
- <quote>s</quote>for
+ <emphasis>proto</emphasis>is the communication protocol:
+ <literal>imap</literal>for IMAP,
+ <literal>pop</literal>for POP3 and
+ <literal>smtp</literal>for SMTP. If
+ <quote>s</quote>for
<quote>secure communication</quote>is appended, Mutt will attempt to
establish an encrypted communication using SSL or TLS.</para>
<para>Since all protocols supported by Mutt support/require
authentication, login credentials may be specified in the URL. This has
the advantage that multiple IMAP, POP3 or SMTP servers may be specified
- (which isn't possible using, for example,
+ (which isn't possible using, for example,
<link linkend="imap-user">$imap_user</link>). The username may contain
- the
+ the
<quote>@</quote>symbol being used by many mail systems as part of the
- login name. The special characters
+ login name. The special characters
<quote>/</quote>(
- <literal>%2F</literal>),
+ <literal>%2F</literal>),
<quote>:</quote>(
- <literal>%3A</literal>) and
+ <literal>%3A</literal>) and
<quote>%</quote>(
- <literal>%25</literal>) have to be URL-encoded in usernames using the
+ <literal>%25</literal>) have to be URL-encoded in usernames using the
<literal>%</literal>-notation.</para>
<para>A password can be given, too but is not recommended if the URL is
specified in a configuration file on disk.</para>
<para>If no port number is given, Mutt will use the system's default
- for the given protocol (usually consulting
+ for the given protocol (usually consulting
<literal>/etc/services</literal>).</para>
<para>The optional path is only relevant for IMAP and ignored
elsewhere.</para>
<title>SSL/TLS Support</title>
<para>If Mutt is compiled with IMAP, POP3 and/or SMTP support, it can
also be compiled with support for SSL or TLS using either OpenSSL or
- GnuTLS ( by running the
- <emphasis>configure</emphasis>script with the
- <emphasis>--enable-ssl=...</emphasis>option for OpenSSL or
+ GnuTLS ( by running the
+ <emphasis>configure</emphasis>script with the
+ <emphasis>--enable-ssl=...</emphasis>option for OpenSSL or
<emphasis>--enable-gnutls=...</emphasis>for GnuTLS). Mutt can then
attempt to encrypt communication with remote servers if these protocols
- are suffixed with
- <quote>s</quote>for
+ are suffixed with
+ <quote>s</quote>for
<quote>secure communication</quote>.</para>
</sect1>
<sect1 id="pop">
<title>POP3 Support</title>
- <para>If Mutt is compiled with POP3 support (by running the
- <emphasis>configure</emphasis>script with the
+ <para>If Mutt is compiled with POP3 support (by running the
+ <emphasis>configure</emphasis>script with the
<emphasis>--enable-pop</emphasis>flag), it has the ability to work with
mailboxes located on a remote POP3 server and fetch mail for local
browsing.</para>
- <para>Remote POP3 servers can be accessed using URLs with the
- <literal>pop</literal>protocol for unencrypted and
- <literal>pops</literal>for encrypted communication, see
+ <para>Remote POP3 servers can be accessed using URLs with the
+ <literal>pop</literal>protocol for unencrypted and
+ <literal>pops</literal>for encrypted communication, see
<xref linkend="url-syntax" />for details.</para>
<para>Polling for new mail is more expensive over POP3 than locally. For
this reason the frequency at which Mutt will check for mail remotely can
- be controlled by the
+ be controlled by the
<link linkend="pop-checkinterval">$pop_checkinterval</link>variable,
which defaults to every 60 seconds.</para>
<para>POP is read-only which doesn't allow for some features like editing
- messages or changing flags. However, using
- <xref linkend="header-caching" />and
+ messages or changing flags. However, using
+ <xref linkend="header-caching" />and
<xref linkend="body-caching" />Mutt simulates the new/old/read flags as
well as flagged and replied. Mutt applies some logic on top of remote
messages but cannot change them so that modifications of flags are lost
when messages are downloaded from the POP server (either by Mutt or other
tools).</para>
<anchor id="fetch-mail" />
- <para>Another way to access your POP3 mail is the
+ <para>Another way to access your POP3 mail is the
<literal><fetch-mail></literal>function (default: G). It allows to
- connect to
+ connect to
<link linkend="pop-host">$pop_host</link>, fetch all your new mail and
- place it in the local
+ place it in the local
<link linkend="spoolfile">$spoolfile</link>. After this point, Mutt runs
exactly as if the mail had always been local.</para>
<note>
<para>If you only need to fetch all messages to a local mailbox you
- should consider using a specialized program, such as
- <literal>fetchmail(1)</literal>,
+ should consider using a specialized program, such as
+ <literal>fetchmail(1)</literal>,
<literal>getmail(1)</literal>or similar.</para>
</note>
</sect1>
<sect1 id="imap">
<title>IMAP Support</title>
- <para>If Mutt was compiled with IMAP support (by running the
- <emphasis>configure</emphasis>script with the
+ <para>If Mutt was compiled with IMAP support (by running the
+ <emphasis>configure</emphasis>script with the
<emphasis>--enable-imap</emphasis>flag), it has the ability to work with
folders located on a remote IMAP server.</para>
<para>You can access the remote inbox by selecting the folder by its URL
- (see
- <xref linkend="url-syntax" />for details) using the
- <literal>imap</literal>or
+ (see
+ <xref linkend="url-syntax" />for details) using the
+ <literal>imap</literal>or
<literal>imaps</literal>protocol. Alternatively, a pine-compatible
- notation is also supported, i.e.
+ notation is also supported, i.e.
<literal>
{[username@]imapserver[:port][/ssl]}path/to/folder</literal></para>
- <para>Note that not all servers use
+ <para>Note that not all servers use
<quote>/</quote>as the hierarchy separator. Mutt should correctly notice
which separator is being used by the server and convert paths
accordingly.</para>
<para>When browsing folders on an IMAP server, you can toggle whether to
- look at only the folders you are subscribed to, or all folders with the
- <emphasis>toggle-subscribed</emphasis>command. See also the
+ look at only the folders you are subscribed to, or all folders with the
+ <emphasis>toggle-subscribed</emphasis>command. See also the
<link linkend="imap-list-subscribed">
$imap_list_subscribed</link>variable.</para>
<para>Polling for new mail on an IMAP server can cause noticeable delays.
- So, you'll want to carefully tune the
- <link linkend="mail-check">$mail_check</link>and
+ So, you'll want to carefully tune the
+ <link linkend="mail-check">$mail_check</link>and
<link linkend="timeout">$timeout</link>variables. Reasonable values
are:</para>
<screen>
following differences:</para>
<itemizedlist>
<listitem>
- <para>In lieu of file permissions, Mutt displays the string
- <quote>IMAP</quote>, possibly followed by the symbol
+ <para>In lieu of file permissions, Mutt displays the string
+ <quote>IMAP</quote>, possibly followed by the symbol
<quote>+</quote>, indicating that the entry contains both messages
and subfolders. On Cyrus-like servers folders will often contain
both messages and subfolders.</para>
</listitem>
<listitem>
<para>For the case where an entry can contain both messages and
- subfolders, the selection key (bound to
+ subfolders, the selection key (bound to
<literal>enter</literal>by default) will choose to descend into the
subfolder view. If you wish to view the messages in that folder,
- you must use
- <literal>view-file</literal>instead (bound to
+ you must use
+ <literal>view-file</literal>instead (bound to
<literal>space</literal>by default).</para>
</listitem>
<listitem>
- <para>You can create, delete and rename mailboxes with the
- <literal><create-mailbox></literal>,
- <literal><delete-mailbox></literal>, and
+ <para>You can create, delete and rename mailboxes with the
+ <literal><create-mailbox></literal>,
+ <literal><delete-mailbox></literal>, and
<literal><rename-mailbox></literal>commands (default
- bindings:
- <literal>C</literal>,
- <literal>d</literal>and
- <literal>r</literal>, respectively). You may also
- <literal><subscribe></literal>and
+ bindings:
+ <literal>C</literal>,
+ <literal>d</literal>and
+ <literal>r</literal>, respectively). You may also
+ <literal><subscribe></literal>and
<literal><unsubscribe></literal>to mailboxes (normally these
- are bound to
- <literal>s</literal>and
+ are bound to
+ <literal>s</literal>and
<literal>u</literal>, respectively).</para>
</listitem>
</itemizedlist>
has yet to be integrated into the main tree). There is also support for
the pseudo-protocol ANONYMOUS, which allows you to log in to a public
IMAP server without having an account. To use ANONYMOUS, simply make
- your username blank or
+ your username blank or
<quote>anonymous</quote>.</para>
<para>SASL is a special super-authenticator, which selects among
several protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and
GSSAPI), your entire session will be encrypted and invisible to those
teeming network snoops. It is the best option if you have it. To use
it, you must have the Cyrus SASL library installed on your system and
- compile Mutt with the
+ compile Mutt with the
<emphasis>--with-sasl</emphasis>flag.</para>
<para>Mutt will try whichever methods are compiled in and available on
the server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5,
<link linkend="imap-user">$imap_user</link>- controls the username
under which you request authentication on the IMAP server, for all
authenticators. This is overridden by an explicit username in the
- mailbox path (i.e. by using a mailbox name of the form
+ mailbox path (i.e. by using a mailbox name of the form
<literal>{user@host}</literal>).</para>
</listitem>
<listitem>
<title>SMTP Support</title>
<para>Besides supporting traditional mail delivery through a
sendmail-compatible program, Mutt supports delivery through SMTP if it
- was configured and built with
+ was configured and built with
<literal>--enable-smtp</literal>.</para>
- <para>If the configuration variable
+ <para>If the configuration variable
<link linkend="smtp-url">$smtp_url</link>is set, Mutt will contact the
given SMTP server to deliver messages; if it is unset, Mutt will use the
- program specified by
+ program specified by
<link linkend="sendmail">$sendmail</link>.</para>
- <para>For details on the URL syntax, please see
+ <para>For details on the URL syntax, please see
<xref linkend="url-syntax" />.</para>
- <para>The built-in SMTP support supports encryption (the
+ <para>The built-in SMTP support supports encryption (the
<literal>smtps</literal>protocol using SSL or TLS) as well as SMTP
authentication using SASL. The authentication mechanisms for SASL are
- specified in
+ specified in
<link linkend="smtp-authenticators">$smtp_authenticators</link>defaulting
to an empty list which makes Mutt try all available methods from
most-secure to least-secure.</para>
</cmdsynopsis>
<para>If you happen to have accounts on multiple IMAP, POP and/or SMTP
servers, you may find managing all the authentication settings
- inconvenient and error-prone. The
+ inconvenient and error-prone. The
<link linkend="account-hook">
<command>account-hook</command>
- </link>command may help. This hook works like
+ </link>command may help. This hook works like
<link linkend="folder-hook">
<command>folder-hook</command>
</link>but is invoked whenever Mutt needs to access a remote mailbox
(including inside the folder browser), not just when you open the
mailbox. This includes (for example) polling for new mail, storing Fcc
- messages and saving messages to a folder. As a consequence,
+ messages and saving messages to a folder. As a consequence,
<link linkend="account-hook">
<command>account-hook</command>
</link>should only be used to set connection-related settings such as
passwords or tunnel commands but not settings such as sender address or
- name (because in general it should be considered unpredictable which
+ name (because in general it should be considered unpredictable which
<link linkend="account-hook">
<command>account-hook</command>
</link>was last used).</para>
account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'
</screen>
- <para>To manage multiple accounts with, for example, different values of
- <link linkend="record">$record</link>or sender addresses,
+ <para>To manage multiple accounts with, for example, different values of
+ <link linkend="record">$record</link>or sender addresses,
<link linkend="folder-hook">
<command>folder-hook</command>
- </link>has to be be used together with the
+ </link>has to be be used together with the
<link linkend="mailboxes">
<command>mailboxes</command>
</link>command.</para>
folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sent'
</screen>
</example>
- <para>In example
- <xref linkend="ex-multiaccount" />the folders are defined using
+ <para>In example
+ <xref linkend="ex-multiaccount" />the folders are defined using
<link linkend="mailboxes">
<command>mailboxes</command>
- </link>so Mutt polls them for new mail. Each
+ </link>so Mutt polls them for new mail. Each
<link linkend="folder-hook">
<command>folder-hook</command>
</link>triggers when one mailbox below each IMAP account is opened and
- sets
+ sets
<link linkend="folder">$folder</link>to the account's root folder. Next,
- it sets
- <link linkend="record">$record</link>to the
- <emphasis>INBOX/Sent</emphasis>folder below the newly set
- <link linkend="folder">$folder</link>. Please notice that the value the
+ it sets
+ <link linkend="record">$record</link>to the
+ <emphasis>INBOX/Sent</emphasis>folder below the newly set
+ <link linkend="folder">$folder</link>. Please notice that the value the
<quote>+</quote>
- <link linkend="shortcuts">mailbox shortcut</link>refers to depends on the
- <emphasis>current</emphasis>value of
+ <link linkend="shortcuts">mailbox shortcut</link>refers to depends on the
+ <emphasis>current</emphasis>value of
<link linkend="folder">$folder</link>and therefore has to be set
- separately per account. Setting other values like
- <link linkend="from">$from</link>or
- <link linkend="signature">$signature</link>is analogous to setting
+ separately per account. Setting other values like
+ <link linkend="from">$from</link>or
+ <link linkend="signature">$signature</link>is analogous to setting
<link linkend="record">$record</link>.</para>
</sect1>
<sect1 id="caching">
<title>Local Caching</title>
- <para>Mutt contains two types of local caching:
- <emphasis>(1)</emphasis>the so-called
- <quote>header caching</quote>and
- <emphasis>(2)</emphasis>the so-called
+ <para>Mutt contains two types of local caching:
+ <emphasis>(1)</emphasis>the so-called
+ <quote>header caching</quote>and
+ <emphasis>(2)</emphasis>the so-called
<quote>body caching</quote>which are both described in this
section.</para>
<para>Header caching is optional as it depends on external libraries,
and MH, reading the headers from a single file is much faster than
looking at possibly thousands of single files (since Maildir and MH use
one file per message.)</para>
- <para>Header caching can be enabled via the configure script and the
+ <para>Header caching can be enabled via the configure script and the
<emphasis>--enable-hcache</emphasis>option. It's not turned on by
default because external database libraries are required: one of
tokyocabinet, kyotocabinet, qdbm, gdbm, lmdb or bdb must be
present.</para>
- <para>If enabled,
+ <para>If enabled,
<link linkend="header-cache">$header_cache</link>can be used to either
point to a file or a directory. If set to point to a file, one database
file for all folders will be used (which may result in lower
performance), but one file per folder if it points to a
directory.</para>
- <para>Additionally,
+ <para>Additionally,
<link linkend="header-cache-backend">$header_cache_backend</link>can be
used to specify which backend to use. The list of available backends
can be specified at configure time with a set of --with-<backend>
whole message bodies. This results in faster display of messages for
POP and IMAP folders because messages usually have to be downloaded
only once.</para>
- <para>For configuration, the variable
+ <para>For configuration, the variable
<link linkend="message-cachedir">$message_cachedir</link>must point to
a directory. There, Mutt will create a hierarchy of subdirectories
named like the account and mailbox path the cache is for.</para>
<sect2 id="cache-dirs">
<title>Cache Directories</title>
- <para>For using both, header and body caching,
- <link linkend="header-cache">$header_cache</link>and
+ <para>For using both, header and body caching,
+ <link linkend="header-cache">$header_cache</link>and
<link linkend="message-cachedir">$message_cachedir</link>can be safely
set to the same value.</para>
<para>In a header or body cache directory, Mutt creates a directory
- hierarchy named like:
- <literal>proto:user@hostname</literal>where
- <literal>proto</literal>is either
- <quote>pop</quote>or
+ hierarchy named like:
+ <literal>proto:user@hostname</literal>where
+ <literal>proto</literal>is either
+ <quote>pop</quote>or
<quote>imap.</quote>Within there, for each folder, Mutt stores messages
- in single files and header caches in files with the
+ in single files and header caches in files with the
<quote>.hcache</quote>extension. All files can be removed as needed if
the consumed disk space becomes an issue as Mutt will silently fetch
missing items again. Pathnames are always stored in UTF-8
big. It depends on the database library used for header caching whether
disk space freed by removing messages is re-used.</para>
<para>For body caches, Mutt can keep the local cache in sync with the
- remote mailbox if the
+ remote mailbox if the
<link linkend="message-cache-clean">$message_cache_clean</link>variable
is set. Cleaning means to remove messages from the cache which are no
longer present in the mailbox which only happens when other mail
<sect1 id="exact-address">
<title>Exact Address Generation</title>
- <para>Mutt supports the
+ <para>Mutt supports the
<quote>Name <user@host></quote>address syntax for reading and
- writing messages, the older
+ writing messages, the older
<quote>user@host (Name)</quote>syntax is only supported when reading
- messages. The
+ messages. The
<emphasis>--enable-exact-address</emphasis>switch can be given to
- configure to build it with write-support for the latter syntax.
- <literal>EXACT_ADDRESS</literal>in the output of
+ configure to build it with write-support for the latter syntax.
+ <literal>EXACT_ADDRESS</literal>in the output of
<literal>mutt -v</literal>indicates whether it's supported.</para>
</sect1>
anonymously using a chain of remailers. Mixmaster support in Mutt is for
mixmaster version 2.04 or later.</para>
<para>To use it, you'll have to obey certain restrictions. Most
- important, you cannot use the
- <literal>Cc</literal>and
+ important, you cannot use the
+ <literal>Cc</literal>and
<literal>Bcc</literal>headers. To tell Mutt to use mixmaster, you have to
select a remailer chain, using the mix function on the compose
menu.</para>
<para>The chain selection screen is divided into two parts. In the
(larger) upper part, you get a list of remailers you may use. In the
lower part, you see the currently selected chain of remailers.</para>
- <para>You can navigate in the chain using the
- <literal><chain-prev></literal>and
+ <para>You can navigate in the chain using the
+ <literal><chain-prev></literal>and
<literal><chain-next></literal>functions, which are by default
- bound to the left and right arrows and to the
- <literal>h</literal>and
+ bound to the left and right arrows and to the
+ <literal>h</literal>and
<literal>l</literal>keys (think vi keyboard bindings). To insert a
- remailer at the current chain position, use the
+ remailer at the current chain position, use the
<literal><insert></literal>function. To append a remailer behind
- the current chain position, use
- <literal><select-entry></literal>or
+ the current chain position, use
+ <literal><select-entry></literal>or
<literal><append></literal>. You can also delete entries from the
chain, using the corresponding function. Finally, to abandon your
- changes, leave the menu, or
- <literal><accept></literal>them pressing (by default) the
+ changes, leave the menu, or
+ <literal><accept></literal>them pressing (by default) the
<literal>Return</literal>key.</para>
<para>Note that different remailers do have different capabilities,
- indicated in the %c entry of the remailer menu lines (see
+ indicated in the %c entry of the remailer menu lines (see
<link linkend="mix-entry-format">$mix_entry_format</link>). Most
- important is the
- <quote>middleman</quote>capability, indicated by a capital
+ important is the
+ <quote>middleman</quote>capability, indicated by a capital
<quote>M</quote>: This means that the remailer in question cannot be used
as the final element of a chain, but will only forward messages to other
mixmaster remailers. For details on the other capabilities, please have a
<title>Introduction</title>
<para>This feature allows specifying regexps to color attachment
headers just like the mail body would. The headers are the parts
- colored by the
+ colored by the
<literal>attachment</literal>color. Coloring them is useful to
highlight the results of GPGME's signature checks or simply the
mimetype or size of the attachment. Only the part matched by the regexp
<sect2 id="attach-headers-color-usage">
<title>Usage</title>
- <para>The
- <literal>attach_headers</literal>color should be used just like the
+ <para>The
+ <literal>attach_headers</literal>color should be used just like the
<literal>body</literal>color.</para>
<screen>color attach_headers foreground background pattern</screen>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Guillaume Brogi
+ <para>Guillaume Brogi
<email>gui-gui@netcourrier.com</email></para>
</listitem>
</itemizedlist>
<para>Brian Medley</para>
</listitem>
<listitem>
- <para>Guillaume Brogi
+ <para>Guillaume Brogi
<email>gui-gui@netcourrier.com</email></para>
</listitem>
</itemizedlist>
well with encrypted files, too. In fact, if you can create a
program/script to convert to and from your format, then Mutt can read
it.</para>
- <para>The patch adds three hooks to Mutt:
- <literal>open-hook</literal>,
- <literal>close-hook</literal>and
+ <para>The patch adds three hooks to Mutt:
+ <literal>open-hook</literal>,
+ <literal>close-hook</literal>and
<literal>append-hook</literal>. They define commands to: uncompress a
file; compress a file; append messages to an already compressed
file.</para>
<replaceable class="parameter">shell-command</replaceable>
</arg>
</cmdsynopsis>
- <para>The shell-command must contain two placeholders for filenames:
- <literal>%f</literal>and
- <literal>%t</literal>. These represent
- <quote>from</quote>and
+ <para>The shell-command must contain two placeholders for filenames:
+ <literal>%f</literal>and
+ <literal>%t</literal>. These represent
+ <quote>from</quote>and
<quote>to</quote>filenames. These placeholders should be placed inside
single-quotes to prevent unintended shell expansions.</para>
- <para>If you need the exact string
- <quote>%f</quote>or
- <quote>%t</quote>in your command, simply double up the
- <quote>%</quote>character, e.g.
- <quote>%%f</quote>or
+ <para>If you need the exact string
+ <quote>%f</quote>or
+ <quote>%t</quote>in your command, simply double up the
+ <quote>%</quote>character, e.g.
+ <quote>%%f</quote>or
<quote>%%t</quote>.</para>
<table id="table-compress-optional">
<sect3 id="open-hook">
<title>Read from compressed mailbox</title>
<screen>open-hook regexp shell-command</screen>
- <para>If Mutt is unable to open a file, it then looks for
+ <para>If Mutt is unable to open a file, it then looks for
<literal>open-hook</literal>that matches the filename.</para>
<para>If your compression program doesn't have a well-defined
- extension, then you can use
+ extension, then you can use
<literal>.</literal>as the regexp.</para>
<sect4 id="compress-open-hook-example">
- <title>Example of
+ <title>Example of
<literal>open-hook</literal></title>
<screen>open-hook '\.gz$' "gzip --stdout --decompress '%f' > '%t'"</screen>
<itemizedlist>
<listitem>
- <para>Mutt finds a file,
+ <para>Mutt finds a file,
<quote>example.gz</quote>, that it can't read</para>
</listitem>
<listitem>
- <para>Mutt has an
- <literal>open-hook</literal>whose regexp matches the filename:
+ <para>Mutt has an
+ <literal>open-hook</literal>whose regexp matches the filename:
<literal>\.gz$</literal></para>
</listitem>
<listitem>
- <para>Mutt uses the command
- <literal>gzip -cd</literal>to create a temporary file that it
+ <para>Mutt uses the command
+ <literal>gzip -cd</literal>to create a temporary file that it
<emphasis>can</emphasis>read</para>
</listitem>
</itemizedlist>
<title>Write to a compressed mailbox</title>
<screen>close-hook regexp shell-command</screen>
<para>When Mutt has finished with a compressed mail folder, it will
- look for a matching
- <literal>close-hook</literal>to recompress the file. This hook is
+ look for a matching
+ <literal>close-hook</literal>to recompress the file. This hook is
<link linkend="table-compress-optional">optional</link>.</para>
<note>
- <para>If the folder has not been modified, the
+ <para>If the folder has not been modified, the
<literal>close-hook</literal>will not be called.</para>
</note>
<sect4 id="compress-close-hook-example">
- <title>Example of
+ <title>Example of
<literal>close-hook</literal></title>
<screen>close-hook '\.gz$' "gzip --stdout '%t' > '%f'"</screen>
<itemizedlist>
<listitem>
- <para>Mutt has finished with a folder,
- <quote>example.gz</quote>, that it opened with
+ <para>Mutt has finished with a folder,
+ <quote>example.gz</quote>, that it opened with
<literal>open-hook</literal></para>
</listitem>
<listitem>
<para>The folder has been modified</para>
</listitem>
<listitem>
- <para>Mutt has a
- <literal>close-hook</literal>whose regexp matches the filename:
+ <para>Mutt has a
+ <literal>close-hook</literal>whose regexp matches the filename:
<literal>\.gz$</literal></para>
</listitem>
<listitem>
- <para>Mutt uses the command
+ <para>Mutt uses the command
<literal>gzip -c</literal>to create a new compressed
file</para>
</listitem>
</itemizedlist>
<note>
- <para>The
+ <para>The
<literal>close-hook</literal>can also include extra options, e.g.
- compression level:
+ compression level:
<literal>--best</literal></para>
</note>
</sect4>
<title>Append to a compressed mailbox</title>
<screen>append-hook regexp shell-command</screen>
<para>When Mutt wants to append an email to a compressed mail folder,
- it will look for a matching
- <literal>append-hook</literal>. This hook is
+ it will look for a matching
+ <literal>append-hook</literal>. This hook is
<link linkend="table-compress-optional">optional</link>.</para>
- <para>Using the
+ <para>Using the
<literal>append-hook</literal>will save time, but Mutt won't be able
to determine the type of the mail folder inside the compressed
file.</para>
- <para>Mutt will
- <emphasis>assume</emphasis>the type to be that of the
+ <para>Mutt will
+ <emphasis>assume</emphasis>the type to be that of the
<literal>$mbox_type</literal>variable. Mutt also uses this type for
temporary files.</para>
- <para>Mutt will only use the
- <literal>append-hook</literal>for existing files. The
+ <para>Mutt will only use the
+ <literal>append-hook</literal>for existing files. The
<literal>close-hook</literal>will be used for empty, or missing
files.</para>
<note>
- <para>If your command writes to stdout, it is vital that you use
- <literal>>></literal>in the
+ <para>If your command writes to stdout, it is vital that you use
+ <literal>>></literal>in the
<quote>append-hook</quote>. If not, data will be lost.</para>
</note>
<sect4 id="compress-append-hook-example">
- <title>Example of
+ <title>Example of
<literal>append-hook</literal></title>
<screen>append-hook '\.gz$' "gzip --stdout '%t' >> '%f'"</screen>
<itemizedlist>
<listitem>
- <para>Mutt wants to append an email to a folder,
- <quote>example.gz</quote>, that it opened with
+ <para>Mutt wants to append an email to a folder,
+ <quote>example.gz</quote>, that it opened with
<literal>open-hook</literal></para>
</listitem>
<listitem>
- <para>Mutt has an
+ <para>Mutt has an
<literal>append-hook</literal>whose regexp matches the
- filename:
+ filename:
<literal>\.gz$</literal></para>
</listitem>
<listitem>
- <para>Mutt knows the mailbox type from the
+ <para>Mutt knows the mailbox type from the
<literal>$mbox</literal>variable</para>
</listitem>
<listitem>
- <para>Mutt uses the command
+ <para>Mutt uses the command
<literal>gzip -c</literal>to append to an existing compressed
file</para>
</listitem>
</itemizedlist>
<note>
- <para>The
+ <para>The
<literal>append-hook</literal>can also include extra options,
- e.g. compression level:
+ e.g. compression level:
<literal>--best</literal></para>
</note>
</sect4>
<sect3 id="compress-empty">
<title>Empty Files</title>
<para>Mutt assumes that an empty file is not compressed. In this
- situation, unset
+ situation, unset
<link linkend="save-empty">$save_empty</link>, so that the compressed
file will be removed if you delete all of the messages.</para>
</sect3>
<sect3 id="compress-security">
<title>Security</title>
<para>Encrypted files are decrypted into temporary files which are
- stored in the
+ stored in the
<link linkend="tmpdir">$tmpdir</link>directory. This could be a
security risk.</para>
</sect3>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Roland Rosenfeld
+ <para>Roland Rosenfeld
<email>roland@spinnaker.de</email></para>
</listitem>
<listitem>
- <para>Alain Penders
+ <para>Alain Penders
<email>Alain@Finale-Dev.com</email></para>
</listitem>
<listitem>
- <para>Christoph
- <quote>Myon</quote>Berg
+ <para>Christoph
+ <quote>Myon</quote>Berg
<email>myon@debian.org</email></para>
</listitem>
<listitem>
- <para>Evgeni Golov
+ <para>Evgeni Golov
<email>evgeni@debian.org</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="cond-date-intro">
<title>Introduction</title>
- <para>The
- <quote>cond-date</quote>patch allows you to construct
+ <para>The
+ <quote>cond-date</quote>patch allows you to construct
<link linkend="index-format">$index_format</link>expressions based on
the age of the email.</para>
- <para>Mutt's default
+ <para>Mutt's default
<literal>$index_format</literal>displays email dates in the form:
- abbreviated-month day-of-month —
+ abbreviated-month day-of-month —
<quote>Jan 14</quote>.</para>
<para>The format is configurable but only per-mailbox. This feature
allows you to configure the display depending on the age of the
</tbody>
</tgroup>
</table>
- <para>For an explanation of the date formatting strings, see
+ <para>For an explanation of the date formatting strings, see
<literal>strftime(3).</literal></para>
<para>By carefully picking your formats, the dates can remain
unambiguous and compact.</para>
<para>Mutt's conditional format strings have the form: (whitespace
introduced for clarity)</para>
<screen>%? TEST ? TRUE & FALSE ?</screen>
- <para>The examples below use the test
+ <para>The examples below use the test
<quote>%[</quote>— the date of the message in the local timezone. They
- will also work with
+ will also work with
<quote>%(</quote>— the local time that the message arrived.</para>
<para>The date tests are of the form:</para>
<screen>%[nX? TRUE & FALSE ?</screen>
<sect2 id="cond-date-variables">
<title>Variables</title>
- <para>The
+ <para>The
<quote>cond-date</quote>patch doesn't have any config of its own. It
modifies the behavior of the format strings.</para>
</sect2>
<sect2 id="cond-date-known-bugs">
<title>Known Bugs</title>
- <para>Date parsing doesn't quite do what you expect.
- <quote>1w</quote>doesn't mean the
- <quote>in the last 7 days</quote>, but
+ <para>Date parsing doesn't quite do what you expect.
+ <quote>1w</quote>doesn't mean the
+ <quote>in the last 7 days</quote>, but
<quote>
<emphasis>this</emphasis>week</quote>. This doesn't match the normal
- Mutt behavior: for example
+ Mutt behavior: for example
<literal>~d>1w</literal>means emails dated in the last 7
days.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Aaron Schrab
+ <para>Aaron Schrab
<email>aaron@schrab.com</email></para>
</listitem>
<listitem>
- <para>Eric Davis
+ <para>Eric Davis
<email>edavis@insanum.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<title>Introduction</title>
<para>Once you encrypt an email to someone you cannot read it. This is
good for security, but bad for record-keeping. If you wanted to keep a
- copy of an encrypted email you could set
+ copy of an encrypted email you could set
<link linkend="fcc-clear">$fcc_clear</link>.</para>
- <para>A better option is to enable
- <link linkend="smime-encrypt-self">$smime_encrypt_self</link>, then set
+ <para>A better option is to enable
+ <link linkend="smime-encrypt-self">$smime_encrypt_self</link>, then set
<link linkend="smime-default-key">$smime_default_key</link>to your
personal S/MIME key id.</para>
<screen>
set smime_encrypt_self = yes
set smime_default_key = bb345e23.0
</screen>
- <para>Or, if you use PGP,
- <link linkend="pgp-encrypt-self">$pgp_encrypt_self</link>, then set
+ <para>Or, if you use PGP,
+ <link linkend="pgp-encrypt-self">$pgp_encrypt_self</link>, then set
<link linkend="pgp-sign-as">$pgp_sign_as</link>to your personal PGP key
id.</para>
<screen>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Omen Wild
+ <para>Omen Wild
<email>omen@mandarb.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
<listitem>
- <para>Guillaume Brogi
+ <para>Guillaume Brogi
<email>gui-gui@netcourrier.com</email></para>
</listitem>
</itemizedlist>
</term>
<listitem>
<para>
- <literal>open_memstream()</literal>,
+ <literal>open_memstream()</literal>,
<literal>fmemopen()</literal>from glibc</para>
</listitem>
</varlistentry>
</variablelist>
- <para>This feature can be enabled by running
- <literal>configure</literal>with the option
+ <para>This feature can be enabled by running
+ <literal>configure</literal>with the option
<literal>--enable-fmemopen</literal></para>
</sect2>
<sect2 id="fmemopen-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>fmemopen</quote>patch speeds up some searches.</para>
<para>This feature changes a few places where Mutt creates temporary
files. It replaces them with in-memory buffers. This should improve the
- performance when searching the header or body using the
+ performance when searching the header or body using the
<link linkend="thorough-search">$thorough_search</link>option.</para>
<para>There are no user-configurable parts.</para>
- <para>This feature depends on
- <literal>open_memstream()</literal>and
+ <para>This feature depends on
+ <literal>open_memstream()</literal>and
<literal>fmemopen()</literal>. They are provided by glibc. Without
them, Mutt will simply create temporary files.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Julius Plenz
+ <para>Julius Plenz
<email>plenz@cis.fu-berlin.de</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
that alerts the user if the message body contains a certain keyword but
there are no attachments added. This is meant to ensure that the user
does not forget to attach a file after promising to do so in the mail.
- The attachment keyword will not be scanned in text matched by
+ The attachment keyword will not be scanned in text matched by
<link linkend="quote-regexp">$quote_regexp</link>.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Darshit Shah
+ <para>Darshit Shah
<email>darnir@gmail.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
<listitem>
- <para>Johannes Weißl
+ <para>Johannes Weißl
<email>jargon@molb.org</email></para>
</listitem>
<listitem>
- <para>Steven! Ragnarök
+ <para>Steven! Ragnarök
<email>steven@nuclearsandwich.com</email></para>
</listitem>
</itemizedlist>
<para>
<emphasis role="bold">Since:</emphasis>NeoMutt 2016-08-08</para>
<para>This feature implements a new hook that is called periodically
- when Mutt checks for new mail. This hook is called every
+ when Mutt checks for new mail. This hook is called every
<literal>$timeout</literal>seconds.</para>
</sect3>
<emphasis role="bold">Since:</emphasis>NeoMutt 2016-11-25</para>
<para>This feature implements a new hook that is called when Mutt
first starts up, but before opening the first mailbox. This is most
- likely to be useful to users of
+ likely to be useful to users of
<link linkend="notmuch">notmuch</link>.</para>
</sect3>
<emphasis role="bold">Since:</emphasis>NeoMutt 2016-11-25</para>
<para>This feature implements a hook that is called when Mutt shuts
down, but before closing the first mailbox. This is most likely to be
- useful to users of
+ useful to users of
<link linkend="notmuch">notmuch</link>.</para>
</sect3>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Armin Wolfermann
+ <para>Armin Wolfermann
<email>armin@wolfermann.org</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
<listitem>
- <para>Thomas Adam
+ <para>Thomas Adam
<email>thomas@xteddy.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="ifdef-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>ifdef</quote>patch introduces three new commands to Mutt and
allow you to share one config file between versions of Mutt that may
have different features compiled in.</para>
ifndef symbol config-command [args...] <emphasis role="comment"># If a symbol is not defined</emphasis>
finish <emphasis role="comment"># Finish reading the current file</emphasis>
</screen>
- <para>Here a symbol can be a
- <link linkend="variables">$variable</link>,
- <link linkend="functions"><function></link>,
- <link linkend="commands">command</link>or compile-time symbol, such as
+ <para>Here a symbol can be a
+ <link linkend="variables">$variable</link>,
+ <link linkend="functions"><function></link>,
+ <link linkend="commands">command</link>or compile-time symbol, such as
<quote>USE_IMAP</quote>.</para>
<para>
- <literal>finish</literal>is particularly useful when combined with
+ <literal>finish</literal>is particularly useful when combined with
<literal>ifndef</literal>. e.g.</para>
<screen>
<emphasis role="comment"># Sidebar config file</emphasis>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Cedric Duval
+ <para>Cedric Duval
<email>cedricduval@free.fr</email></para>
</listitem>
<listitem>
- <para>Matteo F. Vescovi
+ <para>Matteo F. Vescovi
<email>mfvescovi@gmail.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="index-color-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>index-color</quote>patch allows you to specify colors for
individual parts of the email index. e.g. Subject, Author,
Flags.</para>
<para>Note: The pattern does not have to refer to the object you wish
to color. e.g.</para>
<screen>color index_author red default "~smutt"</screen>
- <para>The author appears red when the subject (~s) contains
+ <para>The author appears red when the subject (~s) contains
<quote>mutt</quote>.</para>
</sect2>
<sect2 id="index-color-colors">
<title>Colors</title>
- <para>All the colors default to
+ <para>All the colors default to
<literal>default</literal>, i.e. unset.</para>
- <para>The index objects can be themed using the
+ <para>The index objects can be themed using the
<literal>color</literal>command. Some objects require a pattern.</para>
<screen>
color index-object foreground background
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Christian Aichinger
+ <para>Christian Aichinger
<email>Greek0@gmx.net</email></para>
</listitem>
<listitem>
- <para>Christoph
- <quote>Myon</quote>Berg
+ <para>Christoph
+ <quote>Myon</quote>Berg
<email>myon@debian.org</email></para>
</listitem>
<listitem>
- <para>Elimar Riesebieter
+ <para>Elimar Riesebieter
<email>riesebie@lxtec.de</email></para>
</listitem>
<listitem>
- <para>Eric Davis
+ <para>Eric Davis
<email>edavis@insanum.com</email></para>
</listitem>
<listitem>
- <para>Vladimir Marek
+ <para>Vladimir Marek
<email>Vladimir.Marek@oracle.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="initials-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>initials</quote>patch adds an expando (%I) for an author's
initials.</para>
<para>The index panel displays a list of emails. Its layout is
- controlled by the
+ controlled by the
<link linkend="index-format">$index_format</link>variable. Using this
expando saves space in the index panel. This can be useful if you are
regularly working with a small set of people.</para>
<sect2 id="initials-variables">
<title>Variables</title>
<para>This feature has no config of its own. It adds an expando which
- can be used in the
+ can be used in the
<link linkend="index-format">$index_format</link>variable.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Vsevolod Volkov
+ <para>Vsevolod Volkov
<email>vvv@mutt.org.ua</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<title>Introduction</title>
<para>Unify label/keyword handling.</para>
<para>Since x-labels were added to mutt in 2000, a number of other
- approaches to what we now call
+ approaches to what we now call
<quote>tagging</quote>have also emerged. One of them was even made
standard in RFC 2822. This update unifies the handling of all these
strategies.</para>
keywords from, and can rewrite those headers when saving messages for
compatibility with the mailer of origin.</para>
<para>(X-Label was specified as freeform text by mutt, its only known
- implementation. X-Labels have been used both as a
- <quote>tagging</quote>device, probably with space delimiting, and as a
+ implementation. X-Labels have been used both as a
+ <quote>tagging</quote>device, probably with space delimiting, and as a
<quote>memo</quote>field, where space-delimited parsing would ruin the
semantics of the memo. By default mutt will not split X-Labels at all.
Set $xlabel_delimiter if your needs vary.)</para>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>David Champion
+ <para>David Champion
<email>dgc@uchicago.edu</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
- <para>To check if Mutt supports Kyoto Cabinet, look for
+ <para>To check if Mutt supports Kyoto Cabinet, look for
<itemizedlist>
<listitem>
<para>
- <quote>patch-kyoto</quote>in the mutt version. See:
+ <quote>patch-kyoto</quote>in the mutt version. See:
<xref linkend="mutt-patches" />.</para>
</listitem>
<listitem>
<title>Introduction</title>
<para>This feature adds support for using Kyoto Cabinet, the successor
to Tokyo Cabinet, as a storage backend for Mutt's header cache
- (hcache). It is enabled at configure time with the
+ (hcache). It is enabled at configure time with the
<emphasis>--with-kyotocabinet=<path></emphasis>switch.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Clemens Lang
+ <para>Clemens Lang
<email>neverpanic@gmail.com</email></para>
</listitem>
</itemizedlist>
<sect2 id="limit-current-thread-intro">
<title>Introduction</title>
- <para>This feature adds a new way of using the
- <link linkend="tuning-search">Limit Command</link>. The
+ <para>This feature adds a new way of using the
+ <link linkend="tuning-search">Limit Command</link>. The
<literal><limit-current-thread></literal>function restricts the
- view to just the current thread. Setting the limit (the
- <literal>l</literal>key) to
+ view to just the current thread. Setting the limit (the
+ <literal>l</literal>key) to
<quote>all</quote>will restore the full email list.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>David Sterba
+ <para>David Sterba
<email>dsterba@suse.cz</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="lmdb-intro">
<title>Introduction</title>
<para>This feature adds support for using LMDB as a storage backend for
- Mutt's header cache (hcache). It is enabled at configure time with the
+ Mutt's header cache (hcache). It is enabled at configure time with the
<emphasis>--with-lmdb=<path></emphasis>switch.</para>
<note>
<para>It is not recommended to store the lmdb database on a shared
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Pietro Cerutti
+ <para>Pietro Cerutti
<email>gahr@gahr.ch</email></para>
</listitem>
<listitem>
- <para>Jan-Piet Mens
+ <para>Jan-Piet Mens
<email>jp@mens.de</email></para>
</listitem>
<listitem>
- <para>Clemens Lang
+ <para>Clemens Lang
<email>neverpanic@gmail.com</email></para>
</listitem>
</itemizedlist>
<title>Introduction</title>
<para>This feature allows the user to save outgoing emails in multiple
folders.</para>
- <para>Folders should be listed separated by commas,
+ <para>Folders should be listed separated by commas,
<emphasis role="bold">but no spaces</emphasis>.</para>
- <para>The
+ <para>The
<quote>fcc</quote>field of an email can be set in two ways:</para>
<itemizedlist>
<listitem>
<para>The <edit-fcc> command in the compose menu (default
- key:
+ key:
<quote>f</quote>)</para>
</listitem>
<listitem>
- <para>Creating a
- <literal>fcc-hook</literal>in your
+ <para>Creating a
+ <literal>fcc-hook</literal>in your
<literal>.muttrc</literal></para>
</listitem>
</itemizedlist>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Omen Wild
+ <para>Omen Wild
<email>omen@mandarb.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<para>Mutt's format strings can contain embedded if-then-else
conditions. They are of the form:</para>
<screen>%?VAR?TRUE&FALSE?</screen>
- <para>If the variable
- <quote>VAR</quote>has a value greater than zero, print the
- <quote>TRUE</quote>string, otherwise print the
+ <para>If the variable
+ <quote>VAR</quote>has a value greater than zero, print the
+ <quote>TRUE</quote>string, otherwise print the
<quote>FALSE</quote>string.</para>
- <para>e.g.
+ <para>e.g.
<literal>%?S?Size: %S&Empty?</literal></para>
<para>Which can be read as:</para>
<literallayout>if (%S > 0) { print "Size: %S" } else { print "Empty"
}</literallayout>
<para>These conditions are useful, but in Mutt they cannot be nested
- within one another. This feature uses the notation
+ within one another. This feature uses the notation
<literal>%<VAR?TRUE&FALSE></literal>and allows them to be
nested.</para>
- <para>The
+ <para>The
<literal>%<...></literal>notation was used to format the current
local time. but that's not really very useful since mutt has no means
of refreshing the screen periodically.</para>
<sect2 id="nested-if-variables">
<title>Variables</title>
- <para>The
+ <para>The
<quote>nested-if</quote>patch doesn't have any config of its own. It
modifies the behavior of the format strings.</para>
</sect2>
<sect2 id="nested-if-known-bugs">
<title>Known Bugs</title>
- <para>Patch overwrites $<fmt> handler in
+ <para>Patch overwrites $<fmt> handler in
<literal>$index_format</literal></para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>David Champion
+ <para>David Champion
<email>dgc@uchicago.edu</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<para>This feature enables the new_mail_command setting, which can be
used to execute a custom script (e.g., a notification handler) upon
receiving a new mail.</para>
- <para>The command string can contain expandos, such as
- <literal>%f</literal>for the folder name. For a complete list, see:
+ <para>The command string can contain expandos, such as
+ <literal>%f</literal>for the folder name. For a complete list, see:
<link linkend="status-format">$status_format</link>.</para>
<para>For example in Linux you can use (most distributions already
provide notify-send):</para>
<screen>set new_mail_command="notify-send --icon='/home/santiago/Pictures/mutt.png' 'New Email in %f' '%n new messages, %u unread.' &"</screen>
<para>And in OS X you will need to install a command line interface for
- Notification Center, for example
+ Notification Center, for example
<ulink url="https://github.com/julienXX/terminal-notifier">
terminal-notifier</ulink>:</para>
<screen>set new_mail_command="terminal-notifier -title '%v' -subtitle 'New Mail in %f' -message '%n new messages, %u unread.' -activate 'com.apple.Terminal'"</screen>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Yoshiki Vazquez-Baeza
+ <para>Yoshiki Vazquez-Baeza
<email>yoshiki@ucsd.edu</email></para>
</listitem>
<listitem>
- <para>Santiago Torres-Arias
+ <para>Santiago Torres-Arias
<email>santiago@nyu.edu</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="nntp-intro">
<title>Introduction</title>
<para>Reading news via NNTP</para>
- <para>If Mutt is compiled with the
+ <para>If Mutt is compiled with the
<emphasis>--enable-nntp</emphasis>option, it can read from a news
server using NNTP.</para>
- <para>The default news server can be obtained from the
- <literal>$NNTPSERVER</literal>environment variable or from the
+ <para>The default news server can be obtained from the
+ <literal>$NNTPSERVER</literal>environment variable or from the
<literal>/etc/nntpserver</literal>file. Like in other news readers,
information about the subscribed newsgroups is saved in the file
- specified by the
+ specified by the
<link linkend="newsrc">$newsrc</link>variable. You can open a newsgroup
- with the function
+ with the function
<literal><change-newsgroup></literal></para>
- <para>The variable
+ <para>The variable
<link linkend="news-cache-dir">$news_cache_dir</link>can be used to
point to a directory. Mutt will create a hierarchy of subdirectories
named like the account and newsgroup the cache is for. The hierarchy is
- also used to store header cache if Mutt was compiled with
+ also used to store header cache if Mutt was compiled with
<link linkend="header-caching">header cache</link>support.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Vsevolod Volkov
+ <para>Vsevolod Volkov
<email>vvv@mutt.org.ua</email></para>
</listitem>
<listitem>
- <para>Felix von Leitner
+ <para>Felix von Leitner
<email>leitner@fefe.de</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<para>Notmuch is an email fulltext indexing and tagging engine.</para>
<itemizedlist>
<listitem>
- <para>For more information, see:
+ <para>For more information, see:
<ulink url="https://notmuchmail.org/">
https://notmuchmail.org/</ulink></para>
</listitem>
<listitem>
- <para>More examples:
+ <para>More examples:
<ulink url="https://notmuchmail.org/mutttips/">
https://notmuchmail.org/mutttips/</ulink></para>
</listitem>
...]]</emphasis>
</para>
<para>The <path> is an absolute path to the directory where the
- notmuch database is found as returned by
+ notmuch database is found as returned by
<quote>notmuch config get database.path</quote>command. Note that the
- <path> should NOT include
+ <path> should NOT include
<literal>.notmuch</literal>directory name.</para>
- <para>If the "<path>" is not defined then
- <literal>$nm_default_uri</literal>or
+ <para>If the "<path>" is not defined then
+ <literal>$nm_default_uri</literal>or
<literal>$folder</literal>is used, for example:</para>
<screen>
set nm_default_uri = "notmuch:///home/foo/maildir"
</para>
<para>See SEARCH SYNTAX in notmuch man page. Don't forget to use
operators (
- <quote>and</quote>/
+ <quote>and</quote>/
<quote>or</quote>) in your queries.</para>
- <para>Note that proper URI should not contain blank space and all
+ <para>Note that proper URI should not contain blank space and all
<quote>bad</quote>chars should be encoded, for example</para>
<para>
- <literal>tag:AAA and tag:BBB</literal>--encoding->
+ <literal>tag:AAA and tag:BBB</literal>--encoding->
<literal>tag:AAA%20and%20tag:BBB</literal></para>
<para>but mutt config file parser is smart enough to accept space in
quoted strings. It means that you can use</para>
<literal>notmuch:///foo?query=tag:AAA and tag:BBB</literal>
</para>
<para>in your config files to keep things readable.</para>
- <para>For more details about Xapian queries, see:
+ <para>For more details about Xapian queries, see:
<ulink url="https://xapian.org/docs/queryparser.html">
https://xapian.org/docs/queryparser.html</ulink></para>
<para>
<sect3 id="notmuch-vfolder-format">
<title>Format String for the NotMuch Browser</title>
- <para>Default:
+ <para>Default:
<literallayout>
<literal>%2C %?n?%4n/& ?%4m %f</literal>
</literallayout></para>
<para>This variable allows you to customize the browser display to
- your personal taste. This string is similar to
+ your personal taste. This string is similar to
<link linkend="index-format">$index_format</link>, but has its own
- set of
+ set of
<literal>printf(3)</literal>-like sequences:</para>
<informaltable>
<tgroup cols="2">
<row>
<entry>%>X</entry>
<entry>right justify the rest of the string and pad with
- character
+ character
<quote>X</quote></entry>
</row>
<row>
<entry>%|X</entry>
- <entry>pad to the end of the line with character
+ <entry>pad to the end of the line with character
<quote>X</quote></entry>
</row>
<row>
<entry>%*X</entry>
- <entry>soft-fill with character
+ <entry>soft-fill with character
<quote>X</quote>as pad</entry>
</row>
</tbody>
</tgroup>
</informaltable>
- <para>For an explanation of
- <quote>soft-fill</quote>, see the
+ <para>For an explanation of
+ <quote>soft-fill</quote>, see the
<link linkend="index-format">
$index_format</link>documentation.</para>
<para>* = can be optionally printed if nonzero</para>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Karel Zak
+ <para>Karel Zak
<email>kzak@redhat.com</email></para>
</listitem>
<listitem>
- <para>Chris Mason
+ <para>Chris Mason
<email>clm@fb.com</email></para>
</listitem>
<listitem>
- <para>Christoph Rissner
+ <para>Christoph Rissner
<email>cri@visotech.at</email></para>
</listitem>
<listitem>
- <para>David Riebenbauer
+ <para>David Riebenbauer
<email>davrieb@liegesta.at</email></para>
</listitem>
<listitem>
- <para>David Sterba
+ <para>David Sterba
<email>dsterba@suse.cz</email></para>
</listitem>
<listitem>
- <para>David Wilson
+ <para>David Wilson
<email>dw@botanicus.net</email></para>
</listitem>
<listitem>
- <para>Don Zickus
+ <para>Don Zickus
<email>dzickus@redhat.com</email></para>
</listitem>
<listitem>
- <para>Eric Davis
+ <para>Eric Davis
<email>edavis@insanum.com</email></para>
</listitem>
<listitem>
- <para>Jan Synacek
+ <para>Jan Synacek
<email>jsynacek@redhat.com</email></para>
</listitem>
<listitem>
- <para>Jeremiah C. Foster
+ <para>Jeremiah C. Foster
<email>jeremiah@jeremiahfoster.com</email></para>
</listitem>
<listitem>
- <para>Josh Poimboeuf
+ <para>Josh Poimboeuf
<email>jpoimboe@redhat.com</email></para>
</listitem>
<listitem>
- <para>Kirill A. Shutemov
+ <para>Kirill A. Shutemov
<email>kirill@shutemov.name</email></para>
</listitem>
<listitem>
- <para>Luke Macken
+ <para>Luke Macken
<email>lmacken@redhat.com</email></para>
</listitem>
<listitem>
- <para>Mantas Mikulėnas
+ <para>Mantas Mikulėnas
<email>grawity@gmail.com</email></para>
</listitem>
<listitem>
- <para>Patrick Brisbin
+ <para>Patrick Brisbin
<email>pbrisbin@gmail.com</email></para>
</listitem>
<listitem>
- <para>Philippe Le Brouster
+ <para>Philippe Le Brouster
<email>plb@nebkha.net</email></para>
</listitem>
<listitem>
- <para>Raghavendra D Prabhu
+ <para>Raghavendra D Prabhu
<email>rprabhu@wnohang.net</email></para>
</listitem>
<listitem>
- <para>Sami Farin
+ <para>Sami Farin
<email>hvtaifwkbgefbaei@gmail.com</email></para>
</listitem>
<listitem>
- <para>Stefan Assmann
+ <para>Stefan Assmann
<email>sassmann@kpanic.de</email></para>
</listitem>
<listitem>
- <para>Stefan Kuhn
+ <para>Stefan Kuhn
<email>p_regius@gmx.ch</email></para>
</listitem>
<listitem>
- <para>Tim Stoakes
+ <para>Tim Stoakes
<email>tim@stoakes.net</email></para>
</listitem>
<listitem>
- <para>Vladimir Marek
+ <para>Vladimir Marek
<email>Vladimir.Marek@oracle.com</email></para>
</listitem>
<listitem>
- <para>Víctor Manuel Jáquez Leal
+ <para>Víctor Manuel Jáquez Leal
<email>vjaquez@igalia.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
<listitem>
- <para>Bernard 'Guyzmo' Pratz
+ <para>Bernard 'Guyzmo' Pratz
<email>guyzmo+github+pub@m0g.net</email></para>
</listitem>
</itemizedlist>
<sect2 id="progress-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>progress</quote>patch shows a visual progress bar on slow tasks,
such as indexing a large folder over the net.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Rocco Rutte
+ <para>Rocco Rutte
<email>pdmef@gmx.net</email></para>
</listitem>
<listitem>
- <para>Vincent Lefevre
+ <para>Vincent Lefevre
<email>vincent@vinc17.org</email></para>
</listitem>
<listitem>
- <para>Stefan Kuhn
+ <para>Stefan Kuhn
<email>wuodan@hispeed.ch</email></para>
</listitem>
<listitem>
- <para>Karel Zak
+ <para>Karel Zak
<email>kzak@redhat.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="quasi-delete-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>quasi-delete</quote>function marks an email that should be
hidden from the index, but NOT deleted.</para>
<para>On its own, this feature isn't very useful. It forms a useful
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Karel Zak
+ <para>Karel Zak
<email>kzak@redhat.com</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Pierre-Elliott Bécue
+ <para>Pierre-Elliott Bécue
<email>becue@crans.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="sensible-browser-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>sensible browser</quote>is a set of small changes to NeoMutt's
mailbox browser which make the browser behave in a more predictable
way.</para>
set sort_browser="alpha"
set sort_browser="unsorted"
</screen>
- <para>When you first start the browser, e.g.
+ <para>When you first start the browser, e.g.
<literal>c?</literal>your current mailbox will be highlighted.</para>
<para>When you navigate to a parent mailbox (
<quote>..</quote>) your old mailbox will be highlighted.</para>
set sort_browser="reverse-count"
set sort_browser="reverse-size"
</screen>
- <para>When you first start the browser, e.g.
+ <para>When you first start the browser, e.g.
<literal>c?</literal>the highlight will be on the first mailbox, e.g.
the one with the most new mail.</para>
<para>When you navigate to a parent mailbox (
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Pierre-Elliott Bécue
+ <para>Pierre-Elliott Bécue
<email>becue@crans.org</email></para>
</listitem>
<listitem>
- <para>Haakon Riiser
+ <para>Haakon Riiser
<email>haakon.riiser@fys.uio.no</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
turned on and off, it can be themed and the list style can be
configured.</para>
<para>This part of the manual is a reference guide. If you want a
- simple introduction with examples see the
+ simple introduction with examples see the
<link linkend="intro-sidebar">Sidebar Howto</link>. If you just want to
- get started, you could use the sample
+ get started, you could use the sample
<link linkend="sidebar-muttrc">Sidebar muttrc</link>.</para>
</sect2>
</tbody>
</tgroup>
</table>
- <para>For more details, and examples, about the
- <literal>$sidebar_format</literal>, see the
+ <para>For more details, and examples, about the
+ <literal>$sidebar_format</literal>, see the
<link linkend="intro-sidebar-format">Sidebar Intro</link>.</para>
</sect2>
</group>
</cmdsynopsis>
<para>This command specifies mailboxes that will always be displayed in
- the sidebar, even if
+ the sidebar, even if
<link linkend="sidebar-new-mail-only">$sidebar_new_mail_only</link>is
set and the mailbox does not contain new mail.</para>
- <para>The
+ <para>The
<quote>unsidebar_whitelist</quote>command is used to remove a mailbox
- from the list of whitelisted mailboxes. Use
+ from the list of whitelisted mailboxes. Use
<quote>unsidebar_whitelist *</quote>to remove all mailboxes.</para>
</sect2>
<entry>
<literal>sidebar_indicator</literal>
</entry>
- <entry>mutt
+ <entry>mutt
<literal>indicator</literal></entry>
<entry>The mailbox open in the Index panel</entry>
</row>
</tbody>
</tgroup>
</table>
- <para>If the
+ <para>If the
<literal>sidebar_indicator</literal>color isn't set, then the default
Mutt indicator color will be used (the color used in the index
panel).</para>
<entry>
<literal>unsorted</literal>
</entry>
- <entry>Order of the
+ <entry>Order of the
<literal>mailboxes</literal>command</entry>
</row>
</tbody>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Justin Hibbits
+ <para>Justin Hibbits
<email>jrh29@po.cwru.edu</email></para>
</listitem>
<listitem>
- <para>Thomer M. Gil
+ <para>Thomer M. Gil
<email>mutt@thomer.com</email></para>
</listitem>
<listitem>
- <para>David Sterba
+ <para>David Sterba
<email>dsterba@suse.cz</email></para>
</listitem>
<listitem>
- <para>Evgeni Golov
+ <para>Evgeni Golov
<email>evgeni@debian.org</email></para>
</listitem>
<listitem>
- <para>Fabian Groffen
+ <para>Fabian Groffen
<email>grobian@gentoo.org</email></para>
</listitem>
<listitem>
- <para>Jason DeTiberus
+ <para>Jason DeTiberus
<email>jdetiber@redhat.com</email></para>
</listitem>
<listitem>
- <para>Stefan Assmann
+ <para>Stefan Assmann
<email>sassmann@kpanic.de</email></para>
</listitem>
<listitem>
- <para>Steve Kemp
+ <para>Steve Kemp
<email>steve@steve.org.uk</email></para>
</listitem>
<listitem>
- <para>Terry Chan
+ <para>Terry Chan
<email>tchan@lunar-linux.org</email></para>
</listitem>
<listitem>
- <para>Tyler Earnest
+ <para>Tyler Earnest
<email>tylere@rne.st</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="skip-quoted-intro">
<title>Introduction</title>
- <para>When viewing an email, the
- <literal><skip-to-quoted></literal>function (by default the
+ <para>When viewing an email, the
+ <literal><skip-to-quoted></literal>function (by default the
<literal>S</literal>key) will scroll past any email headers or quoted
text. Sometimes, a little context is useful.</para>
- <para>By setting the
+ <para>By setting the
<literal>$skip_quoted_offset</literal>variable, you can select how much
of the quoted text is left visible.</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>David Sterba
+ <para>David Sterba
<email>dsterba@suse.cz</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="status-color-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>status-color</quote>patch allows you to theme different parts of
the status bar (also when it's used by the index).</para>
- <para>Unlike normal color commands,
+ <para>Unlike normal color commands,
<literal>color status</literal>can now take up to 2 extra parameters
(regex, num).</para>
</sect2>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>David Sterba
+ <para>David Sterba
<email>dsterba@suse.cz</email></para>
</listitem>
<listitem>
- <para>Thomas Glanzmann
+ <para>Thomas Glanzmann
<email>thomas@glanzmann.de</email></para>
</listitem>
<listitem>
- <para>Kirill A. Shutemov
+ <para>Kirill A. Shutemov
<email>kirill@shutemov.name</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="tls-sni-intro">
<title>Introduction</title>
- <para>The
+ <para>The
<quote>TLS-SNI</quote>patch adds support for TLS virtual hosting. If
your mail server doesn't support this everything will still work
normally.</para>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Jeremy Katz
+ <para>Jeremy Katz
<email>katzj@linuxpower.org</email></para>
</listitem>
<listitem>
- <para>Phil Pennock
+ <para>Phil Pennock
<email>mutt-dev@spodhuis.demon.nl</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
<sect2 id="trash-folder-intro">
<title>Introduction</title>
- <para>In Mutt, when you
+ <para>In Mutt, when you
<quote>delete</quote>an email it is first marked deleted. The email
- isn't really gone until
+ isn't really gone until
<link linkend="index-map"><sync-mailbox></link>is called. This
happens when the user leaves the folder, or the function is called
manually.</para>
- <para>After
+ <para>After
<literal><sync-mailbox></literal>has been called the email is
gone forever.</para>
- <para>The
+ <para>The
<link linkend="trash">$trash</link>variable defines a folder in which
to keep old emails. As before, first you mark emails for deletion. When
<sync-mailbox> is called the emails are moved to the trash
folder.</para>
- <para>The
+ <para>The
<literal>$trash</literal>path can be either a full directory, or be
- relative to the
- <link linkend="folder">$folder</link>variable, like the
+ relative to the
+ <link linkend="folder">$folder</link>variable, like the
<literal>mailboxes</literal>command.</para>
<note>
<para>Emails deleted from the trash folder are gone forever.</para>
<title>Credits</title>
<itemizedlist>
<listitem>
- <para>Cedric Duval
+ <para>Cedric Duval
<email>cedricduval@free.fr</email></para>
</listitem>
<listitem>
- <para>Benjamin Kuperman
+ <para>Benjamin Kuperman
<email>kuperman@acm.org</email></para>
</listitem>
<listitem>
- <para>Paul Miller
+ <para>Paul Miller
<email>paul@voltar.org</email></para>
</listitem>
<listitem>
- <para>Richard Russon
+ <para>Richard Russon
<email>rich@flatcap.org</email></para>
</listitem>
</itemizedlist>
digital signatures, etc. As long as being used, these files are visible
by other users and maybe even readable in case of misconfiguration. Also,
a different location for these files may be desired which can be changed
- via the
+ via the
<link linkend="tmpdir">$tmpdir</link>variable.</para>
</sect1>
<sect2 id="security-leaks-mid">
<title>Message-Id: headers</title>
<para>Message-Id: headers contain a local part that is to be created in
- a unique fashion. In order to do so, Mutt will
+ a unique fashion. In order to do so, Mutt will
<quote>leak</quote>some information to the outside world when sending
messages: the generation of this header includes a step counter which
is increased (and rotated) with every message sent. In a longer running
mutt session, others can make assumptions about your mailing habits
depending on the number of messages sent. If this is not desired, the
- header can be manually provided using
+ header can be manually provided using
<link linkend="edit-headers">$edit_headers</link>(though not
recommended).</para>
</sect2>
<sect2 id="security-leaks-mailto">
<title>
<literal>mailto:</literal>-style Links</title>
- <para>As Mutt be can be set up to be the mail client to handle
+ <para>As Mutt be can be set up to be the mail client to handle
<literal>mailto:</literal>style links in websites, there're security
considerations, too. Arbitrary header fields can be embedded in these
links which could override existing header fields or attach arbitrary
- files using
+ files using
<link linkend="attach-header">the Attach: pseudoheader</link>. This may
- be problematic if the
- <link linkend="edit-headers">$edit-headers</link>variable is
+ be problematic if the
+ <link linkend="edit-headers">$edit-headers</link>variable is
<emphasis>unset</emphasis>, i.e. the user doesn't want to see header
fields while editing the message and doesn't pay enough attention to
the compose menu's listing of attachments.</para>
<para>For example, following a link like</para>
<screen>mailto:joe@host?Attach=~/.gnupg/secring.gpg</screen>
- <para>will send out the user's private gnupg keyring to
+ <para>will send out the user's private gnupg keyring to
<literal>joe@host</literal>if the user doesn't follow the information
on screen carefully enough.</para>
- <para>To prevent these issues, Mutt by default only accepts the
- <literal>Subject</literal>and
+ <para>To prevent these issues, Mutt by default only accepts the
+ <literal>Subject</literal>and
<literal>Body</literal>headers. Allowed headers can be adjusted with
- the
+ the
<link linkend="mailto-allow">
<command>mailto_allow</command>
- </link>and
+ </link>and
<link linkend="mailto-allow">
<command>unmailto_allow</command>
</link>commands.</para>
<title>External Applications</title>
<para>Mutt in many places has to rely on external applications or for
convenience supports mechanisms involving external applications.</para>
- <para>One of these is the
+ <para>One of these is the
<literal>mailcap</literal>mechanism as defined by RfC1524. Details about
- a secure use of the mailcap mechanisms is given in
+ a secure use of the mailcap mechanisms is given in
<xref linkend="secure-mailcap" />.</para>
<para>Besides the mailcap mechanism, Mutt uses a number of other external
utilities for operation, for example to provide crypto support, in
<listitem>
<para>For remote folders (IMAP and POP) as well as folders using
one-file-per message storage (Maildir and MH), Mutt's performance can
- be greatly improved using
+ be greatly improved using
<link linkend="header-caching">header caching</link>. using a single
database per folder.</para>
</listitem>
<listitem>
- <para>Mutt provides the
- <link linkend="read-inc">$read_inc</link>and
+ <para>Mutt provides the
+ <link linkend="read-inc">$read_inc</link>and
<link linkend="write-inc">$write_inc</link>variables to specify at
which rate to update progress counters. If these values are too low,
Mutt may spend more time on updating the progress counter than it
spends on actually reading/writing folders.</para>
<para>For example, when opening a maildir folder with a few thousand
- messages, the default value for
+ messages, the default value for
<link linkend="read-inc">$read_inc</link>may be too low. It can be
- tuned on on a folder-basis using
+ tuned on on a folder-basis using
<link linkend="folder-hook">
<command>folder-hook</command>s</link>:</para>
<screen>
others, even per-folder settings of the increment variables may not be
desirable as they produce either too few or too much progress updates.
Thus, Mutt allows to limit the number of progress updates per second
- it'll actually send to the terminal using the
+ it'll actually send to the terminal using the
<link linkend="time-inc">$time_inc</link>variable.</para>
</sect1>
number of recently viewed messages (usually 10) per session (so that it
will be gone for the next session.)</para>
<para>To improve performance and permanently cache whole messages, please
- refer to Mutt's so-called
+ refer to Mutt's so-called
<link linkend="body-caching">body caching</link>for details.</para>
</sect1>
<title>Searching and Limiting</title>
<para>When searching mailboxes either via a search or a limit action, for
some patterns Mutt distinguishes between regular expression and string
- searches. For regular expressions, patterns are prefixed with
- <quote>~</quote>and with
+ searches. For regular expressions, patterns are prefixed with
+ <quote>~</quote>and with
<quote>=</quote>for string searches.</para>
<para>Even though a regular expression search is fast, it's several times
slower than a pure string search which is noticeable especially on large
search pattern.</para>
<para>For example, when limiting a large folder to all messages sent to
or by an author, it's much faster to search for the initial part of an
- e-mail address via
- <literal>=Luser@</literal>instead of
+ e-mail address via
+ <literal>=Luser@</literal>instead of
<literal>~Luser@</literal>. This is especially true for searching message
bodies since a larger amount of input has to be searched.</para>
<para>As for regular expressions, a lower case string search pattern
<sect1 id="commandline">
<title>Command-Line Options</title>
- <para>Running
+ <para>Running
<literal>mutt</literal>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.</para>
</row>
<row>
<entry>-y</entry>
- <entry>show a menu containing the files specified by the
+ <entry>show a menu containing the files specified by the
<command>mailboxes</command>command</entry>
</row>
<row>
</arg>
</group>
</cmdsynopsis>
- <para>Mutt also supports a
+ <para>Mutt also supports a
<quote>batch</quote>mode to send prepared messages. Simply redirect input
from the file you wish to send. For example,</para>
<screen>mutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat</screen>
- <para>will send a message to
- <literal><professor@bigschool.edu></literal>with a subject of
+ <para>will send a message to
+ <literal><professor@bigschool.edu></literal>with a subject of
<quote>data set for run #2</quote>. In the body of the message will be
- the contents of the file
+ the contents of the file
<quote>~/run2.dat</quote>.</para>
- <para>An include file passed with
+ <para>An include file passed with
<literal>-i</literal>will be used as the body of the message. When
- combined with
+ combined with
<literal>-E</literal>, the include file will be directly edited during
message composition. The file will be modified regardless of whether the
message is sent or aborted.</para>
- <para>A draft file passed with
+ <para>A draft file passed with
<literal>-H</literal>will be used as the initial header and body for the
message. Multipart messages can be used as a draft file. When combined
- with
+ with
<literal>-E</literal>, the draft file will be updated to the final state
of the message after composition, regardless of whether the message is
sent, aborted, or even postponed. Note that if the message is sent
encrypted or signed, the draft file will be saved that way too.</para>
- <para>All files passed with
+ <para>All files passed with
<literal>-a</literal>
<emphasis>file</emphasis>will be attached as a MIME part to the message.
- To attach a single or several files, use
+ To attach a single or several files, use
<quote>--</quote>to separate files and recipient addresses:</para>
<screen>mutt -a image.png -- some@one.org</screen>
<para>or</para>
<screen>mutt -a *.png -- some@one.org</screen>
<note>
- <para>The
+ <para>The
<literal>-a</literal>option must be last in the option list.</para>
</note>
<para>In addition to accepting a list of email addresses, Mutt also
- accepts a URL with the
+ accepts a URL with the
<literal>mailto:</literal>schema as specified in RFC2368. This is useful
when configuring a web browser to launch Mutt when clicking on mailto
links.</para>
projects / neomutt / commitdiff