<abstract>
<para>
-<quote>All mail clients suck. This one just sucks less.</quote> — me, circa 1995
+<quote>All mail clients suck. This one just sucks less.</quote> —
+me, circa 1995
</para>
</abstract>
</bookinfo>
<title>Introduction</title>
<para>
-<emphasis role="bold">Mutt</emphasis> is a small but very powerful text-based MIME mail client. Mutt is
-highly configurable, and is well suited to the mail power user with advanced
-features like key bindings, keyboard macros, mail threading, regular
-expression searches and a powerful pattern matching language for selecting
-groups of messages.
+<emphasis role="bold">Mutt</emphasis> is a small but very powerful
+text-based MIME mail client. Mutt is highly configurable, and is well
+suited to the mail power user with advanced features like key bindings,
+keyboard macros, mail threading, regular expression searches and a
+powerful pattern matching language for selecting groups of messages.
</para>
<sect1 id="homepage">
<title>Mailing Lists</title>
<para>
-To subscribe to one of the following mailing lists, send a message with the
-word <emphasis>subscribe</emphasis> in the body to
+To subscribe to one of the following mailing lists, send a message with
+the word <emphasis>subscribe</emphasis> in the body to
<literal>list-name</literal><emphasis>-request</emphasis><literal>@mutt.org</literal>.
</para>
<listitem>
<para>
-<email>mutt-announce-request@mutt.org</email> -- low traffic list for announcements
+<email>mutt-announce-request@mutt.org</email> — low traffic list for
+announcements
</para>
</listitem>
<listitem>
<para>
-<email>mutt-users-request@mutt.org</email> -- help, bug reports and feature requests
+<email>mutt-users-request@mutt.org</email> — help, bug reports and
+feature requests
</para>
</listitem>
<listitem>
<para>
-<email>mutt-dev-request@mutt.org</email> -- development mailing list
+<email>mutt-dev-request@mutt.org</email> — development mailing list
</para>
</listitem>
<title>Getting Mutt</title>
<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
-<ulink url="http://www.mutt.org/download.html">http://www.mutt.org/download.html</ulink>.
+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 <ulink
+url="http://www.mutt.org/download.html">http://www.mutt.org/download.html</ulink>.
</para>
<para>
</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 by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+This program is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version.
</para>
<para>
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
</para>
<para>
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</para>
</sect1>
<title>Getting Started</title>
<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 <ulink url="http://www.mutt.org/">Mutt homepage</ulink> for more details.
+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 <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 <quote>?</quote> in any menu to display the current bindings.
+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 <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 <literal>mutt</literal>
-at the command line. There are various command-line options, see
-either the Mutt man page or the <link linkend="commandline">reference</link>.
+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 <link
+linkend="commandline">reference</link>.
</para>
<sect1 id="core-concepts">
<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 <quote>index</quote> menu (listing all messages of
-the currently opened 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 <quote>help</quote> menu listing
-all available key bindings.
+line-based menu is the so-called <quote>index</quote> menu (listing all
+messages of the currently opened 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 <quote>help</quote> menu listing all available key
+bindings.
</para>
<para>
<para>
Because Mutt allows for customizing almost all key bindings, there 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.
+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
-<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 <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.
+<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
+<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 <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. These hooks can be used to highly customize Mutt's
+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. These hooks can be used to highly customize Mutt's
behaviour including managing multiple identities, customizing the
display for a folder or even implementing auto-archiving based on a
per-folder basis and much more.
<para>
The most important navigation keys common to line- or entry-based menus
-are shown in <xref linkend="tab-keys-nav-line"/> and in
-<xref linkend="tab-keys-nav-page"/> for page-based 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 <xref linkend="tab-keys-editor"/> for a full
-reference of available functions, their default key bindings, and
-short descriptions.
+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 <xref linkend="tab-keys-editor"/> for a full
+reference of available functions, their default key bindings, and short
+descriptions.
</para>
<table id="tab-keys-editor">
</table>
<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 character in front of
-the cursor rather than under, you could use:
+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 character in front of the cursor
+rather than under, you could use:
</para>
<screen>
<para>
Mutt maintains a history for the built-in editor. The number of items
-is controlled by the <link linkend="history">$history</link>
-variable and can be made 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
-<literal><history-down></literal> commands. But notice that Mutt
-does not remember the currently entered text, it only cycles through
-history and wraps around at the end or beginning.
+is controlled by the <link linkend="history">$history</link> variable
+and can be made 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 <literal><history-down></literal> commands. But notice that
+Mutt does not remember the currently entered text, it only cycles
+through history and wraps around at the end or beginning.
</para>
<para>
</itemizedlist>
<para>
-Mutt automatically filters out consecutively repeated items from the history. It
-also mimics the behavior of some shells by ignoring items starting
-with a space. The latter feature can be useful in macros to not clobber
-the history's valuable entries with unwanted entries.
+Mutt automatically filters out consecutively repeated items from the
+history. It also mimics the behavior of some shells by ignoring items
+starting with a space. The latter feature can be useful in macros to not
+clobber the history's valuable entries with unwanted entries.
</para>
</sect2>
<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 <quote>index</quote> menu in Mutt. The second mode is the display of the
-message contents. This is called the <quote>pager.</quote>
+called the <quote>index</quote> menu in Mutt. The second mode is the
+display of the message contents. This is called the
+<quote>pager.</quote>
</para>
<para>
<para>
Common keys used to navigate through and manage messages in the index
are shown in <xref linkend="tab-key-index"/>. How messages are presented
-in the index menu can be customized using the
-<link linkend="index-format">$index_format</link> variable.
+in the index menu can be customized using the <link
+linkend="index-format">$index_format</link> variable.
</para>
<table id="tab-key-index">
<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 <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 <quote>W</quote> respectively.
+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 <quote>W</quote> respectively.
</para>
<para>
Furthermore, the flags in <xref linkend="tab-msg-recip-flags"/> reflect
-who the message is addressed to. They can be customized with the
-<link linkend="to-chars">$to_chars</link> variable.
+who the message is addressed to. They can be customized with the <link
+linkend="to-chars">$to_chars</link> variable.
</para>
<table id="tab-msg-status-flags">
<para>
By default, Mutt uses its builtin pager to display the contents 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 <literal>less(1)</literal>
+configured, see <link linkend="pager">$pager</link> variable). The
+pager is very similar to the Unix program <literal>less(1)</literal>
though not nearly as featureful.
</para>
</table>
<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 <literal><copy-message></literal>
-(this is one advantage over using an external pager to view messages).
+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
+<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 <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>_</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 <command>color</command> or mono attribute for them.
+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>_</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
+<command>color</command> or mono attribute for them.
</para>
<para>
</screen>
<para>
-where <emphasis>Ps</emphasis> can be one of the codes shown in
-<xref linkend="tab-ansi-esc"/>.
+where <emphasis>Ps</emphasis> can be one of the codes shown in <xref
+linkend="tab-ansi-esc"/>.
</para>
<table id="tab-ansi-esc">
<para>
Mutt uses these attributes for handling <literal>text/enriched</literal>
-messages, and they can also be used by an external
-<link linkend="auto-view">autoview</link> script for highlighting
-purposes.
+messages, and they can also be used by an external <link
+linkend="auto-view">autoview</link> script for highlighting purposes.
</para>
<note>
<para>
-If you change the colors for your
-display, for example by changing the color associated with color2 for
-your xterm, then that color will be used instead of green.
+If you change the colors for your display, for example by changing the
+color associated with color2 for your xterm, then that color will be
+used instead of green.
</para>
</note>
<note>
<para>
Note that the search commands in the pager take regular 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 message.
+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 message.
</para>
</note>
</table>
<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 <link linkend="index-format">$index_format</link>.
-For example, you 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 <literal>%?<char>?<if-part>&<else-part>?</literal>
-syntax is explained in detail in
-<link linkend="formatstrings-conditionals">format string conditionals</link>.
+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
+<link linkend="index-format">$index_format</link>. For example, you
+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
+<literal>%?<char>?<if-part>&<else-part>?</literal>
+syntax 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
-<link linkend="strict-threads">$strict_threads</link> variable.
+subject which can be controlled using the <link
+linkend="strict-threads">$strict_threads</link> variable.
</para>
</sect2>
<title>Miscellaneous Functions</title>
<para>
-In addition, the <emphasis>index</emphasis> and <emphasis>pager</emphasis>
-menus have these interesting functions:
+In addition, the <emphasis>index</emphasis> and
+<emphasis>pager</emphasis> menus have these interesting functions:
</para>
<variablelist>
<varlistentry>
<term>
-<literal><create-alias></literal><anchor id="create-alias"/> (default: a)
+<literal><create-alias></literal><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 <link linkend="alias"><command>alias</command></link>
-command is added to the file specified by
-the <link linkend="alias-file">$alias_file</link> variable
-for future use
+Creates a new alias based upon the current message (or 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 linkend="alias-file">$alias_file</link>
+variable for future use
</para>
<note>
<para>
Mutt does not read the <link linkend="alias-file">$alias_file</link>
-upon startup so you must explicitly <link linkend="source"><command>source</command></link> the file.
+upon startup so you must explicitly <link
+linkend="source"><command>source</command></link> the file.
</para>
</note>
</listitem>
<varlistentry>
<term>
-<literal><check-traditional-pgp></literal><anchor id="check-traditional-pgp"/> (default: Esc P)
+<literal><check-traditional-pgp></literal><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 <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 <link linkend="edit-type"><literal><edit-type></literal></link> function's
-effect.
+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 <link
+linkend="edit-type"><literal><edit-type></literal></link>
+function's effect.
</para>
</listitem>
</varlistentry>
</term>
<listitem>
<para>
-This command (available in the index and pager) allows you to
-edit the raw current message as it's present in the mail folder.
-After you have finished editing, the changed message will be
-appended to the current folder, and the original message will be
-marked for deletion; if the message is unchanged it won't be replaced.
+This command (available in the index and pager) allows you to edit the
+raw current message as it's present in the mail folder. After you have
+finished editing, the changed message will be appended to the current
+folder, and the original message will be marked for deletion; if the
+message is unchanged it won't be replaced.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal><edit-type></literal><anchor id="edit-type"/> (default:
-^E on the attachment menu, and in the pager and index menus;
-^T on the compose menu)
+^E on the attachment menu, and in the pager and index menus; ^T on the
+compose menu)
</term>
<listitem>
<para>
-This command is used to temporarily edit an attachment's 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
-<link linkend="attach-menu">attachment menu</link>, you can change any
+This command is used to temporarily edit an attachment's 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 <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 <link linkend="compose-menu">compose
-menu</link>. There, it's used to fine-tune the properties of attachments you are going
-to send.
+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>
</listitem>
</varlistentry>
<varlistentry>
<term>
-<literal><enter-command></literal><anchor id="enter-command"/> (default: <quote>:</quote>)
+<literal><enter-command></literal><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 <link linkend="macro">macros</link> to change settings on the
-fly.
+configuration file. A common use is to check the settings of variables,
+or in conjunction with <link linkend="macro">macros</link> to change
+settings on the fly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-<literal><extract-keys></literal><anchor id="extract-keys"/> (default: ^K)
+<literal><extract-keys></literal><anchor id="extract-keys"/>
+(default: ^K)
</term>
<listitem>
<para>
<varlistentry>
<term>
-<literal><forget-passphrase></literal><anchor id="forget-passphrase"/> (default:
-^F)
+<literal><forget-passphrase></literal><anchor
+id="forget-passphrase"/> (default: ^F)
</term>
<listitem>
<para>
-This command wipes the passphrase(s) from memory. It is useful, if
-you misspelled the passphrase.
+This command wipes the passphrase(s) from memory. It is useful, if you
+misspelled the passphrase.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-<literal><list-reply></literal><anchor id="list-reply"/> (default: L)
+<literal><list-reply></literal><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 <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
-<link linkend="honor-followup-to">$honor_followup_to</link>
-configuration variable is set. Using this when replying to messages posted
-to mailing lists helps avoid duplicate copies being sent to the author of
-the message you are replying to.
+Reply to the current or tagged message(s) by extracting any 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 <link
+linkend="honor-followup-to">$honor_followup_to</link> configuration
+variable is set. Using this when replying to messages posted to mailing
+lists helps avoid duplicate copies being sent to the author of the
+message you are replying to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-<literal><pipe-message></literal><anchor id="pipe-message"/> (default: |)
+<literal><pipe-message></literal><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 <link linkend="wait-key">$wait_key</link> control the exact behavior of this function.
+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 <link
+linkend="wait-key">$wait_key</link> control the exact behavior of this
+function.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-<literal><resend-message></literal><anchor id="resend-message"/> (default: Esc e)
+<literal><resend-message></literal><anchor id="resend-message"/>
+(default: Esc e)
</term>
<listitem>
<para>
-Mutt takes the current message as a template for a
-new 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 <link linkend="weed">$weed</link>
-variable.
+Mutt takes the current message as a template for a new 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 <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
+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 <literal>message/rfc822</literal> body part.
</para>
</listitem>
<varlistentry>
<term>
-<literal><shell-escape></literal><anchor id="shell-escape"/> (default: !)
+<literal><shell-escape></literal><anchor id="shell-escape"/>
+(default: !)
</term>
<listitem>
<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 command), based on
-the return status of the named command. If no command is given, an
-interactive shell is executed.
+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 command), based on the return
+status of the named command. If no command is given, an interactive
+shell is executed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-<literal><toggle-quoted></literal><anchor id="toggle-quoted"/> (default: T)
+<literal><toggle-quoted></literal><anchor id="toggle-quoted"/>
+(default: T)
</term>
<listitem>
<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 message. It is particularly useful when
-being interested in just the response and there is a large amount of
-quoted text in the way.
+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 message.
+It is particularly useful when being interested in just the response and
+there is a large amount of quoted text in the way.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
-<literal><skip-quoted></literal><anchor id="skip-quoted"/> (default: S)
+<literal><skip-quoted></literal><anchor id="skip-quoted"/>
+(default: S)
</term>
<listitem>
<para>
<title>Introduction</title>
<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.
+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. <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 <quote><link linkend="forwarding-mail">Forwarding
-and Bouncing Mail</link>.</quote>
+<emphasis>Bouncing</emphasis> a message sends the message as-is to the
+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 <quote><link
+linkend="forwarding-mail">Forwarding and Bouncing Mail</link>.</quote>
</para>
<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 <literal>m</literal> to start a new message. Next, it will ask
-you for 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 <link linkend="include">$include</link>
-for changing how and if Mutt asks these questions.
+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 <literal>m</literal> to start a new message. Next, it will
+ask you for 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 <link
+linkend="include">$include</link> for changing how and if Mutt asks
+these questions.
</para>
<para>
<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 <link
-linkend="edit-headers">$edit_headers</link> variable is
-set, the headers will be at the top of the message in your editor. 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
-<link
-linkend="post-indent-string">$post_indent_string</link>.
-When 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 <link linkend="signature">$signature</link>, it will
-be appended to the message.
+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. 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 <link
+linkend="post-indent-string">$post_indent_string</link>. When
+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 <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 <xref linkend="tab-func-compose"/> to modify, send or postpone the
-message.
+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>
<table id="tab-func-compose">
</table>
<para>
-The compose menu is also used to edit the attachments for a 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.
+The compose menu is also used to edit the attachments for a 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 <quote>A</quote> to indicate that you are in attach-message mode.
+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
+<quote>A</quote> to indicate that you are in attach-message mode.
</para>
</note>
<title>Editing the Message Header</title>
<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.
+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>
<sect3 id="fcc-header">
</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 <emphasis>compose</emphasis> menu.
-It can later be changed from the compose menu.
+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>
<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 (<quote>\</quote>).
-The file can be removed as well as more added from the compose menu.
+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 (<quote>\</quote>). The file can be removed as well as
+more added from the compose menu.
</para>
</sect3>
</para>
<para>
-<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.
+<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>
<title>In-Reply-To: Header</title>
<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
-<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.
+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
+<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>
</sect3>
<title>Sending Cryptographically Signed/Encrypted Messages</title>
<para>
-If you have told Mutt to PGP or S/MIME encrypt a message, it will guide you
-through a key selection process when you try to send the message.
-Mutt will not ask you any questions about keys which have a
-certified user ID matching one of the message recipients' mail
-addresses. However, there may be situations in which there are
-several keys, weakly certified user ID fields, or where no matching
-keys can be found.
+If you have told Mutt to PGP or S/MIME encrypt a message, it will guide
+you through a key selection process when you try to send the message.
+Mutt will not ask you any questions about keys which have a certified
+user ID matching one of the message recipients' mail addresses.
+However, there may be situations in which there are several keys, weakly
+certified user ID fields, or where no matching keys can be found.
</para>
<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 <literal>^G</literal>. When you do so, Mutt will
-return to the compose screen.
+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 <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.
+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 <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.
+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
-<xref linkend="tab-pgp-menuflags"/>.
+The flags sequence (<quote>%f</quote>) will expand to one of the flags
+in <xref linkend="tab-pgp-menuflags"/>.
</para>
<table id="tab-pgp-menuflags">
</table>
<para>
-The capabilities field (<quote>%c</quote>) expands to a two-character sequence
-representing a key's capabilities. The first character gives
+The capabilities field (<quote>%c</quote>) expands to a two-character
+sequence representing a key's capabilities. The first character gives
the key's encryption capabilities: A minus sign (<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 <quote>e</quote> indicates that
-this key can be used for encryption.
+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 <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>, <quote>.</quote> implies
-that the key is marked as an encryption key in one of the user-ids, and
-<quote>s</quote> denotes a key which can be used for signing.
+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 <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 question mark (<quote>?</quote>) indicates undefined validity, a minus
-character (<quote>-</quote>) marks an untrusted association, a space character
-means a partially trusted association, and a plus character (<quote>+</quote>)
-indicates complete validity.
+Finally, the validity field (<quote>%t</quote>) indicates how
+well-certified a user-id is. A question mark (<quote>?</quote>)
+indicates undefined validity, a minus character (<quote>-</quote>) marks
+an untrusted association, a space character means a partially trusted
+association, and a plus character (<quote>+</quote>) indicates complete
+validity.
</para>
</sect2>
<title>Concept</title>
<para>
-<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 <quote>flowable</quote> paragraph end in spaces
+<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 <quote>flowable</quote> paragraph end in spaces
except for the last line.
</para>
<para>
Mutt only supports setting the required <literal>format=flowed</literal>
MIME parameter on outgoing messages if the <link
-linkend="text-flowed">$text_flowed</link>
-variable is set, specifically it does not add the
-trailing spaces.
+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-stuffes the message.
+After editing the initial message text and before entering the compose
+menu, Mutt properly space-stuffes the message.
<emphasis>Space-stuffing</emphasis> is required by RfC3676 defining
<literal>format=flowed</literal> and means to prepend a space to:
</para>
<itemizedlist>
<listitem><para>all lines starting with a space</para></listitem>
-<listitem><para>lines starting with the word <quote><literal>From</literal></quote>
-followed by space</para></listitem>
-<listitem><para>all lines starting with <quote><literal>></literal></quote> which
-is not intended to be a quote character</para></listitem>
+<listitem><para>lines starting with the word
+<quote><literal>From</literal></quote> followed by
+space</para></listitem>
+<listitem><para>all lines starting with
+<quote><literal>></literal></quote> which is not intended to be a
+quote character</para></listitem>
</itemizedlist>
<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 <literal>></literal> character starts a
-quote or not. Furthermore, Mutt only applies space-stuffing
-<emphasis>once</emphasis> after the initial edit is finished.
+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
+<literal>></literal> character starts a quote or not. 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 restore
-the original message prior to further processing.
+All leading spaces are to be removed by receiving clients to restore the
+original message prior to further processing.
</para>
</sect3>
<title>Editor Considerations</title>
<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 <literal>f=f</literal> messages.
+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 <literal>f=f</literal> messages.
</para>
<para>
Bouncing and forwarding let you send an existing message to recipients
that you specify. Bouncing a message sends a verbatim copy of 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 <quote>f</quote>
-respectively.
+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 <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 <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 <link linkend="mime-forward-decode">$mime_forward_decode</link> variables,
+message's body (surrounded by indicating lines) or including it as a
+MIME 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 <link
+linkend="mime-forward-decode">$mime_forward_decode</link> variables,
respectively. The desired forwarding format may depend on the content,
-therefore <link linkend="mime-forward">$mime_forward</link> is a quadoption which, for
-example, can be set to <quote>ask-no</quote>.
+therefore <link linkend="mime-forward">$mime_forward</link> is a
+quadoption which, 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 <link linkend="mime-forward">$mime_forward</link> is set.
+<link linkend="weed">$weed</link> variable, unless <link
+linkend="mime-forward">$mime_forward</link> is set.
</para>
<para>
<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 <emphasis>compose</emphasis> menu, the body of your message and 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.
+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 <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 <emphasis>pager</emphasis> you will be prompted if postponed
-messages 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.
+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
+<emphasis>pager</emphasis> you will be prompted if postponed messages
+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>
<para>
-If you postpone a reply to a message, the reply setting of
-the message is only updated when you actually finish the message and
-send it. Also, you must be in the same folder with the message you
-replied to for the status of the message to be updated.
+If you postpone a reply to a message, the reply setting of the message
+is only updated when you actually finish the message and send 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>
<title>Location of Initialization Files</title>
<para>
-While the default configuration (or <quote>preferences</quote>) make Mutt
-usable right out of the box, it is often desirable to tailor Mutt to
-suit your own tastes. When Mutt is first invoked, it will attempt to
-read the <quote>system</quote> configuration file (defaults set by your local
-system administrator), unless the <quote>-n</quote> <link linkend="commandline">command line</link> option is specified. This file is typically
-<literal>/usr/local/share/mutt/Muttrc</literal> or <literal>/etc/Muttrc</literal>. Mutt
-will next look for a file named <literal>.muttrc</literal> in your home
-directory. If this file does not exist and your home directory has
-a subdirectory named <literal>.mutt</literal>, Mutt tries to load a file named
+While the default configuration (or <quote>preferences</quote>) make
+Mutt usable right out of the box, it is often desirable to tailor Mutt
+to suit your own tastes. When Mutt is first invoked, it will attempt to
+read the <quote>system</quote> configuration file (defaults set by your
+local system administrator), unless the <quote>-n</quote> <link
+linkend="commandline">command line</link> option is specified. This
+file is typically <literal>/usr/local/share/mutt/Muttrc</literal> or
+<literal>/etc/Muttrc</literal>. Mutt will next look for a file named
+<literal>.muttrc</literal> in your home directory. If this file does
+not exist and your home directory has a subdirectory named
+<literal>.mutt</literal>, Mutt tries to load a file named
<literal>.mutt/muttrc</literal>.
</para>
<para>
-<literal>.muttrc</literal> is the file where you will usually place your <link linkend="commands">commands</link> to configure Mutt.
+<literal>.muttrc</literal> is the file where you will usually place your
+<link linkend="commands">commands</link> to configure Mutt.
</para>
<para>
In addition, Mutt supports version specific configuration files that are
-parsed instead of the default files as explained above. For instance, if
-your system has a <literal>Muttrc-0.88</literal> file in the system configuration
-directory, and you are running version 0.88 of Mutt, this file will be
-sourced instead of the <literal>Muttrc</literal> file. The same is true of the user
-configuration file, if you have a file <literal>.muttrc-0.88.6</literal> in your home
-directory, when you run Mutt version 0.88.6, it will source this file
-instead of the default <literal>.muttrc</literal> file. The version number is the
-same which is visible using the <quote>-v</quote> <link linkend="commandline">command line</link> switch or using the <literal>show-version</literal> key (default:
-V) from the index menu.
+parsed instead of the default files as explained above. For instance,
+if your system has a <literal>Muttrc-0.88</literal> file in the system
+configuration directory, and you are running version 0.88 of Mutt, this
+file will be sourced instead of the <literal>Muttrc</literal> file. The
+same is true of the user configuration file, if you have a file
+<literal>.muttrc-0.88.6</literal> in your home directory, when you run
+Mutt version 0.88.6, it will source this file instead of the default
+<literal>.muttrc</literal> file. The version number is the same which
+is visible using the <quote>-v</quote> <link
+linkend="commandline">command line</link> switch or using the
+<literal>show-version</literal> key (default: V) from the index menu.
</para>
</sect1>
<title>Syntax of Initialization Files</title>
<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
-(<quote>;</quote>).
+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 (<quote>;</quote>).
</para>
<example id="ex-rc-multiple-cmds">
</example>
<para>
-The hash mark, or pound sign
-(<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.
+The hash mark, or pound sign (<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">
</example>
<para>
-Single quotes (<quote>'</quote>) and double quotes (<quote>"</quote>) can be used to quote strings
-which contain spaces or other special characters. The difference between
-the two types of quotes is similar to that of many popular shell programs,
-namely that a single 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 <emphasis>not</emphasis> for single quotes.
+Single quotes (<quote>'</quote>) and double quotes (<quote>"</quote>)
+can be used to quote strings which contain spaces or other special
+characters. The difference between the two types of quotes is similar
+to that of many popular shell programs, namely that a single 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
+<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
-<quote>\</quote> to force the next character to be a literal instead of interpreted
-character.
+<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 <quote>\</quote> to force the next
+character to be a literal instead of interpreted character.
</para>
<example id="ex-rc-quote">
</para>
<para>
-A <quote>\</quote> at the end of a line can be used to split commands over
-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 out
-the first line only.
+A <quote>\</quote> at the end of a line can be used to split commands
+over 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 out the first line only.
</para>
<example id="ex-rc-split">
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 <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.
+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>
<example id="ex-rc-backtick">
<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.)
+<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.
+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 <link linkend="commands">command reference</link>.
+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 <link linkend="charset">$charset</link> variable
-which doesn't have a default value since it's determined by Mutt at startup.
+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
-<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 <link linkend="charset">$charset</link>.
+<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 <link
+linkend="charset">$charset</link>.
</para>
<para>
-This mechanism should be avoided if possible as it has the
-following implications:
+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
-<link linkend="config-charset">$config_charset</link> so Mutt
-knows what character set to convert to.</para></listitem>
-
-<listitem><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 <emphasis>not</emphasis>
-per configuration file.</para></listitem>
-
-<listitem><para>Because Mutt first recodes a line before it attempts to parse it,
-a conversion introducing question marks or other characters as
-part of errors (unconvertable characters, transliteration) may introduce syntax
-errors or silently change the meaning of certain tokens (e.g. inserting
-question marks into regular expressions).</para></listitem>
+file 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 <link linkend="config-charset">$config_charset</link>
+is set, it should be set in each configuration file because the value is
+global and <emphasis>not</emphasis> per configuration
+file.</para></listitem>
+
+<listitem><para>Because Mutt first recodes a line before it attempts to
+parse it, a conversion introducing question marks or other characters as
+part of errors (unconvertable characters, transliteration) may introduce
+syntax errors or silently change the meaning of certain tokens
+(e.g. inserting question marks into regular
+expressions).</para></listitem>
</itemizedlist>
</para>
<para>
-These address groups can also be created implicitly by the
-<link linkend="alias"><command>alias</command></link>, <link linkend="lists">lists</link>,
-<link linkend="lists">subscribe</link> and
-<link linkend="alternates"><command>alternates</command></link> commands by specifying the
-optional <literal>-group</literal> option.
+These address groups can also be created implicitly by the <link
+linkend="alias"><command>alias</command></link>, <link
+linkend="lists">lists</link>, <link linkend="lists">subscribe</link> and
+<link linkend="alternates"><command>alternates</command></link> commands
+by specifying the optional <literal>-group</literal> option.
</para>
<para>
-Once defined, these address groups can be used in
-<link linkend="patterns">patterns</link> to search for and limit the
-display to messages matching a group.
+Once defined, these address groups can be used in <link
+linkend="patterns">patterns</link> to search for and limit the display
+to messages matching a group.
</para>
<para>
</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 <quote>aliases</quote> which map
-a short string to a full address.
+It's usually very cumbersome to remember or type out the address of
+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 <emphasis>must</emphasis> separate the addresses with a comma (<quote>,</quote>).
+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>
</screen>
<para>
-Unlike other mailers, Mutt doesn't require aliases to be defined
-in a special file. The <command>alias</command> command can appear anywhere in
-a configuration 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 <literal>.muttrc</literal>.
+Unlike other mailers, Mutt doesn't require aliases to be defined in a
+special file. The <command>alias</command> command can appear anywhere
+in a configuration 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 <literal>.muttrc</literal>.
</para>
<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
-<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 <link linkend="source"><command>source</command></link> this file too.
+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
+<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
+<link linkend="source"><command>source</command></link> this file too.
</para>
<example id="ex-alias-external">
<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 <emphasis>Cc:</emphasis> prompt. You can
-also enter aliases in your editor at the appropriate headers if you have the
-<link linkend="edit-headers">$edit_headers</link> variable set.
+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 <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 multiple matches,
-Mutt will bring up a menu with the matching aliases. In order to be
-presented with the full list of aliases, you must hit tab without a partial
-alias, such as at the beginning of the prompt or after a comma denoting
-multiple addresses.
+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
+multiple matches, Mutt will bring up a menu with the matching aliases.
+In order to be presented with the full list of aliases, you must hit tab
+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
-<emphasis>exit</emphasis> key (default: q) to return to the address prompt.
+<literal>select-entry</literal> key (default: <Return>), and use
+the <emphasis>exit</emphasis> key (default: q) to return to the address
+prompt.
</para>
</sect1>
</para>
<para>
-<emphasis>map</emphasis> specifies in which menu the binding belongs. Multiple maps may
-be specified by separating them with commas (no additional whitespace is
-allowed). The currently defined maps are:
+<emphasis>map</emphasis> specifies in which menu the binding belongs.
+Multiple maps may be specified by separating them with commas (no
+additional whitespace is allowed). The currently defined maps are:
</para>
<anchor id="maps"/>
<para>
This is not a real menu, but is used as a fallback for all of 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 <command>bind</command> statements to accomplish the same task.
+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 <command>bind</command> statements to accomplish the
+same task.
</para>
</listitem>
</varlistentry>
<listitem>
<para>
The alias menu is the list of your personal aliases as 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).
+<literal>.muttrc</literal>. It is the mapping from a short alias name
+to the full email address(es) of the recipient(s).
</para>
</listitem>
</varlistentry>
<term>attach</term>
<listitem>
<para>
-The attachment menu is used to access the attachments on received messages.
+The attachment menu is used to access the attachments on received
+messages.
</para>
</listitem>
</varlistentry>
<term>browser</term>
<listitem>
<para>
-The browser is used for both browsing the local directory structure, and for
-listing all of your incoming mailboxes.
+The browser is used for both browsing the local directory structure, and
+for listing all of your incoming mailboxes.
</para>
</listitem>
</varlistentry>
<term>smime</term>
<listitem>
<para>
-The smime menu is used to select the OpenSSL certificates used to encrypt outgoing
-messages.
+The smime menu is used to select the OpenSSL certificates used to
+encrypt outgoing messages.
</para>
</listitem>
</varlistentry>
<term>query</term>
<listitem>
<para>
-The query menu is the browser for results returned by
-<link linkend="query-command">$query_command</link>.
+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 <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 <emphasis>\ca</emphasis> are all
+<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 <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 <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 <xref linkend="tab-key-names"/>.
+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">
</table>
<para>
-<emphasis>key</emphasis> does not need to be enclosed in quotes unless it contains a
-space (<quote> </quote>) or semi-colon (<quote>;</quote>).
+<emphasis>key</emphasis> does not need to be enclosed in quotes unless
+it contains a space (<quote> </quote>) or semi-colon
+(<quote>;</quote>).
</para>
<para>
</cmdsynopsis>
<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.
+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 <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 sets.
+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 sets.
</para>
</sect1>
<para>
It is often desirable to change settings based on which mailbox you are
-reading. The <command>folder-hook</command> command provides a method by which you can 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 <command>folder-hook</command>s, they are executed in the order given in the
-<literal>.muttrc</literal>.
+reading. The <command>folder-hook</command> command provides a method
+by which you can 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 <command>folder-hook</command>s, they are
+executed in the order given in the <literal>.muttrc</literal>.
</para>
<note>
<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 <emphasis>not</emphasis> operator for the expression.
+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 <emphasis>not</emphasis> operator for
+the expression.
</para>
</note>
<note>
<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:
+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 <command>folder-hook</command>s adjusting a value on a per-folder basis
-because <command>folder-hook</command>s are evaluated in the order given in the
-configuration file.
+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 <command>folder-hook</command>s are evaluated in the order given
+in the configuration file.
</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 <quote>mutt</quote> in their name.
+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">
</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 <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.
+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
+<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 <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.
+<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
-<link linkend="bind">key bindings</link> with some additions. The
-first is 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 <emphasis>up</emphasis>
-or to invoke a function directly, you can use the 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
+<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
+<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 <emphasis>up</emphasis> or to invoke a function directly, you
+can use the 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 <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).
+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 <emphasis>sequence</emphasis>,
-which is shown in the help screens if they contain a description.
+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 <emphasis>and</emphasis> a background color (it is not
-possible to only specify one or the other).
+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
+<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</emphasis> matches <emphasis>pattern</emphasis>
-(see <xref linkend="patterns"/>) in the message index.
+<emphasis>header</emphasis> and <emphasis>body</emphasis> match
+<emphasis>regexp</emphasis> in the header/body of a message,
+<emphasis>index</emphasis> matches <emphasis>pattern</emphasis> (see
+<xref linkend="patterns"/>) in the message index.
</para>
<para>
<listitem><para>quoted1, quoted2, ..., quoted<emphasis>N</emphasis> (higher levels of quoting)</para></listitem>
<listitem><para>search (hiliting of words in the pager)</para></listitem>
<listitem><para>signature</para></listitem><listitem><para>status (mode lines used to display info about the mailbox or message)</para></listitem>
-<listitem><para>tilde (the <quote>#</quote> used to pad blank lines in the pager)</para></listitem>
+<listitem><para>tilde (the <quote>~</quote> used to pad blank lines in the pager)</para></listitem>
<listitem><para>tree (thread tree drawn in the message index and attachment menu)</para></listitem>
<listitem><para>underline (hiliting underlined patterns in the body of messages)</para></listitem>
</itemizedlist>
<para>
-<emphasis>foreground</emphasis> and <emphasis>background</emphasis> can be one of the following:
+<emphasis>foreground</emphasis> and <emphasis>background</emphasis> can
+be one of the following:
</para>
<itemizedlist>
</itemizedlist>
<para>
-<emphasis>foreground</emphasis> can optionally be prefixed with the keyword <literal>bright</literal> to make
-the foreground color boldfaced (e.g., <literal>brightred</literal>).
+<emphasis>foreground</emphasis> can optionally be prefixed with the
+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 <emphasis>brightdefault</emphasis> is also valid.
-If Mutt is linked 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):
+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 <literal>$COLORFGBG</literal> environment variable to the
+default colors of your terminal for this to work; for example (for
+Bourne-like shells):
</para>
<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 <emphasis>yellow</emphasis> when
-setting this variable.
+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 <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 <quote>*</quote> is
-a special token which means to clear the color list of all entries.
+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
+<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>, ...,
-<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 <emphasis>color2</emphasis>
-for your xterm), since color names may then lose their normal meaning.
+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
+<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 <quote>mono</quote> command. Usage:
+If your terminal does not support color, it is still possible change the
+video attributes through the use of the <quote>mono</quote>
+command. Usage:
</para>
<cmdsynopsis>
</cmdsynopsis>
<para>
-For <emphasis>object</emphasis>, see the <command>color</command> command. <emphasis>attribute</emphasis>
-can be one of the following:
+For <emphasis>object</emphasis>, see the <command>color</command>
+command. <emphasis>attribute</emphasis> can be one of the following:
</para>
<itemizedlist>
<para>
When displaying a message in the pager, Mutt folds long header 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 tries to implement standards compliant folding.)
+<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
+tries to implement standards compliant folding.)
</para>
</sect2>
</cmdsynopsis>
<para>
-Messages often have many header fields added by automatic processing systems,
-or which may not seem useful to display on the screen. This command allows
-you to specify header fields which you don't normally want to see in the pager.
+Messages often have many header fields added by automatic processing
+systems, or which may not seem useful to display on the 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,
-<quote>ignore content-</quote> will ignore all header fields that begin with the pattern
-<quote>content-</quote>. <quote>ignore *</quote> will ignore all headers.
+<quote>ignore content-</quote> will ignore all header fields that begin
+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 <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 <quote>unignore x-mailer</quote>.
+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 <quote>unignore
+x-mailer</quote>.
</para>
<para>
</cmdsynopsis>
<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.
+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>
<para>
-<quote><command>unhdr_order</command> *</quote> will clear all previous headers from the order list,
-thus removing the header order effects set by the system-wide startup file.
+<quote><command>unhdr_order</command> *</quote> will clear all previous
+headers from the order list, thus removing the header order effects set
+by the system-wide startup file.
</para>
<example id="ex-hdr-order">
</cmdsynopsis>
<para>
-With various functions, Mutt will treat messages differently,
-depending on whether you sent them or whether you received them from
-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 <link linkend="reply-to">$reply_to</link>.)
+With various functions, Mutt will treat messages differently, depending
+on whether you sent them or whether you received them from 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 <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 <command>alternates</command> command: It takes a list of regular
+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
+<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>
</screen>
<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:
+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>
</screen>
<para>
-The <literal>-group</literal> flag causes all of the subsequent regular expressions
-to be added to the named group.
+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
-<command>alternates</command> patterns. If an address matches something in an
-<command>alternates</command> command, but you nonetheless do not think it is
-from you, you can list a more precise pattern under an <command>unalternates</command>
-command.
+The <command>unalternates</command> command can be used to write
+exceptions to <command>alternates</command> patterns. If an address
+matches something in an <command>alternates</command> command, but you
+nonetheless do not think it 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 <command>alternates</command> will be removed.
+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>
</cmdsynopsis>
<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
-<literal>List-Post:</literal> header which has the same effect as
-specifying the list address via the <command>lists</command> command
-(except the group feature). Once you have done this, the
-<link linkend="list-reply"><literal><list-reply></literal></link>
-function will work for all known lists.
-Additionally, when you send a message to a subscribed list, Mutt will
-add a Mail-Followup-To header to tell other users' mail user agents
-not to send copies of replies to your personal address.
+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 <literal>List-Post:</literal> header which has the same
+effect as specifying the list address via the <command>lists</command>
+command (except the group feature). Once you have done this, the <link
+linkend="list-reply"><literal><list-reply></literal></link>
+function will work for all known lists. Additionally, when you send a
+message to a subscribed list, Mutt will add a Mail-Followup-To header to
+tell other users' mail user agents not to send copies of replies to your
+personal address.
</para>
<note>
<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
-<link linkend="followup-to">$followup_to</link>
-configuration variable since it's common practice on some mailing lists
-to send Cc upons replies (which is more a group- than a list-reply).
+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 <link
+linkend="followup-to">$followup_to</link> configuration variable since
+it's common practice on some mailing lists to send Cc upons 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>
+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 <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 system as list mail, for instance, you could say
+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 system
+as list mail, for instance, you could say
</para>
<screen>
subscribe [0-9]*.*@bugs.debian.org</screen>
<para>
-as it's often, it's sufficient to just give a portion of the list's e-mail address.
+as it's often, it's sufficient to just give a portion of the list's
+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 <literal>mutt-users@mutt.org</literal>. So, to tell Mutt
-that this is a mailing list, you could add <literal>lists mutt-users@</literal> to your
-initialization file. To tell 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
+example, if you've subscribed to the Mutt mailing list, you will receive
+mail addressed to <literal>mutt-users@mutt.org</literal>. So, to tell
+Mutt that this is a mailing list, you could add <literal>lists
+mutt-users@</literal> to your initialization file. To tell 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
-<literal><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.
+<literal><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 <literal>-group</literal> flag adds all of the subsequent regular expressions
-to the named group.
+The <literal>-group</literal> flag adds all of the subsequent regular
+expressions to the named group.
</para>
<para>
-The <quote>unlists</quote> command is used to remove a token from the list of
-known and subscribed mailing-lists. Use <quote>unlists *</quote> to remove all
-tokens.
+The <quote>unlists</quote> command is used to remove a token from the
+list of 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 <command>unsubscribe</command>.
+To remove a mailing list from the list of subscribed mailing lists, but
+keep it on the list of known mailing lists, use
+<command>unsubscribe</command>.
</para>
</sect1>
<para>
This command is used to move read messages from a specified mailbox to a
different mailbox automatically when you quit or change folders.
-<emphasis>pattern</emphasis> is a regular expression specifying the mailbox to treat as a
-<quote>spool</quote> mailbox and <emphasis>mailbox</emphasis> specifies where mail should be saved when
+<emphasis>pattern</emphasis> is a regular expression specifying the
+mailbox to treat as a <quote>spool</quote> mailbox and
+<emphasis>mailbox</emphasis> specifies where mail should be saved when
read.
</para>
<para>
-Unlike some of the other <emphasis>hook</emphasis> commands, only the <emphasis>first</emphasis> matching
-pattern is used (it is not possible to save read mail in more than a single
-mailbox).
+Unlike some of the other <emphasis>hook</emphasis> commands, only the
+<emphasis>first</emphasis> matching pattern is used (it is not possible
+to save read mail in more than a single mailbox).
</para>
</sect1>
</cmdsynopsis>
<para>
-This command specifies folders which can receive mail and
-which will be checked for new messages periodically.
+This command specifies folders which can receive mail and which will be
+checked for new messages periodically.
</para>
<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, <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 <xref linkend="imap"/>
-respectively.
+URL. The URL 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
-<xref linkend="new-mail"/> for details (including in what
-situations and how often Mutt checks for new mail).
+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 <quote>unmailboxes</quote> command is used to remove a token from the list
-of folders which receive mail. Use <quote>unmailboxes *</quote> to remove all
-tokens.
+The <quote>unmailboxes</quote> command is used to remove a token from
+the list of folders which receive mail. Use <quote>unmailboxes *</quote>
+to remove all tokens.
</para>
<note>
<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 <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 <command>mailboxes</command> command. If
-none of these shorcuts 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 always be desired.
+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 <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
+<command>mailboxes</command> command. If none of these shorcuts 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
+always be desired.
</para>
</note>
</cmdsynopsis>
<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 <link linkend="edit-headers">$edit_headers</link> is set.
+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 <link linkend="edit-headers">$edit_headers</link> is
+set.
</para>
<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 <literal>.muttrc</literal>.
+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
+<literal>.muttrc</literal>.
</para>
<example id="ex-my-hdr">
<note>
<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.
+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: <quote>E</quote>) in the compose menu so
-that you can edit the header of your message along with the body.
+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 <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
+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
<quote>Cc</quote> header fields, you could use:
</para>
<para>
This command is used to override the default mailbox used when saving
-messages. <emphasis>mailbox</emphasis> will be used as the default if the message
-matches <emphasis>pattern</emphasis>, see <xref linkend="pattern-hook"/> for information
-on the exact format.
+messages. <emphasis>mailbox</emphasis> will be used as the default if
+the message 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
+To provide more flexibility and good defaults, Mutt applies the expandos
+of <link linkend="index-format">$index_format</link> to
<emphasis>mailbox</emphasis> after it was expanded.
</para>
</example>
<para>
-Also see the <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.
+Also see the <link
+linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.
</para>
</sect1>
</cmdsynopsis>
<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>regexp</emphasis> and uses <emphasis>mailbox</emphasis>
-as the default Fcc: mailbox. If no match is found the message will be saved
-to <link linkend="record">$record</link> mailbox.
+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>regexp</emphasis>
+and uses <emphasis>mailbox</emphasis> as the default Fcc: mailbox. If
+no match is found the message will be saved to <link
+linkend="record">$record</link> mailbox.
</para>
<para>
</para>
<para>
-See <xref linkend="pattern-hook"/> for information on the exact format of <emphasis>pattern</emphasis>.
+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 <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.
+...will save a copy of all messages going to the aol.com domain to the
+`+spammers' mailbox by default. Also see the <link
+linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.
</para>
</sect1>
</cmdsynopsis>
<para>
-This command is a shortcut, equivalent to doing both a <link linkend="fcc-hook"><command>fcc-hook</command></link>
-and a <link linkend="save-hook"><command>save-hook</command></link> with its arguments,
-including %-expansion on <emphasis>mailbox</emphasis> according
-to <link linkend="index-format">$index_format</link>.
+This command is a shortcut, equivalent to doing both a <link
+linkend="fcc-hook"><command>fcc-hook</command></link> and a <link
+linkend="save-hook"><command>save-hook</command></link> with its
+arguments, including %-expansion on <emphasis>mailbox</emphasis>
+according to <link linkend="index-format">$index_format</link>.
</para>
</sect1>
</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 <emphasis>pattern</emphasis> matches.
+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
+<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 <emphasis>replies</emphasis>.
+<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>, <emphasis>regardless</emphasis>
-of the order specified in the user's configuration file.
+<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.
</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 <command>send-hook</command>, and
-can, e.g., be used to set parameters such as the <link linkend="sendmail">$sendmail</link> variable depending on the message's sender
-address.
+<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 <command>send-hook</command>, and can, e.g., be used to set
+parameters 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 <command>reply-hook</command>, when multiple matches
-occur, commands are executed in the order they are specified in the <literal>.muttrc</literal>
-(for that type of hook).
+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
+<literal>.muttrc</literal> (for that type of hook).
</para>
<para>
-Example: <literal><command>send-hook</command> mutt "<command>set</command> mime_forward signature=''"</literal>
+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="signature">$signature</link> and <link linkend="locale">$locale</link>
-variables in order to change the language of the attributions and
-signatures based upon the recipients.
+<link linkend="attribution">$attribution</link>, <link
+linkend="signature">$signature</link> and <link
+linkend="locale">$locale</link> variables in order to change the
+language of the attributions and signatures based upon the recipients.
</para>
<note>
<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,
-similarily if <link linkend="autoedit">$autoedit</link> is set
-(as then the initial list of recipients is empty). Also note that <link
-linkend="my-hdr"><command>my_hdr</command></link> commands which
+editing the message will not cause any <command>send-hook</command> to
+be executed, similarily if <link linkend="autoedit">$autoedit</link> is
+set (as then the initial 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
<command>send-hook</command>.
<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 <emphasis>pattern</emphasis> matches the message to be
-displayed. When multiple matches occur, commands are executed in the order
-they are specified in the <literal>.muttrc</literal>.
+before viewing or formatting a message based upon information 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 <literal>.muttrc</literal>.
</para>
<para>
-See <xref linkend="pattern-hook"/> for
-information on the exact format of <emphasis>pattern</emphasis>.
+See <xref linkend="pattern-hook"/> for information on the exact format
+of <emphasis>pattern</emphasis>.
</para>
<para>
</cmdsynopsis>
<para>
-When encrypting messages with PGP/GnuPG or OpenSSL, you may want to 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 <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.
+When encrypting messages with PGP/GnuPG or OpenSSL, you may want to
+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 <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.
</para>
<para>
-The meaning of <emphasis>keyid</emphasis> is to be taken broadly in this context: You
-can either put a numerical key ID here, an e-mail address, or even
-just a real name.
+The meaning of <emphasis>keyid</emphasis> is to be taken broadly in this
+context: You can either put a numerical key ID here, an e-mail address,
+or even just a real name.
</para>
</sect1>
</cmdsynopsis>
<para>
-This command adds the named string to the keyboard buffer. The string may
-contain control characters, key names and function 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, <xref linkend="ex-folder-hook-push"/>
-shows how to automatically collapse all threads when entering a folder.
+This command adds the named string to the keyboard buffer. The string
+may contain control characters, key names and function 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, <xref
+linkend="ex-folder-hook-push"/> shows how to automatically collapse all
+threads when entering a folder.
</para>
<example id="ex-folder-hook-push">
</cmdsynopsis>
<para>
-This command can be used to execute any function. Functions are
-listed in the <link linkend="functions">function reference</link>.
-<quote><command>exec</command><literal>function</literal></quote> is equivalent to
-<quote><literal>push <function></literal></quote>.
+This command can be used to execute any function. Functions are listed
+in the <link linkend="functions">function reference</link>.
+<quote><command>exec</command><literal>function</literal></quote> is
+equivalent to <quote><literal>push <function></literal></quote>.
</para>
</sect1>
</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 <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> or <literal>#h</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 <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.
+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> or
+<literal>~h</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 <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 <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 <quote>*</quote> is a special token which means to clear the list
-of all score entries.
+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 <quote>*</quote> is a special token which means to clear the
+list of all score entries.
</para>
</sect1>
</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 <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 <literal>%?H?[%H] ?</literal>
-to display spam tags only when they are defined for a given message.)
+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 <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
+<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. <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 <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. <emphasis>format</emphasis> can be any static
-text, but it also can include back-references from the <emphasis>pattern</emphasis>
-expression. (A regular expression <quote>back-reference</quote> refers to a
-sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
-the first back-reference in the regex, <literal>%2</literal> with the second, etc.
+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 <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. <emphasis>format</emphasis>
+can be any static text, but it also can include back-references from the
+<emphasis>pattern</emphasis> expression. (A regular expression
+<quote>back-reference</quote> refers to a sub-expression contained
+within parentheses.) <literal>%1</literal> is replaced with the first
+back-reference in the 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,
-<link linkend="imap-headers">$imap_headers</link> may need
-to be adjusted.
+<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 <command>spam</command> patterns for each
-filter you use. If a message 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 <link linkend="spam-separator">$spam_separator</link> separating
-them.
+If you're using multiple spam filters, a message can have more than 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 <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
+<link linkend="spam-separator">$spam_separator</link> separating them.
</para>
<para>
</example>
<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 <quote>=many</quote> in a
-DCC report indicate the checksum used — in this case, <quote>Fuz2</quote>.)
+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 <quote>=many</quote> in a
+DCC report indicate the checksum used — in this case,
+<quote>Fuz2</quote>.)
</para>
<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 <emphasis>format</emphasis> strings, you'll get only the last one to match.
+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 <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 <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 <literal><limit></literal> functions. And it's what sorting by spam
-attribute will use as a sort key.
+<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
+<literal><limit></literal> functions. And it's what sorting by
+spam attribute will use as a sort key.
</para>
<para>
</para>
<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
-<literal>sort -n</literal>.) A message with no spam attributes at all — 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 <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.
+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 <literal>sort -n</literal>.) A message with
+no spam attributes at all — 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 <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 <command>spam</command>
-patterns. If a header pattern matches something in 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 <command>nospam</command> command.
+The <command>nospam</command> command can be used to write exceptions to
+<command>spam</command> patterns. If a header pattern matches something
+in 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
+<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 <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>, <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 <command>folder-hook</command>.
+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>, <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 <command>folder-hook</command>.
</para>
<para>
-You can have as many <command>spam</command> or <command>nospam</command> commands as you like.
-You can even do your own 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 <command>spam</command> command like this:
+You can have as many <command>spam</command> or
+<command>nospam</command> commands as you like. You can even do your
+own 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 <command>spam</command> command like this:
</para>
<screen>
<para>
A specialized string for representing paths including support for
mailbox shortcuts (see <xref linkend="shortcuts"/>) as well as tilde
-(<quote>#</quote>) for a user's home directory and more.
+(<quote>~</quote>) for a user's home directory and more.
</para>
</listitem>
</varlistentry>
<listitem>
<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.
+<emphasis>mmdf</emphasis>, <emphasis>mh</emphasis> or
+<emphasis>maildir</emphasis>. Currently only used to determine the type
+for newly created folders.
</para>
</listitem>
</varlistentry>
<term>e-mail address</term>
<listitem>
<para>
-An e-mail address either with or without
-realname. The older <quote><literal>user@example.org (Joe User)</literal></quote>
-form is supported but strongly deprecated.
+An e-mail address either with or without realname. The older
+<quote><literal>user@example.org (Joe User)</literal></quote> form is
+supported but strongly deprecated.
</para>
</listitem>
</varlistentry>
</cmdsynopsis>
<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). <emphasis>number</emphasis> variables can be
-assigned a positive integer 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.
-<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 <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 <emphasis>no</emphasis> will cause the
-action to be carried out as if 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 <quote>no.</quote>
+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).
+<emphasis>number</emphasis> variables can be assigned a positive integer
+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.
+<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 <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 <emphasis>no</emphasis> will cause the action to
+be carried out as if 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 <quote>no.</quote>
</para>
<para>
-Prefixing a variable with <quote>no</quote> will unset it. Example: <literal><command>set</command> noaskbcc</literal>.
+Prefixing a variable with <quote>no</quote> will unset it. Example:
+<literal><command>set</command> noaskbcc</literal>.
</para>
<para>
-For <emphasis>boolean</emphasis> variables, you may optionally prefix the variable name with
-<literal>inv</literal> to toggle the value (on or off). This is useful when writing
-macros. Example: <literal><command>set</command> invsmart_wrap</literal>.
+For <emphasis>boolean</emphasis> variables, you may optionally prefix
+the variable name with <literal>inv</literal> to toggle the value (on or
+off). This is useful when writing macros. Example:
+<literal><command>set</command> invsmart_wrap</literal>.
</para>
<para>
-The <command>toggle</command> command automatically prepends the <literal>inv</literal> prefix to all
-specified variables.
+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 <literal>no</literal> prefix to all
-specified variables.
+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 <emphasis>index</emphasis> menu, you can query the
-value of a variable by prefixing the name of the variable with a question
-mark:
+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>
</para>
<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 <command>reset</command> command.
+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
+<command>reset</command> command.
</para>
<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.
+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>
<title>Introduction</title>
<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, <literal>my_cfgdir</literal>.
+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, <literal>my_cfgdir</literal>.
</para>
<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 <command>reset</command>
+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 <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 <link linkend="shell-escape">shell-escape</link> command and
-backtick expansion), this feature can be used to make configuration
-files more readable.
+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>
<title>Examples</title>
<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:
+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 id="ex-myvar1">
<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
-<link linkend="delete">$delete</link> is changed temporarily
-while its original value is saved as <literal>my_delete</literal>.
-After the macro has executed all commands, the original value of <link
+of another variable. In the following example, the value of the <link
+linkend="delete">$delete</link> is changed temporarily while its
+original value is saved as <literal>my_delete</literal>. After the
+macro has executed all commands, the original value of <link
linkend="delete">$delete</link> is restored.
</para>
</example>
<para>
-Note that there is a space
-between <literal><enter-command></literal> and
-the <command>set</command> configuration command, preventing Mutt from
-recording the <command>macro</command>'s commands into its history.
+Note that there is a space between
+<literal><enter-command></literal> and the <command>set</command>
+configuration command, preventing Mutt from recording the
+<command>macro</command>'s commands into its history.
</para>
</sect3>
Variables are always assigned string values which Mutt parses into its
internal representation according to the type of the variable, for
example an integer number for numeric types. For all queries (including
-$-expansion) the value is converted from its internal type 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
+$-expansion) the value is converted from its internal type 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. <xref linkend="ex-myvar4"/> demonstrates type
conversions.
mailboxes $my_mx +mailbox3</screen>
<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.
+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>
</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
-<literal>#/.muttrc</literal> readable and keep my aliases private.
+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
+<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.
+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 <emphasis>filename</emphasis> is
-considered to be an executable program from which to read input (eg.
-<literal><command>source</command> #/bin/myscript|</literal>).
+If the filename ends with a vertical bar (<quote>|</quote>), then
+<emphasis>filename</emphasis> is considered to be an executable program
+from which to read input (eg. <literal><command>source</command>
+~/bin/myscript|</literal>).
</para>
</sect1>
<para>
This command permits you to flush hooks you have previously 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
+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 <literal><command>unhook</command> send-hook</literal>.
</para>
<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>,
-<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.
+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
+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
-<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.
+<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 <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 <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
-formatted string will occupy — if it's naturally smaller than that, it
-will be padded out with spaces. If a decimal point and another number
-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 <literal>%-12.15L</literal>.
+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
+<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 <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 formatted string will occupy — if
+it's naturally smaller than that, it will be padded out with spaces. If
+a decimal point and another number 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
+<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, <literal>%=14y</literal> will reserve 14
-characters for the %y expansion — that's the X-Label: header, in
-<link linkend="index-format">$index_format</link>. 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 <quote> test </quote>.
+above), it will force the string to be centered within its minimum space
+range. For example, <literal>%=14y</literal> will reserve 14 characters
+for the %y expansion — that's the X-Label: header, in <link
+linkend="index-format">$index_format</link>. 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
+<quote> test </quote>.
</para>
<para>
There are two very little-known modifiers that affect the way that an
-expando is replaced. If there is an underline (<quote>_</quote>) character
-between any format modifiers (as above) and the expando letter, it will
-expands in all lower case. And if you use a colon (<quote>:</quote>), it will
-replace all decimal points with underlines.
+expando is replaced. If there is an underline (<quote>_</quote>)
+character between any format modifiers (as above) and the expando
+letter, it will expands in all lower case. And if you use a colon
+(<quote>:</quote>), it will replace all decimal points with underlines.
</para>
</sect2>
<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.
-<emphasis>optional_string</emphasis> may contain other
-sequences as well as normal text, but you may not nest optional
-strings.
+<emphasis>optional_string</emphasis> is the string you would like
+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
-<link linkend="status-format">$status_format</link>:
+new messages in a mailbox in <link
+linkend="status-format">$status_format</link>:
</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 <emphasis>else_string</emphasis> will be expanded.
+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>
</sect2>
<para>
Any format string ending in a vertical bar (<quote>|</quote>) will be
-expanded and piped through the first word in the string, using spaces
-as separator. The string returned will be used for display.
-If the returned string ends in %, it will be passed through
-the formatter a second time. This allows the filter to generate a
-replacement format string including % expandos.
+expanded and piped through the first word in the string, using spaces as
+separator. The string returned will be used for display. If the
+returned string ends in %, it will be passed through the formatter a
+second time. This allows the filter to generate a replacement format
+string including % expandos.
</para>
<para>
-All % expandos in a format string are expanded before the script
-is called so that:
+All % expandos in a format string are expanded before the script is
+called so that:
</para>
<example id="ex-fmtpipe">
</example>
<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.
+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 <literal>samples</literal>
-subdirectory of the Mutt documentation: it can be used as filter for
-<link linkend="status-format">$status_format</link> to set the current
+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 <link
+linkend="status-format">$status_format</link> to set the current
terminal's title, if supported.
</para>
<term><literal>%|X</literal></term>
<listitem>
<para>
-When this occurs, Mutt will fill the rest of the
-line with the character <literal>X</literal>. For
-example, filling the rest of the line with dashes is
-done by setting:
+When this occurs, Mutt will fill the rest of the line with 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>
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 <literal>%*
-</literal>: the second ensures there's a space between the truncated
-right-hand side and the subject):
+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>
<title>Regular Expressions</title>
<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 <quote>POSIX extended</quote> syntax (which
+All string patterns in Mutt including those in more complex <link
+linkend="patterns">patterns</link> must be specified using regular
+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: <quote>\\</quote>.
+<quote>\</quote> must be quoted if used for a regular expression in an
+initialization command: <quote>\\</quote>.
</para>
</note>
<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 <xref linkend="muttrc-syntax"/>
-for more information on " and ' delimiter processing. To match a
-literal " or ' you must preface it with \ (backslash).
+The regular expression can be enclosed/delimited by either " or ' which
+is useful if the regular expression includes a white-space 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>
</note>
<para>
-The fundamental building blocks are the regular expressions that match
-a single character. Most characters, including all letters and digits,
+The fundamental building blocks are the regular expressions that match a
+single character. Most characters, including all letters and 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 <quote>$</quote> are metacharacters that respectively match
-the empty string at the beginning and end of a line.
+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 <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 <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
-<quote>-</quote>. Most metacharacters lose their special meaning inside
-lists. To include a literal <quote>]</quote> place it first in the list.
-Similarly, to include a literal <quote>^</quote> place it anywhere but first.
+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 <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 <quote>-</quote>. Most
+metacharacters lose their special meaning inside lists. To include a
+literal <quote>]</quote> place it first in the list. Similarly, to
+include a literal <quote>^</quote> place it anywhere but first.
Finally, to include a 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 <quote>:]</quote>.
-The following classes are defined by the POSIX standard in
+consist of <quote>[:</quote>, a keyword denoting the class, and
+<quote>:]</quote>. The following classes are defined by the POSIX
+standard in
<xref linkend="posix-regex-char-classes"/>
</para>
<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
-<emphasis>[0-9]</emphasis>.
+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 <emphasis>[0-9]</emphasis>.
</para>
</note>
<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 <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 <quote>h</quote>.
+<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 <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 <quote>è</quote> <quote>é</quote> and <quote>e</quote>. In this case,
-<emphasis>[[=e=]]</emphasis> is a regexp that matches any of
-<quote>è</quote>, <quote>é</quote> and <quote>e</quote>.
+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 <quote>è</quote> <quote>é</quote> and
+<quote>e</quote>. In this case, <emphasis>[[=e=]]</emphasis> is a
+regexp that matches any of <quote>è</quote>,
+<quote>é</quote> and <quote>e</quote>.
</para>
</listitem>
</varlistentry>
<para>
A regular expression matching a single character may be followed by one
-of several repetition operators described in <xref linkend="regex-repeat"/>.
+of several repetition operators described in <xref
+linkend="regex-repeat"/>.
</para>
<table id="regex-repeat">
</para>
<para>
-Two regular expressions may be joined by the infix operator <quote>|</quote>;
-the resulting regular expression matches any string matching either
-subexpression.
+Two regular expressions may be joined by the infix operator
+<quote>|</quote>; the resulting regular expression matches any string
+matching either subexpression.
</para>
<para>
<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 <xref linkend="regex-gnu-ext"/>.
+following operators may also be used in regular expressions as described
+in <xref linkend="regex-gnu-ext"/>.
</para>
</note>
</table>
<para>
-Where <emphasis>EXPR</emphasis> is a
-<link linkend="regexp">regular expression</link>.
+Where <emphasis>EXPR</emphasis> is a <link linkend="regexp">regular
+expression</link>.
</para>
<para>
-*) The forms <quote><[<emphasis>MAX</emphasis>]</quote>, <quote>>[<emphasis>MIN</emphasis>]</quote>,
-<quote>[<emphasis>MIN</emphasis>]-</quote> and <quote>-[<emphasis>MAX</emphasis>]</quote>
-are allowed, too.
+*) The forms <quote><[<emphasis>MAX</emphasis>]</quote>,
+<quote>>[<emphasis>MIN</emphasis>]</quote>,
+<quote>[<emphasis>MIN</emphasis>]-</quote> and
+<quote>-[<emphasis>MAX</emphasis>]</quote> are allowed, too.
</para>
<para>
-**) The suffixes <quote>K</quote> and <quote>M</quote> are allowed to specify kilobyte and megabyte respectively.
+**) The suffixes <quote>K</quote> and <quote>M</quote> are allowed to
+specify kilobyte and megabyte respectively.
</para>
<para>
-Special attention has to be
-payed when using regular expressions inside of patterns. Specifically,
-Mutt's parser for these patterns will strip one level of backslash (<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 <emphasis>EXPR</emphasis> as a simple string
-instead of a regular expression by using = instead of # in the
-pattern name. For example, <literal>=b *.*</literal> will find all messages that contain
-the 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 <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 value.
+Special attention has to be payed when using regular expressions inside
+of patterns. Specifically, Mutt's parser for these patterns will strip
+one level of backslash (<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
+<emphasis>EXPR</emphasis> as a simple string instead of a regular
+expression by using = instead of ~ in the pattern name. For example,
+<literal>=b *.*</literal> will find all messages that contain the
+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
+<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 value.
</para>
<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 <quote>^</quote>.
-This example matches all mails which only has recipients from Germany.
+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 <quote>^</quote>. This example matches all mails which only has
+recipients from Germany.
</para>
<example id="ex-recips">
<title>Simple Searches</title>
<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 <quote>%</quote>). If the query is
-supposed to contain one of these special characters, they must be escaped
-by prepending a backslash (<quote>\</quote>).
+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 <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>
</table>
<para>
-The second type of simple search is to build a complex search
-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.
+The second type of simple search is to build a complex search 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>
</sect2>
</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 <quote>From</quote> header
-field.
+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:
+Mutt also recognizes the following operators to create more complex
+search patterns:
</para>
<itemizedlist>
</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 <quote>elkins</quote>.
+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
+<quote>elkins</quote>.
</para>
<example id="ex-pattern-bool">
</example>
<para>
-Here is an example using white space in the regular expression (note
-the ' and " 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 <quote>Ed +SomeoneElse</quote>:
+Here is an example using white space in the regular expression (note the
+' and " 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 <quote>Ed +SomeoneElse</quote>:
</para>
<screen>
<note>
<para>
-If a regular expression contains parenthesis, or a vertical bar
-("|"), 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: <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 <emphasis>cs\.hmc\.edu)</emphasis>. They are never what you want.
+If a regular expression contains parenthesis, or a vertical bar ("|"),
+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: <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
+<emphasis>cs\.hmc\.edu)</emphasis>. They are never what you want.
</para>
</note>
<title>Searching by Date</title>
<para>
-Mutt supports two types of dates, <emphasis>absolute</emphasis> and <emphasis>relative</emphasis>.
+Mutt supports two types of dates, <emphasis>absolute</emphasis> and
+<emphasis>relative</emphasis>.
</para>
<sect3 id="date-absolute">
<title>Absolute Dates</title>
<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:
+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>
</screen>
<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 <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.
+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
+<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 <xref linkend="tab-date-units"/>. As a special case, you can replace the
-sign by a <quote>*</quote> character, which is equivalent to giving identical plus and minus error margins.
+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 <xref
+linkend="tab-date-units"/>. As a special case, you can replace the sign
+by a <quote>*</quote> character, which is equivalent to giving identical
+plus and minus error margins.
</para>
<table id="tab-date-units">
</table>
<para>
-Example: To select any messages two weeks around January 15, 2001,
-you'd use the following pattern:
+Example: To select any messages two weeks around January 15, 2001, you'd
+use the following pattern:
</para>
<screen>
<title>Relative Dates</title>
<para>
-This type of date is relative to the current date, and may
-be specified as:
+This type of date is relative to the current date, and may be specified
+as:
</para>
<itemizedlist>
<listitem>
<para>
-><emphasis>offset</emphasis> for messages older than <emphasis>offset</emphasis> units
+><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> units
+<<emphasis>offset</emphasis> for messages newer than
+<emphasis>offset</emphasis> units
</para>
</listitem>
<listitem>
<para>
-=<emphasis>offset</emphasis> for messages exactly <emphasis>offset</emphasis> units old
+=<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 <xref linkend="tab-date-units"/>.
+<emphasis>offset</emphasis> is specified as a positive number with one
+of the units from <xref linkend="tab-date-units"/>.
</para>
<para>
<note>
<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 <emphasis>not</emphasis> the dates shown
-in the main index.
+<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 <emphasis>not</emphasis> the
+dates shown in the main index.
</para>
</note>
<title>Using Tags</title>
<para>
-Sometimes it is desirable to perform an operation on a group of
-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
-<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 <link linkend="patterns">patterns</link> for Mutt's pattern
-matching syntax.
+Sometimes it is desirable to perform an operation on a group of 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 <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 <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 <emphasis>next</emphasis> operation will
-be applied to all tagged messages 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 <quote>tag-prefix</quote>.
+<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
+<link linkend="auto-tag">$auto_tag</link> variable is set, the next
+operation applies to the tagged messages automatically, without
+requiring the <quote>tag-prefix</quote>.
</para>
<para>
-In <link linkend="macro"><command>macro</command>s</link> or <link linkend="push"><command>push</command></link> commands,
-you can use the <literal><tag-prefix-cond></literal> operator. If there are no 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 <literal><end-cond></literal>
-operator; after this operator the rest of the macro will be executed as
-normal.
+In <link linkend="macro"><command>macro</command>s</link> or <link
+linkend="push"><command>push</command></link> commands, you can use the
+<literal><tag-prefix-cond></literal> operator. If there are no
+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 <literal><end-cond></literal> operator;
+after this operator the rest of the macro will be executed as normal.
</para>
</sect1>
<title>Using Hooks</title>
<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
-<link linkend="patterns">pattern</link> along with a
-configuration option/command. See:
+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 <link
+linkend="patterns">pattern</link> along with a configuration
+option/command. See:
<itemizedlist>
<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 <quote>default</quote> hook needs to be added before all
-other hooks of that type to restore configuration defaults.
+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 <quote>default</quote> hook needs to be added before all
+other hooks of that type to restore configuration defaults.
</para>
</note>
</example>
<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
-<literal><c@c.c></literal>.
+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 <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>fcc-hook</command>) are evaluated in a
-slightly different 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.
+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>fcc-hook</command>) are evaluated in a slightly different
+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 <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
-<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, etc.).
+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 <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, etc.).
</para>
<para>
</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 <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
-<link linkend="default-hook">$default_hook</link> variable. The
-pattern 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.
+However, it is not required that you write the pattern to match 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 <link
+linkend="default-hook">$default_hook</link> variable. The pattern 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>
<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 <link linkend="query-command">$query_command</link> variable, you specify the wrapper
-command to use. For example:
+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>
<para>
There are two mechanisms for accessing the query function of Mutt. 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 aliases, or to mail. You can tag multiple addresses
-to mail, start a new query, or have a new query appended to the current
+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 aliases, or to mail. You can tag multiple addresses to mail,
+start a new 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 <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
-there is a single response for that query, Mutt will expand the address
-in place. If there are multiple responses, Mutt will activate the query
-menu. At the query menu, you can select one or more addresses to be
-added to the prompt.
+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 there is a single response for that
+query, Mutt will expand the address in place. If there are multiple
+responses, Mutt will activate the query menu. At the query menu, you
+can select one or more addresses to be added to the prompt.
</para>
</sect1>
<title>Mailbox Formats</title>
<para>
-Mutt supports reading and writing of four different local mailbox formats:
-mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
-is no need to use a flag for different mailbox types. When 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.
+Mutt supports reading and writing of four different local mailbox
+formats: mbox, MMDF, MH and Maildir. The mailbox type is autodetected,
+so there is no need to use a flag for different mailbox types. When
+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>
-<emphasis>mbox</emphasis>. This is a widely used mailbox format for UNIX. All
-messages are stored in a single file. Each message has a line of the form:
+<emphasis>mbox</emphasis>. This is a widely used mailbox format for
+UNIX. All messages are stored in a single file. Each message has a
+line of the form:
</para>
<screen>
<para>
to denote the start of a new message (this is often referred to as 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.
+<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>mbox</emphasis> format. Each message is surrounded by
-lines containing <quote>^A^A^A^A</quote> (four
-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).
+<emphasis>MMDF</emphasis>. This is a variant of the
+<emphasis>mbox</emphasis> format. Each message is surrounded by lines
+containing <quote>^A^A^A^A</quote> (four 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>MMDF</emphasis>, a mailbox
+<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 <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
-<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 <emphasis>MH</emphasis>, except that it adds three
-subdirectories of the 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 unlikely. Maildir maybe
-slower to open without caching in Mutt, it too is not very
-disk-space efficient depending on the environment. Since no additional
-files are used for metadata (which is embedded in the message filenames)
-and Maildir is locking-free, it's easy to sync across different machines
-using file-level synchronization tools.
+detects this type of 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 <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
+<emphasis>MH</emphasis>, except that it adds three subdirectories of the
+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 unlikely. Maildir maybe slower to open without caching in Mutt, it
+too is not very disk-space efficient depending on the environment. Since
+no additional files are used for metadata (which is embedded in the
+message filenames) and Maildir is locking-free, it's easy to sync across
+different machines using file-level synchronization tools.
</para>
</sect1>
<title>Mailbox Shortcuts</title>
<para>
-There are a number of built in shortcuts which refer to specific mailboxes.
-These shortcuts can be used anywhere you are prompted for a file or mailbox
-path or in path-related configuration variables. Note that these only
-work at the beginning of a string.
+There are a number of built in shortcuts which refer to specific
+mailboxes. These shortcuts can be used anywhere you are prompted for a
+file or mailbox path or in path-related configuration variables. Note
+that these only work at the beginning of a string.
</para>
<itemizedlist>
<listitem>
<para>
-! — refers to your <link linkend="spoolfile">$spoolfile</link> (incoming) mailbox
+! — refers to your <link linkend="spoolfile">$spoolfile</link>
+(incoming) mailbox
</para>
</listitem>
<listitem>
<listitem>
<para>
-# — refers to your home directory
+~ — refers to your home directory
</para>
</listitem>
<listitem>
<para>
-= or + — refers to your <link linkend="folder">$folder</link> directory
+= or + — refers to your <link linkend="folder">$folder</link>
+directory
</para>
</listitem>
<listitem>
<para>
-@<emphasis>alias</emphasis> — refers to the <link linkend="save-hook">default save folder</link> as determined by the address of the alias
+@<emphasis>alias</emphasis> — refers to the <link
+linkend="save-hook">default save folder</link> as determined by the
+address of the alias
</para>
</listitem>
<para>
For example, to store a copy of outgoing messages in the folder they
-were composed in,
-a <link linkend="folder-hook"><command>folder-hook</command></link> can
-be used to set <link linkend="record">$record</link>:
+were composed in, a <link
+linkend="folder-hook"><command>folder-hook</command></link> can be used
+to set <link linkend="record">$record</link>:
</para>
<screen>
<para>
Mutt has a few configuration options that make dealing with large
-amounts of mail easier. The first thing you must do is to let Mutt
-know 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 <link linkend="lists"><command>lists</command> and <command>subscribe</command></link> commands in your <literal>.muttrc</literal>.
+amounts of mail easier. The first thing you must do is to let Mutt know
+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 <link linkend="lists"><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 <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 <quote>Cc</quote>
+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 <quote>Cc</quote>
field (otherwise it prints the name of the author).
</para>
<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 <literal><list-reply></literal>
-function, which by default is bound 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
+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
+<literal><list-reply></literal> function, which by default is
+bound 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 <literal>Mail-Followup-To</literal>, see below).
</para>
<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 <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 <quote>followups</quote>) to this
-message should only be sent to the original recipients of the
+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 <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 <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 <literal>Mail-Followup-To</literal> header, Mutt will respect this header if
-the <link linkend="honor-followup-to">$honor_followup_to</link> configuration
-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 <literal>Mail-Followup-To</literal>.
+Conversely, when group-replying or list-replying to a message which has
+a <literal>Mail-Followup-To</literal> header, Mutt will respect this
+header if the <link
+linkend="honor-followup-to">$honor_followup_to</link> configuration
+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
+<literal>Mail-Followup-To</literal>.
</para>
<note>
<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.
+<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
-<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 <link linkend="reply-to">$reply_to</link>
-variable to help decide which 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 <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 <quote>Reply-To</quote> field will be used when
-present.
-</para>
-
-<para>
-The <quote>X-Label:</quote> header field can be used to further identify mailing
-lists or list subject matter (or just to annotate messages
-individually). The <link linkend="index-format">$index_format</link> variable's <quote>%y</quote> and
-<quote>%Y</quote> expandos can be used to expand <quote>X-Label:</quote> fields in the
-index, and Mutt's pattern-matcher can match regular expressions to
-<quote>X-Label:</quote> fields with the <quote>#y</quote> selector. <quote>X-Label:</quote> is not a
-standard message header field, but it can easily be inserted by procmail
-and other mail filtering agents.
-</para>
-
-<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 represented graphically. If you've ever
-used a threaded news client, this is the same concept. It makes dealing
-with large volume mailing lists easier because you can easily delete
-uninteresting threads and quickly find topics of value.
+<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 <link
+linkend="reply-to">$reply_to</link> variable to help decide which
+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 <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
+<quote>Reply-To</quote> field will be used when present.
+</para>
+
+<para>
+The <quote>X-Label:</quote> header field can be used to further identify
+mailing lists or list subject matter (or just to annotate messages
+individually). The <link linkend="index-format">$index_format</link>
+variable's <quote>%y</quote> and <quote>%Y</quote> expandos can be used
+to expand <quote>X-Label:</quote> fields in the index, and Mutt's
+pattern-matcher can match regular expressions to <quote>X-Label:</quote>
+fields with the <quote>~y</quote> selector. <quote>X-Label:</quote> is
+not a standard message header field, but it can easily be inserted by
+procmail and other mail filtering agents.
+</para>
+
+<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 represented graphically. If you've ever used a threaded
+news client, this is the same concept. It makes dealing with large
+volume mailing lists easier because you can easily delete uninteresting
+threads and quickly find topics of value.
</para>
</sect1>
<title>Linking Threads</title>
<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 <literal><link-threads></literal> function (bound to & by default). The
-reply will then be connected to this parent message.
+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 <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
-<literal><tag-prefix></literal> command (';') or the <link linkend="auto-tag">$auto_tag</link> option.
+You can also connect multiple children at once, tagging them and using
+the <literal><tag-prefix></literal> command (';') or the <link
+linkend="auto-tag">$auto_tag</link> option.
</para>
</sect2>
<para>
On mailing lists, some people are in the bad habit of starting a 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 <literal><break-thread></literal> function (bound
-by default to #), which will turn the subthread starting from the
+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 <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>
<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
-<quote>return receipts.</quote>
+about the status of electronic mail messages. These can be thought of
+as <quote>return receipts.</quote>
</para>
<para>
-To support DSN, there are two variables. <link linkend="dsn-notify">$dsn_notify</link> is used to request receipts for
+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.).
-<link linkend="dsn-return">$dsn_return</link> requests how much
-of your message should be returned with the receipt (headers or full
-message).
+<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 <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.
+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 <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.
+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>
</sect1>
<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
-<ulink url="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink>
+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
+<ulink
+url="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink>
and the configuration commands:
</para>
<listitem>
<para>
Mutt normalizes all e-mail addresses to the simplest 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
+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
<emphasis>joe@example.com</emphasis>.
</para>
<para>
present. Otherwise, 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
-<link linkend="spoolfile">$spoolfile</link> setting overrides
-this selection. Highest priority has the mailbox given with the
+reside in the home directory). The <link
+linkend="spoolfile">$spoolfile</link> setting overrides this
+selection. Highest priority has the mailbox given with the
<literal>-f</literal> command line option.
</para>
</listitem>
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
-<literal>mime.types</literal> file, which contains the mapping of file 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.
+<literal>mime.types</literal> file, which contains the mapping of file
+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>
<sect1 id="using-mime">
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
-<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
+<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
<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
-<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
+<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
<xref linkend="supported-mime-types"/>.
</para>
<para>
Mutt supports several of optional features which can be enabled 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 <emphasis>configure --help</emphasis> output.
+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 <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 <quote>-</quote>. For example, if
-Mutt was compiled using GnuTLS for encrypted communication instead of
-OpenSSL, <literal>mutt -v</literal> would contain:
+<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, <literal>mutt -v</literal>
+would contain:
</para>
<screen>
<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 <literal>[]</literal> means it is optional and
-may be omitted):
+in Mutt is (an item enclosed in <literal>[]</literal> means it is
+optional and may be omitted):
</para>
<screen>
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,
-<link linkend="imap-user">$imap_user</link>). The username
-may contain the <quote>@</quote> symbol being used by many mail systems
-as part of the login name. The special characters <quote>/</quote>
-(<literal>%2F</literal>),
-<quote>:</quote> (<literal>%3A</literal>)
-and <quote>%</quote> (<literal>%25</literal>) have to be
-URL-encoded in usernames using the <literal>%</literal>-notation.
+possible using, for example, <link
+linkend="imap-user">$imap_user</link>). The username may contain the
+<quote>@</quote> symbol being used by many mail systems as part of the
+login name. The special characters <quote>/</quote>
+(<literal>%2F</literal>), <quote>:</quote> (<literal>%3A</literal>) and
+<quote>%</quote> (<literal>%25</literal>) have to be URL-encoded in
+usernames using the <literal>%</literal>-notation.
</para>
<para>
<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
+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
<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 <quote>secure communication</quote>.
+are suffixed with <quote>s</quote> for <quote>secure
+communication</quote>.
</para>
</sect1>
<title>POP3 Support</title>
<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
+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 <xref linkend="url-syntax"/> for details.
+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
-<link linkend="pop-checkinterval">$pop_checkinterval</link>
-variable, which defaults to every 60 seconds.
+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 <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).
+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 <literal><fetch-mail></literal> function
-(default: G). It allows to connect to <link linkend="pop-host">$pop_host</link>, fetch all your new mail and place it in the
-local <link linkend="spoolfile">$spoolfile</link>. After this
-point, Mutt runs exactly as if the mail had always been local.
+Another way to access your POP3 mail is the
+<literal><fetch-mail></literal> function (default: G). It allows
+to connect to <link linkend="pop-host">$pop_host</link>, fetch all your
+new mail and 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>, <literal>getmail(1)</literal> or similar.
+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>, <literal>getmail(1)</literal> or
+similar.
</para>
</note>
<title>IMAP Support</title>
<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
+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
+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 <literal>imaps</literal> protocol.
Alternatively, a pine-compatible notation is also supported, ie
<literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
</para>
<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.
+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
-<link linkend="imap-list-subscribed">$imap_list_subscribed</link> variable.
+<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
-<link linkend="timeout">$timeout</link>
-variables. Reasonable values are:
+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 <link
+linkend="timeout">$timeout</link> variables. Reasonable values are:
</para>
<screen>
<note>
<para>
Note that if you are using mbox as the mail store on UW servers prior to
-v12.250, the server has been reported to disconnect a client if another client
-selects the same folder.
+v12.250, the server has been reported to disconnect a client if another
+client selects the same folder.
</para>
</note>
<listitem>
<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
+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>
<para>
-For the case where an entry can contain both messages and
-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 <literal>space</literal> by default).
+For the case where an entry can contain both messages and 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 <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
-<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 <literal><unsubscribe></literal> to mailboxes (normally
-these are bound to <literal>s</literal> and <literal>u</literal>, respectively).
+<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
+<literal><unsubscribe></literal> to mailboxes (normally these are
+bound to <literal>s</literal> and <literal>u</literal>, respectively).
</para>
</listitem>
Mutt supports four authentication methods with IMAP servers: SASL,
GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
NTLM authentication for you poor exchange users out there, but it 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 <quote>anonymous</quote>.
+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 <quote>anonymous</quote>.
</para>
<para>
-SASL is a special super-authenticator, which selects among several protocols
-(including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure
-method available on your host and the server. Using some of these methods
-(including DIGEST-MD5 and possibly 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 <emphasis>--with-sasl</emphasis> flag.
+SASL is a special super-authenticator, which selects among several
+protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the
+most secure method available on your host and the server. Using some of
+these methods (including DIGEST-MD5 and possibly 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 <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, LOGIN.
+Mutt will try whichever methods are compiled in and available on the
+server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5,
+LOGIN.
</para>
<para>
<listitem>
<para>
-<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 (ie by using a mailbox name of the form
+<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 (ie by using a mailbox name of the form
<literal>{user@host}</literal>).
</para>
</listitem>
<listitem>
<para>
-<link linkend="imap-pass">$imap_pass</link> - a
-password which you may preset, used by all authentication methods where
-a password is needed.
+<link linkend="imap-pass">$imap_pass</link> - a password which you may
+preset, used by all authentication methods where a password is needed.
</para>
</listitem>
<listitem>
<para>
-<link linkend="imap-authenticators">$imap_authenticators</link> - a colon-delimited list of IMAP
-authentication methods to try, in the order you wish to try them. If
-specified, this overrides Mutt's default (attempt everything, in the order
-listed above).
+<link linkend="imap-authenticators">$imap_authenticators</link> - a
+colon-delimited list of IMAP authentication methods to try, in the order
+you wish to try them. If specified, this overrides Mutt's default
+(attempt everything, in the order listed above).
</para>
</listitem>
</para>
<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 <link linkend="sendmail">$sendmail</link>.
+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 <link
+linkend="sendmail">$sendmail</link>.
</para>
<para>
</para>
<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 <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.
+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 <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>
</sect1>
</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 <link linkend="account-hook"><command>account-hook</command></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,
-<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 <link linkend="account-hook"><command>account-hook</command></link> was last used).
+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 <link
+linkend="account-hook"><command>account-hook</command></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, <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 <link
+linkend="account-hook"><command>account-hook</command></link> was last
+used).
</para>
<para>
</screen>
<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 linkend="mailboxes"><command>mailboxes</command></link> command.
+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
+linkend="mailboxes"><command>mailboxes</command></link> command.
</para>
<example id="ex-multiaccount">
</example>
<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 linkend="folder-hook"><command>folder-hook</command></link> triggers when
-one mailbox below each IMAP account is opened and 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 <quote>+</quote>
-<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
-separatedly per account. Setting other values
-like <link linkend="from">$from</link>
+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
+linkend="folder-hook"><command>folder-hook</command></link> triggers
+when one mailbox below each IMAP account is opened and 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
+<quote>+</quote> <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 separatedly
+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>
<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 <quote>body caching</quote> which are both described in this section.
+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>
<para>
Mutt provides optional support for caching message headers for the
following types of folders: IMAP, POP, Maildir and MH. Header caching
-greatly improves speed because for remote folders, headers
-usually only need to be downloaded once. For Maildir 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.)
+greatly improves speed because for remote folders, headers usually only
+need to be downloaded once. For Maildir 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
-<emphasis>--enable-hcache</emphasis> option. It's not turned on
-by default because external database libraries are required: one
-of tokyocabinet, qdbm, gdbm or bdb must be present.
+<emphasis>--enable-hcache</emphasis> option. It's not turned on by
+default because external database libraries are required: one of
+tokyocabinet, qdbm, gdbm or bdb must be present.
</para>
<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.
+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>
</sect2>
<para>
-In addition to caching message headers only, Mutt can also cache
-whole message bodies. This results in faster display of messages
-for POP and IMAP folders because messages usually have to be
-downloaded only once.
+In addition to caching message headers only, Mutt can also cache 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 <link linkend="message-cachedir"
->$message_cachedir</link> must point to a
-directory. There, Mutt will create a hierarchy of subdirectories
-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.
-All files can be removed as needed if the consumed disk space
-becomes an issue as Mutt will silently fetch missing items again.
+>$message_cachedir</link> must point to a directory. There, Mutt will
+create a hierarchy of subdirectories 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. All files can be removed
+as needed if the consumed disk space becomes an issue as Mutt will
+silently fetch missing items again.
</para>
</sect2>
</para>
<para>
-For body caches, Mutt can keep the local cache in sync with 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
-clients or instances of Mutt using a different body cache location
-delete messages (Mutt itself removes deleted messages from the cache
-when syncing a mailbox). As cleaning can take a noticeable amount of time,
-it should not be set in general but only occasionally.
+For body caches, Mutt can keep the local cache in sync with 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 clients
+or instances of Mutt using a different body cache location delete
+messages (Mutt itself removes deleted messages from the cache when
+syncing a mailbox). As cleaning can take a noticeable amount of time, it
+should not be set in general but only occasionally.
</para>
</sect2>
<title>Exact Address Generation</title>
<para>
-Mutt supports the <quote>Name <user@host></quote> address syntax for reading and
-writing messages, the older <quote>user@host (Name)</quote> syntax is only supported when
-reading 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
-<literal>mutt -v</literal> indicates whether it's supported.
+Mutt supports the <quote>Name <user@host></quote> address syntax
+for reading and writing messages, the older <quote>user@host
+(Name)</quote> syntax is only supported when reading 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 <literal>mutt
+-v</literal> indicates whether it's supported.
</para>
</sect1>
</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.
+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
-<literal><chain-next></literal> functions, which are by default 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 <literal><insert></literal> function. To append a remailer behind
-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 <literal>Return</literal> key.
+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
+<literal>l</literal> keys (think vi keyboard bindings). To insert a
+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 <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 <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
-<link linkend="mix-entry-format">$mix_entry_format</link>). Most 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 look at the mixmaster documentation.
+Note that different remailers do have different capabilities, 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
+<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 look at the mixmaster documentation.
</para>
</sect1>
with every message sent. In a longer running mutt session, others can
make assumptions about your mailing habbits depending on the number of
messages sent. If this is not desired, the header can be manually
-provided using <link
-linkend="edit-headers">$edit_headers</link> (though not
-recommended).
+provided using <link linkend="edit-headers">$edit_headers</link> (though
+not recommended).
</para>
</sect2>
<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
-<link linkend="header-caching">header caching</link>.
+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 <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 <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.
+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
-<link linkend="read-inc">$read_inc</link>
-may be too low. It can be tuned on on a folder-basis using
-<link linkend="folder-hook"><command>folder-hook</command>s</link>:
+For example, when opening a maildir folder with a few thousand 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 <link
+linkend="folder-hook"><command>folder-hook</command>s</link>:
</para>
<screen>
</listitem>
</orderedlist>
-<para>These settings work on a per-message basis. However, as messages may
-greatly differ in size and certain operations are much faster than others,
-even per-folder settings of the increment variables may not be
+<para>
+These settings work on a per-message basis. However, as messages may
+greatly differ in size and certain operations are much faster than
+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
-<link linkend="time-inc">$time_inc</link> variable.</para>
+Thus, Mutt allows to limit the number of progress updates per second
+it'll actually send to the terminal using the <link
+linkend="time-inc">$time_inc</link> variable.
+</para>
</sect1>
<title>Reading Messages from Remote Folders</title>
<para>
-Reading messages from remote folders such as IMAP an POP can be
-slow especially for large mailboxes since Mutt only caches a very
-limited number of recently viewed messages (usually 10) per
-session (so that it will be gone for the next session.)
+Reading messages from remote folders such as IMAP an POP can be slow
+especially for large mailboxes since Mutt only caches a very limited
+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
-<link linkend="body-caching">body caching</link> for details.
+To improve performance and permanently cache whole messages, please
+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
+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 <quote>=</quote> for string searches.
+<quote>~</quote> and with <quote>=</quote> for string searches.
</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
-<literal>#Luser@</literal>. This is especially true for searching
+<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 makes
Mutt perform a case-insensitive search except for IMAP (because for IMAP
-Mutt performs server-side searches which don't support case-insensivity).
+Mutt performs server-side searches which don't support
+case-insensivity).
</para>
</sect1>
<title>Command-Line Options</title>
<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.
+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>
<table id="tab-commandline-options">
</cmdsynopsis>
<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,
+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>
+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 <quote>data set for run #2</quote>. In the body of the message will be the contents
-of the file <quote>#/run2.dat</quote>.
+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 <quote>~/run2.dat</quote>.
</para>
<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 <quote>--</quote> to separate files and
-recipient addresses:
+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 <quote>--</quote> to separate files and recipient
+addresses:
</para>
<screen>
projects / mutt / commitdiff