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 <muttng-doc:web url="http://www.muttng.org/"/>
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 <muttng-doc:web url="http://mutt-ng.berlios.de/snapshots/"/>
123 Visit channel <emphasis>#muttng</emphasis> on <ulink
124 url="http://www.freenode.net/">irc.freenode.net
125 (www.freenode.net) </ulink> to chat with other people
126 interested in Mutt-ng.
132 <title>Weblog</title>
135 If you want to read fresh news about the latest development in
136 Mutt-ng, and get informed about stuff like interesting,
137 Mutt-ng-related articles and packages for your favorite
138 distribution, you can read and/or subscribe to our <ulink
139 url="http://mutt-ng.supersized.org/">Mutt-ng development
145 <sect1 id="copyright">
146 <title>Copyright</title>
149 Mutt is Copyright (C) 1996-2000 Michael R. Elkins
150 <me@cs.hmc.edu> and others
154 This program is free software; you can redistribute it and/or modify
155 it under the terms of the GNU General Public License as published by
156 the Free Software Foundation; either version 2 of the License, or
157 (at your option) any later version.
161 This program is distributed in the hope that it will be useful,
162 but WITHOUT ANY WARRANTY; without even the implied warranty of
163 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
164 GNU General Public License for more details.
168 You should have received a copy of the GNU General Public License
169 along with this program; if not, write to the Free Software
170 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
175 <sect1 id="conventions">
176 <title>Manual Conventions</title>
179 This manual contains several (hopefully consistent) conventions to
180 specially layout different items in different fashions.
186 <para>Configuration and environment variables will be printed
187 in a typewriter font and both prefixed with a dollar sign as
188 it's common for UNIX-like environments. Configuration
189 variables are lower-case only while environment variables
190 are upper-case only.</para>
193 <para>Muttng-specific commands are enclosed in
194 <literal><></literal> and printed in a typewriter font,
198 <para>As common for UNIX-like environments, references to
199 manual pages are printed with the section enclosed in
200 braces, as in <muttng-doc:man name="vi"/> or <muttng-doc:man
201 name="muttngrc" sect="5"/>. Execute <literal>man [section]
202 [name]</literal> to view the manual page.</para>
208 If, while reading this fine manual, you find any inconsistencies
209 of whatever kind, please contact the developers via
210 <email>mutt-ng-devel@lists.berlios.de</email> to report it.
218 <chapter id="getting-started"> <!--{{{-->
219 <title>Getting Started</title>
221 <sect1 id="basic-concepts"> <!--{{{-->
222 <title>Basic Concepts</title>
224 <sect2 id="concept-screens-and-menus"> <!--{{{-->
225 <title>Screens and Menus</title>
228 mutt-ng offers different screens of which every has its special
238 The <emphasis>index</emphasis> displays the contents of the
247 The <emphasis>pager</emphasis> is responsible for displaying
249 is, the header, the body and all attached parts.
256 The <emphasis>file browser</emphasis> offers operations on and
258 information of all folders mutt-ng should watch for mail.
265 The <emphasis>sidebar</emphasis> offers a permanent view of
267 contain how many total, new and/or flagged mails.
274 The <emphasis>help screen</emphasis> lists for all currently
276 commands how to invoke them as well as a short description.
283 The <emphasis>compose</emphasis> menu is a comfortable
285 actions before sending mail: change subjects, attach files,
294 The <emphasis>attachement</emphasis> menu gives a summary and
296 structure of the attachements of the current message.
303 The <emphasis>alias</emphasis> menu lists all or a fraction of
312 The <emphasis>key</emphasis> menu used in connection with
314 users choose the right key to encrypt with.
324 When mutt-ng is started without any further options, it'll open
325 the users default mailbox and display the index.
335 <sect2 id="concept-configuration"> <!--{{{-->
336 <title>Configuration</title>
339 Mutt-ng does <emphasis>not</emphasis> feature an internal
341 interface or menu due to the simple fact that this would be too
342 complex to handle (currently there are several <emphasis>hundred</emphasis>
343 variables which fine-tune the behaviour.)
347 Mutt-ng is configured using configuration files which allow
348 users to add comments or manage them via version control systems
353 Also, mutt-ng comes with a shell script named <literal>grml-muttng</literal>
354 kindly contributed by users which really helps and eases the
355 creation of a user's configuration file. When downloading the
356 source code via a snapshot or via subversion, it can be found in
357 the <literal>contrib</literal> directory.
367 <sect2 id="concept-functions"> <!--{{{-->
368 <title>Functions</title>
371 Mutt-ng offers great flexibility due to the use of functions:
372 internally, every action a user can make mutt-ng perform is named
373 ``function.'' Those functions are assigned to keys (or even key
374 sequences) and may be completely adjusted to user's needs. The
375 basic idea is that the impatient users get a very intuitive
376 interface to start off with and advanced users virtually get no
377 limits to adjustments.
387 <sect2 id="concept-interaction"> <!--{{{-->
388 <title>Interaction</title>
391 Mutt-ng has two basic concepts of user interaction:
400 There is one dedicated line on the screen used to query
401 the user for input, issue any command, query variables and
402 display error and informational messages. As for every type of
403 user input, this requires manual action leading to the need of
411 The automatized interface for interaction are the so
412 called <emphasis>hooks</emphasis>. Hooks specify actions the
414 performed at well-defined situations: what to do when entering
415 which folder, what to do when displaying or replying to what
416 kind of message, etc. These are optional, i.e. a user doesn't
417 need to specify them but can do so.
433 <sect2 id="concept-modularization"> <!--{{{-->
434 <title>Modularization</title>
437 Although mutt-ng has many functionality built-in, many
438 features can be delegated to external tools to increase
439 flexibility: users can define programs to filter a message through
440 before displaying, users can use any program they want for
441 displaying a message, message types (such as PDF or PostScript)
442 for which mutt-ng doesn't have a built-in filter can be rendered
443 by arbitrary tools and so forth. Although mutt-ng has an alias
444 mechanism built-in, it features using external tools to query for
445 nearly every type of addresses from sources like LDAP, databases
446 or just the list of locally known users.
456 <sect2 id="concept-patterns"> <!--{{{-->
457 <title>Patterns</title>
460 Mutt-ng has a built-in pattern matching ``language'' which is
461 as widely used as possible to present a consistent interface to
462 users. The same ``pattern terms'' can be used for searching,
463 scoring, message selection and much more.
481 <sect1 id="screens-and-menus"> <!--{{{-->
482 <title>Screens and Menus</title>
484 <sect2 id="intro-index">
488 The index is the screen that you usually see first when you
489 start mutt-ng. It gives an overview over your emails in the
490 currently opened mailbox. By default, this is your system mailbox.
491 The information you see in the index is a list of emails, each with
492 its number on the left, its flags (new email, important email,
493 email that has been forwarded or replied to, tagged email, ...),
494 the date when email was sent, its sender, the email size, and the
495 subject. Additionally, the index also shows thread hierarchies:
496 when you reply to an email, and the other person replies back, you
497 can see the other's person email in a "sub-tree" below. This is
498 especially useful for personal email between a group of people or
499 when you've subscribed to mailing lists.
508 <sect2 id="intro-pager">
512 The pager is responsible for showing the email content. On the
513 top of the pager you have an overview over the most important email
514 headers like the sender, the recipient, the subject, and much more
515 information. How much information you actually see depends on your
516 configuration, which we'll describe below.
520 Below the headers, you see the email body which usually contains
521 the message. If the email contains any attachments, you will see
522 more information about them below the email body, or, if the
523 attachments are text files, you can view them directly in the
528 To give the user a good overview, it is possible to configure
529 mutt-ng to show different things in the pager with different
530 colors. Virtually everything that can be described with a regular
531 expression can be colored, e.g. URLs, email addresses or smileys.
540 <sect2 id="intro-browser">
541 <title>File Browser</title>
544 The file browser is the interface to the local or remote
545 file system. When selecting a mailbox to open, the browser allows
546 custom sorting of items, limiting the items shown by a regular
547 expression and a freely adjustable format of what to display in
548 which way. It also allows for easy navigation through the
549 file system when selecting file(s) to attach to a message, select
550 multiple files to attach and many more.
559 <sect2 id="intro-sidebar">
560 <title>Sidebar</title>
563 The sidebar comes in handy to manage mails which are spread
564 over different folders. All folders users setup mutt-ng to watch
565 for new mail will be listed. The listing includes not only the
566 name but also the number of total messages, the number of new and
567 flagged messages. Items with new mail may be colored different
568 from those with flagged mail, items may be shortened or compress
569 if they're they to long to be printed in full form so that by
570 abbreviated names, user still now what the name stands for.
579 <sect2 id="intro-help">
583 The help screen is meant to offer a quick help to the user. It
584 lists the current configuration of key bindings and their
585 associated commands including a short description, and currently
586 unbound functions that still need to be associated with a key
587 binding (or alternatively, they can be called via the mutt-ng
597 <sect2 id="intro-compose">
598 <title>Compose Menu</title>
601 The compose menu features a split screen containing the
602 information which really matter before actually sending a
603 message by mail or posting an article to a newsgroup: who gets
604 the message as what (recipient, newsgroup, who gets what kind of
605 copy). Additionally, users may set security options like
606 deciding whether to sign, encrypt or sign and encrypt a message
611 Also, it's used to attach messages, news articles or files to
612 a message, to re-edit any attachment including the message
622 <sect2 id="intro-alias">
623 <title>Alias Menu</title>
626 The alias menu is used to help users finding the recipients
627 of messages. For users who need to contact many people, there's
628 no need to remember addresses or names completely because it
629 allows for searching, too. The alias mechanism and thus the
630 alias menu also features grouping several addresses by a shorter
631 nickname, the actual alias, so that users don't have to select
632 each single recipient manually.
641 <sect2 id="intro-attach">
642 <title>Attachment Menu</title>
645 As will be later discussed in detail, mutt-ng features a good
646 and stable MIME implementation, that is, is greatly supports
647 sending and receiving messages of arbitrary type. The
648 attachment menu displays a message's structure in detail: what
649 content parts are attached to which parent part (which gives a
650 true tree structure), which type is of what type and what size.
651 Single parts may saved, deleted or modified to offer great and
652 easy access to message's internals.
661 <sect2 id="intro-keysel">
662 <title>Key Menu</title>
665 <literal>FIXME</literal>
681 <sect1 id="moving"> <!--{{{-->
682 <title>Moving Around in Menus</title>
685 Information is presented in menus, very similar to ELM. Here is a
686 tableshowing the common keys used to navigate menus in Mutt-ng.
691 <table frame="none" rowsep="1">
692 <title>Most commonly used movement bindings</title>
693 <tgroup cols="3" align="left" colsep="1" rowsep="1">
697 <entry>Function</entry>
698 <entry>Description</entry>
703 <entry><literal>j</literal> or <literal>Down</literal></entry>
704 <entry><muttng-doc:funcref name="next-entry"/></entry>
705 <entry>move to the next entry</entry>
708 <entry><literal>k</literal> or <literal>Up</literal></entry>
709 <entry><muttng-doc:funcref name="previous-entry"/></entry>
710 <entry>move to the previous entry</entry>
713 <entry><literal>z</literal> or <literal>PageDn</literal></entry>
714 <entry><muttng-doc:funcref name="page-down"/></entry>
715 <entry>go to the next page</entry>
718 <entry><literal>Z</literal> or <literal>PageUp</literal></entry>
719 <entry><muttng-doc:funcref name="page-up"/></entry>
720 <entry>go to the previous page</entry>
723 <entry><literal>=</literal> or <literal>Home</literal></entry>
724 <entry><muttng-doc:funcref name="first-entry"/></entry>
725 <entry>jump to the first entry</entry>
728 <entry><literal>*</literal> or <literal>End</literal></entry>
729 <entry><muttng-doc:funcref name="last-entry"/></entry>
730 <entry>jump to the last entry</entry>
733 <entry><literal>q</literal></entry>
734 <entry><muttng-doc:funcref name="quit"/></entry>
735 <entry>exit the current menu</entry>
738 <entry><literal>?</literal></entry>
739 <entry><muttng-doc:funcref name="help"/></entry>
740 <entry>list all key bindings for the current menu</entry>
756 <sect1 id="editing"> <!--{{{-->
757 <title>Editing Input Fields</title>
760 Mutt-ng has a builtin line editor which is used as the primary way to
762 textual data such as email addresses or filenames. The keys used to
764 around while editing are very similar to those of Emacs.
769 <table frame="none" rowsep="1">
770 <title>Line Editor Functions</title>
771 <tgroup cols="3" align="left" colsep="1" rowsep="1">
775 <entry>Function</entry>
776 <entry>Description</entry>
781 <entry><literal>^A or <Home> </literal></entry>
782 <entry><muttng-doc:funcref name="bol"/></entry>
783 <entry>move to the start of the line</entry>
786 <entry><literal>^B or <Left> </literal></entry>
787 <entry><muttng-doc:funcref name="backward-char"/>
788 </entry><entry>move back one char</entry>
791 <entry><literal>Esc B </literal></entry>
792 <entry><muttng-doc:funcref name="backward-word"/></entry>
793 <entry>move back one word</entry>
796 <entry><literal>^D or <Delete> </literal></entry>
797 <entry><muttng-doc:funcref name="delete-char"/></entry>
798 <entry>delete the char under the cursor</entry>
801 <entry><literal>^E or <End> </literal></entry>
802 <entry><muttng-doc:funcref name="eol"/></entry>
803 <entry>move to the end of the line</entry>
806 <entry><literal>^F or <Right> </literal></entry>
807 <entry><muttng-doc:funcref name="forward-char"/></entry>
808 <entry>move forward one char</entry>
811 <entry><literal>Esc F </literal></entry>
812 <entry><muttng-doc:funcref name="forward-word"/></entry>
813 <entry>move forward one word</entry>
816 <entry><literal><Tab></literal></entry>
817 <entry><muttng-doc:funcref name="complete"/></entry>
818 <entry>complete filename or alias</entry>
821 <entry><literal>^T</literal></entry>
822 <entry><muttng-doc:funcref name="complete-query"/></entry>
823 <entry>complete address with query</entry>
826 <entry><literal>^K</literal></entry>
827 <entry><muttng-doc:funcref name="kill-eol"/></entry>
828 <entry>delete to the end of the line</entry>
831 <entry><literal>ESC d </literal></entry>
832 <entry><muttng-doc:funcref name="kill-eow"/></entry>
833 <entry>delete to the end of the word</entry>
836 <entry><literal>^W</literal></entry>
837 <entry><muttng-doc:funcref name="kill-word"/></entry>
838 <entry>kill the word in front of the cursor</entry>
841 <entry><literal>^U</literal></entry>
842 <entry><muttng-doc:funcref name="kill-line"/></entry>
843 <entry>delete entire line</entry>
846 <entry><literal>^V</literal></entry>
847 <entry><muttng-doc:funcref name="quote-char"/></entry>
848 <entry>quote the next typed key</entry>
851 <entry><literal><Up></literal></entry>
852 <entry><muttng-doc:funcref name="history-up"/></entry>
853 <entry>recall previous string from history</entry>
856 <entry><literal><Down></literal></entry>
857 <entry><muttng-doc:funcref name="history-down"/></entry>
858 <entry>recall next string from history</entry>
861 <entry><literal><BackSpace></literal></entry>
862 <entry><muttng-doc:funcref name="backspace"/></entry>
863 <entry>kill the char in front of the cursor</entry>
866 <entry><literal>Esc u </literal></entry>
867 <entry><muttng-doc:funcref name="upcase-word"/></entry>
868 <entry>convert word to upper case</entry>
871 <entry><literal>Esc l </literal></entry>
872 <entry><muttng-doc:funcref name="downcase-word"/></entry>
873 <entry>convert word to lower case</entry>
876 <entry><literal>Esc c </literal></entry>
877 <entry><muttng-doc:funcref name="capitalize-word"/></entry>
878 <entry>capitalize the word</entry>
881 <entry><literal>^G</literal></entry>
882 <entry><literal>n/a</literal></entry>
886 <entry><literal><Return></literal></entry>
887 <entry><literal>n/a</literal></entry>
888 <entry>finish editing</entry>
897 You can remap the <emphasis>editor</emphasis> functions using the
898 <muttng-doc:command name="bind"/> command. For example, to make
899 the <emphasis>Delete</emphasis> key delete the character in front
900 of the cursor rather than under, you could use
904 <literal>bind editor <delete> backspace</literal>
910 <sect1 id="reading"> <!--{{{-->
911 <title>Reading Mail - The Index and Pager</title>
914 Similar to many other mail clients, there are two modes in which mail
915 isread in Mutt-ng. The first is the index of messages in the mailbox,
917 called the ``index'' in Mutt-ng. The second mode is the display of the
918 message contents. This is called the ``pager.''
922 The next few sections describe the functions provided in each of these
926 <sect2 id="reading-index">
927 <title>The Message Index</title>
931 <table frame="none" rowsep="1">
932 <title>Most commonly used Index Bindings</title>
933 <tgroup cols="3" align="left" colsep="1" rowsep="1">
937 <entry>Function</entry>
938 <entry>Description</entry>
943 <entry><literal>c</literal></entry>
944 <entry><literal></literal></entry>
945 <entry>change to a different mailbox</entry>
948 <entry><literal>ESC c </literal></entry>
949 <entry><literal></literal></entry>
950 <entry>change to a folder in read-only mode</entry>
953 <entry><literal>C</literal></entry>
954 <entry><literal></literal></entry>
955 <entry>copy the current message to another mailbox</entry>
958 <entry><literal>ESC C </literal></entry>
959 <entry><literal></literal></entry>
960 <entry>decode a message and copy it to a folder</entry>
963 <entry><literal>ESC s </literal></entry>
964 <entry><literal></literal></entry>
965 <entry>decode a message and save it to a folder</entry>
968 <entry><literal>D</literal></entry>
969 <entry><literal></literal></entry>
970 <entry>delete messages matching a pattern</entry>
973 <entry><literal>d</literal></entry>
974 <entry><literal></literal></entry>
975 <entry>delete the current message</entry>
978 <entry><literal>F</literal></entry>
979 <entry><literal></literal></entry>
980 <entry>mark as important</entry>
983 <entry><literal>l</literal></entry>
984 <entry><literal></literal></entry>
985 <entry>show messages matching a pattern</entry>
988 <entry><literal>N</literal></entry>
989 <entry><literal></literal></entry>
990 <entry>mark message as new</entry>
993 <entry><literal>o</literal></entry>
994 <entry><literal></literal></entry>
995 <entry>change the current sort method</entry>
998 <entry><literal>O</literal></entry>
999 <entry><literal></literal></entry>
1000 <entry>reverse sort the mailbox</entry>
1003 <entry><literal>q</literal></entry>
1004 <entry><literal></literal></entry>
1005 <entry>save changes and exit</entry>
1008 <entry><literal>s</literal></entry>
1009 <entry><literal></literal></entry>
1010 <entry>save-message</entry>
1013 <entry><literal>T</literal></entry>
1014 <entry><literal></literal></entry>
1015 <entry>tag messages matching a pattern</entry>
1018 <entry><literal>t</literal></entry>
1019 <entry><literal></literal></entry>
1020 <entry>toggle the tag on a message</entry>
1023 <entry><literal>ESC t </literal></entry>
1024 <entry><literal></literal></entry>
1025 <entry>toggle tag on entire message thread</entry>
1028 <entry><literal>U</literal></entry>
1029 <entry><literal></literal></entry>
1030 <entry>undelete messages matching a pattern</entry>
1033 <entry><literal>u</literal></entry>
1034 <entry><literal></literal></entry>
1035 <entry>undelete-message</entry>
1038 <entry><literal>v</literal></entry>
1039 <entry><literal></literal></entry>
1040 <entry>view-attachments</entry>
1043 <entry><literal>x</literal></entry>
1044 <entry><literal></literal></entry>
1045 <entry>abort changes and exit</entry>
1048 <entry><literal><Return></literal></entry>
1049 <entry><literal></literal></entry>
1050 <entry>display-message</entry>
1053 <entry><literal><Tab></literal></entry>
1054 <entry><literal></literal></entry>
1055 <entry>jump to the next new or unread message</entry>
1058 <entry><literal>@</literal></entry>
1059 <entry><literal></literal></entry>
1060 <entry>show the author's full e-mail address</entry>
1063 <entry><literal>$</literal></entry>
1064 <entry><literal></literal></entry>
1065 <entry>save changes to mailbox</entry>
1068 <entry><literal>/</literal></entry>
1069 <entry><literal></literal></entry>
1070 <entry>search</entry>
1073 <entry><literal>ESC / </literal></entry>
1074 <entry><literal></literal></entry>
1075 <entry>search-reverse</entry>
1078 <entry><literal>^L</literal></entry>
1079 <entry><literal></literal></entry>
1080 <entry>clear and redraw the screen</entry>
1083 <entry><literal>^T</literal></entry>
1084 <entry><literal></literal></entry>
1085 <entry>untag messages matching a pattern</entry>
1094 <title>Status Flags</title> <!--{{{-->
1097 In addition to who sent the message and the subject, a short
1099 the disposition of each message is printed beside the message
1101 Zero or more of the following ``flags'' may appear, which mean:
1112 message is deleted (is marked for deletion)
1120 message have attachments marked for deletion
1128 contains a PGP public key
1152 message is PGP encrypted
1160 message has been replied to
1168 message is signed, and the signature is succesfully
1201 Some of the status flags can be turned on or off using
1207 <emphasis role="bold">set-flag</emphasis> (default: w)
1213 <emphasis role="bold">clear-flag</emphasis> (default: W)
1222 Furthermore, the following flags reflect who the message is
1224 to. They can be customized with the
1225 <muttng-doc:varref name="to-chars"/> variable.
1235 message is to you and you only
1243 message is to you, but also to or cc'ed to others
1251 message is cc'ed to you
1267 message is sent to a subscribed mailing list
1278 <sect2 id="reading-pager">
1279 <title>The Pager</title>
1282 By default, Mutt-ng uses its builtin pager to display the body of
1284 The pager is very similar to the Unix program <emphasis>less</emphasis> though not nearly as
1290 <table frame="none" rowsep="1">
1291 <title>Most commonly used Pager Bindings</title>
1292 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1296 <entry>Function</entry>
1297 <entry>Description</entry>
1302 <entry><literal><Return></literal></entry>
1303 <entry><literal></literal></entry>
1304 <entry>go down one line</entry>
1307 <entry><literal><Space></literal></entry>
1308 <entry><literal></literal></entry>
1309 <entry>display the next page (or next message if at the end of a message)</entry>
1312 <entry><literal>-</literal></entry>
1313 <entry><literal></literal></entry>
1314 <entry>go back to the previous page</entry>
1317 <entry><literal>n</literal></entry>
1318 <entry><literal></literal></entry>
1319 <entry>search for next match</entry>
1322 <entry><literal>S</literal></entry>
1323 <entry><literal></literal></entry>
1324 <entry>skip beyond quoted text</entry>
1327 <entry><literal>T</literal></entry>
1328 <entry><literal></literal></entry>
1329 <entry>toggle display of quoted text</entry>
1332 <entry><literal>?</literal></entry>
1333 <entry><literal></literal></entry>
1334 <entry>show key bindings</entry>
1337 <entry><literal>/</literal></entry>
1338 <entry><literal></literal></entry>
1339 <entry>search for a regular expression (pattern)</entry>
1342 <entry><literal>ESC / </literal></entry>
1343 <entry><literal></literal></entry>
1344 <entry>search backwards for a regular expression</entry>
1347 <entry><literal>\</literal></entry>
1348 <entry><literal></literal></entry>
1349 <entry>toggle search pattern coloring</entry>
1352 <entry><literal>^</literal></entry>
1353 <entry><literal></literal></entry>
1354 <entry>jump to the top of the message</entry>
1364 In addition, many of the functions from the <emphasis>index</emphasis> are available in
1365 the pager, such as <emphasis>delete-message</emphasis> or <emphasis>
1369 advantage over using an external pager to view messages).
1373 Also, the internal pager supports a couple other advanced features.
1375 one, it will accept and translate the ``standard'' nroff sequences
1376 forbold and underline. These sequences are a series of either the
1378 backspace (^H), the letter again for bold or the letter,
1380 ``_'' for denoting underline. Mutt-ng will attempt to display
1382 in bold and underline respectively if your terminal supports them. If
1383 not, you can use the bold and underline <muttng-doc:command name="color"/>
1384 objects to specify a color or mono attribute for them.
1388 Additionally, the internal pager supports the ANSI escape
1389 sequences for character attributes. Mutt-ng translates them
1390 into the correct color and character settings. The sequences
1391 Mutt-ng supports are: <literal>ESC [ Ps;Ps;Ps;...;Ps
1392 m</literal> (see table below for possible values for
1393 <literal>Ps</literal>).
1398 <table frame="none" rowsep="1">
1399 <title>ANSI Escape Sequences</title>
1400 <tgroup cols="2" align="left" colsep="1" rowsep="1">
1403 <entry>Value</entry>
1404 <entry>Attribute</entry>
1409 <entry><literal>0</literal></entry>
1410 <entry>All Attributes Off</entry>
1413 <entry><literal>1</literal></entry>
1414 <entry>Bold on</entry>
1417 <entry><literal>4</literal></entry>
1418 <entry>Underline on</entry>
1421 <entry><literal>5</literal></entry>
1422 <entry>Blink on</entry>
1425 <entry><literal>7</literal></entry>
1426 <entry>Reverse video on</entry>
1429 <entry><literal>3x</literal></entry>
1430 <entry>Foreground color is x (see table below)</entry>
1433 <entry><literal>4x</literal></entry>
1434 <entry>Background color is x (see table below)</entry>
1441 <table frame="none" rowsep="1">
1442 <title>ANSI Colors</title>
1443 <tgroup cols="2" align="left" colsep="1" rowsep="1">
1446 <entry>Number</entry>
1447 <entry>Color</entry>
1452 <entry><literal>0</literal></entry>
1453 <entry>black</entry>
1456 <entry><literal>1</literal></entry>
1460 <entry><literal>2</literal></entry>
1461 <entry>green</entry>
1464 <entry><literal>3</literal></entry>
1465 <entry>yellow</entry>
1468 <entry><literal>4</literal></entry>
1472 <entry><literal>5</literal></entry>
1473 <entry>magenta</entry>
1476 <entry><literal>6</literal></entry>
1480 <entry><literal>7</literal></entry>
1481 <entry>white</entry>
1491 Mutt-ng uses these attributes for handling text/enriched messages,
1493 can also be used by an external <muttng-doc:command name="auto-view"/>
1494 script for highlighting purposes. <emphasis role="bold">Note:</emphasis> If you change the colors for your
1495 display, for example by changing the color associated with color2 for
1496 your xterm, then that color will be used instead of green.
1501 <sect2 id="threads">
1502 <title>Threaded Mode</title>
1505 When the mailbox is <link linkend="sort">sorted</link> by <emphasis>
1509 a few additional functions available in the <emphasis>index</emphasis> and <emphasis>
1517 <table frame="none" rowsep="1">
1518 <title>Most commonly used thread-related bindings</title>
1519 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1523 <entry>Function</entry>
1524 <entry>Description</entry>
1529 <entry><literal>^D</literal></entry>
1530 <entry><muttng-doc:funcref name="delete-thread"/></entry>
1531 <entry>delete all messages in the current thread</entry>
1534 <entry><literal>^U</literal></entry>
1535 <entry><muttng-doc:funcref name="undelete-thread"/></entry>
1536 <entry>undelete all messages in the current thread</entry>
1539 <entry><literal>^N</literal></entry>
1540 <entry><muttng-doc:funcref name="next-thread"/></entry>
1541 <entry>jump to the start of the next thread</entry>
1544 <entry><literal>^P</literal></entry>
1545 <entry><muttng-doc:funcref name="previous-thread"/></entry>
1546 <entry>jump to the start of the previous thread</entry>
1549 <entry><literal>^R</literal></entry>
1550 <entry><muttng-doc:funcref name="read-thread"/></entry>
1551 <entry>mark the current thread as read</entry>
1554 <entry><literal>ESC d </literal></entry>
1555 <entry><muttng-doc:funcref name="delete-subthread"/></entry>
1556 <entry>delete all messages in the current subthread</entry>
1559 <entry><literal>ESC u </literal></entry>
1560 <entry><muttng-doc:funcref name="undelete-subthread"/></entry>
1561 <entry>undelete all messages in the current subthread</entry>
1564 <entry><literal>ESC n </literal></entry>
1565 <entry><muttng-doc:funcref name="next-subthread"/></entry>
1566 <entry>jump to the start of the next subthread</entry>
1569 <entry><literal>ESC p </literal></entry>
1570 <entry><muttng-doc:funcref name="previous-subthread"/></entry>
1571 <entry>jump to the start of the previous subthread</entry>
1574 <entry><literal>ESC r </literal></entry>
1575 <entry><muttng-doc:funcref name="read-subthread"/></entry>
1576 <entry>mark the current subthread as read </entry>
1579 <entry><literal>ESC t </literal></entry>
1580 <entry><muttng-doc:funcref name="tag-thread"/></entry>
1581 <entry>toggle the tag on the current thread</entry>
1584 <entry><literal>ESC v </literal></entry>
1585 <entry><muttng-doc:funcref name="collapse-thread"/></entry>
1586 <entry>toggle collapse for the current thread</entry>
1589 <entry><literal>ESC V </literal></entry>
1590 <entry><muttng-doc:funcref name="collapse-all"/></entry>
1591 <entry>toggle collapse for all threads</entry>
1594 <entry><literal>P</literal></entry>
1595 <entry><muttng-doc:funcref name="parent-message"/></entry>
1596 <entry>jump to parent message in thread</entry>
1606 <emphasis role="bold">Note:</emphasis> Collapsing a thread displays
1607 only the first message
1608 in the thread and hides the others. This is useful when threads
1609 contain so many messages that you can only see a handful of threads
1610 onthe screen. See <literal>%M</literal> in
1611 <muttng-doc:varref name="index-format"/>.
1615 For example, you could use
1616 <literal>%?M?(#%03M)&(%4l)?</literal> in <muttng-doc:varref name="index-format"/>
1618 display the number of hidden messages if the thread is collapsed.
1622 See also the <muttng-doc:varref name="strict-threads"/> variable.
1627 <sect2 id="pager-functions">
1628 <title>Miscellaneous Functions</title>
1631 <muttng-doc:funcdef name="create-alias" key="a"/>
1635 Creates a new alias based upon the current message (or prompts for a
1636 new one). Once editing is complete, an <muttng-doc:command name="alias"/>
1637 command is added to the file specified by the <muttng-doc:varref name="alias-file"/>
1638 variable for future use. <emphasis role="bold">Note:</emphasis>
1639 Specifying an <muttng-doc:varref name="alias-file"/>
1640 does not add the aliases specified there-in, you must also <muttng-doc:command name="source"/>
1645 <muttng-doc:funcdef name="check-traditional-pgp" key="ESC P"/>
1649 This function will search the current message for content signed or
1650 encrypted with PGP the "traditional" way, that is, without proper
1651 MIME tagging. Technically, this function will temporarily change
1652 the MIME content types of the body parts containing PGP data; this
1653 is similar to the <muttng-doc:funcref name="edit-type"/>
1659 <muttng-doc:funcdef name="display-toggle-weed" key="h"/>
1663 Toggles the weeding of message header fields specified by <muttng-doc:command name="ignore"/>
1668 <muttng-doc:funcdef name="edit" key="e"/>
1672 This command (available in the ``index'' and ``pager'') allows you to
1673 edit the raw current message as it's present in the mail folder.
1674 After you have finished editing, the changed message will be
1675 appended to the current folder, and the original message will be
1676 marked for deletion.
1680 <muttng-doc:funcdef name="edit-type"/>
1681 (default: <literal>^E</literal> on the attachment menu, and in the pager and index
1682 menus; <literal>^T</literal> on the compose menu)
1686 This command is used to temporarily edit an attachment's content
1687 type to fix, for instance, bogus character set parameters. When
1688 invoked from the index or from the pager, you'll have the
1689 opportunity to edit the top-level attachment's content type. On the
1690 <link linkend="attach-menu">attach-menu</link>, you can change any
1691 attachment's content type. These changes are not persistent, and get
1692 lost upon changing folders.
1696 Note that this command is also available on the <link linkend="compose-menu">compose-menu</link>
1697 .There, it's used to
1698 fine-tune the properties of attachments you are going to send.
1702 <muttng-doc:funcdef name="enter-command" key=":"/>
1706 This command is used to execute any command you would normally put in
1708 configuration file. A common use is to check the settings of
1710 in conjunction with <muttng-doc:command name="macro"/> to change
1716 <muttng-doc:funcdef name="extract-keys" key="^K"/>
1720 This command extracts PGP public keys from the current or tagged
1721 message(s) and adds them to your PGP public key ring.
1725 <muttng-doc:funcdef name="forget-passphrase" key="^F"/>
1729 This command wipes the passphrase(s) from memory. It is useful, if
1730 you misspelled the passphrase.
1734 <muttng-doc:funcdef name="list-reply" key="L"/>
1738 Reply to the current or tagged message(s) by extracting any addresses
1740 match the regular expressions given by the <muttng-doc:command name="lists"/>
1741 commands, but also honor any <literal>Mail-Followup-To</literal>
1743 <muttng-doc:varref name="honor-followup-to"/>
1744 configuration variable is set. Using this when replying to messages
1746 to mailing lists helps avoid duplicate copies being sent to the
1748 the message you are replying to.
1752 <muttng-doc:funcdef name="pipe-message" default="|"/>
1756 Asks for an external Unix command and pipes the current or
1757 tagged message(s) to it. The variables
1758 <muttng-doc:varref name="pipe-decode"/>,
1759 <muttng-doc:varref name="pipe-split"/>,
1760 <muttng-doc:varref name="pipe-decode"/> and
1761 <muttng-doc:varref name="wait-key"/>
1762 control the exact behavior of this function.
1766 <muttng-doc:funcdef name="resend-message" key="ESC e"/>
1770 With resend-message, mutt takes the current message as a template for
1772 new message. This function is best described as "recall from
1774 folders". It can conveniently be used to forward MIME messages while
1775 preserving the original mail structure. Note that the amount of
1777 included here depends on the value of the <muttng-doc:varref name="weed"/>
1782 This function is also available from the attachment menu. You can use
1784 to easily resend a message which was included with a bounce message
1785 as a message/rfc822 body part.
1789 <muttng-doc:funcdef name="shell-escape" key="!"/>
1793 Asks for an external Unix command and executes it. The
1794 <muttng-doc:varref name="wait-key"/>
1795 can be used to control
1796 whether Mutt-ng will wait for a key to be pressed when the command
1798 (presumably to let the user read the output of the command), based on
1799 the return status of the named command.
1803 <muttng-doc:funcdef name="toggle-quoted" key="T"/>
1807 The <emphasis>pager</emphasis> uses the
1808 <muttng-doc:varref name="quote-regexp"/>
1809 variable to detect quoted text when
1810 displaying the body of the message. This function toggles the
1811 displayof the quoted material in the message. It is particularly
1813 are interested in just the response and there is a large amount of
1814 quoted text in the way.
1818 <muttng-doc:funcdef name="skip-quoted" key="S"/>
1822 This function will go to the next line of non-quoted text which come
1823 after a line of quoted text in the internal pager.
1835 <sect1 id="sending"> <!--{{{-->
1836 <title>Sending Mail</title>
1839 The following bindings are available in the <emphasis>index</emphasis>
1846 <table frame="none" rowsep="1">
1847 <title>Most commonly used Mail Composition Bindings</title>
1848 <tgroup cols="3" align="left" colsep="1" rowsep="1">
1852 <entry>Function</entry>
1853 <entry>Description</entry>
1858 <entry><literal>m</literal></entry>
1859 <entry><muttng-doc:funcref name="compose"/></entry>
1860 <entry>compose a new message</entry>
1863 <entry><literal>r</literal></entry>
1864 <entry><muttng-doc:funcref name="reply"/></entry>
1865 <entry>reply to sender</entry>
1868 <entry><literal>g</literal></entry>
1869 <entry><muttng-doc:funcref name="group-reply"/></entry>
1870 <entry>reply to all recipients</entry>
1873 <entry><literal>L</literal></entry>
1874 <entry><muttng-doc:funcref name="list-reply"/></entry>
1875 <entry>reply to mailing list address</entry>
1878 <entry><literal>f</literal></entry>
1879 <entry><muttng-doc:funcref name="forward"/></entry>
1880 <entry>forward message</entry>
1883 <entry><literal>b</literal></entry>
1884 <entry><muttng-doc:funcref name="bounce"/></entry>
1885 <entry>bounce (remail) message</entry>
1888 <entry><literal>ESC k </literal></entry>
1889 <entry><muttng-doc:funcref name="mail-key"/></entry>
1890 <entry>mail a PGP public key to someone</entry>
1899 Bouncing a message sends the message as is to the recipient you
1900 specify. Forwarding a message allows you to add comments or
1901 modify the message you are forwarding. These items are discussed
1902 in greater detail in the next chapter <link linkend="forwarding-mail">forwarding-mail</link>.
1905 <sect2 id="sending-compose">
1906 <title>Composing new messages</title>
1909 When you want to send an email using mutt-ng, simply press <literal>m</literal> on
1910 your keyboard. Then, mutt-ng asks for the recipient via a prompt in
1922 After you've finished entering the recipient(s), press return. If you
1923 want to send an email to more than one recipient, separate the email
1924 addresses using the comma "<literal>,</literal>". Mutt-ng then asks
1926 subject. Again, press return after you've entered it. After that,
1928 got the most important information from you, and starts up an editor
1929 where you can then enter your email.
1933 The editor that is called is selected in the following way: you
1934 can e.g. set it in the mutt-ng configuration:
1940 set editor = "vim +/^$/ -c ':set tw=72'"
1942 set editor = "emacs"</screen>
1947 If you don't set your preferred editor in your configuration, mutt-ng
1948 first looks whether the environment variable <muttng-doc:envvar name="VISUAL"/> is set, and if
1949 so, it takes its value as editor command. Otherwise, it has a look
1950 at <muttng-doc:envvar name="EDITOR"/> and takes its value if it is set. If no
1952 can be found, mutt-ng simply assumes <muttng-doc:man name="vi"/> to be the
1954 since it's the most widespread editor in the Unix world and it's
1956 safe to assume that it is installed and available.
1960 When you've finished entering your message, save it and quit your
1961 editor. Mutt-ng will then present you with a summary screen, the
1963 On the top, you see a summary of the most important available key
1965 Below that, you see the sender, the recipient(s), Cc and/or Bcc
1966 recipient(s), the subject, the reply-to address, and optionally
1967 information where the sent email will be stored and whether it should
1968 be digitally signed and/or encrypted.
1972 Below that, you see a list of "attachments". The mail you've just
1973 entered before is also an attachment, but due to its special type
1974 (it's plain text), it will be displayed as the normal message on
1975 the receiver's side.
1979 At this point, you can add more attachments, pressing <literal>a</literal>, you
1980 can edit the recipient addresses, pressing <literal>t</literal> for
1982 <literal>c</literal> for the "Cc:" field, and <literal>b</literal>
1983 for the "Bcc: field. You can
1984 also edit the subject the subject by simply pressing <literal>s</literal> or the
1985 email message that you've entered before by pressing <literal>e</literal>. You will
1986 then again return to the editor. You can even edit the sender, by
1988 <literal><esc>f</literal>, but this shall only be used with
1993 Alternatively, you can configure mutt-ng in a way that most of the
1994 above settings can be edited using the editor. Therefore, you only
1995 need to add the following to your configuration:
2001 set edit_headers</screen>
2006 Once you have finished editing the body of your mail message, you are
2007 returned to the <emphasis>compose</emphasis> menu. The following
2008 options are available:
2013 <table frame="none" rowsep="1">
2014 <title>Most commonly used Compose Menu Bindings</title>
2015 <tgroup cols="3" align="left" colsep="1" rowsep="1">
2019 <entry>Function</entry>
2020 <entry>Description</entry>
2025 <entry><literal>a</literal></entry>
2026 <entry><muttng-doc:funcref name="attach-file"/></entry>
2027 <entry>attach a file</entry>
2030 <entry><literal>A</literal></entry>
2031 <entry><muttng-doc:funcref name="attach-message"/></entry>
2032 <entry>attach message(s) to the message</entry>
2035 <entry><literal>ESC k </literal></entry>
2036 <entry><muttng-doc:funcref name="attach-key"/></entry>
2037 <entry>attach a PGP public key</entry>
2040 <entry><literal>d</literal></entry>
2041 <entry><muttng-doc:funcref name="edit-description"/></entry>
2042 <entry>edit description on attachment</entry>
2045 <entry><literal>D</literal></entry>
2046 <entry><muttng-doc:funcref name="detach-file"/></entry>
2047 <entry>detach a file</entry>
2050 <entry><literal>t</literal></entry>
2051 <entry><muttng-doc:funcref name="edit-to"/></entry>
2052 <entry>edit the To field</entry>
2055 <entry><literal>ESC f </literal></entry>
2056 <entry><muttng-doc:funcref name="edit-from"/></entry>
2057 <entry>edit the From field</entry>
2060 <entry><literal>r</literal></entry>
2061 <entry><muttng-doc:funcref name="edit-reply-to"/></entry>
2062 <entry>edit the Reply-To field</entry>
2065 <entry><literal>c</literal></entry>
2066 <entry><muttng-doc:funcref name="edit-cc"/></entry>
2067 <entry>edit the Cc field</entry>
2070 <entry><literal>b</literal></entry>
2071 <entry><muttng-doc:funcref name="edit-bcc"/></entry>
2072 <entry>edit the Bcc field</entry>
2075 <entry><literal>y</literal></entry>
2076 <entry><muttng-doc:funcref name="send-message"/></entry>
2077 <entry>send the message</entry>
2080 <entry><literal>s</literal></entry>
2081 <entry><muttng-doc:funcref name="edit-subject"/></entry>
2082 <entry>edit the Subject</entry>
2085 <entry><literal>S</literal></entry>
2086 <entry><muttng-doc:funcref name="smime-menu"/></entry>
2087 <entry>select S/MIME options</entry>
2090 <entry><literal>f</literal></entry>
2091 <entry><muttng-doc:funcref name="edit-fcc"/></entry>
2092 <entry>specify an ``Fcc'' mailbox</entry>
2095 <entry><literal>p</literal></entry>
2096 <entry><muttng-doc:funcref name="pgp-menu"/></entry>
2097 <entry>select PGP options</entry>
2100 <entry><literal>P</literal></entry>
2101 <entry><muttng-doc:funcref name="postpone-message"/></entry>
2102 <entry>postpone this message until later</entry>
2105 <entry><literal>q</literal></entry>
2106 <entry><muttng-doc:funcref name="quit"/></entry>
2107 <entry>quit (abort) sending the message</entry>
2110 <entry><literal>w</literal></entry>
2111 <entry><muttng-doc:funcref name="write-fcc"/></entry>
2112 <entry>write the message to a folder</entry>
2115 <entry><literal>i</literal></entry>
2116 <entry><muttng-doc:funcref name="ispell"/></entry>
2117 <entry>check spelling (if available on your system)</entry>
2120 <entry><literal>^F</literal></entry>
2121 <entry><muttng-doc:funcref name="forget-passphrase"/></entry>
2122 <entry>wipe passphrase(s) from memory</entry>
2131 <emphasis role="bold">Note:</emphasis> The attach-message function
2132 will prompt you for a folder to
2133 attach messages from. You can now tag messages in that folder and
2134 theywill be attached to the message you are sending. Note that
2135 certainoperations like composing a new mail, replying, forwarding,
2137 not permitted when you are in that folder. The <literal>%r</literal>
2138 in <muttng-doc:varref name="status-format"/>
2140 a 'A' to indicate that you are in attach-message mode.
2149 <sect2 id="sending-reply">
2150 <title>Replying</title>
2152 <sect3 id="sending-simple-reply">
2153 <title>Simple Replies</title>
2156 When you want to reply to an email message, select it in the index
2157 menu and then press <literal>r</literal>. Mutt-ng's behaviour is
2159 behaviour when you compose a message: first, you will be asked for
2160 the recipient, then for the subject, and then, mutt-ng will start
2161 the editor with the quote attribution and the quoted message. This
2162 can e.g. look like the example below.
2168 On Mon, Mar 07, 2005 at 05:02:12PM +0100, Michael Svensson wrote:
2169 > Bill, can you please send last month's progress report to Mr.
2170 > Morgan? We also urgently need the cost estimation for the new
2171 > production server that we want to set up before our customer's
2172 > project will go live.</screen>
2177 You can start editing the email message. It is strongly
2178 recommended to put your answer <emphasis>below</emphasis> the
2180 only quote what is really necessary and that you refer to. Putting
2181 your answer on top of the quoted message, is, although very
2182 widespread, very often not considered to be a polite way to answer
2187 The quote attribution is configurable, by default it is set to
2190 set attribution = "On %d, %n wrote:"</screen>
2195 It can also be set to something more compact, e.g.
2198 set attribution = "attribution="* %n <%a> [%(%y-%m-%d %H:%M)]:"</screen>
2203 The example above results in the following attribution:
2206 * Michael Svensson <svensson@foobar.com> [05-03-06 17:02]:
2207 > Bill, can you please send last month's progress report to Mr.
2208 > Morgan? We also urgently need the cost estimation for the new
2209 > production server that we want to set up before our customer's
2210 > project will go live.</screen>
2215 Generally, try to keep your attribution short yet
2216 information-rich. It is <emphasis>not</emphasis> the right place
2218 long "attribution" novels or anything like that: the right place
2219 for such things is - if at all - the email signature at the very
2220 bottom of the message.
2224 When you're done with writing your message, save and quit the
2225 editor. As before, you will return to the compose menu, which is
2226 used in the same way as before.
2235 <sect3 id="sending-group-reply">
2236 <title>Group Replies</title>
2239 In the situation where a group of people uses email as a
2240 discussion, most of the emails will have one or more recipients,
2241 and probably several "Cc:" recipients. The group reply
2242 functionalityensures that when you press <literal>g</literal>
2243 instead of <literal>r</literal> to do a reply,
2244 each and every recipient that is contained in the original message
2245 will receive a copy of the message, either as normal recipient or
2255 <sect3 id="sending-list-reply">
2256 <title>List Replies</title>
2259 When you use mailing lists, it's generally better to send your
2260 reply to a message only to the list instead of the list and the
2261 original author. To make this easy to use, mutt-ng features list
2266 To do a list reply, simply press <literal>L</literal>. If the email
2268 a <literal>Mail-Followup-To:</literal> header, its value will be
2270 address. Otherwise, mutt-ng searches through all mail addresses in
2271 the original message and tries to match them a list of regular
2272 expressions which can be specified using the <literal>lists</literal> command.
2273 If any of the regular expression matches, a mailing
2274 list address has been found, and it will be used as reply address.
2280 lists linuxevent@luga\.at vuln-dev@ mutt-ng-users@</screen>
2285 Nowadays, most mailing list software like GNU Mailman adds a
2286 <literal>Mail-Followup-To:</literal> header to their emails anyway,
2288 <literal>lists</literal> is hardly ever necessary in practice.
2303 <sect2 id="sending-edit-header">
2304 <title>Editing the message header</title>
2307 When editing the header of your outgoing message, there are a couple
2309 special features available.
2315 <literal>Fcc:</literal> <emphasis>filename</emphasis>
2317 Mutt-ng will pick up <emphasis>filename</emphasis>
2318 just as if you had used the <emphasis>edit-fcc</emphasis> function in
2319 the <emphasis>compose</emphasis> menu.
2323 You can also attach files to your message by specifying
2326 Attach: filename [description]</screen>
2328 where <emphasis>filename</emphasis> is the file to attach and <emphasis>
2332 optional string to use as the description of the attached file.
2336 When replying to messages, if you remove the <emphasis>In-Reply-To:</emphasis> field from
2337 the header field, Mutt-ng will not generate a <emphasis>References:</emphasis> field, which
2338 allows you to create a new message thread.
2342 Also see the <muttng-doc:varref name="edit-headers"/> and
2343 <muttng-doc:varref name="editor-headers"/> variables
2352 <sect2 id="sending-crypto">
2353 <title>Using Mutt-ng with PGP</title>
2356 If you want to use PGP, you can specify
2359 Pgp: [E | S | S id]</screen>
2361 ``E'' encrypts, ``S'' signs and
2362 ``S<id>'' signs with the given key, setting
2363 <muttng-doc:varref name="pgp-sign-as"/>
2368 If you have told mutt to PGP encrypt a message, it will guide you
2369 through a key selection process when you try to send the message.
2370 Mutt-ng will not ask you any questions about keys which have a
2371 certified user ID matching one of the message recipients' mail
2372 addresses. However, there may be situations in which there are
2373 several keys, weakly certified user ID fields, or where no matching
2378 In these cases, you are dropped into a menu with a list of keys from
2379 which you can select one. When you quit this menu, or mutt can't
2380 find any matching keys, you are prompted for a user ID. You can, as
2381 usually, abort this prompt using <literal>^G</literal>. When
2382 you do so, mutt will
2383 return to the compose screen.
2387 Once you have successfully finished the key selection, the message
2388 will be encrypted using the selected public keys, and sent out.
2392 Most fields of the entries in the key selection menu (see also
2393 <muttng-doc:varref name="pgp-entry-format"/>)
2394 have obvious meanings. But some explanations on the capabilities,
2396 and validity fields are in order.
2400 The flags sequence (%f) will expand to one of the following
2404 <table frame="none" rowsep="1">
2405 <title>PGP Key Menu Flags</title>
2406 <tgroup cols="2" align="left" colsep="1" rowsep="1">
2410 <entry>Description</entry>
2415 <entry><literal>R</literal></entry>
2416 <entry>The key has been revoked and can't be used.</entry>
2419 <entry><literal>X</literal></entry>
2420 <entry>The key is expired and can't be used.</entry>
2423 <entry><literal>d</literal></entry>
2424 <entry>You have marked the key as disabled.</entry>
2427 <entry><literal>c</literal></entry>
2428 <entry>There are unknown critical self-signature packets.</entry>
2437 The capabilities field (%c) expands to a two-character
2438 sequencerepresenting a key's capabilities. The first character gives
2439 the key's encryption capabilities: A minus sign (<emphasis role="bold">
2443 that the key cannot be used for encryption. A dot (<emphasis role="bold">
2447 it's marked as a signature key in one of the user IDs, but may
2448 also be used for encryption. The letter <emphasis role="bold">e</emphasis> indicates that
2449 this key can be used for encryption.
2453 The second character indicates the key's signing capabilities. Once
2454 again, a ``<emphasis role="bold">-</emphasis>'' implies ``not for
2455 signing'', ``<emphasis role="bold">.</emphasis>'' implies
2456 that the key is marked as an encryption key in one of the user-ids,
2458 ``<emphasis role="bold">s</emphasis>'' denotes a key which can be
2463 Finally, the validity field (%t) indicates how well-certified
2465 is. A question mark (<emphasis role="bold">?</emphasis>) indicates
2466 undefined validity, a minus
2467 character (<emphasis role="bold">-</emphasis>) marks an untrusted
2468 association, a space character
2469 means a partially trusted association, and a plus character (<emphasis role="bold">
2473 indicates complete validity.
2482 <sect2 id="sending-mixmaster">
2483 <title>Sending anonymous messages via mixmaster</title>
2486 You may also have configured mutt to co-operate with Mixmaster, an
2487 anonymous remailer. Mixmaster permits you to send your messages
2488 anonymously using a chain of remailers. Mixmaster support in mutt is
2490 mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
2491 It does not support earlier versions or the later so-called version 3
2493 of which the latest appears to be called 2.9b23.
2497 To use it, you'll have to obey certain restrictions. Most
2498 important, you cannot use the <literal>Cc</literal> and <literal>Bcc</literal> headers. To tell
2499 Mutt-ng to use mixmaster, you have to select a remailer chain, using
2500 the mix function on the compose menu.
2504 The chain selection screen is divided into two parts. In the
2505 (larger) upper part, you get a list of remailers you may use. In
2506 the lower part, you see the currently selected chain of remailers.
2510 You can navigate in the chain using the <literal>chain-prev</literal>
2512 <literal>chain-next</literal> functions, which are by default bound
2514 and right arrows and to the <literal>h</literal> and <literal>l</literal> keys (think vi
2515 keyboard bindings). To insert a remailer at the current chain
2516 position, use the <literal>insert</literal> function. To append a
2518 the current chain position, use <literal>select-entry</literal> or <literal>
2522 You can also delete entries from the chain, using the corresponding
2523 function. Finally, to abandon your changes, leave the menu, or
2524 <literal>accept</literal> them pressing (by default) the <literal>
2531 Note that different remailers do have different capabilities,
2532 indicated in the <literal>%c</literal> entry of the remailer menu lines (see
2533 <muttng-doc:varref name="mix-entry-format"/>).
2535 the ``middleman'' capability, indicated by a capital ``M'': This
2536 means that the remailer in question cannot be used as the final
2537 element of a chain, but will only forward messages to other
2538 mixmaster remailers. For details on the other capabilities, please
2539 have a look at the mixmaster documentation.
2554 <sect1 id="forwarding-mail">
2555 <title>Forwarding and Bouncing Mail</title>
2558 Often, it is necessary to forward mails to other people.
2559 Therefore, mutt-ng supports forwarding messages in two different
2564 The first one is regular forwarding, as you probably know it from
2565 other mail clients. You simply press <literal>f</literal>, enter the
2567 email address, the subject of the forwarded email, and then you can
2568 edit the message to be forwarded in the editor. The forwarded
2569 message is separated from the rest of the message via the two
2576 ----- Forwarded message from Lucas User <luser@example.com> -----
2578 From: Lucas User <luser@example.com>
2579 Date: Thu, 02 Dec 2004 03:08:34 +0100
2580 To: Michael Random <mrandom@example.com>
2581 Subject: Re: blackmail
2583 Pay me EUR 50,000.- cash or your favorite stuffed animal will die
2586 ----- End forwarded message -----</screen>
2591 When you're done with editing the mail, save and quit the editor,
2592 and you will return to the compose menu, the same menu you also
2593 encounter when composing or replying to mails.
2597 The second mode of forwarding emails with mutt-ng is the
2598 so-called <emphasis>bouncing</emphasis>: when you bounce an email to
2600 address, it will be sent in practically the same format you send it
2601 (except for headers that are created during transporting the
2602 message). To bounce a message, press <literal>b</literal> and enter the
2604 email address. By default, you are then asked whether you really
2605 want to bounce the message to the specified recipient. If you answer
2606 with yes, the message will then be bounced.
2610 To the recipient, the bounced email will look as if he got it
2611 like a regular email where he was <literal>Bcc:</literal> recipient.
2613 possibility to find out whether it was a bounced email is to
2614 carefully study the email headers and to find out which host really
2624 <sect1 id="postponing-mail">
2625 <title>Postponing Mail</title>
2628 At times it is desirable to delay sending a message that you have
2629 already begun to compose. When the <emphasis>postpone-message</emphasis> function is
2630 used in the <emphasis>compose</emphasis> menu, the body of your message
2632 are stored in the mailbox specified by the
2633 <muttng-doc:varref name="postponed"/> variable. This means that you can recall the
2634 message even if you exit Mutt-ng and then restart it at a later time.
2638 Once a message is postponed, there are several ways to resume it. From
2640 command line you can use the ``-p'' option, or if you <emphasis>compose</emphasis> a new
2641 message from the <emphasis>index</emphasis> or <emphasis>pager</emphasis> you will be prompted if postponed
2642 messages exist. If multiple messages are currently postponed, the
2643 <emphasis>postponed</emphasis> menu will pop up and you can select
2644 which message you would
2649 <emphasis role="bold">Note:</emphasis> If you postpone a reply to a
2650 message, the reply setting of
2651 the message is only updated when you actually finish the message and
2652 send it. Also, you must be in the same folder with the message you
2653 replied to for the status of the message to be updated.
2657 See also the <muttng-doc:varref name="postpone"/> quad-option.
2675 <chapter id="configuration"> <!--{{{-->
2676 <title>Configuration</title>
2678 <sect1 id="configuration-files">
2679 <title>Locations of Configuration Files</title>
2682 While the default configuration (or ``preferences'') make Mutt-ng
2684 of the box, it is often desirable to tailor Mutt-ng to suit your own
2686 Mutt-ng is first invoked, it will attempt to read the ``system''
2688 file (defaults set by your local system administrator), unless the
2689 ``-n'' <link linkend="commandline">commandline</link> option is
2690 specified. This file is
2691 typically <literal>/usr/local/share/muttng/Muttngrc</literal> or <literal>
2695 Mutt-ng users will find this file in <literal>
2696 /usr/local/share/muttng/Muttrc
2699 <literal>/etc/Muttngrc</literal>. Mutt will next look for a file named <literal>
2702 in your home directory, Mutt-ng will look for <literal>.muttngrc</literal>. If this file
2703 does not exist and your home directory has a subdirectory named <literal>
2707 mutt try to load a file named <literal>.muttng/muttngrc</literal>.
2711 <literal>.muttrc</literal> (or <literal>.muttngrc</literal> for
2712 Mutt-ng) is the file where you will
2713 usually place your <link linkend="commands">commands</link> to
2723 <sect1 id="configuration-syntax">
2724 <title>Basic Syntax of Initialization Files</title>
2727 An initialization file consists of a series of <link linkend="commands">commands</link>. Each line of the file may contain one or more commands.
2728 When multiple commands are used, they must be separated by a semicolon
2732 set realname='Mutt-ng user' ; ignore x-</screen>
2734 The hash mark, or pound sign
2735 (``#''), is used as a ``comment'' character. You can use it to
2736 annotate your initialization file. All text after the comment character
2737 to the end of the line is ignored. For example,
2743 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment</screen>
2748 Single quotes (') and double quotes (") can be used to quote
2750 which contain spaces or other special characters. The difference
2752 the two types of quotes is similar to that of many popular shell
2754 namely that a single quote is used to specify a literal string (one
2756 not interpreted for shell variables or quoting with a backslash
2758 next paragraph), while double quotes indicate a string for which
2759 should be evaluated. For example, backtics are evaluated inside of
2761 quotes, but <emphasis role="bold">not</emphasis> for single quotes.
2765 \ quotes the next character, just as in shells such as bash and
2767 For example, if want to put quotes ``"'' inside of a string, you
2769 ``\'' to force the next character to be a literal instead of
2774 set realname="Michael \"MuttDude\" Elkins"</screen>
2779 ``\\'' means to insert a literal ``\'' into the line.
2780 ``\n'' and ``\r'' have their usual C meanings of linefeed and
2781 carriage-return, respectively.
2785 A \ at the end of a line can be used to split commands over
2786 multiple lines, provided that the split points don't appear in the
2787 middle of command names.
2791 Please note that, unlike the various shells, mutt-ng interprets a
2793 at the end of a line also in comments. This allows you to disable a
2795 split over multiple lines with only one ``#''.
2802 set realname="Michael \"MuttDude\" Elkins"</screen>
2807 When testing your config files, beware the following caveat. The
2809 at the end of the commented line extends the current line with the next
2811 - then referred to as a ``continuation line''. As the first line is
2812 commented with a hash (#) all following continuation lines are also
2813 part of a comment and therefore are ignored, too. So take care of
2815 when continuation lines are involved within your setup files!
2834 line1 ``continues'' until line4. however, the part after the # is a
2835 comment which includes line3 and line4. line5 is a new line of its own
2837 thus is interpreted again.
2841 The commands understood by mutt are explained in the next paragraphs.
2842 For a complete list, see the <link linkend="commands">commands</link>.
2851 <sect1 id="configuration-expansion">
2852 <title>Expansion within variables</title>
2855 Besides just assign static content to variables, there's plenty of
2856 ways of adding external and more or less dynamic content.
2859 <sect2 id="configuration-expansion-commands">
2860 <title>Commands' Output</title>
2863 It is possible to substitute the output of a Unix command in an
2864 initialization file. This is accomplished by enclosing the command
2865 in backquotes (``) as in, for example:
2871 my_hdr X-Operating-System: `uname -a`</screen>
2876 The output of the Unix command ``uname -a'' will be substituted
2877 before the line is parsed. Note that since initialization files are
2878 line oriented, only the first line of output from the Unix command
2879 will be substituted.
2884 <sect2 id="configuration-expansion-environment">
2885 <title>Environment Variables</title>
2888 UNIX environments can be accessed like the way it is done in
2889 shells like sh and bash: Prepend the name of the environment by a
2890 ``$'' sign. For example,
2896 set record=+sent_on_$HOSTNAME</screen>
2901 sets the <muttng-doc:varref name="record"/> variable to the
2902 string <emphasis>+sent_on_</emphasis> and appends the
2903 value of the evironment
2904 variable <muttng-doc:envvar name="HOSTNAME"/>.
2908 <emphasis role="bold">Note:</emphasis> There will be no warning if an
2909 environment variable
2910 is not defined. The result will of the expansion will then be empty.
2915 <sect2 id="configuration-expansion-config">
2916 <title>Configuration Variables</title>
2919 As for environment variables, the values of all configuration
2920 variables as string can be used in the same way, too. For example,
2926 set imap_home_namespace = $folder</screen>
2931 would set the value of <muttng-doc:varref name="imap-home-namespace"/>
2932 to the value to which <muttng-doc:varref name="folder"/>
2933 is <emphasis>currently</emphasis> set to.
2937 <emphasis role="bold">Note:</emphasis> There're no logical links
2938 established in such cases so
2939 that the the value for <muttng-doc:varref name="imap-home-namespace"/>
2941 if <muttng-doc:varref name="folder"/> gets changed.
2945 <emphasis role="bold">Note:</emphasis> There will be no warning if a
2946 configuration variable
2947 is not defined or is empty. The result will of the expansion will
2953 <sect2 id="configuration-expansion-self">
2954 <title>Self-Defined Variables</title>
2957 Mutt-ng flexibly allows users to define their own variables. To
2958 avoid conflicts with the standard set and to prevent misleading
2959 error messages, there's a reserved namespace for them: all
2960 user-defined variables must be prefixed with <literal>user_</literal> and can be
2961 used just like any ordinary configuration or environment
2966 For example, to view the manual, users can either define two
2967 macros like the following
2973 macro generic <F1> "!less -r /path/to/manual" "Show manual"
2974 macro pager <F1> "!less -r /path/to/manual" "Show manual"</screen>
2979 for <literal>generic</literal>, <literal>pager</literal> and <literal>
2982 .The alternative is to
2983 define a custom variable like so:
2989 set user_manualcmd = "!less -r /path/to_manual"
2990 macro generic <F1> "$user_manualcmd<enter>" "Show manual"
2991 macro pager <F1> "$user_manualcmd<enter>" "Show manual"
2992 macro index <F1> "$user_manualcmd<enter>" "Show manual"</screen>
2997 to re-use the command sequence as in:
3003 macro index <F2> "$user_manualcmd | grep '\^[ ]\\+~. '" "Show Patterns"</screen>
3008 Using this feature, arbitrary sequences can be defined once and
3009 recalled and reused where necessary. More advanced scenarios could
3010 include to save a variable's value at the beginning of macro
3011 sequence and restore it at end.
3015 When the variable is first defined, the first value it gets
3016 assigned is also the initial value to which it can be reset using
3017 the <literal>reset</literal> command.
3021 The complete removal is done via the <literal>unset</literal>
3026 After the following sequence:
3033 set user_foo = 666</screen>
3038 the variable <literal>$user_foo</literal> has a current value
3040 initial of 42. The query
3046 set ?user_foo</screen>
3051 will show 666. After doing the reset via
3057 reset user_foo</screen>
3062 a following query will give 42 as the result. After unsetting it
3069 unset user_foo</screen>
3074 any query or operation (except the noted expansion within other
3075 statements) will lead to an error message.
3080 <sect2 id="configuration-expansion-predef">
3081 <title>Pre-Defined Variables</title>
3084 In order to allow users to share one setup over a number of
3085 different machines without having to change its contents, there's a
3086 number of pre-defined variables. These are prefixed with
3087 <literal>muttng_</literal> and are read-only, i.e. they cannot
3089 reset. The reference chapter lists all available variables.
3093 <emphasis> Please consult the local copy of your manual for their
3094 values as they may differ from different manual sources.
3097 the manual is installed in can be queried (already using such a
3098 variable) by running:
3104 muttng -Q muttng_docdir</screen>
3109 To extend the example for viewing the manual via self-defined
3110 variables, it can be made more readable and more portable by
3111 changing the real path in:
3117 set user_manualcmd = '!less -r /path/to_manual'</screen>
3128 set user_manualcmd = "!less -r $muttng_docdir/manual.txt"</screen>
3133 which works everywhere if a manual is installed.
3137 Please note that by the type of quoting, muttng determines when
3138 to expand these values: when it finds double quotes, the value will
3139 be expanded during reading the setup files but when it finds single
3140 quotes, it'll expand it at runtime as needed.
3144 For example, the statement
3150 folder-hook . "set user_current_folder = $muttng_folder_name"</screen>
3155 will be already be translated to the following when reading the
3162 folder-hook . "set user_current_folder = some_folder"</screen>
3167 with <literal>some_folder</literal> being the name of the
3169 opens. On the contrary,
3175 folder-hook . 'set user_current_folder = $muttng_folder_name'</screen>
3180 will be executed at runtime because of the single quotes so that
3181 <literal>user_current_folder</literal> will always have
3182 the value of the currently
3187 A more practical example is:
3193 folder-hook . 'source ~/.mutt/score-$muttng_folder_name'</screen>
3198 which can be used to source files containing score commands
3199 depending on the folder the user enters.
3204 <sect2 id="configuration-expansion-typeconv">
3205 <title>Type Conversions</title>
3208 A note about variable's types during conversion: internally
3209 values are stored in internal types but for any dump/query or set
3210 operation they're converted to and from string. That means that
3211 there's no need to worry about types when referencing any variable.
3212 As an example, the following can be used without harm (besides
3213 makeing muttng very likely behave strange):
3220 set folder = $read_inc
3221 set read_inc = $folder
3222 set user_magic_number = 42
3223 set folder = $user_magic_number</screen>
3231 <sect1 id="command-alias"><anchor id="command-unalias"/>
3232 <title>Defining/Using aliases</title>
3235 Usage: <muttng-doc:command name="alias"/> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>,...]
3239 It's usually very cumbersome to remember or type out the address of
3241 you are communicating with. Mutt-ng allows you to create ``aliases''
3243 a short string to a full address.
3247 <emphasis role="bold">Note:</emphasis> if you want to create an alias
3248 for a group (by specifying more than
3249 one address), you <emphasis role="bold">must</emphasis> separate the
3250 addresses with a comma (``,'').
3254 To remove an alias or aliases (``*'' means all aliases):
3258 <literal>unalias</literal> [* | <emphasis>key</emphasis> <emphasis>...</emphasis>]
3264 alias muttdude me@cs.hmc.edu (Michael Elkins)
3265 alias theguys manny, moe, jack</screen>
3270 Unlike other mailers, Mutt-ng doesn't require aliases to be defined
3271 in a special file. The <literal>alias</literal> command can appear
3273 a configuration file, as long as this file is <muttng-doc:command name="source"/>.
3274 Consequently, you can have multiple alias files, or
3275 you can have all aliases defined in your muttrc.
3279 On the other hand, the <muttng-doc:funcref name="create-alias"/>
3280 function can use only one file, the one pointed to by the
3281 <muttng-doc:varref name="alias-file"/>
3283 <literal>~/.muttrc</literal> by default). This file is not
3285 in the sense that Mutt-ng will happily append aliases to any file, but
3287 order for the new aliases to take effect you need to explicitly <muttng-doc:command name="source"/>
3298 source /usr/local/share/Mutt-ng.aliases
3299 source ~/.mail_aliases
3300 set alias_file=~/.mail_aliases</screen>
3305 To use aliases, you merely use the alias at any place in mutt where
3306 muttprompts for addresses, such as the <emphasis>To:</emphasis> or <emphasis>
3310 also enter aliases in your editor at the appropriate headers if you
3312 <muttng-doc:varref name="editor-headers"/>
3317 In addition, at the various address prompts, you can use the tab
3319 to expand a partial alias to the full alias. If there are multiple
3321 mutt will bring up a menu with the matching aliases. In order to be
3322 presented with the full list of aliases, you must hit tab with out a
3324 alias, such as at the beginning of the prompt or after a comma denoting
3329 In the alias menu, you can select as many aliases as you want with the
3330 <emphasis>select-entry</emphasis> key (default: RET), and use the <emphasis>
3334 (default: q) to return to the address prompt.
3343 <sect1 id="command-bind">
3344 <title>Changing the default key bindings</title>
3347 Usage: <muttng-doc:command name="bind"/> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
3351 This command allows you to change the default key bindings (operation
3352 invoked when pressing a key).
3356 <emphasis>map</emphasis> specifies in which menu the binding belongs.
3358 be specified by separating them with commas (no additional whitespace
3359 isallowed). The currently defined maps are:
3367 <term>generic</term>
3370 This is not a real menu, but is used as a fallback for all of
3372 menus except for the pager and editor modes. If a key is not
3374 another menu, Mutt-ng will look for a binding to use in this
3376 you to bind a key to a certain function in multiple menus
3378 multiple bind statements to accomplish the same task.
3386 The alias menu is the list of your personal aliases as defined
3388 muttrc. It is the mapping from a short alias name to the full
3390 address(es) of the recipient(s).
3398 The attachment menu is used to access the attachments on
3404 <term>browser</term>
3407 The browser is used for both browsing the local directory
3409 listing all of your incoming mailboxes.
3417 The editor is the line-based editor the user enters text data.
3425 The index is the list of messages contained in a mailbox.
3430 <term>compose</term>
3433 The compose menu is the screen used when sending a new message.
3441 The pager is the mode used to display message/attachment data,
3451 The pgp menu is used to select the OpenPGP keys used for
3458 <term>postpone</term>
3461 The postpone menu is similar to the index menu, except is used
3463 recalling a message the user was composing, but saved until
3472 <emphasis>key</emphasis> is the key (or key sequence) you wish to bind.
3474 control character, use the sequence <emphasis>\Cx</emphasis>,
3475 where <emphasis>x</emphasis> is the
3476 letter of the control character (for example, to specify control-A use
3477 ``\Ca''). Note that the case of <emphasis>x</emphasis> as well as
3478 <emphasis>\C</emphasis> is
3479 ignored, so that <emphasis>\CA</emphasis>, <emphasis>\Ca</emphasis>, <emphasis>
3482 and <emphasis>\ca</emphasis> are all
3483 equivalent. An alternative form is to specify the key as a three digit
3484 octal number prefixed with a ``\'' (for example <emphasis>
3488 equivalent to <emphasis>\c?</emphasis>).
3492 In addition, <emphasis>key</emphasis> may consist of:
3497 <table frame="none" rowsep="1">
3498 <title>Alternative Key Names</title>
3499 <tgroup cols="2" align="left" colsep="1" rowsep="1">
3502 <entry>Sequence</entry>
3503 <entry>Description</entry>
3508 <entry><literal>\t</literal></entry>
3512 <entry><literal><tab></literal></entry>
3516 <entry><literal><backtab></literal></entry>
3517 <entry>backtab / shift-tab</entry>
3520 <entry><literal>\r</literal></entry>
3521 <entry>carriage return</entry>
3524 <entry><literal>\n</literal></entry>
3525 <entry>newline</entry>
3528 <entry><literal>\e</literal></entry>
3529 <entry>escape</entry>
3532 <entry><literal><esc></literal></entry>
3533 <entry>escape</entry>
3536 <entry><literal><up></literal></entry>
3537 <entry>up arrow</entry>
3540 <entry><literal><down></literal></entry>
3541 <entry>down arrow</entry>
3544 <entry><literal><left></literal></entry>
3545 <entry>left arrow</entry>
3548 <entry><literal><right></literal></entry>
3549 <entry>right arrow</entry>
3552 <entry><literal><pageup></literal></entry>
3553 <entry>Page Up</entry>
3556 <entry><literal><pagedown></literal></entry>
3557 <entry>Page Down</entry>
3560 <entry><literal><backspace></literal></entry>
3561 <entry>Backspace</entry>
3564 <entry><literal><delete></literal></entry>
3565 <entry>Delete</entry>
3568 <entry><literal><insert></literal></entry>
3569 <entry>Insert</entry>
3572 <entry><literal><enter></literal></entry>
3573 <entry>Enter</entry>
3576 <entry><literal><return></literal></entry>
3577 <entry>Return</entry>
3580 <entry><literal><home></literal></entry>
3584 <entry><literal><end></literal></entry>
3588 <entry><literal><space></literal></entry>
3589 <entry>Space bar</entry>
3592 <entry><literal><f1></literal></entry>
3593 <entry>function key 1</entry>
3596 <entry><literal><f10></literal></entry>
3597 <entry>function key 10</entry>
3606 <emphasis>key</emphasis> does not need to be enclosed in quotes unless
3612 <emphasis>function</emphasis> specifies which action to take when <emphasis>
3616 For a complete list of functions, see the <link linkend="functions">functions</link>.
3617 The special function <literal>noop</literal> unbinds the specified key
3627 <sect1 id="charset-hook">
3628 <title>Defining aliases for character sets</title>
3630 <anchor id="iconv-hook"/>
3632 Usage: <muttng-doc:hook name="charset"/> <emphasis>alias</emphasis> <emphasis> charset</emphasis>
3635 Usage: <muttng-doc:hook name="iconv"/> <emphasis>charset</emphasis> <emphasis> local-charset </emphasis>
3639 The <muttng-doc:hook name="charset"/> command defines an alias for a
3641 This is useful to properly display messages which are tagged with a
3642 character set name not known to mutt.
3646 The <muttng-doc:hook name="iconv"/> command defines a system-specific
3648 character set. This is helpful when your systems character
3649 conversion library insists on using strange, system-specific names
3659 <sect1 id="folder-hook">
3660 <title>Setting variables based upon mailbox</title>
3663 Usage: <muttng-doc:hook name="folder"/> [!]<emphasis>regexp</emphasis> <emphasis>command</emphasis>
3667 It is often desirable to change settings based on which mailbox you are
3668 reading. The <muttng-doc:hook name="folder"/> command provides a method by which you can
3670 any configuration command. <emphasis>regexp</emphasis> is a regular
3671 expression specifying
3672 in which mailboxes to execute <emphasis>command</emphasis> before
3673 loading. If a mailbox
3674 matches multiple <muttng-doc:hook name="folder"/>'s, they are executed in the order given in
3680 <emphasis role="bold">Note:</emphasis> if you use the ``!'' shortcut
3681 for <muttng-doc:varref name="spoolfile"/> at the beginning of the
3682 pattern, you must place it
3683 inside of double or single quotes in order to distinguish it from the
3684 logical <emphasis>not</emphasis> operator for the expression.
3688 Note that the settings are <emphasis>not</emphasis> restored when you
3690 For example, a command action to perform is to change the sorting
3691 methodbased upon the mailbox being read:
3697 folder-hook mutt set sort=threads</screen>
3702 However, the sorting method is not restored to its previous value when
3703 reading a different mailbox. To specify a <emphasis>default</emphasis>
3711 folder-hook . set sort=date-sent</screen>
3721 <sect1 id="command-macro">
3722 <title>Keyboard macros</title>
3725 Usage: <muttng-doc:command name="macro"/> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [<emphasis>description</emphasis>]
3729 Macros are useful when you would like a single key to perform a series
3731 actions. When you press <emphasis>key</emphasis> in menu <emphasis>
3734 ,Mutt-ng will behave as if
3735 you had typed <emphasis>sequence</emphasis>. So if you have a common
3736 sequence of commands
3737 you type, you can create a macro to execute those commands with a
3742 <emphasis>menu</emphasis> is the <link linkend="maps">maps</link> which
3743 the macro will be bound.
3744 Multiple maps may be specified by separating multiple menu arguments by
3745 commas. Whitespace may not be used in between the menu arguments and
3746 thecommas separating them.
3750 <emphasis>key</emphasis> and <emphasis>sequence</emphasis> are expanded
3751 by the same rules as the <muttng-doc:command name="bind"/>. There are
3752 some additions however. The
3753 first is that control characters in <emphasis>sequence</emphasis> can
3755 as <emphasis>^x</emphasis>. In order to get a caret (`^'')
3757 <emphasis>^^</emphasis>. Secondly, to specify a certain key
3758 such as <emphasis>up</emphasis>
3759 or to invoke a function directly, you can use the format
3760 <emphasis><key name></emphasis> and <emphasis><function
3763 .For a listing of key
3764 names see the section on <muttng-doc:command name="bind"/>. Functions
3765 are listed in the <link linkend="functions">functions</link>.
3769 The advantage with using function names directly is that the macros
3770 willwork regardless of the current key bindings, so they are not
3772 the user having particular key definitions. This makes them more
3773 robustand portable, and also facilitates defining of macros in files
3775 than one user (eg. the system Muttngrc).
3779 Optionally you can specify a descriptive text after <emphasis>sequence</emphasis>,
3780 which is shown in the help screens.
3784 <emphasis role="bold">Note:</emphasis> Macro definitions (if any)
3785 listed in the help screen(s), are
3786 silently truncated at the screen width, and are not wrapped.
3795 <sect1 id="command-color"><anchor id="command-uncolor"/>
3796 <title>Using color and mono video attributes</title>
3798 <anchor id="command-mono"/>
3799 <anchor id="command-unmono"/>
3801 Usage: <muttng-doc:command name="color"/> <emphasis>object</emphasis> <emphasis>foreground</emphasis><emphasis>background</emphasis> [<emphasis>regexp</emphasis>]
3804 Usage: <muttng-doc:command name="color"/> index <emphasis>foreground</emphasis> <emphasis>background</emphasis><emphasis>pattern</emphasis>
3807 Usage: <muttng-doc:command name="uncolor"/> index <emphasis>pattern</emphasis>[<emphasis>pattern</emphasis>...]
3811 If your terminal supports color, you can spice up Mutt-ng by creating
3813 color scheme. To define the color of an object (type of information),
3815 must specify both a foreground color <emphasis role="bold">and</emphasis> a background color (it is not
3816 possible to only specify one or the other).
3820 <emphasis>object</emphasis> can be one of:
3835 body (match <emphasis>regexp</emphasis> in the body of messages)
3841 bold (highlighting bold patterns in the body of messages)
3847 error (error messages printed by Mutt-ng)
3853 header (match <emphasis>regexp</emphasis> in the message header)
3859 hdrdefault (default color of the message header in the pager)
3865 index (match <emphasis>pattern</emphasis> in the message index)
3871 indicator (arrow or bar used to indicate the current item in a
3878 markers (the ``+'' markers at the beginning of wrapped lines in
3885 message (informational messages)
3897 quoted (text matching <muttng-doc:varref name="quote-regexp"/> in the body of a message)
3903 quoted1, quoted2, ..., quoted<emphasis role="bold">N</emphasis>
3904 (higher levels of quoting)
3910 search (highlighting of words in the pager)
3922 status (mode lines used to display info about the mailbox or
3929 tilde (the ``~'' used to pad blank lines in the pager)
3935 tree (thread tree drawn in the message index and attachment menu)
3941 underline (highlighting underlined patterns in the body of
3951 <emphasis>foreground</emphasis> and <emphasis>background</emphasis> can
3952 be one of the following:
4015 color<emphasis>x</emphasis>
4024 <emphasis>foreground</emphasis> can optionally be prefixed with the
4025 keyword <literal>bright</literal> to make
4026 the foreground color boldfaced (e.g., <literal>brightred</literal>).
4030 If your terminal supports it, the special keyword <emphasis>default</emphasis> can be
4031 used as a transparent color. The value <emphasis>brightdefault</emphasis> is also valid.
4032 If Mutt-ng is linked against the <emphasis>S-Lang</emphasis> library,
4033 you also need to set
4034 the <muttng-doc:envvar name="COLORFGBG"/> environment variable to the default
4036 terminal for this to work; for example (for Bourne-like shells):
4042 set COLORFGBG="green;black"
4043 export COLORFGBG</screen>
4048 <emphasis role="bold">Note:</emphasis> The <emphasis>S-Lang</emphasis>
4049 library requires you to use the <emphasis>lightgray</emphasis>
4050 and <emphasis>brown</emphasis> keywords instead of <emphasis>white</emphasis> and <emphasis>
4054 setting this variable.
4058 <emphasis role="bold">Note:</emphasis> The uncolor command can be
4059 applied to the index object only. It
4060 removes entries from the list. You <emphasis role="bold">must</emphasis> specify the same pattern
4061 specified in the color command for it to be removed. The pattern ``*''
4063 a special token which means to clear the color index list of all
4068 Mutt-ng also recognizes the keywords <emphasis>color0</emphasis>, <emphasis>
4072 <emphasis>color</emphasis><emphasis role="bold">N-1</emphasis> (<emphasis role="bold">
4075 being the number of colors supported
4076 by your terminal). This is useful when you remap the colors for your
4077 display (for example by changing the color associated with <emphasis>
4080 for your xterm), since color names may then lose their normal meaning.
4084 If your terminal does not support color, it is still possible change
4086 attributes through the use of the ``mono'' command:
4090 Usage: <muttng-doc:command name="mono"/> <emphasis><object> <attribute></emphasis>[<emphasis>regexp</emphasis>]
4093 Usage: <muttng-doc:command name="mono"/> index <emphasis>attribute</emphasis> <emphasis>pattern</emphasis>
4096 Usage: <muttng-doc:command name="unmono"/> index <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
4100 where <emphasis>attribute</emphasis> is one of the following:
4147 <sect1 id="command-ignore"><anchor id="command-unignore"/>
4148 <title>Ignoring (weeding) unwanted message headers</title>
4151 Usage: <muttng-doc:command name="ignore"/> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
4155 Usage: <muttng-doc:command name="unignore"/> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
4159 Messages often have many header fields added by automatic processing
4161 or which may not seem useful to display on the screen. This command
4163 you to specify header fields which you don't normally want to see.
4167 You do not need to specify the full header field name. For example,
4168 ``ignore content-'' will ignore all header fields that begin with the
4170 ``content-''. ``ignore *'' will ignore all headers.
4174 To remove a previously added token from the list, use the ``unignore''
4176 The ``unignore'' command will make Mutt-ng display headers with the
4178 For example, if you do ``ignore x-'' it is possible to ``unignore
4183 ``unignore *'' will remove all tokens from the ignore list.
4190 # Sven's draconian header weeding
4192 unignore from date subject to cc
4193 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
4194 unignore posted-to:</screen>
4204 <sect1 id="command-alternates"><anchor id="command-unalternates"/>
4205 <title>Alternative addresses</title>
4208 Usage: <muttng-doc:command name="alternates"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4212 Usage: <muttng-doc:command name="unalternates"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4216 With various functions, mutt will treat messages differently,
4217 depending on whether you sent them or whether you received them from
4218 someone else. For instance, when replying to a message that you
4219 sent to a different party, mutt will automatically suggest to send
4220 the response to the original message's recipients--responding to
4221 yourself won't make much sense in many cases.
4222 (See <muttng-doc:varref name="reply-to"/>.)
4226 Many users receive e-mail under a number of different addresses. To
4227 fully use mutt's features here, the program must be able to
4228 recognize what e-mail addresses you receive mail under. That's the
4229 purpose of the <literal>alternates</literal> command: It takes a list
4231 expressions, each of which can identify an address under which you
4236 The <literal>unalternates</literal> command can be used to write
4238 <literal>alternates</literal> patterns. If an address matches something
4240 <literal>alternates</literal> command, but you nonetheless do not think
4242 from you, you can list a more precise pattern under an <literal>
4249 To remove a regular expression from the <literal>alternates</literal>
4251 <literal>unalternates</literal> command with exactly the same <emphasis>
4255 Likewise, if the <emphasis>regexp</emphasis> for a <literal>alternates</literal> command matches
4256 an entry on the <literal>unalternates</literal> list, that <literal>
4259 entry will be removed. If the <emphasis>regexp</emphasis> for <literal>
4262 is ``*'', <emphasis>all entries</emphasis> on <literal>alternates</literal> will be removed.
4271 <sect1 id="format-flowed">
4272 <title>Format = Flowed</title>
4274 <sect2 id="format-flowed-intro">
4275 <title>Introduction</title>
4278 Mutt-ng contains support for so-called <literal>format=flowed</literal> messages.
4279 In the beginning of email, each message had a fixed line width, and
4280 it was enough for displaying them on fixed-size terminals. But times
4281 changed, and nowadays hardly anybody still uses fixed-size terminals:
4282 more people nowaydays use graphical user interfaces, with dynamically
4283 resizable windows. This led to the demand of a new email format that
4284 makes it possible for the email client to make the email look nice
4285 in a resizable window without breaking quoting levels and creating
4286 an incompatible email format that can also be displayed nicely on
4287 old fixed-size terminals.
4291 For introductory information on <literal>format=flowed</literal>
4293 <muttng-doc:web url="http://www.joeclark.org/ffaq.html"/>.
4298 <sect2 id="format-flowed-display">
4299 <title>Receiving: Display Setup</title>
4302 When you receive emails that are marked as <literal>format=flowed</literal>
4303 messages, and is formatted correctly, mutt-ng will try to reformat
4304 the message to optimally fit on your terminal. If you want a fixed
4305 margin on the right side of your terminal, you can set the
4312 set wrapmargin = 10</screen>
4317 The code above makes the line break 10 columns before the right
4318 side of the terminal.
4322 If your terminal is so wide that the lines are embarrassingly long,
4323 you can also set a maximum line length:
4329 set max_line_length = 120</screen>
4334 The example above will give you lines not longer than 120
4339 When you view at <literal>format=flowed</literal> messages, you will
4341 the quoting hierarchy like in the following example:
4347 >Bill, can you please send last month's progress report to Mr.
4348 >Morgan? We also urgently need the cost estimation for the new
4349 >production server that we want to set up before our customer's
4350 >project will go live.</screen>
4355 This obviously doesn't look very nice, and it makes it very
4356 hard to differentiate between text and quoting character. The
4357 solution is to configure mutt-ng to "stuff" the quoting:
4363 set stuff_quoted</screen>
4368 This will lead to a nicer result that is easier to read:
4374 > Bill, can you please send last month's progress report to Mr.
4375 > Morgan? We also urgently need the cost estimation for the new
4376 > production server that we want to set up before our customer's
4377 > project will go live.</screen>
4383 <sect2 id="format-flowed-send">
4384 <title>Sending</title>
4387 If you want mutt-ng to send emails with <literal>format=flowed</literal> set, you
4388 need to explicitly set it:
4394 set text_flowed</screen>
4399 Additionally, you have to use an editor which supports writing
4400 <literal>format=flowed</literal>-conforming emails. For <muttng-doc:man name="vim"/>, this is
4402 adding <literal>w</literal> to the formatoptions (see <literal>:h
4406 <literal>:h fo-table</literal>) when writing emails.
4410 Also note that <emphasis>format=flowed</emphasis> knows about
4412 that is, when sending messages, some kinds of lines have to be
4413 indented with a single space on the sending side. On the receiving
4414 side, the first space (if any) is removed. As a consequence and in
4415 addition to the above simple setting, please keep this in mind when
4416 making manual formattings within the editor. Also note that mutt-ng
4417 currently violates the standard (<muttng-doc:rfc num="3676"/>) as it does not
4418 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
4437 Please make sure that you manually prepend a space to each of them.
4442 <sect2 id="format-flowed-notes">
4443 <title>Additional Notes</title>
4446 For completeness, the <muttng-doc:varref name="delete-space"/> variable provides the mechanism
4447 to generate a <literal>DelSp=yes</literal> parameter on <emphasis>
4451 According to the standard, clients receiving a <literal>format=flowed</literal>
4452 messages should delete the last space of a flowed line but still
4453 interpret the line as flowed. Because flowed lines usually contain
4454 only one space at the end, this parameter would make the receiving
4455 client concatenate the last word of the previous with the first of
4456 the current line <emphasis>without</emphasis> a space. This makes
4458 unreadable and is intended for languages rarely using spaces. So
4459 please use this setting only if you're sure what you're doing.
4470 <sect1 id="command-lists"><anchor id="command-unlists"/><anchor id="command-subscribe"/>
4471 <anchor id="command-unsubscribe"/>
4472 <title>Mailing lists</title>
4475 Usage: <muttng-doc:command name="lists"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4478 Usage: <muttng-doc:command name="unlists"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4481 Usage: <muttng-doc:command name="subscribe"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4484 Usage: <muttng-doc:command name="unsubscribe"/> <emphasis>regexp</emphasis> [<emphasis>regexp</emphasis>...]
4488 Mutt-ng has a few nice features for <link linkend="using-lists">using-lists</link>.
4489 In order to take advantage of them, you must
4490 specify which addresses belong to mailing lists, and which mailing
4491 lists you are subscribed to. Once you have done this, the
4492 <link linkend="func-list-reply">list-reply</link>
4493 function will work for all known lists.
4494 Additionally, when you send a message to a subscribed list, mutt will
4495 add a Mail-Followup-To header to tell other users' mail user agents
4496 not to send copies of replies to your personal address. Note that
4497 the Mail-Followup-To header is a non-standard extension which is not
4498 supported by all mail user agents. Adding it is not bullet-proof
4500 receiving personal CCs of list messages. Also note that the generation
4501 of the Mail-Followup-To header is controlled by the
4502 <muttng-doc:varref name="followup-to"/>
4503 configuration variable.
4507 More precisely, Mutt-ng maintains lists of patterns for the addresses
4508 of known and subscribed mailing lists. Every subscribed mailing
4509 list is known. To mark a mailing list as known, use the ``lists''
4510 command. To mark it as subscribed, use ``subscribe''.
4514 You can use regular expressions with both commands. To mark all
4515 messages sent to a specific bug report's address on mutt's bug
4516 tracking system as list mail, for instance, you could say
4517 ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
4518 give a portion of the list's e-mail address.
4522 Specify as much of the address as you need to to remove ambiguity. For
4523 example, if you've subscribed to the Mutt-ng mailing list, you will
4525 addressed to <emphasis>mutt-users@mutt.org</emphasis>. So, to tell
4526 Mutt-ng that this is a
4527 mailing list, you could add ``lists mutt-users'' to your
4528 initialization file. To tell mutt that you are subscribed to it,
4529 add ``subscribe mutt-users'' to your initialization file instead.
4530 If you also happen to get mail from someone whose address is
4531 <emphasis>mutt-users@example.com</emphasis>, you could use ``lists
4532 mutt-users@mutt\\.org''
4533 or ``subscribe mutt-users@mutt\\.org'' to
4534 match only mail from the actual list.
4538 The ``unlists'' command is used to remove a token from the list of
4539 known and subscribed mailing-lists. Use ``unlists *'' to remove all
4544 To remove a mailing list from the list of subscribed mailing lists,
4545 but keep it on the list of known mailing lists, use ``unsubscribe''.
4554 <sect1 id="mbox-hook">
4555 <title>Using Multiple spool mailboxes</title>
4558 Usage: <muttng-doc:hook name="mbox"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4562 This command is used to move read messages from a specified mailbox to
4563 adifferent mailbox automatically when you quit or change folders.
4564 <emphasis>pattern</emphasis> is a regular expression specifying the
4565 mailbox to treat as a
4566 ``spool'' mailbox and <emphasis>mailbox</emphasis> specifies where mail
4567 should be saved when
4572 Unlike some of the other <emphasis>hook</emphasis> commands, only the <emphasis>
4576 pattern is used (it is not possible to save read mail in more than a
4587 <sect1 id="command-mailboxes"><anchor id="command-unmailboxes"/>
4588 <title>Defining mailboxes which receive mail</title>
4591 Usage: <muttng-doc:command name="mailboxes"/> [!]<emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
4594 Usage: <muttng-doc:command name="unmailboxes"/> [!]<emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
4598 This command specifies folders which can receive mail and
4599 which will be checked for new messages. By default, the
4600 main menu status bar displays how many of these folders have
4605 When changing folders, pressing <emphasis>space</emphasis> will cycle
4606 through folders with new mail.
4610 Pressing TAB in the directory browser will bring up a menu showing the
4612 specified by the <literal>mailboxes</literal> command, and indicate
4614 messages. Mutt-ng will automatically enter this mode when invoked from
4616 command line with the <literal>-y</literal> option.
4620 The ``unmailboxes'' command is used to remove a token from the list
4621 of folders which receive mail. Use ``unmailboxes *'' to remove all
4626 <emphasis role="bold">Note:</emphasis> new mail is detected by
4627 comparing the last modification time to
4628 the last access time. Utilities like <literal>biff</literal> or <literal>
4632 program which accesses the mailbox might cause Mutt-ng to never detect
4634 for that mailbox if they do not properly reset the access time. Backup
4635 tools are another common reason for updated access times.
4639 <emphasis role="bold">Note:</emphasis> the filenames in the <literal>
4642 command are resolved when
4643 the command is executed, so if these names contain <link linkend="shortcuts">shortcuts</link>
4644 (such as ``='' and ``!''), any variable
4645 definition that affect these characters (like <muttng-doc:varref name="folder"/>
4646 and <muttng-doc:varref name="spoolfile"/>)
4647 should be executed before the <literal>mailboxes</literal> command.
4656 <sect1 id="command-my-hdr"><anchor id="command-unmy-hdr"/>
4657 <title>User defined headers</title>
4660 Usage: <muttng-doc:command name="my-hdr"/> <emphasis>string</emphasis>
4663 Usage: <muttng-doc:command name="unmy-hdr"/> <emphasis>field</emphasis> [<emphasis>field</emphasis>...]
4667 The ``my_hdr'' command allows you to create your own header
4668 fields which will be added to every message you send.
4672 For example, if you would like to add an ``Organization:'' header field
4674 all of your outgoing messages, you can put the command
4679 my_hdr Organization: A Really Big Company, Anytown, USA</screen>
4683 in your <literal>.muttrc</literal>.
4687 <emphasis role="bold">Note:</emphasis> space characters are <emphasis>
4690 allowed between the keyword and
4691 the colon (``:''). The standard for electronic mail (<muttng-doc:rfc num="822"/>) says that
4692 space is illegal there, so Mutt-ng enforces the rule.
4696 If you would like to add a header field to a single message, you should
4697 either set the <muttng-doc:varref name="edit-headers"/>
4699 or use the <emphasis>edit-headers</emphasis> function (default: ``E'')
4701 that you can edit the header of your message along with the body.
4705 To remove user defined header fields, use the ``unmy_hdr''
4706 command. You may specify an asterisk (``*'') to remove all header
4707 fields, or the fields to remove. For example, to remove all ``To'' and
4708 ``Cc'' header fields, you could use:
4713 unmy_hdr to cc</screen>
4722 <sect1 id="command-hdr-order"><anchor id="command-unhdr-order"/>
4723 <title>Defining the order of headers when viewing messages</title>
4726 Usage: <muttng-doc:command name="hdr-order"/> <emphasis>header1</emphasis><emphasis>header2</emphasis> <emphasis>header3</emphasis>
4730 With this command, you can specify an order in which mutt will attempt
4731 to present headers to you when viewing messages.
4735 ``unhdr_order *'' will clear all previous headers from the order
4737 thus removing the header order effects set by the system-wide startup
4744 hdr_order From Date: From: To: Cc: Subject:</screen>
4754 <sect1 id="save-hook">
4755 <title>Specify default save filename</title>
4758 Usage: <muttng-doc:hook name="save"/> [!]<emphasis>pattern</emphasis> <emphasis>filename</emphasis>
4762 This command is used to override the default filename used when saving
4763 messages. <emphasis>filename</emphasis> will be used as the default
4764 filename if the message is
4765 <emphasis>From:</emphasis> an address matching <emphasis>regexp</emphasis> or if you are the author and the
4766 message is addressed <emphasis>to:</emphasis> something matching <emphasis>
4773 See <muttng-doc:hook name="pattern"/> for information on
4774 the exact format of <emphasis>pattern</emphasis>.
4784 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
4785 save-hook aol\\.com$ +spam</screen>
4790 Also see the <muttng-doc:hook name="fcc-save"/>
4800 <sect1 id="fcc-hook">
4801 <title>Specify default Fcc: mailbox when composing</title>
4804 Usage: <muttng-doc:hook name="fcc"/> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4808 This command is used to save outgoing mail in a mailbox other than
4809 <muttng-doc:varref name="record"/>. Mutt-ng searches the initial
4811 message recipients for the first matching <emphasis>regexp</emphasis>
4812 and uses <emphasis>mailbox</emphasis>
4813 as the default Fcc: mailbox. If no match is found the message will be
4815 to <muttng-doc:varref name="record"/> mailbox.
4819 See <muttng-doc:hook name="pattern"/> for information on
4820 the exact format of <emphasis>pattern</emphasis>.
4824 Example: <literal><muttng-doc:hook name="fcc"/> [@.]aol\\.com$
4830 The above will save a copy of all messages going to the aol.com domain
4832 the `+spammers' mailbox by default. Also see the <muttng-doc:hook name="fcc-save"/>
4842 <sect1 id="fcc-save-hook">
4843 <title>Specify default save filename and default Fcc: mailbox at once</title>
4846 Usage: <literal><muttng-doc:hook name="fcc-save"/></literal> [!]<emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
4850 This command is a shortcut, equivalent to doing both a <muttng-doc:hook name="fcc"/>
4851 and a <muttng-doc:hook name="save"/> with its arguments.
4860 <sect1 id="send-hook">
4861 <title>Change settings based upon message recipients</title>
4863 <anchor id="reply-hook"/>
4864 <anchor id="send2-hook"/>
4866 Usage: <muttng-doc:hook name="reply"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4869 Usage: <muttng-doc:hook name="send"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4872 Usage: <muttng-doc:hook name="send2"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4876 These commands can be used to execute arbitrary configuration commands
4878 upon recipients of the message. <emphasis>pattern</emphasis> is a
4880 matching the desired address. <emphasis>command</emphasis> is executed
4881 when <emphasis>regexp</emphasis>
4882 matches recipients of the message.
4886 <muttng-doc:hook name="reply"/> is matched against the message you are <emphasis>
4889 <emphasis role="bold">to</emphasis>, instead of the message you are <emphasis>
4892 .<muttng-doc:hook name="send"/> is
4893 matched against all messages, both <emphasis>new</emphasis> and <emphasis>
4896 .<emphasis role="bold">Note:</emphasis>
4897 <muttng-doc:hook name="reply"/>s are matched <emphasis role="bold">before</emphasis> the
4898 <muttng-doc:hook name="send"/>, <emphasis role="bold">regardless</emphasis>
4899 of the order specified in the users's configuration file.
4903 <muttng-doc:hook name="send2"/> is matched every time a message is
4905 by editing it, or by using the compose menu to change its recipients
4906 or subject. <muttng-doc:hook name="send2"/> is executed after <muttng-doc:hook name="send"/>
4908 can, e.g., be used to set parameters such as the <muttng-doc:varref name="sendmail"/>
4909 variable depending on the message's sender
4914 For each type of <muttng-doc:hook name="send"/> or <muttng-doc:hook name="reply"/>, when multiple matches
4915 occur, commands are executed in the order they are specified in the
4917 (for that type of hook).
4921 See <muttng-doc:hook name="pattern"/> for information on
4922 the exact format of <emphasis>pattern</emphasis>.
4926 Example: <literal>send-hook mutt "set mime_forward
4932 Another typical use for this command is to change the values of the
4933 <muttng-doc:varref name="attribution"/>,
4934 <muttng-doc:varref name="signature"/> and <muttng-doc:varref
4936 variables in order to change the language of the attributions and
4937 signatures based upon the recipients.
4941 <emphasis role="bold">Note:</emphasis> the <muttng-doc:hook name="send"/>'s are only
4942 executed ONCE after getting the initial
4943 list of recipients. Adding a recipient after replying or editing the
4944 message will NOT cause any <muttng-doc:hook name="send"/> to be executed. Also note that
4945 my_hdr commands which modify recipient headers, or the message's
4946 subject, don't have any effect on the current message when executed
4947 from a <muttng-doc:hook name="send"/>.
4956 <sect1 id="message-hook">
4957 <title>Change settings before formatting a message</title>
4960 Usage: <muttng-doc:hook name="message"/> [!]<emphasis>pattern</emphasis> <emphasis>command</emphasis>
4964 This command can be used to execute arbitrary configuration commands
4965 before viewing or formatting a message based upon information about the
4967 <emphasis>command</emphasis> is executed if the <emphasis>pattern</emphasis> matches the message to be
4968 displayed. When multiple matches occur, commands are executed in the
4970 they are specified in the muttrc.
4974 See <muttng-doc:hook name="pattern"/> for
4975 information on the exact format of <emphasis>pattern</emphasis>.
4982 message-hook <muttng-doc:pattern name="A"/> 'set pager=builtin'
4983 message-hook '<muttng-doc:pattern name="f"/> freshmeat-news' 'set pager="less \"+/^ subject:.*\""'</screen>
4993 <sect1 id="crypt-hook">
4994 <title>Choosing the cryptographic key of the recipient</title>
4997 Usage: <muttng-doc:hook name="crypt"/> <emphasis>pattern</emphasis> <emphasis>keyid</emphasis>
5001 When encrypting messages with PGP or OpenSSL, you may want to associate
5003 key with a given e-mail address automatically, either because the
5004 recipient's public key can't be deduced from the destination address,
5005 or because, for some reasons, you need to override the key Mutt-ng
5006 wouldnormally use. The <muttng-doc:hook name="crypt"/> command provides a method by which
5008 specify the ID of the public key to be used when encrypting messages to
5009 a certain recipient.
5013 The meaning of "key id" is to be taken broadly in this context: You
5014 can either put a numerical key ID here, an e-mail address, or even
5024 <sect1 id="command-push">
5025 <title>Adding key sequences to the keyboard buffer</title>
5028 Usage: <muttng-doc:command name="push"/> <emphasis>string</emphasis>
5033 This command adds the named string to the keyboard buffer. The
5034 string may contain control characters, key names and function
5035 names like the sequence string in the <muttng-doc:command name="macro"/> command. You may use it to
5036 automatically run a sequence of commands at startup, or when
5037 entering certain folders. For example, the following command
5038 will automatically collapse all threads when entering a folder:
5041 folder-hook . 'push <collapse-all>'
5052 <sect1 id="command-exec">
5053 <title>Executing functions</title>
5056 Usage: <muttng-doc:command name="exec"/> <emphasis>function</emphasis> [<emphasis>function</emphasis>...]
5060 This command can be used to execute any function. Functions are
5061 listed in the <link linkend="functions">functions</link>.
5062 ``exec function'' is equivalent to ``push <function>''.
5071 <sect1 id="command-score"><anchor id="command-unscore"/>
5072 <title>Message Scoring</title>
5075 Usage: <muttng-doc:command name="score"/> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
5078 Usage: <muttng-doc:command name="unscore"/> <emphasis>pattern</emphasis> [<emphasis>pattern</emphasis>...]
5082 In situations where you have to cope with a lot of emails, e.g.
5083 when you read many different mailing lists, and take part in
5084 discussions, it is always useful to have the important messages
5085 marked and the annoying messages or the ones that you aren't
5086 interested in deleted. For this purpose, mutt-ng features a
5087 mechanism called ``scoring''.
5091 When you use scoring, every message has a base score of 0. You
5092 can then use the <literal>score</literal> command to define patterns
5094 positive or negative value associated with it. When a pattern
5095 matches a message, the message's score will be raised or lowered by
5096 the amount of the value associated with the pattern.
5102 score "<muttng-doc:pattern name="f"/> nion@muttng\.org" 50
5103 score "<muttng-doc:pattern name="f"/> @sco\.com" -100</screen>
5108 If the pattern matches, it is also possible to set the score
5109 value of the current message to a certain value and then stop
5116 score "<muttng-doc:pattern name="f"/> santaclaus@northpole\.int" =666</screen>
5121 What is important to note is that negative score values will be
5126 To make scoring actually useful, the score must be applied in
5127 some way. That's what the <emphasis>score thresholds</emphasis> are
5129 there are three score thresholds:
5138 flag threshold: when a message has a score value equal or higher
5139 than the flag threshold, it will be flagged.
5146 read threshold: when a message has a score value equal or lower
5147 than the read threshold, it will be marked as read.
5154 delete threshold: when a message has a score value equal or
5155 lower than the delete threshold, it will be marked as deleted.
5165 These three thresholds can be set via the variables
5166 <muttng-doc:varref name="score-threshold-read"/>,
5167 <muttng-doc:varref name="score-threshold-flag"/> and
5168 <muttng-doc:varref name="score-threshold-delete"/>.
5172 <muttng-doc:varref name="score-threshold-read"/> and
5173 <muttng-doc:varref name="score-threshold-delete"/>
5175 <literal>-1</literal>, which means that in the default threshold
5177 message will ever get marked as read or deleted.
5181 Scoring gets especially interesting when combined with the <literal>
5185 and the <muttng-doc:pattern name="n"/> pattern:
5191 color index black yellow "<muttng-doc:pattern name="n"/> 10-"
5192 color index red yellow "<muttng-doc:pattern name="n"/> 100-"</screen>
5197 The rules above mark all messages with a score between 10 and 99
5198 with black and yellow, and messages with a score greater or equal
5199 100 with red and yellow. This might be unusual to you if you're used
5200 to e.g. slrn's scoring mechanism, but it is more flexible, as it
5201 visually marks different scores.
5210 <sect1 id="command-spam"><anchor id="command-nospam"/>
5211 <title>Spam detection</title>
5214 Usage: <muttng-doc:command name="spam"/> <emphasis>pattern</emphasis> <emphasis>format </emphasis>
5217 Usage: <muttng-doc:command name="nospam"/> <emphasis>pattern</emphasis>
5221 Mutt-ng has generalized support for external spam-scoring filters.
5222 By defining your spam patterns with the <literal>spam</literal> and <literal>
5225 commands, you can <emphasis>limit</emphasis>, <emphasis>search</emphasis>, and <emphasis>
5229 mail based on its spam attributes, as determined by the external
5230 filter. You also can display the spam attributes in your index
5231 display using the <literal>%H</literal> selector in the
5232 <muttng-doc:varref name="index-format"/>
5233 variable. (Tip: try <literal>%?H?[%H] ?</literal>
5234 to display spam tags only when they are defined for a given message.)
5238 Your first step is to define your external filter's spam patterns using
5239 the <literal>spam</literal> command. <emphasis>pattern</emphasis>
5240 should be a regular expression
5241 that matches a header in a mail message. If any message in the mailbox
5242 matches this regular expression, it will receive a ``spam tag'' or
5243 ``spam attribute'' (unless it also matches a <literal>nospam</literal>
5245 below.) The appearance of this attribute is entirely up to you, and is
5246 governed by the <emphasis>format</emphasis> parameter. <emphasis>format</emphasis> can be any static
5247 text, but it also can include back-references from the <emphasis>
5250 expression. (A regular expression ``back-reference'' refers to a
5251 sub-expression contained within parentheses.) <literal>%1</literal> is replaced with
5252 the first back-reference in the regex, <literal>%2</literal>
5253 with the second, etc.
5257 If you're using multiple spam filters, a message can have more than
5258 one spam-related header. You can define <literal>spam</literal>
5260 filter you use. If a message matches two or more of these patterns, and
5261 the $spam_separator variable is set to a string, then the
5262 message's spam tag will consist of all the <emphasis>format</emphasis>
5264 together, with the value of $spam_separator separating
5269 For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
5270 define these spam settings:
5273 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
5274 spam "X-Spam-Status: Yes" "90+/SA"
5275 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
5276 set spam_separator=", "</screen>
5281 If I then received a message that DCC registered with ``many'' hits
5282 under the ``Fuz2'' checksum, and that PureMessage registered with a
5283 97% probability of being spam, that message's spam tag would
5284 read<literal>90+/DCC-Fuz2, 97/PM</literal>. (The four characters before
5286 DCC report indicate the checksum used -- in this case, ``Fuz2''.)
5290 If the $spam_separator variable is unset, then each
5291 spam pattern match supersedes the previous one. Instead of getting
5292 joined <emphasis>format</emphasis> strings, you'll get only the last
5297 The spam tag is what will be displayed in the index when you use
5298 <literal>%H</literal> in the <literal>
5301 variable. It's also the
5302 string that the <muttng-doc:pattern name="H"/> pattern-matching expression
5304 <emphasis>search</emphasis> and <emphasis>limit</emphasis> functions.
5305 And it's what sorting by spam
5306 attribute will use as a sort key.
5310 That's a pretty complicated example, and most people's actual
5311 environments will have only one spam filter. The simpler your
5312 configuration, the more effective mutt can be, especially when it comes
5317 Generally, when you sort by spam tag, mutt will sort <emphasis>
5321 that is, by ordering strings alphnumerically. However, if a spam tag
5322 begins with a number, mutt will sort numerically first, and lexically
5323 only when two numbers are equal in value. (This is like UNIX's
5324 <literal>sort -n</literal>.) A message with no spam attributes at all
5326 that didn't match <emphasis>any</emphasis> of your <literal>spam</literal> patterns -- is sorted at
5327 lowest priority. Numbers are sorted next, beginning with 0 and ranging
5328 upward. Finally, non-numeric strings are sorted, with ``a'' taking
5329 lowerpriority than ``z''. Clearly, in general, sorting by spam tags is
5331 effective when you can coerce your filter to give you a raw number. But
5332 in case you can't, mutt can still do something useful.
5336 The <literal>nospam</literal> command can be used to write exceptions
5337 to <literal>spam</literal>
5338 patterns. If a header pattern matches something in a <literal>spam</literal> command,
5339 but you nonetheless do not want it to receive a spam tag, you can list
5340 amore precise pattern under a <literal>nospam</literal> command.
5344 If the <emphasis>pattern</emphasis> given to <literal>nospam</literal>
5345 is exactly the same as the
5346 <emphasis>pattern</emphasis> on an existing <literal>spam</literal>
5347 list entry, the effect will be to
5348 remove the entry from the spam list, instead of adding an exception.
5349 Likewise, if the <emphasis>pattern</emphasis> for a <literal>spam</literal> command matches an entry
5350 on the <literal>nospam</literal> list, that <literal>nospam</literal>
5351 entry will be removed. If the
5352 <emphasis>pattern</emphasis> for <literal>nospam</literal> is ``*'', <emphasis>
5353 all entries on both lists
5355 will be removed. This might be the default action if you use <literal>
5358 and <literal>nospam</literal> in conjunction with a <muttng-doc:hook name="folder"/>.
5362 You can have as many <literal>spam</literal> or <literal>nospam</literal> commands as you like.
5363 You can even do your own primitive spam detection within mutt -- for
5364 example, if you consider all mail from <literal>MAILER-DAEMON</literal>
5366 you can use a <literal>spam</literal> command like this:
5372 spam "^From: .*MAILER-DAEMON" "999"</screen>
5382 <sect1 id="command-set"><anchor id="command-unset"/><anchor id="command-reset"/><anchor id="command-toggle"/>
5383 <title>Setting variables</title>
5386 Usage: <muttng-doc:command name="set"/> [no|inv]<emphasis>variable</emphasis>[=<emphasis>value</emphasis>] [<emphasis>variable</emphasis>...]
5389 Usage: <muttng-doc:command name="toggle"/> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
5392 Usage: <muttng-doc:command name="unset"/> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
5395 Usage: <muttng-doc:command name="reset"/> <emphasis>variable</emphasis> [<emphasis>variable</emphasis>...]
5399 This command is used to set (and unset) <link linkend="variables">variables</link>.
5400 There are four basic types of variables:
5401 boolean, number, string and quadoption. <emphasis>boolean</emphasis>
5403 <emphasis>set</emphasis> (true) or <emphasis>unset</emphasis> (false).
5404 <emphasis>number</emphasis> variables can be
5405 assigned a positive integer value.
5409 <emphasis>string</emphasis> variables consist of any number of
5410 printable characters.
5411 <emphasis>strings</emphasis> must be enclosed in quotes if they contain
5413 may also use the ``C'' escape sequences <emphasis role="bold">\n</emphasis> and <emphasis role="bold">
5417 newline and tab, respectively.
5421 <emphasis>quadoption</emphasis> variables are used to control whether
5422 or not to be prompted
5423 for certain actions, or to specify a default action. A value of <emphasis>
5426 will cause the action to be carried out automatically as if you had
5428 yes to the question. Similarly, a value of <emphasis>no</emphasis>
5430 action to be carried out as if you had answered ``no.'' A value of
5431 <emphasis>ask-yes</emphasis> will cause a prompt with a default answer
5433 <emphasis>ask-no</emphasis> will provide a default answer of ``no.''
5437 Prefixing a variable with ``no'' will unset it. Example: <literal>set
5444 For <emphasis>boolean</emphasis> variables, you may optionally prefix
5445 the variable name with
5446 <literal>inv</literal> to toggle the value (on or off). This is useful
5448 macros. Example: <literal>set invsmart_wrap</literal>.
5452 The <literal>toggle</literal> command automatically prepends the <literal>
5456 specified variables.
5460 The <literal>unset</literal> command automatically prepends the <literal>
5464 specified variables.
5468 Using the enter-command function in the <emphasis>index</emphasis>
5469 menu, you can query the
5470 value of a variable by prefixing the name of the variable with a
5478 set ?allow_8bit</screen>
5483 The question mark is actually only required for boolean and quadoption
5488 The <literal>reset</literal> command resets all given variables to the
5490 defaults (hopefully mentioned in this manual). If you use the command
5491 <literal>set</literal> and prefix the variable with ``&'' this has
5493 behavior as the reset command.
5497 With the <literal>reset</literal> command there exists the special
5499 which allows you to reset all variables to their system defaults.
5508 <sect1 id="command-source">
5509 <title>Reading initialization commands from another file</title>
5512 Usage: <muttng-doc:command name="source"/> <emphasis>filename</emphasis> [<emphasis>filename</emphasis>...]
5516 This command allows the inclusion of initialization commands
5517 from other files. For example, I place all of my aliases in
5518 <literal>~/.mail_aliases</literal> so that I can make my
5519 <literal>~/.muttrc</literal> readable and keep my aliases
5524 If the filename begins with a tilde (``~''), it will be expanded
5526 path of your home directory.
5530 If the filename ends with a vertical bar (|), then <emphasis>
5534 considered to be an executable program from which to read input (eg.
5535 <literal>source ~/bin/myscript|</literal>).
5544 <sect1 id="command-unhook">
5545 <title>Removing hooks</title>
5548 Usage: <muttng-doc:command name="unhook"/> [* | <emphasis>hook-type</emphasis>]
5552 This command permits you to flush hooks you have previously defined.
5553 You can either remove all hooks by giving the ``*'' character as an
5554 argument, or you can remove all hooks of a specific type by saying
5555 something like <literal>unhook send</literal>.
5565 <title>Sharing Setups</title>
5567 <sect2 id="share-charset">
5568 <title>Character Sets</title>
5571 As users may run mutt-ng on different systems, the configuration
5572 must be maintained because it's likely that people want to use the
5573 setup everywhere they use mutt-ng. And mutt-ng tries to help where it
5578 To not produce conflicts with different character sets, mutt-ng
5579 allows users to specify in which character set their configuration
5580 files are encoded. Please note that while reading the configuration
5581 files, this is only respected after the corresponding declaration
5582 appears. It's advised to put the following at the very beginning of a
5589 set config_charset = "..."</screen>
5594 and replacing the dots with the actual character set. To avoid
5595 problems while maintaining the setup, <muttng-doc:man name="vim"/> user's may want to use
5596 modelines as show in:
5602 # vim:fileencoding=...:</screen>
5607 while, again, replacing the dots with the appropriate name. This
5608 tells <muttng-doc:man name="vim"/> as which character set to read and save the file.
5617 <sect2 id="share-modularization">
5618 <title>Modularization</title>
5621 ``Modularization'' means to divide the setup into several files
5622 while sorting the options or commands by topic. Especially for
5623 longer setups (e.g. with many hooks), this helps maintaining it
5624 and solving trouble.
5628 When using separation, setups may be, as a whole or in
5629 fractions, shared over different systems.
5638 <sect2 id="share-conditional">
5639 <title>Conditional parts</title>
5642 When using a configuration on different systems, the user may not
5643 always have influence on how mutt-ng is installed and which features
5648 To solve this, mutt-ng contain a feature based on the ``ifdef''
5649 patch written for mutt. Its basic syntax is:
5655 ifdef <item> <command>
5656 ifndef <item> <command></screen>
5661 ...whereby <literal><item></literal> can be one of:
5701 All available functions, variables and menus are documented
5702 elsewhere in this manual but ``features'' is specific to these
5703 two commands. To test for one, prefix one of the following
5704 keywords with <literal>feature_</literal>: ncurses,
5705 slang, iconv, idn, dotlock, standalone, pop, nntp, imap, ssl,
5706 gnutls, sasl, sasl2, libesmtp, compressed, color, classic_pgp,
5707 classic_smime, gpgme, header_cache
5711 As an example, one can use the following in
5712 <literal>~/.muttngrc</literal>:
5718 ifdef feature_imap 'source ~/.mutt-ng/setup-imap'
5719 ifdef feature_pop 'source ~/.mutt-ng/setup-pop'
5720 ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp'</screen>
5725 ...to only source <literal>~/.mutt-ng/setup-imap</literal> if
5727 support is built in, only source <literal>~/.mutt-ng/setup-pop</literal>
5728 if POP support is built in and only source
5729 <literal>~/.mutt-ng/setup-nntp</literal> if NNTP support is
5734 An example for testing for variable names can be used if users
5735 use different revisions of mutt-ng whereby the older one may not
5736 have a certain variable. To test for the availability of
5737 <muttng-doc:varref name="imap-mail-check"/>
5744 ifdef imap_mail_check 'set imap_mail_check = 300'</screen>
5749 Provided for completeness is the test for menu names. To set
5750 <muttng-doc:varref name="pager-index-lines"
5753 menu is available, use:
5759 ifdef pager 'set pager_index_lines = 10'</screen>
5764 For completeness, too, the opposite of <literal>ifdef</literal> is
5766 <literal>ifndef</literal> which only executes the command if the test
5768 example, the following two examples are equivalent:
5774 ifdef feature_ncurses 'source ~/.mutt-ng/setup-ncurses'
5775 ifndef feature_ncurses 'source ~/.mutt-ng/setup-slang'</screen>
5786 ifdef feature_slang 'source ~/.mutt-ng/setup-slang'
5787 ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</screen>
5803 <sect1 id="vars-obsolete">
5804 <title>Obsolete Variables</title>
5807 In the process of ensuring and creating more consistency, many
5808 variables have been renamed and some of the old names were already
5809 removed. Please see <link linkend="sect-obsolete">sect-obsolete</link>
5810 for a complete list.
5826 <chapter id="advanced-usage"> <!--{{{-->
5827 <title>Advanced Usage</title>
5829 <sect1 id="advanced-regexp">
5830 <title>Regular Expressions</title>
5833 All string patterns in Mutt-ng including those in more complex
5834 <link linkend="tab-patterns">patterns</link> must be specified
5835 using regular expressions (regexp) in the ``POSIX extended'' syntax
5837 is more or less the syntax used by egrep and GNU awk). For your
5838 convenience, we have included below a brief description of this syntax.
5842 The search is case sensitive if the pattern contains at least one upper
5843 case letter, and case insensitive otherwise. Note that ``\''
5844 must be quoted if used for a regular expression in an initialization
5849 A regular expression is a pattern that describes a set of strings.
5850 Regular expressions are constructed analogously to arithmetic
5851 expressions, by using various operators to combine smaller expressions.
5855 Note that the regular expression can be enclosed/delimited by either
5857 or ' which is useful if the regular expression includes a white-space
5858 character. See <link linkend="configuration-syntax">muttrc-syntax</link>
5859 for more information on " and ' delimiter processing. To match a
5860 literal " or ' you must preface it with \ (backslash).
5864 The fundamental building blocks are the regular expressions that match
5865 a single character. Most characters, including all letters and digits,
5866 are regular expressions that match themselves. Any metacharacter with
5867 special meaning may be quoted by preceding it with a backslash.
5871 The period ``.'' matches any single character. The caret ``^''
5872 andthe dollar sign ``$'' are metacharacters that respectively
5874 the empty string at the beginning and end of a line.
5878 A list of characters enclosed by ``]'' and ``]'' matches any
5879 single character in that list; if the first character of the list
5880 is a caret ``^'' then it matches any character <emphasis role="bold">
5884 list. For example, the regular expression <emphasis role="bold">
5887 matches any single digit. A range of ASCII characters may be specified
5888 by giving the first and last characters, separated by a hyphen
5889 ``-''. Most metacharacters lose their special meaning inside
5890 lists. To include a literal ``]'' place it first in the list.
5891 Similarly, to include a literal ``^'' place it anywhere but first.
5892 Finally, to include a literal hyphen ``-'' place it last.
5896 Certain named classes of characters are predefined. Character classes
5897 consist of ``[:'', a keyword denoting the class, and ``:]''.
5898 The following classes are defined by the POSIX standard:
5905 <term>[:alnum:]</term>
5908 Alphanumeric characters.
5913 <term>[:alpha:]</term>
5916 Alphabetic characters.
5921 <term>[:blank:]</term>
5924 Space or tab characters.
5929 <term>[:cntrl:]</term>
5937 <term>[:digit:]</term>
5945 <term>[:graph:]</term>
5948 Characters that are both printable and visible. (A space is
5950 but not visible, while an ``a'' is both.)
5955 <term>[:lower:]</term>
5958 Lower-case alphabetic characters.
5963 <term>[:print:]</term>
5966 Printable characters (characters that are not control
5972 <term>[:punct:]</term>
5975 Punctuation characters (characters that are not letter, digits,
5977 characters, or space characters).
5982 <term>[:space:]</term>
5985 Space characters (such as space, tab and formfeed, to name a
5991 <term>[:upper:]</term>
5994 Upper-case alphabetic characters.
5999 <term>[:xdigit:]</term>
6002 Characters that are hexadecimal digits.
6010 A character class is only valid in a regular expression inside the
6011 brackets of a character list. Note that the brackets in these
6012 class names are part of the symbolic names, and must be included
6013 in addition to the brackets delimiting the bracket list. For
6014 example, <emphasis role="bold">[[:digit:]]</emphasis> is equivalent to
6015 <emphasis role="bold">[0-9]</emphasis>.
6019 Two additional special sequences can appear in character lists. These
6020 apply to non-ASCII character sets, which can have single symbols
6021 (calledcollating elements) that are represented with more than one
6023 as well as several characters that are equivalent for collating or
6031 <term>Collating Symbols</term>
6034 A collating symbol is a multi-character collating element
6036 ``[.'' and ``.]''. For example, if ``ch'' is a
6038 element, then <emphasis role="bold">
6041 is a regexp that matches
6042 this collating element, while <emphasis role="bold">
6046 matches either ``c'' or ``h''.
6051 <term>Equivalence Classes</term>
6054 An equivalence class is a locale-specific name for a list of
6055 characters that are equivalent. The name is enclosed in
6057 and ``=]''. For example, the name ``e'' might be used to
6058 represent all of ``è'' ``é'' and ``e''. In this
6060 <emphasis role="bold">[[=e=]]</emphasis> is
6061 a regexp that matches any of
6062 ``è'', ``é'' and ``e''.
6070 A regular expression matching a single character may be followed by one
6071 of several repetition operators:
6081 The preceding item is optional and matched at most once.
6089 The preceding item will be matched zero or more times.
6097 The preceding item will be matched one or more times.
6105 The preceding item is matched exactly <emphasis>n</emphasis>
6114 The preceding item is matched <emphasis>n</emphasis> or more
6123 The preceding item is matched at most <emphasis>m</emphasis>
6132 The preceding item is matched at least <emphasis>n</emphasis>
6133 times, but no more than
6134 <emphasis>m</emphasis> times.
6142 Two regular expressions may be concatenated; the resulting regular
6143 expression matches any string formed by concatenating two substrings
6144 that respectively match the concatenated subexpressions.
6148 Two regular expressions may be joined by the infix operator
6150 the resulting regular expression matches any string matching either
6155 Repetition takes precedence over concatenation, which in turn takes
6156 precedence over alternation. A whole subexpression may be enclosed in
6157 parentheses to override these precedence rules.
6161 <emphasis role="bold">Note:</emphasis> If you compile Mutt-ng with the
6162 GNU <emphasis>rx</emphasis> package, the
6163 following operators may also be used in regular expressions:
6173 Matches the empty string at either the beginning or the end of
6182 Matches the empty string within a word.
6190 Matches the empty string at the beginning of a word.
6198 Matches the empty string at the end of a word.
6206 Matches any word-constituent character (letter, digit, or
6215 Matches any character that is not word-constituent.
6223 Matches the empty string at the beginning of a buffer (string).
6231 Matches the empty string at the end of a buffer.
6239 Please note however that these operators are not defined by POSIX, so
6240 they may or may not be available in stock libraries on various systems.
6249 <sect1 id="advanced-patterns">
6250 <title>Patterns</title>
6253 Mutt-ng's pattern language provides a simple yet effective way to
6254 set up rules to match messages, e.g. for operations like tagging and
6255 scoring. A pattern consists of one or more sub-pattern, which can be
6256 logically grouped, ORed, and negated. For a complete listing of
6257 these patterns, please refer to table <link linkend="tab-patterns">patterns</link> in the Reference chapter.
6261 It must be noted that in this table, <literal>EXPR</literal> is
6262 a regular expression. For ranges, the forms
6263 <literal><[MAX]</literal>, <literal>>>[MIN]</literal>,
6264 <literal> [MIN]-</literal> and <literal>-[MAX]</literal> are
6268 <sect2 id="patterns-complex">
6269 <title>Complex Patterns</title>
6272 It is possible to combine several sub-patterns to a more complex
6273 pattern. The most simple possibility is to logically AND several
6274 patterns by stringing them together:
6280 <muttng-doc:pattern name="s"/> 'SPAM' <muttng-doc:pattern name="U"/></screen>
6285 The pattern above matches all messages that contain ``SPAM'' in
6286 the subject and are unread.
6290 To logical OR patterns, simply use the <literal>|</literal>
6292 especially useful when using local groups:
6298 <muttng-doc:pattern name="f"/> ("nion@muttng\.org"|"ak@muttng\.org"|"pdmef@muttng\.org")
6299 (<muttng-doc:pattern name="b"/> mutt-ng|<muttng-doc:pattern name="s"/> Mutt-ng)
6300 !<muttng-doc:pattern name="x"/> '@synflood\.at'</screen>
6305 The first pattern matches all messages that were sent by one of
6306 the mutt-ng maintainers, while the seconds pattern matches all
6307 messages that contain ``mutt-ng'' in the message body or ``Mutt-ng''
6308 in the subject. The third pattern matches all messages that do not
6309 contain ``@synflood\.at'' in the <literal>References:</literal>
6311 messages that are not an (indirect) reply to one of my messages. A
6312 pattern can be logicall negated using the <literal>!</literal>
6318 <sect2 sect="patterns-dates">
6319 <title>Patterns and Dates</title>
6322 When using dates in patterns, the dates must be specified in a
6323 special format, i.e. <literal>DD/MM/YYYY</literal>. If you don't
6325 month or year, they default to the current month or year. When using
6326 date ranges, and you specify only the minimum or the maximum, the
6327 specified date will be excluded, e.g. <literal>01/06/2005-</literal>
6329 against all messages <emphasis>after</emphasis> Juni 1st, 2005.
6333 It is also possible to use so-called ``error margins'' when
6334 specifying date ranges. You simply specify a date, and then the
6335 error margin. This margin needs to contain the information whether
6336 it goes ``forth'' or ``back'' in time, by using <literal>+</literal>
6337 and <literal>-</literal>.
6338 Then follows a number and a unit, i.e. <literal>y</literal> for
6339 years, <literal>m</literal> for
6340 months, <literal>w</literal> for weeks and <literal>d</literal> for
6341 days. If you use the special
6342 <literal>*</literal> sign, it means that the error margin goes to
6343 both``directions'' in time.
6349 <muttng-doc:pattern name="d"/> 01/01/2005+1y
6350 <muttng-doc:pattern name="d"/> 18/10/2004-2w
6351 <muttng-doc:pattern name="d"/> 28/12/2004*1d</screen>
6356 The first pattern matches all dates between January 1st, 2005 and
6357 January 1st 2006. The second pattern matches all dates between
6358 October 18th, 2004 and October 4th 2004 (2 weeks before 18/10/2004),
6359 while the third pattern matches all dates 1 day around December
6360 28th, 2004 (i.e. Dec 27th, 28th and 29th).
6364 Relative dates are also very important, as they make it possible
6365 to specify date ranges between a fixed number of units and the
6366 current date. How this works can be seen in the following example:
6372 <muttng-doc:pattern name="d"/> >2w # messages older than two weeks
6373 <muttng-doc:pattern name="d"/> <3d # messages newer than 3 days
6374 <muttng-doc:pattern name="d"/> =1m # messages that are exactly one month old</screen>
6386 <sect1 id="formatstrings">
6387 <title>Format Strings</title>
6389 <sect2 id="formatstrings-intro">
6390 <title>Introduction</title>
6393 The so called <emphasis>Format Strings</emphasis> offer great
6395 configuring mutt-ng. In short, they describe what items to print
6396 out how in menus and status messages.
6400 Basically, they work as this: for different menus and bars,
6401 there's a variable specifying the layout. For every item
6402 available, there is a so called <emphasis>expando</emphasis>.
6406 For example, when running mutt-ng on different machines or
6407 different versions for testing purposes, it may be interesting to
6408 have the following information always printed on screen when one
6418 the current hostname
6425 the current mutt-ng version number
6435 The setting for the status bar of the index is controlled via the
6436 <muttng-doc:varref name="status-format"/>
6437 variable. For the hostname and version string, there's an expando
6438 for <literal>$status_format</literal>: <literal>
6442 hostname and <literal>%v</literal> to the version string. When
6449 set status_format = "%v on %h: ..."</screen>
6454 mutt-ng will replace the sequence <literal>%v</literal> with
6456 and <literal>%h</literal> with the host's name. When you are,
6457 for example, running
6458 mutt-ng version <literal>1.5.9i</literal> on host <literal>mailhost</literal>, you'll see the
6459 following when you're in the index:
6465 Mutt-ng 1.5.9i on mailhost: ...</screen>
6470 In the index, there're more useful information one could want to
6480 which mailbox is open
6487 how man new, flagged or postponed messages
6504 To include the mailbox' name is as easy as:
6510 set status_format = "%v on %h: %B: ...</screen>
6515 When the currently opened mailbox is <literal>Inbox</literal>, this
6523 Mutt-ng 1.5.9i on mailhost: Inbox: ...</screen>
6528 For the number of certain types of messages, one more feature of the
6530 strings is extremely useful. If there aren't messages of a certain
6532 may not be desired to print just that there aren't any but instead
6534 print something if there are any.
6543 <sect2 id="formatstrings-conditional">
6544 <title>Conditional Expansion</title>
6547 To only print the number of messages if there are new messages in
6548 the current mailbox, further extend
6549 <literal>$status_format</literal> to:
6555 set status_format = "%v on %h: %B %?n?%n new? ...</screen>
6560 This feature is called <emphasis>nonzero-printing</emphasis> and
6562 some expandos may be optionally printed nonzero, i.e. a portion
6563 of the format string is only evaluated if the value of the expando
6564 is different from zero. The basic syntax is:
6570 %?<item>?<string if nonzero>?</screen>
6575 which tells mutt-ng to only look at <literal><string if
6578 if the value of the <literal>%<item%gt;</literal>
6579 expando is different from zero. In our example, we used <literal>n</literal> as
6580 the expando to check for and <literal>%n new</literal> as the
6586 But this is not all: this feature only offers one alternative:
6587 ``print something if not zero.'' Mutt-ng does, as you might guess,
6588 also provide a logically complete version: ``if zero, print
6589 something and else print something else.'' This is achieved by the
6590 following syntax for those expandos which may be printed nonzero:
6596 %?<item>?<string if nonzero>&<string if zero>?</screen>
6601 Using this we can make mutt-ng to do the following:
6610 make it print ``<emphasis>n</emphasis> new messages'' whereby <emphasis>
6614 count but only if there new ones
6621 and make it print ``no new messages'' if there aren't any
6631 The corresponding configuration is:
6637 set status_format = "%v on %h: %B: %?n?%n new messages&no new messages? ...</screen>
6642 This doubles the use of the ``new messages'' string because it'll get
6643 always printed. Thus, it can be shortened to:
6649 set status_format = "%v on %h: %B: %?n?%n&no? new messages ...</screen>
6654 As you might see from this rather simple example, one can create
6655 very complex but fancy status messages. Please see the reference
6656 chapter for expandos and those which may be printed nonzero.
6665 <sect2 id="formatstrings-padding">
6666 <title>Modifications and Padding</title>
6669 Besides the information given so far, there're even more features of
6679 When specifying <literal>%_<item></literal>
6681 just <literal>%<item></literal>, mutt-ng will
6683 characters in the expansion of <literal><item></literal>
6692 When specifying <literal>%:<item></literal>
6694 <literal>%<item></literal>, mutt-ng will convert
6696 expansion of <literal><item></literal> to underscores
6697 (<literal>_</literal>).
6707 Also, there's a feature called <emphasis>Padding</emphasis> supplied
6709 following two expandos: <literal>%|X</literal> and <literal>
6720 <literal>%|X</literal>
6724 When this occurs, mutt-ng will fill the
6725 rest of the line with the character <literal>X</literal>. In
6727 filling the rest of the line with dashes is done by setting:
6733 set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-"</screen>
6740 <literal>%>X</literal>
6744 Since the previous expando stops at
6745 the end of line, there must be a way to fill the gap between
6746 two items via the <literal>%>X</literal> expando:
6748 characters <literal>X</literal> in between two items so that
6750 the line will be right-justified. For example, to not put the
6751 version string and hostname of our example on the left but on
6752 the right and fill the gap with spaces, one might use (note
6753 the space after <literal>%></literal>):
6759 set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)"</screen>
6779 <sect1 id="using-tags">
6780 <title>Using Tags</title>
6783 Sometimes it is desirable to perform an operation on a group of
6784 messages all at once rather than one at a time. An example might be
6785 to save messages to a mailing list to a separate folder, or to
6786 delete all messages with a given subject. To tag all messages
6787 matching a pattern, use the tag-pattern function, which is bound to
6788 ``shift-T'' by default. Or you can select individual messages by
6789 hand using the ``tag-message'' function, which is bound to ``t'' by
6790 default. See <link linkend="tab-patterns">patterns</link> for Mutt-ng's
6796 Once you have tagged the desired messages, you can use the
6797 ``tag-prefix'' operator, which is the ``;'' (semicolon) key by default.
6798 When the ``tag-prefix'' operator is used, the <emphasis role="bold">
6802 be applied to all tagged messages if that operation can be used in that
6803 manner. If the <muttng-doc:varref name="auto-tag"/>
6804 variable is set, the next operation applies to the tagged messages
6805 automatically, without requiring the ``tag-prefix''.
6809 In <muttng-doc:command name="macro"/> or <muttng-doc:command name="push"/> commands,
6810 you can use the ``tag-prefix-cond'' operator. If there are no tagged
6811 messages, mutt will "eat" the rest of the macro to abort it's
6812 execution.Mutt-ng will stop "eating" the macro when it encounters the
6814 operator; after this operator the rest of the macro will be executed
6825 <title>Using Hooks</title>
6828 A <emphasis>hook</emphasis> is a concept borrowed from the EMACS editor
6830 execute arbitrary commands before performing some operation. For
6832 you may wish to tailor your configuration based upon which mailbox you
6834 reading, or to whom you are sending mail. In the Mutt-ng world, a <emphasis>
6837 consists of a <link linkend="advanced-regexp">regexp</link> or
6838 <link linkend="tab-patterns">patterns</link> along with a
6839 configuration option/command. See
6845 <muttng-doc:hook name="folder"/>
6851 <muttng-doc:hook name="send"/>
6857 <muttng-doc:hook name="message"/>
6863 <muttng-doc:hook name="save"/>
6869 <muttng-doc:hook name="mbox"/>
6875 <muttng-doc:hook name="fcc"/>
6881 <muttng-doc:hook name="fcc-save"/>
6887 for specific details on each type of <emphasis>hook</emphasis>
6892 <emphasis role="bold">Note:</emphasis> if a hook changes configuration
6893 settings, these changes remain
6894 effective until the end of the current mutt session. As this is
6896 not desired, a default hook needs to be added before all other hooks to
6897 restore configuration defaults. Here is an example with <muttng-doc:hook name="send"/> and
6905 send-hook . 'unmy_hdr From:'
6906 send-hook <muttng-doc:pattern name="C"/>'^b@b\.b$' my-hdr from: c@c.c</screen>
6910 <sect2 id="pattern-hook">
6911 <title>Message Matching in Hooks</title>
6914 Hooks that act upon messages (<literal><muttng-doc:hook name="send"/>, <muttng-doc:hook name="save"/>,
6915 <muttng-doc:hook name="fcc"/>,<muttng-doc:hook name="message"/>
6917 )are evaluated in a slightly different manner. For the other
6918 types of hooks, a <link linkend="advanced-regexp">regexp</link> is
6919 sufficient. But in dealing with messages a finer grain of control is
6920 needed for matching since for different purposes you want to match
6925 Mutt-ng allows the use of the <link linkend="tab-patterns">patterns</link>
6926 language for matching messages in hook commands. This works in
6927 exactly the same way as it would when <emphasis>limiting</emphasis>
6928 or<emphasis>searching</emphasis> the mailbox, except that you are
6930 operators which match information mutt extracts from the header of
6931 the message (i.e. from, to, cc, date, subject, etc.).
6935 For example, if you wanted to set your return address based upon
6937 mail to a specific address, you could do something like:
6940 send-hook '<muttng-doc:pattern name="t"/> ^me@cs\.hmc\.edu$' 'my-hdr From: Mutt-ng User <user@host>'</screen>
6942 which would execute the given command when sending mail to
6943 <emphasis>me@cs.hmc.edu</emphasis>.
6947 However, it is not required that you write the pattern to match using
6949 full searching language. You can still specify a simple <emphasis>
6953 like the other hooks, in which case Mutt-ng will translate your
6954 pattern into the full language, using the translation specified by
6956 <muttng-doc:hook name="default"/> variable. The
6957 pattern is translated at the time the hook is declared, so the value
6959 <muttng-doc:hook name="default"/> that is in effect
6960 at that time will be used.
6971 <sect1 id="sidebar">
6972 <title>Using the sidebar</title>
6975 The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox
6977 which looks very similar to the ones you probably know from GUI mail
6979 The sidebar lists all specified mailboxes, shows the number in each
6980 and highlights the ones with new email
6981 Use the following configuration commands:
6984 set sidebar_visible="yes"
6985 set sidebar_width=25</screen>
6990 If you want to specify the mailboxes you can do so with:
7002 You can also specify the colors for mailboxes with new mails by using:
7005 color sidebar_new red black
7006 color sidebar white black</screen>
7011 Reasonable key bindings look e.g. like this:
7014 bind index \Cp sidebar-prev
7015 bind index \Cn sidebar-next
7016 bind index \Cb sidebar-open
7017 bind pager \Cp sidebar-prev
7018 bind pager \Cn sidebar-next
7019 bind pager \Cb sidebar-open
7021 macro index B ':toggle sidebar_visible^M'
7022 macro pager B ':toggle sidebar_visible^M'</screen>
7027 You can then go up and down by pressing Ctrl-P and Ctrl-N, and
7028 switch on and off the sidebar simply by pressing 'B'.
7038 <title>External Address Queries</title>
7041 Mutt-ng supports connecting to external directory databases such as
7043 ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
7044 using a simple interface. Using the
7045 <muttng-doc:varref name="query-command"/>
7046 variable, you specify the wrapper
7047 command to use. For example:
7053 set query_command = "mutt_ldap_query.pl '%s'"</screen>
7058 The wrapper script should accept the query on the command-line. It
7059 should return a one line message, then each matching response on a
7060 single line, each line containing a tab separated address then name
7061 thensome other optional information. On error, or if there are no
7063 addresses, return a non-zero exit code and a one line error message.
7067 An example multiple response output:
7070 Searching database ... 20 entries ... 3 matching:
7071 me@cs.hmc.edu Michael Elkins mutt dude
7072 blong@fiction.net Brandon Long mutt and more
7073 roessler@guug.de Thomas Roessler mutt pgp</screen>
7078 There are two mechanisms for accessing the query function of mutt. One
7079 is to do a query from the index menu using the query function (default:
7081 This will prompt for a query, then bring up the query menu which will
7082 list the matching responses. From the query menu, you can select
7083 addresses to create aliases, or to mail. You can tag multiple
7084 addressesto mail, start a new query, or have a new query appended to
7090 The other mechanism for accessing the query function is for address
7091 completion, similar to the alias completion. In any prompt for address
7092 entry, you can use the complete-query function (default: ^T) to
7094 query based on the current address you have typed. Like aliases, mutt
7095 will look for what you have typed back to the last space or comma. If
7096 there is a single response for that query, mutt will expand the address
7097 in place. If there are multiple responses, mutt will activate the
7098 querymenu. At the query menu, you can select one or more addresses to
7100 added to the prompt.
7109 <sect1 id="mailbox-formats">
7110 <title>Mailbox Formats</title>
7113 Mutt-ng supports reading and writing of four different mailbox formats:
7114 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
7115 is no need to use a flag for different mailbox types. When creating
7116 newmailboxes, Mutt-ng uses the default specified with the
7117 <muttng-doc:varref name="mbox-type"/>
7122 <emphasis role="bold">mbox</emphasis>. This is the most widely used
7123 mailbox format for UNIX. All
7124 messages are stored in a single file. Each message has a line of the
7131 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST</screen>
7136 to denote the start of a new message (this is often referred to as the
7141 <emphasis role="bold">MMDF</emphasis>. This is a variant of the <emphasis>
7144 format. Each message is
7145 surrounded by lines containing ``^A^A^A^A'' (four
7150 <emphasis role="bold">MH</emphasis>. A radical departure from <emphasis>
7153 and <emphasis>MMDF</emphasis>, a mailbox
7154 consists of a directory and each message is stored in a separate file.
7155 The filename indicates the message number (however, this is may not
7156 correspond to the message number Mutt-ng displays). Deleted messages
7157 arerenamed with a comma (,) prepended to the filename. <emphasis role="bold">
7161 detects this type of mailbox by looking for either <literal>
7164 or <literal>.xmhcache</literal> (needed to distinguish normal
7170 <emphasis role="bold">Maildir</emphasis>. The newest of the mailbox
7171 formats, used by the Qmail MTA (a
7172 replacement for sendmail). Similar to <emphasis>MH</emphasis>, except
7174 subdirectories of the mailbox: <emphasis>tmp</emphasis>, <emphasis>new</emphasis> and <emphasis>
7178 for the messages are chosen in such a way they are unique, even when
7179 twoprograms are writing the mailbox over NFS, which means that no file
7190 <sect1 id="shortcuts">
7191 <title>Mailbox Shortcuts</title>
7194 There are a number of built in shortcuts which refer to specific
7196 These shortcuts can be used anywhere you are prompted for a file or
7207 ! -- refers to your <muttng-doc:varref name="spoolfile"/>
7214 > -- refers to your <muttng-doc:varref name="mbox"/> file
7220 < -- refers to your <muttng-doc:varref name="record"/> file
7226 ^ -- refers to the current mailbox
7232 - or !! -- refers to the file you've last visited
7238 ~ -- refers to your home directory
7244 = or + -- refers to your <muttng-doc:varref name="folder"/>
7251 @<emphasis>alias</emphasis> -- refers to the <muttng-doc:hook name="save"/>
7252 as determined by the address of the alias
7266 <sect1 id="using-lists">
7267 <title>Handling Mailing Lists</title>
7270 Mutt-ng has a few configuration options that make dealing with large
7271 amounts of mail easier. The first thing you must do is to let Mutt
7272 know what addresses you consider to be mailing lists (technically
7273 this does not have to be a mailing list, but that is what it is most
7274 often used for), and what lists you are subscribed to. This is
7275 accomplished through the use of the <muttng-doc:command name="lists"/>
7276 commands in your muttrc.
7280 Now that Mutt-ng knows what your mailing lists are, it can do several
7281 things, the first of which is the ability to show the name of a list
7282 through which you received a message (i.e., of a subscribed list) in
7283 the <emphasis>index</emphasis> menu display. This is useful to
7285 personal and list mail in the same mailbox. In the
7286 <muttng-doc:varref name="index-format"/>
7287 variable, the escape ``%L''
7288 will return the string ``To <list>'' when ``list'' appears in the
7289 ``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
7290 field (otherwise it returns the name of the author).
7294 Often times the ``To'' and ``Cc'' fields in mailing list messages
7295 tend to get quite large. Most people do not bother to remove the
7296 author of the message they are reply to from the list, resulting in
7297 two or more copies being sent to that person. The ``list-reply''
7298 function, which by default is bound to ``L'' in the <emphasis>index</emphasis> menu
7299 and <emphasis>pager</emphasis>, helps reduce the clutter by only
7301 known mailing list addresses instead of all recipients (except as
7302 specified by <literal>Mail-Followup-To</literal>, see below).
7306 Mutt-ng also supports the <literal>Mail-Followup-To</literal> header.
7308 a message to a list of recipients which includes one or several
7309 subscribed mailing lists, and if the <muttng-doc:varref name="followup-to"/>
7310 option is set, mutt will generate
7311 a Mail-Followup-To header which contains all the recipients to whom
7312 you send this message, but not your address. This indicates that
7313 group-replies or list-replies (also known as ``followups'') to this
7314 message should only be sent to the original recipients of the
7315 message, and not separately to you - you'll receive your copy through
7316 one of the mailing lists you are subscribed to.
7320 Conversely, when group-replying or list-replying to a message which
7321 has a <literal>Mail-Followup-To</literal> header, mutt will respect
7323 the <muttng-doc:varref name="honor-followup-to"/>
7325 variable is set. Using list-reply will in this case also make sure
7326 that the reply goes to the mailing list, even if it's not specified
7327 in the list of recipients in the <literal>Mail-Followup-To</literal>.
7331 Note that, when header editing is enabled, you can create a
7332 <literal>Mail-Followup-To</literal> header manually. Mutt-ng will only
7334 this header if it doesn't exist when you send the message.
7338 The other method some mailing list admins use is to generate a
7339 ``Reply-To'' field which points back to the mailing list address rather
7340 than the author of the message. This can create problems when trying
7341 to reply directly to the author in private, since most mail clients
7342 will automatically reply to the address given in the ``Reply-To''
7343 field. Mutt-ng uses the <muttng-doc:varref name="reply-to"/>
7344 variable to help decide which address to use. If set to <emphasis>
7348 <emphasis>ask-no</emphasis>, you will be
7349 prompted as to whether or not you would like to use the address given
7350 inthe ``Reply-To'' field, or reply directly to the address given in the
7351 ``From'' field. When set to <emphasis>yes</emphasis>, the ``Reply-To''
7352 field will be used when
7357 The ``X-Label:'' header field can be used to further identify mailing
7358 lists or list subject matter (or just to annotate messages
7359 individually). The <muttng-doc:varref name="index-format"/>
7360 variable's ``%y'' and
7361 ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
7362 index, and Mutt-ng's pattern-matcher can match regular expressions to
7363 ``X-Label:'' fields with the ``<muttng-doc:pattern name="y"/>'' selector. ``X-Label:'' is
7365 standard message header field, but it can easily be inserted by
7366 procmailand other mail filtering agents.
7370 Lastly, Mutt-ng has the ability to <link linkend="sort">sort</link> the
7372 <link linkend="threads">threads</link>. A thread is a group of
7373 messages which all relate to the same
7374 subject. This is usually organized into a tree-like structure where a
7375 message and all of its replies are represented graphically. If you've
7377 used a threaded news client, this is the same concept. It makes
7378 dealingwith large volume mailing lists easier because you can easily
7380 uninteresting threads and quickly find topics of value.
7389 <sect1 id="editing-threads">
7390 <title>Editing threads</title>
7393 Mutt-ng has the ability to dynamically restructure threads that are
7395 either by misconfigured software or bad behavior from some
7396 correspondents. This allows to clean your mailboxes formats) from these
7397 annoyances which make it hard to follow a discussion.
7400 <sect2 id="editing-threads-link">
7401 <title>Linking threads</title>
7404 Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
7405 "References:" headers when replying to a message. This results in
7407 discussions because Mutt-ng has not enough information to guess the
7410 You can fix this by tagging the reply, then moving to the parent
7412 and using the ``link-threads'' function (bound to & by default).
7414 reply will then be connected to this "parent" message.
7418 You can also connect multiple children at once, tagging them and
7420 tag-prefix command (';') or the auto_tag option.
7425 <sect2 id="editing-threads-break">
7426 <title>Breaking threads</title>
7429 On mailing lists, some people are in the bad habit of starting a new
7430 discussion by hitting "reply" to any message from the list and
7432 the subject to a totally unrelated one.
7433 You can fix such threads by using the ``break-thread'' function
7434 (boundby default to #), which will turn the subthread starting
7436 current message into a whole different thread.
7448 <title>Delivery Status Notification (DSN) Support</title>
7451 <muttng-doc:rfc num="1894"/> defines a set of MIME content types for relaying information
7452 about the status of electronic mail messages. These can be thought of
7454 ``return receipts.''
7458 Users can make use of it in one of the following two ways:
7467 Berkeley sendmail 8.8.x currently has some command line options
7468 in which the mail client can make requests as to what type of
7470 messages should be returned.
7476 The SMTP support via libESMTP supports it, too.
7485 To support this, there are two variables:
7494 <muttng-doc:varref name="dsn-notify"/> is used
7495 to request receipts for different results (such as failed
7496 message,message delivered, etc.).
7503 <muttng-doc:varref name="dsn-return"/> requests
7504 how much of your message should be returned with the receipt
7505 (headers or full message).
7515 Please see the reference chapter for possible values.
7525 <title>POP3 Support (OPTIONAL)</title>
7528 If Mutt-ng was compiled with POP3 support (by running the <emphasis>
7531 script with the <emphasis>--enable-pop</emphasis> flag), it has the
7533 with mailboxes located on a remote POP3 server and fetch mail for local
7538 You can access the remote POP3 mailbox by selecting the folder
7539 <literal>pop://popserver/</literal>.
7543 You can select an alternative port by specifying it with the server,
7545 <literal>pop://popserver:port/</literal>.
7549 You can also specify different username for each folder, i.e.:
7550 <literal>pop://username@popserver[:port]/</literal>.
7554 Polling for new mail is more expensive over POP3 than locally. For this
7555 reason the frequency at which Mutt-ng will check for mail remotely can
7558 <muttng-doc:varref name="pop-mail-check"/>
7559 variable, which defaults to every 60 seconds.
7563 If Mutt-ng was compiled with SSL support (by running the <emphasis>
7566 script with the <emphasis>--with-ssl</emphasis> flag), connections to
7568 can be encrypted. This naturally requires that the server supports
7569 SSL encrypted connections. To access a folder with POP3/SSL, you should
7570 use pops: prefix, ie:
7571 <literal>pops://[username@]popserver[:port]/</literal>.
7575 Another way to access your POP3 mail is the <emphasis>fetch-mail</emphasis> function
7576 (default: G). It allows to connect to <link
7577 linkend="pop-host">pop-host</link>
7578 ,fetch all your new mail and place it in the
7579 local <muttng-doc:varref name="spoolfile"/>. After this
7580 point, Mutt-ng runs exactly as if the mail had always been local.
7584 <emphasis role="bold">Note:</emphasis> If you only need to fetch all
7585 messages to local mailbox
7586 you should consider using a specialized program, such as
7587 <muttng-doc:man name="fetchmail"/>.
7597 <title>IMAP Support (OPTIONAL)</title>
7600 If Mutt-ng was compiled with IMAP support (by running the
7601 <emphasis>configure</emphasis> script with the
7602 <emphasis>--enable-imap</emphasis> flag), it has the
7603 ability to work with folders located on a remote IMAP server.
7607 You can access the remote inbox by selecting the folder via its
7613 imap://imapserver/INBOX</screen>
7617 where <literal>imapserver</literal> is the name of the IMAP
7618 server and <literal>INBOX</literal> is the special name for your
7619 spool mailbox on the IMAP server. If you want to access another
7620 mail folder at the IMAP server, you should use
7625 imap://imapserver/path/to/folder</screen>
7629 where <literal>path/to/folder</literal> is the path
7630 of the folder you want to access. You can select an alternative
7631 port by specifying it with the server, i.e.:
7636 imap://imapserver:port/INBOX</screen>
7640 You can also specify different username for each folder by
7641 prenpending your username and an @ symbol to the server's name.
7645 If Mutt-ng was compiled with SSL support (by running the <emphasis>
7648 script with the <emphasis>--with-ssl</emphasis> flag), connections to
7650 can be encrypted. This naturally requires that the server supports
7651 SSL encrypted connections. To access a folder with IMAP/SSL, you only
7652 need to substitute the initial <literal>imap://</literal> by
7653 <literal>imaps://</literal> in the above examples.
7657 Note that not all servers use / as the hierarchy separator. Mutt-ng
7659 correctly notice which separator is being used by the server and
7660 convertpaths accordingly.
7664 When browsing folders on an IMAP server, you can toggle whether to look
7665 at only the folders you are subscribed to, or all folders with the
7666 <emphasis>toggle-subscribed</emphasis> command. See also the
7667 <muttng-doc:varref name="imap-list-subscribed"/>
7672 Polling for new mail on an IMAP server can cause noticeable delays. So,
7674 want to carefully tune the
7675 <muttng-doc:varref name="imap-mail-check"/>
7677 <muttng-doc:varref name="timeout"/>
7682 Note that if you are using mbox as the mail store on UW servers prior
7683 tov12.250, the server has been reported to disconnect a client if
7685 selects the same folder.
7688 <sect2 id="imap-browser">
7689 <title>The Folder Browser</title>
7692 As of version 1.2, mutt supports browsing mailboxes on an IMAP
7693 server. This is mostly the same as the local file browser, with the
7694 following differences:
7700 Instead of file permissions, mutt displays the string "IMAP",
7701 possibly followed by the symbol "+", indicating
7702 that the entry contains both messages and subfolders. On
7703 Cyrus-like servers folders will often contain both messages and
7710 For the case where an entry can contain both messages and
7711 subfolders, the selection key (bound to <literal>enter</literal> by default)
7712 will choose to descend into the subfolder view. If you wish to
7714 the messages in that folder, you must use <literal>view-file</literal> instead
7715 (bound to <literal>space</literal> by default).
7721 You can create, delete and rename mailboxes with the
7722 <literal>create-mailbox</literal>, <literal>delete-mailbox</literal>, and
7723 <literal>rename-mailbox</literal> commands (default bindings: <literal>
7727 <literal>d</literal> and <literal>r</literal>, respectively).
7729 <literal>subscribe</literal> and <literal>unsubscribe</literal>
7730 to mailboxes (normally
7731 these are bound to <literal>s</literal> and <literal>u</literal>, respectively).
7741 <sect2 id="imap-auth">
7742 <title>Authentication</title>
7745 Mutt-ng supports four authentication methods with IMAP servers: SASL,
7746 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
7747 NTLM authentication for you poor exchange users out there, but it has
7748 yet to be integrated into the main tree). There is also support for
7749 the pseudo-protocol ANONYMOUS, which allows you to log in to a public
7750 IMAP server without having an account. To use ANONYMOUS, simply make
7751 your username blank or "anonymous".
7755 SASL is a special super-authenticator, which selects among several
7757 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most
7759 method available on your host and the server. Using some of these
7761 (including DIGEST-MD5 and possibly GSSAPI), your entire session will
7763 encrypted and invisible to those teeming network snoops. It is the
7765 option if you have it. To use it, you must have the Cyrus SASL
7766 libraryinstalled on your system and compile mutt with the <emphasis>
7773 Mutt-ng will try whichever methods are compiled in and available on
7775 in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
7779 There are a few variables which control authentication:
7785 <muttng-doc:varref name="imap-user"/> - controls
7786 the username under which you request authentication on the IMAP
7788 for all authenticators. This is overridden by an explicit
7790 the mailbox path (i.e. by using a mailbox name of the form
7791 <literal>{user@host}</literal>).
7797 <muttng-doc:varref name="imap-pass"/> - a
7798 password which you may preset, used by all authentication
7800 a password is needed.
7806 <muttng-doc:varref name="imap-authenticators"/>
7807 - a colon-delimited list of IMAP
7808 authentication methods to try, in the order you wish to try
7810 specified, this overrides mutt's default (attempt everything,
7829 <title>NNTP Support (OPTIONAL)</title>
7832 If compiled with ``--enable-nntp'' option, Mutt-ng can read news from
7833 a newsserver via NNTP. You can open a newsgroup with the
7834 ``change-newsgroup'' function from the index/pager which is by default
7835 bound to <literal>i</literal>.
7839 The Default newsserver can be obtained from the <muttng-doc:envvar name="NNTPSERVER"/>
7840 environment variable. Like other
7842 info about subscribed newsgroups is saved in a file as specified by the
7843 <muttng-doc:varref name="nntp-newsrc"/> variable.
7844 Article headers are cached and can be loaded from a file when a
7845 newsgroup is entered instead loading from newsserver; currently, this
7846 caching mechanism still is different from the header caching for
7850 <sect2 id="nntp-scoring">
7851 <title>Again: Scoring</title>
7854 Especially for Usenet, people often ask for advanced filtering
7855 and scoring functionality. Of course, mutt-ng has scoring and
7856 allows a killfile, too. How to use a killfile has been discussed
7857 in <link linkend="command-score">Message Scoring</link>.
7861 What has not been discusses in detail is mutt-ng's built-in
7862 realname filter. For may newsreaders including those for
7863 ``advanced users'' like <emphasis>slrn</emphasis> or <emphasis>tin</emphasis>, there are frequent
7864 request for such functionality. The solutions offered often are
7865 complicated regular expressions.
7869 In mutt-ng this is as easy as
7875 score <muttng-doc:pattern name="*"/> =42</screen>
7880 This tells mutt-ng to apply a score of 42 to all messages whose
7881 sender specified a valid realname and a valid email address. Using
7887 score !<muttng-doc:pattern name="*"/> =42</screen>
7892 on the contrary applies a score of 42 to all messages <emphasis>not</emphasis>
7893 matching those criteria which are very strict:
7902 Email addresses must be valid according to <muttng-doc:rfc num="2822"/>
7908 the name must consist of at least 2 fields whereby a field
7909 must not end in a dot. This means that ``Joe User'' and ``Joe
7910 A.User'' are valid while ``J. User'' and ``J. A. User'' aren't.
7917 it's assumed that users are interested in reading their
7918 own mail and mail from people who they have defined an alias
7919 forso that those 2 groups of messages are excluded from the
7943 <title>SMTP Support (OPTIONAL)</title>
7946 Mutt-ng can be built using a library called ``libESMTP'' which
7947 provides SMTP functionality. When <literal>configure</literal> was
7949 <literal>--with-libesmtp</literal> or the output <literal>muttng -v</literal> contains
7950 <literal>+USE_LIBESMTP</literal>, this will be or is the case
7952 support includes support for Delivery Status Notification
7953 (see <link linkend="dsn">dsn</link> section) as well as
7954 handling the <literal>8BITMIME</literal> flag controlled via
7955 <muttng-doc:varref name="use-8bitmime"/>.
7959 To enable sending mail directly via SMTP without an MTA such as
7960 Postfix or SSMTP and the like, simply set the <muttng-doc:varref name="smtp-host"/>
7961 variable pointing to your SMTP server.
7965 Authentication mechanisms are available via the <muttng-doc:varref name="smtp-user"/>
7966 and <muttng-doc:varref name="smtp-pass"/> variables.
7970 Transport Encryption via the StartTLS command is also available. For
7971 this to work, first of all Mutt-ng must be built with SSL or GNUTLS.
7972 Secondly, the <muttng-doc:varref name="smtp-use-tls"/> variable
7974 to ``enabled'' or ``required.'' In both cases, StartTLS will be used if
7975 the server supports it: for the second case, the connection will fail
7976 ifit doesn't while switching back to unencrypted communication for the
7981 Some mail providers require user's to set a particular envelope
7982 sender, i.e. they allow for only one value which may not be what the
7983 user wants to send as the <literal>From:</literal> header. In this
7985 <muttng-doc:varref name="smtp-envelope"/> may be used
7986 to set the envelope different from the <literal>From:</literal> header.
7991 <sect1 id="account-hook">
7992 <title>Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)</title>
7995 If you happen to have accounts on multiple IMAP and/or POP servers,
7996 you may find managing all the authentication settings inconvenient and
7997 error-prone. The <muttng-doc:hook name="account"/> command may help. This hook works like
7998 <muttng-doc:hook name="folder"/> but is invoked whenever you access a remote mailbox
7999 (including inside the folder browser), not just when you open the
8010 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
8011 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
8012 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'</screen>
8022 <sect1 id="urlview">
8023 <title>Start a WWW Browser on URLs (EXTERNAL)</title>
8026 If a message contains URLs (<emphasis>unified resource locator</emphasis> = address in the
8027 WWW space like <emphasis>http://www.mutt.org/</emphasis>), it is
8029 a menu with all the URLs and start a WWW browser on one of them. This
8030 functionality is provided by the external urlview program which can be
8031 retrieved at <muttng-doc:web url="ftp://ftp.mutt.org/mutt/contrib/"/>
8032 and the configuration commands:
8035 macro index \cb |urlview\n
8036 macro pager \cb |urlview\n</screen>
8046 <sect1 id="compressed-folders">
8047 <title>Compressed folders Support (OPTIONAL)</title>
8050 If Mutt-ng was compiled with compressed folders support (by running the
8051 <emphasis>configure</emphasis> script with the <emphasis>
8055 can open folders stored in an arbitrary format, provided that the user
8056 has a script to convert from/to this format to one of the accepted.
8060 The most common use is to open compressed archived folders e.g. with
8065 In addition, the user can provide a script that gets a folder in an
8066 accepted format and appends its context to the folder in the
8067 user-defined format, which may be faster than converting the entire
8068 folder to the accepted format, appending to it and converting back to
8069 the user-defined format.
8073 There are three hooks defined (<muttng-doc:hook name="open"/>,
8074 <muttng-doc:hook name="close"/> and <muttng-doc:hook name="append"/>
8075 )which define commands to uncompress and compress
8076 a folder and to append messages to an existing compressed folder
8087 open-hook \\.gz$ "gzip -cd %f > %t"
8088 close-hook \\.gz$ "gzip -c %t > %f"
8089 append-hook \\.gz$ "gzip -c %t >> %f" </screen>
8094 You do not have to specify all of the commands. If you omit <muttng-doc:hook name="append"/>
8095 ,the folder will be open and
8096 closed again each time you will add to it. If you omit <muttng-doc:hook name="close"/>
8097 (or give empty command) , the
8098 folder will be open in the mode. If you specify <muttng-doc:hook name="append"/>
8099 though you'll be able to append
8104 Note that Mutt-ng will only try to use hooks if the file is not in one
8106 the accepted formats. In particular, if the file is empty, mutt
8107 supposes it is not compressed. This is important because it allows the
8108 use of programs that do not have well defined extensions. Just use
8109 "." as a regexp. But this may be surprising if your
8110 compressing script produces empty files. In this situation, unset
8111 <muttng-doc:varref name="save-empty"/>
8112 ,so that the compressed file
8113 will be removed if you delete all of the messages.
8116 <sect2 id="open-hook">
8117 <title>Open a compressed mailbox for reading</title>
8120 Usage: <muttng-doc:hook name="open"/> <emphasis>regexp</emphasis> "<emphasis>command</emphasis>"
8124 The <emphasis>command</emphasis> is the command that can be used for
8126 folders whose names match <emphasis>regexp</emphasis>.
8130 The <emphasis>command</emphasis> string is the printf-like format
8132 should accept two parameters: %f, which is replaced with the
8133 (compressed) folder name, and %t which is replaced with the
8134 name of the temporary folder to which to write.
8138 %f and %t can be repeated any number of times in the
8139 command string, and all of the entries are replaced with the
8140 appropriate folder name. In addition, %% is replaced by
8141 %, as in printf, and any other %anything is left as is.
8145 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the original compressed file.
8146 The <emphasis>command</emphasis> should return non-zero exit status
8148 mutt knows something's wrong.
8158 open-hook \\.gz$ "gzip -cd %f > %t"
8164 If the <emphasis>command</emphasis> is empty, this operation is
8165 disabled for this file
8171 <sect2 id="close-hook">
8172 <title>Write a compressed mailbox</title>
8175 Usage: <muttng-doc:hook name="close"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
8179 This is used to close the folder that was open with the <muttng-doc:hook name="open"/>
8180 command after some changes were made to it.
8184 The <emphasis>command</emphasis> string is the command that can be
8185 used for closing the
8186 folders whose names match <emphasis>regexp</emphasis>. It has the
8188 the <muttng-doc:hook name="open"/> command. Temporary
8190 in this case is the folder previously produced by the <muttng-doc:hook name="open"/>
8195 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
8196 <emphasis>command</emphasis> should return non-zero exit status if it
8198 knows something's wrong.
8208 close-hook \\.gz$ "gzip -c %t > %f"</screen>
8213 If the <emphasis>command</emphasis> is empty, this operation is
8214 disabled for this file
8215 type, and the file can only be open in the readonly mode.
8219 <muttng-doc:hook name="close"/> is not called when you
8221 from the folder if the folder was not changed.
8226 <sect2 id="append-hook">
8227 <title>Append a message to a compressed mailbox</title>
8230 Usage: <muttng-doc:hook name="append"/> <emphasis>regexp</emphasis>"<emphasis>command</emphasis>"
8234 This command is used for saving to an existing compressed folder.
8235 The <emphasis>command</emphasis> is the command that can be used for
8237 folders whose names match <emphasis>regexp</emphasis>. It has the
8239 the <muttng-doc:hook name="open"/> command.
8240 The temporary folder in this case contains the messages that are
8245 The <emphasis>command</emphasis> should <emphasis role="bold">not</emphasis> remove the decompressed file. The
8246 <emphasis>command</emphasis> should return non-zero exit status if it
8248 knows something's wrong.
8258 append-hook \\.gz$ "gzip -c %t >> %f" </screen>
8263 When <muttng-doc:hook name="append"/> is used, the
8265 not opened, which saves time, but this means that we can not find out
8266 what the folder type is. Thus the default (<muttng-doc:varref name="mbox-type"/>
8267 )type is always supposed (i.e.
8268 this is the format used for the temporary folder).
8272 If the file does not exist when you save to it, <muttng-doc:hook name="close"/>
8273 is called, and not <muttng-doc:hook name="append"/>. <muttng-doc:hook name="append"/>
8275 for appending to existing folders.
8279 If the <emphasis>command</emphasis> is empty, this operation is
8280 disabled for this file
8281 type. In this case, the folder will be open and closed again (using
8282 <muttng-doc:hook name="open"/> and <muttng-doc:hook name="close"/>
8283 respectively) each time you will add to it.
8288 <sect2 id="encrypted-folders">
8289 <title>Encrypted folders</title>
8292 The compressed folders support can also be used to handle encrypted
8293 folders. If you want to encrypt a folder with PGP, you may want to
8294 usethe following hooks:
8300 open-hook \\.pgp$ "pgp -f < %f > %t"
8301 close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f"
8307 Please note, that PGP does not support appending to an encrypted
8308 folder, so there is no <muttng-doc:hook name="append"/> defined.
8312 <emphasis role="bold">Note:</emphasis> the folder is temporary stored
8313 decrypted in the /tmp
8314 directory, where it can be read by your system administrator. So
8315 thinkabout the security aspects of this.
8333 <chapter id="mime-support"> <!--{{{-->
8334 <title>Mutt-ng's MIME Support</title>
8337 Quite a bit of effort has been made to make Mutt-ng the premier text-mode
8338 MIME MUA. Every effort has been made to provide the functionality that
8339 the discerning MIME user requires, and the conformance to the standards
8340 wherever possible. When configuring Mutt-ng for MIME, there are two
8341 extratypes of configuration files which Mutt-ng uses. One is the
8342 <literal>mime.types</literal> file, which contains the mapping of file
8344 IANA MIME types. The other is the <literal>mailcap</literal> file, which
8346 the external commands to use for handling specific MIME types.
8350 <title>Using MIME in Mutt</title>
8353 There are three areas/menus in Mutt-ng which deal with MIME, they are
8355 pager (while viewing a message), the attachment menu and the compose
8359 <sect2 id="mime-view">
8360 <title>Viewing MIME messages in the pager</title>
8363 When you select a message from the index and view it in the pager,
8365 decodes the message to a text representation. Mutt-ng internally
8367 a number of MIME types, including <literal>text/plain, text/enriched,
8368 message/rfc822, and message/news
8370 .In addition, the export
8371 controlled version of Mutt-ng recognizes a variety of PGP MIME types,
8372 including PGP/MIME and application/pgp.
8376 Mutt-ng will denote attachments with a couple lines describing them.
8377 These lines are of the form:
8380 [-- Attachment #1: Description --]
8381 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]</screen>
8383 Where the <literal>Description</literal> is the description or
8384 filename given for the
8385 attachment, and the <literal>Encoding</literal> is one of
8386 <literal>7bit/8bit/quoted-printable/base64/binary</literal>.
8390 If Mutt-ng cannot deal with a MIME type, it will display a message
8394 [-- image/gif is unsupported (use 'v' to view this part) --]</screen>
8400 <sect2 id="attach-menu">
8401 <title>The Attachment Menu</title>
8404 The default binding for <literal>view-attachments</literal> is `v',
8406 attachment menu for a message. The attachment menu displays a list
8407 ofthe attachments in a message. From the attachment menu, you can
8409 print, pipe, delete, and view attachments. You can apply these
8410 operations to a group of attachments at once, by tagging the
8412 and by using the ``tag-prefix'' operator. You can also reply to the
8413 current message from this menu, and only the current attachment (or
8415 attachments tagged) will be quoted in your reply. You can view
8416 attachments as text, or view them using the mailcap viewer
8421 Finally, you can apply the usual message-related functions (like
8422 <muttng-doc:funcref name="resend-message"/>, and the reply
8423 and forward functions) to attachments of type <literal>message/rfc822</literal>.
8427 See the help on the attachment menu for more information.
8432 <sect2 id="compose-menu">
8433 <title>The Compose Menu</title>
8436 The compose menu is the menu you see before you send a message. It
8437 allows you to edit the recipient list, the subject, and other aspects
8438 of your message. It also contains a list of the attachments of your
8439 message, including the main body. From this menu, you can print,
8441 filter, pipe, edit, compose, review, and rename an attachment or a
8442 list of tagged attachments. You can also modifying the attachment
8443 information, notably the type, encoding and description.
8447 Attachments appear as follows:
8450 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
8451 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description></screen>
8456 The '-' denotes that Mutt-ng will delete the file after sending (or
8457 postponing, or canceling) the message. It can be toggled with the
8458 <literal>toggle-unlink</literal> command (default: u). The next
8460 content-type, and can be changed with the <literal>edit-type</literal> command
8461 (default: ^T). The next field is the encoding for the
8463 which allows a binary message to be encoded for transmission on 7bit
8464 links. It can be changed with the <literal>edit-encoding</literal>
8466 (default: ^E). The next field is the size of the attachment,
8467 rounded to kilobytes or megabytes. The next field is the filename,
8468 which can be changed with the <literal>rename-file</literal> command
8470 The final field is the description of the attachment, and can be
8471 changed with the <literal>edit-description</literal> command
8483 <sect1 id="mime-types">
8485 MIME Type configuration with <literal>mime.types</literal>
8489 When you add an attachment to your mail message, Mutt-ng searches your
8490 personal mime.types file within <muttng-doc:envvar name="HOME"/> and then
8491 the system mime.types file at <literal>/usr/local/share/mutt/mime.types</literal> or
8492 <literal>/etc/mime.types</literal>
8496 The mime.types file consist of lines containing a MIME type and a space
8497 separated list of extensions. For example:
8500 application/postscript ps eps
8502 audio/x-aiff aif aifc aiff</screen>
8504 A sample <literal>mime.types</literal> file comes with the Mutt-ng
8506 should contain most of the MIME types you are likely to use.
8510 If Mutt-ng can not determine the mime type by the extension of the file
8512 attach, it will look at the file. If the file is free of binary
8513 information, Mutt-ng will assume that the file is plain text, and mark
8515 as <literal>text/plain</literal>. If the file contains binary
8516 information, then Mutt-ng will
8517 mark it as <literal>application/octet-stream</literal>. You can change
8519 type that Mutt-ng assigns to an attachment by using the <literal>
8522 command from the compose menu (default: ^T). The MIME type is
8524 major mime type followed by the sub-type, separated by a '/'. 6 major
8525 types: application, text, image, video, audio, and model have been
8527 after various internet discussions. Mutt-ng recognises all of these if
8529 appropriate entry is found in the mime.types file. It also recognises
8531 major mime types, such as the chemical type that is widely used in the
8532 molecular modelling community to pass molecular data in various forms
8534 various molecular viewers. Non-recognised mime types should only be
8536 if the recipient of the message is likely to be expecting such
8546 <sect1 id="mime-mailcap">
8548 MIME Viewer configuration with <literal>mailcap</literal>
8552 Mutt-ng supports <muttng-doc:rfc num="1524"/> MIME Configuration, in particular the Unix
8553 specific format specified in Appendix A of the RfC. This file format
8554 is commonly referred to as the mailcap format. Many MIME compliant
8555 programs utilize the mailcap format, allowing you to specify handling
8556 for all MIME types in one place for all programs. Programs known to
8557 use this format include Netscape, XMosaic, lynx and metamail.
8561 In order to handle various MIME types that Mutt-ng can not handle
8562 internally, Mutt-ng parses a series of external configuration files to
8563 find an external handler. The default search string for these files
8564 is a colon delimited list set to
8567 ${HOME}/.mailcap:/usr/local/share/mutt/mailcap:/etc/mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap</screen>
8569 where <muttng-doc:envvar name="HOME"/> is your home directory.
8573 In particular, the metamail distribution will install a mailcap file,
8574 usually as <literal>/usr/local/etc/mailcap</literal>, which contains
8579 <sect2 id="mime-mailcap-basics">
8580 <title>The Basics of the mailcap file</title>
8583 A mailcap file consists of a series of lines which are comments,
8589 A comment line consists of a # character followed by anything you
8594 A blank line is blank.
8598 A definition line consists of a content type, a view command, and any
8599 number of optional fields. Each field of a definition line is
8600 dividedby a semicolon ';' character.
8604 The content type is specified in the MIME standard type/subtype
8607 <literal>text/plain, text/html, image/gif,</literal>
8608 etc. In addition, the mailcap format includes two formats for
8609 wildcards, one using the special '*' subtype, the other is the
8611 wild, where you only include the major type. For example, <literal>
8615 <literal>video,</literal> will match all image types and video types,
8620 The view command is a Unix command for viewing the type specified.
8622 are two different types of commands supported. The default is to send
8623 the body of the MIME message to the command on stdin. You can change
8624 this behavior by using %s as a parameter to your view command.
8625 This will cause Mutt-ng to save the body of the MIME message to a
8627 file, and then call the view command with the %s replaced by
8628 the name of the temporary file. In both cases, Mutt-ng will turn over
8630 terminal to the view program until the program quits, at which time
8632 will remove the temporary file if it exists.
8636 So, in the simplest form, you can send a text/plain message to the
8637 external pager more on stdin:
8640 text/plain; more</screen>
8642 Or, you could send the message as a file:
8645 text/plain; more %s</screen>
8647 Perhaps you would like to use lynx to interactively view a text/html
8651 text/html; lynx %s</screen>
8653 In this case, lynx does not support viewing a file from stdin, so you
8654 must use the %s syntax.
8655 <emphasis role="bold">Note:</emphasis> <emphasis>Some older versions
8656 of lynx contain a bug where they
8657 will check the mailcap file for a viewer for text/html. They will
8659 the line which calls lynx, and run it. This causes lynx to
8661 spawn itself to view the object.
8666 On the other hand, maybe you don't want to use lynx interactively,
8667 youjust want to have it convert the text/html to text/plain, then you
8672 text/html; lynx -dump %s | more</screen>
8677 Perhaps you wish to use lynx to view text/html files, and a pager on
8678 all other text formats, then you would use the following:
8682 text/*; more</screen>
8684 This is the simplest form of a mailcap file.
8689 <sect2 id="mime-mailcap-security">
8690 <title>Secure use of mailcap</title>
8693 The interpretation of shell meta-characters embedded in MIME
8695 can lead to security problems in general. Mutt-ng tries to quote
8697 in expansion of %s syntaxes properly, and avoids risky
8699 substituting them, see the <muttng-doc:varref name="mailcap-sanitize"/>
8704 Although mutt's procedures to invoke programs with mailcap seem to be
8705 safe, there are other applications parsing mailcap, maybe taking less
8707 of it. Therefore you should pay attention to the following rules:
8711 <emphasis>Keep the %-expandos away from shell quoting.</emphasis>
8712 Don't quote them with single or double quotes. Mutt-ng does this for
8713 you, the right way, as should any other program which interprets
8714 mailcap. Don't put them into backtick expansions. Be highly careful
8715 with eval statements, and avoid them if possible at all. Trying to
8717 broken behaviour with quotes introduces new leaks - there is no
8718 alternative to correct quoting in the first place.
8722 If you have to use the %-expandos' values in context where you
8724 quoting or backtick expansions, put that value into a shell variable
8725 and reference the shell variable where necessary, as in the following
8726 example (using <literal>$charset</literal> inside the backtick
8728 since it is not itself subject to any further expansion):
8734 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
8735 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1</screen>
8741 <sect2 id="mime-mailcap-advanced">
8742 <title>Advanced mailcap Usage</title>
8744 <sect3 id="mime-mailcap-advanced-fields">
8745 <title>Optional Fields</title>
8748 In addition to the required content-type and view command fields,
8750 can add semi-colon ';' separated fields to set flags and other
8752 Mutt-ng recognizes the following optional fields:
8756 <term>copiousoutput</term>
8759 This flag tells Mutt-ng that the command passes possibly
8761 text on stdout. This causes Mutt-ng to invoke a pager
8762 (either the internal
8763 pager or the external pager defined by the pager variable)
8765 of the view command. Without this flag, Mutt-ng assumes
8767 is interactive. One could use this to replace the pipe to <literal>
8770 in the <literal>lynx -dump</literal> example in the Basic
8774 text/html; lynx -dump %s ; copiousoutput</screen>
8776 This will cause lynx to format the text/html output as
8778 and Mutt-ng will use your standard pager to display the
8784 <term>needsterminal</term>
8787 Mutt-ng uses this flag when viewing attachments with <muttng-doc:command name="auto-view"/>,
8788 in order to decide whether it should honor the setting
8789 of the <muttng-doc:varref name="wait-key"/> variable or
8790 not. When an attachment is viewed using an interactive
8792 corresponding mailcap entry has a <emphasis>needsterminal</emphasis> flag, Mutt-ng will use
8793 <muttng-doc:varref name="wait-key"/> and the exit
8794 statusof the program to decide if it will ask you to press
8796 external program has exited. In all other situations it
8803 <term>compose=<command></term>
8806 This flag specifies the command to use to create a new
8808 specific MIME type. Mutt-ng supports this from the compose
8814 <term>composetyped=<command></term>
8817 This flag specifies the command to use to create a new
8819 specific MIME type. This command differs from the compose
8821 that mutt will expect standard MIME headers on the data.
8823 used to specify parameters, filename, description, etc. for
8825 attachment. Mutt-ng supports this from the compose menu.
8830 <term>print=<command></term>
8833 This flag specifies the command to use to print a specific
8835 Mutt-ng supports this from the attachment and compose
8841 <term>edit=<command></term>
8844 This flag specifies the command to use to edit a specific
8846 Mutt-ng supports this from the compose menu, and also uses
8848 new attachments. Mutt-ng will default to the defined
8855 <term>nametemplate=<template></term>
8858 This field specifies the format for the file denoted by
8860 command fields. Certain programs will require a certain
8862 for instance, to correctly view a file. For instance, lynx
8864 interpret a file as <literal>text/html</literal> if the
8865 file ends in <literal>.html</literal>.
8866 So, you would specify lynx as a <literal>text/html</literal> viewer with a line in
8867 the mailcap file like:
8870 text/html; lynx %s; nametemplate=%s.html</screen>
8876 <term>test=<command></term>
8879 This field specifies a command to run to test whether this
8881 entry should be used. The command is defined with the
8883 rules defined in the next section. If the command returns
8885 test passed, and Mutt-ng uses this entry. If the command
8887 then the test failed, and Mutt-ng continues searching for
8889 <emphasis role="bold">Note:</emphasis> <emphasis>the
8890 content-type must match before Mutt-ng performs the test.
8895 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
8896 text/html; lynx %s</screen>
8898 In this example, Mutt-ng will run the program RunningX
8900 if the X Window manager is running, and non-zero if it
8902 RunningX returns 0, then Mutt-ng will call netscape to
8904 text/html object. If RunningX doesn't return 0, then
8906 to the next entry and use lynx to display the text/html
8916 <sect3 id="mime-mailcap-advanced-searchorder">
8917 <title>Search Order</title>
8920 When searching for an entry in the mailcap file, Mutt-ng will
8922 the most useful entry for its purpose. For instance, if you are
8923 attempting to print an <literal>image/gif</literal>, and you have
8925 entries in your mailcap file, Mutt-ng will search for an entry with
8931 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
8932 nametemplate=%s.gif</screen>
8934 Mutt-ng will skip the <literal>image/*</literal> entry and use the <literal>
8937 entry with the print command.
8941 In addition, you can use this with <muttng-doc:command name="auto-view"/>
8942 to denote two commands for viewing an attachment, one to be viewed
8943 automatically, the other to be viewed interactively from the
8945 menu. In addition, you can then use the test feature to determine
8947 viewer to use interactively depending on your environment.
8950 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
8951 text/html; lynx %s; nametemplate=%s.html
8952 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput</screen>
8954 For <muttng-doc:command name="auto-view"/>, Mutt-ng will choose
8956 entry because of the copiousoutput tag. For interactive viewing,
8958 will run the program RunningX to determine if it should use the
8960 entry. If the program returns non-zero, Mutt-ng will use the
8962 for interactive viewing.
8967 <sect3 id="mime-mailcap-advanced-expansion">
8968 <title>Command Expansion</title>
8971 The various commands defined in the mailcap files are passed to the
8972 <literal>/bin/sh</literal> shell using the system() function.
8974 command is passed to <literal>/bin/sh -c</literal>, it is parsed to
8976 various special parameters with information from Mutt-ng. The
8978 Mutt-ng expands are:
8985 As seen in the basic mailcap section, this variable is
8987 to a filename specified by the calling program. This file
8989 the body of the message to view/print/edit or where the
8991 program should place the results of composition. In
8993 use of this keyword causes Mutt-ng to not pass the body of
8995 to the view/print/edit program on stdin.
9003 Mutt-ng will expand %t to the text representation of
9005 type of the message in the same form as the first parameter
9007 mailcap definition line, ie <literal>text/html</literal> or
9008 <literal>image/gif</literal>.
9013 <term>%{<parameter>}</term>
9016 Mutt-ng will expand this to the value of the specified
9018 from the Content-Type: line of the mail message. For
9020 Your mail message contains:
9023 Content-Type: text/plain; charset=iso-8859-1</screen>
9025 then Mutt-ng will expand %{charset} to
9026 iso-8859-1. The default metamail
9027 mailcap file uses this feature to test the charset to spawn
9029 using the right charset to view the message.
9037 This will be replaced by a %
9042 Mutt-ng does not currently support the %F and %n
9044 specified in <muttng-doc:rfc num="1524"/>. The main purpose of these parameters is for
9045 multipart messages, which is handled internally by Mutt-ng.
9052 <sect2 id="mime-mailcap-examples">
9053 <title>Example mailcap files</title>
9056 This mailcap file is fairly simple and standard:
9059 # I'm always running X :)
9060 video/*; xanim %s > /dev/null
9061 image/*; xv %s > /dev/null
9063 # I'm always running netscape (if my computer had more memory, maybe)
9064 text/html; netscape -remote 'openURL(%s)'</screen>
9069 This mailcap file shows quite a number of examples:
9075 # Use xanim to view all videos Xanim produces a header on startup,
9076 # send that to /dev/null so I don't see it
9077 video/*; xanim %s > /dev/null
9079 # Send html to a running netscape by remote
9080 text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
9081 # If I'm not running netscape but I am running X, start netscape on the
9083 text/html; netscape %s; test=RunningX
9085 # Else use lynx to view it as text
9088 # This version would convert the text/html to text/plain
9089 text/html; lynx -dump %s; copiousoutput
9091 # I use enscript to print text in two columns to a page
9092 text/*; more %s; print=enscript -2Gr %s
9094 # Netscape adds a flag to tell itself to view jpegs internally
9095 image/jpeg;xv %s; x-mozilla-flags=internal
9097 # Use xv to view images if I'm running X
9098 # In addition, this uses the \ to extend the line and set my editor
9100 image/*;xv %s; test=RunningX; edit=xpaint %s
9102 # Convert images to text using the netpbm tools
9103 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
9104 pbmtoascii -1x2 ) 2>&1 ; copiousoutput
9106 # Send excel spreadsheets to my NT box
9107 application/ms-excel; open.pl %s</screen>
9119 <sect1 id="command-auto-view"><anchor id="command-unauto-view"/>
9120 <title>MIME Autoview</title>
9123 In addition to explicitly telling Mutt-ng to view an attachment with
9124 theMIME viewer defined in the mailcap file, Mutt-ng has support for
9125 automatically viewing MIME attachments while in the pager.
9129 To work, you must define a viewer in the mailcap file which uses the
9130 <literal>copiousoutput</literal> option to denote that it is
9132 Usually, you also use the entry to convert the attachment to a text
9133 representation which you can view in the pager.
9137 You then use the <literal>auto_view</literal> muttrc command to
9139 content-types that you wish to view automatically.
9143 For instance, if you set auto_view to:
9146 auto_view text/html application/x-gunzip application/postscript
9147 image/gif application/x-tar-gz</screen>
9152 Mutt-ng could use the following mailcap entries to automatically view
9153 attachments of these types.
9156 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
9157 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | pgmtopbm | pbmtoascii ; copiousoutput
9158 application/x-gunzip; gzcat; copiousoutput
9159 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
9160 application/postscript; ps2ascii %s; copiousoutput</screen>
9165 ``unauto_view'' can be used to remove previous entries from the
9167 This can be used with <muttng-doc:hook name="message"/> to autoview messages based on size,
9169 ``unauto_view *'' will remove all previous entries.
9178 <sect1 id="command-alternative-order"><anchor id="command-unalternative-order"/>
9179 <title>MIME Multipart/Alternative</title>
9182 Mutt-ng has some heuristics for determining which attachment of a
9183 multipart/alternative type to display. First, mutt will check the
9184 alternative_order list to determine if one of the available
9185 typesis preferred. The alternative_order list consists of a
9187 MIME types in order, including support for implicit and explicit
9188 wildcards, for example:
9191 alternative_order text/enriched text/plain text
9192 application/postscript image/*</screen>
9197 Next, mutt will check if any of the types have a defined
9198 <muttng-doc:command name="auto-view"/>, and use that. Failing
9199 that, Mutt-ng will look for any text type. As a last attempt, mutt
9200 willlook for any type it knows how to handle.
9204 To remove a MIME type from the <literal>alternative_order</literal> list, use the
9205 <literal>unalternative_order</literal> command.
9214 <sect1 id="command-mime-lookup"><anchor id="command-unmime-lookup"/>
9215 <title>MIME Lookup</title>
9218 Mutt-ng's mime_lookup list specifies a list of mime-types that
9220 be treated according to their mailcap entry. This option is designed
9221 todeal with binary types such as application/octet-stream. When an
9223 mime-type is listed in mime_lookup, then the extension of the
9225 be compared to the list of extensions in the mime.types file. The
9227 associated with this extension will then be used to process the
9229 according to the rules in the mailcap file and according to any other
9231 options (such as auto_view) specified. Common usage would be:
9234 mime_lookup application/octet-stream application/X-Lotus-Manuscript</screen>
9239 In addition, the unmime_lookup command may be used to disable
9241 for any particular mime-type if it had been set, for example, in a
9259 <chapter id="security"> <!--{{{-->
9260 <title>Security Considerations</title>
9263 First of all, mutt-ng contains no security holes included by
9264 intention but may contain unknown security holes. As a consequence,
9265 please run mutt-ng only with as few permissions as possible.
9269 Please do not run mutt-ng as the super user.
9273 When configuring mutt-ng, there're some points to note about secure
9278 In practice, mutt-ng can be easily made as vulnerable as even the
9279 most insecure mail user agents (in their default configuration) just
9280 by changing mutt-ng's configuration files: it then can execute
9281 arbitrary programs and scripts attached to messages, send out private
9282 data on its own, etc. Although this is not believed to the common type
9283 of setup, please read this chapter carefully.
9286 <sect1 id="security-passwords">
9287 <title>Passwords</title>
9290 Although mutt-ng can be told the various passwords for accounts,
9291 please never store passwords in configuration files. Besides the
9292 fact that the system's operator can always read them, you could
9293 forget to replace the actual password with asterisks when reporting
9294 a bug or asking for help via, for example, a mailing list so that
9295 your mail including your password could be archived by internet
9296 search engines, etc. Please never store passwords on disk.
9301 <sect1 id="security-tempfiles">
9302 <title>Temporary Files</title>
9305 Mutt-ng uses many temporary files for viewing messages, verifying
9306 digital signatures, etc. The <muttng-doc:varref name="umask"/>
9307 variable can be used to change the default permissions of these
9308 files. Please only change it if you really know what you are doing.
9309 Also, a different location for these files may be desired which can
9310 be changed via the <muttng-doc:varref name="tmpdir"/> variable.
9315 <sect1 id="security-leaks">
9316 <title>Information Leaks</title>
9318 <sect2 id="security-leaks-mid">
9319 <title>Message-ID: headers</title>
9322 In the default configuration, mutt-ng will leak some information
9323 to the outside world when sending messages: the generation of
9324 <literal>Message-ID:</literal> headers includes a step counter which
9326 (and rotated) with every message sent. If you'd like to hide this
9327 information probably telling others how many mail you sent in which
9328 time, you at least need to remove the <literal>%P</literal>
9330 default setting of the <muttng-doc:varref name="msgid-format"/> variable. Please make sure that
9331 you really know how local parts of these <literal>Message-ID:</literal> headers
9337 <sect2 id="security-leaks-mailto">
9338 <title>mailto:-style links</title>
9341 As mutt-ng be can be set up to be the mail client to handle
9342 <literal>mailto:</literal> style links in websites, there're security
9343 considerations, too. To keep the old behavior by default, mutt-ng
9344 will be strict in interpreting them which means that arbitrary
9345 header fields can be embedded in these links which could override
9346 existing header fields or attach arbitrary files. This may be
9347 problematic if the <muttng-doc:varref name="edit-headers"/>
9348 variable is <emphasis>unset</emphasis>, i.e. the
9349 user doesn't want to see header fields while editing the message.
9353 For example, following a link like
9359 mailto:joe@host?Attach=~/.gnupg/secring.gpg</screen>
9364 will send out the user's private gnupg keyring to <literal>joe@host</literal> if
9365 the user doesn't follow the information on screen carefully
9370 When <emphasis>unsetting</emphasis> the <muttng-doc:varref name="strict-mailto"/>
9371 variable, mutt-ng will
9380 be less strict when interpreting these links by
9381 prepending a <literal>X-Mailto-</literal> string to all header
9383 embedded in such a link <emphasis>and</emphasis>
9390 turn on the <muttng-doc:varref name="edit-headers"/>
9392 force to let the user see all the headers
9393 (because they still may leak information.)
9406 <sect1 id="security-external">
9407 <title>External applications</title>
9410 Mutt-ng in many places has to rely on external applications or
9411 for convenience supports mechanisms involving external
9415 <sect2 id="security-external-mailcap">
9416 <title>mailcap</title>
9419 One of these is the <literal>mailcap</literal> mechanism as defined
9420 by <muttng-doc:rfc num="1524"/>. Mutt-ng can be set up to <emphasis>automatically</emphasis>
9422 given utility as listed in one of the mailcap files (see the
9423 <muttng-doc:varref name="mailcap-path"/>
9424 variable for details.)
9428 These utilities may have a variety of security vulnerabilities,
9429 including overwriting of arbitrary files, information leaks or
9430 other exploitable bugs. These vulnerabilities may go unnoticed by
9431 the user, especially when they are called automatically (and
9432 without interactive prompting) from the mailcap file(s). When
9433 using mutt-ng's autoview mechanism in combination with mailcap
9434 files, please be sure to...
9443 manually select trustworth applications with a reasonable
9451 periodically check the contents of mailcap files,
9452 especially after software installations or upgrades
9459 keep the software packages referenced in the mailcap file up to
9467 leave the <muttng-doc:varref name="mailcap-sanitize"/> variable in its default
9468 state to restrict mailcap expandos to a safe set of characters
9479 <sect2 id="security-external-other">
9480 <title>Other</title>
9483 Besides the mailcap mechanism, mutt-ng uses a number of other
9484 external utilities for operation.
9488 The same security considerations apply for these as for tools
9489 involved via mailcap (for example, mutt-ng is vulnerable to Denial
9490 of Service Attacks with compressed folders support if the
9491 uncompressed mailbox is too large for the disk it is saved to.)
9495 As already noted, most of these problems are not built in but
9496 caused by wrong configuration, so please check your configuration.
9506 <chapter id="reference"> <!--{{{-->
9507 <title>Reference</title>
9509 <sect1 id="commandline">
9510 <title>Command line options</title>
9513 Running <literal>mutt</literal> with no arguments will make Mutt-ng
9514 attempt to read your spool
9515 mailbox. However, it is possible to read other mailboxes and
9516 to send messages from the command line as well.
9521 <table frame="none" rowsep="1">
9522 <title>Reference: Command Line Options</title>
9523 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9526 <entry>Option</entry>
9527 <entry>Description</entry>
9532 <entry><literal>-A</literal></entry>
9533 <entry>expand an alias</entry>
9536 <entry><literal>-a</literal></entry>
9537 <entry>attach a file to a message</entry>
9540 <entry><literal>-b</literal></entry>
9541 <entry>specify a blind carbon-copy (BCC) address</entry>
9544 <entry><literal>-c</literal></entry>
9545 <entry>specify a carbon-copy (Cc) address</entry>
9548 <entry><literal>-e</literal></entry>
9549 <entry>specify a config command to be run after initialization files are read</entry>
9552 <entry><literal>-f</literal></entry>
9553 <entry>specify a mailbox to load</entry>
9556 <entry><literal>-F</literal></entry>
9557 <entry>specify an alternate file to read initialization commands</entry>
9560 <entry><literal>-h</literal></entry>
9561 <entry>print help on command line options</entry>
9564 <entry><literal>-H</literal></entry>
9565 <entry>specify a draft file from which to read a header and body</entry>
9568 <entry><literal>-i</literal></entry>
9569 <entry>specify a file to include in a message composition</entry>
9572 <entry><literal>-m</literal></entry>
9573 <entry>specify a default mailbox type</entry>
9576 <entry><literal>-n</literal></entry>
9577 <entry>do not read the system Muttngrc</entry>
9580 <entry><literal>-p</literal></entry>
9581 <entry>recall a postponed message</entry>
9584 <entry><literal>-Q</literal></entry>
9585 <entry>query a configuration variable</entry>
9588 <entry><literal>-R</literal></entry>
9589 <entry>open mailbox in read-only mode</entry>
9592 <entry><literal>-s</literal></entry>
9593 <entry>specify a subject (enclose in quotes if it contains spaces)</entry>
9596 <entry><literal>-t</literal></entry>
9597 <entry>dump the value of all variables to stdout</entry>
9600 <entry><literal>-T</literal></entry>
9601 <entry>dump the value of all changed variables to stdout</entry>
9604 <entry><literal>-v</literal></entry>
9605 <entry>show version number and compile-time definitions</entry>
9608 <entry><literal>-x</literal></entry>
9609 <entry>simulate the mailx(1) compose mode</entry>
9612 <entry><literal>-y</literal></entry>
9613 <entry>show a menu containing the files specified by the mailboxes command</entry>
9616 <entry><literal>-z</literal></entry>
9617 <entry>exit immediately if there are no messages in the mailbox</entry>
9620 <entry><literal>-Z</literal></entry>
9621 <entry>open the first folder with new message,exit immediately if none</entry>
9630 To read messages in a mailbox
9634 <literal>mutt</literal> ] -nz ] ] -F <emphasis>muttrc</emphasis> ] ] -m <emphasis>
9637 ] ] -f <emphasis>mailbox</emphasis> ]
9641 To compose a new message
9645 <literal>mutt</literal> ] -n ] ] -F <emphasis>muttrc</emphasis> ] ] -a <emphasis>
9648 ] ] -c <emphasis>address</emphasis> ] ] -i <emphasis>
9651 ] ] -s <emphasis>subject</emphasis> ] <emphasis>address</emphasis> ] <emphasis>
9658 Mutt-ng also supports a ``batch'' mode to send prepared messages.
9660 input from the file you wish to send. For example,
9664 <literal>mutt -s "data set for run #2"
9665 professor@bigschool.edu
9671 This command will send a message to ``professor@bigschool.edu'' with a
9673 of ``data set for run #2''. In the body of the message will be the
9675 of the file ``~/run2.dat''.
9684 <sect1 id="patterns">
9685 <title>Patterns</title>
9689 <table frame="none" rowsep="1" id="tab-patterns">
9690 <title>Reference: Patterns</title>
9691 <tgroup cols="2" align="left" colsep="1" rowsep="1">
9694 <entry>Pattern Modifier</entry>
9695 <entry>Argument</entry>
9696 <entry>Description</entry>
9701 <entry><muttng-doc:pattern full="1" name="A"/></entry>
9702 <entry><literal></literal></entry>
9703 <entry>all messages</entry>
9706 <entry><muttng-doc:pattern full="1" name="b"/></entry>
9707 <entry><literal>EXPR</literal></entry>
9708 <entry>messages which contain EXPR in the message body</entry>
9711 <entry><muttng-doc:pattern full="1" name="B"/></entry>
9712 <entry><literal>EXPR</literal></entry>
9713 <entry>messages which contain EXPR in the whole message</entry>
9716 <entry><muttng-doc:pattern full="1" name="c"/></entry>
9717 <entry><literal>EXPR</literal></entry>
9718 <entry>messages carbon-copied to EXPR</entry>
9721 <entry><muttng-doc:pattern full="1" name="C"/></entry>
9722 <entry><literal>EXPR</literal></entry>
9723 <entry>message is either to: or cc: EXPR</entry>
9726 <entry><muttng-doc:pattern full="1" name="D"/></entry>
9727 <entry><literal></literal></entry>
9728 <entry>deleted messages</entry>
9731 <entry><muttng-doc:pattern full="1" name="d"/></entry>
9732 <entry><literal>[MIN]-[MAX]</literal></entry>
9733 <entry>messages with ``date-sent'' in a Date range</entry>
9736 <entry><muttng-doc:pattern full="1" name="E"/></entry>
9737 <entry><literal></literal></entry>
9738 <entry>expired messages</entry>
9741 <entry><muttng-doc:pattern full="1" name="e"/></entry>
9742 <entry><literal>EXPR</literal></entry>
9743 <entry>message which contains EXPR in the ``Sender'' field</entry>
9746 <entry><muttng-doc:pattern full="1" name="F"/></entry>
9747 <entry><literal></literal></entry>
9748 <entry>flagged messages</entry>
9751 <entry><muttng-doc:pattern full="1" name="f"/></entry>
9752 <entry><literal>EXPR</literal></entry>
9753 <entry>messages originating from EXPR</entry>
9756 <entry><muttng-doc:pattern full="1" name="g"/></entry>
9757 <entry><literal></literal></entry>
9758 <entry>cryptographically signed messages</entry>
9761 <entry><muttng-doc:pattern full="1" name="G"/></entry>
9762 <entry><literal></literal></entry>
9763 <entry>cryptographically encrypted messages</entry>
9766 <entry><muttng-doc:pattern full="1" name="H"/></entry>
9767 <entry><literal>EXPR</literal></entry>
9768 <entry>messages with a spam attribute matching EXPR</entry>
9771 <entry><muttng-doc:pattern full="1" name="h"/></entry>
9772 <entry><literal>EXPR</literal></entry>
9773 <entry>messages which contain EXPR in the message header</entry>
9776 <entry><muttng-doc:pattern full="1" name="k"/></entry>
9777 <entry><literal></literal></entry>
9778 <entry>message contains PGP key material</entry>
9781 <entry><muttng-doc:pattern full="1" name="i"/></entry>
9782 <entry><literal>EXPR</literal></entry>
9783 <entry>message which match ID in the ``Message-ID'' field</entry>
9786 <entry><muttng-doc:pattern full="1" name="L"/></entry>
9787 <entry><literal>EXPR</literal></entry>
9788 <entry>message is either originated or received by EXPR</entry>
9791 <entry><muttng-doc:pattern full="1" name="l"/></entry>
9792 <entry><literal></literal></entry>
9793 <entry>message is addressed to a known mailing list</entry>
9796 <entry><muttng-doc:pattern full="1" name="m"/></entry>
9797 <entry><literal>[MIN]-[MAX]</literal></entry>
9798 <entry>message in the range MIN to MAX *)</entry>
9801 <entry><muttng-doc:pattern full="1" name="M"/></entry>
9802 <entry><literal></literal></entry>
9803 <entry>multipart messages</entry>
9806 <entry><muttng-doc:pattern full="1" name="n"/></entry>
9807 <entry><literal>[MIN]-[MAX]</literal></entry>
9808 <entry>messages with a score in the range MIN to MAX *)</entry>
9811 <entry><muttng-doc:pattern full="1" name="N"/></entry>
9812 <entry><literal></literal></entry>
9813 <entry>new messages</entry>
9816 <entry><muttng-doc:pattern full="1" name="O"/></entry>
9817 <entry><literal></literal></entry>
9818 <entry>old messages</entry>
9821 <entry><muttng-doc:pattern full="1" name="p"/></entry>
9822 <entry><literal></literal></entry>
9823 <entry>message is addressed to you (consults alternates)</entry>
9826 <entry><muttng-doc:pattern full="1" name="P"/></entry>
9827 <entry><literal></literal></entry>
9828 <entry>message is from you (consults alternates)</entry>
9831 <entry><muttng-doc:pattern full="1" name="Q"/></entry>
9832 <entry><literal></literal></entry>
9833 <entry>messages which have been replied to</entry>
9836 <entry><muttng-doc:pattern full="1" name="R"/></entry>
9837 <entry><literal></literal></entry>
9838 <entry>read messages</entry>
9841 <entry><muttng-doc:pattern full="1" name="r"/></entry>
9842 <entry><literal>[MIN]-[MAX]</literal></entry>
9843 <entry>messages with ``date-received'' in a Date range</entry>
9846 <entry><muttng-doc:pattern full="1" name="S"/></entry>
9847 <entry><literal></literal></entry>
9848 <entry>superseded messages</entry>
9851 <entry><muttng-doc:pattern full="1" name="s"/></entry>
9852 <entry><literal>EXPR</literal></entry>
9853 <entry>messages having EXPR in the ``Subject'' field.</entry>
9856 <entry><muttng-doc:pattern full="1" name="T"/></entry>
9857 <entry><literal></literal></entry>
9858 <entry>tagged messages</entry>
9861 <entry><muttng-doc:pattern full="1" name="t"/></entry>
9862 <entry><literal>EXPR</literal></entry>
9863 <entry>messages addressed to EXPR</entry>
9866 <entry><muttng-doc:pattern full="1" name="U"/></entry>
9867 <entry><literal></literal></entry>
9868 <entry>unread messages</entry>
9871 <entry><muttng-doc:pattern full="1" name="u"/></entry>
9872 <entry><literal></literal></entry>
9873 <entry>message is addressed to a subscribed mailing list</entry>
9876 <entry><muttng-doc:pattern full="1" name="v"/></entry>
9877 <entry><literal></literal></entry>
9878 <entry>message is part of a collapsed thread.</entry>
9881 <entry><muttng-doc:pattern full="1" name="V"/></entry>
9882 <entry><literal></literal></entry>
9883 <entry>cryptographically verified messages</entry>
9886 <entry><muttng-doc:pattern full="1" name="w"/></entry>
9887 <entry><literal>EXPR</literal></entry>
9888 <entry>messages which contain EXPR in the `Newsgroups' field (if compiled with NNTP support)</entry>
9891 <entry><muttng-doc:pattern full="1" name="x"/></entry>
9892 <entry><literal>EXPR</literal></entry>
9893 <entry>messages which contain EXPR in the `References' field</entry>
9896 <entry><muttng-doc:pattern full="1" name="y"/></entry>
9897 <entry><literal>EXPR</literal></entry>
9898 <entry>messages which contain EXPR in the `X-Label' field</entry>
9901 <entry><muttng-doc:pattern full="1" name="z"/></entry>
9902 <entry><literal>[MIN]-[MAX]</literal></entry>
9903 <entry>messages with a size in the range MIN to MAX *)</entry>
9906 <entry><muttng-doc:pattern full="1" name="="/></entry>
9907 <entry><literal></literal></entry>
9908 <entry>duplicated messages (see $duplicate_threads)</entry>
9911 <entry><muttng-doc:pattern full="1" name="$"/></entry>
9912 <entry><literal></literal></entry>
9913 <entry>unreferenced messages (requires threaded view)</entry>
9916 <entry><muttng-doc:pattern full="1" name="*"/></entry>
9917 <entry><literal></literal></entry>
9918 <entry>``From'' contains realname and (syntactically) valid address
9919 (excluded are addresses matching against alternates or any alias)</entry>
9928 <link linkend="advanced-regexp">regexp</link>. Special attention has to be
9929 made when using regular expressions inside of patterns. Specifically,
9930 Mutt-ng's parser for these patterns will strip one level of backslash
9932 which is normally used for quoting. If it is your intention to use a
9933 backslash in the regular expression, you will need to use two
9939 *) The forms <literal><[MAX]</literal>, <literal>>[MIN]</literal>,
9940 <literal>[MIN]-</literal> and <literal>-[MAX]</literal>
9946 <sect1 id="commands">
9947 <title>Configuration Commands</title>
9950 The following are the commands understood by mutt.
9959 <literal><muttng-doc:hook name="account"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
9965 <literal><muttng-doc:command name="alias"/></literal> <emphasis>key</emphasis> <emphasis>address</emphasis> [, <emphasis>address</emphasis>, ... ]
9971 <literal><muttng-doc:command name="unalias"/></literal> [ * | <emphasis>key</emphasis> ... ]
9977 <literal><muttng-doc:command name="alternates"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
9983 <literal><muttng-doc:command name="unalternates"/></literal> [ * | <emphasis>regexp</emphasis> ... ]
9989 <literal><muttng-doc:command name="alternative-order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
9995 <literal><muttng-doc:command name="unalternative-order"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10001 <literal><muttng-doc:hook name="append"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10007 <literal><muttng-doc:command name="auto-view"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10013 <literal><muttng-doc:command name="unauto-view"/></literal><emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10019 <literal><muttng-doc:command name="bind"/></literal> <emphasis>map</emphasis> <emphasis>key</emphasis> <emphasis>function</emphasis>
10025 <literal><muttng-doc:hook name="charset"/></literal> <emphasis>alias</emphasis> <emphasis>charset</emphasis>
10031 <literal><muttng-doc:hook name="close"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10037 <literal><muttng-doc:command name="color"/></literal> <emphasis>object</emphasis> <emphasis>foreground</emphasis> <emphasis>background</emphasis> [ <emphasis>regexp</emphasis> ]
10043 <literal><muttng-doc:command name="uncolor"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10049 <literal><muttng-doc:command name="exec"/></literal> <emphasis>function</emphasis> [ <emphasis>function</emphasis> ... ]
10055 <literal><muttng-doc:hook name="fcc"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10061 <literal><muttng-doc:hook name="fcc-save"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10067 <literal><muttng-doc:hook name="folder"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
10073 <literal><muttng-doc:command name="hdr-order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
10079 <literal><muttng-doc:command name="unhdr-order"/></literal> <emphasis>header</emphasis> [ <emphasis>header</emphasis> ... ]
10085 <literal><muttng-doc:hook name="charset"/></literal> <emphasis>charset</emphasis> <emphasis>local-charset</emphasis>
10091 <literal><muttng-doc:command name="ignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10097 <literal><muttng-doc:command name="unignore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10103 <literal><muttng-doc:command name="lists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10109 <literal><muttng-doc:command name="unlists"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10115 <literal><muttng-doc:command name="macro"/></literal> <emphasis>menu</emphasis> <emphasis>key</emphasis> <emphasis>sequence</emphasis> [ <emphasis>description</emphasis> ]
10121 <literal><muttng-doc:command name="mailboxes"/></literal> <emphasis>filename</emphasis> [ <emphasis>filename</emphasis> ... ]
10127 <literal><muttng-doc:hook name="mbox"/></literal> <emphasis>pattern</emphasis> <emphasis>mailbox</emphasis>
10133 <literal><muttng-doc:hook name="message"/></literal> <emphasis>pattern</emphasis> <emphasis>command</emphasis>
10139 <literal><muttng-doc:command name="mime-lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10146 <muttng-doc:command name="unmime-lookup"/></literal> <emphasis>mimetype</emphasis> [ <emphasis>mimetype</emphasis> ... ]
10152 <literal><muttng-doc:command name="mono"/></literal> <emphasis>object attribute</emphasis> [ <emphasis>regexp</emphasis> ]
10158 <literal><muttng-doc:command name="unmono"/></literal> <emphasis>index</emphasis> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10164 <literal><muttng-doc:command name="my-hdr"/></literal> <emphasis>string</emphasis>
10170 <literal><muttng-doc:command name="unmy-hdr"/></literal> <emphasis>field</emphasis> [ <emphasis>field</emphasis> ... ]
10176 <literal><muttng-doc:hook name="open"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10182 <literal><muttng-doc:hook name="crypt"/></literal> <emphasis>pattern</emphasis> <emphasis>key-id</emphasis>
10188 <literal><muttng-doc:command name="push"/></literal> <emphasis>string</emphasis>
10194 <literal><muttng-doc:command name="reset"/> </literal><emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
10200 <literal><muttng-doc:hook name="save"/></literal> <emphasis>regexp</emphasis> <emphasis>filename</emphasis>
10206 <literal><muttng-doc:command name="score"/> </literal> <emphasis>pattern</emphasis> <emphasis>value</emphasis>
10212 <literal><muttng-doc:command name="unscore"/></literal> <emphasis>pattern</emphasis> [ <emphasis>pattern</emphasis> ... ]
10218 <literal><muttng-doc:hook name="send"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10224 <literal><muttng-doc:hook name="reply"/></literal> <emphasis>regexp</emphasis> <emphasis>command</emphasis>
10230 <literal><muttng-doc:command name="set"/></literal> [no|inv]<emphasis>variable</emphasis>[ =<emphasis>value</emphasis> ] [ <emphasis>variable</emphasis> ... ]
10236 <literal><muttng-doc:command name="unset"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
10242 <literal><muttng-doc:command name="source"/></literal> <emphasis>filename</emphasis>
10248 <literal><muttng-doc:command name="spam"/></literal> <emphasis>pattern</emphasis> <emphasis>format</emphasis>
10254 <literal><muttng-doc:command name="nospam"/></literal> <emphasis>pattern</emphasis>
10260 <literal><muttng-doc:command name="subscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10266 <literal><muttng-doc:command name="unsubscribe"/></literal> <emphasis>regexp</emphasis> [ <emphasis>regexp</emphasis> ... ]
10272 <literal><muttng-doc:command name="toggle"/></literal> <emphasis>variable</emphasis> [ <emphasis>variable</emphasis> ... ]
10278 <literal><muttng-doc:command name="unhook"/></literal> <emphasis>hook-type</emphasis>
10288 <sect1 id="variables">
10289 <title>Configuration variables</title>
10292 The following list contains all variables which, in the process of
10293 providing more consistency, have been renamed and are partially even
10294 removed already. The left column contains the old synonym variables,
10295 the right column the full/new name:
10299 <anchor id="sect-obsolete"/>
10301 <table frame="none" rowsep="1">
10302 <title>Reference: Obsolete Variables</title>
10303 <tgroup cols="2" align="left" colsep="1" rowsep="1">
10306 <entry>Old Name</entry>
10307 <entry>New Name</entry>
10312 <entry><literal>edit_hdrs</literal></entry>
10313 <entry><muttng-doc:varref name="edit-headers"/></entry>
10316 <entry><literal>forw_decode</literal></entry>
10317 <entry><muttng-doc:varref name="forward-decode"/></entry>
10320 <entry><literal>forw_format</literal></entry>
10321 <entry><muttng-doc:varref name="forward-format"/></entry>
10324 <entry><literal>forw_quote</literal></entry>
10325 <entry><muttng-doc:varref name="forward-quote"/></entry>
10328 <entry><literal>hdr_format</literal></entry>
10329 <entry><muttng-doc:varref name="index-format"/></entry>
10332 <entry><literal>indent_str</literal></entry>
10333 <entry><muttng-doc:varref name="indent-string"/></entry>
10336 <entry><literal>mime_fwd</literal></entry>
10337 <entry><muttng-doc:varref name="mime-forward"/></entry>
10340 <entry><literal>msg_format</literal></entry>
10341 <entry><muttng-doc:varref name="message-format"/></entry>
10344 <entry><literal>pgp_autosign</literal></entry>
10345 <entry><muttng-doc:varref name="crypt-autosign"/></entry>
10348 <entry><literal>pgp_autoencrypt</literal></entry>
10349 <entry><muttng-doc:varref name="crypt-autoencrypt"/></entry>
10352 <entry><literal>pgp_replyencrypt</literal></entry>
10353 <entry><muttng-doc:varref name="crypt-replyencrypt"/></entry>
10356 <entry><literal>pgp_replysign</literal></entry>
10357 <entry><muttng-doc:varref name="crypt-replysign"/></entry>
10360 <entry><literal>pgp_replysignencrypted</literal></entry>
10361 <entry><muttng-doc:varref name="crypt-replysignencrypted"/></entry>
10364 <entry><literal>pgp_verify_sig</literal></entry>
10365 <entry><muttng-doc:varref name="crypt-verify-sig"/></entry>
10368 <entry><literal>pgp_create_traditional</literal></entry>
10369 <entry><muttng-doc:varref name="pgp-autoinline"/></entry>
10372 <entry><literal>pgp_auto_traditional</literal></entry>
10373 <entry><muttng-doc:varref name="pgp-replyinline"/></entry>
10376 <entry><literal>forw_decrypt</literal></entry>
10377 <entry><muttng-doc:varref name="forward-decrypt"/></entry>
10380 <entry><literal>smime_sign_as</literal></entry>
10381 <entry><muttng-doc:varref name="smime-default-key"/></entry>
10384 <entry><literal>post_indent_str</literal></entry>
10385 <entry><muttng-doc:varref name="post-indent-string"/></entry>
10388 <entry><literal>print_cmd</literal></entry>
10389 <entry><muttng-doc:varref name="print-command"/></entry>
10392 <entry><literal>shorten_hierarchy</literal></entry>
10393 <entry><muttng-doc:varref name="sidebar-shorten-hierarchy"/></entry>
10396 <entry><literal>ask_followup_to</literal></entry>
10397 <entry><muttng-doc:varref name="nntp-ask-followup-to"/></entry>
10400 <entry><literal>ask_x_comment_to</literal></entry>
10401 <entry><muttng-doc:varref name="nntp-ask-x-comment-to"/></entry>
10404 <entry><literal>catchup_newsgroup</literal></entry>
10405 <entry><muttng-doc:varref name="nntp-catchup"/></entry>
10408 <entry><literal>followup_to_poster</literal></entry>
10409 <entry><muttng-doc:varref name="nntp-followup-to-poster"/></entry>
10412 <entry><literal>group_index_format</literal></entry>
10413 <entry><muttng-doc:varref name="nntp-group-index-format"/></entry>
10416 <entry><literal>inews</literal></entry>
10417 <entry><muttng-doc:varref name="nntp-inews"/></entry>
10420 <entry><literal>mime_subject</literal></entry>
10421 <entry><muttng-doc:varref name="nntp-mime-subject"/></entry>
10424 <entry><literal>news_cache_dir</literal></entry>
10425 <entry><muttng-doc:varref name="nntp-cache-dir"/></entry>
10428 <entry><literal>news_server</literal></entry>
10429 <entry><muttng-doc:varref name="nntp-host"/></entry>
10432 <entry><literal>newsrc</literal></entry>
10433 <entry><muttng-doc:varref name="nntp-newsrc"/></entry>
10436 <entry><literal>nntp_poll</literal></entry>
10437 <entry><muttng-doc:varref name="nntp-mail-check"/></entry>
10440 <entry><literal>pop_checkinterval</literal></entry>
10441 <entry><muttng-doc:varref name="pop-mail-check"/></entry>
10444 <entry><literal>post_moderated</literal></entry>
10445 <entry><muttng-doc:varref name="nntp-post-moderated"/></entry>
10448 <entry><literal>save_unsubscribed</literal></entry>
10449 <entry><muttng-doc:varref name="nntp-save-unsubscribed"/></entry>
10452 <entry><literal>show_new_news</literal></entry>
10453 <entry><muttng-doc:varref name="nntp-show-new-news"/></entry>
10456 <entry><literal>show_only_unread</literal></entry>
10457 <entry><muttng-doc:varref name="nntp-show-only-unread"/></entry>
10460 <entry><literal>x_comment_to</literal></entry>
10461 <entry><muttng-doc:varref name="nntp-x-comment-to"/></entry>
10464 <entry><literal>smtp_auth_username</literal></entry>
10465 <entry><muttng-doc:varref name="smtp-user"/></entry>
10468 <entry><literal>smtp_auth_password</literal></entry>
10469 <entry><muttng-doc:varref name="smtp-pass"/></entry>
10472 <entry><literal>user_agent</literal></entry>
10473 <entry><muttng-doc:varref name="agent-string"/></entry>
10482 The <literal>contrib</literal> subdirectory contains a script named
10483 <literal>update-config.pl</literal> which eases migration.
10487 A complete list of current variables follows.