X-Git-Url: http://git.madism.org/?p=apps%2Fmadmutt.git;a=blobdiff_plain;f=doc%2Fmanual.txt;h=0b9b62f094434d79142ac53a6fe927bd7a8cfcfa;hp=6b1b1e9450626c1584d1139c49ba466101ade04d;hb=fc9c62aae0a7ebf1ff9335e322e7c1f5d3e459d3;hpb=6833ce8bdca2d64e14485118f2a4417b7e1cb1b1 diff --git a/doc/manual.txt b/doc/manual.txt index 6b1b1e9..0b9b62f 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -1,6 +1,6 @@ The Mutt E-Mail Client by Michael Elkins - version 1.5.6 + version 1.5.8 ``All mail clients suck. This one just sucks less.'' -me, circa 1995 ______________________________________________________________________ @@ -59,9 +59,10 @@ 3.21 Adding key sequences to the keyboard buffer 3.22 Executing functions 3.23 Message Scoring - 3.24 Setting variables - 3.25 Reading initialization commands from another file - 3.26 Removing hooks + 3.24 Spam detection + 3.25 Setting variables + 3.26 Reading initialization commands from another file + 3.27 Removing hooks 4. Advanced Usage @@ -417,22 +418,22 @@ ______________________________________________________________________ - 11.. IInnttrroodduuccttiioonn + 1. Introduction - MMuutttt is a small but very powerful text-based MIME mail client. Mutt + Mutt is a small but very powerful text-based MIME mail client. Mutt is highly configurable, and is well suited to the mail power user with advanced features like key bindings, keyboard macros, mail threading, regular expression searches and a powerful pattern matching language for selecting groups of messages. - 11..11.. MMuutttt HHoommee PPaaggee + 1.1. Mutt Home Page http://www.mutt.org/ - 11..22.. MMaaiilliinngg LLiissttss + 1.2. Mailing Lists To subscribe to one of the following mailing lists, send a message - with the word _s_u_b_s_c_r_i_b_e in the body to list-name_-_r_e_q_u_e_s_t@mutt.org. + with the word subscribe in the body to list-name-request@mutt.org. · mutt-announce@mutt.org -- low traffic list for announcements @@ -440,26 +441,26 @@ · mutt-dev@mutt.org -- development mailing list - NNoottee:: all messages posted to _m_u_t_t_-_a_n_n_o_u_n_c_e are automatically forwarded - to _m_u_t_t_-_u_s_e_r_s, so you do not need to be subscribed to both lists. + Note: all messages posted to mutt-announce are automatically forwarded + to mutt-users, so you do not need to be subscribed to both lists. - 11..33.. SSooffttwwaarree DDiissttrriibbuuttiioonn SSiitteess + 1.3. Software Distribution Sites · ftp://ftp.mutt.org/mutt/ For a list of mirror sites, please refer to http://www.mutt.org/download.html. - 11..44.. IIRRCC + 1.4. IRC - Visit channel _#_m_u_t_t on OpenProjects.Net (www.openprojects.net) to chat + Visit channel #mutt on irc.freenode.net (www.freenode.net) to chat with other people interested in Mutt. - 11..55.. UUSSEENNEETT + 1.5. USENET See the newsgroup comp.mail.mutt. - 11..66.. CCooppyyrriigghhtt + 1.6. Copyright Mutt is Copyright (C) 1996-2000 Michael R. Elkins and others @@ -478,7 +479,7 @@ along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. - 22.. GGeettttiinngg SSttaarrtteedd + 2. Getting Started This section is intended as a brief overview of how to use Mutt. There are many other features which are described elsewhere in the @@ -494,7 +495,7 @@ at the command line. There are various command-line options, see either the mutt man page or the ``reference''. - 22..11.. MMoovviinngg AArroouunndd iinn MMeennuuss + 2.1. Moving Around in Menus Information is presented in menus, very similar to ELM. Here is a table showing the common keys used to navigate menus in Mutt. @@ -651,8 +652,8 @@ \ toggle search pattern coloring ^ jump to the top of the message - In addition, many of the functions from the _i_n_d_e_x are available in the - pager, such as _d_e_l_e_t_e_-_m_e_s_s_a_g_e or _c_o_p_y_-_m_e_s_s_a_g_e (this is one advantage + In addition, many of the functions from the index are available in the + pager, such as delete-message or copy-message (this is one advantage over using an external pager to view messages). Also, the internal pager supports a couple other advanced features. @@ -723,17 +724,17 @@ See also: ``$strict_threads''. - 22..33..44.. MMiisscceellllaanneeoouuss FFuunnccttiioonnss + 2.3.4. Miscellaneous Functions - ccrreeaattee--aalliiaass (default: a) + create-alias (default: a) Creates a new alias based upon the current message (or prompts for a new one). Once editing is complete, an ``alias'' command is added to the file specified by the ``$alias_file'' variable for future use. - NNoottee:: Specifying an ``$alias_file'' does not add the aliases specified + Note: Specifying an ``$alias_file'' does not add the aliases specified there-in, you must also ``source'' the file. - cchheecckk--ttrraaddiittiioonnaall--ppggpp (default: ESC P) + check-traditional-pgp (default: ESC P) This function will search the current message for content signed or encrypted with PGP the "traditional" way, that is, without proper MIME @@ -741,12 +742,12 @@ content types of the body parts containing PGP data; this is similar to the ``edit-type'' function's effect. - ddiissppllaayy--ttooggggllee--wweeeedd (default: h) + display-toggle-weed (default: h) Toggles the weeding of message header fields specified by ``ignore'' commands. - eeddiitt (default: e) + edit (default: e) This command (available in the ``index'' and ``pager'') allows you to edit the raw current message as it's present in the mail folder. @@ -754,7 +755,7 @@ to the current folder, and the original message will be marked for deletion. - eeddiitt--ttyyppee + edit-type (default: ^E on the attachment menu, and in the pager and index menus; ^T on the compose menu) @@ -769,40 +770,41 @@ There, it's used to fine-tune the properties of attachments you are going to send. - eenntteerr--ccoommmmaanndd (default: ``:'') + enter-command (default: ``:'') This command is used to execute any command you would normally put in a configuration file. A common use is to check the settings of variables, or in conjunction with ``macros'' to change settings on the fly. - eexxttrraacctt--kkeeyyss (default: ^K) + extract-keys (default: ^K) This command extracts PGP public keys from the current or tagged message(s) and adds them to your PGP public key ring. - ffoorrggeett--ppaasssspphhrraassee (default: ^F) + forget-passphrase (default: ^F) This command wipes the passphrase(s) from memory. It is useful, if you misspelled the passphrase. - lliisstt--rreeppllyy (default: L) + list-reply (default: L) Reply to the current or tagged message(s) by extracting any addresses - which match the addresses given by the ``lists or subscribe'' - commands, but also honor any Mail-Followup-To header(s) if the - ``$honor_followup_to'' configuration variable is set. Using this when - replying to messages posted to mailing lists helps avoid duplicate - copies being sent to the author of the message you are replying to. + which match the regular expressions given by the ``lists or + subscribe'' commands, but also honor any Mail-Followup-To header(s) if + the ``$honor_followup_to'' configuration variable is set. Using this + when replying to messages posted to mailing lists helps avoid + duplicate copies being sent to the author of the message you are + replying to. - ppiippee--mmeessssaaggee (default: |) + pipe-message (default: |) Asks for an external Unix command and pipes the current or tagged message(s) to it. The variables ``$pipe_decode'', ``$pipe_split'', ``$pipe_sep'' and ``$wait_key'' control the exact behaviour of this function. - rreesseenndd--mmeessssaaggee (default: ESC e) + resend-message (default: ESC e) With resend-message, mutt takes the current message as a template for a new message. This function is best described as "recall from @@ -902,32 +904,32 @@ ``$status_format'' will change to a 'A' to indicate that you are in attach-message mode. - 22..44..11.. EEddiittiinngg tthhee mmeessssaaggee hheeaaddeerr + 2.4.1. Editing the message header When editing the header of your outgoing message, there are a couple of special features available. If you specify - Fcc: _f_i_l_e_n_a_m_e - Mutt will pick up _f_i_l_e_n_a_m_e just as if you had used the _e_d_i_t_-_f_c_c - function in the _c_o_m_p_o_s_e menu. + Fcc: filename + Mutt will pick up filename just as if you had used the edit-fcc + function in the compose menu. You can also attach files to your message by specifying - Attach: _f_i_l_e_n_a_m_e [ _d_e_s_c_r_i_p_t_i_o_n ] - where _f_i_l_e_n_a_m_e is the file to attach and _d_e_s_c_r_i_p_t_i_o_n is an optional + Attach: filename [ description ] + where filename is the file to attach and description is an optional string to use as the description of the attached file. - When replying to messages, if you remove the _I_n_-_R_e_p_l_y_-_T_o_: field from - the header field, Mutt will not generate a _R_e_f_e_r_e_n_c_e_s_: field, which + When replying to messages, if you remove the In-Reply-To: field from + the header field, Mutt will not generate a References: field, which allows you to create a new message thread. Also see ``edit_headers''. - 22..44..22.. UUssiinngg MMuutttt wwiitthh PPGGPP + 2.4.2. Using Mutt with PGP If you want to use PGP, you can specify - Pgp: [ E | S | S ] + Pgp: [ E | S | S ] ``E'' encrypts, ``S'' signs and ``S'' signs with the given key, setting ``$pgp_sign_as'' permanently. @@ -963,24 +965,24 @@ The capabilities field (%c) expands to a two-character sequence representing a key's capabilities. The first character gives the - key's encryption capabilities: A minus sign (--) means that the key - cannot be used for encryption. A dot (..) means that it's marked as a + key's encryption capabilities: A minus sign (-) means that the key + cannot be used for encryption. A dot (.) means that it's marked as a signature key in one of the user IDs, but may also be used for - encryption. The letter ee indicates that this key can be used for + encryption. The letter e indicates that this key can be used for encryption. The second character indicates the key's signing capabilities. Once - again, a ``--'' implies ``not for signing'', ``..'' implies that the key - is marked as an encryption key in one of the user-ids, and ``ss'' + again, a ``-'' implies ``not for signing'', ``.'' implies that the key + is marked as an encryption key in one of the user-ids, and ``s'' denotes a key which can be used for signing. Finally, the validity field (%t) indicates how well-certified a user- - id is. A question mark (??) indicates undefined validity, a minus - character (--) marks an untrusted association, a space character means - a partially trusted association, and a plus character (++) indicates + id is. A question mark (?) indicates undefined validity, a minus + character (-) marks an untrusted association, a space character means + a partially trusted association, and a plus character (+) indicates complete validity. - 22..44..33.. SSeennddiinngg aannoonnyymmoouuss mmeessssaaggeess vviiaa mmiixxmmaasstteerr.. + 2.4.3. Sending anonymous messages via mixmaster. You may also have configured mutt to co-operate with Mixmaster, an anonymous remailer. Mixmaster permits you to send your messages @@ -1016,7 +1018,7 @@ the other capabilities, please have a look at the mixmaster documentation. - 22..55.. FFoorrwwaarrddiinngg aanndd BBoouunncciinngg MMaaiill + 2.5. Forwarding and Bouncing Mail Bouncing and forwarding let you send an existing message to recipients that you specify. Bouncing a message uses the ``sendmail'' command to @@ -1035,7 +1037,7 @@ variable. Decoding of attachments, like in the pager, can be controlled by the ``$forward_decode'' and ``$mime_forward_decode'' variables, respectively. The desired forwarding format may depend on - the content, therefore _$_m_i_m_e___f_o_r_w_a_r_d is a quadoption which, for + the content, therefore $mime_forward is a quadoption which, for example, can be set to ``ask-no''. The inclusion of headers is controlled by the current setting of the @@ -1091,7 +1093,6 @@ .muttrc is the file where you will usually place your ``commands'' to configure Mutt. - In addition, mutt supports version specific configuration files that are parsed instead of the default files as explained above. For instance, if your system has a Muttrc-0.88 file in the system @@ -1103,7 +1104,7 @@ number is the same which is visible using the ``-v'' ``command line'' switch or using the show-version key (default: V) from the index menu. - 33..11.. SSyynnttaaxx ooff IInniittiiaalliizzaattiioonn FFiilleess + 3.1. Syntax of Initialization Files An initialization file consists of a series of ``commands''. Each line of the file may contain one or more commands. When multiple @@ -1125,7 +1126,7 @@ literal string (one that is not interpreted for shell variables or quoting with a backslash [see next paragraph]), while double quotes indicate a string for which should be evaluated. For example, - backtics are evaluated inside of double quotes, but nnoott for single + backtics are evaluated inside of double quotes, but not for single quotes. \ quotes the next character, just as in shells such as bash and zsh. @@ -1163,21 +1164,21 @@ The commands understood by mutt are explained in the next paragraphs. For a complete list, see the ``command reference''. - 33..22.. DDeeffiinniinngg//UUssiinngg aalliiaasseess + 3.2. Defining/Using aliases - Usage: alias _k_e_y _a_d_d_r_e_s_s [ , _a_d_d_r_e_s_s, ... ] + Usage: alias key address [ , address, ... ] It's usually very cumbersome to remember or type out the address of someone you are communicating with. Mutt allows you to create ``aliases'' which map a short string to a full address. - NNoottee:: if you want to create an alias for a group (by specifying more - than one address), you mmuusstt separate the addresses with a comma + Note: if you want to create an alias for a group (by specifying more + than one address), you must separate the addresses with a comma (``,''). To remove an alias or aliases (``*'' means all aliases): - unalias [ * | _k_e_y _._._. ] + unalias [ * | key ... ] alias muttdude me@cs.hmc.edu (Michael Elkins) alias theguys manny, moe, jack @@ -1194,7 +1195,6 @@ that Mutt will happily append aliases to any file, but in order for the new aliases to take effect you need to explicitly ``source'' this file too. - For example: source /usr/local/share/Mutt.aliases @@ -1202,7 +1202,7 @@ set alias_file=~/.mail_aliases To use aliases, you merely use the alias at any place in mutt where - mutt prompts for addresses, such as the _T_o_: or _C_c_: prompt. You can + mutt prompts for addresses, such as the To: or Cc: prompt. You can also enter aliases in your editor at the appropriate headers if you have the ``$edit_headers'' variable set. @@ -1214,20 +1214,21 @@ or after a comma denoting multiple addresses. In the alias menu, you can select as many aliases as you want with the - _s_e_l_e_c_t_-_e_n_t_r_y key (default: RET), and use the _e_x_i_t key (default: q) to + select-entry key (default: RET), and use the exit key (default: q) to return to the address prompt. - 33..33.. CChhaannggiinngg tthhee ddeeffaauulltt kkeeyy bbiinnddiinnggss + 3.3. Changing the default key bindings - Usage: bind _m_a_p _k_e_y _f_u_n_c_t_i_o_n + Usage: bind map key function This command allows you to change the default key bindings (operation invoked when pressing a key). - _m_a_p specifies in which menu the binding belongs. The currently - defined maps are: + map specifies in which menu the binding belongs. Multiple maps may be + specified by separating them with commas (no additional whitespace is + allowed). The currently defined maps are: - ggeenneerriicc + generic This is not a real menu, but is used as a fallback for all of the other menus except for the pager and editor modes. If a key is not defined in another menu, Mutt will look for a binding to @@ -1235,85 +1236,85 @@ function in multiple menus instead of having multiple bind statements to accomplish the same task. - aalliiaass + alias The alias menu is the list of your personal aliases as defined in your muttrc. It is the mapping from a short alias name to the full email address(es) of the recipient(s). - aattttaacchh + attach The attachment menu is used to access the attachments on received messages. - bbrroowwsseerr + browser The browser is used for both browsing the local directory structure, and for listing all of your incoming mailboxes. - eeddiittoorr + editor The editor is the line-based editor the user enters text data. - iinnddeexx + index The index is the list of messages contained in a mailbox. - ccoommppoossee + compose The compose menu is the screen used when sending a new message. - ppaaggeerr + pager The pager is the mode used to display message/attachment data, and help listings. - ppggpp + pgp The pgp menu is used to select the OpenPGP keys used for encrypting outgoing messages. - ppoossttppoonnee + postpone The postpone menu is similar to the index menu, except is used when recalling a message the user was composing, but saved until later. - _k_e_y is the key (or key sequence) you wish to bind. To specify a - control character, use the sequence _\_C_x, where _x is the letter of the + key is the key (or key sequence) you wish to bind. To specify a + control character, use the sequence \Cx, where x is the letter of the control character (for example, to specify control-A use ``\Ca''). - Note that the case of _x as well as _\_C is ignored, so that _\_C_A_, _\_C_a_, - _\_c_A and _\_c_a are all equivalent. An alternative form is to specify the + Note that the case of x as well as \C is ignored, so that \CA, \Ca, + \cA and \ca are all equivalent. An alternative form is to specify the key as a three digit octal number prefixed with a ``\'' (for example - _\_1_7_7 is equivalent to _\_c_?). - - In addition, _k_e_y may consist of: - - \t tab - tab - \r carriage return - \n newline - \e escape - escape - up arrow - down arrow - left arrow - right arrow - Page Up - Page Down - Backspace - Delete - Insert - Enter - Return - Home - End - Space bar - function key 1 - function key 10 - - _k_e_y does not need to be enclosed in quotes unless it contains a space + \177 is equivalent to \c?). + + In addition, key may consist of: + + \t tab + tab + \r carriage return + \n newline + \e escape + escape + up arrow + down arrow + left arrow + right arrow + Page Up + Page Down + Backspace + Delete + Insert + Enter + Return + Home + End + Space bar + function key 1 + function key 10 + + key does not need to be enclosed in quotes unless it contains a space (`` ''). - _f_u_n_c_t_i_o_n specifies which action to take when _k_e_y is pressed. For a + function specifies which action to take when key is pressed. For a complete list of functions, see the ``reference''. The special function noop unbinds the specified key sequence. - 33..44.. DDeeffiinniinngg aalliiaasseess ffoorr cchhaarraacctteerr sseettss + 3.4. Defining aliases for character sets - Usage: charset-hook _a_l_i_a_s _c_h_a_r_s_e_t - Usage: iconv-hook _c_h_a_r_s_e_t _l_o_c_a_l_-_c_h_a_r_s_e_t + Usage: charset-hook alias charset + Usage: iconv-hook charset local-charset The charset-hook command defines an alias for a character set. This is useful to properly display messages which are tagged with a @@ -1323,50 +1324,55 @@ set. This is helpful when your systems character conversion library insists on using strange, system-specific names for character sets. - 33..55.. SSeettttiinngg vvaarriiaabblleess bbaasseedd uuppoonn mmaaiillbbooxx + 3.5. Setting variables based upon mailbox - Usage: folder-hook [!]_r_e_g_e_x_p _c_o_m_m_a_n_d + Usage: folder-hook [!]regexp command It is often desirable to change settings based on which mailbox you are reading. The folder-hook command provides a method by which you - can execute any configuration command. _r_e_g_e_x_p is a regular expression - specifying in which mailboxes to execute _c_o_m_m_a_n_d before loading. If a + can execute any configuration command. regexp is a regular expression + specifying in which mailboxes to execute command before loading. If a mailbox matches multiple folder-hook's, they are executed in the order given in the muttrc. - NNoottee:: if you use the ``!'' shortcut for ``$spoolfile'' at the + Note: if you use the ``!'' shortcut for ``$spoolfile'' at the beginning of the pattern, you must place it inside of double or single - quotes in order to distinguish it from the logical _n_o_t operator for + quotes in order to distinguish it from the logical not operator for the expression. - Note that the settings are _n_o_t restored when you leave the mailbox. + Note that the settings are not restored when you leave the mailbox. For example, a command action to perform is to change the sorting method based upon the mailbox being read: folder-hook mutt set sort=threads However, the sorting method is not restored to its previous value when - reading a different mailbox. To specify a _d_e_f_a_u_l_t command, use the + reading a different mailbox. To specify a default command, use the pattern ``.'': folder-hook . set sort=date-sent - 33..66.. KKeeyybbooaarrdd mmaaccrrooss + 3.6. Keyboard macros - Usage: macro _m_e_n_u _k_e_y _s_e_q_u_e_n_c_e [ _d_e_s_c_r_i_p_t_i_o_n ] + Usage: macro menu key sequence [ description ] Macros are useful when you would like a single key to perform a series - of actions. When you press _k_e_y in menu _m_e_n_u, Mutt will behave as if - you had typed _s_e_q_u_e_n_c_e. So if you have a common sequence of commands + of actions. When you press key in menu menu, Mutt will behave as if + you had typed sequence. So if you have a common sequence of commands you type, you can create a macro to execute those commands with a single key. - _k_e_y and _s_e_q_u_e_n_c_e are expanded by the same rules as the ``key + menu is the ``map'' which the macro will be bound. Multiple maps may + be specified by separating multiple menu arguments by commas. + Whitespace may not be used in between the menu arguments and the + commas separating them. + + key and sequence are expanded by the same rules as the ``key bindings''. There are some additions however. The first is that - control characters in _s_e_q_u_e_n_c_e can also be specified as _^_x. In order - to get a caret (`^'') you need to use _^_^. Secondly, to specify a - certain key such as _u_p or to invoke a function directly, you can use - the format _<_k_e_y _n_a_m_e_> and _<_f_u_n_c_t_i_o_n _n_a_m_e_>. For a listing of key names + control characters in sequence can also be specified as ^x. In order + to get a caret (`^'') you need to use ^^. Secondly, to specify a + certain key such as up or to invoke a function directly, you can use + the format  and . For a listing of key names see the section on ``key bindings''. Functions are listed in the ``function reference''. @@ -1376,39 +1382,39 @@ them more robust and portable, and also facilitates defining of macros in files used by more than one user (eg. the system Muttrc). - Optionally you can specify a descriptive text after _s_e_q_u_e_n_c_e, which is + Optionally you can specify a descriptive text after sequence, which is shown in the help screens. - NNoottee:: Macro definitions (if any) listed in the help screen(s), are + Note: Macro definitions (if any) listed in the help screen(s), are silently truncated at the screen width, and are not wrapped. - 33..77.. UUssiinngg ccoolloorr aanndd mmoonnoo vviiddeeoo aattttrriibbuutteess + 3.7. Using color and mono video attributes - Usage: color _o_b_j_e_c_t _f_o_r_e_g_r_o_u_n_d _b_a_c_k_g_r_o_u_n_d [ _r_e_g_e_x_p ] - Usage: color index _f_o_r_e_g_r_o_u_n_d _b_a_c_k_g_r_o_u_n_d _p_a_t_t_e_r_n - Usage: uncolor index _p_a_t_t_e_r_n [ _p_a_t_t_e_r_n ... ] + Usage: color object foreground background [ regexp ] + Usage: color index foreground background pattern + Usage: uncolor index pattern [ pattern ... ] If your terminal supports color, you can spice up Mutt by creating your own color scheme. To define the color of an object (type of - information), you must specify both a foreground color aanndd a + information), you must specify both a foreground color and a background color (it is not possible to only specify one or the other). - _o_b_j_e_c_t can be one of: + object can be one of: · attachment - · body (match _r_e_g_e_x_p in the body of messages) + · body (match regexp in the body of messages) · bold (hiliting bold patterns in the body of messages) · error (error messages printed by Mutt) - · header (match _r_e_g_e_x_p in the message header) + · header (match regexp in the message header) · hdrdefault (default color of the message header in the pager) - · index (match _p_a_t_t_e_r_n in the message index) + · index (match pattern in the message index) · indicator (arrow or bar used to indicate the current item in a menu) @@ -1422,7 +1428,7 @@ · quoted (text matching ``$quote_regexp'' in the body of a message) - · quoted1, quoted2, ..., quotedNN (higher levels of quoting) + · quoted1, quoted2, ..., quotedN (higher levels of quoting) · search (hiliting of words in the pager) @@ -1437,7 +1443,7 @@ · underline (hiliting underlined patterns in the body of messages) - _f_o_r_e_g_r_o_u_n_d and _b_a_c_k_g_r_o_u_n_d can be one of the following: + foreground and background can be one of the following: · white @@ -1457,43 +1463,43 @@ · default - · color_x + · colorx - _f_o_r_e_g_r_o_u_n_d can optionally be prefixed with the keyword bright to make + foreground can optionally be prefixed with the keyword bright to make the foreground color boldfaced (e.g., brightred). - If your terminal supports it, the special keyword _d_e_f_a_u_l_t can be used - as a transparent color. The value _b_r_i_g_h_t_d_e_f_a_u_l_t is also valid. If - Mutt is linked against the _S_-_L_a_n_g library, you also need to set the - _C_O_L_O_R_F_G_B_G environment variable to the default colors of your terminal + If your terminal supports it, the special keyword default can be used + as a transparent color. The value brightdefault is also valid. If + Mutt is linked against the S-Lang library, you also need to set the + COLORFGBG environment variable to the default colors of your terminal for this to work; for example (for Bourne-like shells): set COLORFGBG="green;black" export COLORFGBG - NNoottee:: The _S_-_L_a_n_g library requires you to use the _l_i_g_h_t_g_r_a_y and _b_r_o_w_n - keywords instead of _w_h_i_t_e and _y_e_l_l_o_w when setting this variable. + Note: The S-Lang library requires you to use the lightgray and brown + keywords instead of white and yellow when setting this variable. - NNoottee:: The uncolor command can be applied to the index object only. It - removes entries from the list. You mmuusstt specify the same pattern + Note: The uncolor command can be applied to the index object only. It + removes entries from the list. You must specify the same pattern specified in the color command for it to be removed. The pattern ``*'' is a special token which means to clear the color index list of all entries. - Mutt also recognizes the keywords _c_o_l_o_r_0, _c_o_l_o_r_1, ..., _c_o_l_o_rNN--11 (NN + Mutt also recognizes the keywords color0, color1, ..., colorN-1 (N being the number of colors supported by your terminal). This is useful when you remap the colors for your display (for example by - changing the color associated with _c_o_l_o_r_2 for your xterm), since color + changing the color associated with color2 for your xterm), since color names may then lose their normal meaning. If your terminal does not support color, it is still possible change the video attributes through the use of the ``mono'' command: - Usage: mono _<_o_b_j_e_c_t_> _<_a_t_t_r_i_b_u_t_e_> [ _r_e_g_e_x_p ] - Usage: mono index _a_t_t_r_i_b_u_t_e _p_a_t_t_e_r_n - Usage: unmono index _p_a_t_t_e_r_n [ _p_a_t_t_e_r_n ... ] + Usage: mono   [ regexp ] + Usage: mono index attribute pattern + Usage: unmono index pattern [ pattern ... ] - where _a_t_t_r_i_b_u_t_e is one of the following: + where attribute is one of the following: · none @@ -1505,9 +1511,9 @@ · standout - 33..88.. IIggnnoorriinngg ((wweeeeddiinngg)) uunnwwaanntteedd mmeessssaaggee hheeaaddeerrss + 3.8. Ignoring (weeding) unwanted message headers - Usage: [un]ignore _p_a_t_t_e_r_n [ _p_a_t_t_e_r_n ... ] + Usage: [un]ignore pattern [ pattern ... ] Messages often have many header fields added by automatic processing systems, or which may not seem useful to display on the screen. This @@ -1533,9 +1539,9 @@ unignore organization organisation x-mailer: x-newsreader: x-mailing-list: unignore posted-to: - 33..99.. AAlltteerrnnaattiivvee aaddddrreesssseess + 3.9. Alternative addresses - Usage: [un]alternates _r_e_g_e_x_p [ _r_e_g_e_x_p ... ] + Usage: [un]alternates regexp [ regexp ... ] With various functions, mutt will treat messages differently, depending on whether you sent them or whether you received them from @@ -1550,13 +1556,21 @@ the alternates command: It takes a list of regular expressions, each of which can identify an address under which you receive e-mail. - To remove a regular expression from this list, use the unalternates - command. + The unalternates command can be used to write exceptions to alternates + patterns. If an address matches something in an alternates command, + but you nonetheless do not think it is from you, you can list a more + precise pattern under an unalternates command. + + To remove a regular expression from the alternates list, use the + unalternates command with exactly the same regexp. Likewise, if the + regexp for a alternates command matches an entry on the unalternates + list, that unalternates entry will be removed. If the regexp for + unalternates is ``*'', all entries on alternates will be removed. - 33..1100.. MMaaiilliinngg lliissttss + 3.10. Mailing lists - Usage: [un]lists _r_e_g_e_x_p [ _r_e_g_e_x_p ... ] - Usage: [un]subscribe _r_e_g_e_x_p [ _r_e_g_e_x_p ... ] + Usage: [un]lists regexp [ regexp ... ] + Usage: [un]subscribe regexp [ regexp ... ] Mutt has a few nice features for ``handling mailing lists''. In order to take advantage of them, you must specify which addresses belong to @@ -1584,45 +1598,44 @@ Specify as much of the address as you need to to remove ambiguity. For example, if you've subscribed to the Mutt mailing list, you will - receive mail addresssed to _m_u_t_t_-_u_s_e_r_s_@_m_u_t_t_._o_r_g. So, to tell Mutt that + receive mail addresssed to mutt-users@mutt.org. So, to tell Mutt that this is a mailing list, you could add ``lists mutt-users'' to your initialization file. To tell mutt that you are subscribed to it, add ``subscribe mutt-users'' to your initialization file instead. If you - also happen to get mail from someone whose address is _m_u_t_t_- - _u_s_e_r_s_@_e_x_a_m_p_l_e_._c_o_m, you could use ``lists mutt-users@mutt.org'' or - ``subscribe mutt-users@mutt.org'' to match only mail from the actual + also happen to get mail from someone whose address is mutt- + users@example.com, you could use ``lists mutt-users@mutt\\.org'' or + ``subscribe mutt-users@mutt\\.org'' to match only mail from the actual list. The ``unlists'' command is used to remove a token from the list of known and subscribed mailing-lists. Use ``unlists *'' to remove all tokens. - To remove a mailing list from the list of subscribed mailing lists, but keep it on the list of known mailing lists, use ``unsubscribe''. - 33..1111.. UUssiinngg MMuullttiippllee ssppooooll mmaaiillbbooxxeess + 3.11. Using Multiple spool mailboxes - Usage: mbox-hook [!]_p_a_t_t_e_r_n _m_a_i_l_b_o_x + Usage: mbox-hook [!]pattern mailbox This command is used to move read messages from a specified mailbox to a different mailbox automatically when you quit or change folders. - _p_a_t_t_e_r_n is a regular expression specifying the mailbox to treat as a - ``spool'' mailbox and _m_a_i_l_b_o_x specifies where mail should be saved + pattern is a regular expression specifying the mailbox to treat as a + ``spool'' mailbox and mailbox specifies where mail should be saved when read. - Unlike some of the other _h_o_o_k commands, only the _f_i_r_s_t matching + Unlike some of the other hook commands, only the first matching pattern is used (it is not possible to save read mail in more than a single mailbox). - 33..1122.. DDeeffiinniinngg mmaaiillbbooxxeess wwhhiicchh rreecceeiivvee mmaaiill + 3.12. Defining mailboxes which receive mail - Usage: [un]mailboxes [!]_f_i_l_e_n_a_m_e [ _f_i_l_e_n_a_m_e ... ] + Usage: [un]mailboxes [!]filename [ filename ... ] This command specifies folders which can receive mail and which will be checked for new messages. By default, the main menu status bar displays how many of these folders have new messages. - When changing folders, pressing _s_p_a_c_e will cycle through folders with + When changing folders, pressing space will cycle through folders with new mail. Pressing TAB in the directory browser will bring up a menu showing the @@ -1634,23 +1647,23 @@ folders which receive mail. Use ``unmailboxes *'' to remove all tokens. - NNoottee:: new mail is detected by comparing the last modification time to + Note: new mail is detected by comparing the last modification time to the last access time. Utilities like biff or frm or any other program which accesses the mailbox might cause Mutt to never detect new mail for that mailbox if they do not properly reset the access time. Backup tools are another common reason for updated access times. - NNoottee:: the filenames in the mailboxes command are resolved when the + Note: the filenames in the mailboxes command are resolved when the command is executed, so if these names contain ``shortcut characters'' (such as ``='' and ``!''), any variable definition that affect these characters (like ``$folder'' and ``$spoolfile'') should be executed before the mailboxes command. - 33..1133.. UUsseerr ddeeffiinneedd hheeaaddeerrss + 3.13. User defined headers Usage: - my_hdr _s_t_r_i_n_g - unmy_hdr _f_i_e_l_d [ _f_i_e_l_d ... ] + my_hdr string + unmy_hdr field [ field ... ] The ``my_hdr'' command allows you to create your own header fields which will be added to every message you send. @@ -1662,13 +1675,13 @@ in your .muttrc. - NNoottee:: space characters are _n_o_t allowed between the keyword and the + Note: space characters are not allowed between the keyword and the colon (``:''). The standard for electronic mail (RFC822) says that space is illegal there, so Mutt enforces the rule. If you would like to add a header field to a single message, you - should either set the ``edit_headers'' variable, or use the _e_d_i_t_- - _h_e_a_d_e_r_s function (default: ``E'') in the send-menu so that you can + should either set the ``edit_headers'' variable, or use the edit- + headers function (default: ``E'') in the send-menu so that you can edit the header of your message along with the body. To remove user defined header fields, use the ``unmy_hdr'' command. @@ -1678,9 +1691,9 @@ unmy_hdr to cc - 33..1144.. DDeeffiinniinngg tthhee oorrddeerr ooff hheeaaddeerrss wwhheenn vviieewwiinngg mmeessssaaggeess + 3.14. Defining the order of headers when viewing messages - Usage: hdr_order _h_e_a_d_e_r_1 _h_e_a_d_e_r_2 _h_e_a_d_e_r_3 + Usage: hdr_order header1 header2 header3 With this command, you can specify an order in which mutt will attempt to present headers to you when viewing messages. @@ -1691,17 +1704,17 @@ hdr_order From Date: From: To: Cc: Subject: - 33..1155.. SSppeecciiffyy ddeeffaauulltt ssaavvee ffiilleennaammee + 3.15. Specify default save filename - Usage: save-hook [!]_p_a_t_t_e_r_n _f_i_l_e_n_a_m_e + Usage: save-hook [!]pattern filename This command is used to override the default filename used when saving - messages. _f_i_l_e_n_a_m_e will be used as the default filename if the - message is _F_r_o_m_: an address matching _r_e_g_e_x_p or if you are the author - and the message is addressed _t_o_: something matching _r_e_g_e_x_p. + messages. filename will be used as the default filename if the + message is From: an address matching regexp or if you are the author + and the message is addressed to: something matching regexp. See ``Message Matching in Hooks'' for information on the exact format - of _p_a_t_t_e_r_n. + of pattern. Examples: @@ -1710,54 +1723,61 @@ Also see the ``fcc-save-hook'' command. - 33..1166.. SSppeecciiffyy ddeeffaauulltt FFcccc:: mmaaiillbbooxx wwhheenn ccoommppoossiinngg + 3.16. Specify default Fcc: mailbox when composing - Usage: fcc-hook [!]_p_a_t_t_e_r_n _m_a_i_l_b_o_x + Usage: fcc-hook [!]pattern mailbox This command is used to save outgoing mail in a mailbox other than ``$record''. Mutt searches the initial list of message recipients for - the first matching _r_e_g_e_x_p and uses _m_a_i_l_b_o_x as the default Fcc: + the first matching regexp and uses mailbox as the default Fcc: mailbox. If no match is found the message will be saved to ``$record'' mailbox. See ``Message Matching in Hooks'' for information on the exact format - of _p_a_t_t_e_r_n. + of pattern. - Example: fcc-hook aol.com$ +spammers + Example: fcc-hook [@.]aol\\.com$ +spammers The above will save a copy of all messages going to the aol.com domain to the `+spammers' mailbox by default. Also see the ``fcc-save-hook'' command. - 33..1177.. SSppeecciiffyy ddeeffaauulltt ssaavvee ffiilleennaammee aanndd ddeeffaauulltt FFcccc:: mmaaiillbbooxx aatt oonnccee + 3.17. Specify default save filename and default Fcc: mailbox at once - Usage: fcc-save-hook [!]_p_a_t_t_e_r_n _m_a_i_l_b_o_x + Usage: fcc-save-hook [!]pattern mailbox This command is a shortcut, equivalent to doing both a ``fcc-hook'' and a ``save-hook'' with its arguments. - 33..1188.. CChhaannggee sseettttiinnggss bbaasseedd uuppoonn mmeessssaaggee rreecciippiieennttss + 3.18. Change settings based upon message recipients - Usage: reply-hook [!]_p_a_t_t_e_r_n _c_o_m_m_a_n_d - Usage: send-hook [!]_p_a_t_t_e_r_n _c_o_m_m_a_n_d + Usage: reply-hook [!]pattern command + Usage: send-hook [!]pattern command + Usage: send2-hook [!]pattern command These commands can be used to execute arbitrary configuration commands - based upon recipients of the message. _p_a_t_t_e_r_n is a regular expression - matching the desired address. _c_o_m_m_a_n_d is executed when _r_e_g_e_x_p matches + based upon recipients of the message. pattern is a regular expression + matching the desired address. command is executed when regexp matches recipients of the message. - reply-hook is matched against the message you are _r_e_p_l_y_i_n_g ttoo, instead - of the message you are _s_e_n_d_i_n_g. send-hook is matched against all - messages, both _n_e_w and _r_e_p_l_i_e_s. NNoottee:: reply-hooks are matched bbeeffoorree - the send-hook, rreeggaarrddlleessss of the order specified in the users's + reply-hook is matched against the message you are replying to, instead + of the message you are sending. send-hook is matched against all + messages, both new and replies. Note: reply-hooks are matched before + the send-hook, regardless of the order specified in the users's configuration file. - For each type of send-hook or reply-hook, When multiple matches occur, + send2-hook is matched every time a message is changed, either by + editing it, or by using the compose menu to change its recipients or + subject. send2-hook is executed after send-hook, and can, e.g., be + used to set parameters such as the ``$sendmail'' variable depending on + the message's sender address. + + For each type of send-hook or reply-hook, when multiple matches occur, commands are executed in the order they are specified in the muttrc (for that type of hook). See ``Message Matching in Hooks'' for information on the exact format - of _p_a_t_t_e_r_n. + of pattern. Example: send-hook mutt "set mime_forward signature=''" @@ -1766,34 +1786,34 @@ change the language of the attributions and signatures based upon the recipients. - NNoottee:: the send-hook's are only executed ONCE after getting the initial + Note: the send-hook's are only executed ONCE after getting the initial list of recipients. Adding a recipient after replying or editing the message will NOT cause any send-hook to be executed. Also note that my_hdr commands which modify recipient headers, or the message's subject, don't have any effect on the current message when executed from a send-hook. - 33..1199.. CChhaannggee sseettttiinnggss bbeeffoorree ffoorrmmaattttiinngg aa mmeessssaaggee + 3.19. Change settings before formatting a message - Usage: message-hook [!]_p_a_t_t_e_r_n _c_o_m_m_a_n_d + Usage: message-hook [!]pattern command This command can be used to execute arbitrary configuration commands before viewing or formatting a message based upon information about - the message. _c_o_m_m_a_n_d is executed if the _p_a_t_t_e_r_n matches the message + the message. command is executed if the pattern matches the message to be displayed. When multiple matches occur, commands are executed in the order they are specified in the muttrc. See ``Message Matching in Hooks'' for information on the exact format - of _p_a_t_t_e_r_n. + of pattern. Example: message-hook ~A 'set pager=builtin' message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""' - 33..2200.. CChhoooossiinngg tthhee ccrryyppttooggrraapphhiicc kkeeyy ooff tthhee rreecciippiieenntt + 3.20. Choosing the cryptographic key of the recipient - Usage: crypt-hook _p_a_t_t_e_r_n _k_e_y_i_d + Usage: crypt-hook pattern keyid When encrypting messages with PGP or OpenSSL, you may want to associate a certain key with a given e-mail address automatically, @@ -1807,9 +1827,9 @@ can either put a numerical key ID here, an e-mail address, or even just a real name. - 33..2211.. AAddddiinngg kkeeyy sseeqquueenncceess ttoo tthhee kkeeyybbooaarrdd bbuuffffeerr + 3.21. Adding key sequences to the keyboard buffer - Usage: push _s_t_r_i_n_g + Usage: push string This command adds the named string to the keyboard buffer. The string may contain control characters, key names and function names like the @@ -1817,63 +1837,155 @@ automatically run a sequence of commands at startup, or when entering certain folders. - 33..2222.. EExxeeccuuttiinngg ffuunnccttiioonnss + 3.22. Executing functions - Usage: exec _f_u_n_c_t_i_o_n [ _f_u_n_c_t_i_o_n ... ] + Usage: exec function [ function ... ] This command can be used to execute any function. Functions are listed in the ``function reference''. ``exec function'' is equivalent to ``push ''. - 33..2233.. MMeessssaaggee SSccoorriinngg + 3.23. Message Scoring - Usage: score _p_a_t_t_e_r_n _v_a_l_u_e - Usage: unscore _p_a_t_t_e_r_n [ _p_a_t_t_e_r_n ... ] + Usage: score pattern value + Usage: unscore pattern [ pattern ... ] - The score commands adds _v_a_l_u_e to a message's score if _p_a_t_t_e_r_n matches - it. _p_a_t_t_e_r_n is a string in the format described in the ``patterns'' + The score commands adds value to a message's score if pattern matches + it. pattern is a string in the format described in the ``patterns'' section (note: For efficiency reasons, patterns which scan information not available in the index, such as ~b, ~B or ~h, may not be used). - _v_a_l_u_e is a positive or negative integer. A message's final score is + value is a positive or negative integer. A message's final score is the sum total of all matching score entries. However, you may - optionally prefix _v_a_l_u_e with an equal sign (=) to cause evaluation to + optionally prefix value with an equal sign (=) to cause evaluation to stop at a particular entry if there is a match. Negative final scores are rounded up to 0. - The unscore command removes score entries from the list. You mmuusstt + The unscore command removes score entries from the list. You must specify the same pattern specified in the score command for it to be removed. The pattern ``*'' is a special token which means to clear the list of all score entries. - 33..2244.. SSeettttiinngg vvaarriiaabblleess - - Usage: set [no|inv]_v_a_r_i_a_b_l_e[=_v_a_l_u_e] [ _v_a_r_i_a_b_l_e ... ] - Usage: toggle _v_a_r_i_a_b_l_e [_v_a_r_i_a_b_l_e ... ] - Usage: unset _v_a_r_i_a_b_l_e [_v_a_r_i_a_b_l_e ... ] - Usage: reset _v_a_r_i_a_b_l_e [_v_a_r_i_a_b_l_e ... ] + 3.24. Spam detection + + Usage: spam pattern format + Usage: nospam pattern + + Mutt has generalized support for external spam-scoring filters. By + defining your spam patterns with the spam and nospam commands, you can + limit, search, and sort your mail based on its spam attributes, as + determined by the external filter. You also can display the spam + attributes in your index display using the %H selector in the + ``$index_format'' variable. (Tip: try %?H?[%H] ? to display spam tags + only when they are defined for a given message.) + + Your first step is to define your external filter's spam patterns + using the spam command. pattern should be a regular expression that + matches a header in a mail message. If any message in the mailbox + matches this regular expression, it will receive a ``spam tag'' or + ``spam attribute'' (unless it also matches a nospam pattern -- see + below.) The appearance of this attribute is entirely up to you, and is + governed by the format parameter. format can be any static text, but + it also can include back-references from the pattern expression. (A + regular expression ``back-reference'' refers to a sub-expression + contained within parentheses.) %1 is replaced with the first back- + reference in the regex, %2 with the second, etc. + + If you're using multiple spam filters, a message can have more than + one spam-related header. You can define spam patterns for each filter + you use. If a message matches two or more of these patterns, and the + $spam_separator variable is set to a string, then the message's spam + tag will consist of all the format strings joined together, with the + value of $spam_separator separating them. + + For example, suppose I use DCC, SpamAssassin, and PureMessage. I might + define these spam settings: + + spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1" + spam "X-Spam-Status: Yes" "90+/SA" + spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM" + set spam_separator=", " + + If I then received a message that DCC registered with ``many'' hits + under the ``Fuz2'' checksum, and that PureMessage registered with a + 97% probability of being spam, that message's spam tag would read + 90+/DCC-Fuz2, 97/PM. (The four characters before ``=many'' in a DCC + report indicate the checksum used -- in this case, ``Fuz2''.) + + If the $spam_separator variable is unset, then each spam pattern match + supercedes the previous one. Instead of getting joined format strings, + you'll get only the last one to match. + + The spam tag is what will be displayed in the index when you use %H in + the $index_format variable. It's also the string that the ~H pattern- + matching expression matches against for search and limit functions. + And it's what sorting by spam attribute will use as a sort key. + + That's a pretty complicated example, and most people's actual + environments will have only one spam filter. The simpler your + configuration, the more effective mutt can be, especially when it + comes to sorting. + + Generally, when you sort by spam tag, mutt will sort lexically -- that + is, by ordering strings alphnumerically. However, if a spam tag begins + with a number, mutt will sort numerically first, and lexically only + when two numbers are equal in value. (This is like UNIX's sort -n.) A + message with no spam attributes at all -- that is, one that didn't + match any of your spam patterns -- is sorted at lowest priority. + Numbers are sorted next, beginning with 0 and ranging upward. Finally, + non-numeric strings are sorted, with ``a'' taking lower priority than + ``z''. Clearly, in general, sorting by spam tags is most effective + when you can coerce your filter to give you a raw number. But in case + you can't, mutt can still do something useful. + + The nospam command can be used to write exceptions to spam patterns. + If a header pattern matches something in a spam command, but you + nonetheless do not want it to receive a spam tag, you can list a more + precise pattern under a nospam command. + + If the pattern given to nospam is exactly the same as the pattern on + an existing spam list entry, the effect will be to remove the entry + from the spam list, instead of adding an exception. Likewise, if the + pattern for a spam command matches an entry on the nospam list, that + nospam entry will be removed. If the pattern for nospam is ``*'', all + entries on both lists will be removed. This might be the default + action if you use spam and nospam in conjunction with a folder-hook. + + You can have as many spam or nospam commands as you like. You can + even do your own primitive spam detection within mutt -- for example, + if you consider all mail from MAILER-DAEMON to be spam, you can use a + spam command like this: + + spam "^From: .*MAILER-DAEMON" "999" + + 3.25. Setting variables + + Usage: set [no|inv]variable[=value] [ variable ... ] + Usage: toggle variable [variable ... ] + Usage: unset variable [variable ... ] + Usage: reset variable [variable ... ] This command is used to set (and unset) ``configuration variables''. There are four basic types of variables: boolean, number, string and - quadoption. _b_o_o_l_e_a_n variables can be _s_e_t (true) or _u_n_s_e_t (false). - _n_u_m_b_e_r variables can be assigned a positive integer value. + quadoption. boolean variables can be set (true) or unset (false). + number variables can be assigned a positive integer value. - _s_t_r_i_n_g variables consist of any number of printable characters. - _s_t_r_i_n_g_s must be enclosed in quotes if they contain spaces or tabs. - You may also use the ``C'' escape sequences \\nn and \\tt for newline and + string variables consist of any number of printable characters. + strings must be enclosed in quotes if they contain spaces or tabs. + You may also use the ``C'' escape sequences \n and \t for newline and tab, respectively. - _q_u_a_d_o_p_t_i_o_n variables are used to control whether or not to be prompted - for certain actions, or to specify a default action. A value of _y_e_s + quadoption variables are used to control whether or not to be prompted + for certain actions, or to specify a default action. A value of yes will cause the action to be carried out automatically as if you had - answered yes to the question. Similarly, a value of _n_o will cause the + answered yes to the question. Similarly, a value of no will cause the the action to be carried out as if you had answered ``no.'' A value - of _a_s_k_-_y_e_s will cause a prompt with a default answer of ``yes'' and - _a_s_k_-_n_o will provide a default answer of ``no.'' + of ask-yes will cause a prompt with a default answer of ``yes'' and + ask-no will provide a default answer of ``no.'' Prefixing a variable with ``no'' will unset it. Example: set noaskbcc. - For _b_o_o_l_e_a_n variables, you may optionally prefix the variable name + For boolean variables, you may optionally prefix the variable name with inv to toggle the value (on or off). This is useful when writing macros. Example: set invsmart_wrap. @@ -1883,7 +1995,7 @@ The unset command automatically prepends the no prefix to all specified variables. - Using the enter-command function in the _i_n_d_e_x menu, you can query the + Using the enter-command function in the index menu, you can query the value of a variable by prefixing the name of the variable with a question mark: @@ -1900,9 +2012,9 @@ With the reset command there exists the special variable ``all'', which allows you to reset all variables to their system defaults. - 33..2255.. RReeaaddiinngg iinniittiiaalliizzaattiioonn ccoommmmaannddss ffrroomm aannootthheerr ffiillee + 3.26. Reading initialization commands from another file - Usage: source _f_i_l_e_n_a_m_e + Usage: source filename This command allows the inclusion of initialization commands from other files. For example, I place all of my aliases in @@ -1912,22 +2024,22 @@ If the filename begins with a tilde (``~''), it will be expanded to the path of your home directory. - If the filename ends with a vertical bar (|), then _f_i_l_e_n_a_m_e is + If the filename ends with a vertical bar (|), then filename is considered to be an executable program from which to read input (eg. - source ~bin/myscript|/). + source ~/bin/myscript|). - 33..2266.. RReemmoovviinngg hhooookkss + 3.27. Removing hooks - Usage: unhook [ * | _h_o_o_k_-_t_y_p_e ] + Usage: unhook [ * | hook-type ] This command permits you to flush hooks you have previously defined. You can either remove all hooks by giving the ``*'' character as an argument, or you can remove all hooks of a specific type by saying something like unhook send-hook. - 44.. AAddvvaanncceedd UUssaaggee + 4. Advanced Usage - 44..11.. RReegguullaarr EExxpprreessssiioonnss + 4.1. Regular Expressions All string patterns in Mutt including those in more complex ``patterns'' must be specified using regular expressions (regexp) in @@ -1963,8 +2075,8 @@ A list of characters enclosed by ``['' and ``]'' matches any single character in that list; if the first character of the list is a caret - ``^'' then it matches any character nnoott in the list. For example, the - regular expression [[00112233445566778899]] matches any single digit. A range of + ``^'' then it matches any character not in the list. For example, the + regular expression [0123456789] matches any single digit. A range of ASCII characters may be specified by giving the first and last characters, separated by a hyphen ``-''. Most metacharacters lose their special meaning inside lists. To include a literal ``]'' place @@ -1976,50 +2088,51 @@ consist of ``[:'', a keyword denoting the class, and ``:]''. The following classes are defined by the POSIX standard: - [[::aallnnuumm::]] + [:alnum:] Alphanumeric characters. - [[::aallpphhaa::]] + [:alpha:] Alphabetic characters. - [[::bbllaannkk::]] + [:blank:] Space or tab characters. - [[::ccnnttrrll::]] + [:cntrl:] Control characters. - [[::ddiiggiitt::]] + [:digit:] Numeric characters. - [[::ggrraapphh::]] + + [:graph:] Characters that are both printable and visible. (A space is printable, but not visible, while an ``a'' is both.) - [[::lloowweerr::]] + [:lower:] Lower-case alphabetic characters. - [[::pprriinntt::]] + [:print:] Printable characters (characters that are not control characters.) - [[::ppuunncctt::]] + [:punct:] Punctuation characters (characters that are not letter, digits, control characters, or space characters). - [[::ssppaaccee::]] + [:space:] Space characters (such as space, tab and formfeed, to name a few). - [[::uuppppeerr::]] + [:upper:] Upper-case alphabetic characters. - [[::xxddiiggiitt::]] + [:xdigit:] Characters that are hexadecimal digits. A character class is only valid in a regular expression inside the brackets of a character list. Note that the brackets in these class names are part of the symbolic names, and must be included in addition - to the brackets delimiting the bracket list. For example, [[[[::ddiiggiitt::]]]] - is equivalent to [[00--99]]. + to the brackets delimiting the bracket list. For example, [[:digit:]] + is equivalent to [0-9]. Two additional special sequences can appear in character lists. These apply to non-ASCII character sets, which can have single symbols @@ -2027,41 +2140,41 @@ character, as well as several characters that are equivalent for collating or sorting purposes: - CCoollllaattiinngg SSyymmbboollss + Collating Symbols A collating symbol is a multi-character collating element enclosed in ``[.'' and ``.]''. For example, if ``ch'' is a - collating element, then [[[[..cchh..]]]] is a regexp that matches this - collating element, while [[cchh]] is a regexp that matches either + collating element, then [[.ch.]] is a regexp that matches this + collating element, while [ch] is a regexp that matches either ``c'' or ``h''. - EEqquuiivvaalleennccee CCllaasssseess + Equivalence Classes An equivalence class is a locale-specific name for a list of characters that are equivalent. The name is enclosed in ``[='' and ``=]''. For example, the name ``e'' might be used to - represent all of ``è'' ``é'' and ``e''. In this case, [[[[==ee==]]]] + represent all of ``è'' ``é'' and ``e''. In this case, [[=e=]] is a regexp that matches any of ``è'', ``é'' and ``e''. A regular expression matching a single character may be followed by one of several repetition operators: - ?? The preceding item is optional and matched at most once. + ? The preceding item is optional and matched at most once. - ** The preceding item will be matched zero or more times. + * The preceding item will be matched zero or more times. - ++ The preceding item will be matched one or more times. + + The preceding item will be matched one or more times. - {{nn}} - The preceding item is matched exactly _n times. + {n} + The preceding item is matched exactly n times. - {{nn,,}} - The preceding item is matched _n or more times. + {n,} + The preceding item is matched n or more times. - {{,,mm}} - The preceding item is matched at most _m times. + {,m} + The preceding item is matched at most m times. - {{nn,,mm}} - The preceding item is matched at least _n times, but no more than - _m times. + {n,m} + The preceding item is matched at least n times, but no more than + m times. Two regular expressions may be concatenated; the resulting regular expression matches any string formed by concatenating two substrings @@ -2075,83 +2188,85 @@ precedence over alternation. A whole subexpression may be enclosed in parentheses to override these precedence rules. - NNoottee:: If you compile Mutt with the GNU _r_x package, the following + Note: If you compile Mutt with the GNU rx package, the following operators may also be used in regular expressions: - \\\\yy + \\y Matches the empty string at either the beginning or the end of a word. - \\\\BB + \\B Matches the empty string within a word. - \\\\<< + \\< Matches the empty string at the beginning of a word. - \\\\>> + \\> Matches the empty string at the end of a word. - \\\\ww + \\w Matches any word-constituent character (letter, digit, or underscore). - \\\\WW + \\W Matches any character that is not word-constituent. - \\\\`` + \\` Matches the empty string at the beginning of a buffer (string). - \\\\'' + \\' Matches the empty string at the end of a buffer. Please note however that these operators are not defined by POSIX, so they may or may not be available in stock libraries on various systems. - 44..22.. PPaatttteerrnnss + 4.2. Patterns Many of Mutt's commands allow you to specify a pattern to match (limit, tag-pattern, delete-pattern, etc.). There are several ways to select messages: - ~A all messages - ~b EXPR messages which contain EXPR in the message body - ~B EXPR messages which contain EXPR in the whole message - ~c USER messages carbon-copied to USER - ~C EXPR message is either to: or cc: EXPR - ~D deleted messages - ~d [MIN]-[MAX] messages with ``date-sent'' in a Date range - ~E expired messages - ~e EXPR message which contains EXPR in the ``Sender'' field - ~F flagged messages - ~f USER messages originating from USER - ~g cryptographically signed messages - ~G cryptographically encrypted messages - ~h EXPR messages which contain EXPR in the message header - ~k message contains PGP key material - ~i ID message which match ID in the ``Message-ID'' field - ~L EXPR message is either originated or received by EXPR - ~l message is addressed to a known mailing list - ~m [MIN]-[MAX] message in the range MIN to MAX *) - ~n [MIN]-[MAX] messages with a score in the range MIN to MAX *) - ~N new messages - ~O old messages - ~p message is addressed to you (consults alternates) - ~P message is from you (consults alternates) - ~Q messages which have been replied to - ~R read messages - ~r [MIN]-[MAX] messages with ``date-received'' in a Date range - ~S superseded messages - ~s SUBJECT messages having SUBJECT in the ``Subject'' field. - ~T tagged messages - ~t USER messages addressed to USER - ~U unread messages - ~v message is part of a collapsed thread. - ~V cryptographically verified messages - ~x EXPR messages which contain EXPR in the `References' field - ~y EXPR messages which contain EXPR in the `X-Label' field - ~z [MIN]-[MAX] messages with a size in the range MIN to MAX *) - ~= duplicated messages (see $duplicate_threads) + ~A all messages + ~b EXPR messages which contain EXPR in the message body + ~B EXPR messages which contain EXPR in the whole message + ~c USER messages carbon-copied to USER + ~C EXPR message is either to: or cc: EXPR + ~D deleted messages + ~d [MIN]-[MAX] messages with ``date-sent'' in a Date range + ~E expired messages + ~e EXPR message which contains EXPR in the ``Sender'' field + ~F flagged messages + ~f USER messages originating from USER + ~g cryptographically signed messages + ~G cryptographically encrypted messages + ~H EXPR messages with a spam attribute matching EXPR + ~h EXPR messages which contain EXPR in the message header + ~k message contains PGP key material + ~i ID message which match ID in the ``Message-ID'' field + ~L EXPR message is either originated or received by EXPR + ~l message is addressed to a known mailing list + ~m [MIN]-[MAX] message in the range MIN to MAX *) + ~n [MIN]-[MAX] messages with a score in the range MIN to MAX *) + ~N new messages + ~O old messages + ~p message is addressed to you (consults alternates) + ~P message is from you (consults alternates) + ~Q messages which have been replied to + ~R read messages + ~r [MIN]-[MAX] messages with ``date-received'' in a Date range + ~S superseded messages + ~s SUBJECT messages having SUBJECT in the ``Subject'' field. + ~T tagged messages + ~t USER messages addressed to USER + ~U unread messages + ~v message is part of a collapsed thread. + ~V cryptographically verified messages + ~x EXPR messages which contain EXPR in the `References' field + ~y EXPR messages which contain EXPR in the `X-Label' field + ~z [MIN]-[MAX] messages with a size in the range MIN to MAX *) + ~= duplicated messages (see $duplicate_threads) + ~$ unreferenced messages (requires threaded view) Where EXPR, USER, ID, and SUBJECT are ``regular expressions''. Special attention has to be made when using regular expressions inside @@ -2162,7 +2277,7 @@ *) The forms <[MAX], >[MIN], [MIN]- and -[MAX] are allowed, too. - 44..22..11.. PPaatttteerrnn MMooddiiffiieerr + 4.2.1. Pattern Modifier Note that patterns matching 'lists' of addresses (notably c,C,p,P and t) match if there is at least one match in the whole list. If you want @@ -2172,7 +2287,7 @@ ^~C \.de$ - 44..22..22.. CCoommpplleexx PPaatttteerrnnss + 4.2.2. Complex Patterns Logical AND is performed by specifying more than one criterion. For example: @@ -2180,7 +2295,7 @@ ~t mutt ~f elkins would select messages which contain the word ``mutt'' in the list of - recipients aanndd that have the word ``elkins'' in the ``From'' header + recipients and that have the word ``elkins'' in the ``From'' header field. Mutt also recognizes the following operators to create more complex @@ -2206,32 +2321,33 @@ '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")' Note that if a regular expression contains parenthesis, or a veritical - bar ("|"), you mmuusstt enclose the expression in double or single quotes + bar ("|"), you must enclose the expression in double or single quotes since those characters are also used to separate different parts of Mutt's pattern language. For example, ~f "me@(mutt\.org|cs\.hmc\.edu)" - Without the quotes, the parenthesis would truncate the regular - expression to simply _m_e_@, which is probably not what you want. + Without the quotes, the parenthesis wouldn't end. This would be + seperated to two OR'd patterns: ~f me@(mutt\.org and cs\.hmc\.edu). + They are never what you want. - 44..22..33.. SSeeaarrcchhiinngg bbyy DDaattee + 4.2.3. Searching by Date - Mutt supports two types of dates, _a_b_s_o_l_u_t_e and _r_e_l_a_t_i_v_e. + Mutt supports two types of dates, absolute and relative. - AAbbssoolluuttee. Dates mmuusstt be in DD/MM/YY format (month and year are + Absolute. Dates must be in DD/MM/YY format (month and year are optional, defaulting to the current month and year). An example of a valid range of dates is: Limit to messages matching: ~d 20/1/95-31/10 If you omit the minimum (first) date, and just specify ``-DD/MM/YY'', - all messages _b_e_f_o_r_e the given date will be selected. If you omit the - maximum (second) date, and specify ``DD/MM/YY-'', all messages _a_f_t_e_r + all messages before the given date will be selected. If you omit the + maximum (second) date, and specify ``DD/MM/YY-'', all messages after the given date will be selected. If you specify a single date with no dash (``-''), only messages sent on the given date will be selected. - EErrrroorr MMaarrggiinnss. You can add error margins to absolute dates. An error + Error Margins. You can add error margins to absolute dates. An error margin is a sign (+ or -), followed by a digit, followed by one of the following units: @@ -2246,18 +2362,18 @@ Example: To select any messages two weeks around January 15, 2001, you'd use the following pattern: - Limit to messages matching: ~d 15/1/2001*2w + Limit to messages matching: ~d 15/1/2001*2w - RReellaattiivvee. This type of date is relative to the current date, and may + Relative. This type of date is relative to the current date, and may be specified as: - · >_o_f_f_s_e_t (messages older than _o_f_f_s_e_t units) + · >offset (messages older than offset units) - · <_o_f_f_s_e_t (messages newer than _o_f_f_s_e_t units) + · <offset (messages newer than offset units) - · =_o_f_f_s_e_t (messages exactly _o_f_f_s_e_t units old) + · =offset (messages exactly offset units old) - _o_f_f_s_e_t is specified as a positive number with one of the following + offset is specified as a positive number with one of the following units: y years @@ -2267,14 +2383,14 @@ Example: to select messages less than 1 month old, you would use - Limit to messages matching: ~d <1m + Limit to messages matching: ~d <1m - NNoottee:: all dates used when searching are relative to the llooccaall time + Note: all dates used when searching are relative to the local time zone, so unless you change the setting of your ``$index_format'' to - include a %[...] format, these are nnoott the dates shown in the main + include a %[...] format, these are not the dates shown in the main index. - 44..33.. UUssiinngg TTaaggss + 4.3. Using Tags Sometimes it is desirable to perform an operation on a group of messages all at once rather than one at a time. An example might be @@ -2287,19 +2403,24 @@ Once you have tagged the desired messages, you can use the ``tag- prefix'' operator, which is the ``;'' (semicolon) key by default. - When the ``tag-prefix'' operator is used, the nneexxtt operation will be + When the ``tag-prefix'' operator is used, the next operation will be applied to all tagged messages if that operation can be used in that manner. If the ``$auto_tag'' variable is set, the next operation applies to the tagged messages automatically, without requiring the ``tag-prefix''. - 44..44.. UUssiinngg HHooookkss + In ``macros'' or ``push'' commands, you can use the ``tag-prefix- + cond'' operator. If there are no tagged messages, mutt will "eat" the + rest of the macro to abort it's execution. Mutt will stop "eating" + the macro when it encounters the ``end-cond'' operator; after this + operator the rest of the macro will be executed as normal. + 4.4. Using Hooks - A _h_o_o_k is a concept borrowed from the EMACS editor which allows you to + A hook is a concept borrowed from the EMACS editor which allows you to execute arbitrary commands before performing some operation. For example, you may wish to tailor your configuration based upon which mailbox you are reading, or to whom you are sending mail. In the Mutt - world, a _h_o_o_k consists of a ``regular expression'' or ``pattern'' + world, a hook consists of a ``regular expression'' or ``pattern'' along with a configuration option/command. See · ``folder-hook'' @@ -2316,18 +2437,18 @@ · ``fcc-save-hook'' - for specific details on each type of _h_o_o_k available. + for specific details on each type of hook available. - NNoottee:: if a hook changes configuration settings, these changes remain + Note: if a hook changes configuration settings, these changes remain effective until the end of the current mutt session. As this is generally not desired, a default hook needs to be added before all other hooks to restore configuration defaults. Here is an example with send-hook and the my_hdr directive: send-hook . 'unmy_hdr From:' - send-hook ~Cb@b.b my_hdr from: c@c.c + send-hook ~C'^b@b\.b$' my_hdr from: c@c.c - 44..44..11.. MMeessssaaggee MMaattcchhiinngg iinn HHooookkss + 4.4.1. Message Matching in Hooks Hooks that act upon messages (send-hook, save-hook, fcc-hook, message- hook) are evaluated in a slightly different manner. For the other @@ -2337,7 +2458,7 @@ Mutt allows the use of the ``search pattern'' language for matching messages in hook commands. This works in exactly the same way as it - would when _l_i_m_i_t_i_n_g or _s_e_a_r_c_h_i_n_g the mailbox, except that you are + would when limiting or searching the mailbox, except that you are restricted to those operators which match information mutt extracts from the header of the message (i.e. from, to, cc, date, subject, etc.). @@ -2348,17 +2469,16 @@ send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User ' which would execute the given command when sending mail to - _m_e_@_c_s_._h_m_c_._e_d_u. - + me@cs.hmc.edu. However, it is not required that you write the pattern to match using - the full searching language. You can still specify a simple _r_e_g_u_l_a_r - _e_x_p_r_e_s_s_i_o_n like the other hooks, in which case Mutt will translate + the full searching language. You can still specify a simple regular + expression like the other hooks, in which case Mutt will translate your pattern into the full language, using the translation specified by the ``$default_hook'' variable. The pattern is translated at the time the hook is declared, so the value of ``$default_hook'' that is in effect at that time will be used. - 44..55.. EExxtteerrnnaall AAddddrreessss QQuueerriieess + 4.5. External Address Queries Mutt supports connecting to external directory databases such as LDAP, ph/qi, bbdb, or NIS through a wrapper script which connects to mutt @@ -2376,17 +2496,17 @@ An example multiple response output: - Searching database ... 20 entries ... 3 matching: - me@cs.hmc.edu Michael Elkins mutt dude - blong@fiction.net Brandon Long mutt and more - roessler@guug.de Thomas Roessler mutt pgp + Searching database ... 20 entries ... 3 matching: + me@cs.hmc.edu Michael Elkins mutt dude + blong@fiction.net Brandon Long mutt and more + roessler@guug.de Thomas Roessler mutt pgp There are two mechanisms for accessing the query function of mutt. One is to do a query from the index menu using the query function (default: Q). This will prompt for a query, then bring up the query menu which will list the matching responses. From the query menu, you can select addresses to create aliases, or to mail. You can tag - multiple messages to mail, start a new query, or have a new query + multiple addresses to mail, start a new query, or have a new query appended to the current responses. The other mechanism for accessing the query function is for address @@ -2399,7 +2519,7 @@ will activate the query menu. At the query menu, you can select one or more addresses to be added to the prompt. - 44..66.. MMaaiillbbooxx FFoorrmmaattss + 4.6. Mailbox Formats Mutt supports reading and writing of four different mailbox formats: mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so @@ -2407,7 +2527,7 @@ creating new mailboxes, Mutt uses the default specified with the ``$mbox_type'' variable. - mmbbooxx. This is the most widely used mailbox format for UNIX. All + mbox. This is the most widely used mailbox format for UNIX. All messages are stored in a single file. Each message has a line of the form: @@ -2416,24 +2536,25 @@ to denote the start of a new message (this is often referred to as the ``From_'' line). - MMMMDDFF. This is a variant of the _m_b_o_x format. Each message is + MMDF. This is a variant of the mbox format. Each message is surrounded by lines containing ``^A^A^A^A'' (four control-A's). - MMHH. A radical departure from _m_b_o_x and _M_M_D_F, a mailbox consists of a + MH. A radical departure from mbox and MMDF, a mailbox consists of a directory and each message is stored in a separate file. The filename indicates the message number (however, this is may not correspond to the message number Mutt displays). Deleted messages are renamed with a - comma (,) prepended to the filename. NNoottee:: Mutt detects this type of + comma (,) prepended to the filename. Note: Mutt detects this type of mailbox by looking for either .mh_sequences or .xmhcache (needed to distinguish normal directories from MH mailboxes). - MMaaiillddiirr. The newest of the mailbox formats, used by the Qmail MTA (a - replacement for sendmail). Similar to _M_H, except that it adds three - subdirectories of the mailbox: _t_m_p, _n_e_w and _c_u_r. Filenames for the + Maildir. The newest of the mailbox formats, used by the Qmail MTA (a + replacement for sendmail). Similar to MH, except that it adds three + subdirectories of the mailbox: tmp, new and cur. Filenames for the messages are chosen in such a way they are unique, even when two programs are writing the mailbox over NFS, which means that no file locking is needed. - 44..77.. MMaaiillbbooxx SShhoorrttccuuttss + + 4.7. Mailbox Shortcuts There are a number of built in shortcuts which refer to specific mailboxes. These shortcuts can be used anywhere you are prompted for @@ -2451,10 +2572,10 @@ · = or + -- refers to your ``$folder'' directory - · @_a_l_i_a_s -- refers to the ``default save folder'' as determined by + · @alias -- refers to the ``default save folder'' as determined by the address of the alias - 44..88.. HHaannddlliinngg MMaaiilliinngg LLiissttss + 4.8. Handling Mailing Lists Mutt has a few configuration options that make dealing with large amounts of mail easier. The first thing you must do is to let Mutt @@ -2467,7 +2588,7 @@ Now that Mutt knows what your mailing lists are, it can do several things, the first of which is the ability to show the name of a list through which you received a message (i.e., of a subscribed list) in - the _i_n_d_e_x menu display. This is useful to distinguish between + the index menu display. This is useful to distinguish between personal and list mail in the same mailbox. In the ``$index_format'' variable, the escape ``%L'' will return the string ``To '' when ``list'' appears in the ``To'' field, and ``Cc '' when it @@ -2478,7 +2599,7 @@ to get quite large. Most people do not bother to remove the author of the message they are reply to from the list, resulting in two or more copies being sent to that person. The ``list-reply'' function, which - by default is bound to ``L'' in the _i_n_d_e_x menu and _p_a_g_e_r, helps reduce + by default is bound to ``L'' in the index menu and pager, helps reduce the clutter by only replying to the known mailing list addresses instead of all recipients (except as specified by Mail-Followup-To, see below). @@ -2510,17 +2631,18 @@ trying to reply directly to the author in private, since most mail clients will automatically reply to the address given in the ``Reply- To'' field. Mutt uses the ``$reply_to'' variable to help decide which - address to use. If set, you will be prompted as to whether or not you - would like to use the address given in the ``Reply-To'' field, or - reply directly to the address given in the ``From'' field. When - unset, the ``Reply-To'' field will be used when present. + address to use. If set to ask-yes or ask-no, you will be prompted as + to whether or not you would like to use the address given in the + ``Reply-To'' field, or reply directly to the address given in the + ``From'' field. When set to yes, the ``Reply-To'' field will be used + when present. The ``X-Label:'' header field can be used to further identify mailing lists or list subject matter (or just to annotate messages individually). The ``$index_format'' variable's ``%y'' and ``%Y'' escapes can be used to expand ``X-Label:'' fields in the index, and Mutt's pattern-matcher can match regular expressions to ``X-Label:'' - fields with the `` y'' selector. ``X-Label:'' is not a standard + fields with the ``y'' selector. ``X-Label:'' is not a standard message header field, but it can easily be inserted by procmail and other mail filtering agents. @@ -2532,7 +2654,7 @@ dealing with large volume mailing lists easier because you can easily delete uninteresting threads and quickly find topics of value. - 44..99.. DDeelliivveerryy SSttaattuuss NNoottiiffiiccaattiioonn ((DDSSNN)) SSuuppppoorrtt + 4.9. Delivery Status Notification (DSN) Support RFC1894 defines a set of MIME content types for relaying information about the status of electronic mail messages. These can be thought of @@ -2546,10 +2668,10 @@ message should be returned with the receipt (headers or full message). Refer to the man page on sendmail for more details on DSN. - 44..1100.. PPOOPP33 SSuuppppoorrtt ((OOPPTTIIOONNAALL)) + 4.10. POP3 Support (OPTIONAL) - If Mutt was compiled with POP3 support (by running the _c_o_n_f_i_g_u_r_e - script with the _-_-_e_n_a_b_l_e_-_p_o_p flag), it has the ability to work with + If Mutt was compiled with POP3 support (by running the configure + script with the --enable-pop flag), it has the ability to work with mailboxes located on a remote POP3 server and fetch mail for local browsing. @@ -2558,6 +2680,7 @@ You can select an alternative port by specifying it with the server, ie: pop://popserver:port/. + You can also specify different username for each folder, ie: pop://username@popserver[:port]/. @@ -2566,24 +2689,24 @@ can be controlled by the ``$pop_checkinterval'' variable, which defaults to every 60 seconds. - If Mutt was compiled with SSL support (by running the _c_o_n_f_i_g_u_r_e script - with the _-_-_w_i_t_h_-_s_s_l flag), connections to POP3 servers can be + If Mutt was compiled with SSL support (by running the configure script + with the --with-ssl flag), connections to POP3 servers can be encrypted. This naturally requires that the server supports SSL encrypted connections. To access a folder with POP3/SSL, you should use pops: prefix, ie: pops://[username@]popserver[:port]/. - Another way to access your POP3 mail is the _f_e_t_c_h_-_m_a_i_l function + Another way to access your POP3 mail is the fetch-mail function (default: G). It allows to connect to ``pop_host'', fetch all your new mail and place it in the local ``spoolfile''. After this point, Mutt runs exactly as if the mail had always been local. - NNoottee:: If you only need to fetch all messages to local mailbox you + Note: If you only need to fetch all messages to local mailbox you should consider using a specialized program, such as fetchmail - 44..1111.. IIMMAAPP SSuuppppoorrtt ((OOPPTTIIOONNAALL)) + 4.11. IMAP Support (OPTIONAL) - If Mutt was compiled with IMAP support (by running the _c_o_n_f_i_g_u_r_e - script with the _-_-_e_n_a_b_l_e_-_i_m_a_p flag), it has the ability to work with + If Mutt was compiled with IMAP support (by running the configure + script with the --enable-imap flag), it has the ability to work with folders located on a remote IMAP server. You can access the remote inbox by selecting the folder @@ -2599,8 +2722,8 @@ You can also specify different username for each folder, ie: imap://username@imapserver[:port]/INBOX. - If Mutt was compiled with SSL support (by running the _c_o_n_f_i_g_u_r_e script - with the _-_-_w_i_t_h_-_s_s_l flag), connections to IMAP servers can be + If Mutt was compiled with SSL support (by running the configure script + with the --with-ssl flag), connections to IMAP servers can be encrypted. This naturally requires that the server supports SSL encrypted connections. To access a folder with IMAP/SSL, you should use imaps://[username@]imapserver[:port]/path/to/folder as your folder @@ -2615,15 +2738,15 @@ When browsing folders on an IMAP server, you can toggle whether to look at only the folders you are subscribed to, or all folders with - the _t_o_g_g_l_e_-_s_u_b_s_c_r_i_b_e_d command. See also the ``$imap_list_subscribed'' + the toggle-subscribed command. See also the ``$imap_list_subscribed'' variable. Polling for new mail on an IMAP server can cause noticeable delays. So, you'll want to carefully tune the ``$mail_check'' and ``$timeout'' variables. Personally I use - set mail_check=90 - set timeout=15 + set mail_check=90 + set timeout=15 with relatively good results over my slow modem line. @@ -2631,7 +2754,7 @@ to v12.250, the server has been reported to disconnect a client if another client selects the same folder. - 44..1111..11.. TThhee FFoollddeerr BBrroowwsseerr + 4.11.1. The Folder Browser As of version 1.2, mutt supports browsing mailboxes on an IMAP server. This is mostly the same as the local file browser, with the following @@ -2652,7 +2775,7 @@ d by default. You may also subscribe and unsubscribe to mailboxes (normally these are bound to s and u, respectively). - 44..1111..22.. AAuutthheennttiiccaattiioonn + 4.11.2. Authentication Mutt supports four authentication methods with IMAP servers: SASL, GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add @@ -2669,7 +2792,7 @@ entire session will be encrypted and invisible to those teeming network snoops. It is the best option if you have it. To use it, you must have the Cyrus SASL library installed on your system and compile - mutt with the _-_-_w_i_t_h_-_s_a_s_l flag. + mutt with the --with-sasl flag. Mutt will try whichever methods are compiled in and available on the server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, @@ -2681,6 +2804,7 @@ authentication on the IMAP server, for all authenticators. This is overridden by an explicit username in the mailbox path (ie by using a mailbox name of the form {user@host}). + · ``$imap_pass'' - a password which you may preset, used by all authentication methods where a password is needed. @@ -2689,7 +2813,7 @@ If specified, this overrides mutt's default (attempt everything, in the order listed above). - 44..1122.. MMaannaaggiinngg mmuullttiippllee IIMMAAPP//PPOOPP aaccccoouunnttss ((OOPPTTIIOONNAALL)) + 4.12. Managing multiple IMAP/POP accounts (OPTIONAL) If you happen to have accounts on multiple IMAP and/or POP servers, you may find managing all the authentication settings inconvenient and @@ -2700,14 +2824,14 @@ Some examples: - account-hook . 'unset imap_user; unset imap_pass; unset tunnel' - account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo' - account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"' + account-hook . 'unset imap_user; unset imap_pass; unset tunnel' + account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo' + account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"' - 44..1133.. SSttaarrtt aa WWWWWW BBrroowwsseerr oonn UURRLLss ((EEXXTTEERRNNAALL)) + 4.13. Start a WWW Browser on URLs (EXTERNAL) - If a message contains URLs (_u_n_i_f_i_e_d _r_e_s_s_o_u_r_c_e _l_o_c_a_t_o_r = address in the - WWW space like _h_t_t_p_:_/_/_w_w_w_._m_u_t_t_._o_r_g_/), it is efficient to get a menu + If a message contains URLs (unified resource locator = address in the + WWW space like http://www.mutt.org/), it is efficient to get a menu with all the URLs and start a WWW browser on one of them. This functionality is provided by the external urlview program which can be retrieved at ftp://ftp.mutt.org/mutt/contrib/ and the configuration @@ -2716,7 +2840,7 @@ macro index \cb |urlview\n macro pager \cb |urlview\n - 55.. MMuutttt''ss MMIIMMEE SSuuppppoorrtt + 5. Mutt's MIME Support Quite a bit of effort has been made to make Mutt the premier text-mode MIME MUA. Every effort has been made to provide the functionality @@ -2727,13 +2851,13 @@ IANA MIME types. The other is the mailcap file, which specifies the external commands to use for handling specific MIME types. - 55..11.. UUssiinngg MMIIMMEE iinn MMuutttt + 5.1. Using MIME in Mutt There are three areas/menus in Mutt which deal with MIME, they are the pager (while viewing a message), the attachment menu and the compose menu. - 55..11..11.. VViieewwiinngg MMIIMMEE mmeessssaaggeess iinn tthhee ppaaggeerr + 5.1.1. Viewing MIME messages in the pager When you select a message from the index and view it in the pager, Mutt decodes the message to a text representation. Mutt internally @@ -2749,14 +2873,13 @@ [-- Type: text/plain, Encoding: 7bit, Size: 10000 --] Where the Description is the description or filename given for the - attachment, and the Encoding is one of 7bit/8bit/quoted-print­ + attachment, and the Encoding is one of 7bit/8bit/quoted-print- able/base64/binary. - If Mutt cannot deal with a MIME type, it will display a message like: [-- image/gif is unsupported (use 'v' to view this part) --] - 55..11..22.. TThhee AAttttaacchhmmeenntt MMeennuu + 5.1.2. The Attachment Menu The default binding for view-attachments is `v', which displays the attachment menu for a message. The attachment menu displays a list of @@ -2775,7 +2898,7 @@ See the help on the attachment menu for more information. - 55..11..33.. TThhee CCoommppoossee MMeennuu + 5.1.3. The Compose Menu The compose menu is the menu you see before you send a message. It allows you to edit the recipient list, the subject, and other aspects @@ -2803,7 +2926,7 @@ description of the attachment, and can be changed with the edit- description command (default: d). - 55..22.. MMIIMMEE TTyyppee ccoonnffiigguurraattiioonn wwiitthh mmiimmee..ttyyppeess + 5.2. MIME Type configuration with mime.types When you add an attachment to your mail message, Mutt searches your personal mime.types file at ${HOME}/.mime.types, and then the system @@ -2836,7 +2959,7 @@ mime types should only be used if the recipient of the message is likely to be expecting such attachments. - 55..33.. MMIIMMEE VViieewweerr ccoonnffiigguurraattiioonn wwiitthh mmaaiillccaapp + 5.3. MIME Viewer configuration with mailcap Mutt supports RFC 1524 MIME Configuration, in particular the Unix specific format specified in Appendix A of RFC 1524. This file format @@ -2858,14 +2981,13 @@ usually as /usr/local/etc/mailcap, which contains some baseline entries. - 55..33..11.. TThhee BBaassiiccss ooff tthhee mmaaiillccaapp ffiillee + 5.3.1. The Basics of the mailcap file A mailcap file consists of a series of lines which are comments, blank, or definitions. A comment line consists of a # character followed by anything you want. - A blank line is blank. A definition line consists of a content type, a view command, and any @@ -2904,10 +3026,10 @@ text/html; lynx %s In this case, lynx does not support viewing a file from stdin, so you - must use the %s syntax. NNoottee:: _S_o_m_e _o_l_d_e_r _v_e_r_s_i_o_n_s _o_f _l_y_n_x _c_o_n_t_a_i_n _a - _b_u_g _w_h_e_r_e _t_h_e_y _w_i_l_l _c_h_e_c_k _t_h_e _m_a_i_l_c_a_p _f_i_l_e _f_o_r _a _v_i_e_w_e_r _f_o_r _t_e_x_t_/_h_t_m_l_. - _T_h_e_y _w_i_l_l _f_i_n_d _t_h_e _l_i_n_e _w_h_i_c_h _c_a_l_l_s _l_y_n_x_, _a_n_d _r_u_n _i_t_. _T_h_i_s _c_a_u_s_e_s - _l_y_n_x _t_o _c_o_n_t_i_n_u_o_u_s_l_y _s_p_a_w_n _i_t_s_e_l_f _t_o _v_i_e_w _t_h_e _o_b_j_e_c_t_. + must use the %s syntax. Note: Some older versions of lynx contain a + bug where they will check the mailcap file for a viewer for text/html. + They will find the line which calls lynx, and run it. This causes + lynx to continuously spawn itself to view the object. On the other hand, maybe you don't want to use lynx interactively, you just want to have it convert the text/html to text/plain, then you can @@ -2923,7 +3045,7 @@ This is the simplest form of a mailcap file. - 55..33..22.. SSeeccuurree uussee ooff mmaaiillccaapp + 5.3.2. Secure use of mailcap The interpretion of shell meta-characters embedded in MIME parameters can lead to security problems in general. Mutt tries to quote @@ -2936,7 +3058,7 @@ care of it. Therefore you should pay attention to the following rules: - _K_e_e_p _t_h_e _%_-_e_x_p_a_n_d_o_s _a_w_a_y _f_r_o_m _s_h_e_l_l _q_u_o_t_i_n_g_. Don't quote them with + Keep the %-expandos away from shell quoting. Don't quote them with single or double quotes. Mutt does this for you, the right way, as should any other program which interprets mailcap. Don't put them into backtick expansions. Be highly careful with eval statements, and @@ -2953,15 +3075,15 @@ text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \ && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1 - 55..33..33.. AAddvvaanncceedd mmaaiillccaapp UUssaaggee + 5.3.3. Advanced mailcap Usage - 55..33..33..11.. OOppttiioonnaall FFiieellddss + 5.3.3.1. Optional Fields In addition to the required content-type and view command fields, you can add semi-colon ';' separated fields to set flags and other options. Mutt recognizes the following optional fields: - ccooppiioouussoouuttppuutt + copiousoutput This flag tells Mutt that the command passes possibly large amounts of text on stdout. This causes Mutt to invoke a pager (either the internal pager or the external pager defined by the @@ -2975,22 +3097,22 @@ This will cause lynx to format the text/html output as text/plain and Mutt will use your standard pager to display the results. - nneeeeddsstteerrmmiinnaall + needsterminal Mutt uses this flag when viewing attachments with ``autoview'', in order to decide whether it should honor the setting of the ``$wait_key'' variable or not. When an attachment is viewed using an interactive program, and the corresponding mailcap - entry has a _n_e_e_d_s_t_e_r_m_i_n_a_l flag, Mutt will use ``$wait_key'' and + entry has a needsterminal flag, Mutt will use ``$wait_key'' and the exit status of the program to decide if it will ask you to press a key after the external program has exited. In all other situations it will not prompt you for a key. - ccoommppoossee==<> + compose= This flag specifies the command to use to create a new attachment of a specific MIME type. Mutt supports this from the compose menu. - ccoommppoosseettyyppeedd==<> + composetyped= This flag specifies the command to use to create a new attachment of a specific MIME type. This command differs from the compose command in that mutt will expect standard MIME @@ -2998,17 +3120,17 @@ filename, description, etc. for a new attachment. Mutt supports this from the compose menu. - pprriinntt==<> + print= This flag specifies the command to use to print a specific MIME type. Mutt supports this from the attachment and compose menus. - eeddiitt==<> + edit= This flag specifies the command to use to edit a specific MIME type. Mutt supports this from the compose menu, and also uses it to compose new attachments. Mutt will default to the defined editor for text attachments. - nnaammeetteemmppllaattee==<> + nametemplate=