X-Git-Url: http://git.madism.org/?a=blobdiff_plain;f=doc%2Fmanual.txt;h=4b3d0f10d79dfdfcf7fd24768095c63eff5aae33;hb=d6988dab6bd378ccdf0f17aaa16de8aee1ceaf43;hp=99c7317cc08c2ac7b51aa2e7ab401a3c105c0103;hpb=b0811fbd6a0e218c9c310a6ef4170e81540e6c22;p=apps%2Fmadmutt.git diff --git a/doc/manual.txt b/doc/manual.txt index 99c7317..4b3d0f1 100644 --- a/doc/manual.txt +++ b/doc/manual.txt @@ -8,7 +8,7 @@ - version devel-r473 + version devel-r522 Abstract @@ -37,6 +37,8 @@ 7. Copyright + 8. Manual Conventions + 2. Getting Started 1. Basic Concepts @@ -346,41 +348,67 @@ 5.11. editor - 8. Miscellany + 5.12. sidebar + + A. Acknowledgments - 1. Acknowledgments + B. Hacking Documentation + + Index List of Tables - 2.1. Default Menu Movement Keys + 2.1. Most commonly used movement bindings - 2.2. Built-In Editor Functions + 2.2. Line Editor Functions - 2.3. Default Index Menu Bindings + 2.3. Most commonly used Index Bindings - 2.4. Default Pager Menu Bindings + 2.4. Most commonly used Pager Bindings 2.5. ANSI Escape Sequences 2.6. ANSI Colors - 2.7. Default Thread Function Bindings + 2.7. Most commonly used thread-related bindings - 2.8. Default Mail Composition Bindings + 2.8. Most commonly used Mail Composition Bindings - 2.9. Default Compose Menu Bindings + 2.9. Most commonly used Compose Menu Bindings 2.10. PGP Key Menu Flags 3.1. Alternative Key Names - 4.1. Default Sidebar Function Bindings + 7.1. Reference: Command Line Options + + 7.2. Reference: Patterns + + 7.3. Reference: Obsolete Variables + + 7.4. Reference: Default Generic Function Bindings + + 7.5. Reference: Default Index Function Bindings + + 7.6. Reference: Default Pager Function Bindings - 7.1. Mutt-NG Command Line Options + 7.7. Reference: Default Alias Menu Function Bindings - 7.2. Patterns + 7.8. Reference: Default Query Menu Function Bindings - 7.3. Obsolete Variables + 7.9. Reference: Default Attachment Menu Function Bindings + + 7.10. Reference: Default Compose Menu Function Bindings + + 7.11. Reference: Default Postpone Menu Function Bindings + + 7.12. Reference: Default Browser Menu Function Bindings + + 7.13. Reference: Default PGP Menu Function Bindings + + 7.14. Reference: Default Editor Function Bindings + + 7.15. Referene: Default Sidebar Function Bindings Chapter 1. Introduction @@ -400,6 +428,8 @@ Chapter 1. Introduction 7. Copyright + 8. Manual Conventions + 1. Overview Mutt-ng is a small but very powerful text-based MIME mail client. Mutt-ng @@ -418,7 +448,7 @@ Chapter 1. Introduction 2. Mutt-ng Home Page - http://www.muttng.org + 3. Mailing Lists @@ -431,7 +461,7 @@ Chapter 1. Introduction 4. Software Distribution Sites So far, there are no official releases of Mutt-ng, but you can download - daily snapshots from http://mutt-ng.berlios.de/snapshots/ + daily snapshots from 5. IRC @@ -464,6 +494,33 @@ Chapter 1. Introduction with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. +8. Manual Conventions + + This manual contains several (hopefully consistent) conventions to + specially layout different items in different fashions. + + o Configuration and environment variables will be printed in a + typewriter font and both prefixed with a dollar sign as it's common + for UNIX-like environments. Configuration variables are lower-case + only while environment variables are upper-case only. $imap_mail_check + is a configuration variable while $EDITOR is an environment variable. + + o Muttng-specific functions are enclosed in <> and printed in a + typewriter font, too, as in . + + o As common for UNIX-like environments, references to manual pages are + printed with the section enclosed in braces, as in vi(1) or + muttngrc(5). Execute man [section] [name] to view the manual page. + + o Keys are presented in the following way: ordinary keys are just given + as-is, e.g. q. Control characters are prefixed with C- (e.g. the + screen can be redraw by pressing C-L) and E- for Escape, e.g. a folder + can be opened read-only with E-c. + + If, while reading this fine manual, you find any inconsistencies of + whatever kind, please contact the developers via + to report it. + Chapter 2. Getting Started Table of Contents @@ -725,28 +782,17 @@ Chapter 2. Getting Started Information is presented in menus, very similar to ELM. Here is a tableshowing the common keys used to navigate menus in Mutt-ng. - Table 2.1. Default Menu Movement Keys - - +------------------------------------------------------------------------+ - | Key | Function | Description | - |-------------+----------------+-----------------------------------------| - | j or Down | next-entry | move to the next entry | - |-------------+----------------+-----------------------------------------| - | k or Up | previous-entry | move to the previous entry | - |-------------+----------------+-----------------------------------------| - | z or PageDn | page-down | go to the next page | - |-------------+----------------+-----------------------------------------| - | Z or PageUp | page-up | go to the previous page | - |-------------+----------------+-----------------------------------------| - | = or Home | first-entry | jump to the first entry | - |-------------+----------------+-----------------------------------------| - | * or End | last-entry | jump to the last entry | - |-------------+----------------+-----------------------------------------| - | q | quit | exit the current menu | - |-------------+----------------+-----------------------------------------| - | ? | help | list all key bindings for the current | - | | | menu | - +------------------------------------------------------------------------+ + Table 2.1. Most commonly used movement bindings + + Key Function Description + j or Down move to the next entry + k or Up move to the previous entry + z or PageDn go to the next page + Z or PageUp go to the previous page + = or Home jump to the first entry + * or End jump to the last entry + q exit the current menu + ? list all key bindings for the current menu 4. Editing Input Fields @@ -754,57 +800,31 @@ Chapter 2. Getting Started input textual data such as email addresses or filenames. The keys used to move around while editing are very similar to those of Emacs. - Table 2.2. Built-In Editor Functions - - +------------------------------------------------------------------------+ - | Key | Function | Description | - |----------------+-----------------+-------------------------------------| - | ^A or | bol | move to the start of the line | - |----------------+-----------------+-------------------------------------| - | ^B or | backward-char | move back one char | - |----------------+-----------------+-------------------------------------| - | Esc B | backward-word | move back one word | - |----------------+-----------------+-------------------------------------| - | ^D or | delete-char | delete the char under the cursor | - |----------------+-----------------+-------------------------------------| - | ^E or | eol | move to the end of the line | - |----------------+-----------------+-------------------------------------| - | ^F or | forward-char | move forward one char | - |----------------+-----------------+-------------------------------------| - | Esc F | forward-word | move forward one word | - |----------------+-----------------+-------------------------------------| - | | complete | complete filename or alias | - |----------------+-----------------+-------------------------------------| - | ^T | complete-query | complete address with query | - |----------------+-----------------+-------------------------------------| - | ^K | kill-eol | delete to the end of the line | - |----------------+-----------------+-------------------------------------| - | ESC d | kill-eow | delete to the end of the word | - |----------------+-----------------+-------------------------------------| - | ^W | kill-word | kill the word in front of the | - | | | cursor | - |----------------+-----------------+-------------------------------------| - | ^U | kill-line | delete entire line | - |----------------+-----------------+-------------------------------------| - | ^V | quote-char | quote the next typed key | - |----------------+-----------------+-------------------------------------| - | | history-up | recall previous string from history | - |----------------+-----------------+-------------------------------------| - | | history-down | recall next string from history | - |----------------+-----------------+-------------------------------------| - | | backspace | kill the char in front of the | - | | | cursor | - |----------------+-----------------+-------------------------------------| - | Esc u | upcase-word | convert word to upper case | - |----------------+-----------------+-------------------------------------| - | Esc l | downcase-word | convert word to lower case | - |----------------+-----------------+-------------------------------------| - | Esc c | capitalize-word | capitalize the word | - |----------------+-----------------+-------------------------------------| - | ^G | n/a | abort | - |----------------+-----------------+-------------------------------------| - | | n/a | finish editing | - +------------------------------------------------------------------------+ + Table 2.2. Line Editor Functions + + Key Function Description + C-A or Home move to the start of the line + C-B or Left move back one char + E-B move back one word + C-D or Delete delete the char under the cursor + C-E or End move to the end of the line + C-F or Right move forward one char + E-F move forward one word + Tab complete filename or alias + C-T complete address with query + C-K delete to the end of the line + E-d delete to the end of the word + C-W kill the word in front of the cursor + C-U delete entire line + C-V quote the next typed key + Up recall previous string from history + Down recall next string from history + BackSpace kill the char in front of the cursor + E-u convert word to upper case + E-l convert word to lower case + E-c capitalize the word + C-G abort + Return finish editing You can remap the editor functions using the bind command. For example, to make the Delete key delete the character in front of the cursor rather @@ -824,69 +844,38 @@ Chapter 2. Getting Started 5.1. The Message Index - Table 2.3. Default Index Menu Bindings - - +-------------------------------------------------------------------+ - | Key | Function | Description | - |----------+----------+---------------------------------------------| - | c | | change to a different mailbox | - |----------+----------+---------------------------------------------| - | ESC c | | change to a folder in read-only mode | - |----------+----------+---------------------------------------------| - | C | | copy the current message to another mailbox | - |----------+----------+---------------------------------------------| - | ESC C | | decode a message and copy it to a folder | - |----------+----------+---------------------------------------------| - | ESC s | | decode a message and save it to a folder | - |----------+----------+---------------------------------------------| - | D | | delete messages matching a pattern | - |----------+----------+---------------------------------------------| - | d | | delete the current message | - |----------+----------+---------------------------------------------| - | F | | mark as important | - |----------+----------+---------------------------------------------| - | l | | show messages matching a pattern | - |----------+----------+---------------------------------------------| - | N | | mark message as new | - |----------+----------+---------------------------------------------| - | o | | change the current sort method | - |----------+----------+---------------------------------------------| - | O | | reverse sort the mailbox | - |----------+----------+---------------------------------------------| - | q | | save changes and exit | - |----------+----------+---------------------------------------------| - | s | | save-message | - |----------+----------+---------------------------------------------| - | T | | tag messages matching a pattern | - |----------+----------+---------------------------------------------| - | t | | toggle the tag on a message | - |----------+----------+---------------------------------------------| - | ESC t | | toggle tag on entire message thread | - |----------+----------+---------------------------------------------| - | U | | undelete messages matching a pattern | - |----------+----------+---------------------------------------------| - | u | | undelete-message | - |----------+----------+---------------------------------------------| - | v | | view-attachments | - |----------+----------+---------------------------------------------| - | x | | abort changes and exit | - |----------+----------+---------------------------------------------| - | | | display-message | - |----------+----------+---------------------------------------------| - | | | jump to the next new or unread message | - |----------+----------+---------------------------------------------| - | @ | | show the author's full e-mail address | - |----------+----------+---------------------------------------------| - | $ | | save changes to mailbox | - |----------+----------+---------------------------------------------| - | / | | search | - |----------+----------+---------------------------------------------| - | ESC / | | search-reverse | - |----------+----------+---------------------------------------------| - | ^L | | clear and redraw the screen | - |----------+----------+---------------------------------------------| - | ^T | | untag messages matching a pattern | - +-------------------------------------------------------------------+ + Table 2.3. Most commonly used Index Bindings + + Key Function Description + c change to a different mailbox + E-c change to a folder in read-only mode + C copy the current message to another mailbox + E-C decode a message and copy it to a folder + E-s decode a message and save it to a folder + D delete messages matching a pattern + d delete the current message + F mark as important + l show messages matching a pattern + N mark message as new + o change the current sort method + O reverse sort the mailbox + q save changes and exit + s save-message + T tag messages matching a pattern + t toggle the tag on a message + E-t toggle tag on entire message thread + U undelete messages matching a pattern + u undelete-message + v view-attachments + x abort changes and exit + Return display-message + Tab jump to the next new or unread message + @ show the author's full e-mail address + $ save changes to mailbox + / search + E-/ search-reverse + C-L clear and redraw the screen + C-T untag messages matching a pattern 5.1.1. Status Flags @@ -973,34 +962,21 @@ Chapter 2. Getting Started messages. The pager is very similar to the Unix program less though not nearly as featureful. - Table 2.4. Default Pager Menu Bindings - - +------------------------------------------------------------------------+ - | Key | Function | Description | - |----------+----------+--------------------------------------------------| - | | | go down one line | - |----------+----------+--------------------------------------------------| - | | | display the next page (or next message if at the | - | | | end of a message) | - |----------+----------+--------------------------------------------------| - | - | | go back to the previous page | - |----------+----------+--------------------------------------------------| - | n | | search for next match | - |----------+----------+--------------------------------------------------| - | S | | skip beyond quoted text | - |----------+----------+--------------------------------------------------| - | T | | toggle display of quoted text | - |----------+----------+--------------------------------------------------| - | ? | | show key bindings | - |----------+----------+--------------------------------------------------| - | / | | search for a regular expression (pattern) | - |----------+----------+--------------------------------------------------| - | ESC / | | search backwards for a regular expression | - |----------+----------+--------------------------------------------------| - | \ | | toggle search pattern coloring | - |----------+----------+--------------------------------------------------| - | ^ | | jump to the top of the message | - +------------------------------------------------------------------------+ + Table 2.4. Most commonly used Pager Bindings + + Key Function Description + Return go down one line + Space display the next page (or next message if at the end of a + message) + - go back to the previous page + n search for next match + S skip beyond quoted text + T toggle display of quoted text + ? show key bindings + / search for a regular expression (pattern) + E-/ search backwards for a regular expression + \ toggle search pattern coloring + ^ jump to the top of the message 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 @@ -1009,8 +985,8 @@ Chapter 2. Getting Started Also, the internal pager supports a couple other advanced features. For one, it will accept and translate the ``standard'' nroff sequences forbold and underline. These sequences are a series of either the letter, - backspace (^H), the letter again for bold or the letter, backspace, ``_'' - for denoting underline. Mutt-ng will attempt to display these in bold and + backspace (C-H), the letter again for bold or the letter, backspace, _ for + denoting underline. Mutt-ng will attempt to display these in bold and underline respectively if your terminal supports them. If not, you can use the bold and underline color objects to specify a color or mono attribute for them. @@ -1022,48 +998,29 @@ Chapter 2. Getting Started Table 2.5. ANSI Escape Sequences - +-------------------------------------------------+ - | Value | Attribute | - |-------+-----------------------------------------| - | 0 | All Attributes Off | - |-------+-----------------------------------------| - | 1 | Bold on | - |-------+-----------------------------------------| - | 4 | Underline on | - |-------+-----------------------------------------| - | 5 | Blink on | - |-------+-----------------------------------------| - | 7 | Reverse video on | - |-------+-----------------------------------------| - | 3x | Foreground color is x (see table below) | - |-------+-----------------------------------------| - | 4x | Background color is x (see table below) | - +-------------------------------------------------+ + Value Attribute + 0 All Attributes Off + 1 Bold on + 4 Underline on + 5 Blink on + 7 Reverse video on + 3x Foreground color is x (see table below) + 4x Background color is x (see table below) Table 2.6. ANSI Colors - +------------------+ - | Number | Color | - |--------+---------| - | 0 | black | - |--------+---------| - | 1 | red | - |--------+---------| - | 2 | green | - |--------+---------| - | 3 | yellow | - |--------+---------| - | 4 | blue | - |--------+---------| - | 5 | magenta | - |--------+---------| - | 6 | cyan | - |--------+---------| - | 7 | white | - +------------------+ + Number Color + 0 black + 1 red + 2 green + 3 yellow + 4 blue + 5 magenta + 6 cyan + 7 white Mutt-ng uses these attributes for handling text/enriched messages, and - they can also be used by an external autoview script for highlighting + they can also be used by an external auto_view script for highlighting purposes. Note: If you change the colors for your display, for example by changing the color associated with color2 for your xterm, then that color will be used instead of green. @@ -1073,84 +1030,66 @@ Chapter 2. Getting Started When the mailbox is sorted by threads ,there are a few additional functions available in the index and pager modes. - Table 2.7. Default Thread Function Bindings - - +------------------------------------------------------------------------+ - | Key | Function | Description | - |-------+--------------------+-------------------------------------------| - | ^D | delete-thread | delete all messages in the current thread | - |-------+--------------------+-------------------------------------------| - | ^U | undelete-thread | undelete all messages in the current | - | | | thread | - |-------+--------------------+-------------------------------------------| - | ^N | next-thread | jump to the start of the next thread | - |-------+--------------------+-------------------------------------------| - | ^P | previous-thread | jump to the start of the previous thread | - |-------+--------------------+-------------------------------------------| - | ^R | read-thread | mark the current thread as read | - |-------+--------------------+-------------------------------------------| - | ESC d | delete-subthread | delete all messages in the current | - | | | subthread | - |-------+--------------------+-------------------------------------------| - | ESC u | undelete-subthread | undelete all messages in the current | - | | | subthread | - |-------+--------------------+-------------------------------------------| - | ESC n | next-subthread | jump to the start of the next subthread | - |-------+--------------------+-------------------------------------------| - | ESC p | previous-subthread | jump to the start of the previous | - | | | subthread | - |-------+--------------------+-------------------------------------------| - | ESC r | read-subthread | mark the current subthread as read | - |-------+--------------------+-------------------------------------------| - | ESC t | tag-thread | toggle the tag on the current thread | - |-------+--------------------+-------------------------------------------| - | ESC v | collapse-thread | toggle collapse for the current thread | - |-------+--------------------+-------------------------------------------| - | ESC V | collapse-all | toggle collapse for all threads | - |-------+--------------------+-------------------------------------------| - | P | parent-message | jump to parent message in thread | - +------------------------------------------------------------------------+ + Table 2.7. Most commonly used thread-related bindings + + Key Function Description + C-D delete all messages in the current thread + C-U undelete all messages in the current thread + C-N jump to the start of the next thread + C-P jump to the start of the previous thread + C-R mark the current thread as read + E-d delete all messages in the current subthread + E-u undelete all messages in the current subthread + E-n jump to the start of the next subthread + E-p jump to the start of the previous subthread + E-r mark the current subthread as read + E-t toggle the tag on the current thread + E-v toggle collapse for the current thread + E-V toggle collapse for all threads + P jump to parent message in thread Note: Collapsing a thread displays only the first message in the thread and hides the others. This is useful when threads contain so many messages that you can only see a handful of threads onthe screen. See %M in - index-format . For example, you could use "%?M?(#%03M)&(%4l)?" in - index-format to optionally display the number of hidden messages if the - thread is collapsed. + $index_format. + + For example, you could use %?M?(#%03M)&(%4l)? in $index_format to + optionally display the number of hidden messages if the thread is + collapsed. - See also: strict-threads. + See also the $strict_threads variable. 5.4. Miscellaneous Functions - create-alias (default: a) + (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. Note: Specifying an - alias-file does not add the aliases specified there-in, you must also + specified by the $alias_file variable for future use. Note: Specifying an + $alias_file does not add the aliases specified there-in, you must also source the file. - check-traditional-pgp (default: ESC P) + (default: E-P) This function will search the current message for content signed or encrypted with PGP the "traditional" way, that is, without proper MIME tagging. Technically, this function will temporarily change the MIME content types of the body parts containing PGP data; this is similar to - the edit-type function's effect. + the function's effect. - display-toggle-weed (default: h) + (default: h) Toggles the weeding of message header fields specified by ignore commands. - edit (default: e) + (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. After you have finished editing, the changed message will be appended to the current folder, and the original message will be marked for deletion. - edit-type (default: ^E on the attachment menu, and in the pager and index - menus; ^T on the compose menu) + (default: ) (default: C-E on the attachment menu, and in the + pager and index menus; C-T on the compose menu) This command is used to temporarily edit an attachment's content type to fix, for instance, bogus character set parameters. When invoked from the @@ -1162,65 +1101,65 @@ Chapter 2. Getting Started Note that this command is also available on the compose-menu .There, it's used to fine-tune the properties of attachments you are going to send. - enter-command (default: ``:'') + (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 macro to change settings on the fly. - extract-keys (default: ^K) + (default: C-K) This command extracts PGP public keys from the current or tagged message(s) and adds them to your PGP public key ring. - forget-passphrase (default: ^F) + (default: C-F) This command wipes the passphrase(s) from memory. It is useful, if you misspelled the passphrase. - list-reply (default: L) + (default: L) Reply to the current or tagged message(s) by extracting any addresses which match the regular expressions given by the lists commands, but also - honor any Mail-Followup-To header(s) if the honor-followup-to + 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. - pipe-message (default: |) + (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 behavior of this function. + message(s) to it. The variables $pipe_decode, $pipe_split, $pipe_decode + and $wait_key control the exact behavior of this function. - resend-message (default: ESC e) + (default: E-e) With resend-message, mutt takes the current message as a template for a new message. This function is best described as "recall from arbitrary folders". It can conveniently be used to forward MIME messages while preserving the original mail structure. Note that the amount of headers - included here depends on the value of the weed variable. + included here depends on the value of the $weed variable. This function is also available from the attachment menu. You can use this to easily resend a message which was included with a bounce message as a message/rfc822 body part. - shell-escape (default: !) + (default: !) - Asks for an external Unix command and executes it. The wait-key can be + Asks for an external Unix command and executes it. The $wait_key can be used to control whether Mutt-ng will wait for a key to be pressed when the command returns (presumably to let the user read the output of the command), based on the return status of the named command. - toggle-quoted (default: T) + (default: T) - The pager uses the quote-regexp variable to detect quoted text when + The pager uses the $quote_regexp variable to detect quoted text when displaying the body of the message. This function toggles the displayof the quoted material in the message. It is particularly useful when are interested in just the response and there is a large amount of quoted text in the way. - skip-quoted (default: S) + (default: S) This function will go to the next line of non-quoted text which come after a line of quoted text in the internal pager. @@ -1229,30 +1168,21 @@ Chapter 2. Getting Started The following bindings are available in the index for sending messages. - Table 2.8. Default Mail Composition Bindings - - +--------------------------------------------------------+ - | Key | Function | Description | - |-------+-------------+----------------------------------| - | m | compose | compose a new message | - |-------+-------------+----------------------------------| - | r | reply | reply to sender | - |-------+-------------+----------------------------------| - | g | group-reply | reply to all recipients | - |-------+-------------+----------------------------------| - | L | list-reply | reply to mailing list address | - |-------+-------------+----------------------------------| - | f | forward | forward message | - |-------+-------------+----------------------------------| - | b | bounce | bounce (remail) message | - |-------+-------------+----------------------------------| - | ESC k | mail-key | mail a PGP public key to someone | - +--------------------------------------------------------+ + Table 2.8. Most commonly used Mail Composition Bindings + + Key Function Description + m compose a new message + r reply to sender + g reply to all recipients + L reply to mailing list address + f forward message + b bounce (remail) message + E-k mail a PGP public key to someone Bouncing a message sends the message as is to the recipient you specify. Forwarding a message allows you to add comments or modify the message you are forwarding. These items are discussed in greater detail in the next - chapter forwarding-mail . + chapter forwarding-mail. 6.1. Composing new messages @@ -1280,9 +1210,9 @@ Chapter 2. Getting Started first looks whether the environment variable $VISUAL is set, and if so, it takes its value as editor command. Otherwise, it has a look at $EDITOR and takes its value if it is set. If no editor command can be found, mutt-ng - simply assumes vi to be the default editor, since it's the most widespread - editor in the Unix world and it's pretty safe to assume that it is - installed and available. + simply assumes vi(1) to be the default editor, since it's the most + widespread editor in the Unix world and it's pretty safe to assume that it + is installed and available. When you've finished entering your message, save it and quit your editor. Mutt-ng will then present you with a summary screen, the compose menu. On @@ -1313,58 +1243,35 @@ Chapter 2. Getting Started Once you have finished editing the body of your mail message, you are returned to the compose menu. The following options are available: - Table 2.9. Default Compose Menu Bindings - - +------------------------------------------------------------------------+ - | Key | Function | Description | - |-------+-------------------+--------------------------------------------| - | a | attach-file | attach a file | - |-------+-------------------+--------------------------------------------| - | A | attach-message | attach message(s) to the message | - |-------+-------------------+--------------------------------------------| - | ESC k | attach-key | attach a PGP public key | - |-------+-------------------+--------------------------------------------| - | d | edit-description | edit description on attachment | - |-------+-------------------+--------------------------------------------| - | D | detach-file | detach a file | - |-------+-------------------+--------------------------------------------| - | t | edit-to | edit the To field | - |-------+-------------------+--------------------------------------------| - | ESC f | edit-from | edit the From field | - |-------+-------------------+--------------------------------------------| - | r | edit-reply-to | edit the Reply-To field | - |-------+-------------------+--------------------------------------------| - | c | edit-cc | edit the Cc field | - |-------+-------------------+--------------------------------------------| - | b | edit-bcc | edit the Bcc field | - |-------+-------------------+--------------------------------------------| - | y | send-message | send the message | - |-------+-------------------+--------------------------------------------| - | s | edit-subject | edit the Subject | - |-------+-------------------+--------------------------------------------| - | S | smime-menu | select S/MIME options | - |-------+-------------------+--------------------------------------------| - | f | edit-fcc | specify an ``Fcc'' mailbox | - |-------+-------------------+--------------------------------------------| - | p | pgp-menu | select PGP options | - |-------+-------------------+--------------------------------------------| - | P | postpone-message | postpone this message until later | - |-------+-------------------+--------------------------------------------| - | q | quit | quit (abort) sending the message | - |-------+-------------------+--------------------------------------------| - | w | write-fcc | write the message to a folder | - |-------+-------------------+--------------------------------------------| - | i | ispell | check spelling (if available on your | - | | | system) | - |-------+-------------------+--------------------------------------------| - | ^F | forget-passphrase | wipe passphrase(s) from memory | - +------------------------------------------------------------------------+ + Table 2.9. Most commonly used Compose Menu Bindings + + Key Function Description + a attach a file + A attach message(s) to the message + E-k attach a PGP public key + d edit description on attachment + D detach a file + t edit the To field + E-f edit the From field + r edit the Reply-To field + c edit the Cc field + b edit the Bcc field + y send the message + s edit the Subject + S select S/MIME options + f specify an ``Fcc'' mailbox + p select PGP options + P postpone this message until later + q quit (abort) sending the message + w write the message to a folder + i check spelling (if available on your system) + C-F wipe passphrase(s) from memory Note: The attach-message function will prompt you for a folder to attach messages from. You can now tag messages in that folder and theywill be attached to the message you are sending. Note that certainoperations like composing a new mail, replying, forwarding, etc. are not permitted when - you are in that folder. The %r in status-format will change to a 'A' to + you are in that folder. The %r in $status_format will change to a 'A' to indicate that you are in attach-message mode. 6.2. Replying @@ -1449,27 +1356,30 @@ Chapter 2. Getting Started When editing the header of your outgoing message, there are a couple of special features available. - If you specify Fcc: filename Mutt-ng will pick up filename just as if you + If you specify Fcc:filename Mutt-ng 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: filename [ - description ] where filename is the file to attach and description is an - optional string to use as the description of the attached file. + You can also attach files to your message by specifying + + 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 In-Reply-To: field from the header field, Mutt-ng will not generate a References: field, which allows you to create a new message thread. - Also see edit-headers. + Also see the $edit_headers and $editor_headers variables 6.4. Using Mutt-ng with PGP If you want to use PGP, you can specify - Pgp: [ E | S | S ] + Pgp: [E | S | S id] ``E'' encrypts, ``S'' signs and ``S'' signs with the given key, - setting pgp-sign-as permanently. + setting $pgp_sign_as permanently. If you have told mutt to PGP encrypt a message, it will guide you through a key selection process when you try to send the message. Mutt-ng will not @@ -1481,31 +1391,25 @@ Chapter 2. Getting Started In these cases, you are dropped into a menu with a list of keys from which you can select one. When you quit this menu, or mutt can't find any matching keys, you are prompted for a user ID. You can, as usually, abort - this prompt using ^G. When you do so, mutt will return to the compose + this prompt using C-G. When you do so, mutt will return to the compose screen. Once you have successfully finished the key selection, the message will be encrypted using the selected public keys, and sent out. Most fields of the entries in the key selection menu (see also - pgp-entry-format ) have obvious meanings. But some explanations on the + $pgp_entry_format) have obvious meanings. But some explanations on the capabilities, flags, and validity fields are in order. The flags sequence (%f) will expand to one of the following flags: Table 2.10. PGP Key Menu Flags - +-----------------------------------------------------------+ - | Flag | Description | - |------+----------------------------------------------------| - | R | The key has been revoked and can't be used. | - |------+----------------------------------------------------| - | X | The key is expired and can't be used. | - |------+----------------------------------------------------| - | d | You have marked the key as disabled. | - |------+----------------------------------------------------| - | c | There are unknown critical self-signature packets. | - +-----------------------------------------------------------+ + Flag Description + R The key has been revoked and can't be used. + X The key is expired and can't be used. + d You have marked the key as disabled. + c There are unknown critical self-signature packets. The capabilities field (%c) expands to a two-character sequencerepresenting a key's capabilities. The first character gives the @@ -1553,7 +1457,7 @@ Chapter 2. Getting Started (by default) the Return key. Note that different remailers do have different capabilities, indicated in - the %c entry of the remailer menu lines (see mix-entry-format). Most + the %c entry of the remailer menu lines (see $mix_entry_format). Most important is the ``middleman'' capability, indicated by a capital ``M'': This means that the remailer in question cannot be used as the final element of a chain, but will only forward messages to other mixmaster @@ -1605,7 +1509,7 @@ Chapter 2. Getting Started At times it is desirable to delay sending a message that you have already begun to compose. When the postpone-message function is used in the compose menu, the body of your message and attachments are stored in the - mailbox specified by the postponed variable. This means that you can + mailbox specified by the $postponed variable. This means that you can recall the message even if you exit Mutt-ng and then restart it at a later time. @@ -1620,7 +1524,7 @@ Chapter 2. Getting Started Also, you must be in the same folder with the message you replied to for the status of the message to be updated. - See also the postpone quad-option. + See also the $postpone quad-option. Chapter 3. Configuration @@ -1735,7 +1639,7 @@ Chapter 3. Configuration 2. Basic Syntax of Initialization Files - An initialization file consists of a series of commands .Each line of the + An initialization file consists of a series of commands. Each line of the file may contain one or more commands. When multiple commands are used, they must be separated by a semicolon (;). @@ -1751,8 +1655,8 @@ Chapter 3. Configuration contain spaces or other special characters. The difference between the two types of quotes is similar to that of many popular shell programs, namely that a single quote is used to specify a literal string (one that is not - interpreted for shell variables or quoting with a backslash [see next - paragraph]), while double quotes indicate a string for which should be + 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 not for single quotes. @@ -1824,7 +1728,7 @@ Chapter 3. Configuration set record=+sent_on_$HOSTNAME - sets the record variable to the string +sent_on_ and appends the value of + sets the $record variable to the string +sent_on_ and appends the value of the evironment variable $HOSTNAME. Note: There will be no warning if an environment variable is not defined. @@ -1837,11 +1741,11 @@ Chapter 3. Configuration set imap_home_namespace = $folder - would set the value of imap-home-namespace to the value to which folder is - currently set to. + would set the value of $imap_home_namespace to the value to which $folder + is currently set to. Note: There're no logical links established in such cases so that the the - value for imap-home-namespace won't change even if folder gets changed. + value for $imap_home_namespace won't change even if $folder gets changed. Note: There will be no warning if a configuration variable is not defined or is empty. The result will of the expansion will then be empty. @@ -1915,7 +1819,7 @@ Chapter 3. Configuration differ from different manual sources. Where the manual is installed in can be queried (already using such a variable) by running: - muttng -Q muttng_docdir + $ muttng -Q muttng_docdir To extend the example for viewing the manual via self-defined variables, it can be made more readable and more portable by changing the real path @@ -1976,7 +1880,7 @@ Chapter 3. Configuration 4. Defining/Using aliases - Usage: alias key address [ , address, ... ] + Usage: aliaskey address [, address,...] It's usually very cumbersome to remember or type out the address of someone you are communicating with. Mutt-ng allows you to create @@ -1987,18 +1891,18 @@ Chapter 3. Configuration To remove an alias or aliases (``*'' means all aliases): - unalias [ * | key ... ] + Usage: unalias[* | key ... ] alias muttdude me@cs.hmc.edu (Michael Elkins) alias theguys manny, moe, jack Unlike other mailers, Mutt-ng doesn't require aliases to be defined in a special file. The alias command can appear anywhere in a configuration - file, as long as this file is source .Consequently, you can have multiple + file, as long as this file is source. Consequently, you can have multiple alias files, or you can have all aliases defined in your muttrc. - On the other hand, the create-alias function can use only one file, the - one pointed to by the alias-file variable (which is ˜/.muttrc by + On the other hand, the function can use only one file, the + one pointed to by the $alias_file variable (which is ~/.muttrc by default). This file is not special either, in the sense that Mutt-ng 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. @@ -2012,7 +1916,7 @@ Chapter 3. Configuration To use aliases, you merely use the alias at any place in mutt where muttprompts 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. + $editor_headers variable set. In addition, at the various address prompts, you can use the tab character to expand a partial alias to the full alias. If there are multiple @@ -2027,7 +1931,7 @@ Chapter 3. Configuration 5. Changing the default key bindings - Usage: bind map key function + Usage: bindmap key function This command allows you to change the default key bindings (operation invoked when pressing a key). @@ -2101,66 +2005,43 @@ Chapter 3. Configuration Table 3.1. Alternative Key Names - +-----------------------------------+ - | Sequence | Description | - |-------------+---------------------| - | \t | tab | - |-------------+---------------------| - | | tab | - |-------------+---------------------| - | | backtab / shift-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 | - +-----------------------------------+ + Sequence Description + \t tab + tab + backtab / shift-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 (`` ''). function specifies which action to take when key is pressed. For a - complete list of functions, see the functions .The special function noop + complete list of functions, see the functions. The special function noop unbinds the specified key sequence. 6. Defining aliases for character sets - Usage: charset-hook alias charset Usage: iconv-hook charset local-charset + Usage: charset-hookaliascharset + + Usage: iconv-hookcharsetlocal-charset The charset-hook command defines an alias for a character set. This is useful to properly display messages which are tagged with a character set @@ -2172,7 +2053,7 @@ Chapter 3. Configuration 7. Setting variables based upon mailbox - Usage: folder-hook [!]regexp command + Usage: folder-hook [!]regexpcommand 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 @@ -2181,7 +2062,7 @@ Chapter 3. Configuration mailbox matches multiple folder-hook's, they are executed in the order given in the muttrc. - Note: if you use the ``!'' shortcut for spoolfile at the beginning of 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 not operator for the expression. @@ -2199,7 +2080,7 @@ Chapter 3. Configuration 8. Keyboard macros - Usage: macro menu key sequence [ description ] + Usage: macromenu key sequence [description] Macros are useful when you would like a single key to perform a series of actions. When you press key in menu menu ,Mutt-ng will behave as if you @@ -2213,10 +2094,10 @@ Chapter 3. Configuration key and sequence are expanded by the same rules as the bind. There are some additions however. The first is that 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 bind. Functions are listed - in the functions. + specify it twice. 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 bind. + Functions are listed in the functions. The advantage with using function names directly is that the macros willwork regardless of the current key bindings, so they are not dependent @@ -2232,8 +2113,11 @@ Chapter 3. Configuration 9. Using color and mono video attributes - Usage: color object foreground background [ regexp ] Usage: color index - foreground background pattern Usage: uncolor index pattern [ pattern ... ] + Usage: colorobject foreground background [regexp] + + Usage: colorindex foreground pattern + + Usage: uncolorindex pattern [pattern ...] If your terminal supports color, you can spice up Mutt-ng by creating your own color scheme. To define the color of an object (type of information), @@ -2265,7 +2149,7 @@ Chapter 3. Configuration o normal - o quoted (text matching quote-regexp in the body of a message) + o quoted (text matching $quote_regexp in the body of a message) o quoted1, quoted2, ..., quotedN (higher levels of quoting) @@ -2275,7 +2159,7 @@ Chapter 3. Configuration o status (mode lines used to display info about the mailbox or message) - o tilde (the ``˜'' used to pad blank lines in the pager) + o tilde (the ``~'' used to pad blank lines in the pager) o tree (thread tree drawn in the message index and attachment menu) @@ -2308,7 +2192,7 @@ Chapter 3. Configuration If your terminal supports it, the special keyword default can be used as a transparent color. The value brightdefault is also valid. If Mutt-ng is - linked against the S-Lang library, you also need to set the COLORFGBG + 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): @@ -2323,7 +2207,7 @@ Chapter 3. Configuration 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-ng also recognizes the keywords color0, color1 ,…, colorN-1 (N + Mutt-ng 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 color2 for your xterm), since color names may then @@ -2332,8 +2216,11 @@ Chapter 3. Configuration If your terminal does not support color, it is still possible change the video attributes through the use of the ``mono'' command: - Usage: mono [ regexp ] Usage: mono index attribute - pattern Usage: unmono index pattern [ pattern ... ] + Usage: monoobject attribute [regexp] + + Usage: monoindex attribute pattern + + Usage: unmonoindex pattern [pattern ...] where attribute is one of the following: @@ -2349,7 +2236,9 @@ Chapter 3. Configuration 10. Ignoring (weeding) unwanted message headers - Usage: [un]ignore pattern [ pattern ... ] + Usage: ignorepattern [pattern ...] + + Usage: unignorepattern [pattern ...] Messages often have many header fields added by automatic processing systems, or which may not seem useful to display on the screen. This @@ -2377,14 +2266,16 @@ Chapter 3. Configuration 11. Alternative addresses - Usage: [un]alternates regexp [ regexp ... ] + Usage: alternatesregexp [regexp ...] + + Usage: unalternatesregexp [regexp ...] With various functions, mutt will treat messages differently, depending on whether you sent them or whether you received them from someone else. For instance, when replying to a message that you sent to a different party, mutt will automatically suggest to send the response to the original - message's recipients -- responding to yourself won't make much sense in - many cases. (See reply-to .) + message's recipients--responding to yourself won't make much sense in many + cases. (See $reply_to.) Many users receive e-mail under a number of different addresses. To fully use mutt's features here, the program must be able to recognize what @@ -2468,8 +2359,9 @@ Chapter 3. Configuration set text_flowed Additionally, you have to use an editor which supports writing - format=flowed-conforming emails. For vim, this is done by adding w to the - formatoptions (see :h formatoptions and :h fo-table) when writing emails. + format=flowed-conforming emails. For vim(1), this is done by adding w to + the formatoptions (see :h formatoptions and :h fo-table) when writing + emails. Also note that format=flowed knows about ``space-stuffing'', that is, when sending messages, some kinds of lines have to be indented with a single @@ -2482,15 +2374,11 @@ Chapter 3. Configuration o > This is not the quote character but a right angle used for other reasons - o From with a trailing space. - - o just a space for formatting reasons - Please make sure that you manually prepend a space to each of them. 12.4. Additional Notes - For completeness, the delete-space variable provides the mechanism to + For completeness, the $delete_space variable provides the mechanism to generate a DelSp=yes parameter on outgoing messages. According to the standard, clients receiving a format=flowed messages should delete the last space of a flowed line but still interpret the line as flowed. @@ -2502,10 +2390,15 @@ Chapter 3. Configuration 13. Mailing lists - Usage: [un]lists regexp [ regexp ... ] Usage: [un]subscribe regexp [ - regexp ... ] + Usage: listsregexp [regexp ...] - Mutt-ng has a few nice features for using-lists .In order to take + Usage: unlistsregexp [regexp ...] + + Usage: subscriberegexp [regexp ...] + + Usage: unsubscriberegexp [regexp ...] + + Mutt-ng has a few nice features for using-lists. In order to take advantage of them, you must specify which addresses belong to mailing lists, and which mailing lists you are subscribed to. Once you have done this, the list-reply function will work for all known lists. Additionally, @@ -2515,7 +2408,7 @@ Chapter 3. Configuration header is a non-standard extension which is not supported by all mail user agents. Adding it is not bullet-proof against receiving personal CCs of list messages. Also note that the generation of the Mail-Followup-To - header is controlled by the followup-to configuration variable. + header is controlled by the $followup_to configuration variable. More precisely, Mutt-ng maintains lists of patterns for the addresses of known and subscribed mailing lists. Every subscribed mailing list is @@ -2546,7 +2439,7 @@ Chapter 3. Configuration 14. Using Multiple spool mailboxes - Usage: mbox-hook [!]pattern mailbox + Usage: mbox-hook [!]patternmailbox This command is used to move read messages from a specified mailbox to adifferent mailbox automatically when you quit or change folders. pattern @@ -2558,7 +2451,9 @@ Chapter 3. Configuration 15. Defining mailboxes which receive mail - Usage: [un]mailboxes [!]filename [ filename ... ] + Usage: mailboxes[!]filename [filename ... ] + + Usage: unmailboxes[!]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 @@ -2583,12 +2478,14 @@ Chapter 3. Configuration Note: the filenames in the mailboxes command are resolved when the command is executed, so if these names contain shortcuts (such as ``='' and - ``!''), any variable definition that affect these characters (like folder - and spoolfile) should be executed before the mailboxes command. + ``!''), any variable definition that affect these characters (like $folder + and $spoolfile) should be executed before the mailboxes command. 16. User defined headers - Usage: my_hdr string unmy_hdr field [ field ... ] + Usage: my_hdrstring + + Usage: unmy_hdrfield [field ...] The ``my_hdr'' command allows you to create your own header fields which will be added to every message you send. @@ -2601,11 +2498,11 @@ Chapter 3. Configuration in your .muttrc. Note: space characters are not allowed between the keyword and the colon - (``:''). The standard for electronic mail (RFC822) says that space is + (``:''). The standard for electronic mail (RfC 822) says that space is illegal there, so Mutt-ng 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 edit-headers function + 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. @@ -2618,7 +2515,9 @@ Chapter 3. Configuration 17. Defining the order of headers when viewing messages - Usage: hdr_order header1 header2 header3 + Usage: hdr_orderheader header [header ...] + + Usage: unhdr_order[ * | header header ...] With this command, you can specify an order in which mutt will attempt to present headers to you when viewing messages. @@ -2631,7 +2530,7 @@ Chapter 3. Configuration 18. Specify default save filename - Usage: save-hook [!]pattern filename + Usage: save-hook [!]patternfilename This command is used to override the default filename used when saving messages. filename will be used as the default filename if the message is @@ -2649,31 +2548,36 @@ Chapter 3. Configuration 19. Specify default Fcc: mailbox when composing - Usage: fcc-hook [!]pattern mailbox + Usage: fcc-hook [!]patternmailbox - This command is used to save outgoing mail in a mailbox other than record. - Mutt-ng searches the initial list of message recipients for 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. + This command is used to save outgoing mail in a mailbox other than + $record. Mutt-ng searches the initial list of message recipients for 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 pattern-hook for information on the exact format 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. 20. Specify default save filename and default Fcc: mailbox at once - Usage: fcc-save-hook [!]pattern mailbox + Usage: fcc-save-hook [!]patternmailbox This command is a shortcut, equivalent to doing both a fcc-hook and a save-hook with its arguments. 21. Change settings based upon message recipients - Usage: reply-hook [!]pattern command Usage: send-hook [!]pattern command - Usage: send2-hook [!]pattern command + Usage: reply-hook [!]patterncommand + + Usage: send-hook [!]patterncommand + + Usage: send2-hook [!]patterncommand These commands can be used to execute arbitrary configuration commands based upon recipients of the message. pattern is a regular expression @@ -2682,14 +2586,14 @@ Chapter 3. Configuration 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. + both new and replies .Note:reply-hooks are matched before the send-hook, + regardless of the order specified in the users's configuration file. 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. + 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 @@ -2700,7 +2604,7 @@ Chapter 3. Configuration Example: send-hook mutt "set mime_forward signature=''" Another typical use for this command is to change the values of the - attribution, signature and locale variables in order to change the + $attribution, $signature and $locale variables in order to change the language of the attributions and signatures based upon the recipients. Note: the send-hook's are only executed ONCE after getting the initial @@ -2711,7 +2615,7 @@ Chapter 3. Configuration 22. Change settings before formatting a message - Usage: message-hook [!]pattern command + Usage: message-hook [!]patterncommand This command can be used to execute arbitrary configuration commands before viewing or formatting a message based upon information about the @@ -2728,7 +2632,7 @@ Chapter 3. Configuration 23. Choosing the cryptographic key of the recipient - Usage: crypt-hook pattern keyid + Usage: crypt-hookpatternkeyid When encrypting messages with PGP or OpenSSL, you may want to associate a certain key with a given e-mail address automatically, either because the @@ -2744,23 +2648,29 @@ Chapter 3. Configuration 24. Adding key sequences to the keyboard buffer - Usage: push string + Usage: pushstring This command adds the named string to the keyboard buffer. The string may contain control characters, key names and function names like the sequence string in the macro command. You may use it to automatically run a - sequence of commands at startup, or when entering certain folders. + sequence of commands at startup, or when entering certain folders. For + example, the following command will automatically collapse all threads + when entering a folder: + + folder-hook . 'push ' 25. Executing functions - Usage: exec function [ function ... ] + Usage: execfunction [function ... ] This command can be used to execute any function. Functions are listed in the functions. ``exec function'' is equivalent to ``push ''. 26. Message Scoring - Usage: score pattern value Usage: unscore pattern [ pattern ... ] + Usage: scorepattern value + + Usage: unscorepattern [pattern ... ] In situations where you have to cope with a lot of emails, e.g. when you read many different mailing lists, and take part in discussions, it is @@ -2798,14 +2708,15 @@ Chapter 3. Configuration o delete threshold: when a message has a score value equal or lower than the delete threshold, it will be marked as deleted. - These three thresholds can be set via the variables score-threshold-flag - ,score-threshold-read, score-threshold-delete and. By default, - score-threshold-read and score-threshold-delete are set to -1, which means - that in the default threshold configuration no message will ever get - marked as read or deleted. + These three thresholds can be set via the variables $score_threshold_read, + $score_threshold_flag and $score_threshold_delete. + + By default, $score_threshold_read and $score_threshold_delete are set to + -1, which means that in the default threshold configuration no message + will ever get marked as read or deleted. Scoring gets especially interesting when combined with the color command - and the ˜n pattern: + and the ~n pattern: color index black yellow "~n 10-" color index red yellow "~n 100-" @@ -2818,15 +2729,17 @@ Chapter 3. Configuration 27. Spam detection - Usage: spam pattern format Usage: nospam pattern + Usage: spampattern format + + Usage: nospampattern Mutt-ng 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.) + 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 @@ -2866,7 +2779,7 @@ Chapter 3. Configuration 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 + $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. @@ -2897,7 +2810,7 @@ Chapter 3. Configuration 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 . + 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 @@ -2908,11 +2821,15 @@ Chapter 3. Configuration 28. Setting variables - Usage: set [no|inv]variable [=value] [ variable ... ] Usage: toggle - variable [variable ... ] Usage: unset variable [variable ... ] Usage: - reset variable [variable ... ] + Usage: set[no|inv]variable [=value] [variable...] + + Usage: togglevariable [variable ...] - This command is used to set (and unset) variables .There are four basic + Usage: unsetvariable [variable ...] + + Usage: resetvariable [variable ...] + + This command is used to set (and unset) variables. There are four basic types of variables: boolean, number, string and quadoption. boolean variables can be set (true) or unset (false). number variables can be assigned a positive integer value. @@ -2961,27 +2878,27 @@ Chapter 3. Configuration 29. Reading initialization commands from another file - Usage: source filename [ filename ... ] + Usage: sourcefilename [filename ...] This command allows the inclusion of initialization commands from other - files. For example, I place all of my aliases in ˜/.mail_aliases so that - I can make my ˜/.muttrc readable and keep my aliases private. + files. For example, I place all of my aliases in ~/.mail_aliases so that I + can make my ~/.muttrc readable and keep my aliases private. - If the filename begins with a tilde (``˜''), it will be expanded to the + 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 filename is considered to be an executable program from which to read input (eg. source - ˜/bin/myscript|). + ~/bin/myscript|). 30. Removing hooks - Usage: unhook [ * | hook-type ] + 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. + unhook send. 31. Sharing Setups @@ -3000,13 +2917,13 @@ Chapter 3. Configuration set config_charset = "..." and replacing the dots with the actual character set. To avoid problems - while maintaining the setup, vim user's may want to use modelines as show - in: + while maintaining the setup, vim(1) user's may want to use modelines as + show in: # vim:fileencoding=...: - while, again, replacing the dots with the appropriate name. This tells vim - as which character set to read and save the file. + while, again, replacing the dots with the appropriate name. This tells + vim(1) as which character set to read and save the file. 31.2. Modularization @@ -3045,24 +2962,24 @@ Chapter 3. Configuration sasl, sasl2, libesmtp, compressed, color, classic_pgp, classic_smime, gpgme, header_cache - As an example, one can use the following in ˜/.muttngrc: + As an example, one can use the following in ~/.muttngrc: ifdef feature_imap 'source ~/.mutt-ng/setup-imap' ifdef feature_pop 'source ~/.mutt-ng/setup-pop' ifdef feature_nntp 'source ~/.mutt-ng/setup-nntp' - ...to only source ˜/.mutt-ng/setup-imap if IMAP support is built in, only - source ˜/.mutt-ng/setup-pop if POP support is built in and only source - ˜/.mutt-ng/setup-nntp if NNTP support is built in. + ...to only source ~/.mutt-ng/setup-imap if IMAP support is built in, only + source ~/.mutt-ng/setup-pop if POP support is built in and only source + ~/.mutt-ng/setup-nntp if NNTP support is built in. An example for testing for variable names can be used if users use different revisions of mutt-ng whereby the older one may not have a - certain variable. To test for the availability of imap-mail-check , use: + certain variable. To test for the availability of $imap_mail_check use: ifdef imap_mail_check 'set imap_mail_check = 300' Provided for completeness is the test for menu names. To set - pager-index-lines only if the pager menu is available, use: + $pager_index_lines only if the pager menu is available, use: ifdef pager 'set pager_index_lines = 10' @@ -3188,10 +3105,10 @@ Chapter 4. Advanced Usage dollar sign ``$'' are metacharacters that respectively match the empty string at the beginning and end of a line. - A list of characters enclosed by ``['' and ``]'' matches any single + 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 not in the list. For example, the - regular expression [0123456789] matches any single digit. A range of ASCII + 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 it first in the @@ -3456,7 +3373,7 @@ Chapter 4. Advanced Usage o the current mutt-ng version number The setting for the status bar of the index is controlled via the - status-format variable. For the hostname and version string, there's an + $status_format variable. For the hostname and version string, there's an expando for $status_format: %h expands to the hostname and %v to the version string. When just configuring: @@ -3584,7 +3501,7 @@ Chapter 4. Advanced Usage operator, which is the ``;'' (semicolon) key by default. 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 + $auto_tag variable is set, the next operation applies to the tagged messages automatically, without requiring the ``tag-prefix''. In macro or push commands, you can use the ``tag-prefix-cond'' operator. @@ -3625,7 +3542,7 @@ Chapter 4. Advanced Usage my_hdr directive: send-hook . 'unmy_hdr From:' - send-hook ~C'^b@b\.b$' my_hdr from: c@c.c + send-hook '~C ^b@b\.b$' my-hdr from: c@c.c 5.1. Message Matching in Hooks @@ -3644,7 +3561,7 @@ Chapter 4. Advanced Usage For example, if you wanted to set your return address based upon sending mail to a specific address, you could do something like: - send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt-ng User ' + send-hook '~t ^me@cs\.hmc\.edu$' 'my-hdr From: Mutt-ng User ' which would execute the given command when sending mail to me@cs.hmc.edu. @@ -3680,26 +3597,6 @@ Chapter 4. Advanced Usage color sidebar_new red black color sidebar white black - The available functions are: - - Table 4.1. Default Sidebar Function Bindings - - +------------------------------------------------------------------------+ - | Key | Function | Description | - |------+---------------------+-------------------------------------------| - | none | sidebar-scroll-up | Scrolls the mailbox list up 1 page | - |------+---------------------+-------------------------------------------| - | none | sidebar-scroll-down | Scrolls the mailbox list down 1 page | - |------+---------------------+-------------------------------------------| - | none | sidebar-next | Highlights the next mailbox | - |------+---------------------+-------------------------------------------| - | none | sidebar-next-new | Highlights the next mailbox with new mail | - |------+---------------------+-------------------------------------------| - | none | sidebar-previous | Highlights the previous mailbox | - |------+---------------------+-------------------------------------------| - | none | sidebar-open | Opens the currently highlighted mailbox | - +------------------------------------------------------------------------+ - Reasonable key bindings look e.g. like this: bind index \Cp sidebar-prev @@ -3719,7 +3616,7 @@ Chapter 4. Advanced Usage Mutt-ng supports connecting to external directory databases such as LDAP, ph/qi, bbdb, or NIS through a wrapper script which connects to mutt using - a simple interface. Using the query-command variable, you specify the + a simple interface. Using the $query_command variable, you specify the wrapper command to use. For example: set query_command = "mutt_ldap_query.pl '%s'" @@ -3759,7 +3656,7 @@ Chapter 4. Advanced Usage Mutt-ng supports reading and writing of four different mailbox formats: mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there is no need to use a flag for different mailbox types. When creating - newmailboxes, Mutt-ng uses the default specified with the mbox-type + newmailboxes, Mutt-ng uses the default specified with the $mbox_type variable. mbox. This is the most widely used mailbox format for UNIX. All messages @@ -3794,19 +3691,19 @@ Chapter 4. Advanced Usage mailboxes. These shortcuts can be used anywhere you are prompted for a file or mailbox path. - o ! -- refers to your spoolfile (incoming) mailbox + o ! -- refers to your $spoolfile (incoming) mailbox - o > -- refers to your mbox file + o > -- refers to your $mbox file - o < -- refers to your record file + o < -- refers to your $record file o ^ -- refers to the current mailbox o - or !! -- refers to the file you've last visited - o ˜ -- refers to your home directory + o ~ -- refers to your home directory - o = or + -- refers to your folder directory + o = or + -- refers to your $folder directory o @alias -- refers to the save-hook as determined by the address of the alias @@ -3824,7 +3721,7 @@ Chapter 4. Advanced Usage 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 index menu display. This is useful to distinguish between personal and - list mail in the same mailbox. In the index-format variable, the escape + 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 appears in the ``Cc'' field (otherwise it returns the name of the author). @@ -3839,7 +3736,7 @@ Chapter 4. Advanced Usage Mutt-ng also supports the Mail-Followup-To header. When you send a message to a list of recipients which includes one or several subscribed mailing - lists, and if the followup-to option is set, mutt will generate a + lists, and if the $followup_to option is set, mutt will generate a Mail-Followup-To header which contains all the recipients to whom you send this message, but not your address. This indicates that group-replies or list-replies (also known as ``followups'') to this message should only be @@ -3849,7 +3746,7 @@ Chapter 4. Advanced Usage Conversely, when group-replying or list-replying to a message which has a Mail-Followup-To header, mutt will respect this header if the - honor-followup-to configuration variable is set. Using list-reply will in + $honor_followup_to configuration variable is set. Using list-reply will in this case also make sure that the reply goes to the mailing list, even if it's not specified in the list of recipients in the Mail-Followup-To. @@ -3862,19 +3759,19 @@ Chapter 4. Advanced Usage than the author of the message. This can create problems when trying to reply directly to the author in private, since most mail clients will automatically reply to the address given in the ``Reply-To'' field. - Mutt-ng uses the reply-to variable to help decide which address to use. If - set to ask-yes or ask-no, you will be prompted as to whether or not you + Mutt-ng uses the $reply_to variable to help decide which 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 inthe ``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 + The $index_format variable's ``%y'' and ``%Y'' escapes can be used to expand ``X-Label:'' fields in the index, and Mutt-ng's pattern-matcher can - match regular expressions to ``X-Label:'' fields with the ``˜y'' - selector. ``X-Label:'' is not a standard message header field, but it can - easily be inserted by procmailand other mail filtering agents. + match regular expressions to ``X-Label:'' fields with the ``~y'' selector. + ``X-Label:'' is not a standard message header field, but it can easily be + inserted by procmailand other mail filtering agents. Lastly, Mutt-ng has the ability to sort the mailbox into threads. A thread is a group of messages which all relate to the same subject. This is @@ -3913,8 +3810,8 @@ Chapter 4. Advanced Usage 12. 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 as + RfC 1894 defines a set of MIME content types for relaying information + about the status of electronic mail messages. These can be thought of as ``return receipts.'' Users can make use of it in one of the following two ways: @@ -3927,10 +3824,10 @@ Chapter 4. Advanced Usage To support this, there are two variables: - o dsn-notify is used to request receipts for different results (such as + o $dsn_notify is used to request receipts for different results (such as failed message,message delivered, etc.). - o dsn-return requests how much of your message should be returned with + o $dsn_return requests how much of your message should be returned with the receipt (headers or full message). Please see the reference chapter for possible values. @@ -3952,7 +3849,7 @@ Chapter 4. Advanced Usage Polling for new mail is more expensive over POP3 than locally. For this reason the frequency at which Mutt-ng will check for mail remotely can be - controlled by the pop-mail-check variable, which defaults to every 60 + controlled by the $pop_mail_check variable, which defaults to every 60 seconds. If Mutt-ng was compiled with SSL support (by running the configure script @@ -3963,11 +3860,11 @@ Chapter 4. Advanced Usage 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-ng runs exactly as if the + in the local $spoolfile. After this point, Mutt-ng runs exactly as if the mail had always been local. Note: If you only need to fetch all messages to local mailbox you should - consider using a specialized program, such as fetchmail + consider using a specialized program, such as fetchmail(1). 14. IMAP Support (OPTIONAL) @@ -3975,27 +3872,29 @@ Chapter 4. Advanced Usage 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 - imap://imapserver/INBOX, where imapserver is the name of the IMAP server - and INBOX is the special name for your spool mailbox on the IMAP server. - If you want to access another mail folder at the IMAP server, you should - use imap://imapserver/path/to/folder where path/to/folder is the path of - the folder you want to access. + You can access the remote inbox by selecting the folder via its URL: - You can select an alternative port by specifying it with the server, i.e.: - imap://imapserver:port/INBOX. + imap://imapserver/INBOX - You can also specify different username for each folder, i.e.: - imap://username@imapserver[:port]/INBOX. + where imapserver is the name of the IMAP server and INBOX is the special + name for your spool mailbox on the IMAP server. If you want to access + another mail folder at the IMAP server, you should use + + imap://imapserver/path/to/folder + + where path/to/folder is the path of the folder you want to access. You can + select an alternative port by specifying it with the server, i.e.: + + imap://imapserver:port/INBOX + + You can also specify different username for each folder by prenpending + your username and an @ symbol to the server's name. If Mutt-ng 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 path. - - Pine-compatible notation is also supported, i.e. - {[username@]imapserver[:port][/ssl]}path/to/folder + connections. To access a folder with IMAP/SSL, you only need to substitute + the initial imap:// by imaps:// in the above examples. Note that not all servers use / as the hierarchy separator. Mutt-ng should correctly notice which separator is being used by the server and @@ -4003,10 +3902,10 @@ Chapter 4. Advanced Usage 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 - toggle-subscribed command. See also the imap-list-subscribed variable. + 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 imap-mail-check and timeout variables. + you'll want to carefully tune the $imap_mail_check and $timeout variables. Note that if you are using mbox as the mail store on UW servers prior tov12.250, the server has been reported to disconnect a client if another @@ -4057,15 +3956,15 @@ Chapter 4. Advanced Usage There are a few variables which control authentication: - o imap-user - controls the username under which you request + o $imap_user - controls the username under which you request authentication on the IMAP server, for all authenticators. This is overridden by an explicit username in the mailbox path (i.e. by using a mailbox name of the form {user@host}). - o imap-pass - a password which you may preset, used by all + o $imap_pass - a password which you may preset, used by all authentication methods where a password is needed. - o imap-authenticators - a colon-delimited list of IMAP authentication + o $imap_authenticators - a colon-delimited list of IMAP authentication methods to try, in the order you wish to try them. If specified, this overrides mutt's default (attempt everything, in the order listed above). @@ -4079,7 +3978,7 @@ Chapter 4. Advanced Usage The Default newsserver can be obtained from the $NNTPSERVER environment variable. Like other news readers, info about subscribed newsgroups is - saved in a file as specified by the nntp-newsrc variable. Article headers + saved in a file as specified by the $nntp_newsrc variable. Article headers are cached and can be loaded from a file when a newsgroup is entered instead loading from newsserver; currently, this caching mechanism still is different from the header caching for maildir/IMAP. @@ -4088,7 +3987,7 @@ Chapter 4. Advanced Usage Especially for Usenet, people often ask for advanced filtering and scoring functionality. Of course, mutt-ng has scoring and allows a killfile, too. - How to use a killfile has been discussed in score-command. + How to use a killfile has been discussed in Message Scoring. What has not been discusses in detail is mutt-ng's built-in realname filter. For may newsreaders including those for ``advanced users'' like @@ -4107,8 +4006,7 @@ Chapter 4. Advanced Usage on the contrary applies a score of 42 to all messages not matching those criteria which are very strict: - o Email addresses must be valid according to RFC 2822, see - + o Email addresses must be valid according to RfC 2822 o the name must consist of at least 2 fields whereby a field must not end in a dot. This means that ``Joe User'' and ``Joe A.User'' are @@ -4125,25 +4023,25 @@ Chapter 4. Advanced Usage output muttng -v contains +USE_LIBESMTP, this will be or is the case already. The SMTP support includes support for Delivery Status Notification (see dsn section) as well as handling the 8BITMIME flag - controlled via use-8bitmime . + controlled via $use_8bitmime. To enable sending mail directly via SMTP without an MTA such as Postfix or - SSMTP and the like, simply set the smtp-host variable pointing to your + SSMTP and the like, simply set the $smtp_host variable pointing to your SMTP server. - Authentication mechanisms are available via the smtp-user and smtp-pass + Authentication mechanisms are available via the $smtp_user and $smtp_pass variables. Transport Encryption via the StartTLS command is also available. For this to work, first of all Mutt-ng must be built with SSL or GNUTLS. Secondly, - the smtp-use-tls variable must be either set to ``enabled'' or + the $smtp_use_tls variable must be either set to ``enabled'' or ``required.'' In both cases, StartTLS will be used if the server supports it: for the second case, the connection will fail ifit doesn't while switching back to unencrypted communication for the first one. Some mail providers require user's to set a particular envelope sender, i.e. they allow for only one value which may not be what the user wants to - send as the From: header. In this case, the variable smtp-envelope may be + send as the From: header. In this case, the variable $smtp_envelope may be used to set the envelope different from the From: header. 17. Managing multiple IMAP/POP/NNTP accounts (OPTIONAL) @@ -4166,7 +4064,7 @@ Chapter 4. Advanced Usage 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 commands: + and the configuration commands: macro index \cb |urlview\n macro pager \cb |urlview\n @@ -4207,12 +4105,12 @@ Chapter 4. Advanced Usage it is not compressed. This is important because it allows the use of programs that do not have well defined extensions. Just use "." as a regexp. But this may be surprising if your compressing script produces - empty files. In this situation, unset save-empty ,so that the compressed + empty files. In this situation, unset $save_empty ,so that the compressed file will be removed if you delete all of the messages. 19.1. Open a compressed mailbox for reading - Usage: open-hook regexp "command" + Usage: open-hookregexp "command" The command is the command that can be used for opening the folders whose names match regexp. @@ -4239,7 +4137,7 @@ Chapter 4. Advanced Usage 19.2. Write a compressed mailbox - Usage: close-hook regexp "command" + Usage: close-hookregexp"command" This is used to close the folder that was open with the open-hook command after some changes were made to it. @@ -4247,7 +4145,7 @@ Chapter 4. Advanced Usage The command string is the command that can be used for closing the folders whose names match regexp. It has the same format as in the open-hook command. Temporary folder in this case is the folder previously produced - by the < open-hook command. + by the open-hook command. The command should not remove the decompressed file. The command should return non-zero exit status if it fails, so mutt knows something's wrong. @@ -4264,7 +4162,7 @@ Chapter 4. Advanced Usage 19.3. Append a message to a compressed mailbox - Usage: append-hook regexp "command" + Usage: append-hookregexp"command" This command is used for saving to an existing compressed folder. The command is the command that can be used for appending to the folders whose @@ -4281,7 +4179,7 @@ Chapter 4. Advanced Usage When append-hook is used, the folder is not opened, which saves time, but this means that we can not find out what the folder type is. Thus the - default ( mbox-type )type is always supposed (i.e. this is the format used + default ($mbox_type )type is always supposed (i.e. this is the format used for the temporary folder). If the file does not exist when you save to it, close-hook is called, and @@ -4387,7 +4285,7 @@ Chapter 5. Mutt-ng's MIME Support them using the mailcap viewer definition. Finally, you can apply the usual message-related functions (like - resend-message, and the reply and forward functions) to attachments of + , and the reply and forward functions) to attachments of type message/rfc822. See the help on the attachment menu for more information. @@ -4422,8 +4320,8 @@ Chapter 5. Mutt-ng's MIME Support 2. MIME Type configuration with mime.types When you add an attachment to your mail message, Mutt-ng searches your - personal mime.types file at ${HOME}/.mime.types ,and then the system - mime.types file at /usr/local/share/mutt/mime.types or /etc/mime.types + personal mime.types file within $HOME and then the system mime.types file + at /usr/local/share/mutt/mime.types or /etc/mime.types The mime.types file consist of lines containing a MIME type and a space separated list of extensions. For example: @@ -4453,8 +4351,8 @@ Chapter 5. Mutt-ng's MIME Support 3. MIME Viewer configuration with mailcap - Mutt-ng supports RFC 1524 MIME Configuration, in particular the Unix - specific format specified in Appendix A of RFC 1524. This file format is + Mutt-ng supports RfC 1524 MIME Configuration, in particular the Unix + specific format specified in Appendix A of the RfC. This file format is commonly referred to as the mailcap format. Many MIME compliant programs utilize the mailcap format, allowing you to specify handling for all MIME types in one place for all programs. Programs known to use this format @@ -4517,7 +4415,7 @@ Chapter 5. Mutt-ng's MIME Support text/html; lynx %s In this case, lynx does not support viewing a file from stdin, so you must - use the %s syntax. Note: Some older versions of lynx contain a bug where + 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. @@ -4540,7 +4438,7 @@ Chapter 5. Mutt-ng's MIME Support The interpretation of shell meta-characters embedded in MIME parameters can lead to security problems in general. Mutt-ng tries to quote parameters in expansion of %s syntaxes properly, and avoids risky - characters by substituting them, see the mailcap-sanitize variable. + characters by substituting them, see the $mailcap_sanitize variable. Although mutt's procedures to invoke programs with mailcap seem to be safe, there are other applications parsing mailcap, maybe taking less care @@ -4587,11 +4485,11 @@ Chapter 5. Mutt-ng's MIME Support needsterminal - Mutt-ng uses this flag when viewing attachments with auto-view ,in + Mutt-ng uses this flag when viewing attachments with auto_view, in order to decide whether it should honor the setting of the - wait-key variable or not. When an attachment is viewed using an + $wait_key variable or not. When an attachment is viewed using an interactive program, and the corresponding mailcap entry has a - needsterminal flag, Mutt-ng will use wait-key and the exit + needsterminal flag, Mutt-ng will use $wait_key and the exit statusof 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. @@ -4641,7 +4539,7 @@ Chapter 5. Mutt-ng's MIME Support expansion rules defined in the next section. If the command returns 0, then the test passed, and Mutt-ng uses this entry. If the command returns non-zero, then the test failed, and Mutt-ng - continues searching for the right entry. Note: the content-type + continues searching for the right entry. Note:the content-type must match before Mutt-ng performs the test. For example: text/html; netscape -remote 'openURL(%s)' ; test=RunningX @@ -4668,7 +4566,7 @@ Chapter 5. Mutt-ng's MIME Support Mutt-ng will skip the image/* entry and use the image/gif entry with the print command. - In addition, you can use this with auto-view to denote two commands for + In addition, you can use this with auto_view to denote two commands for viewing an attachment, one to be viewed automatically, the other to be viewed interactively from the attachment menu. In addition, you can then use the test feature to determine which viewer to use interactively @@ -4678,7 +4576,7 @@ Chapter 5. Mutt-ng's MIME Support text/html; lynx %s; nametemplate=%s.html text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput - For auto-view, Mutt-ng will choose the third entry because of the + For auto_view, Mutt-ng will choose the third entry because of the copiousoutput tag. For interactive viewing, Mutt will run the program RunningX to determine if it should use the first entry. If the program returns non-zero, Mutt-ng will use the second entry for interactive @@ -4722,7 +4620,7 @@ Chapter 5. Mutt-ng's MIME Support This will be replaced by a % - Mutt-ng does not currently support the %F and %n keywords specified in RFC + Mutt-ng does not currently support the %F and %n keywords specified in RfC 1524. The main purpose of these parameters is for multipart messages, which is handled internally by Mutt-ng. @@ -4768,14 +4666,18 @@ Chapter 5. Mutt-ng's MIME Support image/*;xv %s; test=RunningX; edit=xpaint %s # Convert images to text using the netpbm tools - image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm | - pbmtoascii -1x2 ) 2>&1 ; copiousoutput + image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | \ + pgmtopbm | pbmtoascii -1x2 ) 2>&1 ; copiousoutput # Send excel spreadsheets to my NT box application/ms-excel; open.pl %s 4. MIME Autoview + Usage: auto_viewmime-type [mime-type ...] + + Usage: unauto_viewmime-type [mime-type ...] + In addition to explicitly telling Mutt-ng to view an attachment with theMIME viewer defined in the mailcap file, Mutt-ng has support for automatically viewing MIME attachments while in the pager. @@ -4808,6 +4710,10 @@ Chapter 5. Mutt-ng's MIME Support 5. MIME Multipart/Alternative + Usage: alternative_ordermime-type [mime-type ...] + + Usage: unalternative_ordermime-type [mime-type ...] + Mutt-ng has some heuristics for determining which attachment of a multipart/alternative type to display. First, mutt will check the alternative_order list to determine if one of the available typesis @@ -4818,7 +4724,7 @@ Chapter 5. Mutt-ng's MIME Support alternative_order text/enriched text/plain text application/postscript image/* - Next, mutt will check if any of the types have a defined auto-view, and + Next, mutt will check if any of the types have a defined auto_view, and use that. Failing that, Mutt-ng will look for any text type. As a last attempt, mutt willlook for any type it knows how to handle. @@ -4827,6 +4733,10 @@ Chapter 5. Mutt-ng's MIME Support 6. MIME Lookup + Usage: mime_lookupmime-type [mime-type ...] + + Usage: unmime_lookupmime-type [mime-type ...] + Mutt-ng's mime_lookup list specifies a list of mime-types that should not be treated according to their mailcap entry. This option is designed todeal with binary types such as application/octet-stream. When an @@ -4892,10 +4802,10 @@ Chapter 6. Security Considerations 2. Temporary Files Mutt-ng uses many temporary files for viewing messages, verifying digital - signatures, etc. The umask variable can be used to change the default + signatures, etc. The $umask variable can be used to change the default permissions of these files. Please only change it if you really know what you are doing. Also, a different location for these files may be desired - which can be changed via the tmpdir variable. + which can be changed via the $tmpdir variable. 3. Information Leaks @@ -4906,7 +4816,7 @@ Chapter 6. Security Considerations includes a step counter which is increased (and rotated) with every message sent. If you'd like to hide this information probably telling others how many mail you sent in which time, you at least need to remove - the %P expando from the default setting of the msgid-format variable. + the %P expando from the default setting of the $msgid_format variable. Please make sure that you really know how local parts of these Message-ID: headers are composed. @@ -4917,7 +4827,7 @@ Chapter 6. Security Considerations behavior by default, mutt-ng will be strict in interpreting them which means that arbitrary header fields can be embedded in these links which could override existing header fields or attach arbitrary files. This may - be problematic if the edit-headers variable is unset, i.e. the user + be problematic if the $edit_headers variable is unset, i.e. the user doesn't want to see header fields while editing the message. For example, following a link like @@ -4927,13 +4837,13 @@ Chapter 6. Security Considerations will send out the user's private gnupg keyring to joe@host if the user doesn't follow the information on screen carefully enough. - When unsetting the strict-mailto variable, mutt-ng will + When unsetting the $strict_mailto variable, mutt-ng will o be less strict when interpreting these links by prepending a X-Mailto- string to all header fields embedded in such a link and - o turn on the edit-headers variable by force to let the user see all the - headers (because they still may leak information.) + o turn on the $edit_headers variable by force to let the user see all + the headers (because they still may leak information.) 4. External applications @@ -4944,7 +4854,7 @@ Chapter 6. Security Considerations One of these is the mailcap mechanism as defined by RfC 1524. Mutt-ng can be set up to automatically execute any given utility as listed in one of - the mailcap files (see the mailcap-path variable for details.) + the mailcap files (see the $mailcap_path variable for details.) These utilities may have a variety of security vulnerabilities, including overwriting of arbitrary files, information leaks or other exploitable @@ -4961,7 +4871,7 @@ Chapter 6. Security Considerations o keep the software packages referenced in the mailcap file up to date - o leave the mailcap-sanitize variable in its default state to restrict + o leave the $mailcap_sanitize variable in its default state to restrict mailcap expandos to a safe set of characters 4.2. Other @@ -5013,206 +4923,129 @@ Chapter 7. Reference 5.11. editor + 5.12. sidebar + 1. Command line options Running mutt with no arguments will make Mutt-ng attempt to read your spool mailbox. However, it is possible to read other mailboxes and to send messages from the command line as well. - Table 7.1. Mutt-NG Command Line Options - - +------------------------------------------------------------------------+ - | Option | Description | - |--------+---------------------------------------------------------------| - | -A | expand an alias | - |--------+---------------------------------------------------------------| - | -a | attach a file to a message | - |--------+---------------------------------------------------------------| - | -b | specify a blind carbon-copy (BCC) address | - |--------+---------------------------------------------------------------| - | -c | specify a carbon-copy (Cc) address | - |--------+---------------------------------------------------------------| - | -e | specify a config command to be run after initialization files | - | | are read | - |--------+---------------------------------------------------------------| - | -f | specify a mailbox to load | - |--------+---------------------------------------------------------------| - | -F | specify an alternate file to read initialization commands | - |--------+---------------------------------------------------------------| - | -h | print help on command line options | - |--------+---------------------------------------------------------------| - | -H | specify a draft file from which to read a header and body | - |--------+---------------------------------------------------------------| - | -i | specify a file to include in a message composition | - |--------+---------------------------------------------------------------| - | -m | specify a default mailbox type | - |--------+---------------------------------------------------------------| - | -n | do not read the system Muttngrc | - |--------+---------------------------------------------------------------| - | -p | recall a postponed message | - |--------+---------------------------------------------------------------| - | -Q | query a configuration variable | - |--------+---------------------------------------------------------------| - | -R | open mailbox in read-only mode | - |--------+---------------------------------------------------------------| - | -s | specify a subject (enclose in quotes if it contains spaces) | - |--------+---------------------------------------------------------------| - | -t | dump the value of all variables to stdout | - |--------+---------------------------------------------------------------| - | -T | dump the value of all changed variables to stdout | - |--------+---------------------------------------------------------------| - | -v | show version number and compile-time definitions | - |--------+---------------------------------------------------------------| - | -x | simulate the mailx(1) compose mode | - |--------+---------------------------------------------------------------| - | -y | show a menu containing the files specified by the mailboxes | - | | command | - |--------+---------------------------------------------------------------| - | -z | exit immediately if there are no messages in the mailbox | - |--------+---------------------------------------------------------------| - | -Z | open the first folder with new message,exit immediately if | - | | none | - +------------------------------------------------------------------------+ + Table 7.1. Reference: Command Line Options + + Option Description + -A expand an alias + -a attach a file to a message + -b specify a blind carbon-copy (BCC) address + -c specify a carbon-copy (Cc) address + -e specify a config command to be run after initialization files are + read + -f specify a mailbox to load + -F specify an alternate file to read initialization commands + -h print help on command line options + -H specify a draft file from which to read a header and body + -i specify a file to include in a message composition + -m specify a default mailbox type + -n do not read the system Muttngrc + -p recall a postponed message + -Q query a configuration variable + -R open mailbox in read-only mode + -s specify a subject (enclose in quotes if it contains spaces) + -t dump the value of all variables to stdout + -T dump the value of all changed variables to stdout + -v show version number and compile-time definitions + -x simulate the mailx(1) compose mode + -y show a menu containing the files specified by the mailboxes command + -z exit immediately if there are no messages in the mailbox + -Z open the first folder with new message,exit immediately if none To read messages in a mailbox - mutt [ -nz ] [ -F muttrc ] [ -m type ] [ -f mailbox ] + mutt ] -nz ] ] -F muttrc ] ] -m type ] ] -f mailbox ] To compose a new message - mutt [ -n ] [ -F muttrc ] [ -a file ] [ -c address ] [ -i filename ] [ -s - subject ] address [ address ... ] + mutt ] -n ] ] -F muttrc ] ] -a file ] ] -c address ] ] -i filename ] ] -s + subject ] address ] address ... ] Mutt-ng also supports a ``batch'' mode to send prepared messages. Simply redirect input from the file you wish to send. For example, - mutt -s "data set for run #2" professor@bigschool.edu < ˜/run2.dat + mutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat This command will send a message to ``professor@bigschool.edu'' with a subject of ``data set for run #2''. In the body of the message will be the - contents of the file ``˜/run2.dat''. + contents of the file ``~/run2.dat''. 2. Patterns - Table 7.2. Patterns - - +------------------------------------------------------------------------+ - | Pattern Modifier | Argument | Description | - |------------------+-------------+---------------------------------------| - | ~A | | all messages | - |------------------+-------------+---------------------------------------| - | ~b | EXPR | messages which contain EXPR in the | - | | | message body | - |------------------+-------------+---------------------------------------| - | ~B | EXPR | messages which contain EXPR in the | - | | | whole message | - |------------------+-------------+---------------------------------------| - | ~c | EXPR | messages carbon-copied to EXPR | - |------------------+-------------+---------------------------------------| - | ~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 | EXPR | messages originating from EXPR | - |------------------+-------------+---------------------------------------| - | ~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 | EXPR | 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 *) | - |------------------+-------------+---------------------------------------| - | ~M | | multipart messages | - |------------------+-------------+---------------------------------------| - | ~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 | EXPR | messages having EXPR in the | - | | | ``Subject'' field. | - |------------------+-------------+---------------------------------------| - | ~T | | tagged messages | - |------------------+-------------+---------------------------------------| - | ~t | EXPR | messages addressed to EXPR | - |------------------+-------------+---------------------------------------| - | ~U | | unread messages | - |------------------+-------------+---------------------------------------| - | ~u | | message is addressed to a subscribed | - | | | mailing list | - |------------------+-------------+---------------------------------------| - | ~v | | message is part of a collapsed | - | | | thread. | - |------------------+-------------+---------------------------------------| - | ~V | | cryptographically verified messages | - |------------------+-------------+---------------------------------------| - | | | messages which contain EXPR in the | - | ~w | EXPR | `Newsgroups' field (if compiled with | - | | | NNTP support) | - |------------------+-------------+---------------------------------------| - | ~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) | - |------------------+-------------+---------------------------------------| - | | | ``From'' contains realname and | - | ~* | | (syntactically) valid address | - | | | (excluded are addresses matching | - | | | against alternates or any alias) | - +------------------------------------------------------------------------+ + Table 7.2. Reference: Patterns + + Pattern Modifier Argument Description + ~A/=A all messages + ~b/=b EXPR messages which contain EXPR in the message + body + ~B/=B EXPR messages which contain EXPR in the whole + message + ~c/=c EXPR messages carbon-copied to EXPR + ~C/=C EXPR message is either to: or cc: EXPR + ~D/=D deleted messages + ~d/=d [MIN]-[MAX] messages with ``date-sent'' in a Date range + ~E/=E expired messages + ~e/=e EXPR message which contains EXPR in the ``Sender'' + field + ~F/=F flagged messages + ~f/=f EXPR messages originating from EXPR + ~g/=g cryptographically signed messages + ~G/=G cryptographically encrypted messages + ~H/=H EXPR messages with a spam attribute matching EXPR + ~h/=h EXPR messages which contain EXPR in the message + header + ~k/=k message contains PGP key material + ~i/=i EXPR message which match ID in the ``Message-ID'' + field + ~L/=L EXPR message is either originated or received by + EXPR + ~l/=l message is addressed to a known mailing list + ~m/=m [MIN]-[MAX] message in the range MIN to MAX *) + ~M/=M multipart messages + ~n/=n [MIN]-[MAX] messages with a score in the range MIN to MAX + *) + ~N/=N new messages + ~O/=O old messages + ~p/=p message is addressed to you (consults + alternates) + ~P/=P message is from you (consults alternates) + ~Q/=Q messages which have been replied to + ~R/=R read messages + ~r/=r [MIN]-[MAX] messages with ``date-received'' in a Date + range + ~S/=S superseded messages + ~s/=s EXPR messages having EXPR in the ``Subject'' + field. + ~T/=T tagged messages + ~t/=t EXPR messages addressed to EXPR + ~U/=U unread messages + ~u/=u message is addressed to a subscribed mailing + list + ~v/=v message is part of a collapsed thread. + ~V/=V cryptographically verified messages + messages which contain EXPR in the + ~w/=w EXPR `Newsgroups' field (if compiled with NNTP + support) + ~x/=x EXPR messages which contain EXPR in the + `References' field + ~y/=y EXPR messages which contain EXPR in the `X-Label' + field + ~z/=z [MIN]-[MAX] messages with a size in the range MIN to MAX + *) + ~=/== duplicated messages (see $duplicate_threads) + ~$/=$ unreferenced messages (requires threaded + view) + ``From'' contains realname and + ~*/=* (syntactically) valid address (excluded are + addresses matching against alternates or any + alias) Where EXPR are regexp. Special attention has to be made when using regular expressions inside of patterns. Specifically, Mutt-ng's parser for these @@ -5220,7 +5053,7 @@ Chapter 7. Reference quoting. If it is your intention to use a backslash in the regular expression, you will need to use two backslashes instead (\\). - *) The forms <[MAX], >[MIN] , [MIN]- and -[MAX] are allowed, too. + *) The forms <[MAX], >[MIN], [MIN]- and -[MAX] are allowed, too. 3. Configuration Commands @@ -5228,23 +5061,23 @@ Chapter 7. Reference o account-hook pattern command - o alias key address [ , address ,... ] + o aliaskeyaddress [, address, ... ] - o alias [ * | key ... ] + o unalias [ * | key ... ] - o alternates regexp [ regexp ... ] + o alternatesregexp [ regexp ... ] - o alternates [ * | regexp ... ] + o unalternates [ * | regexp ... ] - o alternative-order mimetype [ mimetype ... ] + o alternative_ordermimetype [ mimetype ... ] - o alternative-order mimetype [ mimetype ... ] + o unalternative_ordermimetype [ mimetype ... ] o append-hook regexp command - o auto-view mimetype [ mimetype ... ] + o auto_viewmimetype [ mimetype ... ] - o auto-view mimetype [ mimetype ... ] + o unauto_viewmimetype [ mimetype ... ] o bind map key function @@ -5252,11 +5085,11 @@ Chapter 7. Reference o close-hook regexp command - o color object foreground background [ regexp ] + o colorobjectforegroundbackground [ regexp ] - o color index pattern [ pattern ... ] + o uncolorindexpattern [ pattern ... ] - o exec function [ function ... ] + o execfunction [ function ... ] o fcc-hook pattern mailbox @@ -5264,39 +5097,39 @@ Chapter 7. Reference o folder-hook pattern command - o hdr-order header [ header ... ] + o hdr_orderheader [ header ... ] - o hdr-order header [ header ... ] + o unhdr_orderheader [ header ... ] o charset-hook charset local-charset - o ignore pattern [ pattern ... ] + o ignorepattern [ pattern ... ] - o ignore pattern [ pattern ... ] + o unignorepattern [ pattern ... ] - o lists regexp [ regexp ... ] + o listsregexp [ regexp ... ] - o lists regexp [ regexp ... ] + o unlistsregexp [ regexp ... ] - o macro menu key sequence [ description ] + o macromenukeysequence [ description ] - o mailboxes filename [ filename ... ] + o mailboxesfilename [ filename ... ] o mbox-hook pattern mailbox o message-hook pattern command - o mime-lookup mimetype [ mimetype ... ] + o mime_lookupmimetype [ mimetype ... ] - o mime-lookup mimetype [ mimetype ... ] + o unmime_lookupmimetype [ mimetype ... ] - o color object attribute [ regexp ] + o monoobject attribute [ regexp ] - o color index pattern [ pattern ... ] + o unmonoindexpattern [ pattern ... ] - o my-hdr string + o my_hdr string - o my-hdr field [ field ... ] + o unmy_hdrfield [ field ... ] o open-hook regexp command @@ -5304,33 +5137,33 @@ Chapter 7. Reference o push string - o set variable [variable ... ] + o resetvariable [ variable ... ] o save-hook regexp filename - o score-command pattern value + o score pattern value - o score-command pattern [ pattern ... ] + o unscorepattern [ pattern ... ] o send-hook regexp command o reply-hook regexp command - o set [no|inv]variable[=value ] [ variable ... ] + o set [no|inv]variable[ =value ] [ variable ... ] - o set variable [variable ... ] + o unsetvariable [ variable ... ] o source filename o spam pattern format - o spam pattern + o nospam pattern - o lists regexp [ regexp ... ] + o subscriberegexp [ regexp ... ] - o lists regexp [ regexp ... ] + o unsubscriberegexp [ regexp ... ] - o set variable [variable ... ] + o togglevariable [ variable ... ] o unhook hook-type @@ -5341,100 +5174,57 @@ Chapter 7. Reference removed already. The left column contains the old synonym variables, the right column the full/new name: - Table 7.3. Obsolete Variables - - +----------------------------------------------------+ - | Old Name | New Name | - |------------------------+---------------------------| - | edit_hdrs | edit_headers | - |------------------------+---------------------------| - | forw_decode | forward_decode | - |------------------------+---------------------------| - | forw_format | forward_format | - |------------------------+---------------------------| - | forw_quote | forward_quote | - |------------------------+---------------------------| - | hdr_format | index_format | - |------------------------+---------------------------| - | indent_str | indent_string | - |------------------------+---------------------------| - | mime_fwd | mime_forward | - |------------------------+---------------------------| - | msg_format | message_format | - |------------------------+---------------------------| - | pgp_autosign | crypt_autosign | - |------------------------+---------------------------| - | pgp_autoencrypt | crypt_autoencrypt | - |------------------------+---------------------------| - | pgp_replyencrypt | crypt_replyencrypt | - |------------------------+---------------------------| - | pgp_replysign | crypt_replysign | - |------------------------+---------------------------| - | pgp_replysignencrypted | crypt_replysignencrypted | - |------------------------+---------------------------| - | pgp_verify_sig | crypt_verify_sig | - |------------------------+---------------------------| - | pgp_create_traditional | pgp_autoinline | - |------------------------+---------------------------| - | pgp_auto_traditional | pgp_replyinline | - |------------------------+---------------------------| - | forw_decrypt | forward_decrypt | - |------------------------+---------------------------| - | smime_sign_as | smime_default_key | - |------------------------+---------------------------| - | post_indent_str | post_indent_string | - |------------------------+---------------------------| - | print_cmd | print_command | - |------------------------+---------------------------| - | shorten_hierarchy | sidebar_shorten_hierarchy | - |------------------------+---------------------------| - | ask_followup_to | nntp_ask_followup_to | - |------------------------+---------------------------| - | ask_x_comment_to | nntp_ask_x_comment_to | - |------------------------+---------------------------| - | catchup_newsgroup | nntp_catchup | - |------------------------+---------------------------| - | followup_to_poster | nntp_followup_to_poster | - |------------------------+---------------------------| - | group_index_format | nntp_group_index_format | - |------------------------+---------------------------| - | inews | nntp_inews | - |------------------------+---------------------------| - | mime_subject | nntp_mime_subject | - |------------------------+---------------------------| - | news_cache_dir | nntp_cache_dir | - |------------------------+---------------------------| - | news_server | nntp_host | - |------------------------+---------------------------| - | newsrc | nntp_newsrc | - |------------------------+---------------------------| - | nntp_poll | nntp_mail_check | - |------------------------+---------------------------| - | pop_checkinterval | pop_mail_check | - |------------------------+---------------------------| - | post_moderated | nntp_post_moderated | - |------------------------+---------------------------| - | save_unsubscribed | nntp_save_unsubscribed | - |------------------------+---------------------------| - | show_new_news | nntp_show_new_news | - |------------------------+---------------------------| - | show_only_unread | nntp_show_only_unread | - |------------------------+---------------------------| - | x_comment_to | nntp_x_comment_to | - |------------------------+---------------------------| - | smtp_auth_username | smtp_user | - |------------------------+---------------------------| - | smtp_auth_password | smtp_pass | - |------------------------+---------------------------| - | user_agent | agent_string | - +----------------------------------------------------+ + Table 7.3. Reference: Obsolete Variables + + Old Name New Name + edit_hdrs $edit_headers + forw_decode $forward_decode + forw_format $forward_format + forw_quote $forward_quote + hdr_format $index_format + indent_str $indent_string + mime_fwd $mime_forward + msg_format $message_format + pgp_autosign $crypt_autosign + pgp_autoencrypt $crypt_autoencrypt + pgp_replyencrypt $crypt_replyencrypt + pgp_replysign $crypt_replysign + pgp_replysignencrypted $crypt_replysignencrypted + pgp_verify_sig $crypt_verify_sig + pgp_create_traditional $pgp_autoinline + pgp_auto_traditional $pgp_replyinline + forw_decrypt $forward_decrypt + smime_sign_as $smime_default_key + post_indent_str $post_indent_string + print_cmd $print_command + shorten_hierarchy $sidebar_shorten_hierarchy + ask_followup_to $nntp_ask_followup_to + ask_x_comment_to $nntp_ask_x_comment_to + catchup_newsgroup $nntp_catchup + followup_to_poster $nntp_followup_to_poster + group_index_format $nntp_group_index_format + inews $nntp_inews + mime_subject $nntp_mime_subject + news_cache_dir $nntp_cache_dir + news_server $nntp_host + newsrc $nntp_newsrc + nntp_poll $nntp_mail_check + pop_checkinterval $pop_mail_check + post_moderated $nntp_post_moderated + save_unsubscribed $nntp_save_unsubscribed + show_new_news $nntp_show_new_news + show_only_unread $nntp_show_only_unread + x_comment_to $nntp_x_comment_to + smtp_auth_username $smtp_user + smtp_auth_password $smtp_pass + user_agent $agent_string The contrib subdirectory contains a script named update-config.pl which eases migration. A complete list of current variables follows. -1. abort_noattach +1. $abort_noattach Type: quadoption @@ -5451,7 +5241,7 @@ Chapter 7. Reference See also the $attach_remind_regexp variable. -2. abort_nosubject +2. $abort_nosubject Type: quadoption @@ -5462,7 +5252,7 @@ Chapter 7. Reference messages with no subject given at the subject prompt will never be aborted. -3. abort_unmodified +3. $abort_unmodified Type: quadoption @@ -5473,7 +5263,7 @@ Chapter 7. Reference after the first edit of the file). When set to no, composition will never be aborted. -4. agent_string +4. $agent_string Type: boolean @@ -5482,19 +5272,19 @@ Chapter 7. Reference When set, Mutt-ng will add a ``User-Agent:'' header to outgoing messages, indicating which version of Mutt-ng was used for composing them. -5. alias_file +5. $alias_file Type: path - Default: "˜/.muttngrc" + Default: "~/.muttngrc" The default file in which to save aliases created by the ``create-alias'' function. Note: Mutt-ng will not automatically source this file; you must explicitly - use the `` source'' command for it to be executed. + use the ``source'' command for it to be executed. -6. alias_format +6. $alias_format Type: string @@ -5523,7 +5313,7 @@ Chapter 7. Reference character which indicates if the alias is tagged for inclusion -7. allow_8bit +7. $allow_8bit Type: boolean @@ -5532,7 +5322,7 @@ Chapter 7. Reference Controls whether 8-bit data is converted to 7-bit using either quoted-printable or base64 encoding when sending mail. -8. allow_ansi +8. $allow_ansi Type: boolean @@ -5545,7 +5335,7 @@ Chapter 7. Reference problem, since a message could include a line like ``[-- PGP output follows ..." and give it the same color as your attachment color. -9. arrow_cursor +9. $arrow_cursor Type: boolean @@ -5557,7 +5347,7 @@ Chapter 7. Reference redrawn on the screen when moving to the next or previous entries in the menu. -10. ascii_chars +10. $ascii_chars Type: boolean @@ -5566,7 +5356,7 @@ Chapter 7. Reference If set, Mutt-ng will use plain ASCII characters when displaying thread and attachment trees, instead of the default ACS characters. -11. askbcc +11. $askbcc Type: boolean @@ -5575,7 +5365,7 @@ Chapter 7. Reference If set, Mutt-ng will prompt you for blind-carbon-copy (Bcc) recipients before editing an outgoing message. -12. askcc +12. $askcc Type: boolean @@ -5584,7 +5374,7 @@ Chapter 7. Reference If set, Mutt-ng will prompt you for carbon-copy (Cc) recipients before editing the body of an outgoing message. -13. assumed_charset +13. $assumed_charset Type: string @@ -5604,7 +5394,7 @@ Chapter 7. Reference However, only the first content is valid for the message body. This variable is valid only if $strict_mime is unset. -14. attach_format +14. $attach_format Type: string @@ -5677,7 +5467,7 @@ Chapter 7. Reference pad to the end of the line with character "X" -15. attach_remind_regexp +15. $attach_remind_regexp Type: regular expression @@ -5690,7 +5480,7 @@ Chapter 7. Reference This variable and $abort_noattach are intended to remind the user to attach files if the message's text references them. -16. attach_sep +16. $attach_sep Type: string @@ -5699,7 +5489,7 @@ Chapter 7. Reference The separator to add between attachments when operating (saving, printing, piping, etc) on a list of tagged attachments. -17. attach_split +17. $attach_split Type: boolean @@ -5711,7 +5501,7 @@ Chapter 7. Reference separator is added after each attachment. When set, Mutt-ng will operate on the attachments one by one. -18. attribution +18. $attribution Type: string @@ -5721,7 +5511,7 @@ Chapter 7. Reference a reply. For a full listing of defined printf(3)-like sequences see the section on ``$index_format''. -19. auto_tag +19. $auto_tag Type: boolean @@ -5732,7 +5522,7 @@ Chapter 7. Reference first use the ``tag-prefix'' function (default: ";") to make the next function apply to all tagged messages. -20. autoedit +20. $autoedit Type: boolean @@ -5745,7 +5535,7 @@ Chapter 7. Reference Also see ``$fast_reply''. -21. beep +21. $beep Type: boolean @@ -5753,7 +5543,7 @@ Chapter 7. Reference When this variable is set, Mutt-ng will beep when an error occurs. -22. beep_new +22. $beep_new Type: boolean @@ -5763,7 +5553,7 @@ Chapter 7. Reference notifying you of new mail. This is independent of the setting of the ``$beep'' variable. -23. bounce +23. $bounce Type: quadoption @@ -5774,7 +5564,7 @@ Chapter 7. Reference variable to no is not generally useful, and thus not recommended, because you are unable to bounce messages. -24. bounce_delivered +24. $bounce_delivered Type: boolean @@ -5784,7 +5574,7 @@ Chapter 7. Reference fields when bouncing messages. Postfix users may wish to unset this variable. -25. braille_friendly +25. $braille_friendly Type: boolean @@ -5796,11 +5586,11 @@ Chapter 7. Reference menus. The option is disabled by default because many visual terminals don't permit making the cursor invisible. -26. certificate_file +26. $certificate_file Type: path - Default: "˜/.mutt_certificates" + Default: "~/.mutt_certificates" Availability: SSL or GNUTLS @@ -5813,9 +5603,9 @@ Chapter 7. Reference certificate that is signed with one of these CA certificates are also automatically accepted. - Example: set certificate_file=˜/.muttng/certificates + Example: set certificate_file=~/.muttng/certificates -27. charset +27. $charset Type: string @@ -5823,7 +5613,7 @@ Chapter 7. Reference Character set your terminal uses to display and enter textual data. -28. check_new +28. $check_new Type: boolean @@ -5837,7 +5627,7 @@ Chapter 7. Reference see if it has already been looked at. If it's unset, no check for new mail is performed while the mailbox is open. -29. collapse_unread +29. $collapse_unread Type: boolean @@ -5846,7 +5636,7 @@ Chapter 7. Reference When unset, Mutt-ng will not collapse a thread if it contains any unread messages. -30. compose_format +30. $compose_format Type: string @@ -5875,7 +5665,7 @@ Chapter 7. Reference See the text describing the ``$status_format'' option for more information on how to set ``$compose_format''. -31. config_charset +31. $config_charset Type: string @@ -5883,7 +5673,7 @@ Chapter 7. Reference When defined, Mutt-ng will recode commands in rc files from this encoding. -32. confirmappend +32. $confirmappend Type: boolean @@ -5892,7 +5682,7 @@ Chapter 7. Reference When set, Mutt-ng will prompt for confirmation when appending messages to an existing mailbox. -33. confirmcreate +33. $confirmcreate Type: boolean @@ -5901,7 +5691,7 @@ Chapter 7. Reference When set, Mutt-ng will prompt for confirmation when saving messages to a mailbox which does not yet exist before creating it. -34. connect_timeout +34. $connect_timeout Type: number @@ -5912,7 +5702,7 @@ Chapter 7. Reference negative value causes Mutt-ng to wait indefinitely for the connection to succeed. -35. content_type +35. $content_type Type: string @@ -5921,7 +5711,7 @@ Chapter 7. Reference Sets the default Content-Type: header field for the body of newly composed messages. -36. copy +36. $copy Type: quadoption @@ -5931,7 +5721,7 @@ Chapter 7. Reference will be saved for later references. Also see ``$record'', ``$save_name'', ``$force_name'' and ``fcc-hook''. -37. crypt_autoencrypt +37. $crypt_autoencrypt Type: boolean @@ -5945,7 +5735,7 @@ Chapter 7. Reference S/MIME messages and settings can be overridden by use of the smime-menu. (Crypto only) -38. crypt_autopgp +38. $crypt_autopgp Type: boolean @@ -5956,7 +5746,7 @@ Chapter 7. Reference ``$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``$smime_is_default''. -39. crypt_autosign +39. $crypt_autosign Type: boolean @@ -5969,7 +5759,7 @@ Chapter 7. Reference create S/MIME messages and settings can be overridden by use of the smime-menu. (Crypto only) -40. crypt_autosmime +40. $crypt_autosmime Type: boolean @@ -5980,7 +5770,7 @@ Chapter 7. Reference ``$crypt_replyencrypt'', ``$crypt_autosign'', ``$crypt_replysign'' and ``$smime_is_default''. -41. crypt_replyencrypt +41. $crypt_replyencrypt Type: boolean @@ -5989,7 +5779,7 @@ Chapter 7. Reference If set, automatically PGP or OpenSSL encrypt replies to messages which are encrypted. (Crypto only) -42. crypt_replysign +42. $crypt_replysign Type: boolean @@ -6001,7 +5791,7 @@ Chapter 7. Reference Note: this does not work on messages that are encrypted and signed! (Crypto only) -43. crypt_replysignencrypted +43. $crypt_replysignencrypted Type: boolean @@ -6014,7 +5804,7 @@ Chapter 7. Reference that Mutt-ng is not able to find out whether an encrypted message is also signed. (Crypto only) -44. crypt_timestamp +44. $crypt_timestamp Type: boolean @@ -6025,7 +5815,7 @@ Chapter 7. Reference colors to mark these lines, and rely on these, you may unset this setting. (Crypto only) -45. crypt_use_gpgme +45. $crypt_use_gpgme Type: boolean @@ -6038,7 +5828,7 @@ Chapter 7. Reference Note: You need to use this option in your .muttngrc configuration file as it won't have any effect when used interactively. -46. crypt_verify_sig +46. $crypt_verify_sig Type: quadoption @@ -6048,7 +5838,7 @@ Chapter 7. Reference ask whether or not to verify the signature. If ``no'', never attempt to verify cryptographic signatures. (Crypto only) -47. date_format +47. $date_format Type: string @@ -6064,11 +5854,11 @@ Chapter 7. Reference bang is discarded, and the month and week day names in the rest of the string are expanded in the C locale (that is in US English). -48. debug_level +48. $debug_level Type: number - Default: 0 + Default: 1 Availability: debug @@ -6079,11 +5869,11 @@ Chapter 7. Reference Currently, this number must be >= 0 and <= 5 and muttng must be started with -d to enable debugging at all; enabling at runtime is not possible. -49. default_hook +49. $default_hook Type: string - Default: "˜f %s !˜P | (˜P ˜C %s)" + Default: "~f %s !~P | (~P ~C %s)" This variable controls how send-hooks, message-hooks, save-hooks, and fcc-hooks will be interpreted if they are specified with only a simple @@ -6094,7 +5884,7 @@ Chapter 7. Reference or if it is from you (if the from address matches ``alternates'') and is to or cc'ed to a user matching the given regular expression. -50. delete +50. $delete Type: quadoption @@ -6105,7 +5895,7 @@ Chapter 7. Reference automatically be purged without prompting. If set to no, messages marked for deletion will be kept in the mailbox. -51. delete_space +51. $delete_space Type: boolean @@ -6119,7 +5909,7 @@ Chapter 7. Reference Note: this variable only has an effect on outgoing messages (if $text_flowed is set) but not on incomming. -52. delete_untag +52. $delete_untag Type: boolean @@ -6129,7 +5919,7 @@ Chapter 7. Reference deletion. This applies when you either explicitly delete a message, or when you save it to another folder. -53. digest_collapse +53. $digest_collapse Type: boolean @@ -6139,7 +5929,7 @@ Chapter 7. Reference the subparts of individual messages in a multipart/digest. To see these subparts, press 'v' on that menu. -54. display_filter +54. $display_filter Type: path @@ -6149,7 +5939,7 @@ Chapter 7. Reference viewed it is passed as standard input to $display_filter, and the filtered message is read from the standard output. -55. dotlock_program +55. $dotlock_program Type: path @@ -6159,7 +5949,7 @@ Chapter 7. Reference Contains the path of the muttng_dotlock(1) binary to be used by Mutt-ng. -56. dsn_notify +56. $dsn_notify Type: string @@ -6176,7 +5966,7 @@ Chapter 7. Reference Example: set dsn_notify="failure,delay" -57. dsn_return +57. $dsn_return Type: string @@ -6191,7 +5981,7 @@ Chapter 7. Reference Example: set dsn_return=hdrs -58. duplicate_threads +58. $duplicate_threads Type: boolean @@ -6202,7 +5992,7 @@ Chapter 7. Reference will indicate that it thinks they are duplicates of each other with an equals sign in the thread diagram. -59. edit_headers +59. $edit_headers Type: boolean @@ -6214,7 +6004,7 @@ Chapter 7. Reference Which empty header fields to show is controlled by the $editor_headers option. -60. editor +60. $editor Type: path @@ -6224,7 +6014,7 @@ Chapter 7. Reference the value of the $VISUAL, or $EDITOR, environment variable, or to the string "vi" if neither of those are set. -61. editor_headers +61. $editor_headers Type: string @@ -6237,7 +6027,7 @@ Chapter 7. Reference Note: if $edit_headers had to be turned on by force because $strict_mailto is unset, this option has no effect. -62. encode_from +62. $encode_from Type: boolean @@ -6253,7 +6043,7 @@ Chapter 7. Reference standard. Alternatively, you must take care of space-stuffing