···13131414<abstract>
1515<para>
1616-<quote>All mail clients suck. This one just sucks less.</quote> — me, circa 1995
1616+<quote>All mail clients suck. This one just sucks less.</quote> —
1717+me, circa 1995
1718</para>
1819</abstract>
1920</bookinfo>
···2223<title>Introduction</title>
23242425<para>
2525-<emphasis role="bold">Mutt</emphasis> is a small but very powerful text-based MIME mail client. Mutt is
2626-highly configurable, and is well suited to the mail power user with advanced
2727-features like key bindings, keyboard macros, mail threading, regular
2828-expression searches and a powerful pattern matching language for selecting
2929-groups of messages.
2626+<emphasis role="bold">Mutt</emphasis> is a small but very powerful
2727+text-based MIME mail client. Mutt is highly configurable, and is well
2828+suited to the mail power user with advanced features like key bindings,
2929+keyboard macros, mail threading, regular expression searches and a
3030+powerful pattern matching language for selecting groups of messages.
3031</para>
31323233<sect1 id="homepage">
···4344<title>Mailing Lists</title>
44454546<para>
4646-To subscribe to one of the following mailing lists, send a message with the
4747-word <emphasis>subscribe</emphasis> in the body to
4747+To subscribe to one of the following mailing lists, send a message with
4848+the word <emphasis>subscribe</emphasis> in the body to
4849<literal>list-name</literal><emphasis>-request</emphasis><literal>@mutt.org</literal>.
4950</para>
5051···5253<listitem>
53545455<para>
5555-<email>mutt-announce-request@mutt.org</email> -- low traffic list for announcements
5656+<email>mutt-announce-request@mutt.org</email> — low traffic list for
5757+announcements
5658</para>
5759</listitem>
5860<listitem>
59616062<para>
6161-<email>mutt-users-request@mutt.org</email> -- help, bug reports and feature requests
6363+<email>mutt-users-request@mutt.org</email> — help, bug reports and
6464+feature requests
6265</para>
6366</listitem>
6467<listitem>
65686669<para>
6767-<email>mutt-dev-request@mutt.org</email> -- development mailing list
7070+<email>mutt-dev-request@mutt.org</email> — development mailing list
6871</para>
6972</listitem>
7073···8588<title>Getting Mutt</title>
86898790<para>
8888-Mutt releases can be downloaded from
8989-<ulink url="ftp://ftp.mutt.org/mutt/">ftp://ftp.mutt.org/mutt/</ulink>.
9090-For a list of mirror sites, please refer to
9191-<ulink url="http://www.mutt.org/download.html">http://www.mutt.org/download.html</ulink>.
9191+Mutt releases can be downloaded from <ulink
9292+url="ftp://ftp.mutt.org/mutt/">ftp://ftp.mutt.org/mutt/</ulink>. For a
9393+list of mirror sites, please refer to <ulink
9494+url="http://www.mutt.org/download.html">http://www.mutt.org/download.html</ulink>.
9295</para>
93969497<para>
···225228</para>
226229227230<para>
228228-This program is free software; you can redistribute it and/or modify
229229-it under the terms of the GNU General Public License as published by
230230-the Free Software Foundation; either version 2 of the License, or
231231-(at your option) any later version.
231231+This program is free software; you can redistribute it and/or modify it
232232+under the terms of the GNU General Public License as published by the
233233+Free Software Foundation; either version 2 of the License, or (at your
234234+option) any later version.
232235</para>
233236234237<para>
235235-This program is distributed in the hope that it will be useful,
236236-but WITHOUT ANY WARRANTY; without even the implied warranty of
237237-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
238238-GNU General Public License for more details.
238238+This program is distributed in the hope that it will be useful, but
239239+WITHOUT ANY WARRANTY; without even the implied warranty of
240240+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
241241+General Public License for more details.
239242</para>
240243241244<para>
242242-You should have received a copy of the GNU General Public License
243243-along with this program; if not, write to the Free Software
244244-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
245245+You should have received a copy of the GNU General Public License along
246246+with this program; if not, write to the Free Software Foundation, Inc.,
247247+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
245248</para>
246249247250</sect1>
···252255<title>Getting Started</title>
253256254257<para>
255255-This section is intended as a brief overview of how to use Mutt. There are
256256-many other features which are described elsewhere in the manual. There
257257-is even more information available in the Mutt FAQ and various web
258258-pages. See the <ulink url="http://www.mutt.org/">Mutt homepage</ulink> for more details.
258258+This section is intended as a brief overview of how to use Mutt. There
259259+are many other features which are described elsewhere in the manual.
260260+There is even more information available in the Mutt FAQ and various web
261261+pages. See the <ulink url="http://www.mutt.org/">Mutt homepage</ulink>
262262+for more details.
259263</para>
260264261265<para>
262262-The keybindings described in this section are the defaults as distributed.
263263-Your local system administrator may have altered the defaults for your site.
264264-You can always type <quote>?</quote> in any menu to display the current bindings.
266266+The keybindings described in this section are the defaults as
267267+distributed. Your local system administrator may have altered the
268268+defaults for your site. You can always type <quote>?</quote> in any
269269+menu to display the current bindings.
265270</para>
266271267272<para>
268268-The first thing you need to do is invoke Mutt, simply by typing <literal>mutt</literal>
269269-at the command line. There are various command-line options, see
270270-either the Mutt man page or the <link linkend="commandline">reference</link>.
273273+The first thing you need to do is invoke Mutt, simply by typing
274274+<literal>mutt</literal> at the command line. There are various
275275+command-line options, see either the Mutt man page or the <link
276276+linkend="commandline">reference</link>.
271277</para>
272278273279<sect1 id="core-concepts">
···276282<para>
277283Mutt is a text-based application which interacts with users through
278284different menus which are mostly line-/entry-based or page-based. A
279279-line-based menu is the so-called <quote>index</quote> menu (listing all messages of
280280-the currently opened folder) or the <quote>alias</quote> menu (allowing you to
281281-select recipients from a list). Examples for page-based menus are the
282282-<quote>pager</quote> (showing one message at a time) or the <quote>help</quote> menu listing
283283-all available key bindings.
285285+line-based menu is the so-called <quote>index</quote> menu (listing all
286286+messages of the currently opened folder) or the <quote>alias</quote>
287287+menu (allowing you to select recipients from a list). Examples for
288288+page-based menus are the <quote>pager</quote> (showing one message at a
289289+time) or the <quote>help</quote> menu listing all available key
290290+bindings.
284291</para>
285292286293<para>
···300307301308<para>
302309Because Mutt allows for customizing almost all key bindings, there are
303303-so-called <quote>functions</quote> which can be executed manually (using the
304304-command line) or in macros. Macros allow the user to bind a sequence of
305305-commands to a single key or a short key sequence instead of repeating a
306306-sequence of actions over and over.
310310+so-called <quote>functions</quote> which can be executed manually (using
311311+the command line) or in macros. Macros allow the user to bind a sequence
312312+of commands to a single key or a short key sequence instead of repeating
313313+a sequence of actions over and over.
307314</para>
308315309316<para>
310317Many commands (such as saving or copying a message to another folder)
311318can be applied to a single message or a set of messages (so-called
312312-<quote>tagged</quote> messages). To help selecting messages, Mutt provides a rich
313313-set of message patterns (such as recipients, sender, body contents, date
314314-sent/received, etc.) which can be combined into complex expressions
315315-using the boolean <emphasis>and</emphasis> and <emphasis>or</emphasis>
316316-operations as well as negating. These patterns can also be used to (for
317317-example) search for messages or to limit the index to show only matching
318318-messages.
319319+<quote>tagged</quote> messages). To help selecting messages, Mutt
320320+provides a rich set of message patterns (such as recipients, sender,
321321+body contents, date sent/received, etc.) which can be combined into
322322+complex expressions using the boolean <emphasis>and</emphasis> and
323323+<emphasis>or</emphasis> operations as well as negating. These patterns
324324+can also be used to (for example) search for messages or to limit the
325325+index to show only matching messages.
319326</para>
320327321328<para>
322322-Mutt supports a <quote>hook</quote> concept which allows the user to execute
323323-arbitrary configuration commands and functions in certain situations
324324-such as entering a folder, starting a new message or replying to an
325325-existing one. These hooks can be used to highly customize Mutt's
329329+Mutt supports a <quote>hook</quote> concept which allows the user to
330330+execute arbitrary configuration commands and functions in certain
331331+situations such as entering a folder, starting a new message or replying
332332+to an existing one. These hooks can be used to highly customize Mutt's
326333behaviour including managing multiple identities, customizing the
327334display for a folder or even implementing auto-archiving based on a
328335per-folder basis and much more.
···465472466473<para>
467474The most important navigation keys common to line- or entry-based menus
468468-are shown in <xref linkend="tab-keys-nav-line"/> and in
469469-<xref linkend="tab-keys-nav-page"/> for page-based menus.
475475+are shown in <xref linkend="tab-keys-nav-line"/> and in <xref
476476+linkend="tab-keys-nav-page"/> for page-based menus.
470477</para>
471478472479<table id="tab-keys-nav-line">
···514521<title>Introduction</title>
515522516523<para>
517517-Mutt has a built-in line editor for inputting text, e.g. email
518518-addresses or filenames. The keys used to manipulate text input are
519519-very similar to those of Emacs. See <xref linkend="tab-keys-editor"/> for a full
520520-reference of available functions, their default key bindings, and
521521-short descriptions.
524524+Mutt has a built-in line editor for inputting text, e.g. email addresses
525525+or filenames. The keys used to manipulate text input are very similar to
526526+those of Emacs. See <xref linkend="tab-keys-editor"/> for a full
527527+reference of available functions, their default key bindings, and short
528528+descriptions.
522529</para>
523530524531<table id="tab-keys-editor">
···555562</table>
556563557564<para>
558558-You can remap the <emphasis>editor</emphasis> functions using the
559559-<link linkend="bind"><command>bind</command></link> command. For example, to make
560560-the <Delete> key delete the character in front of
561561-the cursor rather than under, you could use:
565565+You can remap the <emphasis>editor</emphasis> functions using the <link
566566+linkend="bind"><command>bind</command></link> command. For example, to
567567+make the <Delete> key delete the character in front of the cursor
568568+rather than under, you could use:
562569</para>
563570564571<screen>
···572579573580<para>
574581Mutt maintains a history for the built-in editor. The number of items
575575-is controlled by the <link linkend="history">$history</link>
576576-variable and can be made persistent using an external file specified
577577-using <link linkend="history-file">$history_file</link>.
578578-You may cycle through them at an editor prompt by using the
579579-<literal><history-up></literal> and/or
580580-<literal><history-down></literal> commands. But notice that Mutt
581581-does not remember the currently entered text, it only cycles through
582582-history and wraps around at the end or beginning.
582582+is controlled by the <link linkend="history">$history</link> variable
583583+and can be made persistent using an external file specified using <link
584584+linkend="history-file">$history_file</link>. You may cycle through them
585585+at an editor prompt by using the <literal><history-up></literal>
586586+and/or <literal><history-down></literal> commands. But notice that
587587+Mutt does not remember the currently entered text, it only cycles
588588+through history and wraps around at the end or beginning.
583589</para>
584590585591<para>
···597603</itemizedlist>
598604599605<para>
600600-Mutt automatically filters out consecutively repeated items from the history. It
601601-also mimics the behavior of some shells by ignoring items starting
602602-with a space. The latter feature can be useful in macros to not clobber
603603-the history's valuable entries with unwanted entries.
606606+Mutt automatically filters out consecutively repeated items from the
607607+history. It also mimics the behavior of some shells by ignoring items
608608+starting with a space. The latter feature can be useful in macros to not
609609+clobber the history's valuable entries with unwanted entries.
604610</para>
605611606612</sect2>
···613619<para>
614620Similar to many other mail clients, there are two modes in which mail is
615621read in Mutt. The first is a list of messages in the mailbox, which is
616616-called the <quote>index</quote> menu in Mutt. The second mode is the display of the
617617-message contents. This is called the <quote>pager.</quote>
622622+called the <quote>index</quote> menu in Mutt. The second mode is the
623623+display of the message contents. This is called the
624624+<quote>pager.</quote>
618625</para>
619626620627<para>
···628635<para>
629636Common keys used to navigate through and manage messages in the index
630637are shown in <xref linkend="tab-key-index"/>. How messages are presented
631631-in the index menu can be customized using the
632632-<link linkend="index-format">$index_format</link> variable.
638638+in the index menu can be customized using the <link
639639+linkend="index-format">$index_format</link> variable.
633640</para>
634641635642<table id="tab-key-index">
···675682<para>
676683In addition to who sent the message and the subject, a short summary of
677684the disposition of each message is printed beside the message number.
678678-Zero or more of the <quote>flags</quote> in <xref linkend="tab-msg-status-flags"/>
679679-may appear, some of which can be turned on or off using these functions:
680680-<literal><set-flag></literal> and
681681-<literal><clear-flag></literal>
682682-bound by default to <quote>w</quote> and <quote>W</quote> respectively.
685685+Zero or more of the <quote>flags</quote> in <xref
686686+linkend="tab-msg-status-flags"/> may appear, some of which can be turned
687687+on or off using these functions: <literal><set-flag></literal> and
688688+<literal><clear-flag></literal> bound by default to
689689+<quote>w</quote> and <quote>W</quote> respectively.
683690</para>
684691685692<para>
686693Furthermore, the flags in <xref linkend="tab-msg-recip-flags"/> reflect
687687-who the message is addressed to. They can be customized with the
688688-<link linkend="to-chars">$to_chars</link> variable.
694694+who the message is addressed to. They can be customized with the <link
695695+linkend="to-chars">$to_chars</link> variable.
689696</para>
690697691698<table id="tab-msg-status-flags">
···734741<para>
735742By default, Mutt uses its builtin pager to display the contents of
736743messages (an external pager such as <literal>less(1)</literal> can be
737737-configured, see <link linkend="pager">$pager</link> variable).
738738-The pager is very similar to the Unix program <literal>less(1)</literal>
744744+configured, see <link linkend="pager">$pager</link> variable). The
745745+pager is very similar to the Unix program <literal>less(1)</literal>
739746though not nearly as featureful.
740747</para>
741748···762769</table>
763770764771<para>
765765-In addition to key bindings in <xref linkend="tab-key-pager"/>,
766766-many of the functions from the index menu are also available in
767767-the pager, such as <literal><delete-message></literal> or <literal><copy-message></literal>
768768-(this is one advantage over using an external pager to view messages).
772772+In addition to key bindings in <xref linkend="tab-key-pager"/>, many of
773773+the functions from the index menu are also available in the pager, such
774774+as <literal><delete-message></literal> or
775775+<literal><copy-message></literal> (this is one advantage over
776776+using an external pager to view messages).
769777</para>
770778771779<para>
772780Also, the internal pager supports a couple other advanced features. For
773773-one, it will accept and translate the <quote>standard</quote> nroff sequences for
774774-bold and underline. These sequences are a series of either the letter,
775775-backspace (<quote>^H</quote>), the letter again for bold or the letter, backspace,
776776-<quote>_</quote> for denoting underline. Mutt will attempt to display these
777777-in bold and underline respectively if your terminal supports them. If
778778-not, you can use the bold and underline <link linkend="color">color</link>
779779-objects to specify a <command>color</command> or mono attribute for them.
781781+one, it will accept and translate the <quote>standard</quote> nroff
782782+sequences for bold and underline. These sequences are a series of either
783783+the letter, backspace (<quote>^H</quote>), the letter again for bold or
784784+the letter, backspace, <quote>_</quote> for denoting underline. Mutt
785785+will attempt to display these in bold and underline respectively if your
786786+terminal supports them. If not, you can use the bold and underline <link
787787+linkend="color">color</link> objects to specify a
788788+<command>color</command> or mono attribute for them.
780789</para>
781790782791<para>
···790799</screen>
791800792801<para>
793793-where <emphasis>Ps</emphasis> can be one of the codes shown in
794794-<xref linkend="tab-ansi-esc"/>.
802802+where <emphasis>Ps</emphasis> can be one of the codes shown in <xref
803803+linkend="tab-ansi-esc"/>.
795804</para>
796805797806<table id="tab-ansi-esc">
···833842834843<para>
835844Mutt uses these attributes for handling <literal>text/enriched</literal>
836836-messages, and they can also be used by an external
837837-<link linkend="auto-view">autoview</link> script for highlighting
838838-purposes.
845845+messages, and they can also be used by an external <link
846846+linkend="auto-view">autoview</link> script for highlighting purposes.
839847</para>
840848841849<note>
842850<para>
843843-If you change the colors for your
844844-display, for example by changing the color associated with color2 for
845845-your xterm, then that color will be used instead of green.
851851+If you change the colors for your display, for example by changing the
852852+color associated with color2 for your xterm, then that color will be
853853+used instead of green.
846854</para>
847855</note>
848856849857<note>
850858<para>
851859Note that the search commands in the pager take regular expressions,
852852-which are not quite the same as the more
853853-complex <link linkend="patterns">patterns</link> used by the search
854854-command in the index. This is because patterns are used to select messages by
855855-criteria whereas the pager already displays a selected message.
860860+which are not quite the same as the more complex <link
861861+linkend="patterns">patterns</link> used by the search command in the
862862+index. This is because patterns are used to select messages by criteria
863863+whereas the pager already displays a selected message.
856864</para>
857865</note>
858866···902910</table>
903911904912<para>
905905-Collapsing a thread displays only the first message
906906-in the thread and hides the others. This is useful when threads
907907-contain so many messages that you can only see a handful of threads on
908908-the screen. See %M in <link linkend="index-format">$index_format</link>.
909909-For example, you could use <quote>%?M?(#%03M)&(%4l)?</quote> in <link linkend="index-format">$index_format</link> to optionally
910910-display the number of hidden messages if the thread is
911911-collapsed. The <literal>%?<char>?<if-part>&<else-part>?</literal>
912912-syntax is explained in detail in
913913-<link linkend="formatstrings-conditionals">format string conditionals</link>.
913913+Collapsing a thread displays only the first message in the thread and
914914+hides the others. This is useful when threads contain so many messages
915915+that you can only see a handful of threads on the screen. See %M in
916916+<link linkend="index-format">$index_format</link>. For example, you
917917+could use <quote>%?M?(#%03M)&(%4l)?</quote> in <link
918918+linkend="index-format">$index_format</link> to optionally display the
919919+number of hidden messages if the thread is collapsed. The
920920+<literal>%?<char>?<if-part>&<else-part>?</literal>
921921+syntax is explained in detail in <link
922922+linkend="formatstrings-conditionals">format string conditionals</link>.
914923</para>
915924916925<para>
917926Technically, every reply should contain a list of its parent messages in
918927the thread tree, but not all do. In these cases, Mutt groups them by
919919-subject which can be controlled using the
920920-<link linkend="strict-threads">$strict_threads</link> variable.
928928+subject which can be controlled using the <link
929929+linkend="strict-threads">$strict_threads</link> variable.
921930</para>
922931923932</sect2>
···926935<title>Miscellaneous Functions</title>
927936928937<para>
929929-In addition, the <emphasis>index</emphasis> and <emphasis>pager</emphasis>
930930-menus have these interesting functions:
938938+In addition, the <emphasis>index</emphasis> and
939939+<emphasis>pager</emphasis> menus have these interesting functions:
931940</para>
932941933942<variablelist>
934943935944<varlistentry>
936945<term>
937937-<literal><create-alias></literal><anchor id="create-alias"/> (default: a)
946946+<literal><create-alias></literal><anchor id="create-alias"/>
947947+(default: a)
938948</term>
939949<listitem>
940950<para>
941941-Creates a new alias based upon the current message (or prompts for a
942942-new one). Once editing is complete, an <link linkend="alias"><command>alias</command></link>
943943-command is added to the file specified by
944944-the <link linkend="alias-file">$alias_file</link> variable
945945-for future use
951951+Creates a new alias based upon the current message (or prompts for a new
952952+one). Once editing is complete, an <link
953953+linkend="alias"><command>alias</command></link> command is added to the
954954+file specified by the <link linkend="alias-file">$alias_file</link>
955955+variable for future use
946956</para>
947957948958<note>
949959<para>
950960Mutt does not read the <link linkend="alias-file">$alias_file</link>
951951-upon startup so you must explicitly <link linkend="source"><command>source</command></link> the file.
961961+upon startup so you must explicitly <link
962962+linkend="source"><command>source</command></link> the file.
952963</para>
953964</note>
954965</listitem>
···956967957968<varlistentry>
958969<term>
959959-<literal><check-traditional-pgp></literal><anchor id="check-traditional-pgp"/> (default: Esc P)
970970+<literal><check-traditional-pgp></literal><anchor
971971+id="check-traditional-pgp"/> (default: Esc P)
960972</term>
961973<listitem>
962974<para>
963975This function will search the current message for content signed or
964964-encrypted with PGP the <quote>traditional</quote> way, that is, without proper
965965-MIME tagging. Technically, this function will temporarily change
966966-the MIME content types of the body parts containing PGP data; this
967967-is similar to the <link linkend="edit-type"><literal><edit-type></literal></link> function's
968968-effect.
976976+encrypted with PGP the <quote>traditional</quote> way, that is, without
977977+proper MIME tagging. Technically, this function will temporarily change
978978+the MIME content types of the body parts containing PGP data; this is
979979+similar to the <link
980980+linkend="edit-type"><literal><edit-type></literal></link>
981981+function's effect.
969982</para>
970983</listitem>
971984</varlistentry>
···976989</term>
977990<listitem>
978991<para>
979979-This command (available in the index and pager) allows you to
980980-edit the raw current message as it's present in the mail folder.
981981-After you have finished editing, the changed message will be
982982-appended to the current folder, and the original message will be
983983-marked for deletion; if the message is unchanged it won't be replaced.
992992+This command (available in the index and pager) allows you to edit the
993993+raw current message as it's present in the mail folder. After you have
994994+finished editing, the changed message will be appended to the current
995995+folder, and the original message will be marked for deletion; if the
996996+message is unchanged it won't be replaced.
984997</para>
985998</listitem>
986999</varlistentry>
···9881001<varlistentry>
9891002<term>
9901003<literal><edit-type></literal><anchor id="edit-type"/> (default:
991991-^E on the attachment menu, and in the pager and index menus;
992992-^T on the compose menu)
10041004+^E on the attachment menu, and in the pager and index menus; ^T on the
10051005+compose menu)
9931006</term>
9941007<listitem>
9951008<para>
996996-This command is used to temporarily edit an attachment's content
997997-type to fix, for instance, bogus character set parameters. When
998998-invoked from the index or from the pager, you'll have the
999999-opportunity to edit the top-level attachment's content type. On the
10001000-<link linkend="attach-menu">attachment menu</link>, you can change any
10091009+This command is used to temporarily edit an attachment's content type to
10101010+fix, for instance, bogus character set parameters. When invoked from
10111011+the index or from the pager, you'll have the opportunity to edit the
10121012+top-level attachment's content type. On the <link
10131013+linkend="attach-menu">attachment menu</link>, you can change any
10011014attachment's content type. These changes are not persistent, and get
10021015lost upon changing folders.
10031016</para>
1004101710051018<para>
10061006-Note that this command is also available on the <link linkend="compose-menu">compose
10071007-menu</link>. There, it's used to fine-tune the properties of attachments you are going
10081008-to send.
10191019+Note that this command is also available on the <link
10201020+linkend="compose-menu">compose menu</link>. There, it's used to
10211021+fine-tune the properties of attachments you are going to send.
10091022</para>
10101023</listitem>
10111024</varlistentry>
1012102510131026<varlistentry>
10141027<term>
10151015-<literal><enter-command></literal><anchor id="enter-command"/> (default: <quote>:</quote>)
10281028+<literal><enter-command></literal><anchor id="enter-command"/>
10291029+(default: <quote>:</quote>)
10161030</term>
10171031<listitem>
10181032<para>
10191033This command is used to execute any command you would normally put in a
10201020-configuration file. A common use is to check the settings of variables, or
10211021-in conjunction with <link linkend="macro">macros</link> to change settings on the
10221022-fly.
10341034+configuration file. A common use is to check the settings of variables,
10351035+or in conjunction with <link linkend="macro">macros</link> to change
10361036+settings on the fly.
10231037</para>
10241038</listitem>
10251039</varlistentry>
1026104010271041<varlistentry>
10281042<term>
10291029-<literal><extract-keys></literal><anchor id="extract-keys"/> (default: ^K)
10431043+<literal><extract-keys></literal><anchor id="extract-keys"/>
10441044+(default: ^K)
10301045</term>
10311046<listitem>
10321047<para>
···1038105310391054<varlistentry>
10401055<term>
10411041-<literal><forget-passphrase></literal><anchor id="forget-passphrase"/> (default:
10421042-^F)
10561056+<literal><forget-passphrase></literal><anchor
10571057+id="forget-passphrase"/> (default: ^F)
10431058</term>
10441059<listitem>
10451060<para>
10461046-This command wipes the passphrase(s) from memory. It is useful, if
10471047-you misspelled the passphrase.
10611061+This command wipes the passphrase(s) from memory. It is useful, if you
10621062+misspelled the passphrase.
10481063</para>
10491064</listitem>
10501065</varlistentry>
1051106610521067<varlistentry>
10531068<term>
10541054-<literal><list-reply></literal><anchor id="list-reply"/> (default: L)
10691069+<literal><list-reply></literal><anchor id="list-reply"/> (default:
10701070+L)
10551071</term>
10561072<listitem>
10571073<para>
10581058-Reply to the current or tagged message(s) by extracting any addresses which
10591059-match the regular expressions given by the <link linkend="lists"><command>lists</command> or <command>subscribe</command></link>
10601060-commands, but also honor any <literal>Mail-Followup-To</literal> header(s) if the
10611061-<link linkend="honor-followup-to">$honor_followup_to</link>
10621062-configuration variable is set. Using this when replying to messages posted
10631063-to mailing lists helps avoid duplicate copies being sent to the author of
10641064-the message you are replying to.
10741074+Reply to the current or tagged message(s) by extracting any addresses
10751075+which match the regular expressions given by the <link
10761076+linkend="lists"><command>lists</command> or
10771077+<command>subscribe</command></link> commands, but also honor any
10781078+<literal>Mail-Followup-To</literal> header(s) if the <link
10791079+linkend="honor-followup-to">$honor_followup_to</link> configuration
10801080+variable is set. Using this when replying to messages posted to mailing
10811081+lists helps avoid duplicate copies being sent to the author of the
10821082+message you are replying to.
10651083</para>
10661084</listitem>
10671085</varlistentry>
1068108610691087<varlistentry>
10701088<term>
10711071-<literal><pipe-message></literal><anchor id="pipe-message"/> (default: |)
10891089+<literal><pipe-message></literal><anchor id="pipe-message"/>
10901090+(default: |)
10721091</term>
10731092<listitem>
10741093<para>
10751075-Asks for an external Unix command and pipes the current or
10761076-tagged message(s) to it. The variables <link linkend="pipe-decode">$pipe_decode</link>, <link linkend="pipe-split">$pipe_split</link>,
10771077-<link linkend="pipe-sep">$pipe_sep</link> and <link linkend="wait-key">$wait_key</link> control the exact behavior of this function.
10941094+Asks for an external Unix command and pipes the current or tagged
10951095+message(s) to it. The variables <link
10961096+linkend="pipe-decode">$pipe_decode</link>, <link
10971097+linkend="pipe-split">$pipe_split</link>, <link
10981098+linkend="pipe-sep">$pipe_sep</link> and <link
10991099+linkend="wait-key">$wait_key</link> control the exact behavior of this
11001100+function.
10781101</para>
10791102</listitem>
10801103</varlistentry>
1081110410821105<varlistentry>
10831106<term>
10841084-<literal><resend-message></literal><anchor id="resend-message"/> (default: Esc e)
11071107+<literal><resend-message></literal><anchor id="resend-message"/>
11081108+(default: Esc e)
10851109</term>
10861110<listitem>
10871111<para>
10881088-Mutt takes the current message as a template for a
10891089-new message. This function is best described as "recall from arbitrary
10901090-folders". It can conveniently be used to forward MIME messages while
10911091-preserving the original mail structure. Note that the amount of headers
10921092-included here depends on the value of the <link linkend="weed">$weed</link>
10931093-variable.
11121112+Mutt takes the current message as a template for a new message. This
11131113+function is best described as "recall from arbitrary folders". It can
11141114+conveniently be used to forward MIME messages while preserving the
11151115+original mail structure. Note that the amount of headers included here
11161116+depends on the value of the <link linkend="weed">$weed</link> variable.
10941117</para>
1095111810961119<para>
10971097-This function is also available from the attachment menu. You can use this
10981098-to easily resend a message which was included with a bounce message
11201120+This function is also available from the attachment menu. You can use
11211121+this to easily resend a message which was included with a bounce message
10991122as a <literal>message/rfc822</literal> body part.
11001123</para>
11011124</listitem>
···1103112611041127<varlistentry>
11051128<term>
11061106-<literal><shell-escape></literal><anchor id="shell-escape"/> (default: !)
11291129+<literal><shell-escape></literal><anchor id="shell-escape"/>
11301130+(default: !)
11071131</term>
11081132<listitem>
11091133<para>
11101110-Asks for an external Unix command and executes it. The <link linkend="wait-key">$wait_key</link> can be used to control
11111111-whether Mutt will wait for a key to be pressed when the command returns
11121112-(presumably to let the user read the output of the command), based on
11131113-the return status of the named command. If no command is given, an
11141114-interactive shell is executed.
11341134+Asks for an external Unix command and executes it. The <link
11351135+linkend="wait-key">$wait_key</link> can be used to control whether Mutt
11361136+will wait for a key to be pressed when the command returns (presumably
11371137+to let the user read the output of the command), based on the return
11381138+status of the named command. If no command is given, an interactive
11391139+shell is executed.
11151140</para>
11161141</listitem>
11171142</varlistentry>
1118114311191144<varlistentry>
11201145<term>
11211121-<literal><toggle-quoted></literal><anchor id="toggle-quoted"/> (default: T)
11461146+<literal><toggle-quoted></literal><anchor id="toggle-quoted"/>
11471147+(default: T)
11221148</term>
11231149<listitem>
11241150<para>
11251125-The pager uses the <link linkend="quote-regexp">$quote_regexp</link> variable to detect quoted text when
11261126-displaying the body of the message. This function toggles the display
11271127-of the quoted material in the message. It is particularly useful when
11281128-being interested in just the response and there is a large amount of
11291129-quoted text in the way.
11511151+The pager uses the <link linkend="quote-regexp">$quote_regexp</link>
11521152+variable to detect quoted text when displaying the body of the message.
11531153+This function toggles the display of the quoted material in the message.
11541154+It is particularly useful when being interested in just the response and
11551155+there is a large amount of quoted text in the way.
11301156</para>
11311157</listitem>
11321158</varlistentry>
1133115911341160<varlistentry>
11351161<term>
11361136-<literal><skip-quoted></literal><anchor id="skip-quoted"/> (default: S)
11621162+<literal><skip-quoted></literal><anchor id="skip-quoted"/>
11631163+(default: S)
11371164</term>
11381165<listitem>
11391166<para>
···11561183<title>Introduction</title>
1157118411581185<para>
11591159-The bindings shown in <xref linkend="tab-key-send"/> are available in the
11601160-<emphasis>index</emphasis> and <emphasis>pager</emphasis> to start a new message.
11861186+The bindings shown in <xref linkend="tab-key-send"/> are available in
11871187+the <emphasis>index</emphasis> and <emphasis>pager</emphasis> to start a
11881188+new message.
11611189</para>
1162119011631191<table id="tab-key-send">
···11791207</table>
1180120811811209<para>
11821182-<emphasis>Bouncing</emphasis> a message sends the message as-is to the recipient you
11831183-specify. <emphasis>Forwarding</emphasis> a message allows you to add comments or
11841184-modify the message you are forwarding. These items are discussed
11851185-in greater detail in the next section <quote><link linkend="forwarding-mail">Forwarding
11861186-and Bouncing Mail</link>.</quote>
12101210+<emphasis>Bouncing</emphasis> a message sends the message as-is to the
12111211+recipient you specify. <emphasis>Forwarding</emphasis> a message allows
12121212+you to add comments or modify the message you are forwarding. These
12131213+items are discussed in greater detail in the next section <quote><link
12141214+linkend="forwarding-mail">Forwarding and Bouncing Mail</link>.</quote>
11871215</para>
1188121611891217<para>
11901190-Mutt will then enter the <emphasis>compose</emphasis> menu and prompt you for the
11911191-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
11921192-you for the <quote>Subject:</quote> field for the message, providing a default if
11931193-you are replying to or forwarding a message. You again
11941194-have the chance to adjust recipients, subject, and security settings
11951195-right before actually sending the message. See also
11961196-<link linkend="askcc">$askcc</link>,
11971197-<link linkend="askbcc">$askbcc</link>,
11981198-<link linkend="autoedit">$autoedit</link>,
11991199-<link linkend="bounce">$bounce</link>,
12001200-<link linkend="fast-reply">$fast_reply</link>,
12011201-and <link linkend="include">$include</link>
12021202-for changing how and if Mutt asks these questions.
12181218+Mutt will then enter the <emphasis>compose</emphasis> menu and prompt
12191219+you for the recipients to place on the <quote>To:</quote> header field
12201220+when you hit <literal>m</literal> to start a new message. Next, it will
12211221+ask you for the <quote>Subject:</quote> field for the message, providing
12221222+a default if you are replying to or forwarding a message. You again have
12231223+the chance to adjust recipients, subject, and security settings right
12241224+before actually sending the message. See also <link
12251225+linkend="askcc">$askcc</link>, <link linkend="askbcc">$askbcc</link>,
12261226+<link linkend="autoedit">$autoedit</link>, <link
12271227+linkend="bounce">$bounce</link>, <link
12281228+linkend="fast-reply">$fast_reply</link>, and <link
12291229+linkend="include">$include</link> for changing how and if Mutt asks
12301230+these questions.
12031231</para>
1204123212051233<para>
···1239126712401268<para>
12411269After getting recipients for new messages, forwards or replies, Mutt
12421242-will then automatically start your <link
12431243-linkend="editor">$editor</link> on the message body. If the <link
12441244-linkend="edit-headers">$edit_headers</link> variable is
12451245-set, the headers will be at the top of the message in your editor. Any
12461246-messages you are replying to will be added in sort order to the message,
12471247-with appropriate <link linkend="attribution">$attribution</link>,
12481248-<link linkend="indent-string">$indent_string</link> and
12491249-<link
12501250-linkend="post-indent-string">$post_indent_string</link>.
12511251-When forwarding a message, if the <link
12521252-linkend="mime-forward">$mime_forward</link> variable is
12531253-unset, a copy of the forwarded message will be included. If you have
12541254-specified a <link linkend="signature">$signature</link>, it will
12551255-be appended to the message.
12701270+will then automatically start your <link linkend="editor">$editor</link>
12711271+on the message body. If the <link
12721272+linkend="edit-headers">$edit_headers</link> variable is set, the headers
12731273+will be at the top of the message in your editor. Any messages you are
12741274+replying to will be added in sort order to the message, with appropriate
12751275+<link linkend="attribution">$attribution</link>, <link
12761276+linkend="indent-string">$indent_string</link> and <link
12771277+linkend="post-indent-string">$post_indent_string</link>. When
12781278+forwarding a message, if the <link
12791279+linkend="mime-forward">$mime_forward</link> variable is unset, a copy of
12801280+the forwarded message will be included. If you have specified a <link
12811281+linkend="signature">$signature</link>, it will be appended to the
12821282+message.
12561283</para>
1257128412581285<para>
12591286Once you have finished editing the body of your mail message, you are
12601260-returned to the <emphasis>compose</emphasis> menu providing the functions
12611261-shown in <xref linkend="tab-func-compose"/> to modify, send or postpone the
12621262-message.
12871287+returned to the <emphasis>compose</emphasis> menu providing the
12881288+functions shown in <xref linkend="tab-func-compose"/> to modify, send or
12891289+postpone the message.
12631290</para>
1264129112651292<table id="tab-func-compose">
···12941321</table>
1295132212961323<para>
12971297-The compose menu is also used to edit the attachments for a message which can be either files
12981298-or other messages. The <literal><attach-message></literal> function to will prompt you for a folder to
12991299-attach messages from. You can now tag messages in that folder and they
13001300-will be attached to the message you are sending.
13241324+The compose menu is also used to edit the attachments for a message
13251325+which can be either files or other messages. The
13261326+<literal><attach-message></literal> function to will prompt you
13271327+for a folder to attach messages from. You can now tag messages in that
13281328+folder and they will be attached to the message you are sending.
13011329</para>
1302133013031331<note>
13041332<para>
13051305-Note that certain
13061306-operations like composing a new mail, replying, forwarding, etc. are
13071307-not permitted when you are in that folder. The %r in
13081308-<link linkend="status-format">$status_format</link> will change to
13091309-a <quote>A</quote> to indicate that you are in attach-message mode.
13331333+Note that certain operations like composing a new mail, replying,
13341334+forwarding, etc. are not permitted when you are in that folder. The %r
13351335+in <link linkend="status-format">$status_format</link> will change to a
13361336+<quote>A</quote> to indicate that you are in attach-message mode.
13101337</para>
13111338</note>
13121339···13161343<title>Editing the Message Header</title>
1317134413181345<para>
13191319-When editing the header because of <link linkend="edit-headers">$edit_headers</link>
13201320-being set, there are a several pseudo headers available which
13211321-will not be included in sent messages but trigger special Mutt behavior.
13461346+When editing the header because of <link
13471347+linkend="edit-headers">$edit_headers</link> being set, there are a
13481348+several pseudo headers available which will not be included in sent
13491349+messages but trigger special Mutt behavior.
13221350</para>
1323135113241352<sect3 id="fcc-header">
···13331361</para>
1334136213351363<para>
13361336-as a header, Mutt will pick up <emphasis>filename</emphasis>
13371337-just as if you had used the <literal><edit-fcc></literal> function in the <emphasis>compose</emphasis> menu.
13381338-It can later be changed from the compose menu.
13641364+as a header, Mutt will pick up <emphasis>filename</emphasis> just as if
13651365+you had used the <literal><edit-fcc></literal> function in the
13661366+<emphasis>compose</emphasis> menu. It can later be changed from the
13671367+compose menu.
13391368</para>
1340136913411370</sect3>
···13531382</para>
1354138313551384<para>
13561356-where <emphasis>filename</emphasis> is the file to attach and <emphasis>description</emphasis> is an
13571357-optional string to use as the description of the attached file. Spaces
13581358-in filenames have to be escaped using backslash (<quote>\</quote>).
13591359-The file can be removed as well as more added from the compose menu.
13851385+where <emphasis>filename</emphasis> is the file to attach and
13861386+<emphasis>description</emphasis> is an optional string to use as the
13871387+description of the attached file. Spaces in filenames have to be escaped
13881388+using backslash (<quote>\</quote>). The file can be removed as well as
13891389+more added from the compose menu.
13601390</para>
1361139113621392</sect3>
···13741404</para>
1375140513761406<para>
13771377-<quote>E</quote> selects encryption, <quote>S</quote> selects signing and
13781378-<quote>S<id></quote> selects signing with the given key, setting
13791379-<link linkend="pgp-sign-as">$pgp_sign_as</link>
13801380-permanently. The selection can later be changed in the compose menu.
14071407+<quote>E</quote> selects encryption, <quote>S</quote> selects signing
14081408+and <quote>S<id></quote> selects signing with the given key,
14091409+setting <link linkend="pgp-sign-as">$pgp_sign_as</link> permanently. The
14101410+selection can later be changed in the compose menu.
13811411</para>
1382141213831413</sect3>
···13861416<title>In-Reply-To: Header</title>
1387141713881418<para>
13891389-When replying to messages, the <emphasis>In-Reply-To:</emphasis> header contains the
13901390-Message-Id of the message(s) you reply to. If you remove or modify its value, Mutt will not generate a
13911391-<emphasis>References:</emphasis> field, which allows you to create a new message thread, for example
13921392-to create a new message to a mailing list without having to enter the mailing list's address.
14191419+When replying to messages, the <emphasis>In-Reply-To:</emphasis> header
14201420+contains the Message-Id of the message(s) you reply to. If you remove or
14211421+modify its value, Mutt will not generate a
14221422+<emphasis>References:</emphasis> field, which allows you to create a new
14231423+message thread, for example to create a new message to a mailing list
14241424+without having to enter the mailing list's address.
13931425</para>
1394142613951427</sect3>
···14001432<title>Sending Cryptographically Signed/Encrypted Messages</title>
1401143314021434<para>
14031403-If you have told Mutt to PGP or S/MIME encrypt a message, it will guide you
14041404-through a key selection process when you try to send the message.
14051405-Mutt will not ask you any questions about keys which have a
14061406-certified user ID matching one of the message recipients' mail
14071407-addresses. However, there may be situations in which there are
14081408-several keys, weakly certified user ID fields, or where no matching
14091409-keys can be found.
14351435+If you have told Mutt to PGP or S/MIME encrypt a message, it will guide
14361436+you through a key selection process when you try to send the message.
14371437+Mutt will not ask you any questions about keys which have a certified
14381438+user ID matching one of the message recipients' mail addresses.
14391439+However, there may be situations in which there are several keys, weakly
14401440+certified user ID fields, or where no matching keys can be found.
14101441</para>
1411144214121443<para>
14131444In these cases, you are dropped into a menu with a list of keys from
14141414-which you can select one. When you quit this menu, or Mutt can't
14151415-find any matching keys, you are prompted for a user ID. You can, as
14161416-usually, abort this prompt using <literal>^G</literal>. When you do so, Mutt will
14171417-return to the compose screen.
14451445+which you can select one. When you quit this menu, or Mutt can't find
14461446+any matching keys, you are prompted for a user ID. You can, as usually,
14471447+abort this prompt using <literal>^G</literal>. When you do so, Mutt
14481448+will return to the compose screen.
14181449</para>
1419145014201451<para>
14211421-Once you have successfully finished the key selection, the message
14221422-will be encrypted using the selected public keys when sent out.
14521452+Once you have successfully finished the key selection, the message will
14531453+be encrypted using the selected public keys when sent out.
14231454</para>
1424145514251456<para>
14261426-Most fields of the entries in the key selection menu (see also <link linkend="pgp-entry-format">$pgp_entry_format</link>)
14271427-have obvious meanings. But some explanations on the capabilities, flags,
14281428-and validity fields are in order.
14571457+Most fields of the entries in the key selection menu (see also <link
14581458+linkend="pgp-entry-format">$pgp_entry_format</link>) have obvious
14591459+meanings. But some explanations on the capabilities, flags, and
14601460+validity fields are in order.
14291461</para>
1430146214311463<para>
14321432-The flags sequence (<quote>%f</quote>) will expand to one of the flags in
14331433-<xref linkend="tab-pgp-menuflags"/>.
14641464+The flags sequence (<quote>%f</quote>) will expand to one of the flags
14651465+in <xref linkend="tab-pgp-menuflags"/>.
14341466</para>
1435146714361468<table id="tab-pgp-menuflags">
···14491481</table>
1450148214511483<para>
14521452-The capabilities field (<quote>%c</quote>) expands to a two-character sequence
14531453-representing a key's capabilities. The first character gives
14841484+The capabilities field (<quote>%c</quote>) expands to a two-character
14851485+sequence representing a key's capabilities. The first character gives
14541486the key's encryption capabilities: A minus sign (<quote>-</quote>) means
14551455-that the key cannot be used for encryption. A dot (<quote>.</quote>) means that
14561456-it's marked as a signature key in one of the user IDs, but may
14571457-also be used for encryption. The letter <quote>e</quote> indicates that
14581458-this key can be used for encryption.
14871487+that the key cannot be used for encryption. A dot (<quote>.</quote>)
14881488+means that it's marked as a signature key in one of the user IDs, but
14891489+may also be used for encryption. The letter <quote>e</quote> indicates
14901490+that this key can be used for encryption.
14591491</para>
1460149214611493<para>
14621494The second character indicates the key's signing capabilities. Once
14631463-again, a <quote>-</quote> implies <quote>not for signing</quote>, <quote>.</quote> implies
14641464-that the key is marked as an encryption key in one of the user-ids, and
14651465-<quote>s</quote> denotes a key which can be used for signing.
14951495+again, a <quote>-</quote> implies <quote>not for signing</quote>,
14961496+<quote>.</quote> implies that the key is marked as an encryption key in
14971497+one of the user-ids, and <quote>s</quote> denotes a key which can be
14981498+used for signing.
14661499</para>
1467150014681501<para>
14691469-Finally, the validity field (<quote>%t</quote>) indicates how well-certified a user-id
14701470-is. A question mark (<quote>?</quote>) indicates undefined validity, a minus
14711471-character (<quote>-</quote>) marks an untrusted association, a space character
14721472-means a partially trusted association, and a plus character (<quote>+</quote>)
14731473-indicates complete validity.
15021502+Finally, the validity field (<quote>%t</quote>) indicates how
15031503+well-certified a user-id is. A question mark (<quote>?</quote>)
15041504+indicates undefined validity, a minus character (<quote>-</quote>) marks
15051505+an untrusted association, a space character means a partially trusted
15061506+association, and a plus character (<quote>+</quote>) indicates complete
15071507+validity.
14741508</para>
1475150914761510</sect2>
···14821516<title>Concept</title>
1483151714841518<para>
14851485-<literal>format=flowed</literal>-style messages (or <literal>f=f</literal>
14861486-for short) are <literal>text/plain</literal> messages that consist of paragraphs which a receiver's
14871487-mail client may reformat to its own needs which mostly means to
14881488-customize line lengths regardless of what the sender sent. Technically this is
14891489-achieved by letting lines of a <quote>flowable</quote> paragraph end in spaces
15191519+<literal>format=flowed</literal>-style messages (or
15201520+<literal>f=f</literal> for short) are <literal>text/plain</literal>
15211521+messages that consist of paragraphs which a receiver's mail client may
15221522+reformat to its own needs which mostly means to customize line lengths
15231523+regardless of what the sender sent. Technically this is achieved by
15241524+letting lines of a <quote>flowable</quote> paragraph end in spaces
14901525except for the last line.
14911526</para>
14921527···15041539<para>
15051540Mutt only supports setting the required <literal>format=flowed</literal>
15061541MIME parameter on outgoing messages if the <link
15071507-linkend="text-flowed">$text_flowed</link>
15081508-variable is set, specifically it does not add the
15091509-trailing spaces.
15421542+linkend="text-flowed">$text_flowed</link> variable is set, specifically
15431543+it does not add the trailing spaces.
15101544</para>
1511154515121546<para>
15131513-After editing the initial message text and before entering
15141514-the compose menu, Mutt properly space-stuffes the message.
15471547+After editing the initial message text and before entering the compose
15481548+menu, Mutt properly space-stuffes the message.
15151549<emphasis>Space-stuffing</emphasis> is required by RfC3676 defining
15161550<literal>format=flowed</literal> and means to prepend a space to:
15171551</para>
1518155215191553<itemizedlist>
15201554<listitem><para>all lines starting with a space</para></listitem>
15211521-<listitem><para>lines starting with the word <quote><literal>From</literal></quote>
15221522-followed by space</para></listitem>
15231523-<listitem><para>all lines starting with <quote><literal>></literal></quote> which
15241524-is not intended to be a quote character</para></listitem>
15551555+<listitem><para>lines starting with the word
15561556+<quote><literal>From</literal></quote> followed by
15571557+space</para></listitem>
15581558+<listitem><para>all lines starting with
15591559+<quote><literal>></literal></quote> which is not intended to be a
15601560+quote character</para></listitem>
15251561</itemizedlist>
1526156215271563<note>
15281564<para>
15291529-Mutt only supports space-stuffing
15301530-for the first two types of lines but not for the third: It is impossible to
15311531-safely detect whether a leading <literal>></literal> character starts a
15321532-quote or not. Furthermore, Mutt only applies space-stuffing
15331533-<emphasis>once</emphasis> after the initial edit is finished.
15651565+Mutt only supports space-stuffing for the first two types of lines but
15661566+not for the third: It is impossible to safely detect whether a leading
15671567+<literal>></literal> character starts a quote or not. Furthermore,
15681568+Mutt only applies space-stuffing <emphasis>once</emphasis> after the
15691569+initial edit is finished.
15341570</para>
15351571</note>
1536157215371573<para>
15381538-All leading spaces are to be removed by receiving clients to restore
15391539-the original message prior to further processing.
15741574+All leading spaces are to be removed by receiving clients to restore the
15751575+original message prior to further processing.
15401576</para>
1541157715421578</sect3>
···15451581<title>Editor Considerations</title>
1546158215471583<para>
15481548-As Mutt provides no additional features to compose <literal>f=f</literal>
15491549-messages, it's completely up to the user and his editor to produce
15501550-proper messages. Please consider your editor's documentation if you
15511551-intend to send <literal>f=f</literal> messages.
15841584+As Mutt provides no additional features to compose
15851585+<literal>f=f</literal> messages, it's completely up to the user and his
15861586+editor to produce proper messages. Please consider your editor's
15871587+documentation if you intend to send <literal>f=f</literal> messages.
15521588</para>
1553158915541590<para>
···15771613Bouncing and forwarding let you send an existing message to recipients
15781614that you specify. Bouncing a message sends a verbatim copy of a message
15791615to alternative addresses as if they were the message's original
15801580-recipients specified in the Bcc header.
15811581-Forwarding a message, on the other hand, allows you to modify the message
15821582-before it is resent (for example, by adding your own comments). Bouncing
15831583-is done using the <literal><bounce></literal> function and forwarding
15841584-using the <literal><forward></literal> function bound to <quote>b</quote> and <quote>f</quote>
15851585-respectively.
16161616+recipients specified in the Bcc header. Forwarding a message, on the
16171617+other hand, allows you to modify the message before it is resent (for
16181618+example, by adding your own comments). Bouncing is done using the
16191619+<literal><bounce></literal> function and forwarding using the
16201620+<literal><forward></literal> function bound to <quote>b</quote>
16211621+and <quote>f</quote> respectively.
15861622</para>
1587162315881624<para>
15891625Forwarding can be done by including the original message in the new
15901590-message's body (surrounded by indicating lines) or including it as a MIME
15911591-attachment, depending on the value of the <link linkend="mime-forward">$mime_forward</link> variable. Decoding of attachments,
15921592-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,
16261626+message's body (surrounded by indicating lines) or including it as a
16271627+MIME attachment, depending on the value of the <link
16281628+linkend="mime-forward">$mime_forward</link> variable. Decoding of
16291629+attachments, like in the pager, can be controlled by the <link
16301630+linkend="forward-decode">$forward_decode</link> and <link
16311631+linkend="mime-forward-decode">$mime_forward_decode</link> variables,
15931632respectively. The desired forwarding format may depend on the content,
15941594-therefore <link linkend="mime-forward">$mime_forward</link> is a quadoption which, for
15951595-example, can be set to <quote>ask-no</quote>.
16331633+therefore <link linkend="mime-forward">$mime_forward</link> is a
16341634+quadoption which, for example, can be set to <quote>ask-no</quote>.
15961635</para>
1597163615981637<para>
15991638The inclusion of headers is controlled by the current setting of the
16001600-<link linkend="weed">$weed</link> variable, unless <link linkend="mime-forward">$mime_forward</link> is set.
16391639+<link linkend="weed">$weed</link> variable, unless <link
16401640+linkend="mime-forward">$mime_forward</link> is set.
16011641</para>
1602164216031643<para>
···1612165216131653<para>
16141654At times it is desirable to delay sending a message that you have
16151615-already begun to compose. When the <literal><postpone-message></literal> function is
16161616-used in the <emphasis>compose</emphasis> menu, the body of your message and attachments
16171617-are stored in the mailbox specified by the <link linkend="postponed">$postponed</link> variable. This means that you can recall the
16181618-message even if you exit Mutt and then restart it at a later time.
16551655+already begun to compose. When the
16561656+<literal><postpone-message></literal> function is used in the
16571657+<emphasis>compose</emphasis> menu, the body of your message and
16581658+attachments are stored in the mailbox specified by the <link
16591659+linkend="postponed">$postponed</link> variable. This means that you can
16601660+recall the message even if you exit Mutt and then restart it at a later
16611661+time.
16191662</para>
1620166316211664<para>
16221622-Once a message is postponed, there are several ways to resume it. From the
16231623-command line you can use the <quote>-p</quote> option, or if you compose a new
16241624-message from the <emphasis>index</emphasis> or <emphasis>pager</emphasis> you will be prompted if postponed
16251625-messages exist. If multiple messages are currently postponed, the
16261626-<emphasis>postponed</emphasis> menu will pop up and you can select which message you would
16271627-like to resume.
16651665+Once a message is postponed, there are several ways to resume it. From
16661666+the command line you can use the <quote>-p</quote> option, or if you
16671667+compose a new message from the <emphasis>index</emphasis> or
16681668+<emphasis>pager</emphasis> you will be prompted if postponed messages
16691669+exist. If multiple messages are currently postponed, the
16701670+<emphasis>postponed</emphasis> menu will pop up and you can select which
16711671+message you would like to resume.
16281672</para>
1629167316301674<note>
16311675<para>
16321632-If you postpone a reply to a message, the reply setting of
16331633-the message is only updated when you actually finish the message and
16341634-send it. Also, you must be in the same folder with the message you
16351635-replied to for the status of the message to be updated.
16761676+If you postpone a reply to a message, the reply setting of the message
16771677+is only updated when you actually finish the message and send it. Also,
16781678+you must be in the same folder with the message you replied to for the
16791679+status of the message to be updated.
16361680</para>
16371681</note>
16381682···16511695<title>Location of Initialization Files</title>
1652169616531697<para>
16541654-While the default configuration (or <quote>preferences</quote>) make Mutt
16551655-usable right out of the box, it is often desirable to tailor Mutt to
16561656-suit your own tastes. When Mutt is first invoked, it will attempt to
16571657-read the <quote>system</quote> configuration file (defaults set by your local
16581658-system administrator), unless the <quote>-n</quote> <link linkend="commandline">command line</link> option is specified. This file is typically
16591659-<literal>/usr/local/share/mutt/Muttrc</literal> or <literal>/etc/Muttrc</literal>. Mutt
16601660-will next look for a file named <literal>.muttrc</literal> in your home
16611661-directory. If this file does not exist and your home directory has
16621662-a subdirectory named <literal>.mutt</literal>, Mutt tries to load a file named
16981698+While the default configuration (or <quote>preferences</quote>) make
16991699+Mutt usable right out of the box, it is often desirable to tailor Mutt
17001700+to suit your own tastes. When Mutt is first invoked, it will attempt to
17011701+read the <quote>system</quote> configuration file (defaults set by your
17021702+local system administrator), unless the <quote>-n</quote> <link
17031703+linkend="commandline">command line</link> option is specified. This
17041704+file is typically <literal>/usr/local/share/mutt/Muttrc</literal> or
17051705+<literal>/etc/Muttrc</literal>. Mutt will next look for a file named
17061706+<literal>.muttrc</literal> in your home directory. If this file does
17071707+not exist and your home directory has a subdirectory named
17081708+<literal>.mutt</literal>, Mutt tries to load a file named
16631709<literal>.mutt/muttrc</literal>.
16641710</para>
1665171116661712<para>
16671667-<literal>.muttrc</literal> is the file where you will usually place your <link linkend="commands">commands</link> to configure Mutt.
17131713+<literal>.muttrc</literal> is the file where you will usually place your
17141714+<link linkend="commands">commands</link> to configure Mutt.
16681715</para>
1669171616701717<para>
16711718In addition, Mutt supports version specific configuration files that are
16721672-parsed instead of the default files as explained above. For instance, if
16731673-your system has a <literal>Muttrc-0.88</literal> file in the system configuration
16741674-directory, and you are running version 0.88 of Mutt, this file will be
16751675-sourced instead of the <literal>Muttrc</literal> file. The same is true of the user
16761676-configuration file, if you have a file <literal>.muttrc-0.88.6</literal> in your home
16771677-directory, when you run Mutt version 0.88.6, it will source this file
16781678-instead of the default <literal>.muttrc</literal> file. The version number is the
16791679-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:
16801680-V) from the index menu.
17191719+parsed instead of the default files as explained above. For instance,
17201720+if your system has a <literal>Muttrc-0.88</literal> file in the system
17211721+configuration directory, and you are running version 0.88 of Mutt, this
17221722+file will be sourced instead of the <literal>Muttrc</literal> file. The
17231723+same is true of the user configuration file, if you have a file
17241724+<literal>.muttrc-0.88.6</literal> in your home directory, when you run
17251725+Mutt version 0.88.6, it will source this file instead of the default
17261726+<literal>.muttrc</literal> file. The version number is the same which
17271727+is visible using the <quote>-v</quote> <link
17281728+linkend="commandline">command line</link> switch or using the
17291729+<literal>show-version</literal> key (default: V) from the index menu.
16811730</para>
1682173116831732</sect1>
···16861735<title>Syntax of Initialization Files</title>
1687173616881737<para>
16891689-An initialization file consists of a series of <link linkend="commands">commands</link>. Each line of the file may contain one or more commands.
16901690-When multiple commands are used, they must be separated by a semicolon
16911691-(<quote>;</quote>).
17381738+An initialization file consists of a series of <link
17391739+linkend="commands">commands</link>. Each line of the file may contain
17401740+one or more commands. When multiple commands are used, they must be
17411741+separated by a semicolon (<quote>;</quote>).
16921742</para>
1693174316941744<example id="ex-rc-multiple-cmds">
···16991749</example>
1700175017011751<para>
17021702-The hash mark, or pound sign
17031703-(<quote>#</quote>), is used as a <quote>comment</quote> character. You can use it to
17041704-annotate your initialization file. All text after the comment character
17051705-to the end of the line is ignored.
17521752+The hash mark, or pound sign (<quote>#</quote>), is used as a
17531753+<quote>comment</quote> character. You can use it to annotate your
17541754+initialization file. All text after the comment character to the end of
17551755+the line is ignored.
17061756</para>
1707175717081758<example id="ex-ec-comment">
···17131763</example>
1714176417151765<para>
17161716-Single quotes (<quote>'</quote>) and double quotes (<quote>"</quote>) can be used to quote strings
17171717-which contain spaces or other special characters. The difference between
17181718-the two types of quotes is similar to that of many popular shell programs,
17191719-namely that a single quote is used to specify a literal string (one that is
17201720-not interpreted for shell variables or quoting with a backslash [see
17211721-next paragraph]), while double quotes indicate a string for which
17221722-should be evaluated. For example, backticks are evaluated inside of double
17231723-quotes, but <emphasis>not</emphasis> for single quotes.
17661766+Single quotes (<quote>'</quote>) and double quotes (<quote>"</quote>)
17671767+can be used to quote strings which contain spaces or other special
17681768+characters. The difference between the two types of quotes is similar
17691769+to that of many popular shell programs, namely that a single quote is
17701770+used to specify a literal string (one that is not interpreted for shell
17711771+variables or quoting with a backslash [see next paragraph]), while
17721772+double quotes indicate a string for which should be evaluated. For
17731773+example, backticks are evaluated inside of double quotes, but
17741774+<emphasis>not</emphasis> for single quotes.
17241775</para>
1725177617261777<para>
17271727-<quote>\</quote> quotes the next character, just as in shells such as bash and zsh.
17281728-For example, if want to put quotes <quote>"</quote> inside of a string, you can use
17291729-<quote>\</quote> to force the next character to be a literal instead of interpreted
17301730-character.
17781778+<quote>\</quote> quotes the next character, just as in shells such as
17791779+bash and zsh. For example, if want to put quotes <quote>"</quote>
17801780+inside of a string, you can use <quote>\</quote> to force the next
17811781+character to be a literal instead of interpreted character.
17311782</para>
1732178317331784<example id="ex-rc-quote">
···17441795</para>
1745179617461797<para>
17471747-A <quote>\</quote> at the end of a line can be used to split commands over
17481748-multiple lines as it <quote>escapes</quote> the line end, provided that the split points don't appear in the
17491749-middle of command names. Lines are first concatenated before
17501750-interpretation so that a multi-line can be commented by commenting out
17511751-the first line only.
17981798+A <quote>\</quote> at the end of a line can be used to split commands
17991799+over multiple lines as it <quote>escapes</quote> the line end, provided
18001800+that the split points don't appear in the middle of command names. Lines
18011801+are first concatenated before interpretation so that a multi-line can be
18021802+commented by commenting out the first line only.
17521803</para>
1753180417541805<example id="ex-rc-split">
···17641815It is also possible to substitute the output of a Unix command in an
17651816initialization file. This is accomplished by enclosing the command in
17661817backticks (``). In <xref linkend="ex-rc-backtick"/>, the output of the
17671767-Unix command <quote>uname -a</quote> will be substituted before the
17681768-line is parsed.
17691769-Since initialization files are line oriented, only
17701770-the first line of output from the Unix command will be substituted.
18181818+Unix command <quote>uname -a</quote> will be substituted before the line
18191819+is parsed. Since initialization files are line oriented, only the first
18201820+line of output from the Unix command will be substituted.
17711821</para>
1772182217731823<example id="ex-rc-backtick">
···1791184117921842<para>
17931843will cause Mutt to save outgoing messages to a folder named
17941794-<quote>sent_on_kremvax</quote> if the environment variable <literal>$HOSTNAME</literal> is set to
17951795-<quote>kremvax.</quote> (See <link linkend="record">$record</link> for
17961796-details.)
18441844+<quote>sent_on_kremvax</quote> if the environment variable
18451845+<literal>$HOSTNAME</literal> is set to <quote>kremvax.</quote> (See
18461846+<link linkend="record">$record</link> for details.)
17971847</para>
1798184817991849<para>
18001850Mutt expands the variable when it is assigned, not when it is used. If
18011801-the value of a variable on the right-hand side of an assignment
18021802-changes after the assignment, the variable on the left-hand side will
18031803-not be affected.
18511851+the value of a variable on the right-hand side of an assignment changes
18521852+after the assignment, the variable on the left-hand side will not be
18531853+affected.
18041854</para>
1805185518061856<para>
18071857The commands understood by Mutt are explained in the next paragraphs.
18081808-For a complete list, see the <link linkend="commands">command reference</link>.
18581858+For a complete list, see the <link linkend="commands">command
18591859+reference</link>.
18091860</para>
1810186118111862<para>
18121863All configuration files are expected to be in the current locale as
18131813-specified by the <link linkend="charset">$charset</link> variable
18141814-which doesn't have a default value since it's determined by Mutt at startup.
18641864+specified by the <link linkend="charset">$charset</link> variable which
18651865+doesn't have a default value since it's determined by Mutt at startup.
18151866If a configuration file is not encoded in the same character set the
18161816-<link linkend="config-charset">$config_charset</link>
18171817-variable should be used: all lines starting with the next are recoded
18181818-from <link linkend="config-charset">$config_charset</link>
18191819-to <link linkend="charset">$charset</link>.
18671867+<link linkend="config-charset">$config_charset</link> variable should be
18681868+used: all lines starting with the next are recoded from <link
18691869+linkend="config-charset">$config_charset</link> to <link
18701870+linkend="charset">$charset</link>.
18201871</para>
1821187218221873<para>
18231823-This mechanism should be avoided if possible as it has the
18241824-following implications:
18741874+This mechanism should be avoided if possible as it has the following
18751875+implications:
18251876</para>
1826187718271878<itemizedlist>
1828187918291880<listitem><para>These variables should be set early in a configuration
18301830-file with <link linkend="charset">$charset</link> preceding
18311831-<link linkend="config-charset">$config_charset</link> so Mutt
18321832-knows what character set to convert to.</para></listitem>
18811881+file with <link linkend="charset">$charset</link> preceding <link
18821882+linkend="config-charset">$config_charset</link> so Mutt knows what
18831883+character set to convert to.</para></listitem>
1833188418341834-<listitem><para>If <link linkend="config-charset">$config_charset</link> is set, it should be set
18351835-in each configuration file because the value is global and <emphasis>not</emphasis>
18361836-per configuration file.</para></listitem>
18851885+<listitem><para>If <link linkend="config-charset">$config_charset</link>
18861886+is set, it should be set in each configuration file because the value is
18871887+global and <emphasis>not</emphasis> per configuration
18881888+file.</para></listitem>
1837188918381838-<listitem><para>Because Mutt first recodes a line before it attempts to parse it,
18391839-a conversion introducing question marks or other characters as
18401840-part of errors (unconvertable characters, transliteration) may introduce syntax
18411841-errors or silently change the meaning of certain tokens (e.g. inserting
18421842-question marks into regular expressions).</para></listitem>
18901890+<listitem><para>Because Mutt first recodes a line before it attempts to
18911891+parse it, a conversion introducing question marks or other characters as
18921892+part of errors (unconvertable characters, transliteration) may introduce
18931893+syntax errors or silently change the meaning of certain tokens
18941894+(e.g. inserting question marks into regular
18951895+expressions).</para></listitem>
1843189618441897</itemizedlist>
18451898···18981951</para>
1899195219001953<para>
19011901-These address groups can also be created implicitly by the
19021902-<link linkend="alias"><command>alias</command></link>, <link linkend="lists">lists</link>,
19031903-<link linkend="lists">subscribe</link> and
19041904-<link linkend="alternates"><command>alternates</command></link> commands by specifying the
19051905-optional <literal>-group</literal> option.
19541954+These address groups can also be created implicitly by the <link
19551955+linkend="alias"><command>alias</command></link>, <link
19561956+linkend="lists">lists</link>, <link linkend="lists">subscribe</link> and
19571957+<link linkend="alternates"><command>alternates</command></link> commands
19581958+by specifying the optional <literal>-group</literal> option.
19061959</para>
1907196019081961<para>
19091909-Once defined, these address groups can be used in
19101910-<link linkend="patterns">patterns</link> to search for and limit the
19111911-display to messages matching a group.
19621962+Once defined, these address groups can be used in <link
19631963+linkend="patterns">patterns</link> to search for and limit the display
19641964+to messages matching a group.
19121965</para>
1913196619141967<para>
···19582011</cmdsynopsis>
1959201219602013<para>
19611961-It's usually very cumbersome to remember or type out the address of someone
19621962-you are communicating with. Mutt allows you to create <quote>aliases</quote> which map
19631963-a short string to a full address.
20142014+It's usually very cumbersome to remember or type out the address of
20152015+someone you are communicating with. Mutt allows you to create
20162016+<quote>aliases</quote> which map a short string to a full address.
19642017</para>
1965201819662019<note>
19672020<para>
19681968-If you want to create an alias for more than
19691969-one address, you <emphasis>must</emphasis> separate the addresses with a comma (<quote>,</quote>).
20212021+If you want to create an alias for more than one address, you
20222022+<emphasis>must</emphasis> separate the addresses with a comma
20232023+(<quote>,</quote>).
19702024</para>
19712025</note>
19722026···19862040</screen>
1987204119882042<para>
19891989-Unlike other mailers, Mutt doesn't require aliases to be defined
19901990-in a special file. The <command>alias</command> command can appear anywhere in
19911991-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
19921992-you can have all aliases defined in your <literal>.muttrc</literal>.
20432043+Unlike other mailers, Mutt doesn't require aliases to be defined in a
20442044+special file. The <command>alias</command> command can appear anywhere
20452045+in a configuration file, as long as this file is <link
20462046+linkend="source"><command>source</command>d</link>. Consequently, you
20472047+can have multiple alias files, or you can have all aliases defined in
20482048+your <literal>.muttrc</literal>.
19932049</para>
1994205019952051<para>
19961996-On the other hand, the <link linkend="create-alias"><literal><create-alias></literal></link>
19971997-function can use only one file, the one pointed to by the <link linkend="alias-file">$alias_file</link> variable (which is
19981998-<literal>#/.muttrc</literal> by default). This file is not special either,
19991999-in the sense that Mutt will happily append aliases to any file, but in
20002000-order for the new aliases to take effect you need to explicitly <link linkend="source"><command>source</command></link> this file too.
20522052+On the other hand, the <link
20532053+linkend="create-alias"><literal><create-alias></literal></link>
20542054+function can use only one file, the one pointed to by the <link
20552055+linkend="alias-file">$alias_file</link> variable (which is
20562056+<literal>~/.muttrc</literal> by default). This file is not special
20572057+either, in the sense that Mutt will happily append aliases to any file,
20582058+but in order for the new aliases to take effect you need to explicitly
20592059+<link linkend="source"><command>source</command></link> this file too.
20012060</para>
2002206120032062<example id="ex-alias-external">
···2011207020122071<para>
20132072To use aliases, you merely use the alias at any place in Mutt where Mutt
20142014-prompts for addresses, such as the <emphasis>To:</emphasis> or <emphasis>Cc:</emphasis> prompt. You can
20152015-also enter aliases in your editor at the appropriate headers if you have the
20162016-<link linkend="edit-headers">$edit_headers</link> variable set.
20732073+prompts for addresses, such as the <emphasis>To:</emphasis> or
20742074+<emphasis>Cc:</emphasis> prompt. You can also enter aliases in your
20752075+editor at the appropriate headers if you have the <link
20762076+linkend="edit-headers">$edit_headers</link> variable set.
20172077</para>
2018207820192079<para>
20202020-In addition, at the various address prompts, you can use the tab character
20212021-to expand a partial alias to the full alias. If there are multiple matches,
20222022-Mutt will bring up a menu with the matching aliases. In order to be
20232023-presented with the full list of aliases, you must hit tab without a partial
20242024-alias, such as at the beginning of the prompt or after a comma denoting
20252025-multiple addresses.
20802080+In addition, at the various address prompts, you can use the tab
20812081+character to expand a partial alias to the full alias. If there are
20822082+multiple matches, Mutt will bring up a menu with the matching aliases.
20832083+In order to be presented with the full list of aliases, you must hit tab
20842084+without a partial alias, such as at the beginning of the prompt or after
20852085+a comma denoting multiple addresses.
20262086</para>
2027208720282088<para>
20292089In the alias menu, you can select as many aliases as you want with the
20302030-<literal>select-entry</literal> key (default: <Return>), and use the
20312031-<emphasis>exit</emphasis> key (default: q) to return to the address prompt.
20902090+<literal>select-entry</literal> key (default: <Return>), and use
20912091+the <emphasis>exit</emphasis> key (default: q) to return to the address
20922092+prompt.
20322093</para>
2033209420342095</sect1>
···20572118</para>
2058211920592120<para>
20602060-<emphasis>map</emphasis> specifies in which menu the binding belongs. Multiple maps may
20612061-be specified by separating them with commas (no additional whitespace is
20622062-allowed). The currently defined maps are:
21212121+<emphasis>map</emphasis> specifies in which menu the binding belongs.
21222122+Multiple maps may be specified by separating them with commas (no
21232123+additional whitespace is allowed). The currently defined maps are:
20632124</para>
2064212520652126<anchor id="maps"/>
···20712132<para>
20722133This is not a real menu, but is used as a fallback for all of the other
20732134menus except for the pager and editor modes. If a key is not defined in
20742074-another menu, Mutt will look for a binding to use in this menu. This allows
20752075-you to bind a key to a certain function in multiple menus instead of having
20762076-multiple <command>bind</command> statements to accomplish the same task.
21352135+another menu, Mutt will look for a binding to use in this menu. This
21362136+allows you to bind a key to a certain function in multiple menus instead
21372137+of having multiple <command>bind</command> statements to accomplish the
21382138+same task.
20772139</para>
20782140</listitem>
20792141</varlistentry>
···20822144<listitem>
20832145<para>
20842146The alias menu is the list of your personal aliases as defined in your
20852085-<literal>.muttrc</literal>. It is the mapping from a short alias name to the full email
20862086-address(es) of the recipient(s).
21472147+<literal>.muttrc</literal>. It is the mapping from a short alias name
21482148+to the full email address(es) of the recipient(s).
20872149</para>
20882150</listitem>
20892151</varlistentry>
···20912153<term>attach</term>
20922154<listitem>
20932155<para>
20942094-The attachment menu is used to access the attachments on received messages.
21562156+The attachment menu is used to access the attachments on received
21572157+messages.
20952158</para>
20962159</listitem>
20972160</varlistentry>
···20992162<term>browser</term>
21002163<listitem>
21012164<para>
21022102-The browser is used for both browsing the local directory structure, and for
21032103-listing all of your incoming mailboxes.
21652165+The browser is used for both browsing the local directory structure, and
21662166+for listing all of your incoming mailboxes.
21042167</para>
21052168</listitem>
21062169</varlistentry>
···21502213<term>smime</term>
21512214<listitem>
21522215<para>
21532153-The smime menu is used to select the OpenSSL certificates used to encrypt outgoing
21542154-messages.
22162216+The smime menu is used to select the OpenSSL certificates used to
22172217+encrypt outgoing messages.
21552218</para>
21562219</listitem>
21572220</varlistentry>
···21682231<term>query</term>
21692232<listitem>
21702233<para>
21712171-The query menu is the browser for results returned by
21722172-<link linkend="query-command">$query_command</link>.
22342234+The query menu is the browser for results returned by <link
22352235+linkend="query-command">$query_command</link>.
21732236</para>
21742237</listitem>
21752238</varlistentry>
···21852248</variablelist>
2186224921872250<para>
21882188-<emphasis>key</emphasis> is the key (or key sequence) you wish to bind. To specify a
21892189-control character, use the sequence <emphasis>\Cx</emphasis>, where <emphasis>x</emphasis> is the
21902190-letter of the control character (for example, to specify control-A use
21912191-<quote>\Ca</quote>). Note that the case of <emphasis>x</emphasis> as well as <emphasis>\C</emphasis> is
21922192-ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>\cA</emphasis> and <emphasis>\ca</emphasis> are all
22512251+<emphasis>key</emphasis> is the key (or key sequence) you wish to bind.
22522252+To specify a control character, use the sequence
22532253+<emphasis>\Cx</emphasis>, where <emphasis>x</emphasis> is the letter of
22542254+the control character (for example, to specify control-A use
22552255+<quote>\Ca</quote>). Note that the case of <emphasis>x</emphasis> as
22562256+well as <emphasis>\C</emphasis> is ignored, so that
22572257+<emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>,
22582258+<emphasis>\cA</emphasis> and <emphasis>\ca</emphasis> are all
21932259equivalent. An alternative form is to specify the key as a three digit
21942194-octal number prefixed with a <quote>\</quote> (for example <emphasis>\177</emphasis> is
21952195-equivalent to <emphasis>\c?</emphasis>). In addition, <emphasis>key</emphasis> may
21962196-be a symbolic name as shown in <xref linkend="tab-key-names"/>.
22602260+octal number prefixed with a <quote>\</quote> (for example
22612261+<emphasis>\177</emphasis> is equivalent to <emphasis>\c?</emphasis>). In
22622262+addition, <emphasis>key</emphasis> may be a symbolic name as shown in
22632263+<xref linkend="tab-key-names"/>.
21972264</para>
2198226521992266<table id="tab-key-names">
···22312298</table>
2232229922332300<para>
22342234-<emphasis>key</emphasis> does not need to be enclosed in quotes unless it contains a
22352235-space (<quote> </quote>) or semi-colon (<quote>;</quote>).
23012301+<emphasis>key</emphasis> does not need to be enclosed in quotes unless
23022302+it contains a space (<quote> </quote>) or semi-colon
23032303+(<quote>;</quote>).
22362304</para>
2237230522382306<para>
···22742342</cmdsynopsis>
2275234322762344<para>
22772277-The <command>charset-hook</command> command defines an alias for a character set.
22782278-This is useful to properly display messages which are tagged with a
22792279-character set name not known to Mutt.
23452345+The <command>charset-hook</command> command defines an alias for a
23462346+character set. This is useful to properly display messages which are
23472347+tagged with a character set name not known to Mutt.
22802348</para>
2281234922822350<para>
22832283-The <command>iconv-hook</command> command defines a system-specific name for a
22842284-character set. This is helpful when your systems character
22852285-conversion library insists on using strange, system-specific names
22862286-for character sets.
23512351+The <command>iconv-hook</command> command defines a system-specific name
23522352+for a character set. This is helpful when your systems character
23532353+conversion library insists on using strange, system-specific names for
23542354+character sets.
22872355</para>
2288235622892357</sect1>
···2305237323062374<para>
23072375It is often desirable to change settings based on which mailbox you are
23082308-reading. The <command>folder-hook</command> command provides a method by which you can execute
23092309-any configuration command. <emphasis>regexp</emphasis> is a regular expression specifying
23102310-in which mailboxes to execute <emphasis>command</emphasis> before loading. If a mailbox
23112311-matches multiple <command>folder-hook</command>s, they are executed in the order given in the
23122312-<literal>.muttrc</literal>.
23762376+reading. The <command>folder-hook</command> command provides a method
23772377+by which you can execute any configuration command.
23782378+<emphasis>regexp</emphasis> is a regular expression specifying in which
23792379+mailboxes to execute <emphasis>command</emphasis> before loading. If a
23802380+mailbox matches multiple <command>folder-hook</command>s, they are
23812381+executed in the order given in the <literal>.muttrc</literal>.
23132382</para>
2314238323152384<note>
23162385<para>
23172317-If you use the <quote>!</quote> shortcut for <link linkend="spoolfile">$spoolfile</link> at the beginning of the pattern, you must place it
23182318-inside of double or single quotes in order to distinguish it from the
23192319-logical <emphasis>not</emphasis> operator for the expression.
23862386+If you use the <quote>!</quote> shortcut for <link
23872387+linkend="spoolfile">$spoolfile</link> at the beginning of the pattern,
23882388+you must place it inside of double or single quotes in order to
23892389+distinguish it from the logical <emphasis>not</emphasis> operator for
23902390+the expression.
23202391</para>
23212392</note>
2322239323232394<note>
23242395<para>
23252325-Settings are <emphasis>not</emphasis> restored when you leave the mailbox.
23262326-For example, a command action to perform is to change the sorting method
23272327-based upon the mailbox being read:
23962396+Settings are <emphasis>not</emphasis> restored when you leave the
23972397+mailbox. For example, a command action to perform is to change the
23982398+sorting method based upon the mailbox being read:
23992399+</para>
2328240023292401<screen>
23302402folder-hook mutt "set sort=threads"</screen>
2331240324042404+<para>
23322405However, the sorting method is not restored to its previous value when
23332333-reading a different mailbox. To specify a <emphasis>default</emphasis> command, use the
23342334-pattern <quote>.</quote> before other <command>folder-hook</command>s adjusting a value on a per-folder basis
23352335-because <command>folder-hook</command>s are evaluated in the order given in the
23362336-configuration file.
24062406+reading a different mailbox. To specify a <emphasis>default</emphasis>
24072407+command, use the pattern <quote>.</quote> before other
24082408+<command>folder-hook</command>s adjusting a value on a per-folder basis
24092409+because <command>folder-hook</command>s are evaluated in the order given
24102410+in the configuration file.
23372411</para>
23382412</note>
2339241323402414<para>
23412341-The following example will set the <link linkend="sort">sort</link> variable
23422342-to <literal>date-sent</literal> for all folders but to <literal>threads</literal>
23432343-for all folders containing <quote>mutt</quote> in their name.
24152415+The following example will set the <link linkend="sort">sort</link>
24162416+variable to <literal>date-sent</literal> for all folders but to
24172417+<literal>threads</literal> for all folders containing
24182418+<quote>mutt</quote> in their name.
23442419</para>
2345242023462421<example id="ex-folder-sorting">
···23752450</cmdsynopsis>
2376245123772452<para>
23782378-Macros are useful when you would like a single key to perform a series of
23792379-actions. When you press <emphasis>key</emphasis> in menu <emphasis>menu</emphasis>, Mutt will behave as if
23802380-you had typed <emphasis>sequence</emphasis>. So if you have a common sequence of commands
23812381-you type, you can create a macro to execute those commands with a single
23822382-key or fewer keys.
24532453+Macros are useful when you would like a single key to perform a series
24542454+of actions. When you press <emphasis>key</emphasis> in menu
24552455+<emphasis>menu</emphasis>, Mutt will behave as if you had typed
24562456+<emphasis>sequence</emphasis>. So if you have a common sequence of
24572457+commands you type, you can create a macro to execute those commands with
24582458+a single key or fewer keys.
23832459</para>
2384246023852461<para>
23862386-<emphasis>menu</emphasis> is the <link linkend="maps">map</link> which the macro will be bound in.
23872387-Multiple maps may be specified by separating multiple menu arguments by
23882388-commas. Whitespace may not be used in between the menu arguments and the
23892389-commas separating them.
24622462+<emphasis>menu</emphasis> is the <link linkend="maps">map</link> which
24632463+the macro will be bound in. Multiple maps may be specified by
24642464+separating multiple menu arguments by commas. Whitespace may not be used
24652465+in between the menu arguments and the commas separating them.
23902466</para>
2391246723922468<para>
23932393-<emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded by the same rules as the
23942394-<link linkend="bind">key bindings</link> with some additions. The
23952395-first is that control characters in <emphasis>sequence</emphasis> can also be specified
23962396-as <emphasis>^x</emphasis>. In order to get a caret (<quote>^</quote>) you need to use
23972397-<emphasis>^^</emphasis>. Secondly, to specify a certain key such as <emphasis>up</emphasis>
23982398-or to invoke a function directly, you can use the format
23992399-<emphasis><key name></emphasis> and <emphasis><function name></emphasis>. For a listing of key
24002400-names see the section on <link linkend="bind">key bindings</link>. Functions
24692469+<emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded
24702470+by the same rules as the <link linkend="bind">key bindings</link> with
24712471+some additions. The first is that control characters in
24722472+<emphasis>sequence</emphasis> can also be specified as
24732473+<emphasis>^x</emphasis>. In order to get a caret (<quote>^</quote>) you
24742474+need to use <emphasis>^^</emphasis>. Secondly, to specify a certain key
24752475+such as <emphasis>up</emphasis> or to invoke a function directly, you
24762476+can use the format <emphasis><key name></emphasis> and
24772477+<emphasis><function name></emphasis>. For a listing of key names
24782478+see the section on <link linkend="bind">key bindings</link>. Functions
24012479are listed in the <link linkend="functions">reference</link>.
24022480</para>
2403248124042482<para>
24052483The advantage with using function names directly is that the macros will
24062406-work regardless of the current key bindings, so they are not dependent on
24072407-the user having particular key definitions. This makes them more robust
24082408-and portable, and also facilitates defining of macros in files used by more
24092409-than one user (e.g., the system Muttrc).
24842484+work regardless of the current key bindings, so they are not dependent
24852485+on the user having particular key definitions. This makes them more
24862486+robust and portable, and also facilitates defining of macros in files
24872487+used by more than one user (e.g., the system Muttrc).
24102488</para>
2411248924122490<para>
24132413-Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>,
24142414-which is shown in the help screens if they contain a description.
24912491+Optionally you can specify a descriptive text after
24922492+<emphasis>sequence</emphasis>, which is shown in the help screens if
24932493+they contain a description.
24152494</para>
2416249524172496<note>
···24962575</cmdsynopsis>
2497257624982577<para>
24992499-If your terminal supports color, you can spice up Mutt by creating your own
25002500-color scheme. To define the color of an object (type of information), you
25012501-must specify both a foreground color <emphasis>and</emphasis> a background color (it is not
25022502-possible to only specify one or the other).
25782578+If your terminal supports color, you can spice up Mutt by creating your
25792579+own color scheme. To define the color of an object (type of
25802580+information), you must specify both a foreground color
25812581+<emphasis>and</emphasis> a background color (it is not possible to only
25822582+specify one or the other).
25032583</para>
2504258425052585<para>
25062506-<emphasis>header</emphasis> and <emphasis>body</emphasis> match <emphasis>regexp</emphasis>
25072507-in the header/body of a message, <emphasis>index</emphasis> matches <emphasis>pattern</emphasis>
25082508-(see <xref linkend="patterns"/>) in the message index.
25862586+<emphasis>header</emphasis> and <emphasis>body</emphasis> match
25872587+<emphasis>regexp</emphasis> in the header/body of a message,
25882588+<emphasis>index</emphasis> matches <emphasis>pattern</emphasis> (see
25892589+<xref linkend="patterns"/>) in the message index.
25092590</para>
2510259125112592<para>
···25252606<listitem><para>quoted1, quoted2, ..., quoted<emphasis>N</emphasis> (higher levels of quoting)</para></listitem>
25262607<listitem><para>search (hiliting of words in the pager)</para></listitem>
25272608<listitem><para>signature</para></listitem><listitem><para>status (mode lines used to display info about the mailbox or message)</para></listitem>
25282528-<listitem><para>tilde (the <quote>#</quote> used to pad blank lines in the pager)</para></listitem>
26092609+<listitem><para>tilde (the <quote>~</quote> used to pad blank lines in the pager)</para></listitem>
25292610<listitem><para>tree (thread tree drawn in the message index and attachment menu)</para></listitem>
25302611<listitem><para>underline (hiliting underlined patterns in the body of messages)</para></listitem>
25312612</itemizedlist>
2532261325332614<para>
25342534-<emphasis>foreground</emphasis> and <emphasis>background</emphasis> can be one of the following:
26152615+<emphasis>foreground</emphasis> and <emphasis>background</emphasis> can
26162616+be one of the following:
25352617</para>
2536261825372619<itemizedlist>
···25492631</itemizedlist>
2550263225512633<para>
25522552-<emphasis>foreground</emphasis> can optionally be prefixed with the keyword <literal>bright</literal> to make
25532553-the foreground color boldfaced (e.g., <literal>brightred</literal>).
26342634+<emphasis>foreground</emphasis> can optionally be prefixed with the
26352635+keyword <literal>bright</literal> to make the foreground color boldfaced
26362636+(e.g., <literal>brightred</literal>).
25542637</para>
2555263825562639<para>
25572557-If your terminal supports it, the special keyword <emphasis>default</emphasis> can be
25582558-used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.
25592559-If Mutt is linked against the <emphasis>S-Lang</emphasis> library, you also need to set
25602560-the <literal>$COLORFGBG</literal> environment variable to the default colors of your
25612561-terminal for this to work; for example (for Bourne-like shells):
26402640+If your terminal supports it, the special keyword
26412641+<emphasis>default</emphasis> can be used as a transparent color. The
26422642+value <emphasis>brightdefault</emphasis> is also valid. If Mutt is
26432643+linked against the <emphasis>S-Lang</emphasis> library, you also need to
26442644+set the <literal>$COLORFGBG</literal> environment variable to the
26452645+default colors of your terminal for this to work; for example (for
26462646+Bourne-like shells):
25622647</para>
2563264825642649<screen>
···2568265325692654<note>
25702655<para>
25712571-The <emphasis>S-Lang</emphasis> library requires you to use the <emphasis>lightgray</emphasis>
25722572-and <emphasis>brown</emphasis> keywords instead of <emphasis>white</emphasis> and <emphasis>yellow</emphasis> when
25732573-setting this variable.
26562656+The <emphasis>S-Lang</emphasis> library requires you to use the
26572657+<emphasis>lightgray</emphasis> and <emphasis>brown</emphasis> keywords
26582658+instead of <emphasis>white</emphasis> and <emphasis>yellow</emphasis>
26592659+when setting this variable.
25742660</para>
25752661</note>
2576266225772663<note>
25782664<para>
25792579-The <command>uncolor</command> command can be applied to the index, header and body objects only. It
25802580-removes entries from the list. You <emphasis>must</emphasis> specify the same pattern
25812581-specified in the <command>color</command> command for it to be removed. The pattern <quote>*</quote> is
25822582-a special token which means to clear the color list of all entries.
26652665+The <command>uncolor</command> command can be applied to the index,
26662666+header and body objects only. It removes entries from the list. You
26672667+<emphasis>must</emphasis> specify the same pattern specified in the
26682668+<command>color</command> command for it to be removed. The pattern
26692669+<quote>*</quote> is a special token which means to clear the color list
26702670+of all entries.
25832671</para>
25842672</note>
2585267325862674<para>
25872587-Mutt also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>color1</emphasis>, ...,
25882588-<emphasis>color</emphasis><emphasis>N-1</emphasis> (<emphasis>N</emphasis> being the number of colors supported
25892589-by your terminal). This is useful when you remap the colors for your
25902590-display (for example by changing the color associated with <emphasis>color2</emphasis>
25912591-for your xterm), since color names may then lose their normal meaning.
26752675+Mutt also recognizes the keywords <emphasis>color0</emphasis>,
26762676+<emphasis>color1</emphasis>, ...,
26772677+<emphasis>color</emphasis><emphasis>N-1</emphasis>
26782678+(<emphasis>N</emphasis> being the number of colors supported by your
26792679+terminal). This is useful when you remap the colors for your display
26802680+(for example by changing the color associated with
26812681+<emphasis>color2</emphasis> for your xterm), since color names may then
26822682+lose their normal meaning.
25922683</para>
2593268425942685<anchor id="mono"/>
25952686<para>
25962596-If your terminal does not support color, it is still possible change the video
25972597-attributes through the use of the <quote>mono</quote> command. Usage:
26872687+If your terminal does not support color, it is still possible change the
26882688+video attributes through the use of the <quote>mono</quote>
26892689+command. Usage:
25982690</para>
2599269126002692<cmdsynopsis>
···26562748</cmdsynopsis>
2657274926582750<para>
26592659-For <emphasis>object</emphasis>, see the <command>color</command> command. <emphasis>attribute</emphasis>
26602660-can be one of the following:
27512751+For <emphasis>object</emphasis>, see the <command>color</command>
27522752+command. <emphasis>attribute</emphasis> can be one of the following:
26612753</para>
2662275426632755<itemizedlist>
···2678277026792771<para>
26802772When displaying a message in the pager, Mutt folds long header lines at
26812681-<link linkend="wrap">$wrap</link> columns. Though there're
26822682-precise rules about where to break and how, Mutt always folds headers
26832683-using a tab for readability. (Note that the sending side is not affected
26842684-by this, Mutt tries to implement standards compliant folding.)
27732773+<link linkend="wrap">$wrap</link> columns. Though there're precise rules
27742774+about where to break and how, Mutt always folds headers using a tab for
27752775+readability. (Note that the sending side is not affected by this, Mutt
27762776+tries to implement standards compliant folding.)
26852777</para>
2686277826872779</sect2>
···27122804</cmdsynopsis>
2713280527142806<para>
27152715-Messages often have many header fields added by automatic processing systems,
27162716-or which may not seem useful to display on the screen. This command allows
27172717-you to specify header fields which you don't normally want to see in the pager.
28072807+Messages often have many header fields added by automatic processing
28082808+systems, or which may not seem useful to display on the screen. This
28092809+command allows you to specify header fields which you don't normally
28102810+want to see in the pager.
27182811</para>
2719281227202813<para>
27212814You do not need to specify the full header field name. For example,
27222722-<quote>ignore content-</quote> will ignore all header fields that begin with the pattern
27232723-<quote>content-</quote>. <quote>ignore *</quote> will ignore all headers.
28152815+<quote>ignore content-</quote> will ignore all header fields that begin
28162816+with the pattern <quote>content-</quote>. <quote>ignore *</quote> will
28172817+ignore all headers.
27242818</para>
2725281927262820<para>
27272727-To remove a previously added token from the list, use the <quote>unignore</quote> command.
27282728-The <quote>unignore</quote> command will make Mutt display headers with the given pattern.
27292729-For example, if you do <quote>ignore x-</quote> it is possible to <quote>unignore x-mailer</quote>.
28212821+To remove a previously added token from the list, use the
28222822+<quote>unignore</quote> command. The <quote>unignore</quote> command
28232823+will make Mutt display headers with the given pattern. For example, if
28242824+you do <quote>ignore x-</quote> it is possible to <quote>unignore
28252825+x-mailer</quote>.
27302826</para>
2731282727322828<para>
···27722868</cmdsynopsis>
2773286927742870<para>
27752775-With the <command>hdr_order</command> command you can specify an order in
27762776-which Mutt will attempt to present these headers to you when viewing messages.
28712871+With the <command>hdr_order</command> command you can specify an order
28722872+in which Mutt will attempt to present these headers to you when viewing
28732873+messages.
27772874</para>
2778287527792876<para>
27802780-<quote><command>unhdr_order</command> *</quote> will clear all previous headers from the order list,
27812781-thus removing the header order effects set by the system-wide startup file.
28772877+<quote><command>unhdr_order</command> *</quote> will clear all previous
28782878+headers from the order list, thus removing the header order effects set
28792879+by the system-wide startup file.
27822880</para>
2783288127842882<example id="ex-hdr-order">
···28252923</cmdsynopsis>
2826292428272925<para>
28282828-With various functions, Mutt will treat messages differently,
28292829-depending on whether you sent them or whether you received them from
28302830-someone else. For instance, when replying to a message that you
28312831-sent to a different party, Mutt will automatically suggest to send
28322832-the response to the original message's recipients — responding to
28332833-yourself won't make much sense in many cases. (See <link linkend="reply-to">$reply_to</link>.)
29262926+With various functions, Mutt will treat messages differently, depending
29272927+on whether you sent them or whether you received them from someone else.
29282928+For instance, when replying to a message that you sent to a different
29292929+party, Mutt will automatically suggest to send the response to the
29302930+original message's recipients — responding to yourself won't make
29312931+much sense in many cases. (See <link
29322932+linkend="reply-to">$reply_to</link>.)
28342933</para>
2835293428362935<para>
28372936Many users receive e-mail under a number of different addresses. To
28382838-fully use Mutt's features here, the program must be able to
28392839-recognize what e-mail addresses you receive mail under. That's the
28402840-purpose of the <command>alternates</command> command: It takes a list of regular
29372937+fully use Mutt's features here, the program must be able to recognize
29382938+what e-mail addresses you receive mail under. That's the purpose of the
29392939+<command>alternates</command> command: It takes a list of regular
28412940expressions, each of which can identify an address under which you
28422941receive e-mail.
28432942</para>
···28532952</screen>
2854295328552954<para>
28562856-Mutt will consider <quote><literal>some-user@example</literal></quote> as
28572857-being your address, too which may not be desired. As a solution, in such
28582858-cases addresses should be specified as:
29552955+Mutt will consider <quote><literal>some-user@example</literal></quote>
29562956+as being your address, too which may not be desired. As a solution, in
29572957+such cases addresses should be specified as:
28592958</para>
2860295928612960<screen>
···28632962</screen>
2864296328652964<para>
28662866-The <literal>-group</literal> flag causes all of the subsequent regular expressions
28672867-to be added to the named group.
29652965+The <literal>-group</literal> flag causes all of the subsequent regular
29662966+expressions to be added to the named group.
28682967</para>
2869296828702969<para>
28712871-The <command>unalternates</command> command can be used to write exceptions to
28722872-<command>alternates</command> patterns. If an address matches something in an
28732873-<command>alternates</command> command, but you nonetheless do not think it is
28742874-from you, you can list a more precise pattern under an <command>unalternates</command>
28752875-command.
29702970+The <command>unalternates</command> command can be used to write
29712971+exceptions to <command>alternates</command> patterns. If an address
29722972+matches something in an <command>alternates</command> command, but you
29732973+nonetheless do not think it is from you, you can list a more precise
29742974+pattern under an <command>unalternates</command> command.
28762975</para>
2877297628782977<para>
28792879-To remove a regular expression from the <command>alternates</command> list, use the
28802880-<command>unalternates</command> command with exactly the same <emphasis>regexp</emphasis>.
28812881-Likewise, if the <emphasis>regexp</emphasis> for an <command>alternates</command> command matches
28822882-an entry on the <command>unalternates</command> list, that <command>unalternates</command>
28832883-entry will be removed. If the <emphasis>regexp</emphasis> for <command>unalternates</command>
28842884-is <quote>*</quote>, <emphasis>all entries</emphasis> on <command>alternates</command> will be removed.
29782978+To remove a regular expression from the <command>alternates</command>
29792979+list, use the <command>unalternates</command> command with exactly the
29802980+same <emphasis>regexp</emphasis>. Likewise, if the
29812981+<emphasis>regexp</emphasis> for an <command>alternates</command> command
29822982+matches an entry on the <command>unalternates</command> list, that
29832983+<command>unalternates</command> entry will be removed. If the
29842984+<emphasis>regexp</emphasis> for <command>unalternates</command> is
29852985+<quote>*</quote>, <emphasis>all entries</emphasis> on
29862986+<command>alternates</command> will be removed.
28852987</para>
2886298828872989</sect1>
···29473049</cmdsynopsis>
2948305029493051<para>
29502950-Mutt has a few nice features for <link linkend="using-lists">handling mailing lists</link>. In order to take advantage of them, you must
29512951-specify which addresses belong to mailing lists, and which mailing
29522952-lists you are subscribed to. Mutt also has limited support for
29532953-auto-detecting mailing lists: it supports parsing
29542954-<literal>mailto:</literal> links in the common
29552955-<literal>List-Post:</literal> header which has the same effect as
29562956-specifying the list address via the <command>lists</command> command
29572957-(except the group feature). Once you have done this, the
29582958-<link linkend="list-reply"><literal><list-reply></literal></link>
29592959-function will work for all known lists.
29602960-Additionally, when you send a message to a subscribed list, Mutt will
29612961-add a Mail-Followup-To header to tell other users' mail user agents
29622962-not to send copies of replies to your personal address.
30523052+Mutt has a few nice features for <link linkend="using-lists">handling
30533053+mailing lists</link>. In order to take advantage of them, you must
30543054+specify which addresses belong to mailing lists, and which mailing lists
30553055+you are subscribed to. Mutt also has limited support for auto-detecting
30563056+mailing lists: it supports parsing <literal>mailto:</literal> links in
30573057+the common <literal>List-Post:</literal> header which has the same
30583058+effect as specifying the list address via the <command>lists</command>
30593059+command (except the group feature). Once you have done this, the <link
30603060+linkend="list-reply"><literal><list-reply></literal></link>
30613061+function will work for all known lists. Additionally, when you send a
30623062+message to a subscribed list, Mutt will add a Mail-Followup-To header to
30633063+tell other users' mail user agents not to send copies of replies to your
30643064+personal address.
29633065</para>
2964306629653067<note>
29663068<para>
29673069The Mail-Followup-To header is a non-standard extension which is not
29682968-supported by all mail user agents. Adding it is not bullet-proof against
29692969-receiving personal CCs of list messages. Also note that the generation
29702970-of the Mail-Followup-To header is controlled by the
29712971-<link linkend="followup-to">$followup_to</link>
29722972-configuration variable since it's common practice on some mailing lists
29732973-to send Cc upons replies (which is more a group- than a list-reply).
30703070+supported by all mail user agents. Adding it is not bullet-proof
30713071+against receiving personal CCs of list messages. Also note that the
30723072+generation of the Mail-Followup-To header is controlled by the <link
30733073+linkend="followup-to">$followup_to</link> configuration variable since
30743074+it's common practice on some mailing lists to send Cc upons replies
30753075+(which is more a group- than a list-reply).
29743076</para>
29753077</note>
2976307829773079<para>
29782978-More precisely, Mutt maintains lists of patterns for the addresses
29792979-of known and subscribed mailing lists. Every subscribed mailing
29802980-list is known. To mark a mailing list as known, use the <command>list</command>
30803080+More precisely, Mutt maintains lists of patterns for the addresses of
30813081+known and subscribed mailing lists. Every subscribed mailing list is
30823082+known. To mark a mailing list as known, use the <command>list</command>
29813083command. To mark it as subscribed, use <command>subscribe</command>.
29823084</para>
2983308529843086<para>
29852985-You can use regular expressions with both commands. To mark all
29862986-messages sent to a specific bug report's address on Debian's bug
29872987-tracking system as list mail, for instance, you could say
30873087+You can use regular expressions with both commands. To mark all messages
30883088+sent to a specific bug report's address on Debian's bug tracking system
30893089+as list mail, for instance, you could say
29883090</para>
2989309129903092<screen>
29913093subscribe [0-9]*.*@bugs.debian.org</screen>
2992309429933095<para>
29942994-as it's often, it's sufficient to just give a portion of the list's e-mail address.
30963096+as it's often, it's sufficient to just give a portion of the list's
30973097+e-mail address.
29953098</para>
2996309929973100<para>
29983101Specify as much of the address as you need to to remove ambiguity. For
29992999-example, if you've subscribed to the Mutt mailing list, you will receive mail
30003000-addressed to <literal>mutt-users@mutt.org</literal>. So, to tell Mutt
30013001-that this is a mailing list, you could add <literal>lists mutt-users@</literal> to your
30023002-initialization file. To tell Mutt that you are subscribed to it,
30033003-add <literal><command>subscribe</command> mutt-users</literal> to your initialization file instead.
30043004-If you also happen to get mail from someone whose address is
31023102+example, if you've subscribed to the Mutt mailing list, you will receive
31033103+mail addressed to <literal>mutt-users@mutt.org</literal>. So, to tell
31043104+Mutt that this is a mailing list, you could add <literal>lists
31053105+mutt-users@</literal> to your initialization file. To tell Mutt that
31063106+you are subscribed to it, add <literal><command>subscribe</command>
31073107+mutt-users</literal> to your initialization file instead. If you also
31083108+happen to get mail from someone whose address is
30053109<literal>mutt-users@example.com</literal>, you could use
30063006-<literal><command>lists</command> ^mutt-users@mutt\\.org$</literal>
30073007-or <literal><command>subscribe</command> ^mutt-users@mutt\\.org$</literal> to
30083008-match only mail from the actual list.
31103110+<literal><command>lists</command> ^mutt-users@mutt\\.org$</literal> or
31113111+<literal><command>subscribe</command> ^mutt-users@mutt\\.org$</literal>
31123112+to match only mail from the actual list.
30093113</para>
3010311430113115<para>
30123012-The <literal>-group</literal> flag adds all of the subsequent regular expressions
30133013-to the named group.
31163116+The <literal>-group</literal> flag adds all of the subsequent regular
31173117+expressions to the named group.
30143118</para>
3015311930163120<para>
30173017-The <quote>unlists</quote> command is used to remove a token from the list of
30183018-known and subscribed mailing-lists. Use <quote>unlists *</quote> to remove all
30193019-tokens.
31213121+The <quote>unlists</quote> command is used to remove a token from the
31223122+list of known and subscribed mailing-lists. Use <quote>unlists *</quote>
31233123+to remove all tokens.
30203124</para>
3021312530223126<para>
30233023-To remove a mailing list from the list of subscribed mailing lists,
30243024-but keep it on the list of known mailing lists, use <command>unsubscribe</command>.
31273127+To remove a mailing list from the list of subscribed mailing lists, but
31283128+keep it on the list of known mailing lists, use
31293129+<command>unsubscribe</command>.
30253130</para>
3026313130273132</sect1>
···30443149<para>
30453150This command is used to move read messages from a specified mailbox to a
30463151different mailbox automatically when you quit or change folders.
30473047-<emphasis>pattern</emphasis> is a regular expression specifying the mailbox to treat as a
30483048-<quote>spool</quote> mailbox and <emphasis>mailbox</emphasis> specifies where mail should be saved when
31523152+<emphasis>pattern</emphasis> is a regular expression specifying the
31533153+mailbox to treat as a <quote>spool</quote> mailbox and
31543154+<emphasis>mailbox</emphasis> specifies where mail should be saved when
30493155read.
30503156</para>
3051315730523158<para>
30533053-Unlike some of the other <emphasis>hook</emphasis> commands, only the <emphasis>first</emphasis> matching
30543054-pattern is used (it is not possible to save read mail in more than a single
30553055-mailbox).
31593159+Unlike some of the other <emphasis>hook</emphasis> commands, only the
31603160+<emphasis>first</emphasis> matching pattern is used (it is not possible
31613161+to save read mail in more than a single mailbox).
30563162</para>
3057316330583164</sect1>
···30833189</cmdsynopsis>
3084319030853191<para>
30863086-This command specifies folders which can receive mail and
30873087-which will be checked for new messages periodically.
31923192+This command specifies folders which can receive mail and which will be
31933193+checked for new messages periodically.
30883194</para>
3089319530903196<para>
30913197<emphasis>folder</emphasis> can either be a local file or directory
30923198(Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP
30933199support, <emphasis>folder</emphasis> can also be a POP/IMAP folder
30943094-URL. The URL syntax is described in <xref linkend="url-syntax"/>,
30953095-POP and IMAP are described in <xref linkend="pop"/> and <xref linkend="imap"/>
30963096-respectively.
32003200+URL. The URL syntax is described in <xref linkend="url-syntax"/>, POP
32013201+and IMAP are described in <xref linkend="pop"/> and <xref
32023202+linkend="imap"/> respectively.
30973203</para>
3098320430993205<para>
31003206Mutt provides a number of advanced features for handling (possibly many)
31013101-folders and new mail within them, please refer to
31023102-<xref linkend="new-mail"/> for details (including in what
31033103-situations and how often Mutt checks for new mail).
32073207+folders and new mail within them, please refer to <xref
32083208+linkend="new-mail"/> for details (including in what situations and how
32093209+often Mutt checks for new mail).
31043210</para>
3105321131063212<para>
31073107-The <quote>unmailboxes</quote> command is used to remove a token from the list
31083108-of folders which receive mail. Use <quote>unmailboxes *</quote> to remove all
31093109-tokens.
32133213+The <quote>unmailboxes</quote> command is used to remove a token from
32143214+the list of folders which receive mail. Use <quote>unmailboxes *</quote>
32153215+to remove all tokens.
31103216</para>
3111321731123218<note>
31133219<para>
31143114-The folders in the <command>mailboxes</command> command are resolved when
31153115-the command is executed, so if these names contain <link linkend="shortcuts">shortcut characters</link> (such as <quote>=</quote> and <quote>!</quote>), any variable
31163116-definition that affects these characters (like <link linkend="folder">$folder</link> and <link linkend="spoolfile">$spoolfile</link>)
31173117-should be set before the <command>mailboxes</command> command. If
31183118-none of these shorcuts are used, a local path should be absolute as
31193119-otherwise Mutt tries to find it relative to the directory
31203120-from where Mutt was started which may not always be desired.
32203220+The folders in the <command>mailboxes</command> command are resolved
32213221+when the command is executed, so if these names contain <link
32223222+linkend="shortcuts">shortcut characters</link> (such as <quote>=</quote>
32233223+and <quote>!</quote>), any variable definition that affects these
32243224+characters (like <link linkend="folder">$folder</link> and <link
32253225+linkend="spoolfile">$spoolfile</link>) should be set before the
32263226+<command>mailboxes</command> command. If none of these shorcuts are
32273227+used, a local path should be absolute as otherwise Mutt tries to find it
32283228+relative to the directory from where Mutt was started which may not
32293229+always be desired.
31213230</para>
31223231</note>
31233232···31463255</cmdsynopsis>
3147325631483257<para>
31493149-The <command>my_hdr</command> command allows you to create your own header
31503150-fields which will be added to every message you send and appear in the
31513151-editor if <link linkend="edit-headers">$edit_headers</link> is set.
32583258+The <command>my_hdr</command> command allows you to create your own
32593259+header fields which will be added to every message you send and appear
32603260+in the editor if <link linkend="edit-headers">$edit_headers</link> is
32613261+set.
31523262</para>
3153326331543264<para>
31553155-For example, if you would like to add an <quote>Organization:</quote> header field to
31563156-all of your outgoing messages, you can put the command something like
31573157-shown in <xref linkend="ex-my-hdr"/> in your <literal>.muttrc</literal>.
32653265+For example, if you would like to add an <quote>Organization:</quote>
32663266+header field to all of your outgoing messages, you can put the command
32673267+something like shown in <xref linkend="ex-my-hdr"/> in your
32683268+<literal>.muttrc</literal>.
31583269</para>
3159327031603271<example id="ex-my-hdr">
···3166327731673278<note>
31683279<para>
31693169-Space characters are <emphasis>not</emphasis> allowed between the keyword and
31703170-the colon (<quote>:</quote>). The standard for electronic mail (RFC2822) says that
31713171-space is illegal there, so Mutt enforces the rule.
32803280+Space characters are <emphasis>not</emphasis> allowed between the
32813281+keyword and the colon (<quote>:</quote>). The standard for electronic
32823282+mail (RFC2822) says that space is illegal there, so Mutt enforces the
32833283+rule.
31723284</para>
31733285</note>
3174328631753287<para>
31763288If you would like to add a header field to a single message, you should
31773177-either set the <link linkend="edit-headers">$edit_headers</link> variable,
31783178-or use the <literal><edit-headers></literal> function (default: <quote>E</quote>) in the compose menu so
31793179-that you can edit the header of your message along with the body.
32893289+either set the <link linkend="edit-headers">$edit_headers</link>
32903290+variable, or use the <literal><edit-headers></literal> function
32913291+(default: <quote>E</quote>) in the compose menu so that you can edit the
32923292+header of your message along with the body.
31803293</para>
3181329431823295<para>
31833183-To remove user defined header fields, use the <command>unmy_hdr</command>
31843184-command. You may specify an asterisk (<quote>*</quote>) to remove all header
31853185-fields, or the fields to remove. For example, to remove all <quote>To</quote> and
32963296+To remove user defined header fields, use the
32973297+<command>unmy_hdr</command> command. You may specify an asterisk
32983298+(<quote>*</quote>) to remove all header fields, or the fields to
32993299+remove. For example, to remove all <quote>To</quote> and
31863300<quote>Cc</quote> header fields, you could use:
31873301</para>
31883302···3209332332103324<para>
32113325This command is used to override the default mailbox used when saving
32123212-messages. <emphasis>mailbox</emphasis> will be used as the default if the message
32133213-matches <emphasis>pattern</emphasis>, see <xref linkend="pattern-hook"/> for information
32143214-on the exact format.
33263326+messages. <emphasis>mailbox</emphasis> will be used as the default if
33273327+the message matches <emphasis>pattern</emphasis>, see <xref
33283328+linkend="pattern-hook"/> for information on the exact format.
32153329</para>
3216333032173331<para>
32183218-To provide more flexibility and good defaults, Mutt applies the
32193219-expandos of <link linkend="index-format">$index_format</link> to
33323332+To provide more flexibility and good defaults, Mutt applies the expandos
33333333+of <link linkend="index-format">$index_format</link> to
32203334<emphasis>mailbox</emphasis> after it was expanded.
32213335</para>
32223336···32353349</example>
3236335032373351<para>
32383238-Also see the <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.
33523352+Also see the <link
33533353+linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.
32393354</para>
3240335532413356</sect1>
···32563371</cmdsynopsis>
3257337232583373<para>
32593259-This command is used to save outgoing mail in a mailbox other than
32603260-<link linkend="record">$record</link>. Mutt searches the initial list of
32613261-message recipients for the first matching <emphasis>regexp</emphasis> and uses <emphasis>mailbox</emphasis>
32623262-as the default Fcc: mailbox. If no match is found the message will be saved
32633263-to <link linkend="record">$record</link> mailbox.
33743374+This command is used to save outgoing mail in a mailbox other than <link
33753375+linkend="record">$record</link>. Mutt searches the initial list of
33763376+message recipients for the first matching <emphasis>regexp</emphasis>
33773377+and uses <emphasis>mailbox</emphasis> as the default Fcc: mailbox. If
33783378+no match is found the message will be saved to <link
33793379+linkend="record">$record</link> mailbox.
32643380</para>
3265338132663382<para>
···32703386</para>
3271338732723388<para>
32733273-See <xref linkend="pattern-hook"/> for information on the exact format of <emphasis>pattern</emphasis>.
33893389+See <xref linkend="pattern-hook"/> for information on the exact format
33903390+of <emphasis>pattern</emphasis>.
32743391</para>
3275339232763393<screen>fcc-hook [@.]aol\\.com$ +spammers</screen>
3277339432783395<para>
32793279-...will save a copy of all messages going to the aol.com domain to
32803280-the `+spammers' mailbox by default. Also see the <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.
33963396+...will save a copy of all messages going to the aol.com domain to the
33973397+`+spammers' mailbox by default. Also see the <link
33983398+linkend="fcc-save-hook"><command>fcc-save-hook</command></link> command.
32813399</para>
3282340032833401</sect1>
···32983416</cmdsynopsis>
3299341733003418<para>
33013301-This command is a shortcut, equivalent to doing both a <link linkend="fcc-hook"><command>fcc-hook</command></link>
33023302-and a <link linkend="save-hook"><command>save-hook</command></link> with its arguments,
33033303-including %-expansion on <emphasis>mailbox</emphasis> according
33043304-to <link linkend="index-format">$index_format</link>.
34193419+This command is a shortcut, equivalent to doing both a <link
34203420+linkend="fcc-hook"><command>fcc-hook</command></link> and a <link
34213421+linkend="save-hook"><command>save-hook</command></link> with its
34223422+arguments, including %-expansion on <emphasis>mailbox</emphasis>
34233423+according to <link linkend="index-format">$index_format</link>.
33053424</para>
3306342533073426</sect1>
···33413460</cmdsynopsis>
3342346133433462<para>
33443344-These commands can be used to execute arbitrary configuration commands based
33453345-upon recipients of the message. <emphasis>pattern</emphasis> is used to match
33463346-the message, see <xref linkend="pattern-hook"/> for details. <emphasis>command</emphasis>
33473347-is executed when <emphasis>pattern</emphasis> matches.
34633463+These commands can be used to execute arbitrary configuration commands
34643464+based upon recipients of the message. <emphasis>pattern</emphasis> is
34653465+used to match the message, see <xref linkend="pattern-hook"/> for
34663466+details. <emphasis>command</emphasis> is executed when
34673467+<emphasis>pattern</emphasis> matches.
33483468</para>
3349346933503470<para>
33513351-<command>reply-hook</command> is matched against the message you are <emphasis>replying to</emphasis>,
33523352-instead of the message you are <emphasis>sending</emphasis>. <command>send-hook</command> is
33533353-matched against all messages, both <emphasis>new</emphasis>
33543354-and <emphasis>replies</emphasis>.
34713471+<command>reply-hook</command> is matched against the message you are
34723472+<emphasis>replying to</emphasis>, instead of the message you are
34733473+<emphasis>sending</emphasis>. <command>send-hook</command> is matched
34743474+against all messages, both <emphasis>new</emphasis> and
34753475+<emphasis>replies</emphasis>.
33553476</para>
3356347733573478<note>
33583479<para>
33593359-<command>reply-hook</command>s are matched <emphasis>before</emphasis> the <command>send-hook</command>, <emphasis>regardless</emphasis>
33603360-of the order specified in the user's configuration file.
34803480+<command>reply-hook</command>s are matched <emphasis>before</emphasis>
34813481+the <command>send-hook</command>, <emphasis>regardless</emphasis> of the
34823482+order specified in the user's configuration file.
33613483</para>
33623484</note>
3363348533643486<para>
33653365-<command>send2-hook</command> is matched every time a message is changed, either
33663366-by editing it, or by using the compose menu to change its recipients
33673367-or subject. <command>send2-hook</command> is executed after <command>send-hook</command>, and
33683368-can, e.g., be used to set parameters such as the <link linkend="sendmail">$sendmail</link> variable depending on the message's sender
33693369-address.
34873487+<command>send2-hook</command> is matched every time a message is
34883488+changed, either by editing it, or by using the compose menu to change
34893489+its recipients or subject. <command>send2-hook</command> is executed
34903490+after <command>send-hook</command>, and can, e.g., be used to set
34913491+parameters such as the <link linkend="sendmail">$sendmail</link>
34923492+variable depending on the message's sender address.
33703493</para>
3371349433723495<para>
33733373-For each type of <command>send-hook</command> or <command>reply-hook</command>, when multiple matches
33743374-occur, commands are executed in the order they are specified in the <literal>.muttrc</literal>
33753375-(for that type of hook).
34963496+For each type of <command>send-hook</command> or
34973497+<command>reply-hook</command>, when multiple matches occur, commands are
34983498+executed in the order they are specified in the
34993499+<literal>.muttrc</literal> (for that type of hook).
33763500</para>
3377350133783502<para>
33793379-Example: <literal><command>send-hook</command> mutt "<command>set</command> mime_forward signature=''"</literal>
35033503+Example: <literal><command>send-hook</command> mutt
35043504+"<command>set</command> mime_forward signature=''"</literal>
33803505</para>
3381350633823507<para>
33833508Another typical use for this command is to change the values of the
33843384-<link linkend="attribution">$attribution</link>, <link linkend="signature">$signature</link> and <link linkend="locale">$locale</link>
33853385-variables in order to change the language of the attributions and
33863386-signatures based upon the recipients.
35093509+<link linkend="attribution">$attribution</link>, <link
35103510+linkend="signature">$signature</link> and <link
35113511+linkend="locale">$locale</link> variables in order to change the
35123512+language of the attributions and signatures based upon the recipients.
33873513</para>
3388351433893515<note>
33903516<para>
33913517<command>send-hook</command>'s are only executed once after getting the
33923518initial list of recipients. Adding a recipient after replying or
33933393-editing the message will not cause any <command>send-hook</command> to be executed,
33943394-similarily if <link linkend="autoedit">$autoedit</link> is set
33953395-(as then the initial list of recipients is empty). Also note that <link
33963396-linkend="my-hdr"><command>my_hdr</command></link> commands which
35193519+editing the message will not cause any <command>send-hook</command> to
35203520+be executed, similarily if <link linkend="autoedit">$autoedit</link> is
35213521+set (as then the initial list of recipients is empty). Also note that
35223522+<link linkend="my-hdr"><command>my_hdr</command></link> commands which
33973523modify recipient headers, or the message's subject, don't have any
33983524effect on the current message when executed from a
33993525<command>send-hook</command>.
···3419354534203546<para>
34213547This command can be used to execute arbitrary configuration commands
34223422-before viewing or formatting a message based upon information about the message.
34233423-<emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis> matches the message to be
34243424-displayed. When multiple matches occur, commands are executed in the order
34253425-they are specified in the <literal>.muttrc</literal>.
35483548+before viewing or formatting a message based upon information about the
35493549+message. <emphasis>command</emphasis> is executed if the
35503550+<emphasis>pattern</emphasis> matches the message to be displayed. When
35513551+multiple matches occur, commands are executed in the order they are
35523552+specified in the <literal>.muttrc</literal>.
34263553</para>
3427355434283555<para>
34293429-See <xref linkend="pattern-hook"/> for
34303430-information on the exact format of <emphasis>pattern</emphasis>.
35563556+See <xref linkend="pattern-hook"/> for information on the exact format
35573557+of <emphasis>pattern</emphasis>.
34313558</para>
3432355934333560<para>
···34573584</cmdsynopsis>
3458358534593586<para>
34603460-When encrypting messages with PGP/GnuPG or OpenSSL, you may want to associate a certain
34613461-key with a given e-mail address automatically, either because the
34623462-recipient's public key can't be deduced from the destination address,
34633463-or because, for some reasons, you need to override the key Mutt would
34643464-normally use. The <command>crypt-hook</command> command provides a
34653465-method by which you can specify the ID of the public key to be used
34663466-when encrypting messages to a certain recipient.
35873587+When encrypting messages with PGP/GnuPG or OpenSSL, you may want to
35883588+associate a certain key with a given e-mail address automatically,
35893589+either because the recipient's public key can't be deduced from the
35903590+destination address, or because, for some reasons, you need to override
35913591+the key Mutt would normally use. The <command>crypt-hook</command>
35923592+command provides a method by which you can specify the ID of the public
35933593+key to be used when encrypting messages to a certain recipient.
34673594</para>
3468359534693596<para>
34703470-The meaning of <emphasis>keyid</emphasis> is to be taken broadly in this context: You
34713471-can either put a numerical key ID here, an e-mail address, or even
34723472-just a real name.
35973597+The meaning of <emphasis>keyid</emphasis> is to be taken broadly in this
35983598+context: You can either put a numerical key ID here, an e-mail address,
35993599+or even just a real name.
34733600</para>
3474360134753602</sect1>
···34873614</cmdsynopsis>
3488361534893616<para>
34903490-This command adds the named string to the keyboard buffer. The string may
34913491-contain control characters, key names and function names like the sequence
34923492-string in the <link linkend="macro">macro</link> command. You may use it to
34933493-automatically run a sequence of commands at startup, or when entering
34943494-certain folders. For example, <xref linkend="ex-folder-hook-push"/>
34953495-shows how to automatically collapse all threads when entering a folder.
36173617+This command adds the named string to the keyboard buffer. The string
36183618+may contain control characters, key names and function names like the
36193619+sequence string in the <link linkend="macro">macro</link> command. You
36203620+may use it to automatically run a sequence of commands at startup, or
36213621+when entering certain folders. For example, <xref
36223622+linkend="ex-folder-hook-push"/> shows how to automatically collapse all
36233623+threads when entering a folder.
34963624</para>
3497362534983626<example id="ex-folder-hook-push">
···35203648</cmdsynopsis>
3521364935223650<para>
35233523-This command can be used to execute any function. Functions are
35243524-listed in the <link linkend="functions">function reference</link>.
35253525-<quote><command>exec</command><literal>function</literal></quote> is equivalent to
35263526-<quote><literal>push <function></literal></quote>.
36513651+This command can be used to execute any function. Functions are listed
36523652+in the <link linkend="functions">function reference</link>.
36533653+<quote><command>exec</command><literal>function</literal></quote> is
36543654+equivalent to <quote><literal>push <function></literal></quote>.
35273655</para>
3528365635293657</sect1>
···35543682</cmdsynopsis>
3555368335563684<para>
35573557-The <command>score</command> commands adds <emphasis>value</emphasis> to a message's score if <emphasis>pattern</emphasis>
35583558-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
35593559-which scan information not available in the index, such as <literal>#b</literal>,
35603560-<literal>#B</literal> or <literal>#h</literal>, may not be used). <emphasis>value</emphasis> is a
35613561-positive or negative integer. A message's final score is the sum total of all
35623562-matching <command>score</command> entries. However, you may optionally prefix <emphasis>value</emphasis> with
35633563-an equal sign (<quote>=</quote>) to cause evaluation to stop at a particular entry if there is
35643564-a match. Negative final scores are rounded up to 0.
36853685+The <command>score</command> commands adds <emphasis>value</emphasis> to
36863686+a message's score if <emphasis>pattern</emphasis> matches it.
36873687+<emphasis>pattern</emphasis> is a string in the format described in the
36883688+<link linkend="patterns">patterns</link> section (note: For efficiency
36893689+reasons, patterns which scan information not available in the index,
36903690+such as <literal>~b</literal>, <literal>~B</literal> or
36913691+<literal>~h</literal>, may not be used). <emphasis>value</emphasis> is
36923692+a positive or negative integer. A message's final score is the sum
36933693+total of all matching <command>score</command> entries. However, you
36943694+may optionally prefix <emphasis>value</emphasis> with an equal sign
36953695+(<quote>=</quote>) to cause evaluation to stop at a particular entry if
36963696+there is a match. Negative final scores are rounded up to 0.
35653697</para>
3566369835673699<para>
35683568-The <command>unscore</command> command removes score entries from the list. You <emphasis>must</emphasis>
35693569-specify the same pattern specified in the <command>score</command> command for it to be
35703570-removed. The pattern <quote>*</quote> is a special token which means to clear the list
35713571-of all score entries.
37003700+The <command>unscore</command> command removes score entries from the
37013701+list. You <emphasis>must</emphasis> specify the same pattern specified
37023702+in the <command>score</command> command for it to be removed. The
37033703+pattern <quote>*</quote> is a special token which means to clear the
37043704+list of all score entries.
35723705</para>
3573370635743707</sect1>
···35993732</cmdsynopsis>
3600373336013734<para>
36023602-Mutt has generalized support for external spam-scoring filters.
36033603-By defining your spam patterns with the <command>spam</command> and <literal>nospam</literal>
36043604-commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and <emphasis>sort</emphasis> your
36053605-mail based on its spam attributes, as determined by the external
36063606-filter. You also can display the spam attributes in your index
36073607-display using the <literal>%H</literal> selector in the <link linkend="index-format">$index_format</link> variable. (Tip: try <literal>%?H?[%H] ?</literal>
36083608-to display spam tags only when they are defined for a given message.)
37353735+Mutt has generalized support for external spam-scoring filters. By
37363736+defining your spam patterns with the <command>spam</command> and
37373737+<literal>nospam</literal> commands, you can <emphasis>limit</emphasis>,
37383738+<emphasis>search</emphasis>, and <emphasis>sort</emphasis> your mail
37393739+based on its spam attributes, as determined by the external filter. You
37403740+also can display the spam attributes in your index display using the
37413741+<literal>%H</literal> selector in the <link
37423742+linkend="index-format">$index_format</link> variable. (Tip: try
37433743+<literal>%?H?[%H] ?</literal> to display spam tags only when they are
37443744+defined for a given message.)
36093745</para>
3610374636113747<para>
36123748Your first step is to define your external filter's spam patterns using
36133613-the <command>spam</command> command. <emphasis>pattern</emphasis> should be a regular expression
36143614-that matches a header in a mail message. If any message in the mailbox
36153615-matches this regular expression, it will receive a <quote>spam tag</quote> or
36163616-<quote>spam attribute</quote> (unless it also matches a <command>nospam</command> pattern — see
36173617-below.) The appearance of this attribute is entirely up to you, and is
36183618-governed by the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> can be any static
36193619-text, but it also can include back-references from the <emphasis>pattern</emphasis>
36203620-expression. (A regular expression <quote>back-reference</quote> refers to a
36213621-sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
36223622-the first back-reference in the regex, <literal>%2</literal> with the second, etc.
37493749+the <command>spam</command> command. <emphasis>pattern</emphasis> should
37503750+be a regular expression that matches a header in a mail message. If any
37513751+message in the mailbox matches this regular expression, it will receive
37523752+a <quote>spam tag</quote> or <quote>spam attribute</quote> (unless it
37533753+also matches a <command>nospam</command> pattern — see below.) The
37543754+appearance of this attribute is entirely up to you, and is governed by
37553755+the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis>
37563756+can be any static text, but it also can include back-references from the
37573757+<emphasis>pattern</emphasis> expression. (A regular expression
37583758+<quote>back-reference</quote> refers to a sub-expression contained
37593759+within parentheses.) <literal>%1</literal> is replaced with the first
37603760+back-reference in the regex, <literal>%2</literal> with the second, etc.
36233761</para>
3624376236253763<para>
36263764To match spam tags, mutt needs the corresponding header information
36273765which is always the case for local and POP folders but not for IMAP in
36283766the default configuration. Depending on the spam header to be analyzed,
36293629-<link linkend="imap-headers">$imap_headers</link> may need
36303630-to be adjusted.
37673767+<link linkend="imap-headers">$imap_headers</link> may need to be
37683768+adjusted.
36313769</para>
3632377036333771<para>
36343634-If you're using multiple spam filters, a message can have more than
36353635-one spam-related header. You can define <command>spam</command> patterns for each
36363636-filter you use. If a message matches two or more of these patterns, and
36373637-the <link linkend="spam-separator">$spam_separator</link> variable is set to a string, then the
36383638-message's spam tag will consist of all the <emphasis>format</emphasis> strings joined
36393639-together, with the value of <link linkend="spam-separator">$spam_separator</link> separating
36403640-them.
37723772+If you're using multiple spam filters, a message can have more than one
37733773+spam-related header. You can define <command>spam</command> patterns for
37743774+each filter you use. If a message matches two or more of these patterns,
37753775+and the <link linkend="spam-separator">$spam_separator</link> variable
37763776+is set to a string, then the message's spam tag will consist of all the
37773777+<emphasis>format</emphasis> strings joined together, with the value of
37783778+<link linkend="spam-separator">$spam_separator</link> separating them.
36413779</para>
3642378036433781<para>
···36563794</example>
3657379536583796<para>
36593659-If then a message is received that DCC registered with <quote>many</quote> hits
36603660-under the <quote>Fuz2</quote> checksum, and that PureMessage registered with a
36613661-97% probability of being spam, that message's spam tag would read
36623662-<literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before <quote>=many</quote> in a
36633663-DCC report indicate the checksum used — in this case, <quote>Fuz2</quote>.)
37973797+If then a message is received that DCC registered with
37983798+<quote>many</quote> hits under the <quote>Fuz2</quote> checksum, and
37993799+that PureMessage registered with a 97% probability of being spam, that
38003800+message's spam tag would read <literal>90+/DCC-Fuz2,
38013801+97/PM</literal>. (The four characters before <quote>=many</quote> in a
38023802+DCC report indicate the checksum used — in this case,
38033803+<quote>Fuz2</quote>.)
36643804</para>
3665380536663806<para>
36673667-If the <link linkend="spam-separator">$spam_separator</link> variable is unset, then each
36683668-spam pattern match supersedes the previous one. Instead of getting
36693669-joined <emphasis>format</emphasis> strings, you'll get only the last one to match.
38073807+If the <link linkend="spam-separator">$spam_separator</link> variable is
38083808+unset, then each spam pattern match supersedes the previous one. Instead
38093809+of getting joined <emphasis>format</emphasis> strings, you'll get only
38103810+the last one to match.
36703811</para>
3671381236723813<para>
36733814The spam tag is what will be displayed in the index when you use
36743674-<literal>%H</literal> in the <link linkend="index-format">$index_format</link> variable. It's also the
36753675-string that the <literal>#H</literal> pattern-matching expression matches against for
36763676-<literal><search></literal> and <literal><limit></literal> functions. And it's what sorting by spam
36773677-attribute will use as a sort key.
38153815+<literal>%H</literal> in the <link
38163816+linkend="index-format">$index_format</link> variable. It's also the
38173817+string that the <literal>~H</literal> pattern-matching expression
38183818+matches against for <literal><search></literal> and
38193819+<literal><limit></literal> functions. And it's what sorting by
38203820+spam attribute will use as a sort key.
36783821</para>
3679382236803823<para>
···36853828</para>
3686382936873830<para>
36883688-Generally, when you sort by spam tag, Mutt will sort <emphasis>lexically</emphasis> —
36893689-that is, by ordering strings alphanumerically. However, if a spam tag
36903690-begins with a number, Mutt will sort numerically first, and lexically
36913691-only when two numbers are equal in value. (This is like UNIX's
36923692-<literal>sort -n</literal>.) A message with no spam attributes at all — that is, one
36933693-that didn't match <emphasis>any</emphasis> of your <command>spam</command> patterns — is sorted at
36943694-lowest priority. Numbers are sorted next, beginning with 0 and ranging
36953695-upward. Finally, non-numeric strings are sorted, with <quote>a</quote> taking lower
36963696-priority than <quote>z</quote>. Clearly, in general, sorting by spam tags is most
36973697-effective when you can coerce your filter to give you a raw number. But
36983698-in case you can't, Mutt can still do something useful.
38313831+Generally, when you sort by spam tag, Mutt will sort
38323832+<emphasis>lexically</emphasis> — that is, by ordering strings
38333833+alphanumerically. However, if a spam tag begins with a number, Mutt will
38343834+sort numerically first, and lexically only when two numbers are equal in
38353835+value. (This is like UNIX's <literal>sort -n</literal>.) A message with
38363836+no spam attributes at all — that is, one that didn't match
38373837+<emphasis>any</emphasis> of your <command>spam</command> patterns
38383838+— is sorted at lowest priority. Numbers are sorted next, beginning
38393839+with 0 and ranging upward. Finally, non-numeric strings are sorted, with
38403840+<quote>a</quote> taking lower priority than <quote>z</quote>. Clearly,
38413841+in general, sorting by spam tags is most effective when you can coerce
38423842+your filter to give you a raw number. But in case you can't, Mutt can
38433843+still do something useful.
36993844</para>
3700384537013846<para>
37023702-The <command>nospam</command> command can be used to write exceptions to <command>spam</command>
37033703-patterns. If a header pattern matches something in a <command>spam</command> command,
37043704-but you nonetheless do not want it to receive a spam tag, you can list a
37053705-more precise pattern under a <command>nospam</command> command.
38473847+The <command>nospam</command> command can be used to write exceptions to
38483848+<command>spam</command> patterns. If a header pattern matches something
38493849+in a <command>spam</command> command, but you nonetheless do not want it
38503850+to receive a spam tag, you can list a more precise pattern under a
38513851+<command>nospam</command> command.
37063852</para>
3707385337083854<para>
37093709-If the <emphasis>pattern</emphasis> given to <command>nospam</command> is exactly the same as the
37103710-<emphasis>pattern</emphasis> on an existing <command>spam</command> list entry, the effect will be to
37113711-remove the entry from the spam list, instead of adding an exception.
37123712-Likewise, if the <emphasis>pattern</emphasis> for a <command>spam</command> command matches an entry
37133713-on the <command>nospam</command> list, that nospam entry will be removed. If the
37143714-<emphasis>pattern</emphasis> for <command>nospam</command> is <quote>*</quote>, <emphasis>all entries on both lists</emphasis>
37153715-will be removed. This might be the default action if you use <command>spam</command>
37163716-and <command>nospam</command> in conjunction with a <command>folder-hook</command>.
38553855+If the <emphasis>pattern</emphasis> given to <command>nospam</command>
38563856+is exactly the same as the <emphasis>pattern</emphasis> on an existing
38573857+<command>spam</command> list entry, the effect will be to remove the
38583858+entry from the spam list, instead of adding an exception. Likewise, if
38593859+the <emphasis>pattern</emphasis> for a <command>spam</command> command
38603860+matches an entry on the <command>nospam</command> list, that nospam
38613861+entry will be removed. If the <emphasis>pattern</emphasis> for
38623862+<command>nospam</command> is <quote>*</quote>, <emphasis>all entries on
38633863+both lists</emphasis> will be removed. This might be the default action
38643864+if you use <command>spam</command> and <command>nospam</command> in
38653865+conjunction with a <command>folder-hook</command>.
37173866</para>
3718386737193868<para>
37203720-You can have as many <command>spam</command> or <command>nospam</command> commands as you like.
37213721-You can even do your own primitive <command>spam</command> detection within Mutt — for
37223722-example, if you consider all mail from <literal>MAILER-DAEMON</literal> to be spam,
37233723-you can use a <command>spam</command> command like this:
38693869+You can have as many <command>spam</command> or
38703870+<command>nospam</command> commands as you like. You can even do your
38713871+own primitive <command>spam</command> detection within Mutt — for
38723872+example, if you consider all mail from <literal>MAILER-DAEMON</literal>
38733873+to be spam, you can use a <command>spam</command> command like this:
37243874</para>
3725387537263876<screen>
···37703920<para>
37713921A specialized string for representing paths including support for
37723922mailbox shortcuts (see <xref linkend="shortcuts"/>) as well as tilde
37733773-(<quote>#</quote>) for a user's home directory and more.
39233923+(<quote>~</quote>) for a user's home directory and more.
37743924</para>
37753925</listitem>
37763926</varlistentry>
···38063956<listitem>
38073957<para>
38083958Specifies the type of folder to use: <emphasis>mbox</emphasis>,
38093809-<emphasis>mmdf</emphasis>, <emphasis>mh</emphasis>
38103810-or <emphasis>maildir</emphasis>.
38113811-Currently only used to determine the type for newly created folders.
39593959+<emphasis>mmdf</emphasis>, <emphasis>mh</emphasis> or
39603960+<emphasis>maildir</emphasis>. Currently only used to determine the type
39613961+for newly created folders.
38123962</para>
38133963</listitem>
38143964</varlistentry>
···38163966<term>e-mail address</term>
38173967<listitem>
38183968<para>
38193819-An e-mail address either with or without
38203820-realname. The older <quote><literal>user@example.org (Joe User)</literal></quote>
38213821-form is supported but strongly deprecated.
39693969+An e-mail address either with or without realname. The older
39703970+<quote><literal>user@example.org (Joe User)</literal></quote> form is
39713971+supported but strongly deprecated.
38223972</para>
38233973</listitem>
38243974</varlistentry>
···38854035</cmdsynopsis>
3886403638874037<para>
38883888-This command is used to set (and unset) <link linkend="variables">configuration variables</link>. There are four basic types of variables:
38893889-boolean, number, string and quadoption. <emphasis>boolean</emphasis> variables can be
38903890-<emphasis>set</emphasis> (true) or <emphasis>unset</emphasis> (false). <emphasis>number</emphasis> variables can be
38913891-assigned a positive integer value.
38923892-<emphasis>string</emphasis> variables consist of any number of printable characters and
38933893-must be enclosed in quotes if they contain spaces or tabs. You
38943894-may also use the escape sequences <quote>\n</quote> and <quote>\t</quote> for newline and tab, respectively.
38953895-<emphasis>quadoption</emphasis> variables are used to control whether or not to be prompted
38963896-for certain actions, or to specify a default action. A value of <emphasis>yes</emphasis>
38973897-will cause the action to be carried out automatically as if you had answered
38983898-yes to the question. Similarly, a value of <emphasis>no</emphasis> will cause the
38993899-action to be carried out as if you had answered <quote>no.</quote> A value of
39003900-<emphasis>ask-yes</emphasis> will cause a prompt with a default answer of <quote>yes</quote> and
39013901-<emphasis>ask-no</emphasis> will provide a default answer of <quote>no.</quote>
40384038+This command is used to set (and unset) <link
40394039+linkend="variables">configuration variables</link>. There are four
40404040+basic types of variables: boolean, number, string and quadoption.
40414041+<emphasis>boolean</emphasis> variables can be <emphasis>set</emphasis>
40424042+(true) or <emphasis>unset</emphasis> (false).
40434043+<emphasis>number</emphasis> variables can be assigned a positive integer
40444044+value. <emphasis>string</emphasis> variables consist of any number of
40454045+printable characters and must be enclosed in quotes if they contain
40464046+spaces or tabs. You may also use the escape sequences <quote>\n</quote>
40474047+and <quote>\t</quote> for newline and tab, respectively.
40484048+<emphasis>quadoption</emphasis> variables are used to control whether or
40494049+not to be prompted for certain actions, or to specify a default action.
40504050+A value of <emphasis>yes</emphasis> will cause the action to be carried
40514051+out automatically as if you had answered yes to the question.
40524052+Similarly, a value of <emphasis>no</emphasis> will cause the action to
40534053+be carried out as if you had answered <quote>no.</quote> A value of
40544054+<emphasis>ask-yes</emphasis> will cause a prompt with a default answer
40554055+of <quote>yes</quote> and <emphasis>ask-no</emphasis> will provide a
40564056+default answer of <quote>no.</quote>
39024057</para>
3903405839044059<para>
39053905-Prefixing a variable with <quote>no</quote> will unset it. Example: <literal><command>set</command> noaskbcc</literal>.
40604060+Prefixing a variable with <quote>no</quote> will unset it. Example:
40614061+<literal><command>set</command> noaskbcc</literal>.
39064062</para>
3907406339084064<para>
39093909-For <emphasis>boolean</emphasis> variables, you may optionally prefix the variable name with
39103910-<literal>inv</literal> to toggle the value (on or off). This is useful when writing
39113911-macros. Example: <literal><command>set</command> invsmart_wrap</literal>.
40654065+For <emphasis>boolean</emphasis> variables, you may optionally prefix
40664066+the variable name with <literal>inv</literal> to toggle the value (on or
40674067+off). This is useful when writing macros. Example:
40684068+<literal><command>set</command> invsmart_wrap</literal>.
39124069</para>
3913407039144071<para>
39153915-The <command>toggle</command> command automatically prepends the <literal>inv</literal> prefix to all
39163916-specified variables.
40724072+The <command>toggle</command> command automatically prepends the
40734073+<literal>inv</literal> prefix to all specified variables.
39174074</para>
3918407539194076<para>
39203920-The <command>unset</command> command automatically prepends the <literal>no</literal> prefix to all
39213921-specified variables.
40774077+The <command>unset</command> command automatically prepends the
40784078+<literal>no</literal> prefix to all specified variables.
39224079</para>
3923408039244081<para>
39253925-Using the <literal><enter-command></literal> function in the <emphasis>index</emphasis> menu, you can query the
39263926-value of a variable by prefixing the name of the variable with a question
39273927-mark:
40824082+Using the <literal><enter-command></literal> function in the
40834083+<emphasis>index</emphasis> menu, you can query the value of a variable
40844084+by prefixing the name of the variable with a question mark:
39284085</para>
3929408639304087<screen>
···39374094</para>
3938409539394096<para>
39403940-The <command>reset</command> command resets all given variables to the compile time
39413941-defaults (hopefully mentioned in this manual). If you use the command
39423942-<command>set</command> and prefix the variable with <quote>&</quote> this has the same
39433943-behavior as the <command>reset</command> command.
40974097+The <command>reset</command> command resets all given variables to the
40984098+compile time defaults (hopefully mentioned in this manual). If you use
40994099+the command <command>set</command> and prefix the variable with
41004100+<quote>&</quote> this has the same behavior as the
41014101+<command>reset</command> command.
39444102</para>
3945410339464104<para>
39473947-With the <command>reset</command> command there exists the special variable <quote>all</quote>,
39483948-which allows you to reset all variables to their system defaults.
41054105+With the <command>reset</command> command there exists the special
41064106+variable <quote>all</quote>, which allows you to reset all variables to
41074107+their system defaults.
39494108</para>
3950410939514110</sect2>
···39574116<title>Introduction</title>
3958411739594118<para>
39603960-Along with the variables listed in the
39613961-<link linkend="variables">Configuration variables</link> section, Mutt
39623962-supports user-defined variables with names starting
39633963-with <literal>my_</literal> as in, for
39643964-example, <literal>my_cfgdir</literal>.
41194119+Along with the variables listed in the <link
41204120+linkend="variables">Configuration variables</link> section, Mutt
41214121+supports user-defined variables with names starting with
41224122+<literal>my_</literal> as in, for example, <literal>my_cfgdir</literal>.
39654123</para>
3966412439674125<para>
39683968-The <command>set</command> command either creates a
39693969-custom <literal>my_</literal> variable or changes its
39703970-value if it does exist already. The <command>unset</command> and <command>reset</command>
41264126+The <command>set</command> command either creates a custom
41274127+<literal>my_</literal> variable or changes its value if it does exist
41284128+already. The <command>unset</command> and <command>reset</command>
39714129commands remove the variable entirely.
39724130</para>
3973413139744132<para>
39754133Since user-defined variables are expanded in the same way that
39763976-environment variables are (except for
39773977-the <link linkend="shell-escape">shell-escape</link> command and
39783978-backtick expansion), this feature can be used to make configuration
39793979-files more readable.
41344134+environment variables are (except for the <link
41354135+linkend="shell-escape">shell-escape</link> command and backtick
41364136+expansion), this feature can be used to make configuration files more
41374137+readable.
39804138</para>
3981413939824140</sect3>
···39854143<title>Examples</title>
3986414439874145<para>
39883988-The following example defines and uses the variable <literal>my_cfgdir</literal>
39893989-to abbreviate the calls of the <link linkend="source"><command>source</command></link> command:
41464146+The following example defines and uses the variable
41474147+<literal>my_cfgdir</literal> to abbreviate the calls of the <link
41484148+linkend="source"><command>source</command></link> command:
39904149</para>
3991415039924151<example id="ex-myvar1">
···4002416140034162<para>
40044163A custom variable can also be used in macros to backup the current value
40054005-of another variable. In the following example, the value of the
40064006-<link linkend="delete">$delete</link> is changed temporarily
40074007-while its original value is saved as <literal>my_delete</literal>.
40084008-After the macro has executed all commands, the original value of <link
41644164+of another variable. In the following example, the value of the <link
41654165+linkend="delete">$delete</link> is changed temporarily while its
41664166+original value is saved as <literal>my_delete</literal>. After the
41674167+macro has executed all commands, the original value of <link
40094168linkend="delete">$delete</link> is restored.
40104169</para>
40114170···40444203</example>
4045420440464205<para>
40474047-Note that there is a space
40484048-between <literal><enter-command></literal> and
40494049-the <command>set</command> configuration command, preventing Mutt from
40504050-recording the <command>macro</command>'s commands into its history.
42064206+Note that there is a space between
42074207+<literal><enter-command></literal> and the <command>set</command>
42084208+configuration command, preventing Mutt from recording the
42094209+<command>macro</command>'s commands into its history.
40514210</para>
4052421140534212</sect3>
···40614220Variables are always assigned string values which Mutt parses into its
40624221internal representation according to the type of the variable, for
40634222example an integer number for numeric types. For all queries (including
40644064-$-expansion) the value is converted from its internal type back
40654065-into string. As a result, any variable can be assigned any value given
40664066-that its content is valid for the target. This also counts for custom
42234223+$-expansion) the value is converted from its internal type back into
42244224+string. As a result, any variable can be assigned any value given that
42254225+its content is valid for the target. This also counts for custom
40674226variables which are of type string. In case of parsing errors, Mutt will
40684227print error messages. <xref linkend="ex-myvar4"/> demonstrates type
40694228conversions.
···41144273mailboxes $my_mx +mailbox3</screen>
4115427441164275<para>
41174117-because the value of <literal>$my_mx</literal> is
41184118-interpreted as a single mailbox named <quote>+mailbox1 +mailbox2</quote>
41194119-and not two distinct mailboxes.
42764276+because the value of <literal>$my_mx</literal> is interpreted as a
42774277+single mailbox named <quote>+mailbox1 +mailbox2</quote> and not two
42784278+distinct mailboxes.
41204279</para>
4121428041224281</sect2>
···41364295</cmdsynopsis>
4137429641384297<para>
41394139-This command allows the inclusion of initialization commands
41404140-from other files. For example, I place all of my aliases in
41414141-<literal>#/.mail_aliases</literal> so that I can make my
41424142-<literal>#/.muttrc</literal> readable and keep my aliases private.
42984298+This command allows the inclusion of initialization commands from other
42994299+files. For example, I place all of my aliases in
43004300+<literal>~/.mail_aliases</literal> so that I can make my
43014301+<literal>~/.muttrc</literal> readable and keep my aliases private.
41434302</para>
4144430341454304<para>
41464146-If the filename begins with a tilde (<quote>#</quote>), it will be expanded to the
41474147-path of your home directory.
43054305+If the filename begins with a tilde (<quote>~</quote>), it will be
43064306+expanded to the path of your home directory.
41484307</para>
4149430841504309<para>
41514151-If the filename ends with a vertical bar (<quote>|</quote>), then <emphasis>filename</emphasis> is
41524152-considered to be an executable program from which to read input (eg.
41534153-<literal><command>source</command> #/bin/myscript|</literal>).
43104310+If the filename ends with a vertical bar (<quote>|</quote>), then
43114311+<emphasis>filename</emphasis> is considered to be an executable program
43124312+from which to read input (eg. <literal><command>source</command>
43134313+~/bin/myscript|</literal>).
41544314</para>
4155431541564316</sect1>
···4174433441754335<para>
41764336This command permits you to flush hooks you have previously defined.
41774177-You can either remove all hooks by giving the <quote>*</quote> character as an
41784178-argument, or you can remove all hooks of a specific type by saying
43374337+You can either remove all hooks by giving the <quote>*</quote> character
43384338+as an argument, or you can remove all hooks of a specific type by saying
41794339something like <literal><command>unhook</command> send-hook</literal>.
41804340</para>
41814341···4189434941904350<para>
41914351Format strings are a general concept you'll find in several locations
41924192-through the Mutt configuration, especially in the
41934193-<link linkend="index-format">$index_format</link>,
41944194-<link linkend="pager-format">$pager_format</link>,
41954195-<link linkend="status-format">$status_format</link>,
41964196-and other related variables. These can be very straightforward,
41974197-and it's quite possible you already know how to use them.
43524352+through the Mutt configuration, especially in the <link
43534353+linkend="index-format">$index_format</link>, <link
43544354+linkend="pager-format">$pager_format</link>, <link
43554355+linkend="status-format">$status_format</link>, and other related
43564356+variables. These can be very straightforward, and it's quite possible
43574357+you already know how to use them.
41984358</para>
4199435942004360<para>
42014201-The most basic format string element is a percent symbol followed
42024202-by another character. For example, <literal>%s</literal>
42034203-represents a message's Subject: header in the <link
43614361+The most basic format string element is a percent symbol followed by
43624362+another character. For example, <literal>%s</literal> represents a
43634363+message's Subject: header in the <link
42044364linkend="index-format">$index_format</link> variable. The
42054205-<quote>expandos</quote> available are documented with each format variable, but
42064206-there are general modifiers available with all formatting expandos,
42074207-too. Those are our concern here.
43654365+<quote>expandos</quote> available are documented with each format
43664366+variable, but there are general modifiers available with all formatting
43674367+expandos, too. Those are our concern here.
42084368</para>
4209436942104370<para>
42114211-Some of the modifiers are borrowed right out of C (though you might
42124212-know them from Perl, Python, shell, or another language). These are
42134213-the <literal>[-]m.n</literal> modifiers, as in <literal>%-12.12s</literal>. As with
42144214-such programming languages, these modifiers allow you to specify the
42154215-minimum and maximum size of the resulting string, as well as its
42164216-justification. If the <quote>-</quote> sign follows the percent, the string will
42174217-be left-justified instead of right-justified. If there's a number
42184218-immediately following that, it's the minimum amount of space the
42194219-formatted string will occupy — if it's naturally smaller than that, it
42204220-will be padded out with spaces. If a decimal point and another number
42214221-follow, that's the maximum space allowable — the string will not be
42224222-permitted to exceed that width, no matter its natural size. Each of
42234223-these three elements is optional, so that all these are legal format
42244224-strings: <literal>%-12s</literal>, <literal>%4c</literal>,
42254225-<literal>%.15F</literal> and <literal>%-12.15L</literal>.
43714371+Some of the modifiers are borrowed right out of C (though you might know
43724372+them from Perl, Python, shell, or another language). These are the
43734373+<literal>[-]m.n</literal> modifiers, as in
43744374+<literal>%-12.12s</literal>. As with such programming languages, these
43754375+modifiers allow you to specify the minimum and maximum size of the
43764376+resulting string, as well as its justification. If the <quote>-</quote>
43774377+sign follows the percent, the string will be left-justified instead of
43784378+right-justified. If there's a number immediately following that, it's
43794379+the minimum amount of space the formatted string will occupy — if
43804380+it's naturally smaller than that, it will be padded out with spaces. If
43814381+a decimal point and another number follow, that's the maximum space
43824382+allowable — the string will not be permitted to exceed that width,
43834383+no matter its natural size. Each of these three elements is optional, so
43844384+that all these are legal format strings: <literal>%-12s</literal>,
43854385+<literal>%4c</literal>, <literal>%.15F</literal> and
43864386+<literal>%-12.15L</literal>.
42264387</para>
4227438842284389<para>
42294390Mutt adds some other modifiers to format strings. If you use an equals
42304391symbol (<literal>=</literal>) as a numeric prefix (like the minus
42314231-above), it will force the string to be centered within its minimum
42324232-space range. For example, <literal>%=14y</literal> will reserve 14
42334233-characters for the %y expansion — that's the X-Label: header, in
42344234-<link linkend="index-format">$index_format</link>. If the expansion
42354235-results in a string less than 14 characters, it will be centered in a
42364236-14-character space. If the X-Label for a message were <quote>test</quote>, that
42374237-expansion would look like <quote> test </quote>.
43924392+above), it will force the string to be centered within its minimum space
43934393+range. For example, <literal>%=14y</literal> will reserve 14 characters
43944394+for the %y expansion — that's the X-Label: header, in <link
43954395+linkend="index-format">$index_format</link>. If the expansion results in
43964396+a string less than 14 characters, it will be centered in a 14-character
43974397+space. If the X-Label for a message were <quote>test</quote>, that
43984398+expansion would look like
43994399+<quote> test </quote>.
42384400</para>
4239440142404402<para>
42414403There are two very little-known modifiers that affect the way that an
42424242-expando is replaced. If there is an underline (<quote>_</quote>) character
42434243-between any format modifiers (as above) and the expando letter, it will
42444244-expands in all lower case. And if you use a colon (<quote>:</quote>), it will
42454245-replace all decimal points with underlines.
44044404+expando is replaced. If there is an underline (<quote>_</quote>)
44054405+character between any format modifiers (as above) and the expando
44064406+letter, it will expands in all lower case. And if you use a colon
44074407+(<quote>:</quote>), it will replace all decimal points with underlines.
42464408</para>
4247440942484410</sect2>
···4264442642654427<para>
42664428where <emphasis>sequence_char</emphasis> is an expando, and
42674267-<emphasis>optional_string</emphasis> is the string you would like printed if
42684268-<emphasis>sequence_char</emphasis> is nonzero.
42694269-<emphasis>optional_string</emphasis> may contain other
42704270-sequences as well as normal text, but you may not nest optional
42714271-strings.
44294429+<emphasis>optional_string</emphasis> is the string you would like
44304430+printed if <emphasis>sequence_char</emphasis> is nonzero.
44314431+<emphasis>optional_string</emphasis> may contain other sequences as well
44324432+as normal text, but you may not nest optional strings.
42724433</para>
4273443442744435<para>
42754436Here is an example illustrating how to optionally print the number of
42764276-new messages in a mailbox in
42774277-<link linkend="status-format">$status_format</link>:
44374437+new messages in a mailbox in <link
44384438+linkend="status-format">$status_format</link>:
42784439</para>
4279444042804441<screen>
···42884449%?<sequence_char>?<if_string>&<else_string>?</screen>
4289445042904451<para>
42914291-If the value of <emphasis>sequence_char</emphasis> is
42924292-non-zero, <emphasis>if_string</emphasis> will be expanded,
42934293-otherwise <emphasis>else_string</emphasis> will be expanded.
44524452+If the value of <emphasis>sequence_char</emphasis> is non-zero,
44534453+<emphasis>if_string</emphasis> will be expanded, otherwise
44544454+<emphasis>else_string</emphasis> will be expanded.
42944455</para>
4295445642964457</sect2>
···4300446143014462<para>
43024463Any format string ending in a vertical bar (<quote>|</quote>) will be
43034303-expanded and piped through the first word in the string, using spaces
43044304-as separator. The string returned will be used for display.
43054305-If the returned string ends in %, it will be passed through
43064306-the formatter a second time. This allows the filter to generate a
43074307-replacement format string including % expandos.
44644464+expanded and piped through the first word in the string, using spaces as
44654465+separator. The string returned will be used for display. If the
44664466+returned string ends in %, it will be passed through the formatter a
44674467+second time. This allows the filter to generate a replacement format
44684468+string including % expandos.
43084469</para>
4309447043104471<para>
43114311-All % expandos in a format string are expanded before the script
43124312-is called so that:
44724472+All % expandos in a format string are expanded before the script is
44734473+called so that:
43134474</para>
4314447543154476<example id="ex-fmtpipe">
···43204481</example>
4321448243224483<para>
43234323-will make Mutt expand <literal>%r</literal>,
43244324-<literal>%f</literal> and <literal>%L</literal>
43254325-before calling the script. The example also shows that arguments can be
43264326-quoted: the script will receive the expanded string between the single quotes
43274327-as the only argument.
44844484+will make Mutt expand <literal>%r</literal>, <literal>%f</literal> and
44854485+<literal>%L</literal> before calling the script. The example also shows
44864486+that arguments can be quoted: the script will receive the expanded
44874487+string between the single quotes as the only argument.
43284488</para>
4329448943304490<para>
43314331-A practical example is the <literal>mutt_xtitle</literal>
43324332-script installed in the <literal>samples</literal>
43334333-subdirectory of the Mutt documentation: it can be used as filter for
43344334-<link linkend="status-format">$status_format</link> to set the current
44914491+A practical example is the <literal>mutt_xtitle</literal> script
44924492+installed in the <literal>samples</literal> subdirectory of the Mutt
44934493+documentation: it can be used as filter for <link
44944494+linkend="status-format">$status_format</link> to set the current
43354495terminal's title, if supported.
43364496</para>
43374497···43504510<term><literal>%|X</literal></term>
43514511<listitem>
43524512<para>
43534353-When this occurs, Mutt will fill the rest of the
43544354-line with the character <literal>X</literal>. For
43554355-example, filling the rest of the line with dashes is
43564356-done by setting:
45134513+When this occurs, Mutt will fill the rest of the line with the character
45144514+<literal>X</literal>. For example, filling the rest of the line with
45154515+dashes is done by setting:
43574516</para>
43584517<screen>
43594518set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</screen>
···43894548showing padding only if there's still room. If necessary, soft-fill will
43904549eat text leftwards to make room for rightward text. For example, to
43914550right-justify the subject making sure as much as possible of it fits on
43924392-screen, one might use (note two spaces after <literal>%*
43934393-</literal>: the second ensures there's a space between the truncated
43944394-right-hand side and the subject):
45514551+screen, one might use (note two spaces after <literal>%* </literal>: the
45524552+second ensures there's a space between the truncated right-hand side and
45534553+the subject):
43954554</para>
43964555<screen>
43974556set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"</screen>
···44634622<title>Regular Expressions</title>
4464462344654624<para>
44664466-All string patterns in Mutt including those in more complex
44674467-<link linkend="patterns">patterns</link> must be specified
44684468-using regular expressions (regexp) in the <quote>POSIX extended</quote> syntax (which
46254625+All string patterns in Mutt including those in more complex <link
46264626+linkend="patterns">patterns</link> must be specified using regular
46274627+expressions (regexp) in the <quote>POSIX extended</quote> syntax (which
44694628is more or less the syntax used by egrep and GNU awk). For your
44704629convenience, we have included below a brief description of this syntax.
44714630</para>
···4477463644784637<note>
44794638<para>
44804480-<quote>\</quote>
44814481-must be quoted if used for a regular expression in an initialization
44824482-command: <quote>\\</quote>.
46394639+<quote>\</quote> must be quoted if used for a regular expression in an
46404640+initialization command: <quote>\\</quote>.
44834641</para>
44844642</note>
44854643···4491464944924650<note>
44934651<para>
44944494-The regular expression can be enclosed/delimited by either "
44954495-or ' which is useful if the regular expression includes a white-space
44964496-character. See <xref linkend="muttrc-syntax"/>
44974497-for more information on " and ' delimiter processing. To match a
44984498-literal " or ' you must preface it with \ (backslash).
46524652+The regular expression can be enclosed/delimited by either " or ' which
46534653+is useful if the regular expression includes a white-space character.
46544654+See <xref linkend="muttrc-syntax"/> for more information on " and '
46554655+delimiter processing. To match a literal " or ' you must preface it
46564656+with \ (backslash).
44994657</para>
45004658</note>
4501465945024660<para>
45034503-The fundamental building blocks are the regular expressions that match
45044504-a single character. Most characters, including all letters and digits,
46614661+The fundamental building blocks are the regular expressions that match a
46624662+single character. Most characters, including all letters and digits,
45054663are regular expressions that match themselves. Any metacharacter with
45064664special meaning may be quoted by preceding it with a backslash.
45074665</para>
4508466645094667<para>
45104510-The period <quote>.</quote> matches any single character. The caret <quote>^</quote> and
45114511-the dollar sign <quote>$</quote> are metacharacters that respectively match
45124512-the empty string at the beginning and end of a line.
46684668+The period <quote>.</quote> matches any single character. The caret
46694669+<quote>^</quote> and the dollar sign <quote>$</quote> are metacharacters
46704670+that respectively match the empty string at the beginning and end of a
46714671+line.
45134672</para>
4514467345154674<para>
45164516-A list of characters enclosed by <quote>[</quote> and <quote>]</quote> matches any
45174517-single character in that list; if the first character of the list
45184518-is a caret <quote>^</quote> then it matches any character <emphasis>not</emphasis> in the
45194519-list. For example, the regular expression <emphasis>[0123456789]</emphasis>
45204520-matches any single digit. A range of ASCII characters may be specified
45214521-by giving the first and last characters, separated by a hyphen
45224522-<quote>-</quote>. Most metacharacters lose their special meaning inside
45234523-lists. To include a literal <quote>]</quote> place it first in the list.
45244524-Similarly, to include a literal <quote>^</quote> place it anywhere but first.
46754675+A list of characters enclosed by <quote>[</quote> and <quote>]</quote>
46764676+matches any single character in that list; if the first character of the
46774677+list is a caret <quote>^</quote> then it matches any character
46784678+<emphasis>not</emphasis> in the list. For example, the regular
46794679+expression <emphasis>[0123456789]</emphasis> matches any single digit.
46804680+A range of ASCII characters may be specified by giving the first and
46814681+last characters, separated by a hyphen <quote>-</quote>. Most
46824682+metacharacters lose their special meaning inside lists. To include a
46834683+literal <quote>]</quote> place it first in the list. Similarly, to
46844684+include a literal <quote>^</quote> place it anywhere but first.
45254685Finally, to include a literal hyphen <quote>-</quote> place it last.
45264686</para>
4527468745284688<para>
45294689Certain named classes of characters are predefined. Character classes
45304530-consist of <quote>[:</quote>, a keyword denoting the class, and <quote>:]</quote>.
45314531-The following classes are defined by the POSIX standard in
46904690+consist of <quote>[:</quote>, a keyword denoting the class, and
46914691+<quote>:]</quote>. The following classes are defined by the POSIX
46924692+standard in
45324693<xref linkend="posix-regex-char-classes"/>
45334694</para>
45344695···4562472345634724<note>
45644725<para>
45654565-Note that the brackets in these
45664566-class names are part of the symbolic names, and must be included
45674567-in addition to the brackets delimiting the bracket list. For
45684568-example, <emphasis>[[:digit:]]</emphasis> is equivalent to
45694569-<emphasis>[0-9]</emphasis>.
47264726+Note that the brackets in these class names are part of the symbolic
47274727+names, and must be included in addition to the brackets delimiting the
47284728+bracket list. For example, <emphasis>[[:digit:]]</emphasis> is
47294729+equivalent to <emphasis>[0-9]</emphasis>.
45704730</para>
45714731</note>
45724732···45854745<listitem>
45864746<para>
45874747A collating symbol is a multi-character collating element enclosed in
45884588-<quote>[.</quote> and <quote>.]</quote>. For example, if <quote>ch</quote> is a collating
45894589-element, then <emphasis>[[.ch.]]</emphasis> is a regexp that matches
45904590-this collating element, while <emphasis>[ch]</emphasis> is a regexp that
45914591-matches either <quote>c</quote> or <quote>h</quote>.
47484748+<quote>[.</quote> and <quote>.]</quote>. For example, if
47494749+<quote>ch</quote> is a collating element, then
47504750+<emphasis>[[.ch.]]</emphasis> is a regexp that matches this collating
47514751+element, while <emphasis>[ch]</emphasis> is a regexp that matches either
47524752+<quote>c</quote> or <quote>h</quote>.
45924753</para>
45934754</listitem>
45944755</varlistentry>
···45964757<term>Equivalence Classes</term>
45974758<listitem>
45984759<para>
45994599-An equivalence class is a locale-specific name for a list of
46004600-characters that are equivalent. The name is enclosed in <quote>[=</quote>
46014601-and <quote>=]</quote>. For example, the name <quote>e</quote> might be used to
46024602-represent all of <quote>è</quote> <quote>é</quote> and <quote>e</quote>. In this case,
46034603-<emphasis>[[=e=]]</emphasis> is a regexp that matches any of
46044604-<quote>è</quote>, <quote>é</quote> and <quote>e</quote>.
47604760+An equivalence class is a locale-specific name for a list of characters
47614761+that are equivalent. The name is enclosed in <quote>[=</quote> and
47624762+<quote>=]</quote>. For example, the name <quote>e</quote> might be used
47634763+to represent all of <quote>è</quote> <quote>é</quote> and
47644764+<quote>e</quote>. In this case, <emphasis>[[=e=]]</emphasis> is a
47654765+regexp that matches any of <quote>è</quote>,
47664766+<quote>é</quote> and <quote>e</quote>.
46054767</para>
46064768</listitem>
46074769</varlistentry>
···4609477146104772<para>
46114773A regular expression matching a single character may be followed by one
46124612-of several repetition operators described in <xref linkend="regex-repeat"/>.
47744774+of several repetition operators described in <xref
47754775+linkend="regex-repeat"/>.
46134776</para>
4614477746154778<table id="regex-repeat">
···46374800</para>
4638480146394802<para>
46404640-Two regular expressions may be joined by the infix operator <quote>|</quote>;
46414641-the resulting regular expression matches any string matching either
46424642-subexpression.
48034803+Two regular expressions may be joined by the infix operator
48044804+<quote>|</quote>; the resulting regular expression matches any string
48054805+matching either subexpression.
46434806</para>
4644480746454808<para>
···46514814<note>
46524815<para>
46534816If you compile Mutt with the included regular expression engine, the
46544654-following operators may also be used in regular expressions as described in <xref linkend="regex-gnu-ext"/>.
48174817+following operators may also be used in regular expressions as described
48184818+in <xref linkend="regex-gnu-ext"/>.
46554819</para>
46564820</note>
46574821···47574921</table>
4758492247594923<para>
47604760-Where <emphasis>EXPR</emphasis> is a
47614761-<link linkend="regexp">regular expression</link>.
49244924+Where <emphasis>EXPR</emphasis> is a <link linkend="regexp">regular
49254925+expression</link>.
47624926</para>
4763492747644928<para>
47654765-*) The forms <quote><[<emphasis>MAX</emphasis>]</quote>, <quote>>[<emphasis>MIN</emphasis>]</quote>,
47664766-<quote>[<emphasis>MIN</emphasis>]-</quote> and <quote>-[<emphasis>MAX</emphasis>]</quote>
47674767-are allowed, too.
49294929+*) The forms <quote><[<emphasis>MAX</emphasis>]</quote>,
49304930+<quote>>[<emphasis>MIN</emphasis>]</quote>,
49314931+<quote>[<emphasis>MIN</emphasis>]-</quote> and
49324932+<quote>-[<emphasis>MAX</emphasis>]</quote> are allowed, too.
47684933</para>
4769493447704935<para>
47714771-**) The suffixes <quote>K</quote> and <quote>M</quote> are allowed to specify kilobyte and megabyte respectively.
49364936+**) The suffixes <quote>K</quote> and <quote>M</quote> are allowed to
49374937+specify kilobyte and megabyte respectively.
47724938</para>
4773493947744940<para>
47754775-Special attention has to be
47764776-payed when using regular expressions inside of patterns. Specifically,
47774777-Mutt's parser for these patterns will strip one level of backslash (<quote>\</quote>),
47784778-which is normally used for quoting. If it is your intention to use a
47794779-backslash in the regular expression, you will need to use two backslashes
47804780-instead (<quote>\\</quote>). You can force Mutt to treat <emphasis>EXPR</emphasis> as a simple string
47814781-instead of a regular expression by using = instead of # in the
47824782-pattern name. For example, <literal>=b *.*</literal> will find all messages that contain
47834783-the literal string <quote>*.*</quote>. Simple string matches are less powerful than
47844784-regular expressions but can be considerably faster. This is especially
47854785-true for IMAP folders, because string matches can be performed on the
47864786-server instead of by fetching every message. IMAP treats <literal>=h</literal> specially:
47874787-it must be of the form <quote>header: substring</quote> and will not partially
47884788-match header names. The substring part may be omitted if you simply
47894789-wish to find messages containing a particular header without regard to
47904790-its value.
49414941+Special attention has to be payed when using regular expressions inside
49424942+of patterns. Specifically, Mutt's parser for these patterns will strip
49434943+one level of backslash (<quote>\</quote>), which is normally used for
49444944+quoting. If it is your intention to use a backslash in the regular
49454945+expression, you will need to use two backslashes instead
49464946+(<quote>\\</quote>). You can force Mutt to treat
49474947+<emphasis>EXPR</emphasis> as a simple string instead of a regular
49484948+expression by using = instead of ~ in the pattern name. For example,
49494949+<literal>=b *.*</literal> will find all messages that contain the
49504950+literal string <quote>*.*</quote>. Simple string matches are less
49514951+powerful than regular expressions but can be considerably faster. This
49524952+is especially true for IMAP folders, because string matches can be
49534953+performed on the server instead of by fetching every message. IMAP
49544954+treats <literal>=h</literal> specially: it must be of the form
49554955+<quote>header: substring</quote> and will not partially match header
49564956+names. The substring part may be omitted if you simply wish to find
49574957+messages containing a particular header without regard to its value.
47914958</para>
4792495947934960<para>
47944794-Patterns matching lists of addresses (notably c, C, p, P and t)
47954795-match if there is at least one match in the whole list. If you want to
47964796-make sure that all elements of that list match, you need to prefix your
47974797-pattern with <quote>^</quote>.
47984798-This example matches all mails which only has recipients from Germany.
49614961+Patterns matching lists of addresses (notably c, C, p, P and t) match if
49624962+there is at least one match in the whole list. If you want to make sure
49634963+that all elements of that list match, you need to prefix your pattern
49644964+with <quote>^</quote>. This example matches all mails which only has
49654965+recipients from Germany.
47994966</para>
4800496748014968<example id="ex-recips">
···48114978<title>Simple Searches</title>
4812497948134980<para>
48144814-Mutt supports two versions of so called <quote>simple searches</quote>. These are
48154815-issued if the query entered for searching, limiting and similar
48164816-operations does not seem to contain a valid pattern modifier (i.e. it does not contain
48174817-one of these characters: <quote>#</quote>, <quote>=</quote> or <quote>%</quote>). If the query is
48184818-supposed to contain one of these special characters, they must be escaped
48194819-by prepending a backslash (<quote>\</quote>).
49814981+Mutt supports two versions of so called <quote>simple
49824982+searches</quote>. These are issued if the query entered for searching,
49834983+limiting and similar operations does not seem to contain a valid pattern
49844984+modifier (i.e. it does not contain one of these characters:
49854985+<quote>~</quote>, <quote>=</quote> or <quote>%</quote>). If the query is
49864986+supposed to contain one of these special characters, they must be
49874987+escaped by prepending a backslash (<quote>\</quote>).
48204988</para>
4821498948224990<para>
···48545022</table>
4855502348565024<para>
48574857-The second type of simple search is to build a complex search
48584858-pattern using <link linkend="simple-search">$simple_search</link>
48594859-as a template. Mutt will insert your query properly quoted and search
48604860-for the composed complex query.
50255025+The second type of simple search is to build a complex search pattern
50265026+using <link linkend="simple-search">$simple_search</link> as a
50275027+template. Mutt will insert your query properly quoted and search for the
50285028+composed complex query.
48615029</para>
4862503048635031</sect2>
···48755043</screen>
4876504448775045<para>
48784878-would select messages which contain the word <quote>mutt</quote> in the list of
48794879-recipients <emphasis>and</emphasis> that have the word <quote>elkins</quote> in the <quote>From</quote> header
48804880-field.
50465046+would select messages which contain the word <quote>mutt</quote> in the
50475047+list of recipients <emphasis>and</emphasis> that have the word
50485048+<quote>elkins</quote> in the <quote>From</quote> header field.
48815049</para>
4882505048835051<para>
48844884-Mutt also recognizes the following operators to create more complex search
48854885-patterns:
50525052+Mutt also recognizes the following operators to create more complex
50535053+search patterns:
48865054</para>
4887505548885056<itemizedlist>
···49085076</itemizedlist>
4909507749105078<para>
49114911-Here is an example illustrating a complex search pattern. This pattern will
49124912-select all messages which do not contain <quote>mutt</quote> in the <quote>To</quote> or <quote>Cc</quote>
49134913-field and which are from <quote>elkins</quote>.
50795079+Here is an example illustrating a complex search pattern. This pattern
50805080+will select all messages which do not contain <quote>mutt</quote> in the
50815081+<quote>To</quote> or <quote>Cc</quote> field and which are from
50825082+<quote>elkins</quote>.
49145083</para>
4915508449165085<example id="ex-pattern-bool">
···49215090</example>
4922509149235092<para>
49244924-Here is an example using white space in the regular expression (note
49254925-the ' and " delimiters). For this to match, the mail's subject must
49264926-match the <quote>^Junk +From +Me$</quote> and it must be from either <quote>Jim +Somebody</quote>
49274927-or <quote>Ed +SomeoneElse</quote>:
50935093+Here is an example using white space in the regular expression (note the
50945094+' and " delimiters). For this to match, the mail's subject must match
50955095+the <quote>^Junk +From +Me$</quote> and it must be from either
50965096+<quote>Jim +Somebody</quote> or <quote>Ed +SomeoneElse</quote>:
49285097</para>
4929509849305099<screen>
···4933510249345103<note>
49355104<para>
49364936-If a regular expression contains parenthesis, or a vertical bar
49374937-("|"), you <emphasis>must</emphasis> enclose the expression in double or single quotes since
49384938-those characters are also used to separate different parts of Mutt's
49394939-pattern language. For example: <literal>~f "me@(mutt\.org|cs\.hmc\.edu)"</literal>
49404940-Without the quotes, the parenthesis wouldn't end.
49414941-This would be separated to two OR'd patterns: <emphasis>#f me@(mutt\.org</emphasis>
49424942-and <emphasis>cs\.hmc\.edu)</emphasis>. They are never what you want.
51055105+If a regular expression contains parenthesis, or a vertical bar ("|"),
51065106+you <emphasis>must</emphasis> enclose the expression in double or single
51075107+quotes since those characters are also used to separate different parts
51085108+of Mutt's pattern language. For example: <literal>~f
51095109+"me@(mutt\.org|cs\.hmc\.edu)"</literal> Without the quotes, the
51105110+parenthesis wouldn't end. This would be separated to two OR'd patterns:
51115111+<emphasis>~f me@(mutt\.org</emphasis> and
51125112+<emphasis>cs\.hmc\.edu)</emphasis>. They are never what you want.
49435113</para>
49445114</note>
49455115···49495119<title>Searching by Date</title>
4950512049515121<para>
49524952-Mutt supports two types of dates, <emphasis>absolute</emphasis> and <emphasis>relative</emphasis>.
51225122+Mutt supports two types of dates, <emphasis>absolute</emphasis> and
51235123+<emphasis>relative</emphasis>.
49535124</para>
4954512549555126<sect3 id="date-absolute">
49565127<title>Absolute Dates</title>
4957512849585129<para>
49594959-Dates <emphasis>must</emphasis> be in DD/MM/YY format (month and year are
49604960-optional, defaulting to the current month and year). An example of a valid
49614961-range of dates is:
51305130+Dates <emphasis>must</emphasis> be in DD/MM/YY format (month and year
51315131+are optional, defaulting to the current month and year). An example of
51325132+a valid range of dates is:
49625133</para>
4963513449645135<screen>
···49665137</screen>
4967513849685139<para>
49694969-If you omit the minimum (first) date, and just specify <quote>-DD/MM/YY</quote>, all
49704970-messages <emphasis>before</emphasis> the given date will be selected. If you omit the maximum
49714971-(second) date, and specify <quote>DD/MM/YY-</quote>, all messages <emphasis>after</emphasis> the given
49724972-date will be selected. If you specify a single date with no dash (<quote>-</quote>),
49734973-only messages sent on the given date will be selected.
51405140+If you omit the minimum (first) date, and just specify
51415141+<quote>-DD/MM/YY</quote>, all messages <emphasis>before</emphasis> the
51425142+given date will be selected. If you omit the maximum (second) date, and
51435143+specify <quote>DD/MM/YY-</quote>, all messages
51445144+<emphasis>after</emphasis> the given date will be selected. If you
51455145+specify a single date with no dash (<quote>-</quote>), only messages
51465146+sent on the given date will be selected.
49745147</para>
4975514849765149<para>
49774977-You can add error margins to absolute dates.
49784978-An error margin is a sign (+ or -), followed by a digit, followed by
49794979-one of the units in <xref linkend="tab-date-units"/>. As a special case, you can replace the
49804980-sign by a <quote>*</quote> character, which is equivalent to giving identical plus and minus error margins.
51505150+You can add error margins to absolute dates. An error margin is a sign
51515151+(+ or -), followed by a digit, followed by one of the units in <xref
51525152+linkend="tab-date-units"/>. As a special case, you can replace the sign
51535153+by a <quote>*</quote> character, which is equivalent to giving identical
51545154+plus and minus error margins.
49815155</para>
4982515649835157<table id="tab-date-units">
···49965170</table>
4997517149985172<para>
49994999-Example: To select any messages two weeks around January 15, 2001,
50005000-you'd use the following pattern:
51735173+Example: To select any messages two weeks around January 15, 2001, you'd
51745174+use the following pattern:
50015175</para>
5002517650035177<screen>
···50105184<title>Relative Dates</title>
5011518550125186<para>
50135013-This type of date is relative to the current date, and may
50145014-be specified as:
51875187+This type of date is relative to the current date, and may be specified
51885188+as:
50155189</para>
5016519050175191<itemizedlist>
50185192<listitem>
5019519350205194<para>
50215021-><emphasis>offset</emphasis> for messages older than <emphasis>offset</emphasis> units
51955195+><emphasis>offset</emphasis> for messages older than
51965196+<emphasis>offset</emphasis> units
50225197</para>
50235198</listitem>
50245199<listitem>
5025520050265201<para>
50275027-<<emphasis>offset</emphasis> for messages newer than <emphasis>offset</emphasis> units
52025202+<<emphasis>offset</emphasis> for messages newer than
52035203+<emphasis>offset</emphasis> units
50285204</para>
50295205</listitem>
50305206<listitem>
5031520750325208<para>
50335033-=<emphasis>offset</emphasis> for messages exactly <emphasis>offset</emphasis> units old
52095209+=<emphasis>offset</emphasis> for messages exactly
52105210+<emphasis>offset</emphasis> units old
50345211</para>
50355212</listitem>
5036521350375214</itemizedlist>
5038521550395216<para>
50405040-<emphasis>offset</emphasis> is specified as a positive number with one of the units from <xref linkend="tab-date-units"/>.
52175217+<emphasis>offset</emphasis> is specified as a positive number with one
52185218+of the units from <xref linkend="tab-date-units"/>.
50415219</para>
5042522050435221<para>
···50515229<note>
50525230<para>
50535231All dates used when searching are relative to the
50545054-<emphasis>local</emphasis> time zone, so unless you change the setting of your <link linkend="index-format">$index_format</link> to include a
50555055-<literal>%[...]</literal> format, these are <emphasis>not</emphasis> the dates shown
50565056-in the main index.
52325232+<emphasis>local</emphasis> time zone, so unless you change the setting
52335233+of your <link linkend="index-format">$index_format</link> to include a
52345234+<literal>%[...]</literal> format, these are <emphasis>not</emphasis> the
52355235+dates shown in the main index.
50575236</para>
50585237</note>
50595238···50675246<title>Using Tags</title>
5068524750695248<para>
50705070-Sometimes it is desirable to perform an operation on a group of
50715071-messages all at once rather than one at a time. An example might be
50725072-to save messages to a mailing list to a separate folder, or to
50735073-delete all messages with a given subject. To tag all messages
50745074-matching a pattern, use the <literal><tag-pattern></literal> function, which is bound to
50755075-<quote>shift-T</quote> by default. Or you can select individual messages by
50765076-hand using the <literal><tag-message></literal> function, which is bound to <quote>t</quote> by
50775077-default. See <link linkend="patterns">patterns</link> for Mutt's pattern
50785078-matching syntax.
52495249+Sometimes it is desirable to perform an operation on a group of messages
52505250+all at once rather than one at a time. An example might be to save
52515251+messages to a mailing list to a separate folder, or to delete all
52525252+messages with a given subject. To tag all messages matching a pattern,
52535253+use the <literal><tag-pattern></literal> function, which is bound
52545254+to <quote>shift-T</quote> by default. Or you can select individual
52555255+messages by hand using the <literal><tag-message></literal>
52565256+function, which is bound to <quote>t</quote> by default. See <link
52575257+linkend="patterns">patterns</link> for Mutt's pattern matching syntax.
50795258</para>
5080525950815260<para>
50825261Once you have tagged the desired messages, you can use the
50835083-<quote>tag-prefix</quote> operator, which is the <quote>;</quote> (semicolon) key by default.
50845084-When the <quote>tag-prefix</quote> operator is used, the <emphasis>next</emphasis> operation will
50855085-be applied to all tagged messages if that operation can be used in that
50865086-manner. If the <link linkend="auto-tag">$auto_tag</link>
50875087-variable is set, the next operation applies to the tagged messages
50885088-automatically, without requiring the <quote>tag-prefix</quote>.
52625262+<quote>tag-prefix</quote> operator, which is the <quote>;</quote>
52635263+(semicolon) key by default. When the <quote>tag-prefix</quote> operator
52645264+is used, the <emphasis>next</emphasis> operation will be applied to all
52655265+tagged messages if that operation can be used in that manner. If the
52665266+<link linkend="auto-tag">$auto_tag</link> variable is set, the next
52675267+operation applies to the tagged messages automatically, without
52685268+requiring the <quote>tag-prefix</quote>.
50895269</para>
5090527050915271<para>
50925092-In <link linkend="macro"><command>macro</command>s</link> or <link linkend="push"><command>push</command></link> commands,
50935093-you can use the <literal><tag-prefix-cond></literal> operator. If there are no tagged
50945094-messages, Mutt will <quote>eat</quote> the rest of the macro to abort it's execution.
50955095-Mutt will stop <quote>eating</quote> the macro when it encounters the <literal><end-cond></literal>
50965096-operator; after this operator the rest of the macro will be executed as
50975097-normal.
52725272+In <link linkend="macro"><command>macro</command>s</link> or <link
52735273+linkend="push"><command>push</command></link> commands, you can use the
52745274+<literal><tag-prefix-cond></literal> operator. If there are no
52755275+tagged messages, Mutt will <quote>eat</quote> the rest of the macro to
52765276+abort it's execution. Mutt will stop <quote>eating</quote> the macro
52775277+when it encounters the <literal><end-cond></literal> operator;
52785278+after this operator the rest of the macro will be executed as normal.
50985279</para>
5099528051005281</sect1>
···51035284<title>Using Hooks</title>
5104528551055286<para>
51065106-A <emphasis>hook</emphasis> is a concept found in many other programs which allows you to
51075107-execute arbitrary commands before performing some operation. For example,
51085108-you may wish to tailor your configuration based upon which mailbox you are
51095109-reading, or to whom you are sending mail. In the Mutt world, a <emphasis>hook</emphasis>
51105110-consists of a <link linkend="regexp">regular expression</link> or
51115111-<link linkend="patterns">pattern</link> along with a
51125112-configuration option/command. See:
52875287+A <emphasis>hook</emphasis> is a concept found in many other programs
52885288+which allows you to execute arbitrary commands before performing some
52895289+operation. For example, you may wish to tailor your configuration based
52905290+upon which mailbox you are reading, or to whom you are sending mail. In
52915291+the Mutt world, a <emphasis>hook</emphasis> consists of a <link
52925292+linkend="regexp">regular expression</link> or <link
52935293+linkend="patterns">pattern</link> along with a configuration
52945294+option/command. See:
5113529551145296<itemizedlist>
51155297···5198538051995381<note>
52005382<para>
52015201-If a hook changes configuration settings, these changes remain
52025202-effective until the end of the current Mutt session. As this is generally
52035203-not desired, a <quote>default</quote> hook needs to be added before all
52045204-other hooks of that type to restore configuration defaults.
53835383+If a hook changes configuration settings, these changes remain effective
53845384+until the end of the current Mutt session. As this is generally not
53855385+desired, a <quote>default</quote> hook needs to be added before all
53865386+other hooks of that type to restore configuration defaults.
52055387</para>
52065388</note>
52075389···52145396</example>
5215539752165398<para>
52175217-In <xref linkend="ex-default-hook"/>, by default the value of
52185218-<link linkend="from">$from</link>
52195219-and <link linkend="realname">$realname</link>
52205220-is not overridden. When sending messages either To: or Cc:
52215221-to <literal><b@b.b></literal>, the From: header is changed to
52225222-<literal><c@c.c></literal>.
53995399+In <xref linkend="ex-default-hook"/>, by default the value of <link
54005400+linkend="from">$from</link> and <link
54015401+linkend="realname">$realname</link> is not overridden. When sending
54025402+messages either To: or Cc: to <literal><b@b.b></literal>, the
54035403+From: header is changed to <literal><c@c.c></literal>.
52235404</para>
5224540552255406<sect2 id="pattern-hook" xreflabel="Message Matching in Hooks">
52265407<title>Message Matching in Hooks</title>
5227540852285409<para>
52295229-Hooks that act upon messages (<command>message-hook</command>, <command>reply-hook</command>,
52305230-<command>send-hook</command>, <command>send2-hook</command>, <command>save-hook</command>, <command>fcc-hook</command>) are evaluated in a
52315231-slightly different manner. For the other
52325232-types of hooks, a <link linkend="regexp">regular expression</link> is
52335233-sufficient. But in dealing with messages a finer grain of control is
52345234-needed for matching since for different purposes you want to match
52355235-different criteria.
54105410+Hooks that act upon messages (<command>message-hook</command>,
54115411+<command>reply-hook</command>, <command>send-hook</command>,
54125412+<command>send2-hook</command>, <command>save-hook</command>,
54135413+<command>fcc-hook</command>) are evaluated in a slightly different
54145414+manner. For the other types of hooks, a <link linkend="regexp">regular
54155415+expression</link> is sufficient. But in dealing with messages a finer
54165416+grain of control is needed for matching since for different purposes you
54175417+want to match different criteria.
52365418</para>
5237541952385420<para>
52395239-Mutt allows the use of the <link linkend="patterns">search pattern</link>
52405240-language for matching messages in hook commands. This works in
52415241-exactly the same way as it would when <emphasis>limiting</emphasis> or
52425242-<emphasis>searching</emphasis> the mailbox, except that you are restricted to those
52435243-operators which match information Mutt extracts from the header of
52445244-the message (i.e., from, to, cc, date, subject, etc.).
54215421+Mutt allows the use of the <link linkend="patterns">search
54225422+pattern</link> language for matching messages in hook commands. This
54235423+works in exactly the same way as it would when
54245424+<emphasis>limiting</emphasis> or <emphasis>searching</emphasis> the
54255425+mailbox, except that you are restricted to those operators which match
54265426+information Mutt extracts from the header of the message (i.e., from,
54275427+to, cc, date, subject, etc.).
52455428</para>
5246542952475430<para>
···52595442</para>
5260544352615444<para>
52625262-However, it is not required that you write the pattern to match using the
52635263-full searching language. You can still specify a simple <emphasis>regular
52645264-expression</emphasis> like the other hooks, in which case Mutt will translate your
52655265-pattern into the full language, using the translation specified by the
52665266-<link linkend="default-hook">$default_hook</link> variable. The
52675267-pattern is translated at the time the hook is declared, so the value of
52685268-<link linkend="default-hook">$default_hook</link> that is in effect
52695269-at that time will be used.
54455445+However, it is not required that you write the pattern to match using
54465446+the full searching language. You can still specify a simple
54475447+<emphasis>regular expression</emphasis> like the other hooks, in which
54485448+case Mutt will translate your pattern into the full language, using the
54495449+translation specified by the <link
54505450+linkend="default-hook">$default_hook</link> variable. The pattern is
54515451+translated at the time the hook is declared, so the value of <link
54525452+linkend="default-hook">$default_hook</link> that is in effect at that
54535453+time will be used.
52705454</para>
5271545552725456</sect2>
···52795463<para>
52805464Mutt supports connecting to external directory databases such as LDAP,
52815465ph/qi, bbdb, or NIS through a wrapper script which connects to Mutt
52825282-using a simple interface. Using the <link linkend="query-command">$query_command</link> variable, you specify the wrapper
52835283-command to use. For example:
54665466+using a simple interface. Using the <link
54675467+linkend="query-command">$query_command</link> variable, you specify the
54685468+wrapper command to use. For example:
52845469</para>
5285547052865471<screen>
···5308549353095494<para>
53105495There are two mechanisms for accessing the query function of Mutt. One
53115311-is to do a query from the index menu using the <literal><query></literal> function (default: Q).
53125312-This will prompt for a query, then bring up the query menu which will
53135313-list the matching responses. From the query menu, you can select
53145314-addresses to create aliases, or to mail. You can tag multiple addresses
53155315-to mail, start a new query, or have a new query appended to the current
54965496+is to do a query from the index menu using the
54975497+<literal><query></literal> function (default: Q). This will
54985498+prompt for a query, then bring up the query menu which will list the
54995499+matching responses. From the query menu, you can select addresses to
55005500+create aliases, or to mail. You can tag multiple addresses to mail,
55015501+start a new query, or have a new query appended to the current
53165502responses.
53175503</para>
5318550453195505<para>
53205506The other mechanism for accessing the query function is for address
53215507completion, similar to the alias completion. In any prompt for address
53225322-entry, you can use the <literal><complete-query></literal> function (default: ^T) to run a
53235323-query based on the current address you have typed. Like aliases, Mutt
53245324-will look for what you have typed back to the last space or comma. If
53255325-there is a single response for that query, Mutt will expand the address
53265326-in place. If there are multiple responses, Mutt will activate the query
53275327-menu. At the query menu, you can select one or more addresses to be
53285328-added to the prompt.
55085508+entry, you can use the <literal><complete-query></literal>
55095509+function (default: ^T) to run a query based on the current address you
55105510+have typed. Like aliases, Mutt will look for what you have typed back
55115511+to the last space or comma. If there is a single response for that
55125512+query, Mutt will expand the address in place. If there are multiple
55135513+responses, Mutt will activate the query menu. At the query menu, you
55145514+can select one or more addresses to be added to the prompt.
53295515</para>
5330551653315517</sect1>
···53345520<title>Mailbox Formats</title>
5335552153365522<para>
53375337-Mutt supports reading and writing of four different local mailbox formats:
53385338-mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
53395339-is no need to use a flag for different mailbox types. When creating new
53405340-mailboxes, Mutt uses the default specified with the
53415341-<link linkend="mbox-type">$mbox_type</link> variable. A
53425342-short description of the formats follows.
55235523+Mutt supports reading and writing of four different local mailbox
55245524+formats: mbox, MMDF, MH and Maildir. The mailbox type is autodetected,
55255525+so there is no need to use a flag for different mailbox types. When
55265526+creating new mailboxes, Mutt uses the default specified with the <link
55275527+linkend="mbox-type">$mbox_type</link> variable. A short description of
55285528+the formats follows.
53435529</para>
5344553053455531<para>
53465346-<emphasis>mbox</emphasis>. This is a widely used mailbox format for UNIX. All
53475347-messages are stored in a single file. Each message has a line of the form:
55325532+<emphasis>mbox</emphasis>. This is a widely used mailbox format for
55335533+UNIX. All messages are stored in a single file. Each message has a
55345534+line of the form:
53485535</para>
5349553653505537<screen>
···5353554053545541<para>
53555542to denote the start of a new message (this is often referred to as the
53565356-<quote>From_</quote> line). The mbox format requires mailbox
53575357-locking, is prone to mailbox corruption with concurrently writing
53585358-clients or misinterpreted From_ lines. Depending on the
53595359-environment, new mail detection can be unreliable. Mbox folders are fast
53605360-to open and easy to archive.
55435543+<quote>From_</quote> line). The mbox format requires mailbox locking, is
55445544+prone to mailbox corruption with concurrently writing clients or
55455545+misinterpreted From_ lines. Depending on the environment, new mail
55465546+detection can be unreliable. Mbox folders are fast to open and easy to
55475547+archive.
53615548</para>
5362554953635550<para>
53645364-<emphasis>MMDF</emphasis>. This is a variant of
53655365-the <emphasis>mbox</emphasis> format. Each message is surrounded by
53665366-lines containing <quote>^A^A^A^A</quote> (four
53675367-control-A's). The same problems as for mbox apply (also with finding the
53685368-right message separator as four control-A's may appear in message
53695369-bodies).
55515551+<emphasis>MMDF</emphasis>. This is a variant of the
55525552+<emphasis>mbox</emphasis> format. Each message is surrounded by lines
55535553+containing <quote>^A^A^A^A</quote> (four control-A's). The same problems
55545554+as for mbox apply (also with finding the right message separator as four
55555555+control-A's may appear in message bodies).
53705556</para>
5371555753725558<para>
53735373-<emphasis>MH</emphasis>. A radical departure from <emphasis>mbox</emphasis> and <emphasis>MMDF</emphasis>, a mailbox
55595559+<emphasis>MH</emphasis>. A radical departure from
55605560+<emphasis>mbox</emphasis> and <emphasis>MMDF</emphasis>, a mailbox
53745561consists of a directory and each message is stored in a separate file.
53755562The filename indicates the message number (however, this is may not
53765563correspond to the message number Mutt displays). Deleted messages are
53775564renamed with a comma (<quote>,</quote>) prepended to the filename. Mutt
53785378-detects this type of mailbox by looking for either <literal>.mh_sequences</literal>
53795379-or <literal>.xmhcache</literal> files (needed to distinguish normal directories from MH
53805380-mailboxes). MH is more robust with concurrent clients writing the mailbox,
53815381-but still may suffer from lost flags; message corruption is less likely
53825382-to occur than with mbox/mmdf. It's usually slower to open compared to
53835383-mbox/mmdf since many small files have to be read (Mutt provides
53845384-<xref linkend="header-caching"/> to greatly speed this process up).
53855385-Depending on the environment, MH is not very disk-space efficient.
55655565+detects this type of mailbox by looking for either
55665566+<literal>.mh_sequences</literal> or <literal>.xmhcache</literal> files
55675567+(needed to distinguish normal directories from MH mailboxes). MH is more
55685568+robust with concurrent clients writing the mailbox, but still may suffer
55695569+from lost flags; message corruption is less likely to occur than with
55705570+mbox/mmdf. It's usually slower to open compared to mbox/mmdf since many
55715571+small files have to be read (Mutt provides <xref
55725572+linkend="header-caching"/> to greatly speed this process up). Depending
55735573+on the environment, MH is not very disk-space efficient.
53865574</para>
5387557553885576<para>
53895389-<emphasis>Maildir</emphasis>. The newest of the mailbox formats, used by the Qmail MTA (a
53905390-replacement for sendmail). Similar to <emphasis>MH</emphasis>, except that it adds three
53915391-subdirectories of the mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and <emphasis>cur</emphasis>. Filenames
53925392-for the messages are chosen in such a way they are unique, even when two
53935393-programs are writing the mailbox over NFS, which means that no file locking
53945394-is needed and corruption is very unlikely. Maildir maybe
53955395-slower to open without caching in Mutt, it too is not very
53965396-disk-space efficient depending on the environment. Since no additional
53975397-files are used for metadata (which is embedded in the message filenames)
53985398-and Maildir is locking-free, it's easy to sync across different machines
53995399-using file-level synchronization tools.
55775577+<emphasis>Maildir</emphasis>. The newest of the mailbox formats, used
55785578+by the Qmail MTA (a replacement for sendmail). Similar to
55795579+<emphasis>MH</emphasis>, except that it adds three subdirectories of the
55805580+mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and
55815581+<emphasis>cur</emphasis>. Filenames for the messages are chosen in such
55825582+a way they are unique, even when two programs are writing the mailbox
55835583+over NFS, which means that no file locking is needed and corruption is
55845584+very unlikely. Maildir maybe slower to open without caching in Mutt, it
55855585+too is not very disk-space efficient depending on the environment. Since
55865586+no additional files are used for metadata (which is embedded in the
55875587+message filenames) and Maildir is locking-free, it's easy to sync across
55885588+different machines using file-level synchronization tools.
54005589</para>
5401559054025591</sect1>
···54055594<title>Mailbox Shortcuts</title>
5406559554075596<para>
54085408-There are a number of built in shortcuts which refer to specific mailboxes.
54095409-These shortcuts can be used anywhere you are prompted for a file or mailbox
54105410-path or in path-related configuration variables. Note that these only
54115411-work at the beginning of a string.
55975597+There are a number of built in shortcuts which refer to specific
55985598+mailboxes. These shortcuts can be used anywhere you are prompted for a
55995599+file or mailbox path or in path-related configuration variables. Note
56005600+that these only work at the beginning of a string.
54125601</para>
5413560254145603<itemizedlist>
54155604<listitem>
5416560554175606<para>
54185418-! — refers to your <link linkend="spoolfile">$spoolfile</link> (incoming) mailbox
56075607+! — refers to your <link linkend="spoolfile">$spoolfile</link>
56085608+(incoming) mailbox
54195609</para>
54205610</listitem>
54215611<listitem>
···54455635<listitem>
5446563654475637<para>
54485448-# — refers to your home directory
56385638+~ — refers to your home directory
54495639</para>
54505640</listitem>
54515641<listitem>
5452564254535643<para>
54545454-= or + — refers to your <link linkend="folder">$folder</link> directory
56445644+= or + — refers to your <link linkend="folder">$folder</link>
56455645+directory
54555646</para>
54565647</listitem>
54575648<listitem>
5458564954595650<para>
54605460-@<emphasis>alias</emphasis> — refers to the <link linkend="save-hook">default save folder</link> as determined by the address of the alias
56515651+@<emphasis>alias</emphasis> — refers to the <link
56525652+linkend="save-hook">default save folder</link> as determined by the
56535653+address of the alias
54615654</para>
54625655</listitem>
54635656···5465565854665659<para>
54675660For example, to store a copy of outgoing messages in the folder they
54685468-were composed in,
54695469-a <link linkend="folder-hook"><command>folder-hook</command></link> can
54705470-be used to set <link linkend="record">$record</link>:
56615661+were composed in, a <link
56625662+linkend="folder-hook"><command>folder-hook</command></link> can be used
56635663+to set <link linkend="record">$record</link>:
54715664</para>
5472566554735666<screen>
···5480567354815674<para>
54825675Mutt has a few configuration options that make dealing with large
54835483-amounts of mail easier. The first thing you must do is to let Mutt
54845484-know what addresses you consider to be mailing lists (technically
54855485-this does not have to be a mailing list, but that is what it is most
54865486-often used for), and what lists you are subscribed to. This is
54875487-accomplished through the use of the <link linkend="lists"><command>lists</command> and <command>subscribe</command></link> commands in your <literal>.muttrc</literal>.
56765676+amounts of mail easier. The first thing you must do is to let Mutt know
56775677+what addresses you consider to be mailing lists (technically this does
56785678+not have to be a mailing list, but that is what it is most often used
56795679+for), and what lists you are subscribed to. This is accomplished
56805680+through the use of the <link linkend="lists"><command>lists</command>
56815681+and <command>subscribe</command></link> commands in your
56825682+<literal>.muttrc</literal>.
54885683</para>
5489568454905685<para>
54915686Now that Mutt knows what your mailing lists are, it can do several
54925687things, the first of which is the ability to show the name of a list
54935493-through which you received a message (i.e., of a subscribed list) in
54945494-the <emphasis>index</emphasis> menu display. This is useful to distinguish between
54955495-personal and list mail in the same mailbox. In the <link linkend="index-format">$index_format</link> variable, the expando <quote>%L</quote>
54965496-will print the string <quote>To <list></quote> when <quote>list</quote> appears in the
54975497-<quote>To</quote> field, and <quote>Cc <list></quote> when it appears in the <quote>Cc</quote>
56885688+through which you received a message (i.e., of a subscribed list) in the
56895689+<emphasis>index</emphasis> menu display. This is useful to distinguish
56905690+between personal and list mail in the same mailbox. In the <link
56915691+linkend="index-format">$index_format</link> variable, the expando
56925692+<quote>%L</quote> will print the string <quote>To <list></quote>
56935693+when <quote>list</quote> appears in the <quote>To</quote> field, and
56945694+<quote>Cc <list></quote> when it appears in the <quote>Cc</quote>
54985695field (otherwise it prints the name of the author).
54995696</para>
5500569755015698<para>
55025502-Often times the <quote>To</quote> and <quote>Cc</quote> fields in mailing list messages
55035503-tend to get quite large. Most people do not bother to remove the
55045504-author of the message they reply to from the list, resulting in
55055505-two or more copies being sent to that person. The <literal><list-reply></literal>
55065506-function, which by default is bound to <quote>L</quote> in the <emphasis>index</emphasis> menu
55075507-and <emphasis>pager</emphasis>, helps reduce the clutter by only replying to the
55085508-known mailing list addresses instead of all recipients (except as
56995699+Often times the <quote>To</quote> and <quote>Cc</quote> fields in
57005700+mailing list messages tend to get quite large. Most people do not bother
57015701+to remove the author of the message they reply to from the list,
57025702+resulting in two or more copies being sent to that person. The
57035703+<literal><list-reply></literal> function, which by default is
57045704+bound to <quote>L</quote> in the <emphasis>index</emphasis> menu and
57055705+<emphasis>pager</emphasis>, helps reduce the clutter by only replying to
57065706+the known mailing list addresses instead of all recipients (except as
55095707specified by <literal>Mail-Followup-To</literal>, see below).
55105708</para>
5511570955125710<para>
55135513-Mutt also supports the <literal>Mail-Followup-To</literal> header. When you send
55145514-a message to a list of recipients which includes one or several
55155515-subscribed mailing lists, and if the <link linkend="followup-to">$followup_to</link> option is set, Mutt will generate
55165516-a Mail-Followup-To header which contains all the recipients to whom
55175517-you send this message, but not your address. This indicates that
55185518-group-replies or list-replies (also known as <quote>followups</quote>) to this
55195519-message should only be sent to the original recipients of the
57115711+Mutt also supports the <literal>Mail-Followup-To</literal> header. When
57125712+you send a message to a list of recipients which includes one or several
57135713+subscribed mailing lists, and if the <link
57145714+linkend="followup-to">$followup_to</link> option is set, Mutt will
57155715+generate a Mail-Followup-To header which contains all the recipients to
57165716+whom you send this message, but not your address. This indicates that
57175717+group-replies or list-replies (also known as <quote>followups</quote>)
57185718+to this message should only be sent to the original recipients of the
55205719message, and not separately to you - you'll receive your copy through
55215720one of the mailing lists you are subscribed to.
55225721</para>
5523572255245723<para>
55255525-Conversely, when group-replying or list-replying to a message which
55265526-has a <literal>Mail-Followup-To</literal> header, Mutt will respect this header if
55275527-the <link linkend="honor-followup-to">$honor_followup_to</link> configuration
55285528-variable is set. Using <link linkend="list-reply">list-reply</link> will in this case also make sure
55295529-that the reply goes to the mailing list, even if it's not specified
55305530-in the list of recipients in the <literal>Mail-Followup-To</literal>.
57245724+Conversely, when group-replying or list-replying to a message which has
57255725+a <literal>Mail-Followup-To</literal> header, Mutt will respect this
57265726+header if the <link
57275727+linkend="honor-followup-to">$honor_followup_to</link> configuration
57285728+variable is set. Using <link linkend="list-reply">list-reply</link>
57295729+will in this case also make sure that the reply goes to the mailing
57305730+list, even if it's not specified in the list of recipients in the
57315731+<literal>Mail-Followup-To</literal>.
55315732</para>
5532573355335734<note>
55345735<para>
55355736When header editing is enabled, you can create a
55365536-<literal>Mail-Followup-To</literal> header manually. Mutt will only auto-generate
55375537-this header if it doesn't exist when you send the message.
57375737+<literal>Mail-Followup-To</literal> header manually. Mutt will only
57385738+auto-generate this header if it doesn't exist when you send the message.
55385739</para>
55395740</note>
5540574155415742<para>
55425743The other method some mailing list admins use is to generate a
55435543-<quote>Reply-To</quote> field which points back to the mailing list address rather
55445544-than the author of the message. This can create problems when trying
55455545-to reply directly to the author in private, since most mail clients
55465546-will automatically reply to the address given in the <quote>Reply-To</quote>
55475547-field. Mutt uses the <link linkend="reply-to">$reply_to</link>
55485548-variable to help decide which address to use. If set to <emphasis>ask-yes</emphasis> or
55495549-<emphasis>ask-no</emphasis>, you will be
55505550-prompted as to whether or not you would like to use the address given in
55515551-the <quote>Reply-To</quote> field, or reply directly to the address given in the
55525552-<quote>From</quote> field. When set to <emphasis>yes</emphasis>, the <quote>Reply-To</quote> field will be used when
55535553-present.
57445744+<quote>Reply-To</quote> field which points back to the mailing list
57455745+address rather than the author of the message. This can create problems
57465746+when trying to reply directly to the author in private, since most mail
57475747+clients will automatically reply to the address given in the
57485748+<quote>Reply-To</quote> field. Mutt uses the <link
57495749+linkend="reply-to">$reply_to</link> variable to help decide which
57505750+address to use. If set to <emphasis>ask-yes</emphasis> or
57515751+<emphasis>ask-no</emphasis>, you will be prompted as to whether or not
57525752+you would like to use the address given in the <quote>Reply-To</quote>
57535753+field, or reply directly to the address given in the <quote>From</quote>
57545754+field. When set to <emphasis>yes</emphasis>, the
57555755+<quote>Reply-To</quote> field will be used when present.
55545756</para>
5555575755565758<para>
55575557-The <quote>X-Label:</quote> header field can be used to further identify mailing
55585558-lists or list subject matter (or just to annotate messages
55595559-individually). The <link linkend="index-format">$index_format</link> variable's <quote>%y</quote> and
55605560-<quote>%Y</quote> expandos can be used to expand <quote>X-Label:</quote> fields in the
55615561-index, and Mutt's pattern-matcher can match regular expressions to
55625562-<quote>X-Label:</quote> fields with the <quote>#y</quote> selector. <quote>X-Label:</quote> is not a
55635563-standard message header field, but it can easily be inserted by procmail
55645564-and other mail filtering agents.
57595759+The <quote>X-Label:</quote> header field can be used to further identify
57605760+mailing lists or list subject matter (or just to annotate messages
57615761+individually). The <link linkend="index-format">$index_format</link>
57625762+variable's <quote>%y</quote> and <quote>%Y</quote> expandos can be used
57635763+to expand <quote>X-Label:</quote> fields in the index, and Mutt's
57645764+pattern-matcher can match regular expressions to <quote>X-Label:</quote>
57655765+fields with the <quote>~y</quote> selector. <quote>X-Label:</quote> is
57665766+not a standard message header field, but it can easily be inserted by
57675767+procmail and other mail filtering agents.
55655768</para>
5566576955675770<para>
55685568-Lastly, Mutt has the ability to <link linkend="sort">sort</link> the mailbox into
55695569-<link linkend="threads">threads</link>. A thread is a group of messages which all relate to the same
55705570-subject. This is usually organized into a tree-like structure where a
55715571-message and all of its replies are represented graphically. If you've ever
55725572-used a threaded news client, this is the same concept. It makes dealing
55735573-with large volume mailing lists easier because you can easily delete
55745574-uninteresting threads and quickly find topics of value.
57715771+Lastly, Mutt has the ability to <link linkend="sort">sort</link> the
57725772+mailbox into <link linkend="threads">threads</link>. A thread is a
57735773+group of messages which all relate to the same subject. This is usually
57745774+organized into a tree-like structure where a message and all of its
57755775+replies are represented graphically. If you've ever used a threaded
57765776+news client, this is the same concept. It makes dealing with large
57775777+volume mailing lists easier because you can easily delete uninteresting
57785778+threads and quickly find topics of value.
55755779</para>
5576578055775781</sect1>
···57005904<title>Linking Threads</title>
5701590557025906<para>
57035703-Some mailers tend to <quote>forget</quote> to correctly set the <quote>In-Reply-To:</quote> and
57045704-<quote>References:</quote> headers when replying to a message. This results in broken
57055705-discussions because Mutt has not enough information to guess the correct
57065706-threading.
57075707-You can fix this by tagging the reply, then moving to the parent message
57085708-and using the <literal><link-threads></literal> function (bound to & by default). The
57095709-reply will then be connected to this parent message.
59075907+Some mailers tend to <quote>forget</quote> to correctly set the
59085908+<quote>In-Reply-To:</quote> and <quote>References:</quote> headers when
59095909+replying to a message. This results in broken discussions because Mutt
59105910+has not enough information to guess the correct threading. You can fix
59115911+this by tagging the reply, then moving to the parent message and using
59125912+the <literal><link-threads></literal> function (bound to & by
59135913+default). The reply will then be connected to this parent message.
57105914</para>
5711591557125916<para>
57135713-You can also connect multiple children at once, tagging them and using the
57145714-<literal><tag-prefix></literal> command (';') or the <link linkend="auto-tag">$auto_tag</link> option.
59175917+You can also connect multiple children at once, tagging them and using
59185918+the <literal><tag-prefix></literal> command (';') or the <link
59195919+linkend="auto-tag">$auto_tag</link> option.
57155920</para>
5716592157175922</sect2>
···5721592657225927<para>
57235928On mailing lists, some people are in the bad habit of starting a new
57245724-discussion by hitting <quote>reply</quote> to any message from the list and changing
57255725-the subject to a totally unrelated one.
57265726-You can fix such threads by using the <literal><break-thread></literal> function (bound
57275727-by default to #), which will turn the subthread starting from the
59295929+discussion by hitting <quote>reply</quote> to any message from the list
59305930+and changing the subject to a totally unrelated one. You can fix such
59315931+threads by using the <literal><break-thread></literal> function
59325932+(bound by default to #), which will turn the subthread starting from the
57285933current message into a whole different thread.
57295934</para>
57305935···5737594257385943<para>
57395944RFC1894 defines a set of MIME content types for relaying information
57405740-about the status of electronic mail messages. These can be thought of as
57415741-<quote>return receipts.</quote>
59455945+about the status of electronic mail messages. These can be thought of
59465946+as <quote>return receipts.</quote>
57425947</para>
5743594857445949<para>
57455745-To support DSN, there are two variables. <link linkend="dsn-notify">$dsn_notify</link> is used to request receipts for
59505950+To support DSN, there are two variables. <link
59515951+linkend="dsn-notify">$dsn_notify</link> is used to request receipts for
57465952different results (such as failed message, message delivered, etc.).
57475747-<link linkend="dsn-return">$dsn_return</link> requests how much
57485748-of your message should be returned with the receipt (headers or full
57495749-message).
59535953+<link linkend="dsn-return">$dsn_return</link> requests how much of your
59545954+message should be returned with the receipt (headers or full message).
57505955</para>
5751595657525957<para>
57535753-When using <link linkend="sendmail">$sendmail</link> for mail
57545754-delivery, you need to use either Berkeley sendmail 8.8.x (or greater) a MTA
57555755-supporting DSN command line options compatible to Sendmail: The -N and -R
57565756-options can be used by the mail client to make requests as to what type of
57575757-status messages should be returned. Please consider your MTA documentation
57585758-whether DSN is supported.
59585958+When using <link linkend="sendmail">$sendmail</link> for mail delivery,
59595959+you need to use either Berkeley sendmail 8.8.x (or greater) a MTA
59605960+supporting DSN command line options compatible to Sendmail: The -N and
59615961+-R options can be used by the mail client to make requests as to what
59625962+type of status messages should be returned. Please consider your MTA
59635963+documentation whether DSN is supported.
57595964</para>
5760596557615966<para>
57625762-For SMTP delivery using <link
57635763- linkend="smtp-url">$smtp_url</link>, it depends on the
57645764-capabilities announced by the server whether Mutt will attempt to
57655765-request DSN or not.
59675967+For SMTP delivery using <link linkend="smtp-url">$smtp_url</link>, it
59685968+depends on the capabilities announced by the server whether Mutt will
59695969+attempt to request DSN or not.
57665970</para>
5767597157685972</sect1>
···57715975<title>Start a WWW Browser on URLs</title>
5772597657735977<para>
57745774-If a message contains URLs, it is efficient to get
57755775-a menu with all the URLs and start a WWW browser on one of them. This
57765776-functionality is provided by the external urlview program which can be
57775777-retrieved at
57785778-<ulink url="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink>
59785978+If a message contains URLs, it is efficient to get a menu with all the
59795979+URLs and start a WWW browser on one of them. This functionality is
59805980+provided by the external urlview program which can be retrieved at
59815981+<ulink
59825982+url="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink>
57795983and the configuration commands:
57805984</para>
57815985···58016005<listitem>
58026006<para>
58036007Mutt normalizes all e-mail addresses to the simplest form possible. If
58045804-an address contains a realname, the form
58055805-<emphasis>Joe User <joe@example.com></emphasis> is used and the
58065806-pure e-mail address without angle brackets otherwise, i.e. just
60086008+an address contains a realname, the form <emphasis>Joe User
60096009+<joe@example.com></emphasis> is used and the pure e-mail address
60106010+without angle brackets otherwise, i.e. just
58076011<emphasis>joe@example.com</emphasis>.
58086012</para>
58096013<para>
···58226026present. Otherwise, the value of <literal>$MAILDIR</literal> is taken
58236027into account. If that isn't present either, Mutt takes the user's
58246028mailbox in the mailspool as determined at compile-time (which may also
58255825-reside in the home directory). The
58265826-<link linkend="spoolfile">$spoolfile</link> setting overrides
58275827-this selection. Highest priority has the mailbox given with the
60296029+reside in the home directory). The <link
60306030+linkend="spoolfile">$spoolfile</link> setting overrides this
60316031+selection. Highest priority has the mailbox given with the
58286032<literal>-f</literal> command line option.
58296033</para>
58306034</listitem>
···58446048the discerning MIME user requires, and the conformance to the standards
58456049wherever possible. When configuring Mutt for MIME, there are two extra
58466050types of configuration files which Mutt uses. One is the
58475847-<literal>mime.types</literal> file, which contains the mapping of file extensions to
58485848-IANA MIME types. The other is the <literal>mailcap</literal> file, which specifies
58495849-the external commands to use for handling specific MIME types.
60516051+<literal>mime.types</literal> file, which contains the mapping of file
60526052+extensions to IANA MIME types. The other is the
60536053+<literal>mailcap</literal> file, which specifies the external commands
60546054+to use for handling specific MIME types.
58506055</para>
5851605658526057<sect1 id="using-mime">
···58696074Besides the handling of non-ascii characters in message headers, to Mutt
58706075the most important aspect of MIME are so-called MIME types. These are
58716076constructed using a <emphasis>major</emphasis> and
58725872-<emphasis>minor</emphasis> type separated by a forward slash.
58735873-These specify details about the content that follows. Based upon these,
58745874-Mutt decides how to handle this part. The most popular major type is
60776077+<emphasis>minor</emphasis> type separated by a forward slash. These
60786078+specify details about the content that follows. Based upon these, Mutt
60796079+decides how to handle this part. The most popular major type is
58756080<quote><literal>text</literal></quote> with minor types for plain text,
58766081HTML and various other formats. Major types also exist for images,
58776082audio, video and of course general application data (e.g. to separate
58786083cryptographically signed data with a signature, send office documents,
58796084and in general arbitrary binary data). There's also the
58805880-<literal>multipart</literal> major type which represents the root of
58815881-a subtree of MIME parts. A list of supported MIME types can be found in
60856085+<literal>multipart</literal> major type which represents the root of a
60866086+subtree of MIME parts. A list of supported MIME types can be found in
58826087<xref linkend="supported-mime-types"/>.
58836088</para>
58846089···7015722070167221<para>
70177222Mutt supports several of optional features which can be enabled or
70187018-disabled at compile-time by giving the <emphasis>configure</emphasis> script
70197019-certain arguments. These are listed in the <quote>Optional features</quote> section of
70207020-the <emphasis>configure --help</emphasis> output.
72237223+disabled at compile-time by giving the <emphasis>configure</emphasis>
72247224+script certain arguments. These are listed in the <quote>Optional
72257225+features</quote> section of the <emphasis>configure --help</emphasis>
72267226+output.
70217227</para>
7022722870237229<para>
70247230Which features are enabled or disabled can later be determined from the
70257231output of <literal>mutt -v</literal>. If a compile option starts with
70267026-<quote>+</quote> it is enabled and disabled if prefixed with <quote>-</quote>. For example, if
70277027-Mutt was compiled using GnuTLS for encrypted communication instead of
70287028-OpenSSL, <literal>mutt -v</literal> would contain:
72327232+<quote>+</quote> it is enabled and disabled if prefixed with
72337233+<quote>-</quote>. For example, if Mutt was compiled using GnuTLS for
72347234+encrypted communication instead of OpenSSL, <literal>mutt -v</literal>
72357235+would contain:
70297236</para>
7030723770317238<screen>
···70397246<para>
70407247Mutt optionally supports the IMAP, POP3 and SMTP protocols which require
70417248to access servers using URLs. The canonical syntax for specifying URLs
70427042-in Mutt is (an item enclosed in <literal>[]</literal> means it is optional and
70437043-may be omitted):
72497249+in Mutt is (an item enclosed in <literal>[]</literal> means it is
72507250+optional and may be omitted):
70447251</para>
7045725270467253<screen>
···70597266Since all protocols supported by Mutt support/require authentication,
70607267login credentials may be specified in the URL. This has the advantage
70617268that multiple IMAP, POP3 or SMTP servers may be specified (which isn't
70627062-possible using, for example,
70637063-<link linkend="imap-user">$imap_user</link>). The username
70647064-may contain the <quote>@</quote> symbol being used by many mail systems
70657065-as part of the login name. The special characters <quote>/</quote>
70667066-(<literal>%2F</literal>),
70677067-<quote>:</quote> (<literal>%3A</literal>)
70687068-and <quote>%</quote> (<literal>%25</literal>) have to be
70697069-URL-encoded in usernames using the <literal>%</literal>-notation.
72697269+possible using, for example, <link
72707270+linkend="imap-user">$imap_user</link>). The username may contain the
72717271+<quote>@</quote> symbol being used by many mail systems as part of the
72727272+login name. The special characters <quote>/</quote>
72737273+(<literal>%2F</literal>), <quote>:</quote> (<literal>%3A</literal>) and
72747274+<quote>%</quote> (<literal>%25</literal>) have to be URL-encoded in
72757275+usernames using the <literal>%</literal>-notation.
70707276</para>
7071727770727278<para>
···7101730771027308<para>
71037309If Mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be
71047104-compiled with support for SSL or TLS using either OpenSSL or GnuTLS (
71057105-by running the <emphasis>configure</emphasis> script with the
73107310+compiled with support for SSL or TLS using either OpenSSL or GnuTLS ( by
73117311+running the <emphasis>configure</emphasis> script with the
71067312<emphasis>--enable-ssl=...</emphasis> option for OpenSSL or
71077313<emphasis>--enable-gnutls=...</emphasis> for GnuTLS). Mutt can then
71087314attempt to encrypt communication with remote servers if these protocols
71097109-are suffixed with <quote>s</quote> for <quote>secure communication</quote>.
73157315+are suffixed with <quote>s</quote> for <quote>secure
73167316+communication</quote>.
71107317</para>
7111731871127319</sect1>
···71157322<title>POP3 Support</title>
7116732371177324<para>
71187118-If Mutt is compiled with POP3 support (by running the <emphasis>configure</emphasis>
71197119-script with the <emphasis>--enable-pop</emphasis> flag), it has the ability to work
71207120-with mailboxes located on a remote POP3 server and fetch mail for local
73257325+If Mutt is compiled with POP3 support (by running the
73267326+<emphasis>configure</emphasis> script with the
73277327+<emphasis>--enable-pop</emphasis> flag), it has the ability to work with
73287328+mailboxes located on a remote POP3 server and fetch mail for local
71217329browsing.
71227330</para>
7123733171247332<para>
71257125-Remote POP3 servers can be accessed using URLs with the <literal>pop</literal> protocol
71267126-for unencrypted and <literal>pops</literal> for encrypted
71277127-communication, see <xref linkend="url-syntax"/> for details.
73337333+Remote POP3 servers can be accessed using URLs with the
73347334+<literal>pop</literal> protocol for unencrypted and
73357335+<literal>pops</literal> for encrypted communication, see <xref
73367336+linkend="url-syntax"/> for details.
71287337</para>
7129733871307339<para>
71317340Polling for new mail is more expensive over POP3 than locally. For this
71327341reason the frequency at which Mutt will check for mail remotely can be
71337133-controlled by the
71347134-<link linkend="pop-checkinterval">$pop_checkinterval</link>
71357135-variable, which defaults to every 60 seconds.
73427342+controlled by the <link
73437343+linkend="pop-checkinterval">$pop_checkinterval</link> variable, which
73447344+defaults to every 60 seconds.
71367345</para>
7137734671387347<para>
71397348POP is read-only which doesn't allow for some features like editing
71407140-messages or changing flags. However, using
71417141-<xref linkend="header-caching"/> and <xref linkend="body-caching"/>
71427142-Mutt simulates the new/old/read flags as well as flagged and replied.
71437143-Mutt applies some logic on top of remote messages but cannot change
71447144-them so that modifications of flags are lost when
71457145-messages are downloaded from the POP server (either by Mutt or other
71467146-tools).
73497349+messages or changing flags. However, using <xref
73507350+linkend="header-caching"/> and <xref linkend="body-caching"/> Mutt
73517351+simulates the new/old/read flags as well as flagged and replied. Mutt
73527352+applies some logic on top of remote messages but cannot change them so
73537353+that modifications of flags are lost when messages are downloaded from
73547354+the POP server (either by Mutt or other tools).
71477355</para>
7148735671497357<anchor id="fetch-mail"/>
71507358<para>
71517151-Another way to access your POP3 mail is the <literal><fetch-mail></literal> function
71527152-(default: G). It allows to connect to <link linkend="pop-host">$pop_host</link>, fetch all your new mail and place it in the
71537153-local <link linkend="spoolfile">$spoolfile</link>. After this
71547154-point, Mutt runs exactly as if the mail had always been local.
73597359+Another way to access your POP3 mail is the
73607360+<literal><fetch-mail></literal> function (default: G). It allows
73617361+to connect to <link linkend="pop-host">$pop_host</link>, fetch all your
73627362+new mail and place it in the local <link
73637363+linkend="spoolfile">$spoolfile</link>. After this point, Mutt runs
73647364+exactly as if the mail had always been local.
71557365</para>
7156736671577367<note>
71587368<para>
71597159-If you only need to fetch all messages to a
71607160-local mailbox you should consider using a specialized program, such as
71617161-<literal>fetchmail(1)</literal>, <literal>getmail(1)</literal> or similar.
73697369+If you only need to fetch all messages to a local mailbox you should
73707370+consider using a specialized program, such as
73717371+<literal>fetchmail(1)</literal>, <literal>getmail(1)</literal> or
73727372+similar.
71627373</para>
71637374</note>
71647375···71687379<title>IMAP Support</title>
7169738071707381<para>
71717171-If Mutt was compiled with IMAP support (by running the <emphasis>configure</emphasis>
71727172-script with the <emphasis>--enable-imap</emphasis> flag), it has the ability to work
73827382+If Mutt was compiled with IMAP support (by running the
73837383+<emphasis>configure</emphasis> script with the
73847384+<emphasis>--enable-imap</emphasis> flag), it has the ability to work
71737385with folders located on a remote IMAP server.
71747386</para>
7175738771767388<para>
71777177-You can access the remote inbox by selecting the folder by its URL
71787178-(see <xref linkend="url-syntax"/> for details) using the
73897389+You can access the remote inbox by selecting the folder by its URL (see
73907390+<xref linkend="url-syntax"/> for details) using the
71797391<literal>imap</literal> or <literal>imaps</literal> protocol.
71807392Alternatively, a pine-compatible notation is also supported, ie
71817393<literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
71827394</para>
7183739571847396<para>
71857185-Note that not all servers use <quote>/</quote> as the hierarchy separator. Mutt should
71867186-correctly notice which separator is being used by the server and convert
71877187-paths accordingly.
73977397+Note that not all servers use <quote>/</quote> as the hierarchy
73987398+separator. Mutt should correctly notice which separator is being used
73997399+by the server and convert paths accordingly.
71887400</para>
7189740171907402<para>
71917403When browsing folders on an IMAP server, you can toggle whether to look
71927404at only the folders you are subscribed to, or all folders with the
71937193-<emphasis>toggle-subscribed</emphasis> command. See also the
71947194-<link linkend="imap-list-subscribed">$imap_list_subscribed</link> variable.
74057405+<emphasis>toggle-subscribed</emphasis> command. See also the <link
74067406+linkend="imap-list-subscribed">$imap_list_subscribed</link> variable.
71957407</para>
7196740871977409<para>
71987198-Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
71997199-want to carefully tune the
72007200-<link linkend="mail-check">$mail_check</link>
72017201-and
72027202-<link linkend="timeout">$timeout</link>
72037203-variables. Reasonable values are:
74107410+Polling for new mail on an IMAP server can cause noticeable delays. So,
74117411+you'll want to carefully tune the <link
74127412+linkend="mail-check">$mail_check</link> and <link
74137413+linkend="timeout">$timeout</link> variables. Reasonable values are:
72047414</para>
7205741572067416<screen>
···72157425<note>
72167426<para>
72177427Note that if you are using mbox as the mail store on UW servers prior to
72187218-v12.250, the server has been reported to disconnect a client if another client
72197219-selects the same folder.
74287428+v12.250, the server has been reported to disconnect a client if another
74297429+client selects the same folder.
72207430</para>
72217431</note>
72227432···72337443<listitem>
7234744472357445<para>
72367236-In lieu of file permissions, Mutt displays the string <quote>IMAP</quote>,
72377237-possibly followed by the symbol <quote>+</quote>, indicating
72387238-that the entry contains both messages and subfolders. On
74467446+In lieu of file permissions, Mutt displays the string
74477447+<quote>IMAP</quote>, possibly followed by the symbol <quote>+</quote>,
74487448+indicating that the entry contains both messages and subfolders. On
72397449Cyrus-like servers folders will often contain both messages and
72407450subfolders.
72417451</para>
···72437453<listitem>
7244745472457455<para>
72467246-For the case where an entry can contain both messages and
72477247-subfolders, the selection key (bound to <literal>enter</literal> by default)
72487248-will choose to descend into the subfolder view. If you wish to view
72497249-the messages in that folder, you must use <literal>view-file</literal> instead
72507250-(bound to <literal>space</literal> by default).
74567456+For the case where an entry can contain both messages and subfolders,
74577457+the selection key (bound to <literal>enter</literal> by default) will
74587458+choose to descend into the subfolder view. If you wish to view the
74597459+messages in that folder, you must use <literal>view-file</literal>
74607460+instead (bound to <literal>space</literal> by default).
72517461</para>
72527462</listitem>
72537463<listitem>
7254746472557465<para>
72567466You can create, delete and rename mailboxes with the
72577257-<literal><create-mailbox></literal>, <literal><delete-mailbox></literal>, and
72587258-<literal><rename-mailbox></literal> commands (default bindings: <literal>C</literal>,
72597259-<literal>d</literal> and <literal>r</literal>, respectively). You may also
72607260-<literal><subscribe></literal> and <literal><unsubscribe></literal> to mailboxes (normally
72617261-these are bound to <literal>s</literal> and <literal>u</literal>, respectively).
74677467+<literal><create-mailbox></literal>,
74687468+<literal><delete-mailbox></literal>, and
74697469+<literal><rename-mailbox></literal> commands (default bindings:
74707470+<literal>C</literal>, <literal>d</literal> and <literal>r</literal>,
74717471+respectively). You may also <literal><subscribe></literal> and
74727472+<literal><unsubscribe></literal> to mailboxes (normally these are
74737473+bound to <literal>s</literal> and <literal>u</literal>, respectively).
72627474</para>
72637475</listitem>
72647476···72737485Mutt supports four authentication methods with IMAP servers: SASL,
72747486GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
72757487NTLM authentication for you poor exchange users out there, but it has
72767276-yet to be integrated into the main tree). There is also support for
72777277-the pseudo-protocol ANONYMOUS, which allows you to log in to a public
72787278-IMAP server without having an account. To use ANONYMOUS, simply make
72797279-your username blank or <quote>anonymous</quote>.
74887488+yet to be integrated into the main tree). There is also support for the
74897489+pseudo-protocol ANONYMOUS, which allows you to log in to a public IMAP
74907490+server without having an account. To use ANONYMOUS, simply make your
74917491+username blank or <quote>anonymous</quote>.
72807492</para>
7281749372827494<para>
72837283-SASL is a special super-authenticator, which selects among several protocols
72847284-(including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure
72857285-method available on your host and the server. Using some of these methods
72867286-(including DIGEST-MD5 and possibly GSSAPI), your entire session will be
72877287-encrypted and invisible to those teeming network snoops. It is the best
72887288-option if you have it. To use it, you must have the Cyrus SASL library
72897289-installed on your system and compile Mutt with the <emphasis>--with-sasl</emphasis> flag.
74957495+SASL is a special super-authenticator, which selects among several
74967496+protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the
74977497+most secure method available on your host and the server. Using some of
74987498+these methods (including DIGEST-MD5 and possibly GSSAPI), your entire
74997499+session will be encrypted and invisible to those teeming network
75007500+snoops. It is the best option if you have it. To use it, you must have
75017501+the Cyrus SASL library installed on your system and compile Mutt with
75027502+the <emphasis>--with-sasl</emphasis> flag.
72907503</para>
7291750472927505<para>
72937293-Mutt will try whichever methods are compiled in and available on the server,
72947294-in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
75067506+Mutt will try whichever methods are compiled in and available on the
75077507+server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5,
75087508+LOGIN.
72957509</para>
7296751072977511<para>
···73027516<listitem>
7303751773047518<para>
73057305-<link linkend="imap-user">$imap_user</link> - controls
73067306-the username under which you request authentication on the IMAP server,
73077307-for all authenticators. This is overridden by an explicit username in
73087308-the mailbox path (ie by using a mailbox name of the form
75197519+<link linkend="imap-user">$imap_user</link> - controls the username
75207520+under which you request authentication on the IMAP server, for all
75217521+authenticators. This is overridden by an explicit username in the
75227522+mailbox path (ie by using a mailbox name of the form
73097523<literal>{user@host}</literal>).
73107524</para>
73117525</listitem>
73127526<listitem>
7313752773147528<para>
73157315-<link linkend="imap-pass">$imap_pass</link> - a
73167316-password which you may preset, used by all authentication methods where
73177317-a password is needed.
75297529+<link linkend="imap-pass">$imap_pass</link> - a password which you may
75307530+preset, used by all authentication methods where a password is needed.
73187531</para>
73197532</listitem>
73207533<listitem>
7321753473227535<para>
73237323-<link linkend="imap-authenticators">$imap_authenticators</link> - a colon-delimited list of IMAP
73247324-authentication methods to try, in the order you wish to try them. If
73257325-specified, this overrides Mutt's default (attempt everything, in the order
73267326-listed above).
75367536+<link linkend="imap-authenticators">$imap_authenticators</link> - a
75377537+colon-delimited list of IMAP authentication methods to try, in the order
75387538+you wish to try them. If specified, this overrides Mutt's default
75397539+(attempt everything, in the order listed above).
73277540</para>
73287541</listitem>
73297542···73437556</para>
7344755773457558<para>
73467346-If the configuration variable
73477347-<link linkend="smtp-url">$smtp_url</link> is set, Mutt
73487348-will contact the given SMTP server to deliver messages; if it is unset,
73497349-Mutt will use the program specified by <link linkend="sendmail">$sendmail</link>.
75597559+If the configuration variable <link linkend="smtp-url">$smtp_url</link>
75607560+is set, Mutt will contact the given SMTP server to deliver messages; if
75617561+it is unset, Mutt will use the program specified by <link
75627562+linkend="sendmail">$sendmail</link>.
73507563</para>
7351756473527565<para>
···73547567</para>
7355756873567569<para>
73577357-The built-in SMTP support supports encryption (the <literal>smtps</literal> protocol
73587358-using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms
73597359-for SASL are specified in <link linkend="smtp-authenticators">$smtp_authenticators</link>
73607360-defaulting to an empty list which makes Mutt try all available methods
73617361-from most-secure to least-secure.
75707570+The built-in SMTP support supports encryption (the
75717571+<literal>smtps</literal> protocol using SSL or TLS) as well as SMTP
75727572+authentication using SASL. The authentication mechanisms for SASL are
75737573+specified in <link
75747574+linkend="smtp-authenticators">$smtp_authenticators</link> defaulting to
75757575+an empty list which makes Mutt try all available methods from
75767576+most-secure to least-secure.
73627577</para>
7363757873647579</sect1>
···73817596</cmdsynopsis>
7382759773837598<para>
73847384-If you happen to have accounts on multiple IMAP, POP and/or SMTP servers,
73857385-you may find managing all the authentication settings inconvenient and
73867386-error-prone. The <link linkend="account-hook"><command>account-hook</command></link> command may help. This hook works like
73877387-<link linkend="folder-hook"><command>folder-hook</command></link> but is invoked whenever Mutt needs to access a remote mailbox
73887388-(including inside the folder browser), not just when you open the
73897389-mailbox. This includes (for example) polling for new mail, storing Fcc
73907390-messages and saving messages to a folder. As a consequence,
73917391-<link linkend="account-hook"><command>account-hook</command></link> should only be used to set connection-related settings such
73927392-as passwords or tunnel commands but not settings such as sender
73937393-address or name (because in general it should be considered unpredictable
73947394-which <link linkend="account-hook"><command>account-hook</command></link> was last used).
75997599+If you happen to have accounts on multiple IMAP, POP and/or SMTP
76007600+servers, you may find managing all the authentication settings
76017601+inconvenient and error-prone. The <link
76027602+linkend="account-hook"><command>account-hook</command></link> command
76037603+may help. This hook works like <link
76047604+linkend="folder-hook"><command>folder-hook</command></link> but is
76057605+invoked whenever Mutt needs to access a remote mailbox (including inside
76067606+the folder browser), not just when you open the mailbox. This includes
76077607+(for example) polling for new mail, storing Fcc messages and saving
76087608+messages to a folder. As a consequence, <link
76097609+linkend="account-hook"><command>account-hook</command></link> should
76107610+only be used to set connection-related settings such as passwords or
76117611+tunnel commands but not settings such as sender address or name (because
76127612+in general it should be considered unpredictable which <link
76137613+linkend="account-hook"><command>account-hook</command></link> was last
76147614+used).
73957615</para>
7396761673977617<para>
···74067626</screen>
7407762774087628<para>
74097409-To manage multiple accounts with, for example, different values of
74107410-<link linkend="record">$record</link> or sender addresses,
74117411-<link linkend="folder-hook"><command>folder-hook</command></link>
74127412-has to be be used together with
74137413-the <link linkend="mailboxes"><command>mailboxes</command></link> command.
76297629+To manage multiple accounts with, for example, different values of <link
76307630+linkend="record">$record</link> or sender addresses, <link
76317631+linkend="folder-hook"><command>folder-hook</command></link> has to be be
76327632+used together with the <link
76337633+linkend="mailboxes"><command>mailboxes</command></link> command.
74147634</para>
7415763574167636<example id="ex-multiaccount">
···74257645</example>
7426764674277647<para>
74287428-In example
74297429-<xref linkend="ex-multiaccount"/> the folders are defined using
74307430-<link linkend="mailboxes"><command>mailboxes</command></link> so Mutt polls them for new
74317431-mail. Each <link linkend="folder-hook"><command>folder-hook</command></link> triggers when
74327432-one mailbox below each IMAP account is opened and sets
74337433-<link linkend="folder">$folder</link> to the account's root
74347434-folder. Next, it sets <link linkend="record">$record</link> to
74357435-the <emphasis>INBOX/Sent</emphasis> folder below the newly
74367436-set <link linkend="folder">$folder</link>. Please notice that the
74377437-value the <quote>+</quote>
74387438-<link linkend="shortcuts">mailbox shortcut</link> refers to depends on
74397439-the <emphasis>current</emphasis> value
74407440-of <link linkend="folder">$folder</link> and therefore has to be set
74417441-separatedly per account. Setting other values
74427442-like <link linkend="from">$from</link>
76487648+In example <xref linkend="ex-multiaccount"/> the folders are defined
76497649+using <link linkend="mailboxes"><command>mailboxes</command></link> so
76507650+Mutt polls them for new mail. Each <link
76517651+linkend="folder-hook"><command>folder-hook</command></link> triggers
76527652+when one mailbox below each IMAP account is opened and sets <link
76537653+linkend="folder">$folder</link> to the account's root folder. Next, it
76547654+sets <link linkend="record">$record</link> to the
76557655+<emphasis>INBOX/Sent</emphasis> folder below the newly set <link
76567656+linkend="folder">$folder</link>. Please notice that the value the
76577657+<quote>+</quote> <link linkend="shortcuts">mailbox shortcut</link>
76587658+refers to depends on the <emphasis>current</emphasis> value of <link
76597659+linkend="folder">$folder</link> and therefore has to be set separatedly
76607660+per account. Setting other values like <link linkend="from">$from</link>
74437661or <link linkend="signature">$signature</link> is analogous to setting
74447662<link linkend="record">$record</link>.
74457663</para>
···74507668<title>Local Caching</title>
7451766974527670<para>
74537453-Mutt contains two types of local caching: <emphasis>(1)</emphasis>
74547454-the so-called <quote>header caching</quote> and <emphasis>(2)</emphasis> the
74557455-so-called <quote>body caching</quote> which are both described in this section.
76717671+Mutt contains two types of local caching: <emphasis>(1)</emphasis> the
76727672+so-called <quote>header caching</quote> and <emphasis>(2)</emphasis> the
76737673+so-called <quote>body caching</quote> which are both described in this
76747674+section.
74567675</para>
7457767674587677<para>
···74677686<para>
74687687Mutt provides optional support for caching message headers for the
74697688following types of folders: IMAP, POP, Maildir and MH. Header caching
74707470-greatly improves speed because for remote folders, headers
74717471-usually only need to be downloaded once. For Maildir and MH, reading the
74727472-headers from a single file is much faster than looking at possibly
74737473-thousands of single files (since Maildir and MH use one file per message.)
76897689+greatly improves speed because for remote folders, headers usually only
76907690+need to be downloaded once. For Maildir and MH, reading the headers from
76917691+a single file is much faster than looking at possibly thousands of
76927692+single files (since Maildir and MH use one file per message.)
74747693</para>
7475769474767695<para>
74777696Header caching can be enabled via the configure script and the
74787478-<emphasis>--enable-hcache</emphasis> option. It's not turned on
74797479-by default because external database libraries are required: one
74807480-of tokyocabinet, qdbm, gdbm or bdb must be present.
76977697+<emphasis>--enable-hcache</emphasis> option. It's not turned on by
76987698+default because external database libraries are required: one of
76997699+tokyocabinet, qdbm, gdbm or bdb must be present.
74817700</para>
7482770174837702<para>
74847484-If enabled, <link
74857485-linkend="header-cache">$header_cache</link> can be
74867486-used to either point to a file or a directory. If set to point to
74877487-a file, one database file for all folders will be used (which may
74887488-result in lower performance), but one file per folder if it points
74897489-to a directory.
77037703+If enabled, <link linkend="header-cache">$header_cache</link> can be
77047704+used to either point to a file or a directory. If set to point to a
77057705+file, one database file for all folders will be used (which may result
77067706+in lower performance), but one file per folder if it points to a
77077707+directory.
74907708</para>
7491770974927710</sect2>
···750277207503772175047722<para>
75057505-In addition to caching message headers only, Mutt can also cache
75067506-whole message bodies. This results in faster display of messages
75077507-for POP and IMAP folders because messages usually have to be
75087508-downloaded only once.
77237723+In addition to caching message headers only, Mutt can also cache whole
77247724+message bodies. This results in faster display of messages for POP and
77257725+IMAP folders because messages usually have to be downloaded only once.
75097726</para>
7510772775117728<para>
75127729For configuration, the variable <link linkend="message-cachedir"
75137513->$message_cachedir</link> must point to a
75147514-directory. There, Mutt will create a hierarchy of subdirectories
75157515-named like: <literal>proto:user@hostname</literal> where
75167516-<literal>proto</literal> is either <quote>pop</quote> or <quote>imap.</quote> Within
75177517-there for each folder, Mutt stores messages in single files.
75187518-All files can be removed as needed if the consumed disk space
75197519-becomes an issue as Mutt will silently fetch missing items again.
77307730+>$message_cachedir</link> must point to a directory. There, Mutt will
77317731+create a hierarchy of subdirectories named like:
77327732+<literal>proto:user@hostname</literal> where <literal>proto</literal> is
77337733+either <quote>pop</quote> or <quote>imap.</quote> Within there for each
77347734+folder, Mutt stores messages in single files. All files can be removed
77357735+as needed if the consumed disk space becomes an issue as Mutt will
77367736+silently fetch missing items again.
75207737</para>
7521773875227739</sect2>
···75327749</para>
7533775075347751<para>
75357535-For body caches, Mutt can keep the local cache in sync with the
75367536-remote mailbox if the
75377537-<link linkend="message-cache-clean">$message_cache_clean</link>
75387538-variable is set. Cleaning means to remove messages from the cache which
75397539-are no longer present in the mailbox which only happens when other mail
75407540-clients or instances of Mutt using a different body cache location
75417541-delete messages (Mutt itself removes deleted messages from the cache
75427542-when syncing a mailbox). As cleaning can take a noticeable amount of time,
75437543-it should not be set in general but only occasionally.
77527752+For body caches, Mutt can keep the local cache in sync with the remote
77537753+mailbox if the <link
77547754+linkend="message-cache-clean">$message_cache_clean</link> variable is
77557755+set. Cleaning means to remove messages from the cache which are no
77567756+longer present in the mailbox which only happens when other mail clients
77577757+or instances of Mutt using a different body cache location delete
77587758+messages (Mutt itself removes deleted messages from the cache when
77597759+syncing a mailbox). As cleaning can take a noticeable amount of time, it
77607760+should not be set in general but only occasionally.
75447761</para>
7545776275467763</sect2>
···75517768<title>Exact Address Generation</title>
7552776975537770<para>
75547554-Mutt supports the <quote>Name <user@host></quote> address syntax for reading and
75557555-writing messages, the older <quote>user@host (Name)</quote> syntax is only supported when
75567556-reading messages. The <emphasis>--enable-exact-address</emphasis>
75577557-switch can be given to configure to build it with write-support
75587558-for the latter syntax. <literal>EXACT_ADDRESS</literal> in the output of
75597559-<literal>mutt -v</literal> indicates whether it's supported.
77717771+Mutt supports the <quote>Name <user@host></quote> address syntax
77727772+for reading and writing messages, the older <quote>user@host
77737773+(Name)</quote> syntax is only supported when reading messages. The
77747774+<emphasis>--enable-exact-address</emphasis> switch can be given to
77757775+configure to build it with write-support for the latter
77767776+syntax. <literal>EXACT_ADDRESS</literal> in the output of <literal>mutt
77777777+-v</literal> indicates whether it's supported.
75607778</para>
7561777975627780</sect1>
···75797797</para>
7580779875817799<para>
75827582-The chain selection screen is divided into two parts. In the
75837583-(larger) upper part, you get a list of remailers you may use. In
75847584-the lower part, you see the currently selected chain of remailers.
78007800+The chain selection screen is divided into two parts. In the (larger)
78017801+upper part, you get a list of remailers you may use. In the lower part,
78027802+you see the currently selected chain of remailers.
75857803</para>
7586780475877805<para>
75887588-You can navigate in the chain using the <literal><chain-prev></literal> and
75897589-<literal><chain-next></literal> functions, which are by default bound to the left
75907590-and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi
75917591-keyboard bindings). To insert a remailer at the current chain
75927592-position, use the <literal><insert></literal> function. To append a remailer behind
75937593-the current chain position, use <literal><select-entry></literal> or <literal><append></literal>.
75947594-You can also delete entries from the chain, using the corresponding
75957595-function. Finally, to abandon your changes, leave the menu, or
75967596-<literal><accept></literal> them pressing (by default) the <literal>Return</literal> key.
78067806+You can navigate in the chain using the
78077807+<literal><chain-prev></literal> and
78087808+<literal><chain-next></literal> functions, which are by default
78097809+bound to the left and right arrows and to the <literal>h</literal> and
78107810+<literal>l</literal> keys (think vi keyboard bindings). To insert a
78117811+remailer at the current chain position, use the
78127812+<literal><insert></literal> function. To append a remailer behind
78137813+the current chain position, use <literal><select-entry></literal>
78147814+or <literal><append></literal>. You can also delete entries from
78157815+the chain, using the corresponding function. Finally, to abandon your
78167816+changes, leave the menu, or <literal><accept></literal> them
78177817+pressing (by default) the <literal>Return</literal> key.
75977818</para>
7598781975997820<para>
76007600-Note that different remailers do have different capabilities,
76017601-indicated in the %c entry of the remailer menu lines (see
76027602-<link linkend="mix-entry-format">$mix_entry_format</link>). Most important is
76037603-the <quote>middleman</quote> capability, indicated by a capital <quote>M</quote>: This
76047604-means that the remailer in question cannot be used as the final
76057605-element of a chain, but will only forward messages to other
76067606-mixmaster remailers. For details on the other capabilities, please
76077607-have a look at the mixmaster documentation.
78217821+Note that different remailers do have different capabilities, indicated
78227822+in the %c entry of the remailer menu lines (see <link
78237823+linkend="mix-entry-format">$mix_entry_format</link>). Most important is
78247824+the <quote>middleman</quote> capability, indicated by a capital
78257825+<quote>M</quote>: This means that the remailer in question cannot be
78267826+used as the final element of a chain, but will only forward messages to
78277827+other mixmaster remailers. For details on the other capabilities,
78287828+please have a look at the mixmaster documentation.
76087829</para>
7609783076107831</sect1>
···76687889with every message sent. In a longer running mutt session, others can
76697890make assumptions about your mailing habbits depending on the number of
76707891messages sent. If this is not desired, the header can be manually
76717671-provided using <link
76727672-linkend="edit-headers">$edit_headers</link> (though not
76737673-recommended).
78927892+provided using <link linkend="edit-headers">$edit_headers</link> (though
78937893+not recommended).
76747894</para>
7675789576767896</sect2>
···7749796977507970<listitem>
77517971<para>
77527752-For remote folders (IMAP and POP) as well as folders using
77537753-one-file-per message storage (Maildir and MH), Mutt's
77547754-performance can be greatly improved using
77557755-<link linkend="header-caching">header caching</link>.
79727972+For remote folders (IMAP and POP) as well as folders using one-file-per
79737973+message storage (Maildir and MH), Mutt's performance can be greatly
79747974+improved using <link linkend="header-caching">header caching</link>.
77567975using a single database per folder.
77577976</para>
77587977</listitem>
7759797877607979<listitem>
77617980<para>
77627762-Mutt provides the <link linkend="read-inc">$read_inc</link>
77637763-and <link linkend="write-inc">$write_inc</link>
77647764-variables to specify at which rate to update progress
77657765-counters. If these values are too low, Mutt may spend more
77667766-time on updating the progress counter than it spends on
77677767-actually reading/writing folders.
79817981+Mutt provides the <link linkend="read-inc">$read_inc</link> and <link
79827982+linkend="write-inc">$write_inc</link> variables to specify at which rate
79837983+to update progress counters. If these values are too low, Mutt may spend
79847984+more time on updating the progress counter than it spends on actually
79857985+reading/writing folders.
77687986</para>
79877987+77697988<para>
77707770-For example, when opening a maildir folder with a few
77717771-thousand messages, the default value for
77727772-<link linkend="read-inc">$read_inc</link>
77737773-may be too low. It can be tuned on on a folder-basis using
77747774-<link linkend="folder-hook"><command>folder-hook</command>s</link>:
79897989+For example, when opening a maildir folder with a few thousand messages,
79907990+the default value for <link linkend="read-inc">$read_inc</link> may be
79917991+too low. It can be tuned on on a folder-basis using <link
79927992+linkend="folder-hook"><command>folder-hook</command>s</link>:
77757993</para>
7776799477777995<screen>
···77858003</listitem>
77868004</orderedlist>
7787800577887788-<para>These settings work on a per-message basis. However, as messages may
77897789-greatly differ in size and certain operations are much faster than others,
77907790-even per-folder settings of the increment variables may not be
80068006+<para>
80078007+These settings work on a per-message basis. However, as messages may
80088008+greatly differ in size and certain operations are much faster than
80098009+others, even per-folder settings of the increment variables may not be
77918010desirable as they produce either too few or too much progress updates.
77927792-Thus, Mutt allows to limit the number of progress updates per second it'll
77937793-actually send to the terminal using the
77947794-<link linkend="time-inc">$time_inc</link> variable.</para>
80118011+Thus, Mutt allows to limit the number of progress updates per second
80128012+it'll actually send to the terminal using the <link
80138013+linkend="time-inc">$time_inc</link> variable.
80148014+</para>
7795801577968016</sect1>
77978017···77998019<title>Reading Messages from Remote Folders</title>
7800802078018021<para>
78027802-Reading messages from remote folders such as IMAP an POP can be
78037803-slow especially for large mailboxes since Mutt only caches a very
78047804-limited number of recently viewed messages (usually 10) per
78057805-session (so that it will be gone for the next session.)
80228022+Reading messages from remote folders such as IMAP an POP can be slow
80238023+especially for large mailboxes since Mutt only caches a very limited
80248024+number of recently viewed messages (usually 10) per session (so that it
80258025+will be gone for the next session.)
78068026</para>
7807802778088028<para>
78097809-To improve performance and permanently cache whole messages,
78107810-please refer to Mutt's so-called
78117811-<link linkend="body-caching">body caching</link> for details.
80298029+To improve performance and permanently cache whole messages, please
80308030+refer to Mutt's so-called <link linkend="body-caching">body
80318031+caching</link> for details.
78128032</para>
7813803378148034</sect1>
···78178037<title>Searching and Limiting</title>
7818803878198039<para>
78207820-When searching mailboxes either via a search or a limit action, for
78217821-some patterns Mutt distinguishes between regular expression and string
80408040+When searching mailboxes either via a search or a limit action, for some
80418041+patterns Mutt distinguishes between regular expression and string
78228042searches. For regular expressions, patterns are prefixed with
78237823-<quote>#</quote> and with <quote>=</quote> for string searches.
80438043+<quote>~</quote> and with <quote>=</quote> for string searches.
78248044</para>
7825804578268046<para>
···78358055For example, when limiting a large folder to all messages sent to or by
78368056an author, it's much faster to search for the initial part of an e-mail
78378057address via <literal>=Luser@</literal> instead of
78387838-<literal>#Luser@</literal>. This is especially true for searching
80588058+<literal>~Luser@</literal>. This is especially true for searching
78398059message bodies since a larger amount of input has to be searched.
78408060</para>
7841806178428062<para>
78438063As for regular expressions, a lower case string search pattern makes
78448064Mutt perform a case-insensitive search except for IMAP (because for IMAP
78457845-Mutt performs server-side searches which don't support case-insensivity).
80658065+Mutt performs server-side searches which don't support
80668066+case-insensivity).
78468067</para>
7847806878488069</sect1>
···78568077<title>Command-Line Options</title>
7857807878588079<para>
78597859-Running <literal>mutt</literal> with no arguments will make Mutt attempt to read your spool
78607860-mailbox. However, it is possible to read other mailboxes and
78617861-to send messages from the command line as well.
80808080+Running <literal>mutt</literal> with no arguments will make Mutt attempt
80818081+to read your spool mailbox. However, it is possible to read other
80828082+mailboxes and to send messages from the command line as well.
78628083</para>
7863808478648085<table id="tab-commandline-options">
···79438164</cmdsynopsis>
7944816579458166<para>
79467946-Mutt also supports a <quote>batch</quote> mode to send prepared messages. Simply redirect
79477947-input from the file you wish to send. For example,
81678167+Mutt also supports a <quote>batch</quote> mode to send prepared
81688168+messages. Simply redirect input from the file you wish to send. For
81698169+example,
79488170</para>
7949817179508172<screen>
79517951-mutt -s "data set for run #2" professor@bigschool.edu < #/run2.dat</screen>
81738173+mutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat</screen>
7952817479538175<para>
79547954-will send a message to <literal><professor@bigschool.edu></literal> with a subject
79557955-of <quote>data set for run #2</quote>. In the body of the message will be the contents
79567956-of the file <quote>#/run2.dat</quote>.
81768176+will send a message to
81778177+<literal><professor@bigschool.edu></literal> with a subject of
81788178+<quote>data set for run #2</quote>. In the body of the message will be
81798179+the contents of the file <quote>~/run2.dat</quote>.
79578180</para>
7958818179598182<para>
79607960-All files passed with <literal>-a</literal> <emphasis>file</emphasis> will be attached as a MIME
79617961-part to the message. To attach a single or several files, use <quote>--</quote> to separate files and
79627962-recipient addresses:
81838183+All files passed with <literal>-a</literal> <emphasis>file</emphasis>
81848184+will be attached as a MIME part to the message. To attach a single or
81858185+several files, use <quote>--</quote> to separate files and recipient
81868186+addresses:
79638187</para>
7964818879658189<screen>
+6-8
doc/manual.xml.tail
···3636<title>Acknowledgements</title>
37373838<para>
3939-Kari Hurtta <email>kari.hurtta@fmi.fi</email>
4040-co-developed the original MIME parsing code back in the ELM-ME days.
3939+Kari Hurtta <email>kari.hurtta@fmi.fi</email> co-developed the original
4040+MIME parsing code back in the ELM-ME days.
4141</para>
42424343<para>
···9595<title>About This Document</title>
96969797<para>
9898-This document was written in <ulink url="http://docbook.sourceforge.net">DocBook</ulink>,
9999-and then rendered using the <ulink url="http://xmlsoft.org/XSLT/">Gnome XSLT toolkit</ulink>.
9898+This document was written in <ulink
9999+url="http://docbook.sourceforge.net">DocBook</ulink>, and then rendered
100100+using the <ulink url="http://xmlsoft.org/XSLT/">Gnome XSLT
101101+toolkit</ulink>.
100102</para>
101103102104</sect1>
···104106</chapter>
105107106108</book>
107107-108108-<!--
109109-vim:ft=xml
110110--->