1 <?xml version="1.0" encoding="utf-8"?>
2 <!-- THIS FILE IST NOT VALID DOCBOOK ! DTD REMOVED -->
3 <!-- Please don't use html entities like [, ] ^ -->
4 <!-- etc. they don't work with xml! -->
5 <book xmlns:muttng-doc="http://mutt-ng.berlios.de/doc/#NS">
8 <title>The Mutt Next Generation E-Mail Client</title>
10 <firstname>Andreas</firstname><surname>Krennmair</surname>
11 <email>ak@synflood.at</email>
14 <firstname>Michael</firstname><surname>Elkins</surname>
15 <email>me@cs.hmc.edu</email>
17 <pubdate>version @VERSION@</pubdate>
20 Michael Elinks on mutt, circa 1995:
21 ``All mail clients suck. This one just sucks less.''
24 Sven Guckes on mutt, ca. 2003: ``But it still sucks!''
27 </bookinfo> <!--}}}-->
29 <chapter id="introduction"> <!--{{{-->
30 <title>Introduction</title>
33 <title>Overview</title>
36 <emphasis role="bold">Mutt-ng</emphasis> is a small but very
37 powerful text-based MIME mail client. Mutt-ng is highly
38 configurable, and is well suited to the mail power user with
39 advanced features like key bindings, keyboard macros, mail
40 threading, regular expression searches and a powerful pattern
41 matching language for selecting groups of messages.
45 This documentation additionally contains documentation to
46 <emphasis role="bold"> Mutt-NG </emphasis> ,a fork from Mutt
47 with the goal to fix all the little annoyances of Mutt, to
48 integrate all the Mutt patches that are floating around in the
49 web, and to add other new features. Features specific to Mutt-ng
50 will be discussed in an extra section. Don't be confused when
51 most of the documentation talk about Mutt and not Mutt-ng,
52 Mutt-ng contains all Mutt features, plus many more.
62 <title>Mutt-ng Home Page</title>
65 <ulink url="http://www.muttng.org/">http://www.muttng.org</ulink>
74 <sect1 id="mailinglists">
75 <title>Mailing Lists</title>
83 <email>mutt-ng-users@lists.berlios.de</email>: This is
84 where the mutt-ng user support happens.
90 <email>mutt-ng-devel@lists.berlios.de</email>: The
91 development mailing list for mutt-ng
105 <sect1 id="distrib-sites">
106 <title>Software Distribution Sites</title>
109 So far, there are no official releases of Mutt-ng, but you can
110 download daily snapshots from <ulink
111 url="http://mutt-ng.berlios.de/snapshots/"
112 >http://mutt-ng.berlios.de/snapshots/</ulink>
125 Visit channel <emphasis>#muttng</emphasis> on <ulink
126 url="http://www.freenode.net/">irc.freenode.net
127 (www.freenode.net) </ulink> to chat with other people
128 interested in Mutt-ng.
134 <title>Weblog</title>
137 If you want to read fresh news about the latest development in
138 Mutt-ng, and get informed about stuff like interesting,
139 Mutt-ng-related articles and packages for your favorite
140 distribution, you can read and/or subscribe to our <ulink
141 url="http://mutt-ng.supersized.org/">Mutt-ng development
147 <sect1 id="copyright">
148 <title>Copyright</title>
151 Mutt is Copyright (C) 1996-2000 Michael R. Elkins
152 <me@cs.hmc.edu> and others
156 This program is free software; you can redistribute it and/or modify
157 it under the terms of the GNU General Public License as published by
158 the Free Software Foundation; either version 2 of the License, or
159 (at your option) any later version.
163 This program is distributed in the hope that it will be useful,
164 but WITHOUT ANY WARRANTY; without even the implied warranty of
165 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
166 GNU General Public License for more details.
170 You should have received a copy of the GNU General Public License
171 along with this program; if not, write to the Free Software
172 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
177 <sect1 id="conventions">
178 <title>Manual Conventions</title>
181 This manual contains several (hopefully consistent) conventions to
182 specially layout different items in different fashions.
188 <para>Configuration and environment variables will be printed
189 in a typewriter font and both prefixed with a dollar sign as
190 it's common for UNIX-like environments. Configuration
191 variables are lower-case only while environment variables
192 are upper-case only.</para>
195 <para>Muttng-specific commands are enclosed in
196 <literal><></literal> and printed in a typewriter font,
200 <para>As common for UNIX-like environments, references to
201 manual pages are printed with the section enclosed in
202 braces, as in <muttng-doc:man name="vi"/> or <muttng-doc:man
203 name="muttngrc" sect="5"/>. Execute <literal>man [section]
204 [name]</literal> to view the manual page.</para>
210 If, while reading this fine manual, you find any inconsistencies
211 of whatever kind, please contact the developers via
212 <email>mutt-ng-devel@lists.berlios.de</email> to report it.
220 <chapter id="getting-started"> <!--{{{-->
221 <title>Getting Started</title>
223 <sect1 id="basic-concepts"> <!--{{{-->
224 <title>Basic Concepts</title>
226 <sect2 id="concept-screens-and-menus"> <!--{{{-->
227 <title>Screens and Menus</title>
230 mutt-ng offers different screens of which every has its special
240 The <emphasis>index</emphasis> displays the contents of the
249 The <emphasis>pager</emphasis> is responsible for displaying
251 is, the header, the body and all attached parts.
258 The <emphasis>file browser</emphasis> offers operations on and
260 information of all folders mutt-ng should watch for mail.
267 The <emphasis>sidebar</emphasis> offers a permanent view of
269 contain how many total, new and/or flagged mails.
276 The <emphasis>help screen</emphasis> lists for all currently
278 commands how to invoke them as well as a short description.
285 The <emphasis>compose</emphasis> menu is a comfortable
287 actions before sending mail: change subjects, attach files,
296 The <emphasis>attachement</emphasis> menu gives a summary and
298 structure of the attachements of the current message.
305 The <emphasis>alias</emphasis> menu lists all or a fraction of
314 The <emphasis>key</emphasis> menu used in connection with
316 users choose the right key to encrypt with.
326 When mutt-ng is started without any further options, it'll open
327 the users default mailbox and display the index.
337 <sect2 id="concept-configuration"> <!--{{{-->
338 <title>Configuration</title>
341 Mutt-ng does <emphasis>not</emphasis> feature an internal
343 interface or menu due to the simple fact that this would be too
344 complex to handle (currently there are several <emphasis>hundred</emphasis>
345 variables which fine-tune the behaviour.)
349 Mutt-ng is configured using configuration files which allow
350 users to add comments or manage them via version control systems
355 Also, mutt-ng comes with a shell script named <literal>grml-muttng</literal>
356 kindly contributed by users which really helps and eases the
357 creation of a user's configuration file. When downloading the
358 source code via a snapshot or via subversion, it can be found in
359 the <literal>contrib</literal> directory.
369 <sect2 id="concept-functions"> <!--{{{-->
370 <title>Functions</title>
373 Mutt-ng offers great flexibility due to the use of functions:
374 internally, every action a user can make mutt-ng perform is named
375 ``function.'' Those functions are assigned to keys (or even key
376 sequences) and may be completely adjusted to user's needs. The
377 basic idea is that the impatient users get a very intuitive
378 interface to start off with and advanced users virtually get no
379 limits to adjustments.
389 <sect2 id="concept-interaction"> <!--{{{-->
390 <title>Interaction</title>
393 Mutt-ng has two basic concepts of user interaction:
402 There is one dedicated line on the screen used to query
403 the user for input, issue any command, query variables and
404 display error and informational messages. As for every type of
405 user input, this requires manual action leading to the need of
413 The automatized interface for interaction are the so
414 called <emphasis>hooks</emphasis>. Hooks specify actions the
416 performed at well-defined situations: what to do when entering
417 which folder, what to do when displaying or replying to what
418 kind of message, etc. These are optional, i.e. a user doesn't
419 need to specify them but can do so.
435 <sect2 id="concept-modularization"> <!--{{{-->
436 <title>Modularization</title>
439 Although mutt-ng has many functionality built-in, many
440 features can be delegated to external tools to increase
441 flexibility: users can define programs to filter a message through
442 before displaying, users can use any program they want for
443 displaying a message, message types (such as PDF or PostScript)
444 for which mutt-ng doesn't have a built-in filter can be rendered
445 by arbitrary tools and so forth. Although mutt-ng has an alias
446 mechanism built-in, it features using external tools to query for
447 nearly every type of addresses from sources like LDAP, databases
448 or just the list of locally known users.
458 <sect2 id="concept-patterns"> <!--{{{-->
459 <title>Patterns</title>
462 Mutt-ng has a built-in pattern matching ``language'' which is
463 as widely used as possible to present a consistent interface to
464 users. The same ``pattern terms'' can be used for searching,
465 scoring, message selection and much more.
483 <sect1 id="screens-and-menus"> <!--{{{-->
484 <title>Screens and Menus</title>
486 <sect2 id="intro-index">
490 The index is the screen that you usually see first when you
491 start mutt-ng. It gives an overview over your emails in the
492 currently opened mailbox. By default, this is your system mailbox.
493 The information you see in the index is a list of emails, each with
494 its number on the left, its flags (new email, important email,
495 email that has been forwarded or replied to, tagged email, ...),
496 the date when email was sent, its sender, the email size, and the
497 subject. Additionally, the index also shows thread hierarchies:
498 when you reply to an email, and the other person replies back, you
499 can see the other's person email in a "sub-tree" below. This is
500 especially useful for personal email between a group of people or
501 when you've subscribed to mailing lists.
510 <sect2 id="intro-pager">
514 The pager is responsible for showing the email content. On the
515 top of the pager you have an overview over the most important email
516 headers like the sender, the recipient, the subject, and much more
517 information. How much information you actually see depends on your
518 configuration, which we'll describe below.
522 Below the headers, you see the email body which usually contains
523 the message. If the email contains any attachments, you will see
524 more information about them below the email body, or, if the
525 attachments are text files, you can view them directly in the
530 To give the user a good overview, it is possible to configure
531 mutt-ng to show different things in the pager with different
532 colors. Virtually everything that can be described with a regular
533 expression can be colored, e.g. URLs, email addresses or smileys.
542 <sect2 id="intro-browser">
543 <title>File Browser</title>
546 The file browser is the interface to the local or remote
547 file system. When selecting a mailbox to open, the browser allows
548 custom sorting of items, limiting the items shown by a regular
549 expression and a freely adjustable format of what to display in
550 which way. It also allows for easy navigation through the
551 file system when selecting file(s) to attach to a message, select
552 multiple files to attach and many more.
561 <sect2 id="intro-sidebar">
562 <title>Sidebar</title>
565 The sidebar comes in handy to manage mails which are spread
566 over different folders. All folders users setup mutt-ng to watch
567 for new mail will be listed. The listing includes not only the
568 name but also the number of total messages, the number of new and
569 flagged messages. Items with new mail may be colored different
570 from those with flagged mail, items may be shortened or compress
571 if they're they to long to be printed in full form so that by
572 abbreviated names, user still now what the name stands for.
581 <sect2 id="intro-help">
585 The help screen is meant to offer a quick help to the user. It
586 lists the current configuration of key bindings and their
587 associated commands including a short description, and currently
588 unbound functions that still need to be associated with a key
589 binding (or alternatively, they can be called via the mutt-ng
599 <sect2 id="intro-compose">
600 <title>Compose Menu</title>
603 The compose menu features a split screen containing the
604 information which really matter before actually sending a
605 message by mail or posting an article to a newsgroup: who gets
606 the message as what (recipient, newsgroup, who gets what kind of
607 copy). Additionally, users may set security options like
608 deciding whether to sign, encrypt or sign and encrypt a message
613 Also, it's used to attach messages, news articles or files to
614 a message, to re-edit any attachment including the message
624 <sect2 id="intro-alias">
625 <title>Alias Menu</title>
628 The alias menu is used to help users finding the recipients
629 of messages. For users who need to contact many people, there's
630 no need to remember addresses or names completely because it
631 allows for searching, too. The alias mechanism and thus the
632 alias menu also features grouping several addresses by a shorter
633 nickname, the actual alias, so that users don't have to select
634 each single recipient manually.
643 <sect2 id="intro-attach">
644 <title>Attachment Menu</title>
647 As will be later discussed in detail, mutt-ng features a good
648 and stable MIME implementation, that is, is greatly supports
649 sending and receiving messages of arbitrary type. The
650 attachment menu displays a message's structure in detail: what
651 content parts are attached to which parent part (which gives a
652 true tree structure), which type is of what type and what size.
653 Single parts may saved, deleted or modified to offer great and
654 easy access to message's internals.
663 <sect2 id="intro-keysel">
664 <title>Key Menu</title>
667 <literal>FIXME</literal>
683 <sect1 id="moving"> <!--{{{-->
684 <title>Moving Around in Menus</title>
687 Information is presented in menus, very similar to ELM. Here is a
688 tableshowing the common keys used to navigate menus in Mutt-ng.
694 <title>Most commonly used movement bindings</title>
695 <tgroup cols="3" align="left" colsep="1" rowsep="1">
699 <entry>Function</entry>
700 <entry>Description</entry>
705 <entry><literal>j</literal> or <literal>Down</literal></entry>
706 <entry><muttng-doc:funcref name="next-entry"/></entry>
707 <entry>move to the next entry</entry>
710 <entry><literal>k</literal> or <literal>Up</literal></entry>
711 <entry><muttng-doc:funcref name="previous-entry"/></entry>
712 <entry>move to the previous entry</entry>
715 <entry><literal>z</literal> or <literal>PageDn</literal></entry>
716 <entry><muttng-doc:funcref name="page-down"/></entry>
717 <entry>go to the next page</entry>
720 <entry><literal>Z</literal> or <literal>PageUp</literal></entry>
721 <entry><muttng-doc:funcref name="page-up"/></entry>
722 <entry>go to the previous page</entry>
725 <entry><literal>=</literal> or <literal>Home</literal></entry>
726 <entry><muttng-doc:funcref name="first-entry"/></entry>
727 <entry>jump to the first entry</entry>
730 <entry><literal>*</literal> or <literal>End</literal></entry>
731 <entry><muttng-doc:funcref name="last-entry"/></entry>
732 <entry>jump to the last entry</entry>
735 <entry><literal>q</literal></entry>
736 <entry><muttng-doc:funcref name="quit"/></entry>
737 <entry>exit the current menu</entry>
740 <entry><literal>?</literal></entry>
741 <entry><muttng-doc:funcref name="help"/></entry>
742 <entry>list all key bindings for the current menu</entry>
758 <sect1 id="editing"> <!--{{{-->
759 <title>Editing Input Fields</title>
762 Mutt-ng has a builtin line editor which is used as the primary way to
764 textual data such as email addresses or filenames. The keys used to
766 around while editing are very similar to those of Emacs.
772 <title>Line Editor Functions</title>
773 <tgroup cols="3" align="left" colsep="1" rowsep="1">
777 <entry>Function</entry>
778 <entry>Description</entry>
783 <entry><literal>^A or <Home> </literal></entry>
784 <entry><muttng-doc:funcref name="bol"/></entry>
785 <entry>move to the start of the line</entry>
788 <entry><literal>^B or <Left> </literal></entry>
789 <entry><muttng-doc:funcref name="backward-char"/>
790 </entry><entry>move back one char</entry>
793 <entry><literal>Esc B </literal></entry>
794 <entry><muttng-doc:funcref name="backward-word"/></entry>
795 <entry>move back one word</entry>
798 <entry><literal>^D or <Delete> </literal></entry>
799 <entry><muttng-doc:funcref name="delete-char"/></entry>
800 <entry>delete the char under the cursor</entry>
803 <entry><literal>^E or <End> </literal></entry>
804 <entry><muttng-doc:funcref name="eol"/></entry>
805 <entry>move to the end of the line</entry>
808 <entry><literal>^F or <Right> </literal></entry>
809 <entry><muttng-doc:funcref name="forward-char"/></entry>
810 <entry>move forward one char</entry>
813 <entry><literal>Esc F </literal></entry>
814 <entry><muttng-doc:funcref name="forward-word"/></entry>
815 <entry>move forward one word</entry>
818 <entry><literal><Tab></literal></entry>
819 <entry><muttng-doc:funcref name="complete"/></entry>
820 <entry>complete filename or alias</entry>
823 <entry><literal>^T</literal></entry>
824 <entry><muttng-doc:funcref name="complete-query"/></entry>
825 <entry>complete address with query</entry>
828 <entry><literal>^K</literal></entry>
829 <entry><muttng-doc:funcref name="kill-eol"/></entry>
830 <entry>delete to the end of the line</entry>
833 <entry><literal>ESC d </literal></entry>
834 <entry><muttng-doc:funcref name="kill-eow"/></entry>
835 <entry>delete to the end of the word</entry>
838 <entry><literal>^W</literal></entry>
839 <entry><muttng-doc:funcref name="kill-word"/></entry>
840 <entry>kill the word in front of the cursor</entry>
843 <entry><literal>^U</literal></entry>
844 <entry><muttng-doc:funcref name="kill-line"/></entry>
845 <entry>delete entire line</entry>
848 <entry><literal>^V</literal></entry>
849 <entry><muttng-doc:funcref name="quote-char"/></entry>
850 <entry>quote the next typed key</entry>
853 <entry><literal><Up></literal></entry>
854 <entry><muttng-doc:funcref name="history-up"/></entry>
855 <entry>recall previous string from history</entry>
858 <entry><literal><Down></literal></entry>
859 <entry><muttng-doc:funcref name="history-down"/></entry>
860 <entry>recall next string from history</entry>
863 <entry><literal><BackSpace></literal></entry>
864 <entry><muttng-doc:funcref name="backspace"/></entry>
865 <entry>kill the char in front of the cursor</entry>
868 <entry><literal>Esc u </literal></entry>
869 <entry><muttng-doc:funcref name="upcase-word"/></entry>
870 <entry>convert word to upper case</entry>
873 <entry><literal>Esc l </literal></entry>
874 <entry><muttng-doc:funcref name="downcase-word"/></entry>
875 <entry>convert word to lower case</entry>
878 <entry><literal>Esc c </literal></entry>
879 <entry><muttng-doc:funcref name="capitalize-word"/></entry>
880 <entry>capitalize the word</entry>
883 <entry><literal>^G</literal></entry>
884 <entry><literal>n/a</literal></entry>
888 <entry><literal><Return></literal></entry>
889 <entry><literal>n/a</literal></entry>
890 <entry>finish editing</entry>
899 You can remap the <emphasis>editor</emphasis> functions using the
900 <muttng-doc:command name="bind"/> command. For example, to make
901 the <emphasis>Delete</emphasis> key delete the character in front
902 of the cursor rather than under, you could use
906 <literal>bind editor <delete> backspace</literal>
912 <sect1 id="reading"> <!--{{{-->
913 <title>Reading Mail - The Index and Pager</title>
916 Similar to many other mail clients, there are two modes in which mail
917 isread in Mutt-ng. The first is the index of messages in the mailbox,
919 called the ``index'' in Mutt-ng. The second mode is the display of the
920 message contents. This is called the ``pager.''
924 The next few sections describe the functions provided in each of these
928 <sect2 id="reading-index">
929 <title>The Message Index</title>
934 <title>Most commonly used Index Bindings</title>
935 <tgroup cols="3" align="left" colsep="1" rowsep="1">
939 <entry>Function</entry>
940 <entry>Description</entry>
945 <entry><literal>c</literal></entry>
946 <entry><literal></literal></entry>
947 <entry>change to a different mailbox</entry>
950 <entry><literal>ESC c </literal></entry>
951 <entry><literal></literal></entry>
952 <entry>change to a folder in read-only mode</entry>
955 <entry><literal>C</literal></entry>
956 <entry><literal></literal></entry>
957 <entry>copy the current message to another mailbox</entry>
960 <entry><literal>ESC C </literal></entry>
961 <entry><literal></literal></entry>
962 <entry>decode a message and copy it to a folder</entry>
965 <entry><literal>ESC s </literal></entry>
966 <entry><literal></literal></entry>
967 <entry>decode a message and save it to a folder</entry>
970 <entry><literal>D</literal></entry>
971 <entry><literal></literal></entry>
972 <entry>delete messages matching a pattern</entry>
975 <entry><literal>d</literal></entry>
976 <entry><literal></literal></entry>
977 <entry>delete the current message</entry>
980 <entry><literal>F</literal></entry>
981 <entry><literal></literal></entry>
982 <entry>mark as important</entry>
985 <entry><literal>l</literal></entry>
986 <entry><literal></literal></entry>
987 <entry>show messages matching a pattern</entry>
990 <entry><literal>N</literal></entry>
991 <entry><literal></literal></entry>
992 <entry>mark message as new</entry>
995 <entry><literal>o</literal></entry>
996 <entry><literal></literal></entry>
997 <entry>change the current sort method</entry>
1000 <entry><literal>O</literal></entry>
1001 <entry><literal></literal></entry>
1002 <entry>reverse sort the mailbox</entry>
1005 <entry><literal>q</literal></entry>
1006 <entry><literal></literal></entry>
1007 <entry>save changes and exit</entry>
1010 <entry><literal>s</literal></entry>
1011 <entry><literal></literal></entry>
1012 <entry>save-message</entry>
1015 <entry><literal>T</literal></entry>
1016 <entry><literal></literal></entry>
1017 <entry>tag messages matching a pattern</entry>
1020 <entry><literal>t</literal></entry>
1021 <entry><literal></literal></entry>
1022 <entry>toggle the tag on a message</entry>
1025 <entry><literal>ESC t </literal></entry>
1026 <entry><literal></literal></entry>
1027 <entry>toggle tag on entire message thread</entry>
1030 <entry><literal>U</literal></entry>
1031 <entry><literal></literal></entry>
1032 <entry>undelete messages matching a pattern</entry>
1035 <entry><literal>u</literal></entry>
1036 <entry><literal></literal></entry>
1037 <entry>undelete-message</entry>
1040 <entry><literal>v</literal></entry>
1041 <entry><literal></literal></entry>
1042 <entry>view-attachments</entry>
1045 <entry><literal>x</literal></entry>
1046 <entry><literal></literal></entry>
1047 <entry>abort changes and exit</entry>
1050 <entry><literal><Return></literal></entry>
1051 <entry><literal></literal></entry>
1052 <entry>display-message</entry>
1055 <entry><literal><Tab></literal></entry>
1056 <entry><literal></literal></entry>
1057 <entry>jump to the next new or unread message</entry>
1060 <entry><literal>@</literal></entry>
1061 <entry><literal></literal></entry>
1062 <entry>show the author's full e-mail address</entry>
1065 <entry><literal>$</literal></entry>
1066 <entry><literal></literal></entry>
1067 <entry>save changes to mailbox</entry>
1070 <entry><literal>/</literal></entry>
1071 <entry><literal></literal></entry>
1072 <entry>search</entry>
1075 <entry><literal>ESC / </literal></entry>
1076 <entry><literal></literal></entry>
1077 <entry>search-reverse</entry>
1080 <entry><literal>^L</literal></entry>
1081 <entry><literal></literal></entry>
1082 <entry>clear and redraw the screen</entry>
1085 <entry><literal>^T</literal></entry>
1086 <entry><literal></literal></entry>
1087 <entry>untag messages matching a pattern</entry>
1096 <title>Status Flags</title> <!--{{{-->
1099 In addition to who sent the message and the subject, a short
1101 the disposition of each message is printed beside the message
1103 Zero or more of the following ``flags'' may appear, which mean:
1114 message is deleted (is marked for deletion)
1122 message have attachments marked for deletion
1130 contains a PGP public key
1154 message is PGP encrypted
1162 message has been replied to
1170 message is signed, and the signature is succesfully
1203 Some of the status flags can be turned on or off using
1209 <emphasis role="bold">set-flag</emphasis> (default: w)
1215 <emphasis role="bold">clear-flag</emphasis> (default: W)
1224 Furthermore, the following flags reflect who the message is
1226 to. They can be customized with the
1227 <muttng-doc:varref name="to_chars" link="to-chars"/> variable.
1237 message is to you and you only
1245 message is to you, but also to or cc'ed to others
1253 message is cc'ed to you
1269 message is sent to a subscribed mailing list
1280 <sect2 id="reading-pager">
1281 <title>The Pager</title>
1284 By default, Mutt-ng uses its builtin pager to display the body of
1286 The pager is very similar to the Unix program <emphasis>less</emphasis> though not nearly as
1293 <title>Most commonly used Pager Bindings</title>
1294 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1298 <entry>Function</entry>
1299 <entry>Description</entry>
1304 <entry><literal><Return></literal></entry>
1305 <entry><literal></literal></entry>
1306 <entry>go down one line</entry>
1309 <entry><literal><Space></literal></entry>
1310 <entry><literal></literal></entry>
1311 <entry>display the next page (or next message if at the end of a message)</entry>
1314 <entry><literal>-</literal></entry>
1315 <entry><literal></literal></entry>
1316 <entry>go back to the previous page</entry>
1319 <entry><literal>n</literal></entry>
1320 <entry><literal></literal></entry>
1321 <entry>search for next match</entry>
1324 <entry><literal>S</literal></entry>
1325 <entry><literal></literal></entry>
1326 <entry>skip beyond quoted text</entry>
1329 <entry><literal>T</literal></entry>
1330 <entry><literal></literal></entry>
1331 <entry>toggle display of quoted text</entry>
1334 <entry><literal>?</literal></entry>
1335 <entry><literal></literal></entry>
1336 <entry>show key bindings</entry>
1339 <entry><literal>/</literal></entry>
1340 <entry><literal></literal></entry>
1341 <entry>search for a regular expression (pattern)</entry>
1344 <entry><literal>ESC / </literal></entry>
1345 <entry><literal></literal></entry>
1346 <entry>search backwards for a regular expression</entry>
1349 <entry><literal>\</literal></entry>
1350 <entry><literal></literal></entry>
1351 <entry>toggle search pattern coloring</entry>
1354 <entry><literal>^</literal></entry>
1355 <entry><literal></literal></entry>
1356 <entry>jump to the top of the message</entry>
1366 In addition, many of the functions from the <emphasis>index</emphasis> are available in
1367 the pager, such as <emphasis>delete-message</emphasis> or <emphasis>
1371 advantage over using an external pager to view messages).
1375 Also, the internal pager supports a couple other advanced features.
1377 one, it will accept and translate the ``standard'' nroff sequences
1378 forbold and underline. These sequences are a series of either the
1380 backspace (^H), the letter again for bold or the letter,
1382 ``_'' for denoting underline. Mutt-ng will attempt to display
1384 in bold and underline respectively if your terminal supports them. If
1385 not, you can use the bold and underline <muttng-doc:command name="color"/>
1386 objects to specify a color or mono attribute for them.
1390 Additionally, the internal pager supports the ANSI escape
1391 sequences for character attributes. Mutt-ng translates them
1392 into the correct color and character settings. The sequences
1393 Mutt-ng supports are: <literal>ESC [ Ps;Ps;Ps;...;Ps
1394 m</literal> (see table below for possible values for
1395 <literal>Ps</literal>).
1401 <title>ANSI Escape Sequences</title>
1402 <tgroup cols="2" align="left" colsep="1" rowsep="1">
1405 <entry>Value</entry>
1406 <entry>Attribute</entry>
1411 <entry><literal>0</literal></entry>
1412 <entry>All Attributes Off</entry>
1415 <entry><literal>1</literal></entry>
1416 <entry>Bold on</entry>
1419 <entry><literal>4</literal></entry>
1420 <entry>Underline on</entry>
1423 <entry><literal>5</literal></entry>
1424 <entry>Blink on</entry>
1427 <entry><literal>7</literal></entry>
1428 <entry>Reverse video on</entry>
1431 <entry><literal>3x</literal></entry>
1432 <entry>Foreground color is x (see table below)</entry>
1435 <entry><literal>4x</literal></entry>
1436 <entry>Background color is x (see table below)</entry>
1444 <title>ANSI Colors</title>
1445 <tgroup cols="2" align="left" colsep="1" rowsep="1">
1448 <entry>Number</entry>
1449 <entry>Color</entry>
1454 <entry><literal>0</literal></entry>
1455 <entry>black</entry>
1458 <entry><literal>1</literal></entry>
1462 <entry><literal>2</literal></entry>
1463 <entry>green</entry>
1466 <entry><literal>3</literal></entry>
1467 <entry>yellow</entry>
1470 <entry><literal>4</literal></entry>
1474 <entry><literal>5</literal></entry>
1475 <entry>magenta</entry>
1478 <entry><literal>6</literal></entry>
1482 <entry><literal>7</literal></entry>
1483 <entry>white</entry>
1493 Mutt-ng uses these attributes for handling text/enriched messages,
1495 can also be used by an external <link linkend="auto-view">autoview</link>
1496 script for highlighting purposes. <emphasis role="bold">Note:</emphasis> If you change the colors for your
1497 display, for example by changing the color associated with color2 for
1498 your xterm, then that color will be used instead of green.
1503 <sect2 id="threads">
1504 <title>Threaded Mode</title>
1507 When the mailbox is <link linkend="sort">sorted</link> by <emphasis>
1511 a few additional functions available in the <emphasis>index</emphasis> and <emphasis>
1520 <title>Most commonly used thread-related bindings</title>
1521 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1525 <entry>Function</entry>
1526 <entry>Description</entry>
1531 <entry><literal>^D</literal></entry>
1532 <entry><muttng-doc:funcref name="delete-thread"/></entry>
1533 <entry>delete all messages in the current thread</entry>
1536 <entry><literal>^U</literal></entry>
1537 <entry><muttng-doc:funcref name="undelete-thread"/></entry>
1538 <entry>undelete all messages in the current thread</entry>
1541 <entry><literal>^N</literal></entry>
1542 <entry><muttng-doc:funcref name="next-thread"/></entry>
1543 <entry>jump to the start of the next thread</entry>
1546 <entry><literal>^P</literal></entry>
1547 <entry><muttng-doc:funcref name="previous-thread"/></entry>
1548 <entry>jump to the start of the previous thread</entry>
1551 <entry><literal>^R</literal></entry>
1552 <entry><muttng-doc:funcref name="read-thread"/></entry>
1553 <entry>mark the current thread as read</entry>
1556 <entry><literal>ESC d </literal></entry>
1557 <entry><muttng-doc:funcref name="delete-subthread"/></entry>
1558 <entry>delete all messages in the current subthread</entry>
1561 <entry><literal>ESC u </literal></entry>
1562 <entry><muttng-doc:funcref name="undelete-subthread"/></entry>
1563 <entry>undelete all messages in the current subthread</entry>
1566 <entry><literal>ESC n </literal></entry>
1567 <entry><muttng-doc:funcref name="next-subthread"/></entry>
1568 <entry>jump to the start of the next subthread</entry>
1571 <entry><literal>ESC p </literal></entry>
1572 <entry><muttng-doc:funcref name="previous-subthread"/></entry>
1573 <entry>jump to the start of the previous subthread</entry>
1576 <entry><literal>ESC r </literal></entry>
1577 <entry><muttng-doc:funcref name="read-subthread"/></entry>
1578 <entry>mark the current subthread as read </entry>
1581 <entry><literal>ESC t </literal></entry>
1582 <entry><muttng-doc:funcref name="tag-thread"/></entry>
1583 <entry>toggle the tag on the current thread</entry>
1586 <entry><literal>ESC v </literal></entry>
1587 <entry><muttng-doc:funcref name="collapse-thread"/></entry>
1588 <entry>toggle collapse for the current thread</entry>
1591 <entry><literal>ESC V </literal></entry>
1592 <entry><muttng-doc:funcref name="collapse-all"/></entry>
1593 <entry>toggle collapse for all threads</entry>
1596 <entry><literal>P</literal></entry>
1597 <entry><muttng-doc:funcref name="parent-message"/></entry>
1598 <entry>jump to parent message in thread</entry>
1608 <emphasis role="bold">Note:</emphasis> Collapsing a thread displays
1609 only the first message
1610 in the thread and hides the others. This is useful when threads
1611 contain so many messages that you can only see a handful of threads
1612 onthe screen. See <literal>%M</literal> in
1613 <muttng-doc:varref name="index_format" link="index-format"/>.
1617 For example, you could use
1618 <literal>%?M?(#%03M)&(%4l)?</literal> in <muttng-doc:varref name="index_format" link="index-format"/>
1620 display the number of hidden messages if the thread is collapsed.
1624 See also the <muttng-doc:varref name="strict_threads" link="strict-threads"/> variable.
1629 <sect2 id="pager-functions">
1630 <title>Miscellaneous Functions</title>
1633 <muttng-doc:funcdef name="create-alias" key="a"/>
1637 Creates a new alias based upon the current message (or prompts for a
1638 new one). Once editing is complete, an <muttng-doc:command name="alias"/>
1639 command is added to the file specified by the <muttng-doc:varref name="alias_file" link="alias-file"/>
1640 variable for future use. <emphasis role="bold">Note:</emphasis>
1641 Specifying an <muttng-doc:varref name="alias_file" link="alias-file"/>
1642 does not add the aliases specified there-in, you must also <link linkend="source">source</link>
1647 <muttng-doc:funcdef name="check-traditional-pgp" key="ESC P"/>
1651 This function will search the current message for content signed or
1652 encrypted with PGP the "traditional" way, that is, without proper
1653 MIME tagging. Technically, this function will temporarily change
1654 the MIME content types of the body parts containing PGP data; this
1655 is similar to the <muttng-doc:funcref name="edit-type"/>
1661 <muttng-doc:funcdef name="display-toggle-weed" key="h"/>
1665 Toggles the weeding of message header fields specified by <link linkend="ignore">ignore</link>
1670 <muttng-doc:funcdef name="edit" key="e"/>
1674 This command (available in the ``index'' and ``pager'') allows you to
1675 edit the raw current message as it's present in the mail folder.
1676 After you have finished editing, the changed message will be
1677 appended to the current folder, and the original message will be
1678 marked for deletion.
1682 <muttng-doc:funcdef name="edit-type"/>
1683 (default: <literal>^E</literal> on the attachment menu, and in the pager and index
1684 menus; <literal>^T</literal> on the compose menu)
1688 This command is used to temporarily edit an attachment's content
1689 type to fix, for instance, bogus character set parameters. When
1690 invoked from the index or from the pager, you'll have the
1691 opportunity to edit the top-level attachment's content type. On the
1692 <link linkend="attach-menu">attach-menu</link>, you can change any
1693 attachment's content type. These changes are not persistent, and get
1694 lost upon changing folders.
1698 Note that this command is also available on the <link linkend="compose-menu">compose-menu</link>
1699 .There, it's used to
1700 fine-tune the properties of attachments you are going to send.
1704 <muttng-doc:funcdef name="enter-command" key=":"/>
1708 This command is used to execute any command you would normally put in
1710 configuration file. A common use is to check the settings of
1712 in conjunction with <link linkend="macro">macro</link> to change
1718 <muttng-doc:funcdef name="extract-keys" key="^K"/>
1722 This command extracts PGP public keys from the current or tagged
1723 message(s) and adds them to your PGP public key ring.
1727 <muttng-doc:funcdef name="forget-passphrase" key="^F"/>
1731 This command wipes the passphrase(s) from memory. It is useful, if
1732 you misspelled the passphrase.
1736 <muttng-doc:funcdef name="list-reply" key="L"/>
1740 Reply to the current or tagged message(s) by extracting any addresses
1742 match the regular expressions given by the <link linkend="lists">lists</link>
1743 commands, but also honor any <literal>Mail-Followup-To</literal>
1745 <muttng-doc:varref name="honor_followup_to" link="honor-followup-to"/>
1746 configuration variable is set. Using this when replying to messages
1748 to mailing lists helps avoid duplicate copies being sent to the
1750 the message you are replying to.
1754 <muttng-doc:funcdef name="pipe-message" default="|"/>
1758 Asks for an external Unix command and pipes the current or
1759 tagged message(s) to it. The variables
1760 <muttng-doc:varref name="pipe_decode" link="honor-followup-to"/>,
1761 <muttng-doc:varref name="pipe_split" link="pipe-split"/>,
1762 <muttng-doc:varref name="pipe_decode" link="pipe-decode"/> and
1763 <muttng-doc:varref name="wait_key" link="wait-key"/>
1764 control the exact behavior of this function.
1768 <muttng-doc:funcdef name="resend-message" key="ESC e"/>
1772 With resend-message, mutt takes the current message as a template for
1774 new message. This function is best described as "recall from
1776 folders". It can conveniently be used to forward MIME messages while
1777 preserving the original mail structure. Note that the amount of
1779 included here depends on the value of the <muttng-doc:varref name="weed"/>
1784 This function is also available from the attachment menu. You can use
1786 to easily resend a message which was included with a bounce message
1787 as a message/rfc822 body part.
1791 <muttng-doc:funcdef name="shell-escape" key="!"/>
1795 Asks for an external Unix command and executes it. The
1796 <muttng-doc:varref name="wait_key" link="wait-key"/>
1797 can be used to control
1798 whether Mutt-ng will wait for a key to be pressed when the command
1800 (presumably to let the user read the output of the command), based on
1801 the return status of the named command.
1805 <muttng-doc:funcdef name="toggle-quoted" key="T"/>
1809 The <emphasis>pager</emphasis> uses the
1810 <muttng-doc:varref name="quote_regexp" link="quote-regexp"/>
1811 variable to detect quoted text when
1812 displaying the body of the message. This function toggles the
1813 displayof the quoted material in the message. It is particularly
1815 are interested in just the response and there is a large amount of
1816 quoted text in the way.
1820 <muttng-doc:funcdef name="skip-quoted" key="S"/>
1824 This function will go to the next line of non-quoted text which come
1825 after a line of quoted text in the internal pager.
1837 <sect1 id="sending"> <!--{{{-->
1838 <title>Sending Mail</title>
1841 The following bindings are available in the <emphasis>index</emphasis>
1849 <title>Most commonly used Mail Composition Bindings</title>
1850 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1854 <entry>Function</entry>
1855 <entry>Description</entry>
1860 <entry><literal>m</literal></entry>
1861 <entry><muttng-doc:funcref name="compose"/></entry>
1862 <entry>compose a new message</entry>
1865 <entry><literal>r</literal></entry>
1866 <entry><muttng-doc:funcref name="reply"/></entry>
1867 <entry>reply to sender</entry>
1870 <entry><literal>g</literal></entry>
1871 <entry><muttng-doc:funcref name="group-reply"/></entry>
1872 <entry>reply to all recipients</entry>
1875 <entry><literal>L</literal></entry>
1876 <entry><muttng-doc:funcref name="list-reply"/></entry>
1877 <entry>reply to mailing list address</entry>
1880 <entry><literal>f</literal></entry>
1881 <entry><muttng-doc:funcref name="forward"/></entry>
1882 <entry>forward message</entry>
1885 <entry><literal>b</literal></entry>
1886 <entry><muttng-doc:funcref name="bounce"/></entry>
1887 <entry>bounce (remail) message</entry>
1890 <entry><literal>ESC k </literal></entry>
1891 <entry><muttng-doc:funcref name="mail-key"/></entry>
1892 <entry>mail a PGP public key to someone</entry>
1901 Bouncing a message sends the message as is to the recipient you
1902 specify. Forwarding a message allows you to add comments or
1903 modify the message you are forwarding. These items are discussed
1904 in greater detail in the next chapter <link linkend="forwarding-mail">forwarding-mail</link>.
1907 <sect2 id="sending-compose">
1908 <title>Composing new messages</title>
1911 When you want to send an email using mutt-ng, simply press <literal>m</literal> on
1912 your keyboard. Then, mutt-ng asks for the recipient via a prompt in
1924 After you've finished entering the recipient(s), press return. If you
1925 want to send an email to more than one recipient, separate the email
1926 addresses using the comma "<literal>,</literal>". Mutt-ng then asks
1928 subject. Again, press return after you've entered it. After that,
1930 got the most important information from you, and starts up an editor
1931 where you can then enter your email.
1935 The editor that is called is selected in the following way: you
1936 can e.g. set it in the mutt-ng configuration:
1942 set editor = "vim +/^$/ -c ':set tw=72'"
1944 set editor = "emacs"</screen>
1949 If you don't set your preferred editor in your configuration, mutt-ng
1950 first looks whether the environment variable <muttng-doc:envvar name="VISUAL"/> is set, and if
1951 so, it takes its value as editor command. Otherwise, it has a look
1952 at <muttng-doc:envvar name="EDITOR"/> and takes its value if it is set. If no
1954 can be found, mutt-ng simply assumes <muttng-doc:man name="vi"/> to be the
1956 since it's the most widespread editor in the Unix world and it's
1958 safe to assume that it is installed and available.
1962 When you've finished entering your message, save it and quit your
1963 editor. Mutt-ng will then present you with a summary screen, the
1965 On the top, you see a summary of the most important available key
1967 Below that, you see the sender, the recipient(s), Cc and/or Bcc
1968 recipient(s), the subject, the reply-to address, and optionally
1969 information where the sent email will be stored and whether it should
1970 be digitally signed and/or encrypted.
1974 Below that, you see a list of "attachments". The mail you've just
1975 entered before is also an attachment, but due to its special type
1976 (it's plain text), it will be displayed as the normal message on
1977 the receiver's side.
1981 At this point, you can add more attachments, pressing <literal>a</literal>, you
1982 can edit the recipient addresses, pressing <literal>t</literal> for
1984 <literal>c</literal> for the "Cc:" field, and <literal>b</literal>
1985 for the "Bcc: field. You can
1986 also edit the subject the subject by simply pressing <literal>s</literal> or the
1987 email message that you've entered before by pressing <literal>e</literal>. You will
1988 then again return to the editor. You can even edit the sender, by
1990 <literal><esc>f</literal>, but this shall only be used with
1995 Alternatively, you can configure mutt-ng in a way that most of the
1996 above settings can be edited using the editor. Therefore, you only
1997 need to add the following to your configuration:
2003 set edit_headers</screen>
2008 Once you have finished editing the body of your mail message, you are
2009 returned to the <emphasis>compose</emphasis> menu. The following
2010 options are available:
2016 <title>Most commonly used Compose Menu Bindings</title>
2017 <tgroup cols="3" align="left" colsep="1" rowsep="1">
2021 <entry>Function</entry>
2022 <entry>Description</entry>
2027 <entry><literal>a</literal></entry>
2028 <entry><muttng-doc:funcref name="attach-file"/></entry>
2029 <entry>attach a file</entry>
2032 <entry><literal>A</literal></entry>
2033 <entry><muttng-doc:funcref name="attach-message"/></entry>
2034 <entry>attach message(s) to the message</entry>
2037 <entry><literal>ESC k </literal></entry>
2038 <entry><muttng-doc:funcref name="attach-key"/></entry>
2039 <entry>attach a PGP public key</entry>
2042 <entry><literal>d</literal></entry>
2043 <entry><muttng-doc:funcref name="edit-description"/></entry>
2044 <entry>edit description on attachment</entry>
2047 <entry><literal>D</literal></entry>
2048 <entry><muttng-doc:funcref name="detach-file"/></entry>
2049 <entry>detach a file</entry>
2052 <entry><literal>t</literal></entry>
2053 <entry><muttng-doc:funcref name="edit-to"/></entry>
2054 <entry>edit the To field</entry>
2057 <entry><literal>ESC f </literal></entry>
2058 <entry><muttng-doc:funcref name="edit-from"/></entry>
2059 <entry>edit the From field</entry>
2062 <entry><literal>r</literal></entry>
2063 <entry><muttng-doc:funcref name="edit-reply-to"/></entry>
2064 <entry>edit the Reply-To field</entry>
2067 <entry><literal>c</literal></entry>
2068 <entry><muttng-doc:funcref name="edit-cc"/></entry>
2069 <entry>edit the Cc field</entry>
2072 <entry><literal>b</literal></entry>
2073 <entry><muttng-doc:funcref name="edit-bcc"/></entry>
2074 <entry>edit the Bcc field</entry>
2077 <entry><literal>y</literal></entry>
2078 <entry><muttng-doc:funcref name="send-message"/></entry>
2079 <entry>send the message</entry>
2082 <entry><literal>s</literal></entry>
2083 <entry><muttng-doc:funcref name="edit-subject"/></entry>
2084 <entry>edit the Subject</entry>
2087 <entry><literal>S</literal></entry>
2088 <entry><muttng-doc:funcref name="smime-menu"/></entry>
2089 <entry>select S/MIME options</entry>
2092 <entry><literal>f</literal></entry>
2093 <entry><muttng-doc:funcref name="edit-fcc"/></entry>
2094 <entry>specify an ``Fcc'' mailbox</entry>
2097 <entry><literal>p</literal></entry>
2098 <entry><muttng-doc:funcref name="pgp-menu"/></entry>
2099 <entry>select PGP options</entry>
2102 <entry><literal>P</literal></entry>
2103 <entry><muttng-doc:funcref name="postpone-message"/></entry>
2104 <entry>postpone this message until later</entry>
2107 <entry><literal>q</literal></entry>
2108 <entry><muttng-doc:funcref name="quit"/></entry>
2109 <entry>quit (abort) sending the message</entry>
2112 <entry><literal>w</literal></entry>
2113 <entry><muttng-doc:funcref name="write-fcc"/></entry>
2114 <entry>write the message to a folder</entry>
2117 <entry><literal>i</literal></entry>
2118 <entry><muttng-doc:funcref name="ispell"/></entry>
2119 <entry>check spelling (if available on your system)</entry>
2122 <entry><literal>^F</literal></entry>
2123 <entry><muttng-doc:funcref name="forget-passphrase"/></entry>
2124 <entry>wipe passphrase(s) from memory</entry>
2133 <emphasis role="bold">Note:</emphasis> The attach-message function
2134 will prompt you for a folder to
2135 attach messages from. You can now tag messages in that folder and
2136 theywill be attached to the message you are sending. Note that
2137 certainoperations like composing a new mail, replying, forwarding,
2139 not permitted when you are in that folder. The <literal>%r</literal>
2140 in <muttng-doc:varref name="status_format" link="status-format"/>
2142 a 'A' to indicate that you are in attach-message mode.
2151 <sect2 id="sending-reply">
2152 <title>Replying</title>
2154 <sect3 id="sending-simple-reply">
2155 <title>Simple Replies</title>
2158 When you want to reply to an email message, select it in the index
2159 menu and then press <literal>r</literal>. Mutt-ng's behaviour is
2161 behaviour when you compose a message: first, you will be asked for
2162 the recipient, then for the subject, and then, mutt-ng will start
2163 the editor with the quote attribution and the quoted message. This
2164 can e.g. look like the example below.
2170 On Mon, Mar 07, 2005 at 05:02:12PM +0100, Michael Svensson wrote:
2171 > Bill, can you please send last month's progress report to Mr.
2172 > Morgan? We also urgently need the cost estimation for the new
2173 > production server that we want to set up before our customer's
2174 > project will go live.</screen>
2179 You can start editing the email message. It is strongly
2180 recommended to put your answer <emphasis>below</emphasis> the
2182 only quote what is really necessary and that you refer to. Putting
2183 your answer on top of the quoted message, is, although very
2184 widespread, very often not considered to be a polite way to answer
2189 The quote attribution is configurable, by default it is set to
2192 set attribution = "On %d, %n wrote:"</screen>
2197 It can also be set to something more compact, e.g.
2200 set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"</screen>
2205 The example above results in the following attribution:
2208 * Michael Svensson <svensson@foobar.com> [05-03-06 17:02]:
2209 > Bill, can you please send last month's progress report to Mr.
2210 > Morgan? We also urgently need the cost estimation for the new
2211 > production server that we want to set up before our customer's
2212 > project will go live.</screen>
2217 Generally, try to keep your attribution short yet
2218 information-rich. It is <emphasis>not</emphasis> the right place
2220 long "attribution" novels or anything like that: the right place
2221 for such things is - if at all - the email signature at the very
2222 bottom of the message.
2226 When you're done with writing your message, save and quit the
2227 editor. As before, you will return to the compose menu, which is
2228 used in the same way as before.
2237 <sect3 id="sending-group-reply">
2238 <title>Group Replies</title>
2241 In the situation where a group of people uses email as a
2242 discussion, most of the emails will have one or more recipients,
2243 and probably several "Cc:" recipients. The group reply
2244 functionalityensures that when you press <literal>g</literal>
2245 instead of <literal>r</literal> to do a reply,
2246 each and every recipient that is contained in the original message
2247 will receive a copy of the message, either as normal recipient or
2257 <sect3 id="sending-list-reply">
2258 <title>List Replies</title>
2261 When you use mailing lists, it's generally better to send your
2262 reply to a message only to the list instead of the list and the
2263 original author. To make this easy to use, mutt-ng features list
2268 To do a list reply, simply press <literal>L</literal>. If the email
2270 a <literal>Mail-Followup-To:</literal> header, its value will be
2272 address. Otherwise, mutt-ng searches through all mail addresses in
2273 the original message and tries to match them a list of regular
2274 expressions which can be specified using the <literal>lists</literal> command.
2275 If any of the regular expression matches, a mailing
2276 list address has been found, and it will be used as reply address.
2282 lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@</screen>
2287 Nowadays, most mailing list software like GNU Mailman adds a
2288 <literal>Mail-Followup-To:</literal> header to their emails anyway,
2290 <literal>lists</literal> is hardly ever necessary in practice.
2305 <sect2 id="sending-edit-header">
2306 <title>Editing the message header</title>
2309 When editing the header of your outgoing message, there are a couple
2311 special features available.
2317 <literal>Fcc:</literal> <emphasis>filename</emphasis>
2319 Mutt-ng will pick up <emphasis>filename</emphasis>
2320 just as if you had used the <emphasis>edit-fcc</emphasis> function in
2321 the <emphasis>compose</emphasis> menu.
2325 You can also attach files to your message by specifying
2328 Attach: filename [description]</screen>
2330 where <emphasis>filename</emphasis> is the file to attach and <emphasis>
2334 optional string to use as the description of the attached file.
2338 When replying to messages, if you remove the <emphasis>In-Reply-To:</emphasis> field from
2339 the header field, Mutt-ng will not generate a <emphasis>References:</emphasis> field, which
2340 allows you to create a new message thread.
2344 Also see the <muttng-doc:varref name="edit_headers" link="edit-headers"/> and
2345 <muttng-doc:varref name="editor_headers" link="editor-headers"/> variables
2354 <sect2 id="sending-crypto">
2355 <title>Using Mutt-ng with PGP</title>
2358 If you want to use PGP, you can specify
2361 Pgp: [E | S | S id]</screen>
2363 ``E'' encrypts, ``S'' signs and
2364 ``S<id>'' signs with the given key, setting
2365 <muttng-doc:varref name="pgp_sign_as" link="pgp-sign-as"/>
2370 If you have told mutt to PGP encrypt a message, it will guide you
2371 through a key selection process when you try to send the message.
2372 Mutt-ng will not ask you any questions about keys which have a
2373 certified user ID matching one of the message recipients' mail
2374 addresses. However, there may be situations in which there are
2375 several keys, weakly certified user ID fields, or where no matching
2380 In these cases, you are dropped into a menu with a list of keys from
2381 which you can select one. When you quit this menu, or mutt can't
2382 find any matching keys, you are prompted for a user ID. You can, as
2383 usually, abort this prompt using <literal>^G</literal>. When
2384 you do so, mutt will
2385 return to the compose screen.
2389 Once you have successfully finished the key selection, the message
2390 will be encrypted using the selected public keys, and sent out.
2394 Most fields of the entries in the key selection menu (see also
2395 <muttng-doc:varref name="pgp_entry_format" link="pgp-entry-format"/>)
2396 have obvious meanings. But some explanations on the capabilities,
2398 and validity fields are in order.
2402 The flags sequence (%f) will expand to one of the following
2407 <title>PGP Key Menu Flags</title>
2408 <tgroup cols="2" align="left" colsep="1" rowsep="1">
2412 <entry>Description</entry>
2417 <entry><literal>R</literal></entry>
2418 <entry>The key has been revoked and can't be used.</entry>
2421 <entry><literal>X</literal></entry>
2422 <entry>The key is expired and can't be used.</entry>
2425 <entry><literal>d</literal></entry>
2426 <entry>You have marked the key as disabled.</entry>
2429 <entry><literal>c</literal></entry>
2430 <entry>There are unknown critical self-signature packets.</entry>
2439 The capabilities field (%c) expands to a two-character
2440 sequencerepresenting a key's capabilities. The first character gives
2441 the key's encryption capabilities: A minus sign (<emphasis role="bold">
2445 that the key cannot be used for encryption. A dot (<emphasis role="bold">
2449 it's marked as a signature key in one of the user IDs, but may
2450 also be used for encryption. The letter <emphasis role="bold">e</emphasis> indicates that
2451 this key can be used for encryption.
2455 The second character indicates the key's signing capabilities. Once
2456 again, a ``<emphasis role="bold">-</emphasis>'' implies ``not for
2457 signing'', ``<emphasis role="bold">.</emphasis>'' implies
2458 that the key is marked as an encryption key in one of the user-ids,
2460 ``<emphasis role="bold">s</emphasis>'' denotes a key which can be
2465 Finally, the validity field (%t) indicates how well-certified
2467 is. A question mark (<emphasis role="bold">?</emphasis>) indicates
2468 undefined validity, a minus
2469 character (<emphasis role="bold">-</emphasis>) marks an untrusted
2470 association, a space character
2471 means a partially trusted association, and a plus character (<emphasis role="bold">
2475 indicates complete validity.
2484 <sect2 id="sending-mixmaster">
2485 <title>Sending anonymous messages via mixmaster</title>
2488 You may also have configured mutt to co-operate with Mixmaster, an
2489 anonymous remailer. Mixmaster permits you to send your messages
2490 anonymously using a chain of remailers. Mixmaster support in mutt is
2492 mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
2493 It does not support earlier versions or the later so-called version 3
2495 of which the latest appears to be called 2.9b23.
2499 To use it, you'll have to obey certain restrictions. Most
2500 important, you cannot use the <literal>Cc</literal> and <literal>Bcc</literal> headers. To tell
2501 Mutt-ng to use mixmaster, you have to select a remailer chain, using
2502 the mix function on the compose menu.
2506 The chain selection screen is divided into two parts. In the
2507 (larger) upper part, you get a list of remailers you may use. In
2508 the lower part, you see the currently selected chain of remailers.
2512 You can navigate in the chain using the <literal>chain-prev</literal>
2514 <literal>chain-next</literal> functions, which are by default bound
2516 and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi
2517 keyboard bindings). To insert a remailer at the current chain
2518 position, use the <literal>insert</literal> function. To append a
2520 the current chain position, use <literal>select-entry</literal> or <literal>
2524 You can also delete entries from the chain, using the corresponding
2525 function. Finally, to abandon your changes, leave the menu, or
2526 <literal>accept</literal> them pressing (by default) the <literal>
2533 Note that different remailers do have different capabilities,
2534 indicated in the <literal>%c</literal> entry of the remailer menu lines (see
2535 <muttng-doc:varref name="mix_entry_format" link="mix-entry-format"/>).
2537 the ``middleman'' capability, indicated by a capital ``M'': This
2538 means that the remailer in question cannot be used as the final
2539 element of a chain, but will only forward messages to other
2540 mixmaster remailers. For details on the other capabilities, please
2541 have a look at the mixmaster documentation.
2556 <sect1 id="forwarding-mail">
2557 <title>Forwarding and Bouncing Mail</title>
2560 Often, it is necessary to forward mails to other people.
2561 Therefore, mutt-ng supports forwarding messages in two different
2566 The first one is regular forwarding, as you probably know it from
2567 other mail clients. You simply press <literal>f</literal>, enter the
2569 email address, the subject of the forwarded email, and then you can
2570 edit the message to be forwarded in the editor. The forwarded
2571 message is separated from the rest of the message via the two
2578 ----- Forwarded message from Lucas User <luser@example.com> -----
2580 From: Lucas User <luser@example.com>
2581 Date: Thu, 02 Dec 2004 03:08:34 +0100
2582 To: Michael Random <mrandom@example.com>
2583 Subject: Re: blackmail
2585 Pay me EUR 50,000.- cash or your favorite stuffed animal will die
2588 ----- End forwarded message -----</screen>
2593 When you're done with editing the mail, save and quit the editor,
2594 and you will return to the compose menu, the same menu you also
2595 encounter when composing or replying to mails.
2599 The second mode of forwarding emails with mutt-ng is the
2600 so-called <emphasis>bouncing</emphasis>: when you bounce an email to
2602 address, it will be sent in practically the same format you send it
2603 (except for headers that are created during transporting the
2604 message). To bounce a message, press <literal>b</literal> and enter the
2606 email address. By default, you are then asked whether you really
2607 want to bounce the message to the specified recipient. If you answer
2608 with yes, the message will then be bounced.
2612 To the recipient, the bounced email will look as if he got it
2613 like a regular email where he was <literal>Bcc:</literal> recipient.
2615 possibility to find out whether it was a bounced email is to
2616 carefully study the email headers and to find out which host really
2626 <sect1 id="postponing-mail">
2627 <title>Postponing Mail</title>
2630 At times it is desirable to delay sending a message that you have
2631 already begun to compose. When the <emphasis>postpone-message</emphasis> function is
2632 used in the <emphasis>compose</emphasis> menu, the body of your message
2634 are stored in the mailbox specified by the
2635 <muttng-doc:varref name="postponed"/> variable. This means that you can recall the
2636 message even if you exit Mutt-ng and then restart it at a later time.
2640 Once a message is postponed, there are several ways to resume it. From
2642 command line you can use the ``-p'' option, or if you <emphasis>compose</emphasis> a new
2643 message from the <emphasis>index</emphasis> or <emphasis>pager</emphasis> you will be prompted if postponed
2644 messages exist. If multiple messages are currently postponed, the
2645 <emphasis>postponed</emphasis> menu will pop up and you can select
2646 which message you would
2651 <emphasis role="bold">Note:</emphasis> If you postpone a reply to a
2652 message, the reply setting of
2653 the message is only updated when you actually finish the message and
2654 send it. Also, you must be in the same folder with the message you
2655 replied to for the status of the message to be updated.
2659 See also the <muttng-doc:varref name="postpone"/> quad-option.
2677 <chapter id="configuration"> <!--{{{-->
2678 <title>Configuration</title>
2680 <sect1 id="configuration-files">
2681 <title>Locations of Configuration Files</title>
2684 While the default configuration (or ``preferences'') make Mutt-ng
2686 of the box, it is often desirable to tailor Mutt-ng to suit your own
2688 Mutt-ng is first invoked, it will attempt to read the ``system''
2690 file (defaults set by your local system administrator), unless the
2691 ``-n'' <link linkend="commandline">commandline</link> option is
2692 specified. This file is
2693 typically <literal>/usr/local/share/muttng/Muttngrc</literal> or <literal>
2697 Mutt-ng users will find this file in <literal>
2698 /usr/local/share/muttng/Muttrc
2701 <literal>/etc/Muttngrc</literal>. Mutt will next look for a file named <literal>
2704 in your home directory, Mutt-ng will look for <literal>.muttngrc</literal>. If this file
2705 does not exist and your home directory has a subdirectory named <literal>
2709 mutt try to load a file named <literal>.muttng/muttngrc</literal>.
2713 <literal>.muttrc</literal> (or <literal>.muttngrc</literal> for
2714 Mutt-ng) is the file where you will
2715 usually place your <link linkend="commands">commands</link> to
2725 <sect1 id="configuration-syntax">
2726 <title>Basic Syntax of Initialization Files</title>
2729 An initialization file consists of a series of <link linkend="commands">commands</link>. Each line of the file may contain one or more commands.
2730 When multiple commands are used, they must be separated by a semicolon
2734 set realname='Mutt-ng user' ; ignore x-</screen>
2736 The hash mark, or pound sign
2737 (``#''), is used as a ``comment'' character. You can use it to
2738 annotate your initialization file. All text after the comment character
2739 to the end of the line is ignored. For example,
2745 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</screen>
2750 Single quotes (') and double quotes (") can be used to quote
2752 which contain spaces or other special characters. The difference
2754 the two types of quotes is similar to that of many popular shell
2756 namely that a single quote is used to specify a literal string (one
2758 not interpreted for shell variables or quoting with a backslash
2760 next paragraph), while double quotes indicate a string for which
2761 should be evaluated. For example, backtics are evaluated inside of
2763 quotes, but <emphasis role="bold">not</emphasis> for single quotes.
2767 \ quotes the next character, just as in shells such as bash and
2769 For example, if want to put quotes ``"'' inside of a string, you
2771 ``\'' to force the next character to be a literal instead of
2776 set realname="Michael \"MuttDude\" Elkins"</screen>
2781 ``\\'' means to insert a literal ``\'' into the line.
2782 ``\n'' and ``\r'' have their usual C meanings of linefeed and
2783 carriage-return, respectively.
2787 A \ at the end of a line can be used to split commands over
2788 multiple lines, provided that the split points don't appear in the
2789 middle of command names.
2793 Please note that, unlike the various shells, mutt-ng interprets a
2795 at the end of a line also in comments. This allows you to disable a
2797 split over multiple lines with only one ``#''.
2804 set realname="Michael \"MuttDude\" Elkins"</screen>
2809 When testing your config files, beware the following caveat. The
2811 at the end of the commented line extends the current line with the next
2813 - then referred to as a ``continuation line''. As the first line is
2814 commented with a hash (#) all following continuation lines are also
2815 part of a comment and therefore are ignored, too. So take care of
2817 when continuation lines are involved within your setup files!
2836 line1 ``continues'' until line4. however, the part after the # is a
2837 comment which includes line3 and line4. line5 is a new line of its own
2839 thus is interpreted again.
2843 The commands understood by mutt are explained in the next paragraphs.
2844 For a complete list, see the <link linkend="commands">commands</link>.
2853 <sect1 id="configuration-expansion">
2854 <title>Expansion within variables</title>
2857 Besides just assign static content to variables, there's plenty of
2858 ways of adding external and more or less dynamic content.
2861 <sect2 id="configuration-expansion-commands">
2862 <title>Commands' Output</title>
2865 It is possible to substitute the output of a Unix command in an
2866 initialization file. This is accomplished by enclosing the command
2867 in backquotes (``) as in, for example:
2873 my_hdr X-Operating-System: `uname -a`</screen>
2878 The output of the Unix command ``uname -a'' will be substituted
2879 before the line is parsed. Note that since initialization files are
2880 line oriented, only the first line of output from the Unix command
2881 will be substituted.
2886 <sect2 id="configuration-expansion-environment">
2887 <title>Environment Variables</title>
2890 UNIX environments can be accessed like the way it is done in
2891 shells like sh and bash: Prepend the name of the environment by a
2892 ``$'' sign. For example,
2898 set record=+sent_on_$HOSTNAME</screen>
2903 sets the <muttng-doc:varref name="record"/> variable to the
2904 string <emphasis>+sent_on_</emphasis> and appends the
2905 value of the evironment
2906 variable <muttng-doc:envvar name="HOSTNAME"/>.
2910 <emphasis role="bold">Note:</emphasis> There will be no warning if an
2911 environment variable
2912 is not defined. The result will of the expansion will then be empty.
2917 <sect2 id="configuration-expansion-config">
2918 <title>Configuration Variables</title>
2921 As for environment variables, the values of all configuration
2922 variables as string can be used in the same way, too. For example,
2928 set imap_home_namespace = $folder</screen>
2933 would set the value of <muttng-doc:varref name="imap_home_namespace" link="imap-home-namespace"/>
2934 to the value to which <muttng-doc:varref name="folder"/>
2935 is <emphasis>currently</emphasis> set to.
2939 <emphasis role="bold">Note:</emphasis> There're no logical links
2940 established in such cases so
2941 that the the value for <muttng-doc:varref name="imap_home_namespace" link="imap-home-namespace"/>
2943 if <muttng-doc:varref name="folder"/> gets changed.
2947 <emphasis role="bold">Note:</emphasis> There will be no warning if a
2948 configuration variable
2949 is not defined or is empty. The result will of the expansion will
2955 <sect2 id="configuration-expansion-self">
2956 <title>Self-Defined Variables</title>
2959 Mutt-ng flexibly allows users to define their own variables. To
2960 avoid conflicts with the standard set and to prevent misleading
2961 error messages, there's a reserved namespace for them: all
2962 user-defined variables must be prefixed with <literal>user_</literal> and can be
2963 used just like any ordinary configuration or environment
2968 For example, to view the manual, users can either define two
2969 macros like the following
2975 macro generic <F1> "!less -r /path/to/manual" "Show manual"
2976 macro pager <F1> "!less -r /path/to/manual" "Show manual"</screen>
2981 for <literal>generic</literal>, <literal>pager</literal> and <literal>
2984 .The alternative is to
2985 define a custom variable like so:
2991 set user_manualcmd = "!less -r /path/to_manual"
2992 macro generic <F1> "$user_manualcmd<enter>" "Show manual"
2993 macro pager <F1> "$user_manualcmd<enter>" "Show manual"
2994 macro index <F1> "$user_manualcmd<enter>" "Show manual"</screen>
2999 to re-use the command sequence as in:
3005 macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</screen>
3010 Using this feature, arbitrary sequences can be defined once and
3011 recalled and reused where necessary. More advanced scenarios could
3012 include to save a variable's value at the beginning of macro
3013 sequence and restore it at end.
3017 When the variable is first defined, the first value it gets
3018 assigned is also the initial value to which it can be reset using
3019 the <literal>reset</literal> command.
3023 The complete removal is done via the <literal>unset</literal>
3028 After the following sequence:
3035 set user_foo = 666</screen>
3040 the variable <literal>$user_foo</literal> has a current value
3042 initial of 42. The query
3048 set ?user_foo</screen>
3053 will show 666. After doing the reset via
3059 reset user_foo</screen>
3064 a following query will give 42 as the result. After unsetting it
3071 unset user_foo</screen>
3076 any query or operation (except the noted expansion within other
3077 statements) will lead to an error message.
3082 <sect2 id="configuration-expansion-predef">
3083 <title>Pre-Defined Variables</title>
3086 In order to allow users to share one setup over a number of
3087 different machines without having to change its contents, there's a
3088 number of pre-defined variables. These are prefixed with
3089 <literal>muttng_</literal> and are read-only, i.e. they cannot
3091 reset. The reference chapter lists all available variables.
3095 <emphasis> Please consult the local copy of your manual for their
3096 values as they may differ from different manual sources.
3099 the manual is installed in can be queried (already using such a
3100 variable) by running:
3106 muttng -Q muttng_docdir</screen>
3111 To extend the example for viewing the manual via self-defined
3112 variables, it can be made more readable and more portable by
3113 changing the real path in:
3119 set user_manualcmd = '!less -r /path/to_manual'</screen>
3130 set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</screen>
3135 which works everywhere if a manual is installed.
3139 Please note that by the type of quoting, muttng determines when
3140 to expand these values: when it finds double quotes, the value will
3141 be expanded during reading the setup files but when it finds single
3142 quotes, it'll expand it at runtime as needed.
3146 For example, the statement
3152 folder-hook . "set user_current_folder = $muttng_folder_name"</screen>
3157 will be already be translated to the following when reading the
3164 folder-hook . "set user_current_folder = some_folder"</screen>
3169 with <literal>some_folder</literal> being the name of the
3171 opens. On the contrary,
3177 folder-hook . 'set user_current_folder = $muttng_folder_name'</screen>
3182 will be executed at runtime because of the single quotes so that
3183 <literal>user_current_folder</literal> will always have
3184 the value of the currently
3189 A more practical example is:
3195 folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</screen>
3200 which can be used to source files containing score commands
3201 depending on the folder the user enters.
3206 <sect2 id="configuration-expansion-typeconv">
3207 <title>Type Conversions</title>
3210 A note about variable's types during conversion: internally
3211 values are stored in internal types but for any dump/query or set
3212 operation they're converted to and from string. That means that
3213 there's no need to worry about types when referencing any variable.
3214 As an example, the following can be used without harm (besides
3215 makeing muttng very likely behave strange):
3222 set folder = $read_inc
3223 set read_inc = $folder
3224 set user_magic_number = 42
3225 set folder = $user_magic_number</screen>
3234 <title>Defining/Using aliases</title>
3238 Usage: <literal>alias</literal> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>,...]
3243 It's usually very cumbersome to remember or type out the address of
3245 you are communicating with. Mutt-ng allows you to create ``aliases''
3247 a short string to a full address.
3251 <emphasis role="bold">Note:</emphasis> if you want to create an alias
3252 for a group (by specifying more than
3253 one address), you <emphasis role="bold">must</emphasis> separate the
3254 addresses with a comma (``,'').
3258 To remove an alias or aliases (``*'' means all aliases):
3262 <literal>unalias</literal> [* | <emphasis>key</emphasis> <emphasis>...</emphasis>]
3268 alias muttdude me@cs.hmc.edu (Michael Elkins)
3269 alias theguys manny, moe, jack</screen>
3274 Unlike other mailers, Mutt-ng doesn't require aliases to be defined
3275 in a special file. The <literal>alias</literal> command can appear
3277 a configuration file, as long as this file is <link linkend="source">source</link>.
3278 Consequently, you can have multiple alias files, or
3279 you can have all aliases defined in your muttrc.
3283 On the other hand, the <muttng-doc:funcref name="create-alias"/>
3284 function can use only one file, the one pointed to by the
3285 <muttng-doc:varref name="alias_file" link="alias-file"/>
3287 <literal>~/.muttrc</literal> by default). This file is not
3289 in the sense that Mutt-ng will happily append aliases to any file, but
3291 order for the new aliases to take effect you need to explicitly <link linkend="source">source</link>
3302 source /usr/local/share/Mutt-ng.aliases
3303 source ~/.mail_aliases
3304 set alias_file=~/.mail_aliases</screen>
3309 To use aliases, you merely use the alias at any place in mutt where
3310 muttprompts for addresses, such as the <emphasis>To:</emphasis> or <emphasis>
3314 also enter aliases in your editor at the appropriate headers if you
3316 <muttng-doc:varref name="editor_headers" link="edit-headers"/>
3321 In addition, at the various address prompts, you can use the tab
3323 to expand a partial alias to the full alias. If there are multiple
3325 mutt will bring up a menu with the matching aliases. In order to be
3326 presented with the full list of aliases, you must hit tab with out a
3328 alias, such as at the beginning of the prompt or after a comma denoting
3333 In the alias menu, you can select as many aliases as you want with the
3334 <emphasis>select-entry</emphasis> key (default: RET), and use the <emphasis>
3338 (default: q) to return to the address prompt.
3348 <title>Changing the default key bindings</title>
3352 Usage: <literal>bind</literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
3357 This command allows you to change the default key bindings (operation
3358 invoked when pressing a key).
3362 <emphasis>map</emphasis> specifies in which menu the binding belongs.
3364 be specified by separating them with commas (no additional whitespace
3365 isallowed). The currently defined maps are:
3373 <term>generic</term>
3376 This is not a real menu, but is used as a fallback for all of
3378 menus except for the pager and editor modes. If a key is not
3380 another menu, Mutt-ng will look for a binding to use in this
3382 you to bind a key to a certain function in multiple menus
3384 multiple bind statements to accomplish the same task.
3392 The alias menu is the list of your personal aliases as defined
3394 muttrc. It is the mapping from a short alias name to the full
3396 address(es) of the recipient(s).
3404 The attachment menu is used to access the attachments on
3410 <term>browser</term>
3413 The browser is used for both browsing the local directory
3415 listing all of your incoming mailboxes.
3423 The editor is the line-based editor the user enters text data.
3431 The index is the list of messages contained in a mailbox.
3436 <term>compose</term>
3439 The compose menu is the screen used when sending a new message.
3447 The pager is the mode used to display message/attachment data,
3457 The pgp menu is used to select the OpenPGP keys used for
3464 <term>postpone</term>
3467 The postpone menu is similar to the index menu, except is used
3469 recalling a message the user was composing, but saved until
3478 <emphasis>key</emphasis> is the key (or key sequence) you wish to bind.
3480 control character, use the sequence <emphasis>\Cx</emphasis>,
3481 where <emphasis>x</emphasis> is the
3482 letter of the control character (for example, to specify control-A use
3483 ``\Ca''). Note that the case of <emphasis>x</emphasis> as well as
3484 <emphasis>\C</emphasis> is
3485 ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>
3488 and <emphasis>\ca</emphasis> are all
3489 equivalent. An alternative form is to specify the key as a three digit
3490 octal number prefixed with a ``\'' (for example <emphasis>
3494 equivalent to <emphasis>\c?</emphasis>).
3498 In addition, <emphasis>key</emphasis> may consist of:
3504 <title>Alternative Key Names</title>
3505 <tgroup cols="2" align="left" colsep="1" rowsep="1">
3508 <entry>Sequence</entry>
3509 <entry>Description</entry>
3514 <entry><literal>\t</literal></entry>
3518 <entry><literal><tab></literal></entry>
3522 <entry><literal><backtab></literal></entry>
3523 <entry>backtab / shift-tab</entry>
3526 <entry><literal>\r</literal></entry>
3527 <entry>carriage return</entry>
3530 <entry><literal>\n</literal></entry>
3531 <entry>newline</entry>
3534 <entry><literal>\e</literal></entry>
3535 <entry>escape</entry>
3538 <entry><literal><esc></literal></entry>
3539 <entry>escape</entry>
3542 <entry><literal><up></literal></entry>
3543 <entry>up arrow</entry>
3546 <entry><literal><down></literal></entry>
3547 <entry>down arrow</entry>
3550 <entry><literal><left></literal></entry>
3551 <entry>left arrow</entry>
3554 <entry><literal><right></literal></entry>
3555 <entry>right arrow</entry>
3558 <entry><literal><pageup></literal></entry>
3559 <entry>Page Up</entry>
3562 <entry><literal><pagedown></literal></entry>
3563 <entry>Page Down</entry>
3566 <entry><literal><backspace></literal></entry>
3567 <entry>Backspace</entry>
3570 <entry><literal><delete></literal></entry>
3571 <entry>Delete</entry>
3574 <entry><literal><insert></literal></entry>
3575 <entry>Insert</entry>
3578 <entry><literal><enter></literal></entry>
3579 <entry>Enter</entry>
3582 <entry><literal><return></literal></entry>
3583 <entry>Return</entry>
3586 <entry><literal><home></literal></entry>
3590 <entry><literal><end></literal></entry>
3594 <entry><literal><space></literal></entry>
3595 <entry>Space bar</entry>
3598 <entry><literal><f1></literal></entry>
3599 <entry>function key 1</entry>
3602 <entry><literal><f10></literal></entry>
3603 <entry>function key 10</entry>
3612 <emphasis>key</emphasis> does not need to be enclosed in quotes unless
3618 <emphasis>function</emphasis> specifies which action to take when <emphasis>
3622 For a complete list of functions, see the <link linkend="functions">functions</link>.
3623 The special function <literal>noop</literal> unbinds the specified key
3633 <sect1 id="charset-hook">
3634 <title>Defining aliases for character sets</title>
3638 Usage: <muttng-doc:hook name="charset"/> <emphasis>alias</emphasis> <emphasis> charset</emphasis>
3639 Usage: <muttng-doc:hook name="iconv"/> <emphasis>charset</emphasis> <emphasis> local-charset </emphasis>
3644 The <muttng-doc:hook name="charset"/> command defines an alias for a
3646 This is useful to properly display messages which are tagged with a
3647 character set name not known to mutt.
3651 The <muttng-doc:hook name="iconv"/> command defines a system-specific
3653 character set. This is helpful when your systems character
3654 conversion library insists on using strange, system-specific names
3664 <sect1 id="folder-hook">
3665 <title>Setting variables based upon mailbox</title>
3669 Usage: <muttng-doc:hook name="folder"/> [!]<emphasis>regexp</emphasis> <emphasis>command</emphasis>
3675 It is often desirable to change settings based on which mailbox you are
3676 reading. The <muttng-doc:hook name="folder"/> command provides a method by which you can
3678 any configuration command. <emphasis>regexp</emphasis> is a regular
3679 expression specifying
3680 in which mailboxes to execute <emphasis>command</emphasis> before
3681 loading. If a mailbox
3682 matches multiple <muttng-doc:hook name="folder"/>'s, they are executed in the order given in
3688 <emphasis role="bold">Note:</emphasis> if you use the ``!'' shortcut
3689 for <muttng-doc:varref name="spoolfile"/> at the beginning of the
3690 pattern, you must place it
3691 inside of double or single quotes in order to distinguish it from the
3692 logical <emphasis>not</emphasis> operator for the expression.
3696 Note that the settings are <emphasis>not</emphasis> restored when you
3698 For example, a command action to perform is to change the sorting
3699 methodbased upon the mailbox being read:
3705 folder-hook mutt set sort=threads</screen>
3710 However, the sorting method is not restored to its previous value when
3711 reading a different mailbox. To specify a <emphasis>default</emphasis>
3719 folder-hook . set sort=date-sent</screen>
3730 <title>Keyboard macros</title>
3734 Usage: <literal>macro</literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [<emphasis>description</emphasis>]
3739 Macros are useful when you would like a single key to perform a series
3741 actions. When you press <emphasis>key</emphasis> in menu <emphasis>
3744 ,Mutt-ng will behave as if
3745 you had typed <emphasis>sequence</emphasis>. So if you have a common
3746 sequence of commands
3747 you type, you can create a macro to execute those commands with a
3752 <emphasis>menu</emphasis> is the <link linkend="maps">maps</link> which
3753 the macro will be bound.
3754 Multiple maps may be specified by separating multiple menu arguments by
3755 commas. Whitespace may not be used in between the menu arguments and
3756 thecommas separating them.
3760 <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded
3761 by the same rules as the <link linkend="bind">bind</link>. There are
3762 some additions however. The
3763 first is that control characters in <emphasis>sequence</emphasis> can
3765 as <emphasis>^x</emphasis>. In order to get a caret (`^'')
3767 <emphasis>^^</emphasis>. Secondly, to specify a certain key
3768 such as <emphasis>up</emphasis>
3769 or to invoke a function directly, you can use the format
3770 <emphasis><key name></emphasis> and <emphasis><function
3773 .For a listing of key
3774 names see the section on <link linkend="bind">bind</link>. Functions
3775 are listed in the <link linkend="functions">functions</link>.
3779 The advantage with using function names directly is that the macros
3780 willwork regardless of the current key bindings, so they are not
3782 the user having particular key definitions. This makes them more
3783 robustand portable, and also facilitates defining of macros in files
3785 than one user (eg. the system Muttngrc).
3789 Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>,
3790 which is shown in the help screens.
3794 <emphasis role="bold">Note:</emphasis> Macro definitions (if any)
3795 listed in the help screen(s), are
3796 silently truncated at the screen width, and are not wrapped.
3806 <title>Using color and mono video attributes</title>
3810 Usage: <literal>color</literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis><emphasis>background</emphasis> [<emphasis>regexp</emphasis>]
3811 Usage: <literal>color</literal> index <emphasis>foreground</emphasis> <emphasis>background</emphasis><emphasis>pattern</emphasis>
3812 Usage: <literal>uncolor</literal> index <emphasis>pattern</emphasis>[<emphasis>pattern</emphasis>...]
3817 If your terminal supports color, you can spice up Mutt-ng by creating
3819 color scheme. To define the color of an object (type of information),
3821 must specify both a foreground color <emphasis role="bold">and</emphasis> a background color (it is not
3822 possible to only specify one or the other).
3826 <emphasis>object</emphasis> can be one of:
3841 body (match <emphasis>regexp</emphasis> in the body of messages)
3847 bold (highlighting bold patterns in the body of messages)
3853 error (error messages printed by Mutt-ng)
3859 header (match <emphasis>regexp</emphasis> in the message header)
3865 hdrdefault (default color of the message header in the pager)
3871 index (match <emphasis>pattern</emphasis> in the message index)
3877 indicator (arrow or bar used to indicate the current item in a
3884 markers (the ``+'' markers at the beginning of wrapped lines in
3891 message (informational messages)
3903 quoted (text matching <muttng-doc:varref name="quote_regexp" link="quote-regexp"/> in the body of a message)
3909 quoted1, quoted2, ..., quoted<emphasis role="bold">N</emphasis>
3910 (higher levels of quoting)
3916 search (highlighting of words in the pager)
3928 status (mode lines used to display info about the mailbox or
3935 tilde (the ``~'' used to pad blank lines in the pager)
3941 tree (thread tree drawn in the message index and attachment menu)
3947 underline (highlighting underlined patterns in the body of
3957 <emphasis>foreground</emphasis> and <emphasis>background</emphasis> can
3958 be one of the following:
4021 color<emphasis>x</emphasis>
4030 <emphasis>foreground</emphasis> can optionally be prefixed with the
4031 keyword <literal>bright</literal> to make
4032 the foreground color boldfaced (e.g., <literal>brightred</literal>).
4036 If your terminal supports it, the special keyword <emphasis>default</emphasis> can be
4037 used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.
4038 If Mutt-ng is linked against the <emphasis>S-Lang</emphasis> library,
4039 you also need to set
4040 the <muttng-doc:envvar name="COLORFGBG"/> environment variable to the default
4042 terminal for this to work; for example (for Bourne-like shells):
4048 set COLORFGBG="green;black"
4049 export COLORFGBG</screen>
4054 <emphasis role="bold">Note:</emphasis> The <emphasis>S-Lang</emphasis>
4055 library requires you to use the <emphasis>lightgray</emphasis>
4056 and <emphasis>brown</emphasis> keywords instead of <emphasis>white</emphasis> and <emphasis>
4060 setting this variable.
4064 <emphasis role="bold">Note:</emphasis> The uncolor command can be
4065 applied to the index object only. It
4066 removes entries from the list. You <emphasis role="bold">must</emphasis> specify the same pattern
4067 specified in the color command for it to be removed. The pattern ``*''
4069 a special token which means to clear the color index list of all
4074 Mutt-ng also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>
4078 <emphasis>color</emphasis><emphasis role="bold">N-1</emphasis> (<emphasis role="bold">
4081 being the number of colors supported
4082 by your terminal). This is useful when you remap the colors for your
4083 display (for example by changing the color associated with <emphasis>
4086 for your xterm), since color names may then lose their normal meaning.
4090 If your terminal does not support color, it is still possible change
4092 attributes through the use of the ``mono'' command:
4097 Usage: <literal>mono</literal> <emphasis><object> <attribute></emphasis>[<emphasis>regexp</emphasis>]
4098 Usage: <literal>mono</literal> index <emphasis>attribute</emphasis> <emphasis>pattern</emphasis>
4099 Usage: <literal>unmono</literal> index <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
4104 where <emphasis>attribute</emphasis> is one of the following:
4152 <title>Ignoring (weeding) unwanted message headers</title>
4156 Usage: <literal>[un]ignore</literal> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
4161 Messages often have many header fields added by automatic processing
4163 or which may not seem useful to display on the screen. This command
4165 you to specify header fields which you don't normally want to see.
4169 You do not need to specify the full header field name. For example,
4170 ``ignore content-'' will ignore all header fields that begin with the
4172 ``content-''. ``ignore *'' will ignore all headers.
4176 To remove a previously added token from the list, use the ``unignore''
4178 The ``unignore'' command will make Mutt-ng display headers with the
4180 For example, if you do ``ignore x-'' it is possible to ``unignore
4185 ``unignore *'' will remove all tokens from the ignore list.
4192 # Sven's draconian header weeding
4194 unignore from date subject to cc
4195 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
4196 unignore posted-to:</screen>
4206 <sect1 id="alternates">
4207 <title>Alternative addresses</title>
4210 Usage: <literal>[un]alternates</literal> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4215 With various functions, mutt will treat messages differently,
4216 depending on whether you sent them or whether you received them from
4217 someone else. For instance, when replying to a message that you
4218 sent to a different party, mutt will automatically suggest to send
4219 the response to the original message's recipients--responding to
4220 yourself won't make much sense in many cases.
4221 (See <muttng-doc:varref name="reply_to" link="reply-to"/>.)
4225 Many users receive e-mail under a number of different addresses. To
4226 fully use mutt's features here, the program must be able to
4227 recognize what e-mail addresses you receive mail under. That's the
4228 purpose of the <literal>alternates</literal> command: It takes a list
4230 expressions, each of which can identify an address under which you
4235 The <literal>unalternates</literal> command can be used to write
4237 <literal>alternates</literal> patterns. If an address matches something
4239 <literal>alternates</literal> command, but you nonetheless do not think
4241 from you, you can list a more precise pattern under an <literal>
4248 To remove a regular expression from the <literal>alternates</literal>
4250 <literal>unalternates</literal> command with exactly the same <emphasis>
4254 Likewise, if the <emphasis>regexp</emphasis> for a <literal>alternates</literal> command matches
4255 an entry on the <literal>unalternates</literal> list, that <literal>
4258 entry will be removed. If the <emphasis>regexp</emphasis> for <literal>
4261 is ``*'', <emphasis>all entries</emphasis> on <literal>alternates</literal> will be removed.
4270 <sect1 id="format-flowed">
4271 <title>Format = Flowed</title>
4273 <sect2 id="format-flowed-intro">
4274 <title>Introduction</title>
4277 Mutt-ng contains support for so-called <literal>format=flowed</literal> messages.
4278 In the beginning of email, each message had a fixed line width, and
4279 it was enough for displaying them on fixed-size terminals. But times
4280 changed, and nowadays hardly anybody still uses fixed-size terminals:
4281 more people nowaydays use graphical user interfaces, with dynamically
4282 resizable windows. This led to the demand of a new email format that
4283 makes it possible for the email client to make the email look nice
4284 in a resizable window without breaking quoting levels and creating
4285 an incompatible email format that can also be displayed nicely on
4286 old fixed-size terminals.
4290 For introductory information on <literal>format=flowed</literal>
4292 <ulink URL="http://www.joeclark.org/ffaq.html"><http://www.joeclark.org/ffaq.html></ulink>.
4297 <sect2 id="format-flowed-display">
4298 <title>Receiving: Display Setup</title>
4301 When you receive emails that are marked as <literal>format=flowed</literal>
4302 messages, and is formatted correctly, mutt-ng will try to reformat
4303 the message to optimally fit on your terminal. If you want a fixed
4304 margin on the right side of your terminal, you can set the
4311 set wrapmargin = 10</screen>
4316 The code above makes the line break 10 columns before the right
4317 side of the terminal.
4321 If your terminal is so wide that the lines are embarrassingly long,
4322 you can also set a maximum line length:
4328 set max_line_length = 120</screen>
4333 The example above will give you lines not longer than 120
4338 When you view at <literal>format=flowed</literal> messages, you will
4340 the quoting hierarchy like in the following example:
4346 >Bill, can you please send last month's progress report to Mr.
4347 >Morgan? We also urgently need the cost estimation for the new
4348 >production server that we want to set up before our customer's
4349 >project will go live.</screen>
4354 This obviously doesn't look very nice, and it makes it very
4355 hard to differentiate between text and quoting character. The
4356 solution is to configure mutt-ng to "stuff" the quoting:
4362 set stuff_quoted</screen>
4367 This will lead to a nicer result that is easier to read:
4373 > Bill, can you please send last month's progress report to Mr.
4374 > Morgan? We also urgently need the cost estimation for the new
4375 > production server that we want to set up before our customer's
4376 > project will go live.</screen>
4382 <sect2 id="format-flowed-send">
4383 <title>Sending</title>
4386 If you want mutt-ng to send emails with <literal>format=flowed</literal> set, you
4387 need to explicitly set it:
4393 set text_flowed</screen>
4398 Additionally, you have to use an editor which supports writing
4399 <literal>format=flowed</literal>-conforming emails. For <muttng-doc:man name="vim"/>, this is
4401 adding <literal>w</literal> to the formatoptions (see <literal>:h
4405 <literal>:h fo-table</literal>) when writing emails.
4409 Also note that <emphasis>format=flowed</emphasis> knows about
4411 that is, when sending messages, some kinds of lines have to be
4412 indented with a single space on the sending side. On the receiving
4413 side, the first space (if any) is removed. As a consequence and in
4414 addition to the above simple setting, please keep this in mind when
4415 making manual formattings within the editor. Also note that mutt-ng
4416 currently violates the standard (RfC 3676) as it does not
4417 space-stuff lines starting with:
4426 <literal>></literal> This is <emphasis>not</emphasis> the
4427 quote character but a right
4428 angle used for other reasons
4435 <literal>From</literal> with a trailing space.
4442 just a space for formatting reasons
4452 Please make sure that you manually prepend a space to each of them.
4457 <sect2 id="format-flowed-notes">
4458 <title>Additional Notes</title>
4461 For completeness, the <muttng-doc:varref name="delete_space" link="delete-space"/> variable provides the mechanism
4462 to generate a <literal>DelSp=yes</literal> parameter on <emphasis>
4466 According to the standard, clients receiving a <literal>format=flowed</literal>
4467 messages should delete the last space of a flowed line but still
4468 interpret the line as flowed. Because flowed lines usually contain
4469 only one space at the end, this parameter would make the receiving
4470 client concatenate the last word of the previous with the first of
4471 the current line <emphasis>without</emphasis> a space. This makes
4473 unreadable and is intended for languages rarely using spaces. So
4474 please use this setting only if you're sure what you're doing.
4486 <title>Mailing lists</title>
4490 Usage: <literal>[un]lists</literal> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4491 Usage: <literal>[un]subscribe</literal> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4496 Mutt-ng has a few nice features for <link linkend="using-lists">using-lists</link>.
4497 In order to take advantage of them, you must
4498 specify which addresses belong to mailing lists, and which mailing
4499 lists you are subscribed to. Once you have done this, the
4500 <link linkend="func-list-reply">list-reply</link>
4501 function will work for all known lists.
4502 Additionally, when you send a message to a subscribed list, mutt will
4503 add a Mail-Followup-To header to tell other users' mail user agents
4504 not to send copies of replies to your personal address. Note that
4505 the Mail-Followup-To header is a non-standard extension which is not
4506 supported by all mail user agents. Adding it is not bullet-proof
4508 receiving personal CCs of list messages. Also note that the generation
4509 of the Mail-Followup-To header is controlled by the
4510 <muttng-doc:varref name="followup_to" link="followup-to"/>
4511 configuration variable.
4515 More precisely, Mutt-ng maintains lists of patterns for the addresses
4516 of known and subscribed mailing lists. Every subscribed mailing
4517 list is known. To mark a mailing list as known, use the ``lists''
4518 command. To mark it as subscribed, use ``subscribe''.
4522 You can use regular expressions with both commands. To mark all
4523 messages sent to a specific bug report's address on mutt's bug
4524 tracking system as list mail, for instance, you could say
4525 ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
4526 give a portion of the list's e-mail address.
4530 Specify as much of the address as you need to to remove ambiguity. For
4531 example, if you've subscribed to the Mutt-ng mailing list, you will
4533 addressed to <emphasis>mutt-users@mutt.org</emphasis>. So, to tell
4534 Mutt-ng that this is a
4535 mailing list, you could add ``lists mutt-users'' to your
4536 initialization file. To tell mutt that you are subscribed to it,
4537 add ``subscribe mutt-users'' to your initialization file instead.
4538 If you also happen to get mail from someone whose address is
4539 <emphasis>mutt-users@example.com</emphasis>, you could use ``lists
4540 mutt-users@mutt\\.org''
4541 or ``subscribe mutt-users@mutt\\.org'' to
4542 match only mail from the actual list.
4546 The ``unlists'' command is used to remove a token from the list of
4547 known and subscribed mailing-lists. Use ``unlists *'' to remove all
4552 To remove a mailing list from the list of subscribed mailing lists,
4553 but keep it on the list of known mailing lists, use ``unsubscribe''.
4562 <sect1 id="mbox-hook">
4563 <title>Using Multiple spool mailboxes</title>
4567 Usage: <muttng-doc:hook name="mbox"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4572 This command is used to move read messages from a specified mailbox to
4573 adifferent mailbox automatically when you quit or change folders.
4574 <emphasis>pattern</emphasis> is a regular expression specifying the
4575 mailbox to treat as a
4576 ``spool'' mailbox and <emphasis>mailbox</emphasis> specifies where mail
4577 should be saved when
4582 Unlike some of the other <emphasis>hook</emphasis> commands, only the <emphasis>
4586 pattern is used (it is not possible to save read mail in more than a
4597 <sect1 id="mailboxes">
4598 <title>Defining mailboxes which receive mail</title>
4602 Usage: <literal>[un]mailboxes</literal> [!]<emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
4607 This command specifies folders which can receive mail and
4608 which will be checked for new messages. By default, the
4609 main menu status bar displays how many of these folders have
4614 When changing folders, pressing <emphasis>space</emphasis> will cycle
4615 through folders with new mail.
4619 Pressing TAB in the directory browser will bring up a menu showing the
4621 specified by the <literal>mailboxes</literal> command, and indicate
4623 messages. Mutt-ng will automatically enter this mode when invoked from
4625 command line with the <literal>-y</literal> option.
4629 The ``unmailboxes'' command is used to remove a token from the list
4630 of folders which receive mail. Use ``unmailboxes *'' to remove all
4635 <emphasis role="bold">Note:</emphasis> new mail is detected by
4636 comparing the last modification time to
4637 the last access time. Utilities like <literal>biff</literal> or <literal>
4641 program which accesses the mailbox might cause Mutt-ng to never detect
4643 for that mailbox if they do not properly reset the access time. Backup
4644 tools are another common reason for updated access times.
4648 <emphasis role="bold">Note:</emphasis> the filenames in the <literal>
4651 command are resolved when
4652 the command is executed, so if these names contain <link linkend="shortcuts">shortcuts</link>
4653 (such as ``='' and ``!''), any variable
4654 definition that affect these characters (like <muttng-doc:varref name="folder"/>
4655 and <muttng-doc:varref name="spoolfile"/>)
4656 should be executed before the <literal>mailboxes</literal> command.
4666 <title>User defined headers</title>
4670 Usage: <literal>my_hdr</literal> <emphasis>string</emphasis>
4671 Usage: <literal>unmy_hdr</literal> <emphasis>field</emphasis> [<emphasis>field</emphasis>...]
4676 The ``my_hdr'' command allows you to create your own header
4677 fields which will be added to every message you send.
4681 For example, if you would like to add an ``Organization:'' header field
4683 all of your outgoing messages, you can put the command
4688 my_hdr Organization: A Really Big Company, Anytown, USA</screen>
4692 in your <literal>.muttrc</literal>.
4696 <emphasis role="bold">Note:</emphasis> space characters are <emphasis>
4699 allowed between the keyword and
4700 the colon (``:''). The standard for electronic mail (RFC822) says that
4701 space is illegal there, so Mutt-ng enforces the rule.
4705 If you would like to add a header field to a single message, you should
4706 either set the <muttng-doc:varref name="edit_headers" link="edit-headers"/>
4708 or use the <emphasis>edit-headers</emphasis> function (default: ``E'')
4710 that you can edit the header of your message along with the body.
4714 To remove user defined header fields, use the ``unmy_hdr''
4715 command. You may specify an asterisk (``*'') to remove all header
4716 fields, or the fields to remove. For example, to remove all ``To'' and
4717 ``Cc'' header fields, you could use:
4722 unmy_hdr to cc</screen>
4731 <sect1 id="hdr-order">
4732 <title>Defining the order of headers when viewing messages</title>
4736 Usage: <literal>hdr_order</literal> <emphasis>header1</emphasis><emphasis>header2</emphasis> <emphasis>header3</emphasis>
4741 With this command, you can specify an order in which mutt will attempt
4742 to present headers to you when viewing messages.
4746 ``unhdr_order *'' will clear all previous headers from the order
4748 thus removing the header order effects set by the system-wide startup
4755 hdr_order From Date: From: To: Cc: Subject:</screen>
4765 <sect1 id="save-hook">
4766 <title>Specify default save filename</title>
4770 Usage: <muttng-doc:hook name="save"/> [!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
4775 This command is used to override the default filename used when saving
4776 messages. <emphasis>filename</emphasis> will be used as the default
4777 filename if the message is
4778 <emphasis>From:</emphasis> an address matching <emphasis>regexp</emphasis> or if you are the author and the
4779 message is addressed <emphasis>to:</emphasis> something matching <emphasis>
4786 See <muttng-doc:hook name="pattern"/> for information on
4787 the exact format of <emphasis>pattern</emphasis>.
4797 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
4798 save-hook aol\\.com$ +spam</screen>
4803 Also see the <muttng-doc:hook name="fcc-save"/>
4813 <sect1 id="fcc-hook">
4814 <title>Specify default Fcc: mailbox when composing</title>
4818 Usage: <muttng-doc:hook name="fcc"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4823 This command is used to save outgoing mail in a mailbox other than
4824 <muttng-doc:varref name="record"/>. Mutt-ng searches the initial
4826 message recipients for the first matching <emphasis>regexp</emphasis>
4827 and uses <emphasis>mailbox</emphasis>
4828 as the default Fcc: mailbox. If no match is found the message will be
4830 to <muttng-doc:varref name="record"/> mailbox.
4834 See <muttng-doc:hook name="pattern"/> for information on
4835 the exact format of <emphasis>pattern</emphasis>.
4839 Example: <literal><muttng-doc:hook name="fcc"/> ]@.[aol\\.com$
4845 The above will save a copy of all messages going to the aol.com domain
4847 the `+spammers' mailbox by default. Also see the <muttng-doc:hook name="fcc-save"/>
4857 <sect1 id="fcc-save-hook">
4858 <title>Specify default save filename and default Fcc: mailbox at once</title>
4862 Usage: <literal><muttng-doc:hook name="fcc-save"/></literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4867 This command is a shortcut, equivalent to doing both a <muttng-doc:hook name="fcc"/>
4868 and a <muttng-doc:hook name="save"/> with its arguments.
4877 <sect1 id="send-hook">
4878 <title>Change settings based upon message recipients</title>
4880 <anchor id="reply-hook"/>
4883 Usage: <muttng-doc:hook name="reply"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4884 Usage: <muttng-doc:hook name="send"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4885 Usage: <muttng-doc:hook name="send2"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4890 These commands can be used to execute arbitrary configuration commands
4892 upon recipients of the message. <emphasis>pattern</emphasis> is a
4894 matching the desired address. <emphasis>command</emphasis> is executed
4895 when <emphasis>regexp</emphasis>
4896 matches recipients of the message.
4900 <muttng-doc:hook name="reply"/> is matched against the message you are <emphasis>
4903 <emphasis role="bold">to</emphasis>, instead of the message you are <emphasis>
4906 .<muttng-doc:hook name="send"/> is
4907 matched against all messages, both <emphasis>new</emphasis> and <emphasis>
4910 .<emphasis role="bold">Note:</emphasis>
4911 <muttng-doc:hook name="reply"/>s are matched <emphasis role="bold">before</emphasis> the
4912 <muttng-doc:hook name="send"/>, <emphasis role="bold">regardless</emphasis>
4913 of the order specified in the users's configuration file.
4917 <muttng-doc:hook name="send2"/> is matched every time a message is
4919 by editing it, or by using the compose menu to change its recipients
4920 or subject. <muttng-doc:hook name="send2"/> is executed after <muttng-doc:hook name="send"/>
4922 can, e.g., be used to set parameters such as the <muttng-doc:varref name="sendmail"/>
4923 variable depending on the message's sender
4928 For each type of <muttng-doc:hook name="send"/> or <muttng-doc:hook name="reply"/>, when multiple matches
4929 occur, commands are executed in the order they are specified in the
4931 (for that type of hook).
4935 See <muttng-doc:hook name="pattern"/> for information on
4936 the exact format of <emphasis>pattern</emphasis>.
4940 Example: <literal>send-hook mutt "set mime_forward
4946 Another typical use for this command is to change the values of the
4947 <muttng-doc:varref name="attribution"/>,
4948 <muttng-doc:varref name="signature"/> and <muttng-doc:varref
4950 variables in order to change the language of the attributions and
4951 signatures based upon the recipients.
4955 <emphasis role="bold">Note:</emphasis> the <muttng-doc:hook name="send"/>'s are only
4956 executed ONCE after getting the initial
4957 list of recipients. Adding a recipient after replying or editing the
4958 message will NOT cause any <muttng-doc:hook name="send"/> to be executed. Also note that
4959 my_hdr commands which modify recipient headers, or the message's
4960 subject, don't have any effect on the current message when executed
4961 from a <muttng-doc:hook name="send"/>.
4970 <sect1 id="message-hook">
4971 <title>Change settings before formatting a message</title>
4975 Usage: <muttng-doc:hook name="message"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4980 This command can be used to execute arbitrary configuration commands
4981 before viewing or formatting a message based upon information about the
4983 <emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis> matches the message to be
4984 displayed. When multiple matches occur, commands are executed in the
4986 they are specified in the muttrc.
4990 See <muttng-doc:hook name="pattern"/> for
4991 information on the exact format of <emphasis>pattern</emphasis>.
4998 message-hook <muttng-doc:pattern name="A"/> 'set pager=builtin'
4999 message-hook '<muttng-doc:pattern name="f"/> freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</screen>
5009 <sect1 id="crypt-hook">
5010 <title>Choosing the cryptographic key of the recipient</title>
5014 Usage: <muttng-doc:hook name="crypt"/> <emphasis>pattern</emphasis> <emphasis>keyid</emphasis>
5019 When encrypting messages with PGP or OpenSSL, you may want to associate
5021 key with a given e-mail address automatically, either because the
5022 recipient's public key can't be deduced from the destination address,
5023 or because, for some reasons, you need to override the key Mutt-ng
5024 wouldnormally use. The <muttng-doc:hook name="crypt"/> command provides a method by which
5026 specify the ID of the public key to be used when encrypting messages to
5027 a certain recipient.
5031 The meaning of "key id" is to be taken broadly in this context: You
5032 can either put a numerical key ID here, an e-mail address, or even
5043 <title>Adding key sequences to the keyboard buffer</title>
5047 Usage: <literal>push</literal> <emphasis>string</emphasis>
5053 This command adds the named string to the keyboard buffer. The
5054 string may contain control characters, key names and function
5055 names like the sequence string in the <link linkend="macro">macro</link> command. You may use it to
5056 automatically run a sequence of commands at startup, or when
5057 entering certain folders. For example, the following command
5058 will automatically collapse all threads when entering a folder:
5061 folder-hook . 'push <collapse-all>'
5073 <title>Executing functions</title>
5077 Usage: <literal>exec</literal> <emphasis>function</emphasis> [<emphasis>function</emphasis>...]
5082 This command can be used to execute any function. Functions are
5083 listed in the <link linkend="functions">functions</link>.
5084 ``exec function'' is equivalent to ``push <function>''.
5093 <sect1 id="score-command">
5094 <title>Message Scoring</title>
5098 Usage: <literal>score</literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
5099 Usage: <literal>unscore</literal> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
5104 In situations where you have to cope with a lot of emails, e.g.
5105 when you read many different mailing lists, and take part in
5106 discussions, it is always useful to have the important messages
5107 marked and the annoying messages or the ones that you aren't
5108 interested in deleted. For this purpose, mutt-ng features a
5109 mechanism called ``scoring''.
5113 When you use scoring, every message has a base score of 0. You
5114 can then use the <literal>score</literal> command to define patterns
5116 positive or negative value associated with it. When a pattern
5117 matches a message, the message's score will be raised or lowered by
5118 the amount of the value associated with the pattern.
5124 score "<muttng-doc:pattern name="f"/> nion@muttng\.org" 50
5125 score "<muttng-doc:pattern name="f"/> @sco\.com" -100</screen>
5130 If the pattern matches, it is also possible to set the score
5131 value of the current message to a certain value and then stop
5138 score "<muttng-doc:pattern name="f"/> santaclaus@northpole\.int" =666</screen>
5143 What is important to note is that negative score values will be
5148 To make scoring actually useful, the score must be applied in
5149 some way. That's what the <emphasis>score thresholds</emphasis> are
5151 there are three score thresholds:
5160 flag threshold: when a message has a score value equal or higher
5161 than the flag threshold, it will be flagged.
5168 read threshold: when a message has a score value equal or lower
5169 than the read threshold, it will be marked as read.
5176 delete threshold: when a message has a score value equal or
5177 lower than the delete threshold, it will be marked as deleted.
5187 These three thresholds can be set via the variables
5188 <muttng-doc:varref name="score_threshold_read" link="score-threshold-read"/>,
5189 <muttng-doc:varref name="score_threshold_flag" link="score-threshold-flag"/> and
5190 <muttng-doc:varref name="score_threshold_delete" link="score-threshold-delete"/>.
5194 <muttng-doc:varref name="score_threshold_read" link="score-threshold-read"/> and
5195 <muttng-doc:varref name="score_threshold_delete" link="score-threshold-delete"/>
5197 <literal>-1</literal>, which means that in the default threshold
5199 message will ever get marked as read or deleted.
5203 Scoring gets especially interesting when combined with the <literal>
5207 and the <muttng-doc:pattern name="n"/> pattern:
5213 color index black yellow "<muttng-doc:pattern name="n"/> 10-"
5214 color index red yellow "<muttng-doc:pattern name="n"/> 100-"</screen>
5219 The rules above mark all messages with a score between 10 and 99
5220 with black and yellow, and messages with a score greater or equal
5221 100 with red and yellow. This might be unusual to you if you're used
5222 to e.g. slrn's scoring mechanism, but it is more flexible, as it
5223 visually marks different scores.
5233 <title>Spam detection</title>
5237 Usage: <literal>spam</literal> <emphasis>pattern</emphasis> <emphasis>format </emphasis>
5238 Usage: <literal>nospam</literal> <emphasis>pattern</emphasis>
5243 Mutt-ng has generalized support for external spam-scoring filters.
5244 By defining your spam patterns with the <literal>spam</literal> and <literal>
5247 commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and <emphasis>
5251 mail based on its spam attributes, as determined by the external
5252 filter. You also can display the spam attributes in your index
5253 display using the <literal>%H</literal> selector in the
5254 <muttng-doc:varref name="index_format" link="index-format"/>
5255 variable. (Tip: try <literal>%?H?[%H] ?</literal>
5256 to display spam tags only when they are defined for a given message.)
5260 Your first step is to define your external filter's spam patterns using
5261 the <literal>spam</literal> command. <emphasis>pattern</emphasis>
5262 should be a regular expression
5263 that matches a header in a mail message. If any message in the mailbox
5264 matches this regular expression, it will receive a ``spam tag'' or
5265 ``spam attribute'' (unless it also matches a <literal>nospam</literal>
5267 below.) The appearance of this attribute is entirely up to you, and is
5268 governed by the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> can be any static
5269 text, but it also can include back-references from the <emphasis>
5272 expression. (A regular expression ``back-reference'' refers to a
5273 sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
5274 the first back-reference in the regex, <literal>%2</literal>
5275 with the second, etc.
5279 If you're using multiple spam filters, a message can have more than
5280 one spam-related header. You can define <literal>spam</literal>
5282 filter you use. If a message matches two or more of these patterns, and
5283 the $spam_separator variable is set to a string, then the
5284 message's spam tag will consist of all the <emphasis>format</emphasis>
5286 together, with the value of $spam_separator separating
5291 For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
5292 define these spam settings:
5295 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
5296 spam "X-Spam-Status: Yes" "90+/SA"
5297 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
5298 set spam_separator=", "</screen>
5303 If I then received a message that DCC registered with ``many'' hits
5304 under the ``Fuz2'' checksum, and that PureMessage registered with a
5305 97% probability of being spam, that message's spam tag would
5306 read<literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before
5308 DCC report indicate the checksum used -- in this case, ``Fuz2''.)
5312 If the $spam_separator variable is unset, then each
5313 spam pattern match supersedes the previous one. Instead of getting
5314 joined <emphasis>format</emphasis> strings, you'll get only the last
5319 The spam tag is what will be displayed in the index when you use
5320 <literal>%H</literal> in the <literal>
5323 variable. It's also the
5324 string that the <muttng-doc:pattern name="H"/> pattern-matching expression
5326 <emphasis>search</emphasis> and <emphasis>limit</emphasis> functions.
5327 And it's what sorting by spam
5328 attribute will use as a sort key.
5332 That's a pretty complicated example, and most people's actual
5333 environments will have only one spam filter. The simpler your
5334 configuration, the more effective mutt can be, especially when it comes
5339 Generally, when you sort by spam tag, mutt will sort <emphasis>
5343 that is, by ordering strings alphnumerically. However, if a spam tag
5344 begins with a number, mutt will sort numerically first, and lexically
5345 only when two numbers are equal in value. (This is like UNIX's
5346 <literal>sort -n</literal>.) A message with no spam attributes at all
5348 that didn't match <emphasis>any</emphasis> of your <literal>spam</literal> patterns -- is sorted at
5349 lowest priority. Numbers are sorted next, beginning with 0 and ranging
5350 upward. Finally, non-numeric strings are sorted, with ``a'' taking
5351 lowerpriority than ``z''. Clearly, in general, sorting by spam tags is
5353 effective when you can coerce your filter to give you a raw number. But
5354 in case you can't, mutt can still do something useful.
5358 The <literal>nospam</literal> command can be used to write exceptions
5359 to <literal>spam</literal>
5360 patterns. If a header pattern matches something in a <literal>spam</literal> command,
5361 but you nonetheless do not want it to receive a spam tag, you can list
5362 amore precise pattern under a <literal>nospam</literal> command.
5366 If the <emphasis>pattern</emphasis> given to <literal>nospam</literal>
5367 is exactly the same as the
5368 <emphasis>pattern</emphasis> on an existing <literal>spam</literal>
5369 list entry, the effect will be to
5370 remove the entry from the spam list, instead of adding an exception.
5371 Likewise, if the <emphasis>pattern</emphasis> for a <literal>spam</literal> command matches an entry
5372 on the <literal>nospam</literal> list, that <literal>nospam</literal>
5373 entry will be removed. If the
5374 <emphasis>pattern</emphasis> for <literal>nospam</literal> is ``*'', <emphasis>
5375 all entries on both lists
5377 will be removed. This might be the default action if you use <literal>
5380 and <literal>nospam</literal> in conjunction with a <muttng-doc:hook name="folder"/>.
5384 You can have as many <literal>spam</literal> or <literal>nospam</literal> commands as you like.
5385 You can even do your own primitive spam detection within mutt -- for
5386 example, if you consider all mail from <literal>MAILER-DAEMON</literal>
5388 you can use a <literal>spam</literal> command like this:
5394 spam "^From: .*MAILER-DAEMON" "999"</screen>
5405 <title>Setting variables</title>
5409 Usage: <literal>set</literal> [no|inv]<emphasis>variable</emphasis>[=<emphasis>value</emphasis>] [<emphasis>variable</emphasis>...]
5410 Usage: <literal>toggle</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
5411 Usage: <literal>unset</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
5412 Usage: <literal>reset</literal> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
5418 This command is used to set (and unset) <link linkend="variables">variables</link>.
5419 There are four basic types of variables:
5420 boolean, number, string and quadoption. <emphasis>boolean</emphasis>
5422 <emphasis>set</emphasis> (true) or <emphasis>unset</emphasis> (false).
5423 <emphasis>number</emphasis> variables can be
5424 assigned a positive integer value.
5428 <emphasis>string</emphasis> variables consist of any number of
5429 printable characters.
5430 <emphasis>strings</emphasis> must be enclosed in quotes if they contain
5432 may also use the ``C'' escape sequences <emphasis role="bold">\n</emphasis> and <emphasis role="bold">
5436 newline and tab, respectively.
5440 <emphasis>quadoption</emphasis> variables are used to control whether
5441 or not to be prompted
5442 for certain actions, or to specify a default action. A value of <emphasis>
5445 will cause the action to be carried out automatically as if you had
5447 yes to the question. Similarly, a value of <emphasis>no</emphasis>
5449 action to be carried out as if you had answered ``no.'' A value of
5450 <emphasis>ask-yes</emphasis> will cause a prompt with a default answer
5452 <emphasis>ask-no</emphasis> will provide a default answer of ``no.''
5456 Prefixing a variable with ``no'' will unset it. Example: <literal>set
5463 For <emphasis>boolean</emphasis> variables, you may optionally prefix
5464 the variable name with
5465 <literal>inv</literal> to toggle the value (on or off). This is useful
5467 macros. Example: <literal>set invsmart_wrap</literal>.
5471 The <literal>toggle</literal> command automatically prepends the <literal>
5475 specified variables.
5479 The <literal>unset</literal> command automatically prepends the <literal>
5483 specified variables.
5487 Using the enter-command function in the <emphasis>index</emphasis>
5488 menu, you can query the
5489 value of a variable by prefixing the name of the variable with a
5497 set ?allow_8bit</screen>
5502 The question mark is actually only required for boolean and quadoption
5507 The <literal>reset</literal> command resets all given variables to the
5509 defaults (hopefully mentioned in this manual). If you use the command
5510 <literal>set</literal> and prefix the variable with ``&'' this has
5512 behavior as the reset command.
5516 With the <literal>reset</literal> command there exists the special
5518 which allows you to reset all variables to their system defaults.
5528 <title>Reading initialization commands from another file</title>
5532 Usage: <literal>source</literal> <emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
5537 This command allows the inclusion of initialization commands
5538 from other files. For example, I place all of my aliases in
5539 <literal>~/.mail_aliases</literal> so that I can make my
5540 <literal>~/.muttrc</literal> readable and keep my aliases
5545 If the filename begins with a tilde (``~''), it will be expanded
5547 path of your home directory.
5551 If the filename ends with a vertical bar (|), then <emphasis>
5555 considered to be an executable program from which to read input (eg.
5556 <literal>source ~/bin/myscript|</literal>).
5566 <title>Removing hooks</title>
5570 Usage: <literal>unhook</literal> [* | <emphasis>hook-type</emphasis>]
5575 This command permits you to flush hooks you have previously defined.
5576 You can either remove all hooks by giving the ``*'' character as an
5577 argument, or you can remove all hooks of a specific type by saying
5578 something like <literal>unhook send</literal>.
5588 <title>Sharing Setups</title>
5590 <sect2 id="share-charset">
5591 <title>Character Sets</title>
5594 As users may run mutt-ng on different systems, the configuration
5595 must be maintained because it's likely that people want to use the
5596 setup everywhere they use mutt-ng. And mutt-ng tries to help where it
5601 To not produce conflicts with different character sets, mutt-ng
5602 allows users to specify in which character set their configuration
5603 files are encoded. Please note that while reading the configuration
5604 files, this is only respected after the corresponding declaration
5605 appears. It's advised to put the following at the very beginning of a
5612 set config_charset = "..."</screen>
5617 and replacing the dots with the actual character set. To avoid
5618 problems while maintaining the setup, <muttng-doc:man name="vim"/> user's may want to use
5619 modelines as show in:
5625 # vim:fileencoding=...:</screen>
5630 while, again, replacing the dots with the appropriate name. This
5631 tells <muttng-doc:man name="vim"/> as which character set to read and save the file.
5640 <sect2 id="share-modularization">
5641 <title>Modularization</title>
5644 ``Modularization'' means to divide the setup into several files
5645 while sorting the options or commands by topic. Especially for
5646 longer setups (e.g. with many hooks), this helps maintaining it
5647 and solving trouble.
5651 When using separation, setups may be, as a whole or in
5652 fractions, shared over different systems.
5661 <sect2 id="share-conditional">
5662 <title>Conditional parts</title>
5665 When using a configuration on different systems, the user may not
5666 always have influence on how mutt-ng is installed and which features
5671 To solve this, mutt-ng contain a feature based on the ``ifdef''
5672 patch written for mutt. Its basic syntax is:
5678 ifdef <item> <command>
5679 ifndef <item> <command></screen>
5684 ...whereby <literal><item></literal> can be one of:
5724 All available functions, variables and menus are documented
5725 elsewhere in this manual but ``features'' is specific to these
5726 two commands. To test for one, prefix one of the following
5727 keywords with <literal>feature_</literal>: ncurses,
5728 slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
5729 gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
5730 classic_smime, gpgme, header_cache
5734 As an example, one can use the following in
5735 <literal>~/.muttngrc</literal>:
5741 ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
5742 ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
5743 ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</screen>
5748 ...to only source <literal>~/.mutt-ng/setup-imap</literal> if
5750 support is built in, only source <literal>~/.mutt-ng/setup-pop</literal>
5751 if POP support is built in and only source
5752 <literal>~/.mutt-ng/setup-nntp</literal> if NNTP support is
5757 An example for testing for variable names can be used if users
5758 use different revisions of mutt-ng whereby the older one may not
5759 have a certain variable. To test for the availability of
5760 <muttng-doc:varref name="imap_mail_check" link="imap-mail-check"/>
5767 ifdef imap_mail_check 'set imap_mail_check = 300'</screen>
5772 Provided for completeness is the test for menu names. To set
5773 <muttng-doc:varref name="pager_index_lines"
5774 link="pager-index-lines"/>
5776 menu is available, use:
5782 ifdef pager 'set pager_index_lines = 10'</screen>
5787 For completeness, too, the opposite of <literal>ifdef</literal> is
5789 <literal>ifndef</literal> which only executes the command if the test
5791 example, the following two examples are equivalent:
5797 ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
5798 ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</screen>
5809 ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
5810 ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</screen>
5826 <sect1 id="vars-obsolete">
5827 <title>Obsolete Variables</title>
5830 In the process of ensuring and creating more consistency, many
5831 variables have been renamed and some of the old names were already
5832 removed. Please see <link linkend="sect-obsolete">sect-obsolete</link>
5833 for a complete list.
5849 <chapter id="advanced-usage"> <!--{{{-->
5850 <title>Advanced Usage</title>
5852 <sect1 id="advanced-regexp">
5853 <title>Regular Expressions</title>
5856 All string patterns in Mutt-ng including those in more complex
5857 <link linkend="tab-patterns">patterns</link> must be specified
5858 using regular expressions (regexp) in the ``POSIX extended'' syntax
5860 is more or less the syntax used by egrep and GNU awk). For your
5861 convenience, we have included below a brief description of this syntax.
5865 The search is case sensitive if the pattern contains at least one upper
5866 case letter, and case insensitive otherwise. Note that ``\''
5867 must be quoted if used for a regular expression in an initialization
5872 A regular expression is a pattern that describes a set of strings.
5873 Regular expressions are constructed analogously to arithmetic
5874 expressions, by using various operators to combine smaller expressions.
5878 Note that the regular expression can be enclosed/delimited by either
5880 or ' which is useful if the regular expression includes a white-space
5881 character. See <link linkend="configuration-syntax">muttrc-syntax</link>
5882 for more information on " and ' delimiter processing. To match a
5883 literal " or ' you must preface it with \ (backslash).
5887 The fundamental building blocks are the regular expressions that match
5888 a single character. Most characters, including all letters and digits,
5889 are regular expressions that match themselves. Any metacharacter with
5890 special meaning may be quoted by preceding it with a backslash.
5894 The period ``.'' matches any single character. The caret ``^''
5895 andthe dollar sign ``$'' are metacharacters that respectively
5897 the empty string at the beginning and end of a line.
5901 A list of characters enclosed by ``]'' and ``['' matches any
5902 single character in that list; if the first character of the list
5903 is a caret ``^'' then it matches any character <emphasis role="bold">
5907 list. For example, the regular expression <emphasis role="bold">
5910 matches any single digit. A range of ASCII characters may be specified
5911 by giving the first and last characters, separated by a hyphen
5912 ``-''. Most metacharacters lose their special meaning inside
5913 lists. To include a literal ``['' place it first in the list.
5914 Similarly, to include a literal ``^'' place it anywhere but first.
5915 Finally, to include a literal hyphen ``-'' place it last.
5919 Certain named classes of characters are predefined. Character classes
5920 consist of ``]:'', a keyword denoting the class, and ``:[''.
5921 The following classes are defined by the POSIX standard:
5928 <term>]:alnum:[</term>
5931 Alphanumeric characters.
5936 <term>]:alpha:[</term>
5939 Alphabetic characters.
5944 <term>]:blank:[</term>
5947 Space or tab characters.
5952 <term>]:cntrl:[</term>
5960 <term>]:digit:[</term>
5968 <term>]:graph:[</term>
5971 Characters that are both printable and visible. (A space is
5973 but not visible, while an ``a'' is both.)
5978 <term>]:lower:[</term>
5981 Lower-case alphabetic characters.
5986 <term>]:print:[</term>
5989 Printable characters (characters that are not control
5995 <term>]:punct:[</term>
5998 Punctuation characters (characters that are not letter, digits,
6000 characters, or space characters).
6005 <term>]:space:[</term>
6008 Space characters (such as space, tab and formfeed, to name a
6014 <term>]:upper:[</term>
6017 Upper-case alphabetic characters.
6022 <term>]:xdigit:[</term>
6025 Characters that are hexadecimal digits.
6033 A character class is only valid in a regular expression inside the
6034 brackets of a character list. Note that the brackets in these
6035 class names are part of the symbolic names, and must be included
6036 in addition to the brackets delimiting the bracket list. For
6037 example, <emphasis role="bold">]]:digit:[[</emphasis> is equivalent to
6038 <emphasis role="bold">]0-9[</emphasis>.
6042 Two additional special sequences can appear in character lists. These
6043 apply to non-ASCII character sets, which can have single symbols
6044 (calledcollating elements) that are represented with more than one
6046 as well as several characters that are equivalent for collating or
6054 <term>Collating Symbols</term>
6057 A collating symbol is a multi-character collating element
6059 ``].'' and ``.[''. For example, if ``ch'' is a
6061 element, then <emphasis role="bold">
6064 is a regexp that matches
6065 this collating element, while <emphasis role="bold">
6069 matches either ``c'' or ``h''.
6074 <term>Equivalence Classes</term>
6077 An equivalence class is a locale-specific name for a list of
6078 characters that are equivalent. The name is enclosed in
6080 and ``=[''. For example, the name ``e'' might be used to
6081 represent all of ``è'' ``é'' and ``e''. In this
6083 <emphasis role="bold">]]=e=[[</emphasis> is
6084 a regexp that matches any of
6085 ``è'', ``é'' and ``e''.
6093 A regular expression matching a single character may be followed by one
6094 of several repetition operators:
6104 The preceding item is optional and matched at most once.
6112 The preceding item will be matched zero or more times.
6120 The preceding item will be matched one or more times.
6128 The preceding item is matched exactly <emphasis>n</emphasis>
6137 The preceding item is matched <emphasis>n</emphasis> or more
6146 The preceding item is matched at most <emphasis>m</emphasis>
6155 The preceding item is matched at least <emphasis>n</emphasis>
6156 times, but no more than
6157 <emphasis>m</emphasis> times.
6165 Two regular expressions may be concatenated; the resulting regular
6166 expression matches any string formed by concatenating two substrings
6167 that respectively match the concatenated subexpressions.
6171 Two regular expressions may be joined by the infix operator
6173 the resulting regular expression matches any string matching either
6178 Repetition takes precedence over concatenation, which in turn takes
6179 precedence over alternation. A whole subexpression may be enclosed in
6180 parentheses to override these precedence rules.
6184 <emphasis role="bold">Note:</emphasis> If you compile Mutt-ng with the
6185 GNU <emphasis>rx</emphasis> package, the
6186 following operators may also be used in regular expressions:
6196 Matches the empty string at either the beginning or the end of
6205 Matches the empty string within a word.
6213 Matches the empty string at the beginning of a word.
6221 Matches the empty string at the end of a word.
6229 Matches any word-constituent character (letter, digit, or
6238 Matches any character that is not word-constituent.
6246 Matches the empty string at the beginning of a buffer (string).
6254 Matches the empty string at the end of a buffer.
6262 Please note however that these operators are not defined by POSIX, so
6263 they may or may not be available in stock libraries on various systems.
6272 <sect1 id="advanced-patterns">
6273 <title>Patterns</title>
6276 Mutt-ng's pattern language provides a simple yet effective way to
6277 set up rules to match messages, e.g. for operations like tagging and
6278 scoring. A pattern consists of one or more sub-pattern, which can be
6279 logically grouped, ORed, and negated. For a complete listing of
6280 these patterns, please refer to table <link linkend="tab-patterns">patterns</link> in the Reference chapter.
6284 It must be noted that in this table, <literal>EXPR</literal> is
6285 a regular expression. For ranges, the forms
6286 <literal><[MAX]</literal>, <literal>>>[MIN]</literal>,
6287 <literal> [MIN]-</literal> and <literal>-[MAX]</literal> are
6291 <sect2 id="patterns-complex">
6292 <title>Complex Patterns</title>
6295 It is possible to combine several sub-patterns to a more complex
6296 pattern. The most simple possibility is to logically AND several
6297 patterns by stringing them together:
6303 <muttng-doc:pattern name="s"/> 'SPAM' <muttng-doc:pattern name="U"/></screen>
6308 The pattern above matches all messages that contain ``SPAM'' in
6309 the subject and are unread.
6313 To logical OR patterns, simply use the <literal>|</literal>
6315 especially useful when using local groups:
6321 <muttng-doc:pattern name="f"/> ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
6322 (<muttng-doc:pattern name="b"/> mutt-ng|<muttng-doc:pattern name="s"/> Mutt-ng)
6323 !<muttng-doc:pattern name="x"/> '@synflood\.at'</screen>
6328 The first pattern matches all messages that were sent by one of
6329 the mutt-ng maintainers, while the seconds pattern matches all
6330 messages that contain ``mutt-ng'' in the message body or ``Mutt-ng''
6331 in the subject. The third pattern matches all messages that do not
6332 contain ``@synflood\.at'' in the <literal>References:</literal>
6334 messages that are not an (indirect) reply to one of my messages. A
6335 pattern can be logicall negated using the <literal>!</literal>
6341 <sect2 sect="patterns-dates">
6342 <title>Patterns and Dates</title>
6345 When using dates in patterns, the dates must be specified in a
6346 special format, i.e. <literal>DD/MM/YYYY</literal>. If you don't
6348 month or year, they default to the current month or year. When using
6349 date ranges, and you specify only the minimum or the maximum, the
6350 specified date will be excluded, e.g. <literal>01/06/2005-</literal>
6352 against all messages <emphasis>after</emphasis> Juni 1st, 2005.
6356 It is also possible to use so-called ``error margins'' when
6357 specifying date ranges. You simply specify a date, and then the
6358 error margin. This margin needs to contain the information whether
6359 it goes ``forth'' or ``back'' in time, by using <literal>+</literal>
6360 and <literal>-</literal>.
6361 Then follows a number and a unit, i.e. <literal>y</literal> for
6362 years, <literal>m</literal> for
6363 months, <literal>w</literal> for weeks and <literal>d</literal> for
6364 days. If you use the special
6365 <literal>*</literal> sign, it means that the error margin goes to
6366 both``directions'' in time.
6372 <muttng-doc:pattern name="d"/> 01/01/2005+1y
6373 <muttng-doc:pattern name="d"/> 18/10/2004-2w
6374 <muttng-doc:pattern name="d"/> 28/12/2004*1d</screen>
6379 The first pattern matches all dates between January 1st, 2005 and
6380 January 1st 2006. The second pattern matches all dates between
6381 October 18th, 2004 and October 4th 2004 (2 weeks before 18/10/2004),
6382 while the third pattern matches all dates 1 day around December
6383 28th, 2004 (i.e. Dec 27th, 28th and 29th).
6387 Relative dates are also very important, as they make it possible
6388 to specify date ranges between a fixed number of units and the
6389 current date. How this works can be seen in the following example:
6395 <muttng-doc:pattern name="d"/> >2w # messages older than two weeks
6396 <muttng-doc:pattern name="d"/> <3d # messages newer than 3 days
6397 <muttng-doc:pattern name="d"/> =1m # messages that are exactly one month old</screen>
6409 <sect1 id="formatstrings">
6410 <title>Format Strings</title>
6412 <sect2 id="formatstrings-intro">
6413 <title>Introduction</title>
6416 The so called <emphasis>Format Strings</emphasis> offer great
6418 configuring mutt-ng. In short, they describe what items to print
6419 out how in menus and status messages.
6423 Basically, they work as this: for different menus and bars,
6424 there's a variable specifying the layout. For every item
6425 available, there is a so called <emphasis>expando</emphasis>.
6429 For example, when running mutt-ng on different machines or
6430 different versions for testing purposes, it may be interesting to
6431 have the following information always printed on screen when one
6441 the current hostname
6448 the current mutt-ng version number
6458 The setting for the status bar of the index is controlled via the
6459 <muttng-doc:varref name="status_format" link="status-format"/>
6460 variable. For the hostname and version string, there's an expando
6461 for <literal>$status_format</literal>: <literal>
6465 hostname and <literal>%v</literal> to the version string. When
6472 set status_format = "%v on %h: ..."</screen>
6477 mutt-ng will replace the sequence <literal>%v</literal> with
6479 and <literal>%h</literal> with the host's name. When you are,
6480 for example, running
6481 mutt-ng version <literal>1.5.9i</literal> on host <literal>mailhost</literal>, you'll see the
6482 following when you're in the index:
6488 Mutt-ng 1.5.9i on mailhost: ...</screen>
6493 In the index, there're more useful information one could want to
6503 which mailbox is open
6510 how man new, flagged or postponed messages
6527 To include the mailbox' name is as easy as:
6533 set status_format = "%v on %h: %B: ...</screen>
6538 When the currently opened mailbox is <literal>Inbox</literal>, this
6546 Mutt-ng 1.5.9i on mailhost: Inbox: ...</screen>
6551 For the number of certain types of messages, one more feature of the
6553 strings is extremely useful. If there aren't messages of a certain
6555 may not be desired to print just that there aren't any but instead
6557 print something if there are any.
6566 <sect2 id="formatstrings-conditional">
6567 <title>Conditional Expansion</title>
6570 To only print the number of messages if there are new messages in
6571 the current mailbox, further extend
6572 <literal>$status_format</literal> to:
6578 set status_format = "%v on %h: %B %?n?%n new? ...</screen>
6583 This feature is called <emphasis>nonzero-printing</emphasis> and
6585 some expandos may be optionally printed nonzero, i.e. a portion
6586 of the format string is only evaluated if the value of the expando
6587 is different from zero. The basic syntax is:
6593 %?<item>?<string if nonzero>?</screen>
6598 which tells mutt-ng to only look at <literal><string if
6601 if the value of the <literal>%<item%gt;</literal>
6602 expando is different from zero. In our example, we used <literal>n</literal> as
6603 the expando to check for and <literal>%n new</literal> as the
6609 But this is not all: this feature only offers one alternative:
6610 ``print something if not zero.'' Mutt-ng does, as you might guess,
6611 also provide a logically complete version: ``if zero, print
6612 something and else print something else.'' This is achieved by the
6613 following syntax for those expandos which may be printed nonzero:
6619 %?<item>?<string if nonzero>&<string if zero>?</screen>
6624 Using this we can make mutt-ng to do the following:
6633 make it print ``<emphasis>n</emphasis> new messages'' whereby <emphasis>
6637 count but only if there new ones
6644 and make it print ``no new messages'' if there aren't any
6654 The corresponding configuration is:
6660 set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</screen>
6665 This doubles the use of the ``new messages'' string because it'll get
6666 always printed. Thus, it can be shortened to:
6672 set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</screen>
6677 As you might see from this rather simple example, one can create
6678 very complex but fancy status messages. Please see the reference
6679 chapter for expandos and those which may be printed nonzero.
6688 <sect2 id="formatstrings-padding">
6689 <title>Modifications and Padding</title>
6692 Besides the information given so far, there're even more features of
6702 When specifying <literal>%_<item></literal>
6704 just <literal>%<item></literal>, mutt-ng will
6706 characters in the expansion of <literal><item></literal>
6715 When specifying <literal>%:<item></literal>
6717 <literal>%<item></literal>, mutt-ng will convert
6719 expansion of <literal><item></literal> to underscores
6720 (<literal>_</literal>).
6730 Also, there's a feature called <emphasis>Padding</emphasis> supplied
6732 following two expandos: <literal>%|X</literal> and <literal>
6743 <literal>%|X</literal>
6747 When this occurs, mutt-ng will fill the
6748 rest of the line with the character <literal>X</literal>. In
6750 filling the rest of the line with dashes is done by setting:
6756 set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</screen>
6763 <literal>%>X</literal>
6767 Since the previous expando stops at
6768 the end of line, there must be a way to fill the gap between
6769 two items via the <literal>%>X</literal> expando:
6771 characters <literal>X</literal> in between two items so that
6773 the line will be right-justified. For example, to not put the
6774 version string and hostname of our example on the left but on
6775 the right and fill the gap with spaces, one might use (note
6776 the space after <literal>%></literal>):
6782 set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</screen>
6802 <sect1 id="using-tags">
6803 <title>Using Tags</title>
6806 Sometimes it is desirable to perform an operation on a group of
6807 messages all at once rather than one at a time. An example might be
6808 to save messages to a mailing list to a separate folder, or to
6809 delete all messages with a given subject. To tag all messages
6810 matching a pattern, use the tag-pattern function, which is bound to
6811 ``shift-T'' by default. Or you can select individual messages by
6812 hand using the ``tag-message'' function, which is bound to ``t'' by
6813 default. See <link linkend="tab-patterns">patterns</link> for Mutt-ng's
6819 Once you have tagged the desired messages, you can use the
6820 ``tag-prefix'' operator, which is the ``;'' (semicolon) key by default.
6821 When the ``tag-prefix'' operator is used, the <emphasis role="bold">
6825 be applied to all tagged messages if that operation can be used in that
6826 manner. If the <muttng-doc:varref name="auto_tag" link="auto-tag"/>
6827 variable is set, the next operation applies to the tagged messages
6828 automatically, without requiring the ``tag-prefix''.
6832 In <link linkend="macro">macro</link> or <link linkend="push">push</link> commands,
6833 you can use the ``tag-prefix-cond'' operator. If there are no tagged
6834 messages, mutt will "eat" the rest of the macro to abort it's
6835 execution.Mutt-ng will stop "eating" the macro when it encounters the
6837 operator; after this operator the rest of the macro will be executed
6848 <title>Using Hooks</title>
6851 A <emphasis>hook</emphasis> is a concept borrowed from the EMACS editor
6853 execute arbitrary commands before performing some operation. For
6855 you may wish to tailor your configuration based upon which mailbox you
6857 reading, or to whom you are sending mail. In the Mutt-ng world, a <emphasis>
6860 consists of a <link linkend="advanced-regexp">regexp</link> or
6861 <link linkend="tab-patterns">patterns</link> along with a
6862 configuration option/command. See
6868 <muttng-doc:hook name="folder"/>
6874 <muttng-doc:hook name="send"/>
6880 <muttng-doc:hook name="message"/>
6886 <muttng-doc:hook name="save"/>
6892 <muttng-doc:hook name="mbox"/>
6898 <muttng-doc:hook name="fcc"/>
6904 <muttng-doc:hook name="fcc-save"/>
6910 for specific details on each type of <emphasis>hook</emphasis>
6915 <emphasis role="bold">Note:</emphasis> if a hook changes configuration
6916 settings, these changes remain
6917 effective until the end of the current mutt session. As this is
6919 not desired, a default hook needs to be added before all other hooks to
6920 restore configuration defaults. Here is an example with <muttng-doc:hook name="send"/> and
6928 send-hook . 'unmy_hdr From:'
6929 send-hook <muttng-doc:pattern name="C"/>'^b@b\.b$' my_hdr from: c@c.c</screen>
6933 <sect2 id="pattern-hook">
6934 <title>Message Matching in Hooks</title>
6937 Hooks that act upon messages (<literal><muttng-doc:hook name="send"/>, <muttng-doc:hook name="save"/>,
6938 <muttng-doc:hook name="fcc"/>,<muttng-doc:hook name="message"/>
6940 )are evaluated in a slightly different manner. For the other
6941 types of hooks, a <link linkend="advanced-regexp">regexp</link> is
6942 sufficient. But in dealing with messages a finer grain of control is
6943 needed for matching since for different purposes you want to match
6948 Mutt-ng allows the use of the <link linkend="tab-patterns">patterns</link>
6949 language for matching messages in hook commands. This works in
6950 exactly the same way as it would when <emphasis>limiting</emphasis>
6951 or<emphasis>searching</emphasis> the mailbox, except that you are
6953 operators which match information mutt extracts from the header of
6954 the message (i.e. from, to, cc, date, subject, etc.).
6958 For example, if you wanted to set your return address based upon
6960 mail to a specific address, you could do something like:
6963 send-hook '<muttng-doc:pattern name="t"/> ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User <user@host>'</screen>
6965 which would execute the given command when sending mail to
6966 <emphasis>me@cs.hmc.edu</emphasis>.
6970 However, it is not required that you write the pattern to match using
6972 full searching language. You can still specify a simple <emphasis>
6976 like the other hooks, in which case Mutt-ng will translate your
6977 pattern into the full language, using the translation specified by
6979 <muttng-doc:hook name="default"/> variable. The
6980 pattern is translated at the time the hook is declared, so the value
6982 <muttng-doc:hook name="default"/> that is in effect
6983 at that time will be used.
6994 <sect1 id="sidebar">
6995 <title>Using the sidebar</title>
6998 The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox
7000 which looks very similar to the ones you probably know from GUI mail
7002 The sidebar lists all specified mailboxes, shows the number in each
7003 and highlights the ones with new email
7004 Use the following configuration commands:
7007 set sidebar_visible="yes"
7008 set sidebar_width=25</screen>
7013 If you want to specify the mailboxes you can do so with:
7025 You can also specify the colors for mailboxes with new mails by using:
7028 color sidebar_new red black
7029 color sidebar white black</screen>
7034 Reasonable key bindings look e.g. like this:
7037 bind index \Cp sidebar-prev
7038 bind index \Cn sidebar-next
7039 bind index \Cb sidebar-open
7040 bind pager \Cp sidebar-prev
7041 bind pager \Cn sidebar-next
7042 bind pager \Cb sidebar-open
7044 macro index B ':toggle sidebar_visible^M'
7045 macro pager B ':toggle sidebar_visible^M'</screen>
7050 You can then go up and down by pressing Ctrl-P and Ctrl-N, and
7051 switch on and off the sidebar simply by pressing 'B'.
7061 <title>External Address Queries</title>
7064 Mutt-ng supports connecting to external directory databases such as
7066 ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
7067 using a simple interface. Using the
7068 <muttng-doc:varref name="query_command" link="query-command"/>
7069 variable, you specify the wrapper
7070 command to use. For example:
7076 set query_command = "mutt_ldap_query.pl '%s'"</screen>
7081 The wrapper script should accept the query on the command-line. It
7082 should return a one line message, then each matching response on a
7083 single line, each line containing a tab separated address then name
7084 thensome other optional information. On error, or if there are no
7086 addresses, return a non-zero exit code and a one line error message.
7090 An example multiple response output:
7093 Searching database ... 20 entries ... 3 matching:
7094 me@cs.hmc.edu Michael Elkins mutt dude
7095 blong@fiction.net Brandon Long mutt and more
7096 roessler@guug.de Thomas Roessler mutt pgp</screen>
7101 There are two mechanisms for accessing the query function of mutt. One
7102 is to do a query from the index menu using the query function (default:
7104 This will prompt for a query, then bring up the query menu which will
7105 list the matching responses. From the query menu, you can select
7106 addresses to create aliases, or to mail. You can tag multiple
7107 addressesto mail, start a new query, or have a new query appended to
7113 The other mechanism for accessing the query function is for address
7114 completion, similar to the alias completion. In any prompt for address
7115 entry, you can use the complete-query function (default: ^T) to
7117 query based on the current address you have typed. Like aliases, mutt
7118 will look for what you have typed back to the last space or comma. If
7119 there is a single response for that query, mutt will expand the address
7120 in place. If there are multiple responses, mutt will activate the
7121 querymenu. At the query menu, you can select one or more addresses to
7123 added to the prompt.
7132 <sect1 id="mailbox-formats">
7133 <title>Mailbox Formats</title>
7136 Mutt-ng supports reading and writing of four different mailbox formats:
7137 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
7138 is no need to use a flag for different mailbox types. When creating
7139 newmailboxes, Mutt-ng uses the default specified with the
7140 <muttng-doc:varref name="mbox_type" link="mbox-type"/>
7145 <emphasis role="bold">mbox</emphasis>. This is the most widely used
7146 mailbox format for UNIX. All
7147 messages are stored in a single file. Each message has a line of the
7154 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</screen>
7159 to denote the start of a new message (this is often referred to as the
7164 <emphasis role="bold">MMDF</emphasis>. This is a variant of the <emphasis>
7167 format. Each message is
7168 surrounded by lines containing ``^A^A^A^A'' (four
7173 <emphasis role="bold">MH</emphasis>. A radical departure from <emphasis>
7176 and <emphasis>MMDF</emphasis>, a mailbox
7177 consists of a directory and each message is stored in a separate file.
7178 The filename indicates the message number (however, this is may not
7179 correspond to the message number Mutt-ng displays). Deleted messages
7180 arerenamed with a comma (,) prepended to the filename. <emphasis role="bold">
7184 detects this type of mailbox by looking for either <literal>
7187 or <literal>.xmhcache</literal> (needed to distinguish normal
7193 <emphasis role="bold">Maildir</emphasis>. The newest of the mailbox
7194 formats, used by the Qmail MTA (a
7195 replacement for sendmail). Similar to <emphasis>MH</emphasis>, except
7197 subdirectories of the mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and <emphasis>
7201 for the messages are chosen in such a way they are unique, even when
7202 twoprograms are writing the mailbox over NFS, which means that no file
7213 <sect1 id="shortcuts">
7214 <title>Mailbox Shortcuts</title>
7217 There are a number of built in shortcuts which refer to specific
7219 These shortcuts can be used anywhere you are prompted for a file or
7230 ! -- refers to your <muttng-doc:varref name="spoolfile" link="spoolfile"/>
7237 > -- refers to your <muttng-doc:varref name="mbox" link="mbox"/> file
7243 < -- refers to your <muttng-doc:varref name="record" link="record"/> file
7249 ^ -- refers to the current mailbox
7255 - or !! -- refers to the file you've last visited
7261 ~ -- refers to your home directory
7267 = or + -- refers to your <muttng-doc:varref name="folder" link="folder"/>
7274 @<emphasis>alias</emphasis> -- refers to the <muttng-doc:hook name="save"/>
7275 as determined by the address of the alias
7289 <sect1 id="using-lists">
7290 <title>Handling Mailing Lists</title>
7293 Mutt-ng has a few configuration options that make dealing with large
7294 amounts of mail easier. The first thing you must do is to let Mutt
7295 know what addresses you consider to be mailing lists (technically
7296 this does not have to be a mailing list, but that is what it is most
7297 often used for), and what lists you are subscribed to. This is
7298 accomplished through the use of the <link linkend="lists">lists</link>
7299 commands in your muttrc.
7303 Now that Mutt-ng knows what your mailing lists are, it can do several
7304 things, the first of which is the ability to show the name of a list
7305 through which you received a message (i.e., of a subscribed list) in
7306 the <emphasis>index</emphasis> menu display. This is useful to
7308 personal and list mail in the same mailbox. In the
7309 <muttng-doc:varref name="index_format" link="index-format"/>
7310 variable, the escape ``%L''
7311 will return the string ``To <list>'' when ``list'' appears in the
7312 ``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
7313 field (otherwise it returns the name of the author).
7317 Often times the ``To'' and ``Cc'' fields in mailing list messages
7318 tend to get quite large. Most people do not bother to remove the
7319 author of the message they are reply to from the list, resulting in
7320 two or more copies being sent to that person. The ``list-reply''
7321 function, which by default is bound to ``L'' in the <emphasis>index</emphasis> menu
7322 and <emphasis>pager</emphasis>, helps reduce the clutter by only
7324 known mailing list addresses instead of all recipients (except as
7325 specified by <literal>Mail-Followup-To</literal>, see below).
7329 Mutt-ng also supports the <literal>Mail-Followup-To</literal> header.
7331 a message to a list of recipients which includes one or several
7332 subscribed mailing lists, and if the <muttng-doc:varref name="followup_to" link="followup-to"/>
7333 option is set, mutt will generate
7334 a Mail-Followup-To header which contains all the recipients to whom
7335 you send this message, but not your address. This indicates that
7336 group-replies or list-replies (also known as ``followups'') to this
7337 message should only be sent to the original recipients of the
7338 message, and not separately to you - you'll receive your copy through
7339 one of the mailing lists you are subscribed to.
7343 Conversely, when group-replying or list-replying to a message which
7344 has a <literal>Mail-Followup-To</literal> header, mutt will respect
7346 the <muttng-doc:varref name="honor_followup_to" link="honor-followup-to"/>
7348 variable is set. Using list-reply will in this case also make sure
7349 that the reply goes to the mailing list, even if it's not specified
7350 in the list of recipients in the <literal>Mail-Followup-To</literal>.
7354 Note that, when header editing is enabled, you can create a
7355 <literal>Mail-Followup-To</literal> header manually. Mutt-ng will only
7357 this header if it doesn't exist when you send the message.
7361 The other method some mailing list admins use is to generate a
7362 ``Reply-To'' field which points back to the mailing list address rather
7363 than the author of the message. This can create problems when trying
7364 to reply directly to the author in private, since most mail clients
7365 will automatically reply to the address given in the ``Reply-To''
7366 field. Mutt-ng uses the <muttng-doc:varref name="reply_to" link="reply-to"/>
7367 variable to help decide which address to use. If set to <emphasis>
7371 <emphasis>ask-no</emphasis>, you will be
7372 prompted as to whether or not you would like to use the address given
7373 inthe ``Reply-To'' field, or reply directly to the address given in the
7374 ``From'' field. When set to <emphasis>yes</emphasis>, the ``Reply-To''
7375 field will be used when
7380 The ``X-Label:'' header field can be used to further identify mailing
7381 lists or list subject matter (or just to annotate messages
7382 individually). The <muttng-doc:varref name="index_format" link="index-format"/>
7383 variable's ``%y'' and
7384 ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
7385 index, and Mutt-ng's pattern-matcher can match regular expressions to
7386 ``X-Label:'' fields with the ``<muttng-doc:pattern name="y"/>'' selector. ``X-Label:'' is
7388 standard message header field, but it can easily be inserted by
7389 procmailand other mail filtering agents.
7393 Lastly, Mutt-ng has the ability to <link linkend="sort">sort</link> the
7395 <link linkend="threads">threads</link>. A thread is a group of
7396 messages which all relate to the same
7397 subject. This is usually organized into a tree-like structure where a
7398 message and all of its replies are represented graphically. If you've
7400 used a threaded news client, this is the same concept. It makes
7401 dealingwith large volume mailing lists easier because you can easily
7403 uninteresting threads and quickly find topics of value.
7412 <sect1 id="editing-threads">
7413 <title>Editing threads</title>
7416 Mutt-ng has the ability to dynamically restructure threads that are
7418 either by misconfigured software or bad behavior from some
7419 correspondents. This allows to clean your mailboxes formats) from these
7420 annoyances which make it hard to follow a discussion.
7423 <sect2 id="editing-threads-link">
7424 <title>Linking threads</title>
7427 Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
7428 "References:" headers when replying to a message. This results in
7430 discussions because Mutt-ng has not enough information to guess the
7433 You can fix this by tagging the reply, then moving to the parent
7435 and using the ``link-threads'' function (bound to & by default).
7437 reply will then be connected to this "parent" message.
7441 You can also connect multiple children at once, tagging them and
7443 tag-prefix command (';') or the auto_tag option.
7448 <sect2 id="editing-threads-break">
7449 <title>Breaking threads</title>
7452 On mailing lists, some people are in the bad habit of starting a new
7453 discussion by hitting "reply" to any message from the list and
7455 the subject to a totally unrelated one.
7456 You can fix such threads by using the ``break-thread'' function
7457 (boundby default to #), which will turn the subthread starting
7459 current message into a whole different thread.
7471 <title>Delivery Status Notification (DSN) Support</title>
7474 RFC1894 defines a set of MIME content types for relaying information
7475 about the status of electronic mail messages. These can be thought of
7477 ``return receipts.''
7481 Users can make use of it in one of the following two ways:
7490 Berkeley sendmail 8.8.x currently has some command line options
7491 in which the mail client can make requests as to what type of
7493 messages should be returned.
7499 The SMTP support via libESMTP supports it, too.
7508 To support this, there are two variables:
7517 <muttng-doc:varref name="dsn_notify" link="dsn-notify"/> is used
7518 to request receipts for different results (such as failed
7519 message,message delivered, etc.).
7526 <muttng-doc:varref name="dsn_return" link="dsn-return"/> requests
7527 how much of your message should be returned with the receipt
7528 (headers or full message).
7538 Please see the reference chapter for possible values.
7548 <title>POP3 Support (OPTIONAL)</title>
7551 If Mutt-ng was compiled with POP3 support (by running the <emphasis>
7554 script with the <emphasis>--enable-pop</emphasis> flag), it has the
7556 with mailboxes located on a remote POP3 server and fetch mail for local
7561 You can access the remote POP3 mailbox by selecting the folder
7562 <literal>pop://popserver/</literal>.
7566 You can select an alternative port by specifying it with the server,
7568 <literal>pop://popserver:port/</literal>.
7572 You can also specify different username for each folder, i.e.:
7573 <literal>pop://username@popserver[:port]/</literal>.
7577 Polling for new mail is more expensive over POP3 than locally. For this
7578 reason the frequency at which Mutt-ng will check for mail remotely can
7581 <muttng-doc:varref name="pop_mail_check" link="pop-mail-check"/>
7582 variable, which defaults to every 60 seconds.
7586 If Mutt-ng was compiled with SSL support (by running the <emphasis>
7589 script with the <emphasis>--with-ssl</emphasis> flag), connections to
7591 can be encrypted. This naturally requires that the server supports
7592 SSL encrypted connections. To access a folder with POP3/SSL, you should
7593 use pops: prefix, ie:
7594 <literal>pops://[username@]popserver[:port]/</literal>.
7598 Another way to access your POP3 mail is the <emphasis>fetch-mail</emphasis> function
7599 (default: G). It allows to connect to <link
7600 linkend="pop-host">pop-host</link>
7601 ,fetch all your new mail and place it in the
7602 local <muttng-doc:varref name="spoolfile" link="spoolfile"/>. After this
7603 point, Mutt-ng runs exactly as if the mail had always been local.
7607 <emphasis role="bold">Note:</emphasis> If you only need to fetch all
7608 messages to local mailbox
7609 you should consider using a specialized program, such as
7610 <muttng-doc:man name="fetchmail"/>.
7620 <title>IMAP Support (OPTIONAL)</title>
7623 If Mutt-ng was compiled with IMAP support (by running the <emphasis>
7626 script with the <emphasis>--enable-imap</emphasis> flag), it has the
7628 with folders located on a remote IMAP server.
7632 You can access the remote inbox by selecting the folder
7633 <literal>imap://imapserver/INBOX</literal>, where <literal>imapserver</literal> is the name of the
7634 IMAP server and <literal>INBOX</literal> is the special name for your
7636 the IMAP server. If you want to access another mail folder at the IMAP
7637 server, you should use <literal>imap://imapserver/path/to/folder</literal> where
7638 <literal>path/to/folder</literal> is the path of the folder you want to
7643 You can select an alternative port by specifying it with the server,
7645 <literal>imap://imapserver:port/INBOX</literal>.
7649 You can also specify different username for each folder, i.e.:
7650 <literal>imap://username@imapserver[:port]/INBOX</literal>.
7654 If Mutt-ng was compiled with SSL support (by running the <emphasis>
7657 script with the <emphasis>--with-ssl</emphasis> flag), connections to
7659 can be encrypted. This naturally requires that the server supports
7660 SSL encrypted connections. To access a folder with IMAP/SSL, you should
7661 use <literal>imaps://[username@]imapserver[:port]/path/to/folder</literal> as your
7666 Pine-compatible notation is also supported, i.e.
7667 <literal>{[username@]imapserver[:port][/ssl]}path/to/folder</literal>
7671 Note that not all servers use / as the hierarchy separator. Mutt-ng
7673 correctly notice which separator is being used by the server and
7674 convertpaths accordingly.
7678 When browsing folders on an IMAP server, you can toggle whether to look
7679 at only the folders you are subscribed to, or all folders with the
7680 <emphasis>toggle-subscribed</emphasis> command. See also the
7681 <muttng-doc:varref name="imap_list_subscribed" link="imap-list-subscribed"/>
7686 Polling for new mail on an IMAP server can cause noticeable delays. So,
7688 want to carefully tune the
7689 <muttng-doc:varref name="imap_mail_check" link="imap-mail-check"/>
7691 <muttng-doc:varref name="timeout" link="timeout"/>
7696 Note that if you are using mbox as the mail store on UW servers prior
7697 tov12.250, the server has been reported to disconnect a client if
7699 selects the same folder.
7702 <sect2 id="imap-browser">
7703 <title>The Folder Browser</title>
7706 As of version 1.2, mutt supports browsing mailboxes on an IMAP
7707 server. This is mostly the same as the local file browser, with the
7708 following differences:
7714 Instead of file permissions, mutt displays the string "IMAP",
7715 possibly followed by the symbol "+", indicating
7716 that the entry contains both messages and subfolders. On
7717 Cyrus-like servers folders will often contain both messages and
7724 For the case where an entry can contain both messages and
7725 subfolders, the selection key (bound to <literal>enter</literal> by default)
7726 will choose to descend into the subfolder view. If you wish to
7728 the messages in that folder, you must use <literal>view-file</literal> instead
7729 (bound to <literal>space</literal> by default).
7735 You can create, delete and rename mailboxes with the
7736 <literal>create-mailbox</literal>, <literal>delete-mailbox</literal>, and
7737 <literal>rename-mailbox</literal> commands (default bindings: <literal>
7741 <literal>d</literal> and <literal>r</literal>, respectively).
7743 <literal>subscribe</literal> and <literal>unsubscribe</literal>
7744 to mailboxes (normally
7745 these are bound to <literal>s</literal> and <literal>u</literal>, respectively).
7755 <sect2 id="imap-auth">
7756 <title>Authentication</title>
7759 Mutt-ng supports four authentication methods with IMAP servers: SASL,
7760 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
7761 NTLM authentication for you poor exchange users out there, but it has
7762 yet to be integrated into the main tree). There is also support for
7763 the pseudo-protocol ANONYMOUS, which allows you to log in to a public
7764 IMAP server without having an account. To use ANONYMOUS, simply make
7765 your username blank or "anonymous".
7769 SASL is a special super-authenticator, which selects among several
7771 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most
7773 method available on your host and the server. Using some of these
7775 (including DIGEST-MD5 and possibly GSSAPI), your entire session will
7777 encrypted and invisible to those teeming network snoops. It is the
7779 option if you have it. To use it, you must have the Cyrus SASL
7780 libraryinstalled on your system and compile mutt with the <emphasis>
7787 Mutt-ng will try whichever methods are compiled in and available on
7789 in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
7793 There are a few variables which control authentication:
7799 <muttng-doc:varref name="imap_user" link="imap-user"/> - controls
7800 the username under which you request authentication on the IMAP
7802 for all authenticators. This is overridden by an explicit
7804 the mailbox path (i.e. by using a mailbox name of the form
7805 <literal>{user@host}</literal>).
7811 <muttng-doc:varref name="imap_pass" link="imap-pass"/> - a
7812 password which you may preset, used by all authentication
7814 a password is needed.
7820 <muttng-doc:varref name="imap_authenticators" link="imap-authenticators"/>
7821 - a colon-delimited list of IMAP
7822 authentication methods to try, in the order you wish to try
7824 specified, this overrides mutt's default (attempt everything,
7843 <title>NNTP Support (OPTIONAL)</title>
7846 If compiled with ``--enable-nntp'' option, Mutt-ng can read news from
7847 a newsserver via NNTP. You can open a newsgroup with the
7848 ``change-newsgroup'' function from the index/pager which is by default
7849 bound to <literal>i</literal>.
7853 The Default newsserver can be obtained from the <muttng-doc:envvar name="NNTPSERVER"/>
7854 environment variable. Like other
7856 info about subscribed newsgroups is saved in a file as specified by the
7857 <muttng-doc:varref name="nntp_newsrc" link="nntp-newsrc"/> variable.
7858 Article headers are cached and can be loaded from a file when a
7859 newsgroup is entered instead loading from newsserver; currently, this
7860 caching mechanism still is different from the header caching for
7864 <sect2 id="nntp-scoring">
7865 <title>Again: Scoring</title>
7868 Especially for Usenet, people often ask for advanced filtering
7869 and scoring functionality. Of course, mutt-ng has scoring and
7870 allows a killfile, too. How to use a killfile has been discussed
7871 in <link linkend="score-command">Message Scoring</link>.
7875 What has not been discusses in detail is mutt-ng's built-in
7876 realname filter. For may newsreaders including those for
7877 ``advanced users'' like <emphasis>slrn</emphasis> or <emphasis>tin</emphasis>, there are frequent
7878 request for such functionality. The solutions offered often are
7879 complicated regular expressions.
7883 In mutt-ng this is as easy as
7889 score <muttng-doc:pattern name="*"/> =42</screen>
7894 This tells mutt-ng to apply a score of 42 to all messages whose
7895 sender specified a valid realname and a valid email address. Using
7901 score !<muttng-doc:pattern name="*"/> =42</screen>
7906 on the contrary applies a score of 42 to all messages <emphasis>not</emphasis>
7907 matching those criteria which are very strict:
7916 Email addresses must be valid according to RFC 2822, see
7918 URL="ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt"><ftp://ftp.rfc-editor.org/in-notes/rfc2822.txt>
7925 the name must consist of at least 2 fields whereby a field
7926 must not end in a dot. This means that ``Joe User'' and ``Joe
7927 A.User'' are valid while ``J. User'' and ``J. A. User'' aren't.
7934 it's assumed that users are interested in reading their
7935 own mail and mail from people who they have defined an alias
7936 forso that those 2 groups of messages are excluded from the
7960 <title>SMTP Support (OPTIONAL)</title>
7963 Mutt-ng can be built using a library called ``libESMTP'' which
7964 provides SMTP functionality. When <literal>configure</literal> was
7966 <literal>--with-libesmtp</literal> or the output <literal>muttng -v</literal> contains
7967 <literal>+USE_LIBESMTP</literal>, this will be or is the case
7969 support includes support for Delivery Status Notification
7970 (see <link linkend="dsn">dsn</link> section) as well as
7971 handling the <literal>8BITMIME</literal> flag controlled via
7972 <muttng-doc:varref name="use_8bitmime" link="use-8bitmime"/>.
7976 To enable sending mail directly via SMTP without an MTA such as
7977 Postfix or SSMTP and the like, simply set the <muttng-doc:varref name="smtp_host" link="smtp-host"/>
7978 variable pointing to your SMTP server.
7982 Authentication mechanisms are available via the <muttng-doc:varref name="smtp_user" link="smtp-user"/>
7983 and <muttng-doc:varref name="smtp_pass" link="smtp-pass"/> variables.
7987 Transport Encryption via the StartTLS command is also available. For
7988 this to work, first of all Mutt-ng must be built with SSL or GNUTLS.
7989 Secondly, the <muttng-doc:varref name="smtp_use_tls" link="smtp-use-tls"/> variable
7991 to ``enabled'' or ``required.'' In both cases, StartTLS will be used if
7992 the server supports it: for the second case, the connection will fail
7993 ifit doesn't while switching back to unencrypted communication for the
7998 Some mail providers require user's to set a particular envelope
7999 sender, i.e. they allow for only one value which may not be what the
8000 user wants to send as the <literal>From:</literal> header. In this
8002 <muttng-doc:varref name="smtp_envelope" link="smtp-envelope"/> may be used
8003 to set the envelope different from the <literal>From:</literal> header.
8008 <sect1 id="account-hook">
8009 <title>Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)</title>
8012 If you happen to have accounts on multiple IMAP and/or POP servers,
8013 you may find managing all the authentication settings inconvenient and
8014 error-prone. The <muttng-doc:hook name="account"/> command may help. This hook works like
8015 <muttng-doc:hook name="folder"/> but is invoked whenever you access a remote mailbox
8016 (including inside the folder browser), not just when you open the
8027 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
8028 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
8029 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'</screen>
8039 <sect1 id="urlview">
8040 <title>Start a WWW Browser on URLs (EXTERNAL)</title>
8043 If a message contains URLs (<emphasis>unified resource locator</emphasis> = address in the
8044 WWW space like <emphasis>http://www.mutt.org/</emphasis>), it is
8046 a menu with all the URLs and start a WWW browser on one of them. This
8047 functionality is provided by the external urlview program which can be
8048 retrieved at <ulink URL="ftp://ftp.mutt.org/mutt/contrib/">ftp://ftp.mutt.org/mutt/contrib/</ulink>
8050 and the configuration commands:
8053 macro index \cb |urlview\n
8054 macro pager \cb |urlview\n</screen>
8064 <sect1 id="compressed-folders">
8065 <title>Compressed folders Support (OPTIONAL)</title>
8068 If Mutt-ng was compiled with compressed folders support (by running the
8069 <emphasis>configure</emphasis> script with the <emphasis>
8073 can open folders stored in an arbitrary format, provided that the user
8074 has a script to convert from/to this format to one of the accepted.
8078 The most common use is to open compressed archived folders e.g. with
8083 In addition, the user can provide a script that gets a folder in an
8084 accepted format and appends its context to the folder in the
8085 user-defined format, which may be faster than converting the entire
8086 folder to the accepted format, appending to it and converting back to
8087 the user-defined format.
8091 There are three hooks defined (<muttng-doc:hook name="open"/>,
8092 <muttng-doc:hook name="close"/> and <muttng-doc:hook name="append"/>
8093 )which define commands to uncompress and compress
8094 a folder and to append messages to an existing compressed folder
8105 open-hook \\.gz$ "gzip -cd %f > %t"
8106 close-hook \\.gz$ "gzip -c %t > %f"
8107 append-hook \\.gz$ "gzip -c %t >> %f" </screen>
8112 You do not have to specify all of the commands. If you omit <muttng-doc:hook name="append"/>
8113 ,the folder will be open and
8114 closed again each time you will add to it. If you omit <muttng-doc:hook name="close"/>
8115 (or give empty command) , the
8116 folder will be open in the mode. If you specify <muttng-doc:hook name="append"/>
8117 though you'll be able to append
8122 Note that Mutt-ng will only try to use hooks if the file is not in one
8124 the accepted formats. In particular, if the file is empty, mutt
8125 supposes it is not compressed. This is important because it allows the
8126 use of programs that do not have well defined extensions. Just use
8127 "." as a regexp. But this may be surprising if your
8128 compressing script produces empty files. In this situation, unset
8129 <muttng-doc:varref name="save_empty" link="save-empty"/>
8130 ,so that the compressed file
8131 will be removed if you delete all of the messages.
8134 <sect2 id="open-hook">
8135 <title>Open a compressed mailbox for reading</title>
8139 Usage: <muttng-doc:hook name="open"/> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
8144 The <emphasis>command</emphasis> is the command that can be used for
8146 folders whose names match <emphasis>regexp</emphasis>.
8150 The <emphasis>command</emphasis> string is the printf-like format
8152 should accept two parameters: %f, which is replaced with the
8153 (compressed) folder name, and %t which is replaced with the
8154 name of the temporary folder to which to write.
8158 %f and %t can be repeated any number of times in the
8159 command string, and all of the entries are replaced with the
8160 appropriate folder name. In addition, %% is replaced by
8161 %, as in printf, and any other %anything is left as is.
8165 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the original compressed file.
8166 The <emphasis>command</emphasis> should return non-zero exit status
8168 mutt knows something's wrong.
8178 open-hook \\.gz$ "gzip -cd %f > %t"
8184 If the <emphasis>command</emphasis> is empty, this operation is
8185 disabled for this file
8191 <sect2 id="close-hook">
8192 <title>Write a compressed mailbox</title>
8196 Usage: <muttng-doc:hook name="close"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
8201 This is used to close the folder that was open with the <muttng-doc:hook name="open"/>
8202 command after some changes were made to it.
8206 The <emphasis>command</emphasis> string is the command that can be
8207 used for closing the
8208 folders whose names match <emphasis>regexp</emphasis>. It has the
8210 the <muttng-doc:hook name="open"/> command. Temporary
8212 in this case is the folder previously produced by the <muttng-doc:hook name="open"/>
8217 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
8218 <emphasis>command</emphasis> should return non-zero exit status if it
8220 knows something's wrong.
8230 close-hook \\.gz$ "gzip -c %t > %f"</screen>
8235 If the <emphasis>command</emphasis> is empty, this operation is
8236 disabled for this file
8237 type, and the file can only be open in the readonly mode.
8241 <muttng-doc:hook name="close"/> is not called when you
8243 from the folder if the folder was not changed.
8248 <sect2 id="append-hook">
8249 <title>Append a message to a compressed mailbox</title>
8253 Usage: <muttng-doc:hook name="append"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
8258 This command is used for saving to an existing compressed folder.
8259 The <emphasis>command</emphasis> is the command that can be used for
8261 folders whose names match <emphasis>regexp</emphasis>. It has the
8263 the <muttng-doc:hook name="open"/> command.
8264 The temporary folder in this case contains the messages that are
8269 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
8270 <emphasis>command</emphasis> should return non-zero exit status if it
8272 knows something's wrong.
8282 append-hook \\.gz$ "gzip -c %t >> %f" </screen>
8287 When <muttng-doc:hook name="append"/> is used, the
8289 not opened, which saves time, but this means that we can not find out
8290 what the folder type is. Thus the default (<muttng-doc:varref name="mbox_type" link="mbox-type"/>
8291 )type is always supposed (i.e.
8292 this is the format used for the temporary folder).
8296 If the file does not exist when you save to it, <muttng-doc:hook name="close"/>
8297 is called, and not <muttng-doc:hook name="append"/>. <muttng-doc:hook name="append"/>
8299 for appending to existing folders.
8303 If the <emphasis>command</emphasis> is empty, this operation is
8304 disabled for this file
8305 type. In this case, the folder will be open and closed again (using
8306 <muttng-doc:hook name="open"/> and <muttng-doc:hook name="close"/>
8307 respectively) each time you will add to it.
8312 <sect2 id="encrypted-folders">
8313 <title>Encrypted folders</title>
8316 The compressed folders support can also be used to handle encrypted
8317 folders. If you want to encrypt a folder with PGP, you may want to
8318 usethe following hooks:
8324 open-hook \\.pgp$ "pgp -f < %f > %t"
8325 close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
8331 Please note, that PGP does not support appending to an encrypted
8332 folder, so there is no <muttng-doc:hook name="append"/> defined.
8336 <emphasis role="bold">Note:</emphasis> the folder is temporary stored
8337 decrypted in the /tmp
8338 directory, where it can be read by your system administrator. So
8339 thinkabout the security aspects of this.
8357 <chapter id="mime-support"> <!--{{{-->
8358 <title>Mutt-ng's MIME Support</title>
8361 Quite a bit of effort has been made to make Mutt-ng the premier text-mode
8362 MIME MUA. Every effort has been made to provide the functionality that
8363 the discerning MIME user requires, and the conformance to the standards
8364 wherever possible. When configuring Mutt-ng for MIME, there are two
8365 extratypes of configuration files which Mutt-ng uses. One is the
8366 <literal>mime.types</literal> file, which contains the mapping of file
8368 IANA MIME types. The other is the <literal>mailcap</literal> file, which
8370 the external commands to use for handling specific MIME types.
8374 <title>Using MIME in Mutt</title>
8377 There are three areas/menus in Mutt-ng which deal with MIME, they are
8379 pager (while viewing a message), the attachment menu and the compose
8383 <sect2 id="mime-view">
8384 <title>Viewing MIME messages in the pager</title>
8387 When you select a message from the index and view it in the pager,
8389 decodes the message to a text representation. Mutt-ng internally
8391 a number of MIME types, including <literal>text/plain, text/enriched,
8392 message/rfc822, and message/news
8394 .In addition, the export
8395 controlled version of Mutt-ng recognizes a variety of PGP MIME types,
8396 including PGP/MIME and application/pgp.
8400 Mutt-ng will denote attachments with a couple lines describing them.
8401 These lines are of the form:
8404 [-- Attachment #1: Description --]
8405 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]</screen>
8407 Where the <literal>Description</literal> is the description or
8408 filename given for the
8409 attachment, and the <literal>Encoding</literal> is one of
8410 <literal>7bit/8bit/quoted-printable/base64/binary</literal>.
8414 If Mutt-ng cannot deal with a MIME type, it will display a message
8418 [-- image/gif is unsupported (use 'v' to view this part) --]</screen>
8424 <sect2 id="attach-menu">
8425 <title>The Attachment Menu</title>
8428 The default binding for <literal>view-attachments</literal> is `v',
8430 attachment menu for a message. The attachment menu displays a list
8431 ofthe attachments in a message. From the attachment menu, you can
8433 print, pipe, delete, and view attachments. You can apply these
8434 operations to a group of attachments at once, by tagging the
8436 and by using the ``tag-prefix'' operator. You can also reply to the
8437 current message from this menu, and only the current attachment (or
8439 attachments tagged) will be quoted in your reply. You can view
8440 attachments as text, or view them using the mailcap viewer
8445 Finally, you can apply the usual message-related functions (like
8446 <muttng-doc:funcref name="resend-message"/>, and the reply
8447 and forward functions) to attachments of type <literal>message/rfc822</literal>.
8451 See the help on the attachment menu for more information.
8456 <sect2 id="compose-menu">
8457 <title>The Compose Menu</title>
8460 The compose menu is the menu you see before you send a message. It
8461 allows you to edit the recipient list, the subject, and other aspects
8462 of your message. It also contains a list of the attachments of your
8463 message, including the main body. From this menu, you can print,
8465 filter, pipe, edit, compose, review, and rename an attachment or a
8466 list of tagged attachments. You can also modifying the attachment
8467 information, notably the type, encoding and description.
8471 Attachments appear as follows:
8474 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
8475 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description></screen>
8480 The '-' denotes that Mutt-ng will delete the file after sending (or
8481 postponing, or canceling) the message. It can be toggled with the
8482 <literal>toggle-unlink</literal> command (default: u). The next
8484 content-type, and can be changed with the <literal>edit-type</literal> command
8485 (default: ^T). The next field is the encoding for the
8487 which allows a binary message to be encoded for transmission on 7bit
8488 links. It can be changed with the <literal>edit-encoding</literal>
8490 (default: ^E). The next field is the size of the attachment,
8491 rounded to kilobytes or megabytes. The next field is the filename,
8492 which can be changed with the <literal>rename-file</literal> command
8494 The final field is the description of the attachment, and can be
8495 changed with the <literal>edit-description</literal> command
8507 <sect1 id="mime-types">
8509 MIME Type configuration with <literal>mime.types</literal>
8513 When you add an attachment to your mail message, Mutt-ng searches your
8514 personal mime.types file within <muttng-doc:envvar name="HOME"/> and then
8515 the system mime.types file at <literal>/usr/local/share/mutt/mime.types</literal> or
8516 <literal>/etc/mime.types</literal>
8520 The mime.types file consist of lines containing a MIME type and a space
8521 separated list of extensions. For example:
8524 application/postscript ps eps
8526 audio/x-aiff aif aifc aiff</screen>
8528 A sample <literal>mime.types</literal> file comes with the Mutt-ng
8530 should contain most of the MIME types you are likely to use.
8534 If Mutt-ng can not determine the mime type by the extension of the file
8536 attach, it will look at the file. If the file is free of binary
8537 information, Mutt-ng will assume that the file is plain text, and mark
8539 as <literal>text/plain</literal>. If the file contains binary
8540 information, then Mutt-ng will
8541 mark it as <literal>application/octet-stream</literal>. You can change
8543 type that Mutt-ng assigns to an attachment by using the <literal>
8546 command from the compose menu (default: ^T). The MIME type is
8548 major mime type followed by the sub-type, separated by a '/'. 6 major
8549 types: application, text, image, video, audio, and model have been
8551 after various internet discussions. Mutt-ng recognises all of these if
8553 appropriate entry is found in the mime.types file. It also recognises
8555 major mime types, such as the chemical type that is widely used in the
8556 molecular modelling community to pass molecular data in various forms
8558 various molecular viewers. Non-recognised mime types should only be
8560 if the recipient of the message is likely to be expecting such
8570 <sect1 id="mime-mailcap">
8572 MIME Viewer configuration with <literal>mailcap</literal>
8576 Mutt-ng supports RFC 1524 MIME Configuration, in particular the Unix
8577 specific format specified in Appendix A of RFC 1524. This file format
8578 is commonly referred to as the mailcap format. Many MIME compliant
8579 programs utilize the mailcap format, allowing you to specify handling
8580 for all MIME types in one place for all programs. Programs known to
8581 use this format include Netscape, XMosaic, lynx and metamail.
8585 In order to handle various MIME types that Mutt-ng can not handle
8586 internally, Mutt-ng parses a series of external configuration files to
8587 find an external handler. The default search string for these files
8588 is a colon delimited list set to
8591 ${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap</screen>
8593 where <muttng-doc:envvar name="HOME"/> is your home directory.
8597 In particular, the metamail distribution will install a mailcap file,
8598 usually as <literal>/usr/local/etc/mailcap</literal>, which contains
8603 <sect2 id="mime-mailcap-basics">
8604 <title>The Basics of the mailcap file</title>
8607 A mailcap file consists of a series of lines which are comments,
8613 A comment line consists of a # character followed by anything you
8618 A blank line is blank.
8622 A definition line consists of a content type, a view command, and any
8623 number of optional fields. Each field of a definition line is
8624 dividedby a semicolon ';' character.
8628 The content type is specified in the MIME standard type/subtype
8631 <literal>text/plain, text/html, image/gif,</literal>
8632 etc. In addition, the mailcap format includes two formats for
8633 wildcards, one using the special '*' subtype, the other is the
8635 wild, where you only include the major type. For example, <literal>
8639 <literal>video,</literal> will match all image types and video types,
8644 The view command is a Unix command for viewing the type specified.
8646 are two different types of commands supported. The default is to send
8647 the body of the MIME message to the command on stdin. You can change
8648 this behavior by using %s as a parameter to your view command.
8649 This will cause Mutt-ng to save the body of the MIME message to a
8651 file, and then call the view command with the %s replaced by
8652 the name of the temporary file. In both cases, Mutt-ng will turn over
8654 terminal to the view program until the program quits, at which time
8656 will remove the temporary file if it exists.
8660 So, in the simplest form, you can send a text/plain message to the
8661 external pager more on stdin:
8664 text/plain; more</screen>
8666 Or, you could send the message as a file:
8669 text/plain; more %s</screen>
8671 Perhaps you would like to use lynx to interactively view a text/html
8675 text/html; lynx %s</screen>
8677 In this case, lynx does not support viewing a file from stdin, so you
8678 must use the %s syntax.
8679 <emphasis role="bold">Note:</emphasis> <emphasis>Some older versions
8680 of lynx contain a bug where they
8681 will check the mailcap file for a viewer for text/html. They will
8683 the line which calls lynx, and run it. This causes lynx to
8685 spawn itself to view the object.
8690 On the other hand, maybe you don't want to use lynx interactively,
8691 youjust want to have it convert the text/html to text/plain, then you
8696 text/html; lynx -dump %s | more</screen>
8701 Perhaps you wish to use lynx to view text/html files, and a pager on
8702 all other text formats, then you would use the following:
8706 text/*; more</screen>
8708 This is the simplest form of a mailcap file.
8713 <sect2 id="mime-mailcap-security">
8714 <title>Secure use of mailcap</title>
8717 The interpretation of shell meta-characters embedded in MIME
8719 can lead to security problems in general. Mutt-ng tries to quote
8721 in expansion of %s syntaxes properly, and avoids risky
8723 substituting them, see the <muttng-doc:varref name="mailcap_sanitize" link="mailcap-sanitize"/>
8728 Although mutt's procedures to invoke programs with mailcap seem to be
8729 safe, there are other applications parsing mailcap, maybe taking less
8731 of it. Therefore you should pay attention to the following rules:
8735 <emphasis>Keep the %-expandos away from shell quoting.</emphasis>
8736 Don't quote them with single or double quotes. Mutt-ng does this for
8737 you, the right way, as should any other program which interprets
8738 mailcap. Don't put them into backtick expansions. Be highly careful
8739 with eval statements, and avoid them if possible at all. Trying to
8741 broken behaviour with quotes introduces new leaks - there is no
8742 alternative to correct quoting in the first place.
8746 If you have to use the %-expandos' values in context where you
8748 quoting or backtick expansions, put that value into a shell variable
8749 and reference the shell variable where necessary, as in the following
8750 example (using <literal>$charset</literal> inside the backtick
8752 since it is not itself subject to any further expansion):
8758 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
8759 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1</screen>
8765 <sect2 id="mime-mailcap-advanced">
8766 <title>Advanced mailcap Usage</title>
8768 <sect3 id="mime-mailcap-advanced-fields">
8769 <title>Optional Fields</title>
8772 In addition to the required content-type and view command fields,
8774 can add semi-colon ';' separated fields to set flags and other
8776 Mutt-ng recognizes the following optional fields:
8780 <term>copiousoutput</term>
8783 This flag tells Mutt-ng that the command passes possibly
8785 text on stdout. This causes Mutt-ng to invoke a pager
8786 (either the internal
8787 pager or the external pager defined by the pager variable)
8789 of the view command. Without this flag, Mutt-ng assumes
8791 is interactive. One could use this to replace the pipe to <literal>
8794 in the <literal>lynx -dump</literal> example in the Basic
8798 text/html; lynx -dump %s ; copiousoutput</screen>
8800 This will cause lynx to format the text/html output as
8802 and Mutt-ng will use your standard pager to display the
8808 <term>needsterminal</term>
8811 Mutt-ng uses this flag when viewing attachments with <link linkend="auto-view">auto-view</link>,
8812 in order to decide whether it should honor the setting
8813 of the <muttng-doc:varref name="wait_key" link="wait-key"/> variable or
8814 not. When an attachment is viewed using an interactive
8816 corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt-ng will use
8817 <muttng-doc:varref name="wait_key" link="wait-key"/> and the exit
8818 statusof the program to decide if it will ask you to press
8820 external program has exited. In all other situations it
8827 <term>compose=<command></term>
8830 This flag specifies the command to use to create a new
8832 specific MIME type. Mutt-ng supports this from the compose
8838 <term>composetyped=<command></term>
8841 This flag specifies the command to use to create a new
8843 specific MIME type. This command differs from the compose
8845 that mutt will expect standard MIME headers on the data.
8847 used to specify parameters, filename, description, etc. for
8849 attachment. Mutt-ng supports this from the compose menu.
8854 <term>print=<command></term>
8857 This flag specifies the command to use to print a specific
8859 Mutt-ng supports this from the attachment and compose
8865 <term>edit=<command></term>
8868 This flag specifies the command to use to edit a specific
8870 Mutt-ng supports this from the compose menu, and also uses
8872 new attachments. Mutt-ng will default to the defined
8879 <term>nametemplate=<template></term>
8882 This field specifies the format for the file denoted by
8884 command fields. Certain programs will require a certain
8886 for instance, to correctly view a file. For instance, lynx
8888 interpret a file as <literal>text/html</literal> if the
8889 file ends in <literal>.html</literal>.
8890 So, you would specify lynx as a <literal>text/html</literal> viewer with a line in
8891 the mailcap file like:
8894 text/html; lynx %s; nametemplate=%s.html</screen>
8900 <term>test=<command></term>
8903 This field specifies a command to run to test whether this
8905 entry should be used. The command is defined with the
8907 rules defined in the next section. If the command returns
8909 test passed, and Mutt-ng uses this entry. If the command
8911 then the test failed, and Mutt-ng continues searching for
8913 <emphasis role="bold">Note:</emphasis> <emphasis>the
8914 content-type must match before Mutt-ng performs the test.
8919 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
8920 text/html; lynx %s</screen>
8922 In this example, Mutt-ng will run the program RunningX
8924 if the X Window manager is running, and non-zero if it
8926 RunningX returns 0, then Mutt-ng will call netscape to
8928 text/html object. If RunningX doesn't return 0, then
8930 to the next entry and use lynx to display the text/html
8940 <sect3 id="mime-mailcap-advanced-searchorder">
8941 <title>Search Order</title>
8944 When searching for an entry in the mailcap file, Mutt-ng will
8946 the most useful entry for its purpose. For instance, if you are
8947 attempting to print an <literal>image/gif</literal>, and you have
8949 entries in your mailcap file, Mutt-ng will search for an entry with
8955 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
8956 nametemplate=%s.gif</screen>
8958 Mutt-ng will skip the <literal>image/*</literal> entry and use the <literal>
8961 entry with the print command.
8965 In addition, you can use this with <link linkend="auto-view">auto-view</link>
8966 to denote two commands for viewing an attachment, one to be viewed
8967 automatically, the other to be viewed interactively from the
8969 menu. In addition, you can then use the test feature to determine
8971 viewer to use interactively depending on your environment.
8974 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
8975 text/html; lynx %s; nametemplate=%s.html
8976 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput</screen>
8978 For <link linkend="auto-view">auto-view</link>, Mutt-ng will choose
8980 entry because of the copiousoutput tag. For interactive viewing,
8982 will run the program RunningX to determine if it should use the
8984 entry. If the program returns non-zero, Mutt-ng will use the
8986 for interactive viewing.
8991 <sect3 id="mime-mailcap-advanced-expansion">
8992 <title>Command Expansion</title>
8995 The various commands defined in the mailcap files are passed to the
8996 <literal>/bin/sh</literal> shell using the system() function.
8998 command is passed to <literal>/bin/sh -c</literal>, it is parsed to
9000 various special parameters with information from Mutt-ng. The
9002 Mutt-ng expands are:
9009 As seen in the basic mailcap section, this variable is
9011 to a filename specified by the calling program. This file
9013 the body of the message to view/print/edit or where the
9015 program should place the results of composition. In
9017 use of this keyword causes Mutt-ng to not pass the body of
9019 to the view/print/edit program on stdin.
9027 Mutt-ng will expand %t to the text representation of
9029 type of the message in the same form as the first parameter
9031 mailcap definition line, ie <literal>text/html</literal> or
9032 <literal>image/gif</literal>.
9037 <term>%{<parameter>}</term>
9040 Mutt-ng will expand this to the value of the specified
9042 from the Content-Type: line of the mail message. For
9044 Your mail message contains:
9047 Content-Type: text/plain; charset=iso-8859-1</screen>
9049 then Mutt-ng will expand %{charset} to
9050 iso-8859-1. The default metamail
9051 mailcap file uses this feature to test the charset to spawn
9053 using the right charset to view the message.
9061 This will be replaced by a %
9066 Mutt-ng does not currently support the %F and %n
9068 specified in RFC 1524. The main purpose of these parameters is for
9069 multipart messages, which is handled internally by Mutt-ng.
9076 <sect2 id="mime-mailcap-examples">
9077 <title>Example mailcap files</title>
9080 This mailcap file is fairly simple and standard:
9083 # I'm always running X :)
9084 video/*; xanim %s > /dev/null
9085 image/*; xv %s > /dev/null
9087 # I'm always running netscape (if my computer had more memory, maybe)
9088 text/html; netscape -remote 'openURL(%s)'</screen>
9093 This mailcap file shows quite a number of examples:
9099 # Use xanim to view all videos Xanim produces a header on startup,
9100 # send that to /dev/null so I don't see it
9101 video/*; xanim %s > /dev/null
9103 # Send html to a running netscape by remote
9104 text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
9105 # If I'm not running netscape but I am running X, start netscape on the
9107 text/html; netscape %s; test=RunningX
9109 # Else use lynx to view it as text
9112 # This version would convert the text/html to text/plain
9113 text/html; lynx -dump %s; copiousoutput
9115 # I use enscript to print text in two columns to a page
9116 text/*; more %s; print=enscript -2Gr %s
9118 # Netscape adds a flag to tell itself to view jpegs internally
9119 image/jpeg;xv %s; x-mozilla-flags=internal
9121 # Use xv to view images if I'm running X
9122 # In addition, this uses the \ to extend the line and set my editor
9124 image/*;xv %s; test=RunningX; edit=xpaint %s
9126 # Convert images to text using the netpbm tools
9127 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
9128 pbmtoascii -1x2 ) 2>&1 ; copiousoutput
9130 # Send excel spreadsheets to my NT box
9131 application/ms-excel; open.pl %s</screen>
9143 <sect1 id="auto-view">
9144 <title>MIME Autoview</title>
9147 In addition to explicitly telling Mutt-ng to view an attachment with
9148 theMIME viewer defined in the mailcap file, Mutt-ng has support for
9149 automatically viewing MIME attachments while in the pager.
9153 To work, you must define a viewer in the mailcap file which uses the
9154 <literal>copiousoutput</literal> option to denote that it is
9156 Usually, you also use the entry to convert the attachment to a text
9157 representation which you can view in the pager.
9161 You then use the <literal>auto_view</literal> muttrc command to
9163 content-types that you wish to view automatically.
9167 For instance, if you set auto_view to:
9170 auto_view text/html application/x-gunzip application/postscript
9171 image/gif application/x-tar-gz</screen>
9176 Mutt-ng could use the following mailcap entries to automatically view
9177 attachments of these types.
9180 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
9181 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
9182 application/x-gunzip; gzcat; copiousoutput
9183 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
9184 application/postscript; ps2ascii %s; copiousoutput</screen>
9189 ``unauto_view'' can be used to remove previous entries from the
9191 This can be used with <muttng-doc:hook name="message"/> to autoview messages based on size,
9193 ``unauto_view *'' will remove all previous entries.
9202 <sect1 id="alternative-order">
9203 <title>MIME Multipart/Alternative</title>
9206 Mutt-ng has some heuristics for determining which attachment of a
9207 multipart/alternative type to display. First, mutt will check the
9208 alternative_order list to determine if one of the available
9209 typesis preferred. The alternative_order list consists of a
9211 MIME types in order, including support for implicit and explicit
9212 wildcards, for example:
9215 alternative_order text/enriched text/plain text
9216 application/postscript image/*</screen>
9221 Next, mutt will check if any of the types have a defined
9222 <link linkend="auto-view">auto-view</link>, and use that. Failing
9223 that, Mutt-ng will look for any text type. As a last attempt, mutt
9224 willlook for any type it knows how to handle.
9228 To remove a MIME type from the <literal>alternative_order</literal> list, use the
9229 <literal>unalternative_order</literal> command.
9238 <sect1 id="mime-lookup">
9239 <title>MIME Lookup</title>
9242 Mutt-ng's mime_lookup list specifies a list of mime-types that
9244 be treated according to their mailcap entry. This option is designed
9245 todeal with binary types such as application/octet-stream. When an
9247 mime-type is listed in mime_lookup, then the extension of the
9249 be compared to the list of extensions in the mime.types file. The
9251 associated with this extension will then be used to process the
9253 according to the rules in the mailcap file and according to any other
9255 options (such as auto_view) specified. Common usage would be:
9258 mime_lookup application/octet-stream application/X-Lotus-Manuscript</screen>
9263 In addition, the unmime_lookup command may be used to disable
9265 for any particular mime-type if it had been set, for example, in a
9283 <chapter id="security"> <!--{{{-->
9284 <title>Security Considerations</title>
9287 First of all, mutt-ng contains no security holes included by
9288 intention but may contain unknown security holes. As a consequence,
9289 please run mutt-ng only with as few permissions as possible.
9293 Please do not run mutt-ng as the super user.
9297 When configuring mutt-ng, there're some points to note about secure
9302 In practice, mutt-ng can be easily made as vulnerable as even the
9303 most insecure mail user agents (in their default configuration) just
9304 by changing mutt-ng's configuration files: it then can execute
9305 arbitrary programs and scripts attached to messages, send out private
9306 data on its own, etc. Although this is not believed to the common type
9307 of setup, please read this chapter carefully.
9310 <sect1 id="security-passwords">
9311 <title>Passwords</title>
9314 Although mutt-ng can be told the various passwords for accounts,
9315 please never store passwords in configuration files. Besides the
9316 fact that the system's operator can always read them, you could
9317 forget to replace the actual password with asterisks when reporting
9318 a bug or asking for help via, for example, a mailing list so that
9319 your mail including your password could be archived by internet
9320 search engines, etc. Please never store passwords on disk.
9325 <sect1 id="security-tempfiles">
9326 <title>Temporary Files</title>
9329 Mutt-ng uses many temporary files for viewing messages, verifying
9330 digital signatures, etc. The <muttng-doc:varref name="umask" link="umask"/>
9331 variable can be used to change the default permissions of these
9332 files. Please only change it if you really know what you are doing.
9333 Also, a different location for these files may be desired which can
9334 be changed via the <muttng-doc:varref name="tmpdir" link="tmpdir"/> variable.
9339 <sect1 id="security-leaks">
9340 <title>Information Leaks</title>
9342 <sect2 id="security-leaks-mid">
9343 <title>Message-ID: headers</title>
9346 In the default configuration, mutt-ng will leak some information
9347 to the outside world when sending messages: the generation of
9348 <literal>Message-ID:</literal> headers includes a step counter which
9350 (and rotated) with every message sent. If you'd like to hide this
9351 information probably telling others how many mail you sent in which
9352 time, you at least need to remove the <literal>%P</literal>
9354 default setting of the <muttng-doc:varref name="msgid_format" link="msgid-format"/> variable. Please make sure that
9355 you really know how local parts of these <literal>Message-ID:</literal> headers
9361 <sect2 id="security-leaks-mailto">
9362 <title>mailto:-style links</title>
9365 As mutt-ng be can be set up to be the mail client to handle
9366 <literal>mailto:</literal> style links in websites, there're security
9367 considerations, too. To keep the old behavior by default, mutt-ng
9368 will be strict in interpreting them which means that arbitrary
9369 header fields can be embedded in these links which could override
9370 existing header fields or attach arbitrary files. This may be
9371 problematic if the <muttng-doc:varref name="edit_headers" link="edit-headers"/>
9372 variable is <emphasis>unset</emphasis>, i.e. the
9373 user doesn't want to see header fields while editing the message.
9377 For example, following a link like
9383 mailto:joe@host?Attach=~/.gnupg/secring.gpg</screen>
9388 will send out the user's private gnupg keyring to <literal>joe@host</literal> if
9389 the user doesn't follow the information on screen carefully
9394 When <emphasis>unsetting</emphasis> the <muttng-doc:varref name="strict_mailto" link="strict-mailto"/>
9395 variable, mutt-ng will
9404 be less strict when interpreting these links by
9405 prepending a <literal>X-Mailto-</literal> string to all header
9407 embedded in such a link <emphasis>and</emphasis>
9414 turn on the <muttng-doc:varref name="edit_headers" link="edit-headers"/>
9416 force to let the user see all the headers
9417 (because they still may leak information.)
9430 <sect1 id="security-external">
9431 <title>External applications</title>
9434 Mutt-ng in many places has to rely on external applications or
9435 for convenience supports mechanisms involving external
9439 <sect2 id="security-external-mailcap">
9440 <title>mailcap</title>
9443 One of these is the <literal>mailcap</literal> mechanism as defined
9445 1524. Mutt-ng can be set up to <emphasis>automatically</emphasis>
9447 given utility as listed in one of the mailcap files (see the
9448 <muttng-doc:varref name="mailcap_path" link="mailcap-path"/>
9449 variable for details.)
9453 These utilities may have a variety of security vulnerabilities,
9454 including overwriting of arbitrary files, information leaks or
9455 other exploitable bugs. These vulnerabilities may go unnoticed by
9456 the user, especially when they are called automatically (and
9457 without interactive prompting) from the mailcap file(s). When
9458 using mutt-ng's autoview mechanism in combination with mailcap
9459 files, please be sure to...
9468 manually select trustworth applications with a reasonable
9476 periodically check the contents of mailcap files,
9477 especially after software installations or upgrades
9484 keep the software packages referenced in the mailcap file up to
9492 leave the <muttng-doc:varref name="mailcap_sanitize" link="mailcap-sanitize"/> variable in its default
9493 state to restrict mailcap expandos to a safe set of characters
9504 <sect2 id="security-external-other">
9505 <title>Other</title>
9508 Besides the mailcap mechanism, mutt-ng uses a number of other
9509 external utilities for operation.
9513 The same security considerations apply for these as for tools
9514 involved via mailcap (for example, mutt-ng is vulnerable to Denial
9515 of Service Attacks with compressed folders support if the
9516 uncompressed mailbox is too large for the disk it is saved to.)
9520 As already noted, most of these problems are not built in but
9521 caused by wrong configuration, so please check your configuration.
9531 <chapter id="reference"> <!--{{{-->
9532 <title>Reference</title>
9534 <sect1 id="commandline">
9535 <title>Command line options</title>
9538 Running <literal>mutt</literal> with no arguments will make Mutt-ng
9539 attempt to read your spool
9540 mailbox. However, it is possible to read other mailboxes and
9541 to send messages from the command line as well.
9547 <title>Reference: Command Line Options</title>
9548 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9551 <entry>Option</entry>
9552 <entry>Description</entry>
9557 <entry><literal>-A</literal></entry>
9558 <entry>expand an alias</entry>
9561 <entry><literal>-a</literal></entry>
9562 <entry>attach a file to a message</entry>
9565 <entry><literal>-b</literal></entry>
9566 <entry>specify a blind carbon-copy (BCC) address</entry>
9569 <entry><literal>-c</literal></entry>
9570 <entry>specify a carbon-copy (Cc) address</entry>
9573 <entry><literal>-e</literal></entry>
9574 <entry>specify a config command to be run after initialization files are read</entry>
9577 <entry><literal>-f</literal></entry>
9578 <entry>specify a mailbox to load</entry>
9581 <entry><literal>-F</literal></entry>
9582 <entry>specify an alternate file to read initialization commands</entry>
9585 <entry><literal>-h</literal></entry>
9586 <entry>print help on command line options</entry>
9589 <entry><literal>-H</literal></entry>
9590 <entry>specify a draft file from which to read a header and body</entry>
9593 <entry><literal>-i</literal></entry>
9594 <entry>specify a file to include in a message composition</entry>
9597 <entry><literal>-m</literal></entry>
9598 <entry>specify a default mailbox type</entry>
9601 <entry><literal>-n</literal></entry>
9602 <entry>do not read the system Muttngrc</entry>
9605 <entry><literal>-p</literal></entry>
9606 <entry>recall a postponed message</entry>
9609 <entry><literal>-Q</literal></entry>
9610 <entry>query a configuration variable</entry>
9613 <entry><literal>-R</literal></entry>
9614 <entry>open mailbox in read-only mode</entry>
9617 <entry><literal>-s</literal></entry>
9618 <entry>specify a subject (enclose in quotes if it contains spaces)</entry>
9621 <entry><literal>-t</literal></entry>
9622 <entry>dump the value of all variables to stdout</entry>
9625 <entry><literal>-T</literal></entry>
9626 <entry>dump the value of all changed variables to stdout</entry>
9629 <entry><literal>-v</literal></entry>
9630 <entry>show version number and compile-time definitions</entry>
9633 <entry><literal>-x</literal></entry>
9634 <entry>simulate the mailx(1) compose mode</entry>
9637 <entry><literal>-y</literal></entry>
9638 <entry>show a menu containing the files specified by the mailboxes command</entry>
9641 <entry><literal>-z</literal></entry>
9642 <entry>exit immediately if there are no messages in the mailbox</entry>
9645 <entry><literal>-Z</literal></entry>
9646 <entry>open the first folder with new message,exit immediately if none</entry>
9655 To read messages in a mailbox
9659 <literal>mutt</literal> ] -nz [ ] -F <emphasis>muttrc</emphasis> [ ] -m <emphasis>
9662 [ ] -f <emphasis>mailbox</emphasis> [
9666 To compose a new message
9670 <literal>mutt</literal> ] -n [ ] -F <emphasis>muttrc</emphasis> [ ] -a <emphasis>
9673 [ ] -c <emphasis>address</emphasis> [ ] -i <emphasis>
9676 [ ] -s <emphasis>subject</emphasis> [ <emphasis>address</emphasis> ] <emphasis>
9683 Mutt-ng also supports a ``batch'' mode to send prepared messages.
9685 input from the file you wish to send. For example,
9689 <literal>mutt -s "data set for run #2"
9690 professor@bigschool.edu
9696 This command will send a message to ``professor@bigschool.edu'' with a
9698 of ``data set for run #2''. In the body of the message will be the
9700 of the file ``~/run2.dat''.
9709 <sect1 id="patterns">
9710 <title>Patterns</title>
9714 <table id="tab-patterns">
9715 <title>Reference: Patterns</title>
9716 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9719 <entry>Pattern Modifier</entry>
9720 <entry>Argument</entry>
9721 <entry>Description</entry>
9726 <entry><muttng-doc:pattern name="A"/></entry>
9727 <entry><literal></literal></entry>
9728 <entry>all messages</entry>
9731 <entry><muttng-doc:pattern name="b"/></entry>
9732 <entry><literal>EXPR</literal></entry>
9733 <entry>messages which contain EXPR in the message body</entry>
9736 <entry><muttng-doc:pattern name="B"/></entry>
9737 <entry><literal>EXPR</literal></entry>
9738 <entry>messages which contain EXPR in the whole message</entry>
9741 <entry><muttng-doc:pattern name="c"/></entry>
9742 <entry><literal>EXPR</literal></entry>
9743 <entry>messages carbon-copied to EXPR</entry>
9746 <entry><muttng-doc:pattern name="C"/></entry>
9747 <entry><literal>EXPR</literal></entry>
9748 <entry>message is either to: or cc: EXPR</entry>
9751 <entry><muttng-doc:pattern name="D"/></entry>
9752 <entry><literal></literal></entry>
9753 <entry>deleted messages</entry>
9756 <entry><muttng-doc:pattern name="d"/></entry>
9757 <entry><literal>[MIN]-[MAX]</literal></entry>
9758 <entry>messages with ``date-sent'' in a Date range</entry>
9761 <entry><muttng-doc:pattern name="E"/></entry>
9762 <entry><literal></literal></entry>
9763 <entry>expired messages</entry>
9766 <entry><muttng-doc:pattern name="e"/></entry>
9767 <entry><literal>EXPR</literal></entry>
9768 <entry>message which contains EXPR in the ``Sender'' field</entry>
9771 <entry><muttng-doc:pattern name="F"/></entry>
9772 <entry><literal></literal></entry>
9773 <entry>flagged messages</entry>
9776 <entry><muttng-doc:pattern name="f"/></entry>
9777 <entry><literal>EXPR</literal></entry>
9778 <entry>messages originating from EXPR</entry>
9781 <entry><muttng-doc:pattern name="g"/></entry>
9782 <entry><literal></literal></entry>
9783 <entry>cryptographically signed messages</entry>
9786 <entry><muttng-doc:pattern name="G"/></entry>
9787 <entry><literal></literal></entry>
9788 <entry>cryptographically encrypted messages</entry>
9791 <entry><muttng-doc:pattern name="H"/></entry>
9792 <entry><literal>EXPR</literal></entry>
9793 <entry>messages with a spam attribute matching EXPR</entry>
9796 <entry><muttng-doc:pattern name="h"/></entry>
9797 <entry><literal>EXPR</literal></entry>
9798 <entry>messages which contain EXPR in the message header</entry>
9801 <entry><muttng-doc:pattern name="k"/></entry>
9802 <entry><literal></literal></entry>
9803 <entry>message contains PGP key material</entry>
9806 <entry><muttng-doc:pattern name="i"/></entry>
9807 <entry><literal>EXPR</literal></entry>
9808 <entry>message which match ID in the ``Message-ID'' field</entry>
9811 <entry><muttng-doc:pattern name="L"/></entry>
9812 <entry><literal>EXPR</literal></entry>
9813 <entry>message is either originated or received by EXPR</entry>
9816 <entry><muttng-doc:pattern name="l"/></entry>
9817 <entry><literal></literal></entry>
9818 <entry>message is addressed to a known mailing list</entry>
9821 <entry><muttng-doc:pattern name="m"/></entry>
9822 <entry><literal>[MIN]-[MAX]</literal></entry>
9823 <entry>message in the range MIN to MAX *)</entry>
9826 <entry><muttng-doc:pattern name="M"/></entry>
9827 <entry><literal></literal></entry>
9828 <entry>multipart messages</entry>
9831 <entry><muttng-doc:pattern name="n"/></entry>
9832 <entry><literal>[MIN]-[MAX]</literal></entry>
9833 <entry>messages with a score in the range MIN to MAX *)</entry>
9836 <entry><muttng-doc:pattern name="N"/></entry>
9837 <entry><literal></literal></entry>
9838 <entry>new messages</entry>
9841 <entry><muttng-doc:pattern name="O"/></entry>
9842 <entry><literal></literal></entry>
9843 <entry>old messages</entry>
9846 <entry><muttng-doc:pattern name="p"/></entry>
9847 <entry><literal></literal></entry>
9848 <entry>message is addressed to you (consults alternates)</entry>
9851 <entry><muttng-doc:pattern name="P"/></entry>
9852 <entry><literal></literal></entry>
9853 <entry>message is from you (consults alternates)</entry>
9856 <entry><muttng-doc:pattern name="Q"/></entry>
9857 <entry><literal></literal></entry>
9858 <entry>messages which have been replied to</entry>
9861 <entry><muttng-doc:pattern name="R"/></entry>
9862 <entry><literal></literal></entry>
9863 <entry>read messages</entry>
9866 <entry><muttng-doc:pattern name="r"/></entry>
9867 <entry><literal>[MIN]-[MAX]</literal></entry>
9868 <entry>messages with ``date-received'' in a Date range</entry>
9871 <entry><muttng-doc:pattern name="S"/></entry>
9872 <entry><literal></literal></entry>
9873 <entry>superseded messages</entry>
9876 <entry><muttng-doc:pattern name="s"/></entry>
9877 <entry><literal>EXPR</literal></entry>
9878 <entry>messages having EXPR in the ``Subject'' field.</entry>
9881 <entry><muttng-doc:pattern name="T"/></entry>
9882 <entry><literal></literal></entry>
9883 <entry>tagged messages</entry>
9886 <entry><muttng-doc:pattern name="t"/></entry>
9887 <entry><literal>EXPR</literal></entry>
9888 <entry>messages addressed to EXPR</entry>
9891 <entry><muttng-doc:pattern name="U"/></entry>
9892 <entry><literal></literal></entry>
9893 <entry>unread messages</entry>
9896 <entry><muttng-doc:pattern name="u"/></entry>
9897 <entry><literal></literal></entry>
9898 <entry>message is addressed to a subscribed mailing list</entry>
9901 <entry><muttng-doc:pattern name="v"/></entry>
9902 <entry><literal></literal></entry>
9903 <entry>message is part of a collapsed thread.</entry>
9906 <entry><muttng-doc:pattern name="V"/></entry>
9907 <entry><literal></literal></entry>
9908 <entry>cryptographically verified messages</entry>
9911 <entry><muttng-doc:pattern name="w"/></entry>
9912 <entry><literal>EXPR</literal></entry>
9913 <entry>messages which contain EXPR in the `Newsgroups' field (if compiled with NNTP support)</entry>
9916 <entry><muttng-doc:pattern name="x"/></entry>
9917 <entry><literal>EXPR</literal></entry>
9918 <entry>messages which contain EXPR in the `References' field</entry>
9921 <entry><muttng-doc:pattern name="y"/></entry>
9922 <entry><literal>EXPR</literal></entry>
9923 <entry>messages which contain EXPR in the `X-Label' field</entry>
9926 <entry><muttng-doc:pattern name="z"/></entry>
9927 <entry><literal>[MIN]-[MAX]</literal></entry>
9928 <entry>messages with a size in the range MIN to MAX *)</entry>
9931 <entry><muttng-doc:pattern name="="/></entry>
9932 <entry><literal></literal></entry>
9933 <entry>duplicated messages (see $duplicate_threads)</entry>
9936 <entry><muttng-doc:pattern name="$"/></entry>
9937 <entry><literal></literal></entry>
9938 <entry>unreferenced messages (requires threaded view)</entry>
9941 <entry><muttng-doc:pattern name="*"/></entry>
9942 <entry><literal></literal></entry>
9943 <entry>``From'' contains realname and (syntactically) valid address
9944 (excluded are addresses matching against alternates or any alias)</entry>
9953 <link linkend="advanced-regexp">regexp</link>. Special attention has to be
9954 made when using regular expressions inside of patterns. Specifically,
9955 Mutt-ng's parser for these patterns will strip one level of backslash
9957 which is normally used for quoting. If it is your intention to use a
9958 backslash in the regular expression, you will need to use two
9964 *) The forms <literal><[MAX]</literal>, <literal>>[MIN]</literal>,
9965 <literal>[MIN]-</literal> and <literal>-[MAX]</literal>
9971 <sect1 id="commands">
9972 <title>Configuration Commands</title>
9975 The following are the commands understood by mutt.
9985 <muttng-doc:hook name="account"/>
9987 <emphasis>pattern</emphasis> <emphasis>command</emphasis>
9994 <link linkend="alias">alias</link>
9996 <emphasis>key</emphasis> <emphasis>address</emphasis> ] , <emphasis>
10006 <link linkend="alias">alias</link>
10008 ] * | <emphasis>key</emphasis> ... [
10015 <link linkend="alternates">alternates</link>
10017 <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
10025 <link linkend="alternates">alternates</link>
10027 ] * | <emphasis>regexp</emphasis> ... [
10034 <link linkend="alternative-order">alternative-order</link>
10036 <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
10043 <link linkend="alternative-order">alternative-order</link>
10045 <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
10052 <muttng-doc:hook name="append"/>
10054 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10061 <link linkend="auto-view">auto-view</link>
10063 <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
10070 <link linkend="auto-view">auto-view</link>
10072 <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
10079 <link linkend="bind">bind</link>
10081 <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>
10090 <muttng-doc:hook name="charset"/>
10092 <emphasis>alias</emphasis> <emphasis>charset</emphasis>
10099 <muttng-doc:hook name="close"/>
10101 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10108 <link linkend="color">color</link>
10110 <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>
10113 ] <emphasis>regexp</emphasis> [
10120 <link linkend="color">color</link>
10122 <emphasis>index</emphasis> <emphasis>pattern</emphasis> ] <emphasis>
10132 <link linkend="exec">exec</link>
10134 <emphasis>function</emphasis> ] <emphasis>function</emphasis> ... [
10141 <muttng-doc:hook name="fcc"/>
10143 <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10150 <muttng-doc:hook name="fcc-save"/>
10152 <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10159 <muttng-doc:hook name="folder"/>
10161 <emphasis>pattern</emphasis> <emphasis>command</emphasis>
10168 <link linkend="hdr-order">hdr-order</link>
10170 <emphasis>header</emphasis> ] <emphasis>header</emphasis>
10178 <link linkend="hdr-order">hdr-order</link>
10180 <emphasis>header</emphasis> ] <emphasis>header</emphasis>
10188 <muttng-doc:hook name="charset"/>
10190 <emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
10197 <link linkend="ignore">ignore</link>
10199 <emphasis>pattern</emphasis> ] <emphasis>pattern</emphasis>
10207 <link linkend="ignore">ignore</link>
10209 <emphasis>pattern</emphasis> ] <emphasis>pattern</emphasis>
10217 <link linkend="lists">lists</link>
10219 <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
10227 <link linkend="lists">lists</link>
10229 <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
10237 <link linkend="macro">macro</link>
10239 <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>
10242 ] <emphasis>description</emphasis> [
10249 <link linkend="mailboxes">mailboxes</link>
10251 <emphasis>filename</emphasis> ] <emphasis>filename</emphasis> ... [
10258 <muttng-doc:hook name="mbox"/>
10260 <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10267 <muttng-doc:hook name="message"/>
10269 <emphasis>pattern</emphasis> <emphasis>command</emphasis>
10276 <link linkend="mime-lookup">mime-lookup</link>
10278 <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
10285 <link linkend="mime-lookup">mime-lookup</link>
10287 <emphasis>mimetype</emphasis> ] <emphasis>mimetype</emphasis> ... [
10294 <link linkend="color">color</link>
10296 <emphasis>object attribute</emphasis> ] <emphasis>regexp</emphasis> [
10303 <link linkend="color">color</link>
10305 <emphasis>index</emphasis> <emphasis>pattern</emphasis> ] <emphasis>
10315 <link linkend="my-hdr">my-hdr</link>
10317 <emphasis>string</emphasis>
10324 <link linkend="my-hdr">my-hdr</link>
10326 <emphasis>field</emphasis> ] <emphasis>field</emphasis> ...
10334 <muttng-doc:hook name="open"/>
10336 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10343 <muttng-doc:hook name="crypt"/>
10345 <emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
10352 <link linkend="push">push</link>
10354 <emphasis>string</emphasis>
10361 <link linkend="set">set</link>
10363 <emphasis>variable</emphasis> ]<emphasis>variable</emphasis>
10371 <muttng-doc:hook name="save"/>
10373 <emphasis>regexp</emphasis> <emphasis>filename</emphasis>
10380 <link linkend="score-command">score-command</link>
10382 <emphasis>pattern</emphasis> <emphasis>value</emphasis>
10389 <link linkend="score-command">score-command</link>
10391 <emphasis>pattern</emphasis> ] <emphasis>pattern</emphasis>
10399 <muttng-doc:hook name="send"/>
10401 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10408 <muttng-doc:hook name="reply"/>
10410 <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10417 <link linkend="set">set</link>
10419 ]no|inv[<emphasis>variable</emphasis>]=<emphasis>
10422 [ ] <emphasis>variable</emphasis> ... [
10429 <link linkend="set">set</link>
10431 <emphasis>variable</emphasis> ]<emphasis>variable</emphasis>
10439 <link linkend="source">source</link>
10441 <emphasis>filename</emphasis>
10448 <link linkend="spam">spam</link>
10450 <emphasis>pattern</emphasis> <emphasis>format</emphasis>
10457 <link linkend="spam">spam</link>
10459 <emphasis>pattern</emphasis>
10466 <link linkend="lists">lists</link>
10468 <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
10476 <link linkend="lists">lists</link>
10478 <emphasis>regexp</emphasis> ] <emphasis>regexp</emphasis>
10486 <link linkend="set">set</link>
10488 <emphasis>variable</emphasis> ]<emphasis>variable</emphasis>
10496 <link linkend="unhook">unhook</link>
10498 <emphasis>hook-type</emphasis>
10508 <sect1 id="variables">
10509 <title>Configuration variables</title>
10512 The following list contains all variables which, in the process of
10513 providing more consistency, have been renamed and are partially even
10514 removed already. The left column contains the old synonym variables,
10515 the right column the full/new name:
10519 <anchor id="sect-obsolete"/>
10522 <title>Reference: Obsolete Variables</title>
10523 <tgroup cols="2" align="left" colsep="1" rowsep="1">
10526 <entry>Old Name</entry>
10527 <entry>New Name</entry>
10532 <entry><literal>edit_hdrs</literal></entry>
10533 <entry><muttng-doc:varref name="edit_headers" link="edit-headers"/></entry>
10536 <entry><literal>forw_decode</literal></entry>
10537 <entry><muttng-doc:varref name="forward_decode" link="forward-decode"/></entry>
10540 <entry><literal>forw_format</literal></entry>
10541 <entry><muttng-doc:varref name="forward_format" link="forward-format"/></entry>
10544 <entry><literal>forw_quote</literal></entry>
10545 <entry><muttng-doc:varref name="forward_quote" link="forward-quote"/></entry>
10548 <entry><literal>hdr_format</literal></entry>
10549 <entry><muttng-doc:varref name="index_format" link="index-format"/></entry>
10552 <entry><literal>indent_str</literal></entry>
10553 <entry><muttng-doc:varref name="indent_string" link="indent-string"/></entry>
10556 <entry><literal>mime_fwd</literal></entry>
10557 <entry><muttng-doc:varref name="mime_forward" link="mime-forward"/></entry>
10560 <entry><literal>msg_format</literal></entry>
10561 <entry><muttng-doc:varref name="message_format" link="message-format"/></entry>
10564 <entry><literal>pgp_autosign</literal></entry>
10565 <entry><muttng-doc:varref name="crypt_autosign" link="crypt-autosign"/></entry>
10568 <entry><literal>pgp_autoencrypt</literal></entry>
10569 <entry><muttng-doc:varref name="crypt_autoencrypt" link="crypt-autoencrypt"/></entry>
10572 <entry><literal>pgp_replyencrypt</literal></entry>
10573 <entry><muttng-doc:varref name="crypt_replyencrypt" link="crypt-replyencrypt"/></entry>
10576 <entry><literal>pgp_replysign</literal></entry>
10577 <entry><muttng-doc:varref name="crypt_replysign" link="crypt-replysign"/></entry>
10580 <entry><literal>pgp_replysignencrypted</literal></entry>
10581 <entry><muttng-doc:varref name="crypt_replysignencrypted" link="crypt-replysignencrypted"/></entry>
10584 <entry><literal>pgp_verify_sig</literal></entry>
10585 <entry><muttng-doc:varref name="crypt_verify_sig" link="crypt-verify-sig"/></entry>
10588 <entry><literal>pgp_create_traditional</literal></entry>
10589 <entry><muttng-doc:varref name="pgp_autoinline" link="pgp-autoinline"/></entry>
10592 <entry><literal>pgp_auto_traditional</literal></entry>
10593 <entry><muttng-doc:varref name="pgp_replyinline" link="pgp-replyinline"/></entry>
10596 <entry><literal>forw_decrypt</literal></entry>
10597 <entry><muttng-doc:varref name="forward_decrypt" link="forward-decrypt"/></entry>
10600 <entry><literal>smime_sign_as</literal></entry>
10601 <entry><muttng-doc:varref name="smime_default_key" link="smime-default-key"/></entry>
10604 <entry><literal>post_indent_str</literal></entry>
10605 <entry><muttng-doc:varref name="post_indent_string" link="post-indent-string"/></entry>
10608 <entry><literal>print_cmd</literal></entry>
10609 <entry><muttng-doc:varref name="print_command" link="print-command"/></entry>
10612 <entry><literal>shorten_hierarchy</literal></entry>
10613 <entry><muttng-doc:varref name="sidebar_shorten_hierarchy" link="sidebar-shorten-hierarchy"/></entry>
10616 <entry><literal>ask_followup_to</literal></entry>
10617 <entry><muttng-doc:varref name="nntp_ask_followup_to" link="nntp-ask-followup-to"/></entry>
10620 <entry><literal>ask_x_comment_to</literal></entry>
10621 <entry><muttng-doc:varref name="nntp_ask_x_comment_to" link="nntp-ask-x-comment-to"/></entry>
10624 <entry><literal>catchup_newsgroup</literal></entry>
10625 <entry><muttng-doc:varref name="nntp_catchup" link="nntp-catchup"/></entry>
10628 <entry><literal>followup_to_poster</literal></entry>
10629 <entry><muttng-doc:varref name="nntp_followup_to_poster" link="nntp-followup-to-poster"/></entry>
10632 <entry><literal>group_index_format</literal></entry>
10633 <entry><muttng-doc:varref name="nntp_group_index_format" link="nntp-group-index-format"/></entry>
10636 <entry><literal>inews</literal></entry>
10637 <entry><muttng-doc:varref name="nntp_inews" link="nntp-inews"/></entry>
10640 <entry><literal>mime_subject</literal></entry>
10641 <entry><muttng-doc:varref name="nntp_mime_subject" link="nntp-mime-subject"/></entry>
10644 <entry><literal>news_cache_dir</literal></entry>
10645 <entry><muttng-doc:varref name="nntp_cache_dir" link="nntp-cache-dir"/></entry>
10648 <entry><literal>news_server</literal></entry>
10649 <entry><muttng-doc:varref name="nntp_host" link="nntp-host"/></entry>
10652 <entry><literal>newsrc</literal></entry>
10653 <entry><muttng-doc:varref name="nntp_newsrc" link="nntp-newsrc"/></entry>
10656 <entry><literal>nntp_poll</literal></entry>
10657 <entry><muttng-doc:varref name="nntp_mail_check" link="nntp-mail-check"/></entry>
10660 <entry><literal>pop_checkinterval</literal></entry>
10661 <entry><muttng-doc:varref name="pop_mail_check" link="pop-mail-check"/></entry>
10664 <entry><literal>post_moderated</literal></entry>
10665 <entry><muttng-doc:varref name="nntp_post_moderated" link="nntp-post-moderated"/></entry>
10668 <entry><literal>save_unsubscribed</literal></entry>
10669 <entry><muttng-doc:varref name="nntp_save_unsubscribed" link="nntp-save-unsubscribed"/></entry>
10672 <entry><literal>show_new_news</literal></entry>
10673 <entry><muttng-doc:varref name="nntp_show_new_news" link="nntp-show-new-news"/></entry>
10676 <entry><literal>show_only_unread</literal></entry>
10677 <entry><muttng-doc:varref name="nntp_show_only_unread" link="nntp-show-only-unread"/></entry>
10680 <entry><literal>x_comment_to</literal></entry>
10681 <entry><muttng-doc:varref name="nntp_x_comment_to" link="nntp-x-comment-to"/></entry>
10684 <entry><literal>smtp_auth_username</literal></entry>
10685 <entry><muttng-doc:varref name="smtp_user" link="smtp-user"/></entry>
10688 <entry><literal>smtp_auth_password</literal></entry>
10689 <entry><muttng-doc:varref name="smtp_pass" link="smtp-pass"/></entry>
10692 <entry><literal>user_agent</literal></entry>
10693 <entry><muttng-doc:varref name="agent_string" link="agent-string"/></entry>
10702 The <literal>contrib</literal> subdirectory contains a script named
10703 <literal>update-config.pl</literal> which eases migration.
10707 A complete list of current variables follows.