1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Mutt E-Mail Client</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1" /><meta name="description" content="``All mail clients suck. This one just sucks less.'' -me, circa 1995" /></head><body><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id362612"></a>The Mutt E-Mail Client</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Michael</span> <span class="surname">Elkins</span></h3><code class="email"><<a href="mailto:me@cs.hmc.edu">me@cs.hmc.edu</a>></code></div></div><div><p class="releaseinfo">version 1.5.18 (2008-05-17)</p></div><div><div class="abstract"><p class="title"><b>Abstract</b></p><p>
4 ``All mail clients suck. This one just sucks less.'' -me, circa 1995
5 </p></div></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#intro">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#homepage">1. Mutt Home Page</a></span></dt><dt><span class="sect1"><a href="#muttlists">2. Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#distribution">3. Software Distribution Sites</a></span></dt><dt><span class="sect1"><a href="#irc">4. IRC</a></span></dt><dt><span class="sect1"><a href="#usenet">5. USENET</a></span></dt><dt><span class="sect1"><a href="#copyright">6. Copyright</a></span></dt></dl></dd><dt><span class="chapter"><a href="#gettingstarted">2. Getting Started</a></span></dt><dd><dl><dt><span class="sect1"><a href="#menus">1. Moving Around in Menus</a></span></dt><dt><span class="sect1"><a href="#editing">2. Editing Input Fields</a></span></dt><dd><dl><dt><span class="sect2"><a href="#editing-intro">2.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#editing-history">2.2. History</a></span></dt></dl></dd><dt><span class="sect1"><a href="#reading">3. Reading Mail - The Index and Pager</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id449968">3.1. The Message Index</a></span></dt><dt><span class="sect2"><a href="#id450511">3.2. The Pager</a></span></dt><dt><span class="sect2"><a href="#threads">3.3. Threaded Mode</a></span></dt><dt><span class="sect2"><a href="#id451166">3.4. Miscellaneous Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="#sending">4. Sending Mail</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id452150">4.1. Editing the message header</a></span></dt><dt><span class="sect2"><a href="#id452237">4.2. Using Mutt with PGP</a></span></dt><dt><span class="sect2"><a href="#id452481">4.3. Sending anonymous messages via mixmaster.</a></span></dt><dt><span class="sect2"><a href="#id452606">4.4. Sending format=flowed messages</a></span></dt></dl></dd><dt><span class="sect1"><a href="#forwarding-mail">5. Forwarding and Bouncing Mail</a></span></dt><dt><span class="sect1"><a href="#postponing-mail">6. Postponing Mail</a></span></dt></dl></dd><dt><span class="chapter"><a href="#configuration">3. Configuration</a></span></dt><dd><dl><dt><span class="sect1"><a href="#muttrc-syntax">1. Syntax of Initialization Files</a></span></dt><dt><span class="sect1"><a href="#addrgroup">2. Address groups</a></span></dt><dt><span class="sect1"><a href="#alias">3. Defining/Using aliases</a></span></dt><dt><span class="sect1"><a href="#bind">4. Changing the default key bindings</a></span></dt><dt><span class="sect1"><a href="#charset-hook">5. Defining aliases for character sets </a></span></dt><dt><span class="sect1"><a href="#folder-hook">6. Setting variables based upon mailbox</a></span></dt><dt><span class="sect1"><a href="#macro">7. Keyboard macros</a></span></dt><dt><span class="sect1"><a href="#color">8. Using color and mono video attributes</a></span></dt><dt><span class="sect1"><a href="#ignore">9. Ignoring (weeding) unwanted message headers</a></span></dt><dt><span class="sect1"><a href="#alternates">10. Alternative addresses</a></span></dt><dt><span class="sect1"><a href="#lists">11. Mailing lists</a></span></dt><dt><span class="sect1"><a href="#mbox-hook">12. Using Multiple spool mailboxes</a></span></dt><dt><span class="sect1"><a href="#mailboxes">13. Monitoring incoming mail</a></span></dt><dt><span class="sect1"><a href="#my-hdr">14. User defined headers</a></span></dt><dt><span class="sect1"><a href="#hdr-order">15. Defining the order of headers when viewing messages</a></span></dt><dt><span class="sect1"><a href="#save-hook">16. Specify default save mailbox</a></span></dt><dt><span class="sect1"><a href="#fcc-hook">17. Specify default Fcc: mailbox when composing</a></span></dt><dt><span class="sect1"><a href="#fcc-save-hook">18. Specify default save filename and default Fcc: mailbox at once</a></span></dt><dt><span class="sect1"><a href="#send-hook">19. Change settings based upon message recipients</a></span></dt><dt><span class="sect1"><a href="#message-hook">20. Change settings before formatting a message</a></span></dt><dt><span class="sect1"><a href="#crypt-hook">21. Choosing the cryptographic key of the recipient</a></span></dt><dt><span class="sect1"><a href="#push">22. Adding key sequences to the keyboard buffer</a></span></dt><dt><span class="sect1"><a href="#exec">23. Executing functions</a></span></dt><dt><span class="sect1"><a href="#score-command">24. Message Scoring</a></span></dt><dt><span class="sect1"><a href="#spam">25. Spam detection</a></span></dt><dt><span class="sect1"><a href="#set">26. Setting and Querying Variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="#set-commands">26.1. Commands</a></span></dt><dt><span class="sect2"><a href="#set-myvar">26.2. User-defined variables</a></span></dt></dl></dd><dt><span class="sect1"><a href="#source">27. Reading initialization commands from another file</a></span></dt><dt><span class="sect1"><a href="#unhook">28. Removing hooks</a></span></dt><dt><span class="sect1"><a href="#formatstrings">29. Format Strings</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id458133">29.1. Basic usage</a></span></dt><dt><span class="sect2"><a href="#id458263">29.2. Filters</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#advancedusage">4. Advanced Usage</a></span></dt><dd><dl><dt><span class="sect1"><a href="#regexp">1. Regular Expressions</a></span></dt><dt><span class="sect1"><a href="#patterns">2. Patterns: Searching, Limiting and Tagging</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id459463">2.1. Pattern Modifier</a></span></dt><dt><span class="sect2"><a href="#id459491">2.2. Simple Patterns</a></span></dt><dt><span class="sect2"><a href="#id459655">2.3. Complex Patterns</a></span></dt><dt><span class="sect2"><a href="#id459787">2.4. Searching by Date</a></span></dt></dl></dd><dt><span class="sect1"><a href="#tags">3. Using Tags</a></span></dt><dt><span class="sect1"><a href="#hooks">4. Using Hooks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pattern-hook">4.1. Message Matching in Hooks</a></span></dt></dl></dd><dt><span class="sect1"><a href="#query">5. External Address Queries</a></span></dt><dt><span class="sect1"><a href="#mailbox-formats">6. Mailbox Formats</a></span></dt><dt><span class="sect1"><a href="#shortcuts">7. Mailbox Shortcuts</a></span></dt><dt><span class="sect1"><a href="#using-lists">8. Handling Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#editing-threads">9. Editing threads</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id460955">9.1. Linking threads</a></span></dt><dt><span class="sect2"><a href="#id460970">9.2. Breaking threads</a></span></dt></dl></dd><dt><span class="sect1"><a href="#dsn">10. Delivery Status Notification (DSN) Support</a></span></dt><dt><span class="sect1"><a href="#urlview">11. Start a WWW Browser on URLs (EXTERNAL)</a></span></dt></dl></dd><dt><span class="chapter"><a href="#mimesupport">5. Mutt's MIME Support</a></span></dt><dd><dl><dt><span class="sect1"><a href="#using-mime">1. Using MIME in Mutt</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id461145">1.1. Viewing MIME messages in the pager</a></span></dt><dt><span class="sect2"><a href="#attach-menu">1.2. The Attachment Menu</a></span></dt><dt><span class="sect2"><a href="#compose-menu">1.3. The Compose Menu</a></span></dt></dl></dd><dt><span class="sect1"><a href="#mime-types">2. MIME Type configuration with <code class="literal">mime.types</code></a></span></dt><dt><span class="sect1"><a href="#mime-viewers">3. MIME Viewer configuration with <code class="literal">mailcap</code></a></span></dt><dd><dl><dt><span class="sect2"><a href="#id461549">3.1. The Basics of the mailcap file</a></span></dt><dt><span class="sect2"><a href="#id461671">3.2. Secure use of mailcap</a></span></dt><dt><span class="sect2"><a href="#id461742">3.3. Advanced mailcap Usage</a></span></dt><dt><span class="sect2"><a href="#id462190">3.4. Example mailcap files</a></span></dt></dl></dd><dt><span class="sect1"><a href="#auto-view">4. MIME Autoview</a></span></dt><dt><span class="sect1"><a href="#alternative-order">5. MIME Multipart/Alternative</a></span></dt><dt><span class="sect1"><a href="#attachments">6. Attachment Searching and Counting</a></span></dt><dt><span class="sect1"><a href="#mime-lookup">7. MIME Lookup</a></span></dt></dl></dd><dt><span class="chapter"><a href="#optionalfeatures">6. Optional features</a></span></dt><dd><dl><dt><span class="sect1"><a href="#id462485">1. General notes</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id462491">1.1. Enabling/disabling features</a></span></dt><dt><span class="sect2"><a href="#url-syntax">1.2. URL syntax</a></span></dt></dl></dd><dt><span class="sect1"><a href="#ssl">2. SSL/TLS Support</a></span></dt><dt><span class="sect1"><a href="#pop">3. POP3 Support</a></span></dt><dt><span class="sect1"><a href="#imap">4. IMAP Support</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id462908">4.1. The Folder Browser</a></span></dt><dt><span class="sect2"><a href="#id463028">4.2. Authentication</a></span></dt></dl></dd><dt><span class="sect1"><a href="#smtp">5. SMTP Support</a></span></dt><dt><span class="sect1"><a href="#account-hook">6. Managing multiple accounts</a></span></dt><dt><span class="sect1"><a href="#caching">7. Local caching</a></span></dt><dd><dl><dt><span class="sect2"><a href="#header-caching">7.1. Header caching</a></span></dt><dt><span class="sect2"><a href="#body-caching">7.2. Body caching</a></span></dt><dt><span class="sect2"><a href="#maint-cache">7.3. Maintenance</a></span></dt></dl></dd><dt><span class="sect1"><a href="#exact-address">8. Exact address generation</a></span></dt></dl></dd><dt><span class="chapter"><a href="#tuning">7. Performance tuning</a></span></dt><dd><dl><dt><span class="sect1"><a href="#tuning-mailboxes">1. Reading and writing mailboxes</a></span></dt><dt><span class="sect1"><a href="#tuning-messages">2. Reading messages from remote folders</a></span></dt><dt><span class="sect1"><a href="#tuning-search">3. Searching and limiting</a></span></dt></dl></dd><dt><span class="chapter"><a href="#reference">8. Reference</a></span></dt><dd><dl><dt><span class="sect1"><a href="#commandline">1. Command line options</a></span></dt><dt><span class="sect1"><a href="#commands">2. Configuration Commands</a></span></dt><dt><span class="sect1"><a href="#variables">3. Configuration variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="#abort-nosubject">3.1. abort_nosubject</a></span></dt><dt><span class="sect2"><a href="#abort-unmodified">3.2. abort_unmodified</a></span></dt><dt><span class="sect2"><a href="#alias-file">3.3. alias_file</a></span></dt><dt><span class="sect2"><a href="#alias-format">3.4. alias_format</a></span></dt><dt><span class="sect2"><a href="#allow-8bit">3.5. allow_8bit</a></span></dt><dt><span class="sect2"><a href="#allow-ansi">3.6. allow_ansi</a></span></dt><dt><span class="sect2"><a href="#arrow-cursor">3.7. arrow_cursor</a></span></dt><dt><span class="sect2"><a href="#ascii-chars">3.8. ascii_chars</a></span></dt><dt><span class="sect2"><a href="#askbcc">3.9. askbcc</a></span></dt><dt><span class="sect2"><a href="#askcc">3.10. askcc</a></span></dt><dt><span class="sect2"><a href="#assumed-charset">3.11. assumed_charset</a></span></dt><dt><span class="sect2"><a href="#attach-charset">3.12. attach_charset</a></span></dt><dt><span class="sect2"><a href="#attach-format">3.13. attach_format</a></span></dt><dt><span class="sect2"><a href="#attach-sep">3.14. attach_sep</a></span></dt><dt><span class="sect2"><a href="#attach-split">3.15. attach_split</a></span></dt><dt><span class="sect2"><a href="#attribution">3.16. attribution</a></span></dt><dt><span class="sect2"><a href="#autoedit">3.17. autoedit</a></span></dt><dt><span class="sect2"><a href="#auto-tag">3.18. auto_tag</a></span></dt><dt><span class="sect2"><a href="#beep">3.19. beep</a></span></dt><dt><span class="sect2"><a href="#beep-new">3.20. beep_new</a></span></dt><dt><span class="sect2"><a href="#bounce">3.21. bounce</a></span></dt><dt><span class="sect2"><a href="#bounce-delivered">3.22. bounce_delivered</a></span></dt><dt><span class="sect2"><a href="#braille-friendly">3.23. braille_friendly</a></span></dt><dt><span class="sect2"><a href="#check-mbox-size">3.24. check_mbox_size</a></span></dt><dt><span class="sect2"><a href="#charset">3.25. charset</a></span></dt><dt><span class="sect2"><a href="#check-new">3.26. check_new</a></span></dt><dt><span class="sect2"><a href="#collapse-unread">3.27. collapse_unread</a></span></dt><dt><span class="sect2"><a href="#uncollapse-jump">3.28. uncollapse_jump</a></span></dt><dt><span class="sect2"><a href="#compose-format">3.29. compose_format</a></span></dt><dt><span class="sect2"><a href="#config-charset">3.30. config_charset</a></span></dt><dt><span class="sect2"><a href="#confirmappend">3.31. confirmappend</a></span></dt><dt><span class="sect2"><a href="#confirmcreate">3.32. confirmcreate</a></span></dt><dt><span class="sect2"><a href="#connect-timeout">3.33. connect_timeout</a></span></dt><dt><span class="sect2"><a href="#content-type">3.34. content_type</a></span></dt><dt><span class="sect2"><a href="#copy">3.35. copy</a></span></dt><dt><span class="sect2"><a href="#crypt-use-gpgme">3.36. crypt_use_gpgme</a></span></dt><dt><span class="sect2"><a href="#crypt-use-pka">3.37. crypt_use_pka</a></span></dt><dt><span class="sect2"><a href="#crypt-autopgp">3.38. crypt_autopgp</a></span></dt><dt><span class="sect2"><a href="#crypt-autosmime">3.39. crypt_autosmime</a></span></dt><dt><span class="sect2"><a href="#date-format">3.40. date_format</a></span></dt><dt><span class="sect2"><a href="#default-hook">3.41. default_hook</a></span></dt><dt><span class="sect2"><a href="#delete">3.42. delete</a></span></dt><dt><span class="sect2"><a href="#delete-untag">3.43. delete_untag</a></span></dt><dt><span class="sect2"><a href="#digest-collapse">3.44. digest_collapse</a></span></dt><dt><span class="sect2"><a href="#display-filter">3.45. display_filter</a></span></dt><dt><span class="sect2"><a href="#dotlock-program">3.46. dotlock_program</a></span></dt><dt><span class="sect2"><a href="#dsn-notify">3.47. dsn_notify</a></span></dt><dt><span class="sect2"><a href="#dsn-return">3.48. dsn_return</a></span></dt><dt><span class="sect2"><a href="#duplicate-threads">3.49. duplicate_threads</a></span></dt><dt><span class="sect2"><a href="#edit-headers">3.50. edit_headers</a></span></dt><dt><span class="sect2"><a href="#editor">3.51. editor</a></span></dt><dt><span class="sect2"><a href="#encode-from">3.52. encode_from</a></span></dt><dt><span class="sect2"><a href="#envelope-from-address">3.53. envelope_from_address</a></span></dt><dt><span class="sect2"><a href="#escape">3.54. escape</a></span></dt><dt><span class="sect2"><a href="#fast-reply">3.55. fast_reply</a></span></dt><dt><span class="sect2"><a href="#fcc-attach">3.56. fcc_attach</a></span></dt><dt><span class="sect2"><a href="#fcc-clear">3.57. fcc_clear</a></span></dt><dt><span class="sect2"><a href="#folder">3.58. folder</a></span></dt><dt><span class="sect2"><a href="#folder-format">3.59. folder_format</a></span></dt><dt><span class="sect2"><a href="#followup-to">3.60. followup_to</a></span></dt><dt><span class="sect2"><a href="#force-name">3.61. force_name</a></span></dt><dt><span class="sect2"><a href="#forward-decode">3.62. forward_decode</a></span></dt><dt><span class="sect2"><a href="#forward-edit">3.63. forward_edit</a></span></dt><dt><span class="sect2"><a href="#forward-format">3.64. forward_format</a></span></dt><dt><span class="sect2"><a href="#forward-quote">3.65. forward_quote</a></span></dt><dt><span class="sect2"><a href="#from">3.66. from</a></span></dt><dt><span class="sect2"><a href="#gecos-mask">3.67. gecos_mask</a></span></dt><dt><span class="sect2"><a href="#hdrs">3.68. hdrs</a></span></dt><dt><span class="sect2"><a href="#header">3.69. header</a></span></dt><dt><span class="sect2"><a href="#help">3.70. help</a></span></dt><dt><span class="sect2"><a href="#hidden-host">3.71. hidden_host</a></span></dt><dt><span class="sect2"><a href="#hide-limited">3.72. hide_limited</a></span></dt><dt><span class="sect2"><a href="#hide-missing">3.73. hide_missing</a></span></dt><dt><span class="sect2"><a href="#hide-thread-subject">3.74. hide_thread_subject</a></span></dt><dt><span class="sect2"><a href="#hide-top-limited">3.75. hide_top_limited</a></span></dt><dt><span class="sect2"><a href="#hide-top-missing">3.76. hide_top_missing</a></span></dt><dt><span class="sect2"><a href="#history">3.77. history</a></span></dt><dt><span class="sect2"><a href="#history-file">3.78. history_file</a></span></dt><dt><span class="sect2"><a href="#honor-followup-to">3.79. honor_followup_to</a></span></dt><dt><span class="sect2"><a href="#hostname">3.80. hostname</a></span></dt><dt><span class="sect2"><a href="#ignore-linear-white-space">3.81. ignore_linear_white_space</a></span></dt><dt><span class="sect2"><a href="#ignore-list-reply-to">3.82. ignore_list_reply_to</a></span></dt><dt><span class="sect2"><a href="#imap-authenticators">3.83. imap_authenticators</a></span></dt><dt><span class="sect2"><a href="#imap-check-subscribed">3.84. imap_check_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-delim-chars">3.85. imap_delim_chars</a></span></dt><dt><span class="sect2"><a href="#imap-headers">3.86. imap_headers</a></span></dt><dt><span class="sect2"><a href="#imap-idle">3.87. imap_idle</a></span></dt><dt><span class="sect2"><a href="#imap-keepalive">3.88. imap_keepalive</a></span></dt><dt><span class="sect2"><a href="#imap-list-subscribed">3.89. imap_list_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-login">3.90. imap_login</a></span></dt><dt><span class="sect2"><a href="#imap-pass">3.91. imap_pass</a></span></dt><dt><span class="sect2"><a href="#imap-passive">3.92. imap_passive</a></span></dt><dt><span class="sect2"><a href="#imap-peek">3.93. imap_peek</a></span></dt><dt><span class="sect2"><a href="#imap-servernoise">3.94. imap_servernoise</a></span></dt><dt><span class="sect2"><a href="#imap-user">3.95. imap_user</a></span></dt><dt><span class="sect2"><a href="#implicit-autoview">3.96. implicit_autoview</a></span></dt><dt><span class="sect2"><a href="#include">3.97. include</a></span></dt><dt><span class="sect2"><a href="#include-onlyfirst">3.98. include_onlyfirst</a></span></dt><dt><span class="sect2"><a href="#indent-string">3.99. indent_string</a></span></dt><dt><span class="sect2"><a href="#index-format">3.100. index_format</a></span></dt><dt><span class="sect2"><a href="#ispell">3.101. ispell</a></span></dt><dt><span class="sect2"><a href="#keep-flagged">3.102. keep_flagged</a></span></dt><dt><span class="sect2"><a href="#locale">3.103. locale</a></span></dt><dt><span class="sect2"><a href="#mail-check">3.104. mail_check</a></span></dt><dt><span class="sect2"><a href="#mailcap-path">3.105. mailcap_path</a></span></dt><dt><span class="sect2"><a href="#mailcap-sanitize">3.106. mailcap_sanitize</a></span></dt><dt><span class="sect2"><a href="#header-cache">3.107. header_cache</a></span></dt><dt><span class="sect2"><a href="#maildir-header-cache-verify">3.108. maildir_header_cache_verify</a></span></dt><dt><span class="sect2"><a href="#header-cache-pagesize">3.109. header_cache_pagesize</a></span></dt><dt><span class="sect2"><a href="#header-cache-compress">3.110. header_cache_compress</a></span></dt><dt><span class="sect2"><a href="#maildir-trash">3.111. maildir_trash</a></span></dt><dt><span class="sect2"><a href="#mark-old">3.112. mark_old</a></span></dt><dt><span class="sect2"><a href="#markers">3.113. markers</a></span></dt><dt><span class="sect2"><a href="#mask">3.114. mask</a></span></dt><dt><span class="sect2"><a href="#mbox">3.115. mbox</a></span></dt><dt><span class="sect2"><a href="#mbox-type">3.116. mbox_type</a></span></dt><dt><span class="sect2"><a href="#metoo">3.117. metoo</a></span></dt><dt><span class="sect2"><a href="#menu-context">3.118. menu_context</a></span></dt><dt><span class="sect2"><a href="#menu-move-off">3.119. menu_move_off</a></span></dt><dt><span class="sect2"><a href="#menu-scroll">3.120. menu_scroll</a></span></dt><dt><span class="sect2"><a href="#meta-key">3.121. meta_key</a></span></dt><dt><span class="sect2"><a href="#mh-purge">3.122. mh_purge</a></span></dt><dt><span class="sect2"><a href="#mh-seq-flagged">3.123. mh_seq_flagged</a></span></dt><dt><span class="sect2"><a href="#mh-seq-replied">3.124. mh_seq_replied</a></span></dt><dt><span class="sect2"><a href="#mh-seq-unseen">3.125. mh_seq_unseen</a></span></dt><dt><span class="sect2"><a href="#mime-forward">3.126. mime_forward</a></span></dt><dt><span class="sect2"><a href="#mime-forward-decode">3.127. mime_forward_decode</a></span></dt><dt><span class="sect2"><a href="#mime-forward-rest">3.128. mime_forward_rest</a></span></dt><dt><span class="sect2"><a href="#mix-entry-format">3.129. mix_entry_format</a></span></dt><dt><span class="sect2"><a href="#mixmaster">3.130. mixmaster</a></span></dt><dt><span class="sect2"><a href="#move">3.131. move</a></span></dt><dt><span class="sect2"><a href="#message-cachedir">3.132. message_cachedir</a></span></dt><dt><span class="sect2"><a href="#message-cache-clean">3.133. message_cache_clean</a></span></dt><dt><span class="sect2"><a href="#message-format">3.134. message_format</a></span></dt><dt><span class="sect2"><a href="#narrow-tree">3.135. narrow_tree</a></span></dt><dt><span class="sect2"><a href="#net-inc">3.136. net_inc</a></span></dt><dt><span class="sect2"><a href="#pager">3.137. pager</a></span></dt><dt><span class="sect2"><a href="#pager-context">3.138. pager_context</a></span></dt><dt><span class="sect2"><a href="#pager-format">3.139. pager_format</a></span></dt><dt><span class="sect2"><a href="#pager-index-lines">3.140. pager_index_lines</a></span></dt><dt><span class="sect2"><a href="#pager-stop">3.141. pager_stop</a></span></dt><dt><span class="sect2"><a href="#crypt-autosign">3.142. crypt_autosign</a></span></dt><dt><span class="sect2"><a href="#crypt-autoencrypt">3.143. crypt_autoencrypt</a></span></dt><dt><span class="sect2"><a href="#pgp-ignore-subkeys">3.144. pgp_ignore_subkeys</a></span></dt><dt><span class="sect2"><a href="#crypt-replyencrypt">3.145. crypt_replyencrypt</a></span></dt><dt><span class="sect2"><a href="#crypt-replysign">3.146. crypt_replysign</a></span></dt><dt><span class="sect2"><a href="#crypt-replysignencrypted">3.147. crypt_replysignencrypted</a></span></dt><dt><span class="sect2"><a href="#crypt-timestamp">3.148. crypt_timestamp</a></span></dt><dt><span class="sect2"><a href="#pgp-use-gpg-agent">3.149. pgp_use_gpg_agent</a></span></dt><dt><span class="sect2"><a href="#crypt-verify-sig">3.150. crypt_verify_sig</a></span></dt><dt><span class="sect2"><a href="#smime-is-default">3.151. smime_is_default</a></span></dt><dt><span class="sect2"><a href="#smime-ask-cert-label">3.152. smime_ask_cert_label</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-use-default-key">3.153. smime_decrypt_use_default_key</a></span></dt><dt><span class="sect2"><a href="#pgp-entry-format">3.154. pgp_entry_format</a></span></dt><dt><span class="sect2"><a href="#pgp-good-sign">3.155. pgp_good_sign</a></span></dt><dt><span class="sect2"><a href="#pgp-check-exit">3.156. pgp_check_exit</a></span></dt><dt><span class="sect2"><a href="#pgp-long-ids">3.157. pgp_long_ids</a></span></dt><dt><span class="sect2"><a href="#pgp-retainable-sigs">3.158. pgp_retainable_sigs</a></span></dt><dt><span class="sect2"><a href="#pgp-autoinline">3.159. pgp_autoinline</a></span></dt><dt><span class="sect2"><a href="#pgp-replyinline">3.160. pgp_replyinline</a></span></dt><dt><span class="sect2"><a href="#pgp-show-unusable">3.161. pgp_show_unusable</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-as">3.162. pgp_sign_as</a></span></dt><dt><span class="sect2"><a href="#pgp-strict-enc">3.163. pgp_strict_enc</a></span></dt><dt><span class="sect2"><a href="#pgp-timeout">3.164. pgp_timeout</a></span></dt><dt><span class="sect2"><a href="#pgp-sort-keys">3.165. pgp_sort_keys</a></span></dt><dt><span class="sect2"><a href="#pgp-mime-auto">3.166. pgp_mime_auto</a></span></dt><dt><span class="sect2"><a href="#pgp-auto-decode">3.167. pgp_auto_decode</a></span></dt><dt><span class="sect2"><a href="#pgp-decode-command">3.168. pgp_decode_command</a></span></dt><dt><span class="sect2"><a href="#pgp-getkeys-command">3.169. pgp_getkeys_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-command">3.170. pgp_verify_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decrypt-command">3.171. pgp_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#pgp-clearsign-command">3.172. pgp_clearsign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-command">3.173. pgp_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-sign-command">3.174. pgp_encrypt_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-only-command">3.175. pgp_encrypt_only_command</a></span></dt><dt><span class="sect2"><a href="#pgp-import-command">3.176. pgp_import_command</a></span></dt><dt><span class="sect2"><a href="#pgp-export-command">3.177. pgp_export_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-key-command">3.178. pgp_verify_key_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-secring-command">3.179. pgp_list_secring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-pubring-command">3.180. pgp_list_pubring_command</a></span></dt><dt><span class="sect2"><a href="#forward-decrypt">3.181. forward_decrypt</a></span></dt><dt><span class="sect2"><a href="#smime-timeout">3.182. smime_timeout</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-with">3.183. smime_encrypt_with</a></span></dt><dt><span class="sect2"><a href="#smime-keys">3.184. smime_keys</a></span></dt><dt><span class="sect2"><a href="#smime-ca-location">3.185. smime_ca_location</a></span></dt><dt><span class="sect2"><a href="#smime-certificates">3.186. smime_certificates</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-command">3.187. smime_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-command">3.188. smime_verify_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-opaque-command">3.189. smime_verify_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-command">3.190. smime_sign_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-opaque-command">3.191. smime_sign_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-command">3.192. smime_encrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-pk7out-command">3.193. smime_pk7out_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-command">3.194. smime_get_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-signer-cert-command">3.195. smime_get_signer_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-import-cert-command">3.196. smime_import_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-email-command">3.197. smime_get_cert_email_command</a></span></dt><dt><span class="sect2"><a href="#smime-default-key">3.198. smime_default_key</a></span></dt><dt><span class="sect2"><a href="#ssl-client-cert">3.199. ssl_client_cert</a></span></dt><dt><span class="sect2"><a href="#ssl-force-tls">3.200. ssl_force_tls</a></span></dt><dt><span class="sect2"><a href="#ssl-starttls">3.201. ssl_starttls</a></span></dt><dt><span class="sect2"><a href="#certificate-file">3.202. certificate_file</a></span></dt><dt><span class="sect2"><a href="#ssl-usesystemcerts">3.203. ssl_usesystemcerts</a></span></dt><dt><span class="sect2"><a href="#entropy-file">3.204. entropy_file</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv2">3.205. ssl_use_sslv2</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv3">3.206. ssl_use_sslv3</a></span></dt><dt><span class="sect2"><a href="#ssl-use-tlsv1">3.207. ssl_use_tlsv1</a></span></dt><dt><span class="sect2"><a href="#ssl-min-dh-prime-bits">3.208. ssl_min_dh_prime_bits</a></span></dt><dt><span class="sect2"><a href="#ssl-ca-certificates-file">3.209. ssl_ca_certificates_file</a></span></dt><dt><span class="sect2"><a href="#pipe-split">3.210. pipe_split</a></span></dt><dt><span class="sect2"><a href="#pipe-decode">3.211. pipe_decode</a></span></dt><dt><span class="sect2"><a href="#pipe-sep">3.212. pipe_sep</a></span></dt><dt><span class="sect2"><a href="#pop-authenticators">3.213. pop_authenticators</a></span></dt><dt><span class="sect2"><a href="#pop-auth-try-all">3.214. pop_auth_try_all</a></span></dt><dt><span class="sect2"><a href="#pop-checkinterval">3.215. pop_checkinterval</a></span></dt><dt><span class="sect2"><a href="#pop-delete">3.216. pop_delete</a></span></dt><dt><span class="sect2"><a href="#pop-host">3.217. pop_host</a></span></dt><dt><span class="sect2"><a href="#pop-last">3.218. pop_last</a></span></dt><dt><span class="sect2"><a href="#pop-reconnect">3.219. pop_reconnect</a></span></dt><dt><span class="sect2"><a href="#pop-user">3.220. pop_user</a></span></dt><dt><span class="sect2"><a href="#pop-pass">3.221. pop_pass</a></span></dt><dt><span class="sect2"><a href="#post-indent-string">3.222. post_indent_string</a></span></dt><dt><span class="sect2"><a href="#postpone">3.223. postpone</a></span></dt><dt><span class="sect2"><a href="#postponed">3.224. postponed</a></span></dt><dt><span class="sect2"><a href="#preconnect">3.225. preconnect</a></span></dt><dt><span class="sect2"><a href="#print">3.226. print</a></span></dt><dt><span class="sect2"><a href="#print-command">3.227. print_command</a></span></dt><dt><span class="sect2"><a href="#print-decode">3.228. print_decode</a></span></dt><dt><span class="sect2"><a href="#print-split">3.229. print_split</a></span></dt><dt><span class="sect2"><a href="#prompt-after">3.230. prompt_after</a></span></dt><dt><span class="sect2"><a href="#query-command">3.231. query_command</a></span></dt><dt><span class="sect2"><a href="#query-format">3.232. query_format</a></span></dt><dt><span class="sect2"><a href="#quit">3.233. quit</a></span></dt><dt><span class="sect2"><a href="#quote-regexp">3.234. quote_regexp</a></span></dt><dt><span class="sect2"><a href="#read-inc">3.235. read_inc</a></span></dt><dt><span class="sect2"><a href="#read-only">3.236. read_only</a></span></dt><dt><span class="sect2"><a href="#realname">3.237. realname</a></span></dt><dt><span class="sect2"><a href="#recall">3.238. recall</a></span></dt><dt><span class="sect2"><a href="#record">3.239. record</a></span></dt><dt><span class="sect2"><a href="#reply-regexp">3.240. reply_regexp</a></span></dt><dt><span class="sect2"><a href="#reply-self">3.241. reply_self</a></span></dt><dt><span class="sect2"><a href="#reply-to">3.242. reply_to</a></span></dt><dt><span class="sect2"><a href="#resolve">3.243. resolve</a></span></dt><dt><span class="sect2"><a href="#reverse-alias">3.244. reverse_alias</a></span></dt><dt><span class="sect2"><a href="#reverse-name">3.245. reverse_name</a></span></dt><dt><span class="sect2"><a href="#reverse-realname">3.246. reverse_realname</a></span></dt><dt><span class="sect2"><a href="#rfc2047-parameters">3.247. rfc2047_parameters</a></span></dt><dt><span class="sect2"><a href="#save-address">3.248. save_address</a></span></dt><dt><span class="sect2"><a href="#save-empty">3.249. save_empty</a></span></dt><dt><span class="sect2"><a href="#save-history">3.250. save_history</a></span></dt><dt><span class="sect2"><a href="#save-name">3.251. save_name</a></span></dt><dt><span class="sect2"><a href="#score">3.252. score</a></span></dt><dt><span class="sect2"><a href="#score-threshold-delete">3.253. score_threshold_delete</a></span></dt><dt><span class="sect2"><a href="#score-threshold-flag">3.254. score_threshold_flag</a></span></dt><dt><span class="sect2"><a href="#score-threshold-read">3.255. score_threshold_read</a></span></dt><dt><span class="sect2"><a href="#send-charset">3.256. send_charset</a></span></dt><dt><span class="sect2"><a href="#sendmail">3.257. sendmail</a></span></dt><dt><span class="sect2"><a href="#sendmail-wait">3.258. sendmail_wait</a></span></dt><dt><span class="sect2"><a href="#shell">3.259. shell</a></span></dt><dt><span class="sect2"><a href="#sig-dashes">3.260. sig_dashes</a></span></dt><dt><span class="sect2"><a href="#sig-on-top">3.261. sig_on_top</a></span></dt><dt><span class="sect2"><a href="#signature">3.262. signature</a></span></dt><dt><span class="sect2"><a href="#simple-search">3.263. simple_search</a></span></dt><dt><span class="sect2"><a href="#smart-wrap">3.264. smart_wrap</a></span></dt><dt><span class="sect2"><a href="#smileys">3.265. smileys</a></span></dt><dt><span class="sect2"><a href="#sleep-time">3.266. sleep_time</a></span></dt><dt><span class="sect2"><a href="#smtp-authenticators">3.267. smtp_authenticators</a></span></dt><dt><span class="sect2"><a href="#smtp-pass">3.268. smtp_pass</a></span></dt><dt><span class="sect2"><a href="#smtp-url">3.269. smtp_url</a></span></dt><dt><span class="sect2"><a href="#sort">3.270. sort</a></span></dt><dt><span class="sect2"><a href="#sort-alias">3.271. sort_alias</a></span></dt><dt><span class="sect2"><a href="#sort-aux">3.272. sort_aux</a></span></dt><dt><span class="sect2"><a href="#sort-browser">3.273. sort_browser</a></span></dt><dt><span class="sect2"><a href="#sort-re">3.274. sort_re</a></span></dt><dt><span class="sect2"><a href="#spam-separator">3.275. spam_separator</a></span></dt><dt><span class="sect2"><a href="#spoolfile">3.276. spoolfile</a></span></dt><dt><span class="sect2"><a href="#status-chars">3.277. status_chars</a></span></dt><dt><span class="sect2"><a href="#status-format">3.278. status_format</a></span></dt><dt><span class="sect2"><a href="#status-on-top">3.279. status_on_top</a></span></dt><dt><span class="sect2"><a href="#strict-threads">3.280. strict_threads</a></span></dt><dt><span class="sect2"><a href="#suspend">3.281. suspend</a></span></dt><dt><span class="sect2"><a href="#text-flowed">3.282. text_flowed</a></span></dt><dt><span class="sect2"><a href="#thread-received">3.283. thread_received</a></span></dt><dt><span class="sect2"><a href="#thorough-search">3.284. thorough_search</a></span></dt><dt><span class="sect2"><a href="#tilde">3.285. tilde</a></span></dt><dt><span class="sect2"><a href="#time-inc">3.286. time_inc</a></span></dt><dt><span class="sect2"><a href="#timeout">3.287. timeout</a></span></dt><dt><span class="sect2"><a href="#tmpdir">3.288. tmpdir</a></span></dt><dt><span class="sect2"><a href="#to-chars">3.289. to_chars</a></span></dt><dt><span class="sect2"><a href="#tunnel">3.290. tunnel</a></span></dt><dt><span class="sect2"><a href="#use-8bitmime">3.291. use_8bitmime</a></span></dt><dt><span class="sect2"><a href="#use-domain">3.292. use_domain</a></span></dt><dt><span class="sect2"><a href="#use-envelope-from">3.293. use_envelope_from</a></span></dt><dt><span class="sect2"><a href="#use-from">3.294. use_from</a></span></dt><dt><span class="sect2"><a href="#use-idn">3.295. use_idn</a></span></dt><dt><span class="sect2"><a href="#use-ipv6">3.296. use_ipv6</a></span></dt><dt><span class="sect2"><a href="#user-agent">3.297. user_agent</a></span></dt><dt><span class="sect2"><a href="#visual">3.298. visual</a></span></dt><dt><span class="sect2"><a href="#wait-key">3.299. wait_key</a></span></dt><dt><span class="sect2"><a href="#weed">3.300. weed</a></span></dt><dt><span class="sect2"><a href="#wrap">3.301. wrap</a></span></dt><dt><span class="sect2"><a href="#wrap-search">3.302. wrap_search</a></span></dt><dt><span class="sect2"><a href="#wrapmargin">3.303. wrapmargin</a></span></dt><dt><span class="sect2"><a href="#write-inc">3.304. write_inc</a></span></dt><dt><span class="sect2"><a href="#write-bcc">3.305. write_bcc</a></span></dt></dl></dd><dt><span class="sect1"><a href="#functions">4. Functions</a></span></dt><dd><dl><dt><span class="sect2"><a href="#generic_map">4.1. generic</a></span></dt><dt><span class="sect2"><a href="#index_map">4.2. index</a></span></dt><dt><span class="sect2"><a href="#pager_map">4.3. pager</a></span></dt><dt><span class="sect2"><a href="#alias_map">4.4. alias</a></span></dt><dt><span class="sect2"><a href="#query_map">4.5. query</a></span></dt><dt><span class="sect2"><a href="#attach_map">4.6. attach</a></span></dt><dt><span class="sect2"><a href="#compose_map">4.7. compose</a></span></dt><dt><span class="sect2"><a href="#postpone_map">4.8. postpone</a></span></dt><dt><span class="sect2"><a href="#browser_map">4.9. browser</a></span></dt><dt><span class="sect2"><a href="#pgp_map">4.10. pgp</a></span></dt><dt><span class="sect2"><a href="#smime_map">4.11. smime</a></span></dt><dt><span class="sect2"><a href="#mix_map">4.12. mix</a></span></dt><dt><span class="sect2"><a href="#editor_map">4.13. editor</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#miscellany">9. Miscellany</a></span></dt><dd><dl><dt><span class="sect1"><a href="#acknowledgements">1. Acknowledgements</a></span></dt><dt><span class="sect1"><a href="#about">2. About this document</a></span></dt></dl></dd></dl></div><div class="list-of-tables"><p><b>List of Tables</b></p><dl><dt>2.1. <a href="#tab-keys-nav">Most common navigation keys</a></dt><dt>2.2. <a href="#tab-keys-editor">Most common line editor keys</a></dt><dt>2.3. <a href="#tab-key-index">Most common message index keys</a></dt><dt>2.4. <a href="#tab-key-pager">Most common pager keys</a></dt><dt>2.5. <a href="#tab-ansi-esc">ANSI escape sequences</a></dt><dt>2.6. <a href="#tab-color">Color sequences</a></dt><dt>2.7. <a href="#tab-key-threads">Most common thread mode keys</a></dt><dt>2.8. <a href="#tab-key-send">Most common mail sending keys</a></dt><dt>2.9. <a href="#tab-func-compose">Most common compose menu keys</a></dt><dt>2.10. <a href="#tab-pgp-menuflags">PGP key menu flags</a></dt><dt>2.11. <a href="#tab-key-fwd">Message forwarding/bouncing keys</a></dt><dt>3.1. <a href="#tab-key-names">Symbolic key names</a></dt><dt>4.1. <a href="#tab-patterns">Pattern modifiers</a></dt><dt>4.2. <a href="#tab-simplesearch-keywords">Simple search keywords</a></dt><dt>4.3. <a href="#tab-date-units">Date units</a></dt><dt>8.1. <a href="#id463727">Command line options</a></dt><dt>8.2. <a href="#generic_table">Default generic function bindings</a></dt><dt>8.3. <a href="#index_table">Default index function bindings</a></dt><dt>8.4. <a href="#pager_table">Default pager function bindings</a></dt><dt>8.5. <a href="#alias_table">Default alias function bindings</a></dt><dt>8.6. <a href="#query_table">Default query function bindings</a></dt><dt>8.7. <a href="#attach_table">Default attach function bindings</a></dt><dt>8.8. <a href="#compose_table">Default compose function bindings</a></dt><dt>8.9. <a href="#postpone_table">Default postpone function bindings</a></dt><dt>8.10. <a href="#browser_table">Default browser function bindings</a></dt><dt>8.11. <a href="#pgp_table">Default pgp function bindings</a></dt><dt>8.12. <a href="#smime_table">Default smime function bindings</a></dt><dt>8.13. <a href="#mix_table">Default mix function bindings</a></dt><dt>8.14. <a href="#editor_table">Default editor function bindings</a></dt></dl></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="intro"></a>Chapter 1. Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#homepage">1. Mutt Home Page</a></span></dt><dt><span class="sect1"><a href="#muttlists">2. Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#distribution">3. Software Distribution Sites</a></span></dt><dt><span class="sect1"><a href="#irc">4. IRC</a></span></dt><dt><span class="sect1"><a href="#usenet">5. USENET</a></span></dt><dt><span class="sect1"><a href="#copyright">6. Copyright</a></span></dt></dl></div><p>
6 <span class="bold"><strong>Mutt</strong></span> is a small but very powerful text-based MIME mail client. Mutt is
7 highly configurable, and is well suited to the mail power user with advanced
8 features like key bindings, keyboard macros, mail threading, regular
9 expression searches and a powerful pattern matching language for selecting
11 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="homepage"></a>1. Mutt Home Page</h2></div></div></div><p>
12 <a href="http://www.mutt.org/" target="_top">http://www.mutt.org/</a>
13 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="muttlists"></a>2. Mailing Lists</h2></div></div></div><p>
14 To subscribe to one of the following mailing lists, send a message with the
15 word <span class="emphasis"><em>subscribe</em></span> in the body to
16 <code class="literal">list-name</code><span class="emphasis"><em>-request</em></span><code class="literal">@mutt.org</code>.
19 </p><div class="itemizedlist"><ul type="disc"><li><p>
20 <code class="email"><<a href="mailto:mutt-announce-request@mutt.org">mutt-announce-request@mutt.org</a>></code> -- low traffic list for announcements
22 <code class="email"><<a href="mailto:mutt-users-request@mutt.org">mutt-users-request@mutt.org</a>></code> -- help, bug reports and feature requests
24 <code class="email"><<a href="mailto:mutt-dev-request@mutt.org">mutt-dev-request@mutt.org</a>></code> -- development mailing list
25 </p></li></ul></div><p>
28 <span class="bold"><strong>Note:</strong></span> all messages posted to <span class="emphasis"><em>mutt-announce</em></span> are automatically
29 forwarded to <span class="emphasis"><em>mutt-users</em></span>, so you do not need to be subscribed to both
31 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="distribution"></a>3. Software Distribution Sites</h2></div></div></div><p>
33 </p><div class="itemizedlist"><ul type="disc"><li><p>
34 <a href="ftp://ftp.mutt.org/mutt/" target="_top">ftp://ftp.mutt.org/mutt/</a>
35 </p></li></ul></div><p>
38 For a list of mirror sites, please refer to <a href="http://www.mutt.org/download.html" target="_top">http://www.mutt.org/download.html</a>.
39 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="irc"></a>4. IRC</h2></div></div></div><p>
40 Visit channel <span class="emphasis"><em>#mutt</em></span> on
41 <a href="http://www.freenode.net/" target="_top">irc.freenode.net</a> to chat with
42 other people interested in Mutt.
43 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="usenet"></a>5. USENET</h2></div></div></div><p>
44 See the newsgroup <a href="news:comp.mail.mutt" target="_top">comp.mail.mutt</a>.
45 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="copyright"></a>6. Copyright</h2></div></div></div><p>
46 Mutt is Copyright (C) 1996-2005 Michael R. Elkins
47 <code class="email"><<a href="mailto:me@cs.hmc.edu">me@cs.hmc.edu</a>></code> and others
49 This program is free software; you can redistribute it and/or modify
50 it under the terms of the GNU General Public License as published by
51 the Free Software Foundation; either version 2 of the License, or
52 (at your option) any later version.
54 This program is distributed in the hope that it will be useful,
55 but WITHOUT ANY WARRANTY; without even the implied warranty of
56 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
57 GNU General Public License for more details.
59 You should have received a copy of the GNU General Public License
60 along with this program; if not, write to the Free Software
61 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
62 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="gettingstarted"></a>Chapter 2. Getting Started</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#menus">1. Moving Around in Menus</a></span></dt><dt><span class="sect1"><a href="#editing">2. Editing Input Fields</a></span></dt><dd><dl><dt><span class="sect2"><a href="#editing-intro">2.1. Introduction</a></span></dt><dt><span class="sect2"><a href="#editing-history">2.2. History</a></span></dt></dl></dd><dt><span class="sect1"><a href="#reading">3. Reading Mail - The Index and Pager</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id449968">3.1. The Message Index</a></span></dt><dt><span class="sect2"><a href="#id450511">3.2. The Pager</a></span></dt><dt><span class="sect2"><a href="#threads">3.3. Threaded Mode</a></span></dt><dt><span class="sect2"><a href="#id451166">3.4. Miscellaneous Functions</a></span></dt></dl></dd><dt><span class="sect1"><a href="#sending">4. Sending Mail</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id452150">4.1. Editing the message header</a></span></dt><dt><span class="sect2"><a href="#id452237">4.2. Using Mutt with PGP</a></span></dt><dt><span class="sect2"><a href="#id452481">4.3. Sending anonymous messages via mixmaster.</a></span></dt><dt><span class="sect2"><a href="#id452606">4.4. Sending format=flowed messages</a></span></dt></dl></dd><dt><span class="sect1"><a href="#forwarding-mail">5. Forwarding and Bouncing Mail</a></span></dt><dt><span class="sect1"><a href="#postponing-mail">6. Postponing Mail</a></span></dt></dl></div><p>
63 This section is intended as a brief overview of how to use Mutt. There are
64 many other features which are described elsewhere in the manual. There
65 is even more information available in the Mutt FAQ and various web
66 pages. See the <a href="http://www.mutt.org/mutt/" target="_top">Mutt Page</a> for more details.
68 The keybindings described in this section are the defaults as distributed.
69 Your local system administrator may have altered the defaults for your site.
70 You can always type ``?'' in any menu to display the current bindings.
72 The first thing you need to do is invoke mutt, simply by typing mutt
73 at the command line. There are various command-line options, see
74 either the mutt man page or the <a href="#commandline" title="1. Command line options">reference</a>.
75 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="menus"></a>1. Moving Around in Menus</h2></div></div></div><p>
76 Information is presented in menus, very similar to ELM, see <a href="#tab-keys-nav" title="Table 2.1. Most common navigation keys">Table 2.1, “Most common navigation keys”</a>
77 for common keys used to navigate menus in Mutt.
80 </p><div class="table"><a id="tab-keys-nav"></a><p class="title"><b>Table 2.1. Most common navigation keys</b></p><div class="table-contents"><table summary="Most common navigation keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>j or Down</td><td>next-entry</td><td>move to the next entry</td></tr><tr><td>k or Up</td><td>previous-entry</td><td>move to the previous entry</td></tr><tr><td>z or PageDn</td><td>page-down</td><td>go to the next page</td></tr><tr><td>Z or PageUp</td><td>page-up</td><td>go to the previous page</td></tr><tr><td>= or Home</td><td>first-entry</td><td>jump to the first entry</td></tr><tr><td>* or End</td><td>last-entry</td><td>jump to the last entry</td></tr><tr><td>q</td><td>quit</td><td>exit the current menu</td></tr><tr><td>?</td><td>help</td><td>list all keybindings for the current menu</td></tr></tbody></table></div></div><p><br class="table-break" />
82 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="editing"></a>2. Editing Input Fields</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editing-intro"></a>2.1. Introduction</h3></div></div></div><p>
83 Mutt has a built-in line editor for inputting text, e.g. email
84 addresses or filenames. The keys used to manipulate text input are
85 very similar to those of Emacs. See <a href="#tab-keys-editor" title="Table 2.2. Most common line editor keys">Table 2.2, “Most common line editor keys”</a> for a full
86 reference of available functions, their default key bindings, and
90 </p><div class="table"><a id="tab-keys-editor"></a><p class="title"><b>Table 2.2. Most common line editor keys</b></p><div class="table-contents"><table summary="Most common line editor keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>^A or <Home></td><td>bol</td><td>move to the start of the line</td></tr><tr><td>^B or <Left></td><td>backward-char</td><td>move back one char</td></tr><tr><td>Esc B</td><td>backward-word</td><td>move back one word</td></tr><tr><td>^D or <Delete></td><td>delete-char</td><td>delete the char under the cursor</td></tr><tr><td>^E or <End></td><td>eol</td><td>move to the end of the line</td></tr><tr><td>^F or <Right></td><td>forward-char</td><td>move forward one char</td></tr><tr><td>Esc F</td><td>forward-word</td><td>move forward one word</td></tr><tr><td><Tab></td><td>complete</td><td>complete filename or alias</td></tr><tr><td>^T</td><td>complete-query</td><td>complete address with query</td></tr><tr><td>^K</td><td>kill-eol</td><td>delete to the end of the line</td></tr><tr><td>ESC d</td><td>kill-eow</td><td>delete to the end ot the word</td></tr><tr><td>^W</td><td>kill-word</td><td>kill the word in front of the cursor</td></tr><tr><td>^U</td><td>kill-line</td><td>delete entire line</td></tr><tr><td>^V</td><td>quote-char</td><td>quote the next typed key</td></tr><tr><td><Up></td><td>history-up</td><td>recall previous string from history</td></tr><tr><td><Down></td><td>history-down</td><td>recall next string from history</td></tr><tr><td><BackSpace></td><td>backspace</td><td>kill the char in front of the cursor</td></tr><tr><td>Esc u</td><td>upcase-word</td><td>convert word to upper case</td></tr><tr><td>Esc l</td><td>downcase-word</td><td>convert word to lower case</td></tr><tr><td>Esc c</td><td>capitalize-word</td><td>capitalize the word</td></tr><tr><td>^G</td><td>n/a</td><td>abort</td></tr><tr><td><Return></td><td>n/a</td><td>finish editing</td></tr></tbody></table></div></div><p><br class="table-break" />
93 You can remap the <span class="emphasis"><em>editor</em></span> functions using the
94 <a href="#bind" title="4. Changing the default key bindings">bind</a> command. For example, to make
95 the <span class="emphasis"><em>Delete</em></span> key delete the character in front of
96 the cursor rather than under, you could use
97 </p><pre class="screen">
98 bind editor <delete> backspace
99 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editing-history"></a>2.2. History</h3></div></div></div><p>
100 The number of items in the built-in editor's history is controlled by
101 the <a href="#history" title="3.77. history">$history</a> variable. You may
102 cycle through them at an editor prompt by using the
103 <code class="literal">history-up</code> and/or <code class="literal">history-down</code>
106 Mutt maintains several distinct history lists, one for each of the
107 following categories:
109 </p><div class="itemizedlist"><ul type="disc"><li><p>muttrc commands</p></li><li><p>addresses and aliases</p></li><li><p>shell commands</p></li><li><p>filenames</p></li><li><p>patterns</p></li><li><p>everything else</p></li></ul></div><p>
111 Mutt automatically filters out repeated items from the history. It
112 also mimics the behavior of some shells by ignoring items starting
115 The latter feature can be useful in macros to not clobber the history's
116 valuable entries with unwanted entries.
117 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="reading"></a>3. Reading Mail - The Index and Pager</h2></div></div></div><p>
118 Similar to many other mail clients, there are two modes in which mail is
119 read in Mutt. The first is the index of messages in the mailbox, which is
120 called the ``index'' in Mutt. The second mode is the display of the
121 message contents. This is called the ``pager.''
123 The next few sections describe the functions provided in each of these
125 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id449968"></a>3.1. The Message Index</h3></div></div></div><p>
126 Common keys used to navigate through and manage messages in the index
127 are shown in <a href="#tab-key-index" title="Table 2.3. Most common message index keys">Table 2.3, “Most common message index keys”</a>.
130 </p><div class="table"><a id="tab-key-index"></a><p class="title"><b>Table 2.3. Most common message index keys</b></p><div class="table-contents"><table summary="Most common message index keys" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody><tr><td>c</td><td>change to a different mailbox</td></tr><tr><td>ESC c</td><td>change to a folder in read-only mode</td></tr><tr><td>C</td><td>copy the current message to another mailbox</td></tr><tr><td>ESC C</td><td>decode a message and copy it to a folder</td></tr><tr><td>ESC s</td><td>decode a message and save it to a folder</td></tr><tr><td>D</td><td>delete messages matching a pattern</td></tr><tr><td>d</td><td>delete the current message</td></tr><tr><td>F</td><td>mark as important</td></tr><tr><td>l</td><td>show messages matching a pattern</td></tr><tr><td>N</td><td>mark message as new</td></tr><tr><td>o</td><td>change the current sort method</td></tr><tr><td>O</td><td>reverse sort the mailbox</td></tr><tr><td>q</td><td>save changes and exit</td></tr><tr><td>s</td><td>save-message</td></tr><tr><td>T</td><td>tag messages matching a pattern</td></tr><tr><td>t</td><td>toggle the tag on a message</td></tr><tr><td>ESC t</td><td>toggle tag on entire message thread</td></tr><tr><td>U</td><td>undelete messages matching a pattern</td></tr><tr><td>u</td><td>undelete-message</td></tr><tr><td>v</td><td>view-attachments</td></tr><tr><td>x</td><td>abort changes and exit</td></tr><tr><td><Return></td><td>display-message</td></tr><tr><td><Tab></td><td>jump to the next new or unread message</td></tr><tr><td>@</td><td>show the author's full e-mail address</td></tr><tr><td>$</td><td>save changes to mailbox</td></tr><tr><td>/</td><td>search</td></tr><tr><td>ESC /</td><td>search-reverse</td></tr><tr><td>^L</td><td>clear and redraw the screen</td></tr><tr><td>^T</td><td>untag messages matching a pattern</td></tr></tbody></table></div></div><p><br class="table-break" />
132 </p><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id450222"></a>3.1.1. Status Flags</h4></div></div></div><p>
133 In addition to who sent the message and the subject, a short summary of
134 the disposition of each message is printed beside the message number.
135 Zero or more of the following ``flags'' may appear, which mean:
137 </p><div class="variablelist"><dl><dt><span class="term">D</span></dt><dd><p>
138 message is deleted (is marked for deletion)
139 </p></dd><dt><span class="term">d</span></dt><dd><p>
140 message have attachments marked for deletion
141 </p></dd><dt><span class="term">K</span></dt><dd><p>
142 contains a PGP public key
143 </p></dd><dt><span class="term">N</span></dt><dd><p>
145 </p></dd><dt><span class="term">O</span></dt><dd><p>
147 </p></dd><dt><span class="term">P</span></dt><dd><p>
148 message is PGP encrypted
149 </p></dd><dt><span class="term">r</span></dt><dd><p>
150 message has been replied to
151 </p></dd><dt><span class="term">S</span></dt><dd><p>
152 message is signed, and the signature is successfully verified
153 </p></dd><dt><span class="term">s</span></dt><dd><p>
155 </p></dd><dt><span class="term">!</span></dt><dd><p>
157 </p></dd><dt><span class="term">*</span></dt><dd><p>
159 </p></dd></dl></div><p>
161 Some of the status flags can be turned on or off using
163 </p><div class="itemizedlist"><ul type="disc"><li><p>
164 <span class="bold"><strong>set-flag</strong></span> (default: w)
166 <span class="bold"><strong>clear-flag</strong></span> (default: W)
167 </p></li></ul></div><p>
170 Furthermore, the following flags reflect who the message is addressed
171 to. They can be customized with the
172 <a href="#to-chars" title="3.289. to_chars">$to_chars</a> variable.
174 </p><div class="variablelist"><dl><dt><span class="term">+</span></dt><dd><p>
175 message is to you and you only
176 </p></dd><dt><span class="term">T</span></dt><dd><p>
177 message is to you, but also to or cc'ed to others
178 </p></dd><dt><span class="term">C</span></dt><dd><p>
179 message is cc'ed to you
180 </p></dd><dt><span class="term">F</span></dt><dd><p>
182 </p></dd><dt><span class="term">L</span></dt><dd><p>
183 message is sent to a subscribed mailing list
184 </p></dd></dl></div><p>
185 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id450511"></a>3.2. The Pager</h3></div></div></div><p>
186 By default, Mutt uses its builtin pager to display the body of messages.
187 The pager is very similar to the Unix program <span class="emphasis"><em>less</em></span> though not nearly as
191 </p><div class="table"><a id="tab-key-pager"></a><p class="title"><b>Table 2.4. Most common pager keys</b></p><div class="table-contents"><table summary="Most common pager keys" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody><tr><td><Return></td><td>go down one line</td></tr><tr><td><Space></td><td>display the next page (or next message if at the end of a message)</td></tr><tr><td>-</td><td>go back to the previous page</td></tr><tr><td>n</td><td>search for next match</td></tr><tr><td>S</td><td>skip beyond quoted text</td></tr><tr><td>T</td><td>toggle display of quoted text</td></tr><tr><td>?</td><td>show keybindings</td></tr><tr><td>/</td><td>search for a regular expression (pattern)</td></tr><tr><td>ESC /</td><td>search backwards for a regular expression</td></tr><tr><td>\</td><td>toggle search pattern coloring</td></tr><tr><td>^</td><td>jump to the top of the message</td></tr></tbody></table></div></div><p><br class="table-break" />
194 In addition to key bindings in <a href="#tab-key-pager" title="Table 2.4. Most common pager keys">Table 2.4, “Most common pager keys”</a>,
195 many of the functions from the <span class="emphasis"><em>index</em></span> are available in
196 the pager, such as <span class="emphasis"><em>delete-message</em></span> or <span class="emphasis"><em>copy-message</em></span> (this is one
197 advantage over using an external pager to view messages).
199 Also, the internal pager supports a couple other advanced features. For
200 one, it will accept and translate the ``standard'' nroff sequences for
201 bold and underline. These sequences are a series of either the letter,
202 backspace (^H), the letter again for bold or the letter, backspace,
203 ``_'' for denoting underline. Mutt will attempt to display these
204 in bold and underline respectively if your terminal supports them. If
205 not, you can use the bold and underline <a href="#color" title="8. Using color and mono video attributes">color</a>
206 objects to specify a color or mono attribute for them.
208 Additionally, the internal pager supports the ANSI escape sequences for
209 character attributes. Mutt translates them into the correct color and
210 character settings. The sequences Mutt supports are
211 '\e[<span class="emphasis"><em>Ps</em></span>;<span class="emphasis"><em>Ps</em></span>;..<span class="emphasis"><em>Ps</em></span>;m'
212 where <span class="emphasis"><em>Ps</em></span> can be one of the codes shown in
213 <a href="#tab-ansi-esc" title="Table 2.5. ANSI escape sequences">Table 2.5, “ANSI escape sequences”</a>.
214 </p><div class="table"><a id="tab-ansi-esc"></a><p class="title"><b>Table 2.5. ANSI escape sequences</b></p><div class="table-contents"><table summary="ANSI escape sequences" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Escape code</th><th>Description</th></tr></thead><tbody><tr><td>0</td><td>All Attributes Off</td></tr><tr><td>1</td><td>Bold on</td></tr><tr><td>4</td><td>Underline on</td></tr><tr><td>5</td><td>Blink on</td></tr><tr><td>7</td><td>Reverse video on</td></tr><tr><td>3<span class="emphasis"><em><color></em></span></td><td>Foreground color is <span class="emphasis"><em><color></em></span> (see <a href="#tab-color" title="Table 2.6. Color sequences">Table 2.6, “Color sequences”</a>)</td></tr><tr><td>4<span class="emphasis"><em><color></em></span></td><td>Background color is <span class="emphasis"><em><color></em></span> (see <a href="#tab-color" title="Table 2.6. Color sequences">Table 2.6, “Color sequences”</a>)</td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="tab-color"></a><p class="title"><b>Table 2.6. Color sequences</b></p><div class="table-contents"><table summary="Color sequences" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Color code</th><th>Color</th></tr></thead><tbody><tr><td>0</td><td>Black</td></tr><tr><td>1</td><td>Red</td></tr><tr><td>2</td><td>Green</td></tr><tr><td>3</td><td>Yellow</td></tr><tr><td>4</td><td>Blue</td></tr><tr><td>5</td><td>Magenta</td></tr><tr><td>6</td><td>Cyan</td></tr><tr><td>7</td><td>White</td></tr></tbody></table></div></div><br class="table-break" /><p>
215 Mutt uses these attributes for handling text/enriched messages, and they
216 can also be used by an external <a href="#auto-view" title="4. MIME Autoview">autoview</a>
217 script for highlighting purposes. <span class="bold"><strong>Note:</strong></span> If you change the colors for your
218 display, for example by changing the color associated with color2 for
219 your xterm, then that color will be used instead of green.
220 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="threads"></a>3.3. Threaded Mode</h3></div></div></div><p>
221 When the mailbox is <a href="#sort" title="3.270. sort">sorted</a> by <span class="emphasis"><em>threads</em></span>, there are
222 a few additional functions available in the <span class="emphasis"><em>index</em></span> and <span class="emphasis"><em>pager</em></span> modes
223 as shown in <a href="#tab-key-threads" title="Table 2.7. Most common thread mode keys">Table 2.7, “Most common thread mode keys”</a>.
226 </p><div class="table"><a id="tab-key-threads"></a><p class="title"><b>Table 2.7. Most common thread mode keys</b></p><div class="table-contents"><table summary="Most common thread mode keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>^D</td><td>delete-thread</td><td>delete all messages in the current thread</td></tr><tr><td>^U</td><td>undelete-thread</td><td>undelete all messages in the current thread</td></tr><tr><td>^N</td><td>next-thread</td><td>jump to the start of the next thread</td></tr><tr><td>^P</td><td>previous-thread</td><td>jump to the start of the previous thread</td></tr><tr><td>^R</td><td>read-thread</td><td>mark the current thread as read</td></tr><tr><td>ESC d</td><td>delete-subthread</td><td>delete all messages in the current subthread</td></tr><tr><td>ESC u</td><td>undelete-subthread</td><td>undelete all messages in the current subthread</td></tr><tr><td>ESC n</td><td>next-subthread</td><td>jump to the start of the next subthread</td></tr><tr><td>ESC p</td><td>previous-subthread</td><td>jump to the start of the previous subthread</td></tr><tr><td>ESC r</td><td>read-subthread</td><td>mark the current subthread as read</td></tr><tr><td>ESC t</td><td>tag-thread</td><td>toggle the tag on the current thread</td></tr><tr><td>ESC v</td><td>collapse-thread</td><td>toggle collapse for the current thread</td></tr><tr><td>ESC V</td><td>collapse-all</td><td>toggle collapse for all threads</td></tr><tr><td>P</td><td>parent-message</td><td>jump to parent message in thread</td></tr></tbody></table></div></div><p><br class="table-break" />
229 <span class="bold"><strong>Note:</strong></span> Collapsing a thread displays only the first message
230 in the thread and hides the others. This is useful when threads
231 contain so many messages that you can only see a handful of threads on
232 the screen. See %M in <a href="#index-format" title="3.100. index_format">$index_format</a>.
233 For example, you could use "%?M?(#%03M)&(%4l)?" in <a href="#index-format" title="3.100. index_format">$index_format</a> to optionally
234 display the number of hidden messages if the thread is collapsed.
236 See also: <a href="#strict-threads" title="3.280. strict_threads">$strict_threads</a>.
237 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id451166"></a>3.4. Miscellaneous Functions</h3></div></div></div><p>
238 <span class="bold"><strong>create-alias</strong></span><a id="create-alias"></a> (default: a)
241 Creates a new alias based upon the current message (or prompts for a
242 new one). Once editing is complete, an <a href="#alias" title="3. Defining/Using aliases">alias</a>
243 command is added to the file specified by the <a href="#alias-file" title="3.3. alias_file">$alias_file</a> variable for future use. <span class="bold"><strong>Note:</strong></span>
244 Specifying an <a href="#alias-file" title="3.3. alias_file">$alias_file</a>
245 does not add the aliases specified there-in, you must also <a href="#source" title="27. Reading initialization commands from another file">source</a> the file.
247 <span class="bold"><strong>check-traditional-pgp</strong></span><a id="check-traditional-pgp"></a> (default: ESC P)
250 This function will search the current message for content signed or
251 encrypted with PGP the "traditional" way, that is, without proper
252 MIME tagging. Technically, this function will temporarily change
253 the MIME content types of the body parts containing PGP data; this
254 is similar to the <a href="#edit-type">edit-type</a> function's
257 <span class="bold"><strong>display-toggle-weed</strong></span><a id="display-toggle-weed"></a> (default: h)
260 Toggles the weeding of message header fields specified by <a href="#ignore" title="9. Ignoring (weeding) unwanted message headers">ignore</a> commands.
262 <span class="bold"><strong>edit</strong></span><a id="edit"></a> (default: e)
265 This command (available in the ``index'' and ``pager'') allows you to
266 edit the raw current message as it's present in the mail folder.
267 After you have finished editing, the changed message will be
268 appended to the current folder, and the original message will be
271 <span class="bold"><strong>edit-type</strong></span><a id="edit-type"></a>
273 (default: ^E on the attachment menu, and in the pager and index menus; ^T on the
276 This command is used to temporarily edit an attachment's content
277 type to fix, for instance, bogus character set parameters. When
278 invoked from the index or from the pager, you'll have the
279 opportunity to edit the top-level attachment's content type. On the
280 <a href="#attach-menu" title="1.2. The Attachment Menu">attachment menu</a>, you can change any
281 attachment's content type. These changes are not persistent, and get
282 lost upon changing folders.
284 Note that this command is also available on the <a href="#compose-menu" title="1.3. The Compose Menu">compose
285 menu</a>. There, it's used to fine-tune the properties of attachments you are going
288 <span class="bold"><strong>enter-command</strong></span><a id="enter-command"></a> (default: ``:'')
291 This command is used to execute any command you would normally put in a
292 configuration file. A common use is to check the settings of variables, or
293 in conjunction with <a href="#macro" title="7. Keyboard macros">macros</a> to change settings on the
296 <span class="bold"><strong>extract-keys</strong></span><a id="extract-keys"></a> (default: ^K)
299 This command extracts PGP public keys from the current or tagged
300 message(s) and adds them to your PGP public key ring.
302 <span class="bold"><strong>forget-passphrase</strong></span><a id="forget-passphrase"></a> (default:
306 This command wipes the passphrase(s) from memory. It is useful, if
307 you misspelled the passphrase.
309 <span class="bold"><strong>list-reply</strong></span><a id="list-reply"></a> (default: L)
312 Reply to the current or tagged message(s) by extracting any addresses which
313 match the regular expressions given by the <a href="#lists" title="11. Mailing lists">lists or subscribe</a>
314 commands, but also honor any <code class="literal">Mail-Followup-To</code> header(s) if the
315 <a href="#honor-followup-to" title="3.79. honor_followup_to">$honor_followup_to</a>
316 configuration variable is set. Using this when replying to messages posted
317 to mailing lists helps avoid duplicate copies being sent to the author of
318 the message you are replying to.
320 <span class="bold"><strong>pipe-message</strong></span><a id="pipe-message"></a> (default: |)
323 Asks for an external Unix command and pipes the current or
324 tagged message(s) to it. The variables <a href="#pipe-decode" title="3.211. pipe_decode">$pipe_decode</a>, <a href="#pipe-split" title="3.210. pipe_split">$pipe_split</a>,
325 <a href="#pipe-sep" title="3.212. pipe_sep">$pipe_sep</a> and <a href="#wait-key" title="3.299. wait_key">$wait_key</a> control the exact behavior of this function.
327 <span class="bold"><strong>resend-message</strong></span><a id="resend-message"></a> (default: ESC e)
330 With resend-message, mutt takes the current message as a template for a
331 new message. This function is best described as "recall from arbitrary
332 folders". It can conveniently be used to forward MIME messages while
333 preserving the original mail structure. Note that the amount of headers
334 included here depends on the value of the <a href="#weed" title="3.300. weed">$weed</a>
337 This function is also available from the attachment menu. You can use this
338 to easily resend a message which was included with a bounce message
339 as a message/rfc822 body part.
341 <span class="bold"><strong>shell-escape</strong></span><a id="shell-escape"></a> (default: !)
344 Asks for an external Unix command and executes it. The <a href="#wait-key" title="3.299. wait_key">$wait_key</a> can be used to control
345 whether Mutt will wait for a key to be pressed when the command returns
346 (presumably to let the user read the output of the command), based on
347 the return status of the named command.
349 <span class="bold"><strong>toggle-quoted</strong></span><a id="toggle-quoted"></a> (default: T)
352 The <span class="emphasis"><em>pager</em></span> uses the <a href="#quote-regexp" title="3.234. quote_regexp">$quote_regexp</a> variable to detect quoted text when
353 displaying the body of the message. This function toggles the display
354 of the quoted material in the message. It is particularly useful when
355 are interested in just the response and there is a large amount of
356 quoted text in the way.
358 <span class="bold"><strong>skip-quoted</strong></span><a id="skip-quoted"></a> (default: S)
361 This function will go to the next line of non-quoted text which come
362 after a line of quoted text in the internal pager.
363 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="sending"></a>4. Sending Mail</h2></div></div></div><p>
364 The bindings shown in <a href="#tab-key-send" title="Table 2.8. Most common mail sending keys">Table 2.8, “Most common mail sending keys”</a> are available in the
365 <span class="emphasis"><em>index</em></span> for sending messages.
368 </p><div class="table"><a id="tab-key-send"></a><p class="title"><b>Table 2.8. Most common mail sending keys</b></p><div class="table-contents"><table summary="Most common mail sending keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>m</td><td>compose</td><td>compose a new message</td></tr><tr><td>r</td><td>reply</td><td>reply to sender</td></tr><tr><td>g</td><td>group-reply</td><td>reply to all recipients</td></tr><tr><td>L</td><td>list-reply</td><td>reply to mailing list address</td></tr><tr><td>f</td><td>forward</td><td>forward message</td></tr><tr><td>b</td><td>bounce</td><td>bounce (remail) message</td></tr><tr><td>ESC k</td><td>mail-key</td><td>mail a PGP public key to someone</td></tr></tbody></table></div></div><p><br class="table-break" />
371 Bouncing a message sends the message as is to the recipient you
372 specify. Forwarding a message allows you to add comments or
373 modify the message you are forwarding. These items are discussed
374 in greater detail in the next chapter ``<a href="#forwarding-mail" title="5. Forwarding and Bouncing Mail">Forwarding
375 and Bouncing Mail</a>.''
377 Mutt will then enter the <span class="emphasis"><em>compose</em></span> menu and prompt you for the
378 recipients to place on the ``To:'' header field. Next, it will ask
379 you for the ``Subject:'' field for the message, providing a default if
380 you are replying to or forwarding a message. See also
381 <a href="#askcc" title="3.10. askcc">$askcc</a>,
382 <a href="#askbcc" title="3.9. askbcc">$askbcc</a>,
383 <a href="#autoedit" title="3.17. autoedit">$autoedit</a>,
384 <a href="#bounce" title="3.21. bounce">$bounce</a>,
385 <a href="#fast-reply" title="3.55. fast_reply">$fast_reply</a>,
386 and <a href="#include" title="3.97. include">$include</a>
387 for changing how Mutt asks these questions.
389 Mutt will then automatically start your <a href="#editor" title="3.51. editor">$editor</a> on the message body. If the <a href="#edit-headers" title="3.50. edit_headers">$edit_headers</a> variable is set, the headers will be at
390 the top of the message in your editor. Any messages you are replying
391 to will be added in sort order to the message, with appropriate <a href="#attribution" title="3.16. attribution">$attribution</a>, <a href="#indent-string" title="3.99. indent_string">$indent_string</a> and <a href="#post-indent-string" title="3.222. post_indent_string">$post_indent_string</a>. When forwarding a
392 message, if the <a href="#mime-forward" title="3.126. mime_forward">$mime_forward</a>
393 variable is unset, a copy of the forwarded message will be included. If
394 you have specified a <a href="#signature" title="3.262. signature">$signature</a>, it
395 will be appended to the message.
397 Once you have finished editing the body of your mail message, you are
398 returned to the <span class="emphasis"><em>compose</em></span> menu providing the functions
399 show in <a href="#tab-func-compose" title="Table 2.9. Most common compose menu keys">Table 2.9, “Most common compose menu keys”</a>.
402 </p><div class="table"><a id="tab-func-compose"></a><p class="title"><b>Table 2.9. Most common compose menu keys</b></p><div class="table-contents"><table summary="Most common compose menu keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>a</td><td>attach-file</td><td>attach a file</td></tr><tr><td>A</td><td>attach-message</td><td>attach message(s) to the message</td></tr><tr><td>ESC k</td><td>attach-key</td><td>attach a PGP public key</td></tr><tr><td>d</td><td>edit-description</td><td>edit description on attachment</td></tr><tr><td>D</td><td>detach-file</td><td>detach a file</td></tr><tr><td>t</td><td>edit-to</td><td>edit the To field</td></tr><tr><td>ESC f</td><td>edit-from</td><td>edit the From field</td></tr><tr><td>r</td><td>edit-reply-to</td><td>edit the Reply-To field</td></tr><tr><td>c</td><td>edit-cc</td><td>edit the Cc field</td></tr><tr><td>b</td><td>edit-bcc</td><td>edit the Bcc field</td></tr><tr><td>y</td><td>send-message</td><td>send the message</td></tr><tr><td>s</td><td>edit-subject</td><td>edit the Subject</td></tr><tr><td>S</td><td>smime-menu</td><td>select S/MIME options</td></tr><tr><td>f</td><td>edit-fcc</td><td>specify an ``Fcc'' mailbox</td></tr><tr><td>p</td><td>pgp-menu</td><td>select PGP options</td></tr><tr><td>P</td><td>postpone-message</td><td>postpone this message until later</td></tr><tr><td>q</td><td>quit</td><td>quit (abort) sending the message</td></tr><tr><td>w</td><td>write-fcc</td><td>write the message to a folder</td></tr><tr><td>i</td><td>ispell</td><td>check spelling (if available on your system)</td></tr><tr><td>^F</td><td>forget-passphrase</td><td>wipe passphrase(s) from memory</td></tr></tbody></table></div></div><p><br class="table-break" />
405 <span class="bold"><strong>Note:</strong></span> The attach-message function will prompt you for a folder to
406 attach messages from. You can now tag messages in that folder and they
407 will be attached to the message you are sending. Note that certain
408 operations like composing a new mail, replying, forwarding, etc. are
409 not permitted when you are in that folder. The %r in <a href="#status-format" title="3.278. status_format">$status_format</a> will change to
410 a 'A' to indicate that you are in attach-message mode.
411 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id452150"></a>4.1. Editing the message header</h3></div></div></div><p>
412 When editing the header of your outgoing message, there are a couple of
413 special features available.
417 <code class="literal">Fcc:</code> <span class="emphasis"><em>filename</em></span>
419 Mutt will pick up <span class="emphasis"><em>filename</em></span>
420 just as if you had used the <span class="emphasis"><em>edit-fcc</em></span> function in the <span class="emphasis"><em>compose</em></span> menu.
422 You can also attach files to your message by specifying
424 <code class="literal">Attach:</code> <span class="emphasis"><em>filename</em></span> [ <span class="emphasis"><em>description</em></span> ]
426 where <span class="emphasis"><em>filename</em></span> is the file to attach and <span class="emphasis"><em>description</em></span> is an
427 optional string to use as the description of the attached file.
429 When replying to messages, if you remove the <span class="emphasis"><em>In-Reply-To:</em></span> field from
430 the header field, Mutt will not generate a <span class="emphasis"><em>References:</em></span> field, which
431 allows you to create a new message thread.
433 Also see <a href="#edit-headers" title="3.50. edit_headers">$edit_headers</a>.
434 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id452237"></a>4.2. Using Mutt with PGP</h3></div></div></div><p>
435 If you want to use PGP, you can specify
437 <code class="literal">Pgp:</code> [ <code class="literal">E</code> | <code class="literal">S</code> | <code class="literal">S</code><span class="emphasis"><em><id></em></span> ]
440 ``E'' encrypts, ``S'' signs and
441 ``S<id>'' signs with the given key, setting <a href="#pgp-sign-as" title="3.162. pgp_sign_as">$pgp_sign_as</a> permanently.
443 If you have told mutt to PGP encrypt a message, it will guide you
444 through a key selection process when you try to send the message.
445 Mutt will not ask you any questions about keys which have a
446 certified user ID matching one of the message recipients' mail
447 addresses. However, there may be situations in which there are
448 several keys, weakly certified user ID fields, or where no matching
451 In these cases, you are dropped into a menu with a list of keys from
452 which you can select one. When you quit this menu, or mutt can't
453 find any matching keys, you are prompted for a user ID. You can, as
454 usually, abort this prompt using <code class="literal">^G</code>. When you do so, mutt will
455 return to the compose screen.
457 Once you have successfully finished the key selection, the message
458 will be encrypted using the selected public keys, and sent out.
460 Most fields of the entries in the key selection menu (see also <a href="#pgp-entry-format" title="3.154. pgp_entry_format">$pgp_entry_format</a>)
461 have obvious meanings. But some explanations on the capabilities, flags,
462 and validity fields are in order.
464 The flags sequence (%f) will expand to one of the flags in
465 <a href="#tab-pgp-menuflags" title="Table 2.10. PGP key menu flags">Table 2.10, “PGP key menu flags”</a>.
467 </p><div class="table"><a id="tab-pgp-menuflags"></a><p class="title"><b>Table 2.10. PGP key menu flags</b></p><div class="table-contents"><table summary="PGP key menu flags" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td>R</td><td>The key has been revoked and can't be used.</td></tr><tr><td>X</td><td>The key is expired and can't be used.</td></tr><tr><td>d</td><td>You have marked the key as disabled.</td></tr><tr><td>c</td><td>There are unknown critical self-signature packets.</td></tr></tbody></table></div></div><p><br class="table-break" />
470 The capabilities field (%c) expands to a two-character sequence
471 representing a key's capabilities. The first character gives
472 the key's encryption capabilities: A minus sign (<span class="bold"><strong>-</strong></span>) means
473 that the key cannot be used for encryption. A dot (<span class="bold"><strong>.</strong></span>) means that
474 it's marked as a signature key in one of the user IDs, but may
475 also be used for encryption. The letter <span class="bold"><strong>e</strong></span> indicates that
476 this key can be used for encryption.
478 The second character indicates the key's signing capabilities. Once
479 again, a ``<span class="bold"><strong>-</strong></span>'' implies ``not for signing'', ``<span class="bold"><strong>.</strong></span>'' implies
480 that the key is marked as an encryption key in one of the user-ids, and
481 ``<span class="bold"><strong>s</strong></span>'' denotes a key which can be used for signing.
483 Finally, the validity field (%t) indicates how well-certified a user-id
484 is. A question mark (<span class="bold"><strong>?</strong></span>) indicates undefined validity, a minus
485 character (<span class="bold"><strong>-</strong></span>) marks an untrusted association, a space character
486 means a partially trusted association, and a plus character (<span class="bold"><strong>+</strong></span>)
487 indicates complete validity.
488 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id452481"></a>4.3. Sending anonymous messages via mixmaster.</h3></div></div></div><p>
489 You may also have configured mutt to co-operate with Mixmaster, an
490 anonymous remailer. Mixmaster permits you to send your messages
491 anonymously using a chain of remailers. Mixmaster support in mutt is for
492 mixmaster version 2.04 (beta 45 appears to be the latest) and 2.03.
493 It does not support earlier versions or the later so-called version 3 betas,
494 of which the latest appears to be called 2.9b23.
496 To use it, you'll have to obey certain restrictions. Most
497 important, you cannot use the <code class="literal">Cc</code> and <code class="literal">Bcc</code> headers. To tell
498 Mutt to use mixmaster, you have to select a remailer chain, using
499 the mix function on the compose menu.
501 The chain selection screen is divided into two parts. In the
502 (larger) upper part, you get a list of remailers you may use. In
503 the lower part, you see the currently selected chain of remailers.
505 You can navigate in the chain using the <code class="literal">chain-prev</code> and
506 <code class="literal">chain-next</code> functions, which are by default bound to the left
507 and right arrows and to the <code class="literal">h</code> and <code class="literal">l</code> keys (think vi
508 keyboard bindings). To insert a remailer at the current chain
509 position, use the <code class="literal">insert</code> function. To append a remailer behind
510 the current chain position, use <code class="literal">select-entry</code> or <code class="literal">append</code>.
511 You can also delete entries from the chain, using the corresponding
512 function. Finally, to abandon your changes, leave the menu, or
513 <code class="literal">accept</code> them pressing (by default) the <code class="literal">Return</code> key.
515 Note that different remailers do have different capabilities,
516 indicated in the %c entry of the remailer menu lines (see
517 <a href="#mix-entry-format" title="3.129. mix_entry_format">$mix_entry_format</a>). Most important is
518 the ``middleman'' capability, indicated by a capital ``M'': This
519 means that the remailer in question cannot be used as the final
520 element of a chain, but will only forward messages to other
521 mixmaster remailers. For details on the other capabilities, please
522 have a look at the mixmaster documentation.
523 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id452606"></a>4.4. Sending format=flowed messages</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id452612"></a>4.4.1. Concept</h4></div></div></div><p>
524 <code class="literal">format=flowed</code>-style messages (or <code class="literal">f=f</code>
525 for short) are <code class="literal">text/plain</code> messages that consist of paragraphs which a receiver's
526 mail client may reformat to its own needs which mostly means to
527 customize line lengths regardless of what the sender sent. Technically this is
528 achieved by letting lines of a ``flowable'' paragraph end in spaces.
530 While for text-mode clients like mutt it's the best way to assume only a
531 standard 80x25 character cell terminal, it may be desired to let the
532 receiver decide completely how to view a message.
533 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id452650"></a>4.4.2. Mutt support</h4></div></div></div><p>
534 Mutt only supports setting the required <code class="literal">format=flowed</code>
535 MIME parameter on outgoing messages if the <a href="#text-flowed" title="3.282. text_flowed">$text_flowed</a> variable is set. It does not add the
536 trailing spaces nor does it provide any other feature related to
537 composing <code class="literal">f=f</code> messages (like reformatting
538 non-<code class="literal">f=f</code> parts of a reply to <code class="literal">f=f</code>
539 before calling the editor).
541 After editing the initial message text and before entering
542 the compose menu, mutt properly space-stuffes the message.
543 <span class="emphasis"><em>Space-stuffing</em></span> is required by RfC3676 defining
544 <code class="literal">format=flowed</code> and means to prepend a space to:
545 </p><div class="itemizedlist"><ul type="disc"><li><p>all lines starting with a space</p></li><li><p>lines starting with the word ``<code class="literal">From</code>''
546 followed by space</p></li><li><p>all lines starting with ``<code class="literal">></code>'' which
547 is not intended to be a quote character</p></li></ul></div><p>
548 All leading spaces are to be removed by receiving clients to restore
549 the original message.
551 <span class="bold"><strong>Note</strong></span> that mutt only support space-stuffing
552 for the first two types of lines but not for the third: It is impossible to
553 safely detect whether a leading <code class="literal">></code> character starts a
555 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id452764"></a>4.4.3. Editor considerations</h4></div></div></div><p>
556 As mutt provides no additional features to compose <code class="literal">f=f</code>
557 messages, it's completely up to the user and his editor to produce
558 proper messages. Please consider your editor's documentation if you
559 intend to send <code class="literal">f=f</code> messages.
561 Please note that when editing messages from the compose menu several
562 times before really sending a mail, it's up to the user to ensure that
563 the message is properly space-stuffed.
565 For example, <span class="emphasis"><em>vim</em></span> provides the <code class="literal">w</code>
566 flag for its <code class="literal">formatoptions</code> setting to assist in
567 creating <code class="literal">f=f</code> messages, see <code class="literal">:help
568 fo-table</code> for details.
569 </p></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="forwarding-mail"></a>5. Forwarding and Bouncing Mail</h2></div></div></div><p>
570 Bouncing and forwarding let you send an existing message to recipients
571 that you specify. Bouncing a message uses the <a href="#sendmail" title="3.257. sendmail">$sendmail</a> command to send a copy to alternative addresses as if
572 they were the message's original recipients. Forwarding a message, on
573 the other hand, allows you to modify the message before it is resent
574 (for example, by adding your own comments). The default key bindings
575 are shown in <a href="#tab-key-fwd" title="Table 2.11. Message forwarding/bouncing keys">Table 2.11, “Message forwarding/bouncing keys”</a>.
578 </p><div class="table"><a id="tab-key-fwd"></a><p class="title"><b>Table 2.11. Message forwarding/bouncing keys</b></p><div class="table-contents"><table summary="Message forwarding/bouncing keys" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Key</th><th>Function</th><th>Description</th></tr></thead><tbody><tr><td>f</td><td>forward</td><td>forward message</td></tr><tr><td>b</td><td>bounce</td><td>bounce (remail) message</td></tr></tbody></table></div></div><p><br class="table-break" />
581 Forwarding can be done by including the original message in the new
582 message's body (surrounded by indicating lines) or including it as a MIME
583 attachment, depending on the value of the <a href="#mime-forward" title="3.126. mime_forward">$mime_forward</a> variable. Decoding of attachments,
584 like in the pager, can be controlled by the <a href="#forward-decode" title="3.62. forward_decode">$forward_decode</a> and <a href="#mime-forward-decode" title="3.127. mime_forward_decode">$mime_forward_decode</a> variables,
585 respectively. The desired forwarding format may depend on the content,
586 therefore <span class="emphasis"><em>$mime_forward</em></span> is a quadoption which, for
587 example, can be set to ``ask-no''.
589 The inclusion of headers is controlled by the current setting of the
590 <a href="#weed" title="3.300. weed">$weed</a> variable, unless <a href="#mime-forward" title="3.126. mime_forward">$mime_forward</a> is set.
592 Editing the message to forward follows the same procedure as sending or
593 replying to a message does.
594 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="postponing-mail"></a>6. Postponing Mail</h2></div></div></div><p>
595 At times it is desirable to delay sending a message that you have
596 already begun to compose. When the <span class="emphasis"><em>postpone-message</em></span> function is
597 used in the <span class="emphasis"><em>compose</em></span> menu, the body of your message and attachments
598 are stored in the mailbox specified by the <a href="#postponed" title="3.224. postponed">$postponed</a> variable. This means that you can recall the
599 message even if you exit Mutt and then restart it at a later time.
601 Once a message is postponed, there are several ways to resume it. From the
602 command line you can use the ``-p'' option, or if you <span class="emphasis"><em>compose</em></span> a new
603 message from the <span class="emphasis"><em>index</em></span> or <span class="emphasis"><em>pager</em></span> you will be prompted if postponed
604 messages exist. If multiple messages are currently postponed, the
605 <span class="emphasis"><em>postponed</em></span> menu will pop up and you can select which message you would
608 <span class="bold"><strong>Note:</strong></span> If you postpone a reply to a message, the reply setting of
609 the message is only updated when you actually finish the message and
610 send it. Also, you must be in the same folder with the message you
611 replied to for the status of the message to be updated.
613 See also the <a href="#postpone" title="3.223. postpone">$postpone</a> quad-option.
614 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="configuration"></a>Chapter 3. Configuration</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#muttrc-syntax">1. Syntax of Initialization Files</a></span></dt><dt><span class="sect1"><a href="#addrgroup">2. Address groups</a></span></dt><dt><span class="sect1"><a href="#alias">3. Defining/Using aliases</a></span></dt><dt><span class="sect1"><a href="#bind">4. Changing the default key bindings</a></span></dt><dt><span class="sect1"><a href="#charset-hook">5. Defining aliases for character sets </a></span></dt><dt><span class="sect1"><a href="#folder-hook">6. Setting variables based upon mailbox</a></span></dt><dt><span class="sect1"><a href="#macro">7. Keyboard macros</a></span></dt><dt><span class="sect1"><a href="#color">8. Using color and mono video attributes</a></span></dt><dt><span class="sect1"><a href="#ignore">9. Ignoring (weeding) unwanted message headers</a></span></dt><dt><span class="sect1"><a href="#alternates">10. Alternative addresses</a></span></dt><dt><span class="sect1"><a href="#lists">11. Mailing lists</a></span></dt><dt><span class="sect1"><a href="#mbox-hook">12. Using Multiple spool mailboxes</a></span></dt><dt><span class="sect1"><a href="#mailboxes">13. Monitoring incoming mail</a></span></dt><dt><span class="sect1"><a href="#my-hdr">14. User defined headers</a></span></dt><dt><span class="sect1"><a href="#hdr-order">15. Defining the order of headers when viewing messages</a></span></dt><dt><span class="sect1"><a href="#save-hook">16. Specify default save mailbox</a></span></dt><dt><span class="sect1"><a href="#fcc-hook">17. Specify default Fcc: mailbox when composing</a></span></dt><dt><span class="sect1"><a href="#fcc-save-hook">18. Specify default save filename and default Fcc: mailbox at once</a></span></dt><dt><span class="sect1"><a href="#send-hook">19. Change settings based upon message recipients</a></span></dt><dt><span class="sect1"><a href="#message-hook">20. Change settings before formatting a message</a></span></dt><dt><span class="sect1"><a href="#crypt-hook">21. Choosing the cryptographic key of the recipient</a></span></dt><dt><span class="sect1"><a href="#push">22. Adding key sequences to the keyboard buffer</a></span></dt><dt><span class="sect1"><a href="#exec">23. Executing functions</a></span></dt><dt><span class="sect1"><a href="#score-command">24. Message Scoring</a></span></dt><dt><span class="sect1"><a href="#spam">25. Spam detection</a></span></dt><dt><span class="sect1"><a href="#set">26. Setting and Querying Variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="#set-commands">26.1. Commands</a></span></dt><dt><span class="sect2"><a href="#set-myvar">26.2. User-defined variables</a></span></dt></dl></dd><dt><span class="sect1"><a href="#source">27. Reading initialization commands from another file</a></span></dt><dt><span class="sect1"><a href="#unhook">28. Removing hooks</a></span></dt><dt><span class="sect1"><a href="#formatstrings">29. Format Strings</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id458133">29.1. Basic usage</a></span></dt><dt><span class="sect2"><a href="#id458263">29.2. Filters</a></span></dt></dl></dd></dl></div><p>
615 While the default configuration (or ``preferences'') make Mutt
616 usable right out of the box, it is often desirable to tailor Mutt to
617 suit your own tastes. When Mutt is first invoked, it will attempt to
618 read the ``system'' configuration file (defaults set by your local
619 system administrator), unless the ``-n'' <a href="#commandline" title="1. Command line options">command line</a> option is specified. This file is typically
620 <code class="literal">/usr/local/share/mutt/Muttrc</code> or <code class="literal">/etc/Muttrc</code>. Mutt
621 will next look for a file named <code class="literal">.muttrc</code> in your home
622 directory. If this file does not exist and your home directory has
623 a subdirectory named <code class="literal">.mutt</code>, mutt try to load a file named
624 <code class="literal">.mutt/muttrc</code>.
626 <code class="literal">.muttrc</code> is the file where you will usually place your <a href="#commands" title="2. Configuration Commands">commands</a> to configure Mutt.
628 In addition, mutt supports version specific configuration files that are
629 parsed instead of the default files as explained above. For instance, if
630 your system has a <code class="literal">Muttrc-0.88</code> file in the system configuration
631 directory, and you are running version 0.88 of mutt, this file will be
632 sourced instead of the <code class="literal">Muttrc</code> file. The same is true of the user
633 configuration file, if you have a file <code class="literal">.muttrc-0.88.6</code> in your home
634 directory, when you run mutt version 0.88.6, it will source this file
635 instead of the default <code class="literal">.muttrc</code> file. The version number is the
636 same which is visible using the ``-v'' <a href="#commandline" title="1. Command line options">command line</a> switch or using the <code class="literal">show-version</code> key (default:
637 V) from the index menu.
638 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="muttrc-syntax"></a>1. Syntax of Initialization Files</h2></div></div></div><p>
639 An initialization file consists of a series of <a href="#commands" title="2. Configuration Commands">commands</a>. Each line of the file may contain one or more commands.
640 When multiple commands are used, they must be separated by a semicolon (;).
642 </p><pre class="screen">
643 set realname='Mutt user' ; ignore x-
646 The hash mark, or pound sign
647 (``#''), is used as a ``comment'' character. You can use it to
648 annotate your initialization file. All text after the comment character
649 to the end of the line is ignored. For example,
652 </p><pre class="screen">
653 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
657 Single quotes (') and double quotes (") can be used to quote strings
658 which contain spaces or other special characters. The difference between
659 the two types of quotes is similar to that of many popular shell programs,
660 namely that a single quote is used to specify a literal string (one that is
661 not interpreted for shell variables or quoting with a backslash [see
662 next paragraph]), while double quotes indicate a string for which
663 should be evaluated. For example, backtics are evaluated inside of double
664 quotes, but <span class="bold"><strong>not</strong></span> for single quotes.
666 \ quotes the next character, just as in shells such as bash and zsh.
667 For example, if want to put quotes ``"'' inside of a string, you can use
668 ``\'' to force the next character to be a literal instead of interpreted
671 </p><pre class="screen">
672 set realname="Michael \"MuttDude\" Elkins"
676 ``\\'' means to insert a literal ``\'' into the line.
677 ``\n'' and ``\r'' have their usual C meanings of linefeed and
678 carriage-return, respectively.
680 A \ at the end of a line can be used to split commands over
681 multiple lines, provided that the split points don't appear in the
682 middle of command names.
684 It is also possible to substitute the output of a Unix command in an
685 initialization file. This is accomplished by enclosing the command in
686 backquotes (``). For example,
688 </p><pre class="screen">
689 my_hdr X-Operating-System: `uname -a`
692 The output of the Unix command ``uname -a'' will be substituted before the
693 line is parsed. Note that since initialization files are line oriented, only
694 the first line of output from the Unix command will be substituted.
696 Both environment variables and mutt variables can be accessed by
697 prepending ``$'' to the name of the variable. For example,
698 </p><pre class="screen">
699 set record=+sent_on_$HOSTNAME
701 will cause mutt to save outgoing messages to a folder named
702 ``sent_on_kremvax'' if the environment variable HOSTNAME is set to
703 ``kremvax.'' (See <a href="#record" title="3.239. record">$record</a> for
706 Mutt expands the variable when it is assigned, not when it is used. If
707 the value of a variable on the right-hand side of an assignment
708 changes after the assignment, the variable on the left-hand side will
711 The commands understood by mutt are explained in the next paragraphs.
712 For a complete list, see the <a href="#commands" title="2. Configuration Commands">command reference</a>.
713 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="addrgroup"></a>2. Address groups</h2></div></div></div><p>
714 Usage: <code class="literal">group</code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] [ <code class="literal">-rx</code> <span class="emphasis"><em>EXPR</em></span> [ ... ] ] [ <code class="literal">-addr</code> <span class="emphasis"><em>EXPR</em></span> [ ... ] ]
716 <code class="literal">group</code> is used to directly add either addresses or
717 regular expressions to the specified group or groups. The different
718 categories of arguments to the <code class="literal">group</code> command can be
719 in any order. The flags <code class="literal">-rx</code> and
720 <code class="literal">-addr</code> specify what the following strings (that cannot
721 begin with a hyphen) should be interpreted as: either a regular
722 expression or an email address, respectively.
724 These address groups can also be created implicitely by the
725 <a href="#alias" title="3. Defining/Using aliases">alias</a>, <a href="#lists" title="11. Mailing lists">lists</a>,
726 <a href="#lists" title="11. Mailing lists">subscribe</a> and
727 <a href="#alternates" title="10. Alternative addresses">alternates</a> commands by specifying the
728 optional <code class="literal">-group</code> option.
730 Once defined, these address groups can be used in
731 <a href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> to search for and limit the
732 display to messages matching a group.
734 Usage: <code class="literal">ungroup</code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] [ * | [ [ <code class="literal">-rx</code> <span class="emphasis"><em>EXPR</em></span> [ ... ] ] [ <code class="literal">-addr</code> <span class="emphasis"><em>EXPR</em></span> [ ... ] ] ]
736 <code class="literal">ungroup</code> is used to remove addresses or regular
737 expressions from the specified group or groups. The syntax is similar to
738 the <code class="literal">group</code> command, however the special character
739 <code class="literal">*</code> can be used to empty a group of all of its
741 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alias"></a>3. Defining/Using aliases</h2></div></div></div><p>
742 Usage: <code class="literal">alias</code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] <span class="emphasis"><em>key</em></span> <span class="emphasis"><em>address</em></span> [ , <span class="emphasis"><em>address</em></span>, ... ]
744 It's usually very cumbersome to remember or type out the address of someone
745 you are communicating with. Mutt allows you to create ``aliases'' which map
746 a short string to a full address.
748 <span class="bold"><strong>Note:</strong></span> if you want to create an alias for more than
749 one address, you <span class="bold"><strong>must</strong></span> separate the addresses with a comma (``,'').
751 The optional <code class="literal">-group</code> argument to
752 <code class="literal">alias</code> causes the aliased address(es) to be added to
753 the named <span class="emphasis"><em>group</em></span>.
755 To remove an alias or aliases (``*'' means all aliases):
757 <code class="literal">unalias</code> [ * | <span class="emphasis"><em>key</em></span> <span class="emphasis"><em>...</em></span> ]
760 </p><pre class="screen">
761 alias muttdude me@cs.hmc.edu (Michael Elkins)
762 alias theguys manny, moe, jack
766 Unlike other mailers, Mutt doesn't require aliases to be defined
767 in a special file. The <code class="literal">alias</code> command can appear anywhere in
768 a configuration file, as long as this file is <a href="#source" title="27. Reading initialization commands from another file">sourced</a>. Consequently, you can have multiple alias files, or
769 you can have all aliases defined in your muttrc.
771 On the other hand, the <a href="#create-alias">create-alias</a>
772 function can use only one file, the one pointed to by the <a href="#alias-file" title="3.3. alias_file">$alias_file</a> variable (which is
773 <code class="literal">˜/.muttrc</code> by default). This file is not special either,
774 in the sense that Mutt will happily append aliases to any file, but in
775 order for the new aliases to take effect you need to explicitly <a href="#source" title="27. Reading initialization commands from another file">source</a> this file too.
780 </p><pre class="screen">
781 source /usr/local/share/Mutt.aliases
782 source ~/.mail_aliases
783 set alias_file=~/.mail_aliases
787 To use aliases, you merely use the alias at any place in mutt where mutt
788 prompts for addresses, such as the <span class="emphasis"><em>To:</em></span> or <span class="emphasis"><em>Cc:</em></span> prompt. You can
789 also enter aliases in your editor at the appropriate headers if you have the
790 <a href="#edit-headers" title="3.50. edit_headers">$edit_headers</a> variable set.
792 In addition, at the various address prompts, you can use the tab character
793 to expand a partial alias to the full alias. If there are multiple matches,
794 mutt will bring up a menu with the matching aliases. In order to be
795 presented with the full list of aliases, you must hit tab with out a partial
796 alias, such as at the beginning of the prompt or after a comma denoting
799 In the alias menu, you can select as many aliases as you want with the
800 <span class="emphasis"><em>select-entry</em></span> key (default: RET), and use the <span class="emphasis"><em>exit</em></span> key
801 (default: q) to return to the address prompt.
802 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="bind"></a>4. Changing the default key bindings</h2></div></div></div><p>
803 Usage: <code class="literal">bind</code> <span class="emphasis"><em>map</em></span> <span class="emphasis"><em>key</em></span> <span class="emphasis"><em>function</em></span>
805 This command allows you to change the default key bindings (operation
806 invoked when pressing a key).
808 <span class="emphasis"><em>map</em></span> specifies in which menu the binding belongs. Multiple maps may
809 be specified by separating them with commas (no additional whitespace is
810 allowed). The currently defined maps are:
813 </p><div class="variablelist"><dl><dt><span class="term">generic</span></dt><dd><p>
814 This is not a real menu, but is used as a fallback for all of the other
815 menus except for the pager and editor modes. If a key is not defined in
816 another menu, Mutt will look for a binding to use in this menu. This allows
817 you to bind a key to a certain function in multiple menus instead of having
818 multiple bind statements to accomplish the same task.
819 </p></dd><dt><span class="term">alias</span></dt><dd><p>
820 The alias menu is the list of your personal aliases as defined in your
821 muttrc. It is the mapping from a short alias name to the full email
822 address(es) of the recipient(s).
823 </p></dd><dt><span class="term">attach</span></dt><dd><p>
824 The attachment menu is used to access the attachments on received messages.
825 </p></dd><dt><span class="term">browser</span></dt><dd><p>
826 The browser is used for both browsing the local directory structure, and for
827 listing all of your incoming mailboxes.
828 </p></dd><dt><span class="term">editor</span></dt><dd><p>
829 The editor is the line-based editor the user enters text data.
830 </p></dd><dt><span class="term">index</span></dt><dd><p>
831 The index is the list of messages contained in a mailbox.
832 </p></dd><dt><span class="term">compose</span></dt><dd><p>
833 The compose menu is the screen used when sending a new message.
834 </p></dd><dt><span class="term">pager</span></dt><dd><p>
835 The pager is the mode used to display message/attachment data, and help
837 </p></dd><dt><span class="term">pgp</span></dt><dd><p>
838 The pgp menu is used to select the OpenPGP keys used for encrypting outgoing
840 </p></dd><dt><span class="term">postpone</span></dt><dd><p>
841 The postpone menu is similar to the index menu, except is used when
842 recalling a message the user was composing, but saved until later.
843 </p></dd></dl></div><p>
845 <span class="emphasis"><em>key</em></span> is the key (or key sequence) you wish to bind. To specify a
846 control character, use the sequence <span class="emphasis"><em>\Cx</em></span>, where <span class="emphasis"><em>x</em></span> is the
847 letter of the control character (for example, to specify control-A use
848 ``\Ca''). Note that the case of <span class="emphasis"><em>x</em></span> as well as <span class="emphasis"><em>\C</em></span> is
849 ignored, so that <span class="emphasis"><em>\CA</em></span>, <span class="emphasis"><em>\Ca</em></span>, <span class="emphasis"><em>\cA</em></span> and <span class="emphasis"><em>\ca</em></span> are all
850 equivalent. An alternative form is to specify the key as a three digit
851 octal number prefixed with a ``\'' (for example <span class="emphasis"><em>\177</em></span> is
852 equivalent to <span class="emphasis"><em>\c?</em></span>). In addition, <span class="emphasis"><em>key</em></span> may
853 be a symbolic name as shown in <a href="#tab-key-names" title="Table 3.1. Symbolic key names">Table 3.1, “Symbolic key names”</a>.
856 </p><div class="table"><a id="tab-key-names"></a><p class="title"><b>Table 3.1. Symbolic key names</b></p><div class="table-contents"><table summary="Symbolic key names" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Symbolic name</th><th>Meaning</th></tr></thead><tbody><tr><td>\t</td><td>tab</td></tr><tr><td><tab></td><td>tab</td></tr><tr><td><backtab></td><td>backtab / shift-tab</td></tr><tr><td>\r</td><td>carriage return</td></tr><tr><td>\n</td><td>newline</td></tr><tr><td>\e</td><td>escape</td></tr><tr><td><esc></td><td>escape</td></tr><tr><td><up></td><td>up arrow</td></tr><tr><td><down></td><td>down arrow</td></tr><tr><td><left></td><td>left arrow</td></tr><tr><td><right></td><td>right arrow</td></tr><tr><td><pageup></td><td>Page Up</td></tr><tr><td><pagedown></td><td>Page Down</td></tr><tr><td><backspace></td><td>Backspace</td></tr><tr><td><delete></td><td>Delete</td></tr><tr><td><insert></td><td>Insert</td></tr><tr><td><enter></td><td>Enter</td></tr><tr><td><return></td><td>Return</td></tr><tr><td><home></td><td>Home</td></tr><tr><td><end></td><td>End</td></tr><tr><td><space></td><td>Space bar</td></tr><tr><td><f1></td><td>function key 1</td></tr><tr><td><f10></td><td>function key 10</td></tr></tbody></table></div></div><p><br class="table-break" />
859 <span class="emphasis"><em>key</em></span> does not need to be enclosed in quotes unless it contains a
862 <span class="emphasis"><em>function</em></span> specifies which action to take when <span class="emphasis"><em>key</em></span> is pressed.
863 For a complete list of functions, see the <a href="#functions" title="4. Functions">reference</a>. The special function <code class="literal">noop</code> unbinds the specified key
865 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="charset-hook"></a>5. Defining aliases for character sets </h2></div></div></div><p>
866 </p><div class="literallayout"><p><br />
867 Usage: <code class="literal">charset-hook</code> <span class="emphasis"><em>alias</em></span> <span class="emphasis"><em>charset</em></span><br />
868 Usage: <code class="literal">iconv-hook</code> <span class="emphasis"><em>charset</em></span> <span class="emphasis"><em>local-charset</em></span><br />
871 The <code class="literal">charset-hook</code> command defines an alias for a character set.
872 This is useful to properly display messages which are tagged with a
873 character set name not known to mutt.
875 The <code class="literal">iconv-hook</code> command defines a system-specific name for a
876 character set. This is helpful when your systems character
877 conversion library insists on using strange, system-specific names
879 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="folder-hook"></a>6. Setting variables based upon mailbox</h2></div></div></div><p>
880 Usage: <code class="literal">folder-hook</code> [!]<span class="emphasis"><em>regexp</em></span> <span class="emphasis"><em>command</em></span>
882 It is often desirable to change settings based on which mailbox you are
883 reading. The folder-hook command provides a method by which you can execute
884 any configuration command. <span class="emphasis"><em>regexp</em></span> is a regular expression specifying
885 in which mailboxes to execute <span class="emphasis"><em>command</em></span> before loading. If a mailbox
886 matches multiple folder-hook's, they are executed in the order given in the
889 <span class="bold"><strong>Note:</strong></span> if you use the ``!'' shortcut for <a href="#spoolfile" title="3.276. spoolfile">$spoolfile</a> at the beginning of the pattern, you must place it
890 inside of double or single quotes in order to distinguish it from the
891 logical <span class="emphasis"><em>not</em></span> operator for the expression.
893 Note that the settings are <span class="emphasis"><em>not</em></span> restored when you leave the mailbox.
894 For example, a command action to perform is to change the sorting method
895 based upon the mailbox being read:
898 </p><pre class="screen">
899 folder-hook mutt set sort=threads
903 However, the sorting method is not restored to its previous value when
904 reading a different mailbox. To specify a <span class="emphasis"><em>default</em></span> command, use the
908 </p><pre class="screen">
909 folder-hook . set sort=date-sent
912 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="macro"></a>7. Keyboard macros</h2></div></div></div><p>
913 Usage: <code class="literal">macro</code> <span class="emphasis"><em>menu</em></span> <span class="emphasis"><em>key</em></span> <span class="emphasis"><em>sequence</em></span> [ <span class="emphasis"><em>description</em></span> ]
915 Macros are useful when you would like a single key to perform a series of
916 actions. When you press <span class="emphasis"><em>key</em></span> in menu <span class="emphasis"><em>menu</em></span>, Mutt will behave as if
917 you had typed <span class="emphasis"><em>sequence</em></span>. So if you have a common sequence of commands
918 you type, you can create a macro to execute those commands with a single
921 <span class="emphasis"><em>menu</em></span> is the <a href="#maps">map</a> which the macro will be bound.
922 Multiple maps may be specified by separating multiple menu arguments by
923 commas. Whitespace may not be used in between the menu arguments and the
924 commas separating them.
926 <span class="emphasis"><em>key</em></span> and <span class="emphasis"><em>sequence</em></span> are expanded by the same rules as the <a href="#bind" title="4. Changing the default key bindings">key bindings</a>. There are some additions however. The
927 first is that control characters in <span class="emphasis"><em>sequence</em></span> can also be specified
928 as <span class="emphasis"><em>^x</em></span>. In order to get a caret (`^'') you need to use
929 <span class="emphasis"><em>^^</em></span>. Secondly, to specify a certain key such as <span class="emphasis"><em>up</em></span>
930 or to invoke a function directly, you can use the format
931 <span class="emphasis"><em><key name></em></span> and <span class="emphasis"><em><function name></em></span>. For a listing of key
932 names see the section on <a href="#bind" title="4. Changing the default key bindings">key bindings</a>. Functions
933 are listed in the <a href="#functions" title="4. Functions">reference</a>.
935 The advantage with using function names directly is that the macros will
936 work regardless of the current key bindings, so they are not dependent on
937 the user having particular key definitions. This makes them more robust
938 and portable, and also facilitates defining of macros in files used by more
939 than one user (e.g., the system Muttrc).
941 Optionally you can specify a descriptive text after <span class="emphasis"><em>sequence</em></span>,
942 which is shown in the help screens.
944 <span class="bold"><strong>Note:</strong></span> Macro definitions (if any) listed in the help screen(s), are
945 silently truncated at the screen width, and are not wrapped.
946 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="color"></a>8. Using color and mono video attributes</h2></div></div></div><p>
947 </p><div class="literallayout"><p><br />
948 Usage: <code class="literal">color</code> <span class="emphasis"><em>object</em></span> <span class="emphasis"><em>foreground</em></span> <span class="emphasis"><em>background</em></span> [ <span class="emphasis"><em>regexp</em></span> ]<br />
949 Usage: <code class="literal">color</code> index <span class="emphasis"><em>foreground</em></span> <span class="emphasis"><em>background</em></span> <span class="emphasis"><em>pattern</em></span><br />
950 Usage: <code class="literal">uncolor</code> index <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]<br />
953 If your terminal supports color, you can spice up Mutt by creating your own
954 color scheme. To define the color of an object (type of information), you
955 must specify both a foreground color <span class="bold"><strong>and</strong></span> a background color (it is not
956 possible to only specify one or the other).
958 <span class="emphasis"><em>object</em></span> can be one of:
961 </p><div class="itemizedlist"><ul type="disc"><li><p>
964 body (match <span class="emphasis"><em>regexp</em></span> in the body of messages)
966 bold (hiliting bold patterns in the body of messages)
968 error (error messages printed by Mutt)
970 header (match <span class="emphasis"><em>regexp</em></span> in the message header)
972 hdrdefault (default color of the message header in the pager)
974 index (match <span class="emphasis"><em>pattern</em></span> in the message index)
976 indicator (arrow or bar used to indicate the current item in a menu)
978 markers (the ``+'' markers at the beginning of wrapped lines in the pager)
980 message (informational messages)
984 quoted (text matching <a href="#quote-regexp" title="3.234. quote_regexp">$quote_regexp</a> in the body of a message)
986 quoted1, quoted2, ..., quoted<span class="bold"><strong>N</strong></span> (higher levels of quoting)
988 search (hiliting of words in the pager)
992 status (mode lines used to display info about the mailbox or message)
994 tilde (the ``˜'' used to pad blank lines in the pager)
996 tree (thread tree drawn in the message index and attachment menu)
998 underline (hiliting underlined patterns in the body of messages)
999 </p></li></ul></div><p>
1002 <span class="emphasis"><em>foreground</em></span> and <span class="emphasis"><em>background</em></span> can be one of the following:
1005 </p><div class="itemizedlist"><ul type="disc"><li><p>
1024 color<span class="emphasis"><em>x</em></span>
1025 </p></li></ul></div><p>
1028 <span class="emphasis"><em>foreground</em></span> can optionally be prefixed with the keyword <code class="literal">bright</code> to make
1029 the foreground color boldfaced (e.g., <code class="literal">brightred</code>).
1031 If your terminal supports it, the special keyword <span class="emphasis"><em>default</em></span> can be
1032 used as a transparent color. The value <span class="emphasis"><em>brightdefault</em></span> is also valid.
1033 If Mutt is linked against the <span class="emphasis"><em>S-Lang</em></span> library, you also need to set
1034 the <span class="emphasis"><em>COLORFGBG</em></span> environment variable to the default colors of your
1035 terminal for this to work; for example (for Bourne-like shells):
1038 </p><pre class="screen">
1039 set COLORFGBG="green;black"
1044 <span class="bold"><strong>Note:</strong></span> The <span class="emphasis"><em>S-Lang</em></span> library requires you to use the <span class="emphasis"><em>lightgray</em></span>
1045 and <span class="emphasis"><em>brown</em></span> keywords instead of <span class="emphasis"><em>white</em></span> and <span class="emphasis"><em>yellow</em></span> when
1046 setting this variable.
1048 <span class="bold"><strong>Note:</strong></span> The uncolor command can be applied to the index object only. It
1049 removes entries from the list. You <span class="bold"><strong>must</strong></span> specify the same pattern
1050 specified in the color command for it to be removed. The pattern ``*'' is
1051 a special token which means to clear the color index list of all entries.
1053 Mutt also recognizes the keywords <span class="emphasis"><em>color0</em></span>, <span class="emphasis"><em>color1</em></span>, …,
1054 <span class="emphasis"><em>color</em></span><span class="bold"><strong>N-1</strong></span> (<span class="bold"><strong>N</strong></span> being the number of colors supported
1055 by your terminal). This is useful when you remap the colors for your
1056 display (for example by changing the color associated with <span class="emphasis"><em>color2</em></span>
1057 for your xterm), since color names may then lose their normal meaning.
1059 If your terminal does not support color, it is still possible change the video
1060 attributes through the use of the ``mono'' command:
1062 </p><div class="literallayout"><p><br />
1063 Usage: <code class="literal">mono</code> <span class="emphasis"><em><object> <attribute></em></span> [ <span class="emphasis"><em>regexp</em></span> ]<br />
1064 Usage: <code class="literal">mono</code> index <span class="emphasis"><em>attribute</em></span> <span class="emphasis"><em>pattern</em></span><br />
1065 Usage: <code class="literal">unmono</code> index <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]<br />
1068 where <span class="emphasis"><em>attribute</em></span> is one of the following:
1071 </p><div class="itemizedlist"><ul type="disc"><li><p>
1081 </p></li></ul></div><p>
1083 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="ignore"></a>9. Ignoring (weeding) unwanted message headers</h2></div></div></div><p>
1084 Usage: <code class="literal">[un]ignore</code> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]
1086 Messages often have many header fields added by automatic processing systems,
1087 or which may not seem useful to display on the screen. This command allows
1088 you to specify header fields which you don't normally want to see.
1090 You do not need to specify the full header field name. For example,
1091 ``ignore content-'' will ignore all header fields that begin with the pattern
1092 ``content-''. ``ignore *'' will ignore all headers.
1094 To remove a previously added token from the list, use the ``unignore'' command.
1095 The ``unignore'' command will make Mutt display headers with the given pattern.
1096 For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''.
1098 ``unignore *'' will remove all tokens from the ignore list.
1102 </p><pre class="screen">
1103 # Sven's draconian header weeding
1105 unignore from date subject to cc
1106 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
1110 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alternates"></a>10. Alternative addresses</h2></div></div></div><p>
1111 Usage: <code class="literal">[un]alternates</code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] <span class="emphasis"><em>regexp</em></span> [ <span class="emphasis"><em>regexp</em></span> ... ]
1114 With various functions, mutt will treat messages differently,
1115 depending on whether you sent them or whether you received them from
1116 someone else. For instance, when replying to a message that you
1117 sent to a different party, mutt will automatically suggest to send
1118 the response to the original message's recipients -- responding to
1119 yourself won't make much sense in many cases. (See <a href="#reply-to" title="3.242. reply_to">$reply_to</a>.)
1121 Many users receive e-mail under a number of different addresses. To
1122 fully use mutt's features here, the program must be able to
1123 recognize what e-mail addresses you receive mail under. That's the
1124 purpose of the <code class="literal">alternates</code> command: It takes a list of regular
1125 expressions, each of which can identify an address under which you
1128 As addresses are matched using regular expressions and not exact strict
1129 comparisons, you should make sure you specify your addresses as precise
1130 as possible to avoid mismatches. For example, if you specify:
1131 </p><pre class="screen">
1132 alternates user@example
1134 mutt will consider ``<code class="literal">some-user@example</code>'' as
1135 being your address, too which may not be desired. As a solution, in such
1136 cases addresses should be specified as:
1137 </p><pre class="screen">
1138 alternates '^user@example$'
1140 The <code class="literal">-group</code> flag causes all of the subsequent regular expressions
1141 to be added to the named group.
1143 The <code class="literal">unalternates</code> command can be used to write exceptions to
1144 <code class="literal">alternates</code> patterns. If an address matches something in an
1145 <code class="literal">alternates</code> command, but you nonetheless do not think it is
1146 from you, you can list a more precise pattern under an <code class="literal">unalternates</code>
1149 To remove a regular expression from the <code class="literal">alternates</code> list, use the
1150 <code class="literal">unalternates</code> command with exactly the same <span class="emphasis"><em>regexp</em></span>.
1151 Likewise, if the <span class="emphasis"><em>regexp</em></span> for an <code class="literal">alternates</code> command matches
1152 an entry on the <code class="literal">unalternates</code> list, that <code class="literal">unalternates</code>
1153 entry will be removed. If the <span class="emphasis"><em>regexp</em></span> for <code class="literal">unalternates</code>
1154 is ``*'', <span class="emphasis"><em>all entries</em></span> on <code class="literal">alternates</code> will be removed.
1155 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="lists"></a>11. Mailing lists</h2></div></div></div><p>
1156 </p><div class="literallayout"><p><br />
1157 Usage: <code class="literal">[un]lists</code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] <span class="emphasis"><em>regexp</em></span> [ <span class="emphasis"><em>regexp</em></span> ... ]<br />
1158 Usage: <code class="literal">[un]subscribe</code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] <span class="emphasis"><em>regexp</em></span> [ <span class="emphasis"><em>regexp</em></span> ... ]<br />
1161 Mutt has a few nice features for <a href="#using-lists" title="8. Handling Mailing Lists">handling mailing lists</a>. In order to take advantage of them, you must
1162 specify which addresses belong to mailing lists, and which mailing
1163 lists you are subscribed to. Once you have done this, the <a href="#list-reply">list-reply</a> function will work for all known lists.
1164 Additionally, when you send a message to a subscribed list, mutt will
1165 add a Mail-Followup-To header to tell other users' mail user agents
1166 not to send copies of replies to your personal address. Note that
1167 the Mail-Followup-To header is a non-standard extension which is not
1168 supported by all mail user agents. Adding it is not bullet-proof against
1169 receiving personal CCs of list messages. Also note that the generation
1170 of the Mail-Followup-To header is controlled by the <a href="#followup-to" title="3.60. followup_to">$followup_to</a> configuration variable.
1172 More precisely, Mutt maintains lists of patterns for the addresses
1173 of known and subscribed mailing lists. Every subscribed mailing
1174 list is known. To mark a mailing list as known, use the ``lists''
1175 command. To mark it as subscribed, use ``subscribe''.
1177 You can use regular expressions with both commands. To mark all
1178 messages sent to a specific bug report's address on mutt's bug
1179 tracking system as list mail, for instance, you could say
1180 ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
1181 give a portion of the list's e-mail address.
1183 Specify as much of the address as you need to to remove ambiguity. For
1184 example, if you've subscribed to the Mutt mailing list, you will receive mail
1185 addressed to <span class="emphasis"><em>mutt-users@mutt.org</em></span>. So, to tell Mutt
1186 that this is a mailing list, you could add ``lists mutt-users@'' to your
1187 initialization file. To tell mutt that you are subscribed to it,
1188 add ``subscribe mutt-users'' to your initialization file instead.
1189 If you also happen to get mail from someone whose address is
1190 <span class="emphasis"><em>mutt-users@example.com</em></span>, you could use
1191 ``lists ^mutt-users@mutt\\.org$''
1192 or ``subscribe ^mutt-users@mutt\\.org$'' to
1193 match only mail from the actual list.
1195 The <code class="literal">-group</code> flag adds all of the subsequent regular expressions
1198 The ``unlists'' command is used to remove a token from the list of
1199 known and subscribed mailing-lists. Use ``unlists *'' to remove all
1202 To remove a mailing list from the list of subscribed mailing lists,
1203 but keep it on the list of known mailing lists, use ``unsubscribe''.
1204 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mbox-hook"></a>12. Using Multiple spool mailboxes</h2></div></div></div><p>
1205 Usage: <code class="literal">mbox-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
1207 This command is used to move read messages from a specified mailbox to a
1208 different mailbox automatically when you quit or change folders.
1209 <span class="emphasis"><em>pattern</em></span> is a regular expression specifying the mailbox to treat as a
1210 ``spool'' mailbox and <span class="emphasis"><em>mailbox</em></span> specifies where mail should be saved when
1213 Unlike some of the other <span class="emphasis"><em>hook</em></span> commands, only the <span class="emphasis"><em>first</em></span> matching
1214 pattern is used (it is not possible to save read mail in more than a single
1216 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailboxes"></a>13. Monitoring incoming mail</h2></div></div></div><p>
1217 Usage: <code class="literal">[un]mailboxes</code> <span class="emphasis"><em>folder</em></span> [ <span class="emphasis"><em>folder</em></span> ... ]
1219 This command specifies folders which can receive mail and
1220 which will be checked for new messages. By default, the
1221 main menu status bar displays how many of these folders have
1224 <code class="literal">folder</code> can either be a local file or directory
1225 (Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP
1226 support, <code class="literal">folder</code> can also be a POP/IMAP folder
1227 URL. The URL syntax is described in <a href="#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a>,
1228 POP and IMAP are described in <a href="#pop" title="3. POP3 Support">Section 3, “POP3 Support”</a> and <a href="#imap" title="4. IMAP Support">Section 4, “IMAP Support”</a>
1231 When changing folders, pressing <span class="emphasis"><em>space</em></span> will cycle
1232 through folders with new mail.
1234 Pressing TAB in the directory browser will bring up a menu showing the files
1235 specified by the <code class="literal">mailboxes</code> command, and indicate which contain new
1236 messages. Mutt will automatically enter this mode when invoked from the
1237 command line with the <code class="literal">-y</code> option.
1239 The ``unmailboxes'' command is used to remove a token from the list
1240 of folders which receive mail. Use ``unmailboxes *'' to remove all
1243 <span class="bold"><strong>Note:</strong></span> the folders in the <code class="literal">mailboxes</code> command are resolved when
1244 the command is executed, so if these names contain <a href="#shortcuts" title="7. Mailbox Shortcuts">shortcut characters</a> (such as ``='' and ``!''), any variable
1245 definition that affect these characters (like <a href="#folder" title="3.58. folder">$folder</a> and <a href="#spoolfile" title="3.276. spoolfile">$spoolfile</a>)
1246 should be executed before the <code class="literal">mailboxes</code> command. If
1247 none of these shorcuts are used, a local path should be absolute as
1248 otherwise mutt tries to find it within the current working directory
1249 from where mutt was started which may not always be desired.
1251 For local folders, new mail is detected by comparing access and/or
1252 modification times of files and folders. The interval in which Mutt
1253 checks for new mail is defined by
1254 <a href="#mail-check" title="3.104. mail_check">$mail_check</a>.
1256 Special care is required with Mbox and Mmdf
1257 folders as Mutt assumes such a folder has new mail if it wasn't
1258 accessed after it was last modified. Utilities like <code class="literal">biff</code> or
1259 <code class="literal">frm</code> or any other program which accesses the mailbox might cause
1260 Mutt to never detect new mail for that mailbox if they do not properly reset the
1261 access time. Backup tools are another common reason for updated access times.
1262 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="my-hdr"></a>14. User defined headers</h2></div></div></div><p>
1265 <code class="literal">my_hdr</code> <span class="emphasis"><em>string</em></span>
1267 <code class="literal">unmy_hdr</code> <span class="emphasis"><em>field</em></span> [ <span class="emphasis"><em>field</em></span> ... ]
1269 The ``my_hdr'' command allows you to create your own header
1270 fields which will be added to every message you send.
1272 For example, if you would like to add an ``Organization:'' header field to
1273 all of your outgoing messages, you can put the command
1275 “<span class="quote">my_hdr Organization: A Really Big Company, Anytown, USA</span>”
1277 in your <code class="literal">.muttrc</code>.
1279 <span class="bold"><strong>Note:</strong></span> space characters are <span class="emphasis"><em>not</em></span> allowed between the keyword and
1280 the colon (``:''). The standard for electronic mail (RFC822) says that
1281 space is illegal there, so Mutt enforces the rule.
1283 If you would like to add a header field to a single message, you should
1284 either set the <a href="#edit-headers" title="3.50. edit_headers">$edit_headers</a> variable,
1285 or use the <span class="emphasis"><em>edit-headers</em></span> function (default: ``E'') in the send-menu so
1286 that you can edit the header of your message along with the body.
1288 To remove user defined header fields, use the ``unmy_hdr''
1289 command. You may specify an asterisk (``*'') to remove all header
1290 fields, or the fields to remove. For example, to remove all ``To'' and
1291 ``Cc'' header fields, you could use:
1293 “<span class="quote">unmy_hdr to cc</span>”
1294 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="hdr-order"></a>15. Defining the order of headers when viewing messages</h2></div></div></div><p>
1295 Usage: <code class="literal">hdr_order</code> <span class="emphasis"><em>header1</em></span> <span class="emphasis"><em>header2</em></span> <span class="emphasis"><em>header3</em></span>
1297 With this command, you can specify an order in which mutt will attempt
1298 to present headers to you when viewing messages.
1300 ``unhdr_order *'' will clear all previous headers from the order list,
1301 thus removing the header order effects set by the system-wide startup
1305 </p><pre class="screen">
1306 hdr_order From Date: From: To: Cc: Subject:
1309 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="save-hook"></a>16. Specify default save mailbox</h2></div></div></div><p>
1310 Usage: <code class="literal">save-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
1312 This command is used to override the default mailbox used when saving
1313 messages. <span class="emphasis"><em>mailbox</em></span> will be used as the default if the message
1314 matches <span class="emphasis"><em>pattern</em></span>, see <a href="#pattern-hook">Message Matching in Hooks</a> for information
1315 on the exact format.
1317 To provide more flexibility and good defaults, Mutt applies the
1318 expandos of <a href="#index-format" title="3.100. index_format">$index_format</a> to
1319 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
1324 </p><pre class="screen">
1325 # default: save all to ~/Mail/<author name>
1326 save-hook . ~/Mail/%F
1327 # save from me@turing.cs.hmc.edu/me@cs.hmc.edu to $folder/elinks
1328 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
1329 # save from aol.com to $folder/spam
1330 save-hook aol\\.com$ +spam
1334 Also see the <a href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a> command.
1335 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="fcc-hook"></a>17. Specify default Fcc: mailbox when composing</h2></div></div></div><p>
1336 Usage: <code class="literal">fcc-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
1338 This command is used to save outgoing mail in a mailbox other than
1339 <a href="#record" title="3.239. record">$record</a>. Mutt searches the initial list of
1340 message recipients for the first matching <span class="emphasis"><em>regexp</em></span> and uses <span class="emphasis"><em>mailbox</em></span>
1341 as the default Fcc: mailbox. If no match is found the message will be saved
1342 to <a href="#record" title="3.239. record">$record</a> mailbox.
1344 To provide more flexibility and good defaults, Mutt applies the
1345 expandos of <a href="#index-format" title="3.100. index_format">$index_format</a> to
1346 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
1348 See <a href="#pattern-hook">Message Matching in Hooks</a> for information on the exact format of <span class="emphasis"><em>pattern</em></span>.
1350 Example: <code class="literal">fcc-hook [@.]aol\\.com$ +spammers</code>
1352 The above will save a copy of all messages going to the aol.com domain to
1353 the `+spammers' mailbox by default. Also see the <a href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a> command.
1354 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="fcc-save-hook"></a>18. Specify default save filename and default Fcc: mailbox at once</h2></div></div></div><p>
1355 Usage: <code class="literal">fcc-save-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
1357 This command is a shortcut, equivalent to doing both a <a href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a>
1358 and a <a href="#save-hook" title="16. Specify default save mailbox">save-hook</a> with its arguments,
1359 including %-expansion on <span class="emphasis"><em>mailbox</em></span> according
1360 to <a href="#index-format" title="3.100. index_format">$index_format</a>.
1361 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="send-hook"></a>19. Change settings based upon message recipients</h2></div></div></div><p>
1362 </p><div class="literallayout"><p><br />
1363 Usage: <code class="literal">reply-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span><br />
1364 Usage: <code class="literal">send-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span><br />
1365 Usage: <code class="literal">send2-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span><br />
1368 These commands can be used to execute arbitrary configuration commands based
1369 upon recipients of the message. <span class="emphasis"><em>pattern</em></span> is a regular expression
1370 matching the desired address. <span class="emphasis"><em>command</em></span> is executed when <span class="emphasis"><em>regexp</em></span>
1371 matches recipients of the message.
1373 <code class="literal">reply-hook</code> is matched against the message you are <span class="emphasis"><em>replying</em></span>
1374 <span class="bold"><strong>to</strong></span>, instead of the message you are <span class="emphasis"><em>sending</em></span>. <code class="literal">send-hook</code> is
1375 matched against all messages, both <span class="emphasis"><em>new</em></span> and <span class="emphasis"><em>replies</em></span>. <span class="bold"><strong>Note:</strong></span>
1376 <code class="literal">reply-hook</code>s are matched <span class="bold"><strong>before</strong></span> the <code class="literal">send-hook</code>, <span class="bold"><strong>regardless</strong></span>
1377 of the order specified in the user's configuration file.
1379 <code class="literal">send2-hook</code> is matched every time a message is changed, either
1380 by editing it, or by using the compose menu to change its recipients
1381 or subject. <code class="literal">send2-hook</code> is executed after <code class="literal">send-hook</code>, and
1382 can, e.g., be used to set parameters such as the <a href="#sendmail" title="3.257. sendmail">$sendmail</a> variable depending on the message's sender
1385 For each type of <code class="literal">send-hook</code> or <code class="literal">reply-hook</code>, when multiple matches
1386 occur, commands are executed in the order they are specified in the muttrc
1387 (for that type of hook).
1389 See <a href="#pattern-hook">Message Matching in Hooks</a> for information on the exact format of <span class="emphasis"><em>pattern</em></span>.
1391 Example: <code class="literal">send-hook mutt "set mime_forward signature=''"</code>
1393 Another typical use for this command is to change the values of the
1394 <a href="#attribution" title="3.16. attribution">$attribution</a>, <a href="#signature" title="3.262. signature">$signature</a> and <a href="#locale" title="3.103. locale">$locale</a>
1395 variables in order to change the language of the attributions and
1396 signatures based upon the recipients.
1398 <span class="bold"><strong>Note:</strong></span> the send-hook's are only executed ONCE after getting the initial
1399 list of recipients. Adding a recipient after replying or editing the
1400 message will NOT cause any send-hook to be executed. Also note that
1401 my_hdr commands which modify recipient headers, or the message's
1402 subject, don't have any effect on the current message when executed
1404 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="message-hook"></a>20. Change settings before formatting a message</h2></div></div></div><p>
1405 Usage: <code class="literal">message-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span>
1407 This command can be used to execute arbitrary configuration commands
1408 before viewing or formatting a message based upon information about the message.
1409 <span class="emphasis"><em>command</em></span> is executed if the <span class="emphasis"><em>pattern</em></span> matches the message to be
1410 displayed. When multiple matches occur, commands are executed in the order
1411 they are specified in the muttrc.
1413 See <a href="#pattern-hook">Message Matching in Hooks</a> for
1414 information on the exact format of <span class="emphasis"><em>pattern</em></span>.
1418 </p><pre class="screen">
1419 message-hook ~A 'set pager=builtin'
1420 message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
1423 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="crypt-hook"></a>21. Choosing the cryptographic key of the recipient</h2></div></div></div><p>
1424 Usage: <code class="literal">crypt-hook</code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>keyid</em></span>
1426 When encrypting messages with PGP or OpenSSL, you may want to associate a certain
1427 key with a given e-mail address automatically, either because the
1428 recipient's public key can't be deduced from the destination address,
1429 or because, for some reasons, you need to override the key Mutt would
1430 normally use. The crypt-hook command provides a method by which you can
1431 specify the ID of the public key to be used when encrypting messages to
1432 a certain recipient.
1434 The meaning of "key id" is to be taken broadly in this context: You
1435 can either put a numerical key ID here, an e-mail address, or even
1437 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="push"></a>22. Adding key sequences to the keyboard buffer</h2></div></div></div><p>
1438 Usage: <code class="literal">push</code> <span class="emphasis"><em>string</em></span>
1440 This command adds the named string to the keyboard buffer. The string may
1441 contain control characters, key names and function names like the sequence
1442 string in the <a href="#macro" title="7. Keyboard macros">macro</a> command. You may use it to
1443 automatically run a sequence of commands at startup, or when entering
1444 certain folders. For example, the following command will automatically
1445 collapse all threads when entering a folder:
1447 </p><pre class="screen">
1448 folder-hook . 'push <collapse-all>'
1450 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="exec"></a>23. Executing functions</h2></div></div></div><p>
1451 Usage: <code class="literal">exec</code> <span class="emphasis"><em>function</em></span> [ <span class="emphasis"><em>function</em></span> ... ]
1453 This command can be used to execute any function. Functions are
1454 listed in the <a href="#functions" title="4. Functions">function reference</a>.
1455 ``exec function'' is equivalent to ``push <function>''.
1456 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="score-command"></a>24. Message Scoring</h2></div></div></div><p>
1457 </p><div class="literallayout"><p><br />
1458 Usage: <code class="literal">score</code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>value</em></span><br />
1459 Usage: <code class="literal">unscore</code> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]<br />
1462 The <code class="literal">score</code> commands adds <span class="emphasis"><em>value</em></span> to a message's score if <span class="emphasis"><em>pattern</em></span>
1463 matches it. <span class="emphasis"><em>pattern</em></span> is a string in the format described in the <a href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> section (note: For efficiency reasons, patterns
1464 which scan information not available in the index, such as <code class="literal">˜b</code>,
1465 <code class="literal">˜B</code> or <code class="literal">˜h</code>, may not be used). <span class="emphasis"><em>value</em></span> is a
1466 positive or negative integer. A message's final score is the sum total of all
1467 matching <code class="literal">score</code> entries. However, you may optionally prefix <span class="emphasis"><em>value</em></span> with
1468 an equal sign (=) to cause evaluation to stop at a particular entry if there is
1469 a match. Negative final scores are rounded up to 0.
1471 The <code class="literal">unscore</code> command removes score entries from the list. You <span class="bold"><strong>must</strong></span>
1472 specify the same pattern specified in the <code class="literal">score</code> command for it to be
1473 removed. The pattern ``*'' is a special token which means to clear the list
1474 of all score entries.
1475 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="spam"></a>25. Spam detection</h2></div></div></div><p>
1476 </p><div class="literallayout"><p><br />
1477 Usage: <code class="literal">spam</code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>format</em></span><br />
1478 Usage: <code class="literal">nospam</code> <span class="emphasis"><em>pattern</em></span><br />
1481 Mutt has generalized support for external spam-scoring filters.
1482 By defining your spam patterns with the <code class="literal">spam</code> and <code class="literal">nospam</code>
1483 commands, you can <span class="emphasis"><em>limit</em></span>, <span class="emphasis"><em>search</em></span>, and <span class="emphasis"><em>sort</em></span> your
1484 mail based on its spam attributes, as determined by the external
1485 filter. You also can display the spam attributes in your index
1486 display using the <code class="literal">%H</code> selector in the <a href="#index-format" title="3.100. index_format">$index_format</a> variable. (Tip: try <code class="literal">%?H?[%H] ?</code>
1487 to display spam tags only when they are defined for a given message.)
1489 Your first step is to define your external filter's spam patterns using
1490 the <code class="literal">spam</code> command. <span class="emphasis"><em>pattern</em></span> should be a regular expression
1491 that matches a header in a mail message. If any message in the mailbox
1492 matches this regular expression, it will receive a ``spam tag'' or
1493 ``spam attribute'' (unless it also matches a <code class="literal">nospam</code> pattern -- see
1494 below.) The appearance of this attribute is entirely up to you, and is
1495 governed by the <span class="emphasis"><em>format</em></span> parameter. <span class="emphasis"><em>format</em></span> can be any static
1496 text, but it also can include back-references from the <span class="emphasis"><em>pattern</em></span>
1497 expression. (A regular expression ``back-reference'' refers to a
1498 sub-expression contained within parentheses.) <code class="literal">%1</code> is replaced with
1499 the first back-reference in the regex, <code class="literal">%2</code> with the second, etc.
1501 If you're using multiple spam filters, a message can have more than
1502 one spam-related header. You can define <code class="literal">spam</code> patterns for each
1503 filter you use. If a message matches two or more of these patterns, and
1504 the $spam_separator variable is set to a string, then the
1505 message's spam tag will consist of all the <span class="emphasis"><em>format</em></span> strings joined
1506 together, with the value of $spam_separator separating
1509 For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
1510 define these spam settings:
1512 </p><pre class="screen">
1513 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
1514 spam "X-Spam-Status: Yes" "90+/SA"
1515 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
1516 set spam_separator=", "
1520 If I then received a message that DCC registered with ``many'' hits
1521 under the ``Fuz2'' checksum, and that PureMessage registered with a
1522 97% probability of being spam, that message's spam tag would read
1523 <code class="literal">90+/DCC-Fuz2, 97/PM</code>. (The four characters before ``=many'' in a
1524 DCC report indicate the checksum used -- in this case, ``Fuz2''.)
1526 If the $spam_separator variable is unset, then each
1527 spam pattern match supersedes the previous one. Instead of getting
1528 joined <span class="emphasis"><em>format</em></span> strings, you'll get only the last one to match.
1530 The spam tag is what will be displayed in the index when you use
1531 <code class="literal">%H</code> in the <code class="literal">$index_format</code> variable. It's also the
1532 string that the <code class="literal">˜H</code> pattern-matching expression matches against for
1533 <span class="emphasis"><em>search</em></span> and <span class="emphasis"><em>limit</em></span> functions. And it's what sorting by spam
1534 attribute will use as a sort key.
1536 That's a pretty complicated example, and most people's actual
1537 environments will have only one spam filter. The simpler your
1538 configuration, the more effective mutt can be, especially when it comes
1541 Generally, when you sort by spam tag, mutt will sort <span class="emphasis"><em>lexically</em></span> --
1542 that is, by ordering strings alphanumerically. However, if a spam tag
1543 begins with a number, mutt will sort numerically first, and lexically
1544 only when two numbers are equal in value. (This is like UNIX's
1545 <code class="literal">sort -n</code>.) A message with no spam attributes at all -- that is, one
1546 that didn't match <span class="emphasis"><em>any</em></span> of your <code class="literal">spam</code> patterns -- is sorted at
1547 lowest priority. Numbers are sorted next, beginning with 0 and ranging
1548 upward. Finally, non-numeric strings are sorted, with ``a'' taking lower
1549 priority than ``z''. Clearly, in general, sorting by spam tags is most
1550 effective when you can coerce your filter to give you a raw number. But
1551 in case you can't, mutt can still do something useful.
1553 The <code class="literal">nospam</code> command can be used to write exceptions to <code class="literal">spam</code>
1554 patterns. If a header pattern matches something in a <code class="literal">spam</code> command,
1555 but you nonetheless do not want it to receive a spam tag, you can list a
1556 more precise pattern under a <code class="literal">nospam</code> command.
1558 If the <span class="emphasis"><em>pattern</em></span> given to <code class="literal">nospam</code> is exactly the same as the
1559 <span class="emphasis"><em>pattern</em></span> on an existing <code class="literal">spam</code> list entry, the effect will be to
1560 remove the entry from the spam list, instead of adding an exception.
1561 Likewise, if the <span class="emphasis"><em>pattern</em></span> for a <code class="literal">spam</code> command matches an entry
1562 on the <code class="literal">nospam</code> list, that <code class="literal">nospam</code> entry will be removed. If the
1563 <span class="emphasis"><em>pattern</em></span> for <code class="literal">nospam</code> is ``*'', <span class="emphasis"><em>all entries on both lists</em></span>
1564 will be removed. This might be the default action if you use <code class="literal">spam</code>
1565 and <code class="literal">nospam</code> in conjunction with a <code class="literal">folder-hook</code>.
1567 You can have as many <code class="literal">spam</code> or <code class="literal">nospam</code> commands as you like.
1568 You can even do your own primitive spam detection within mutt -- for
1569 example, if you consider all mail from <code class="literal">MAILER-DAEMON</code> to be spam,
1570 you can use a <code class="literal">spam</code> command like this:
1573 </p><pre class="screen">
1574 spam "^From: .*MAILER-DAEMON" "999"
1577 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="set"></a>26. Setting and Querying Variables</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="set-commands"></a>26.1. Commands</h3></div></div></div><p>
1578 The following commands are available to manipulate and query variables:
1580 </p><div class="literallayout"><p><br />
1581 Usage: <code class="literal">set</code> [no|inv]<span class="emphasis"><em>variable</em></span>[=<span class="emphasis"><em>value</em></span>] [ <span class="emphasis"><em>variable</em></span> ... ]<br />
1582 Usage: <code class="literal">toggle</code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]<br />
1583 Usage: <code class="literal">unset</code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]<br />
1584 Usage: <code class="literal">reset</code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]<br />
1587 This command is used to set (and unset) <a href="#variables" title="3. Configuration variables">configuration variables</a>. There are four basic types of variables:
1588 boolean, number, string and quadoption. <span class="emphasis"><em>boolean</em></span> variables can be
1589 <span class="emphasis"><em>set</em></span> (true) or <span class="emphasis"><em>unset</em></span> (false). <span class="emphasis"><em>number</em></span> variables can be
1590 assigned a positive integer value.
1592 <span class="emphasis"><em>string</em></span> variables consist of any number of printable characters.
1593 <span class="emphasis"><em>strings</em></span> must be enclosed in quotes if they contain spaces or tabs. You
1594 may also use the ``C'' escape sequences <span class="bold"><strong>\n</strong></span> and <span class="bold"><strong>\t</strong></span> for
1595 newline and tab, respectively.
1597 <span class="emphasis"><em>quadoption</em></span> variables are used to control whether or not to be prompted
1598 for certain actions, or to specify a default action. A value of <span class="emphasis"><em>yes</em></span>
1599 will cause the action to be carried out automatically as if you had answered
1600 yes to the question. Similarly, a value of <span class="emphasis"><em>no</em></span> will cause the
1601 action to be carried out as if you had answered ``no.'' A value of
1602 <span class="emphasis"><em>ask-yes</em></span> will cause a prompt with a default answer of ``yes'' and
1603 <span class="emphasis"><em>ask-no</em></span> will provide a default answer of ``no.''
1605 Prefixing a variable with ``no'' will unset it. Example: <code class="literal">set noaskbcc</code>.
1607 For <span class="emphasis"><em>boolean</em></span> variables, you may optionally prefix the variable name with
1608 <code class="literal">inv</code> to toggle the value (on or off). This is useful when writing
1609 macros. Example: <code class="literal">set invsmart_wrap</code>.
1611 The <code class="literal">toggle</code> command automatically prepends the <code class="literal">inv</code> prefix to all
1612 specified variables.
1614 The <code class="literal">unset</code> command automatically prepends the <code class="literal">no</code> prefix to all
1615 specified variables.
1617 Using the enter-command function in the <span class="emphasis"><em>index</em></span> menu, you can query the
1618 value of a variable by prefixing the name of the variable with a question
1622 </p><pre class="screen">
1627 The question mark is actually only required for boolean and quadoption
1630 The <code class="literal">reset</code> command resets all given variables to the compile time
1631 defaults (hopefully mentioned in this manual). If you use the command
1632 <code class="literal">set</code> and prefix the variable with ``&'' this has the same
1633 behavior as the reset command.
1635 With the <code class="literal">reset</code> command there exists the special variable ``all'',
1636 which allows you to reset all variables to their system defaults.
1637 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="set-myvar"></a>26.2. User-defined variables</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="set-myvar-intro"></a>26.2.1. Introduction</h4></div></div></div><p>
1638 Along with the variables listed in the
1639 <a href="#variables" title="3. Configuration variables">Configuration variables</a> section, mutt
1640 supports user-defined variables with names starting
1641 with <code class="literal">my_</code> as in, for
1642 example, <code class="literal">my_cfgdir</code>.
1644 The <code class="literal">set</code> command creates a
1645 custom <code class="literal">$my_</code> variable and changes its
1646 value. The <code class="literal">unset</code> and <code class="literal">reset</code>
1647 commands remove the variable entirely.
1649 Since user-defined variables are expanded in the same way that
1650 environment variables are (except for
1651 the <a href="#shell-escape">shell-escape</a> command), this
1652 feature can be used to make configuration files more readable.
1653 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="set-myvar-examples"></a>26.2.2. Examples</h4></div></div></div><p>
1654 The following example defines and uses the variable <code class="literal">my_cfgdir</code>
1655 to abbreviate the calls of the <a href="#source" title="27. Reading initialization commands from another file">source</a> command:
1657 </p><pre class="screen">
1658 set my_cfgdir = $HOME/mutt/config
1660 source $my_cfgdir/hooks
1661 source $my_cfgdir/macros
1662 # more source commands...
1665 A custom variable can also be used in macros to backup the current value
1666 of another variable. In the following example, the value of the
1667 <a href="#delete" title="3.42. delete">$delete</a> is changed temporarily
1668 while its original value is saved as <code class="literal">my_delete</code>.
1669 After the macro has executed all commands, the original value of <a href="#delete" title="3.42. delete">$delete</a> is restored.
1671 </p><pre class="screen">
1673 <enter-command>set my_delete=$delete<enter>\
1674 <enter-command>set delete=yes<enter>\
1676 <enter-command>set delete=$my_delete<enter>'
1679 Since mutt expands such values already when parsing the configuration
1680 file(s), the value of <code class="literal">$my_delete</code> in the
1681 last example would be the value of <code class="literal">$delete</code> exactly
1682 as it was at that point during parsing the configuration file. If
1683 another statement would change the value for <code class="literal">$delete</code>
1684 later in the same or another file, it would have no effect on
1685 <code class="literal">$my_delete</code>. However, the expansion can
1686 be deferred to runtime, as shown in the next example, when escaping the
1689 </p><pre class="screen">
1690 macro pager <PageDown> "\
1691 <enter-command> set my_old_pager_stop=\$pager_stop pager_stop<Enter>\
1693 <enter-command> set pager_stop=\$my_old_pager_stop<Enter>\
1694 <enter-command> unset my_old_pager_stop<Enter>"
1697 Note that there is a space
1698 between <code class="literal"><enter-command></code> and
1699 the <code class="literal">set</code> configuration command, preventing mutt from
1700 recording the macro's commands into its history.
1701 </p></div></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="source"></a>27. Reading initialization commands from another file</h2></div></div></div><p>
1702 Usage: <code class="literal">source</code> <span class="emphasis"><em>filename</em></span>
1704 This command allows the inclusion of initialization commands
1705 from other files. For example, I place all of my aliases in
1706 <code class="literal">˜/.mail_aliases</code> so that I can make my
1707 <code class="literal">˜/.muttrc</code> readable and keep my aliases private.
1709 If the filename begins with a tilde (``˜''), it will be expanded to the
1710 path of your home directory.
1712 If the filename ends with a vertical bar (|), then <span class="emphasis"><em>filename</em></span> is
1713 considered to be an executable program from which to read input (eg.
1714 <code class="literal">source ˜/bin/myscript|</code>).
1715 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="unhook"></a>28. Removing hooks</h2></div></div></div><p>
1716 Usage: <code class="literal">unhook</code> [ * | <span class="emphasis"><em>hook-type</em></span> ]
1718 This command permits you to flush hooks you have previously defined.
1719 You can either remove all hooks by giving the ``*'' character as an
1720 argument, or you can remove all hooks of a specific type by saying
1721 something like <code class="literal">unhook send-hook</code>.
1722 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="formatstrings"></a>29. Format Strings</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id458133"></a>29.1. Basic usage</h3></div></div></div><p>
1723 Format strings are a general concept you'll find in several locations
1724 through the mutt configuration, especially in the
1725 <a href="#index-format" title="3.100. index_format">$index_format"</a>,
1726 <a href="#pager-format" title="3.139. pager_format">$pager_format"</a>,
1727 <a href="#status-format" title="3.278. status_format">$status_format"</a>,
1728 and other ``*_format'' variables. These can be very straightforward,
1729 and it's quite possible you already know how to use them.
1731 The most basic format string element is a percent symbol followed
1732 by another character. For example, <code class="literal">%s</code>
1733 represents a message's Subject: header in the <a href="#index-format" title="3.100. index_format">$index_format"</a> variable. The
1734 ``expandos'' available are documented with each format variable, but
1735 there are general modifiers available with all formatting expandos,
1736 too. Those are our concern here.
1738 Some of the modifers are borrowed right out of C (though you might
1739 know them from Perl, Python, shell, or another langugage). These are
1740 the [-]m.n modifiers, as in <code class="literal">%-12.12s</code>. As with
1741 such programming languages, these modifiers allow you to specify the
1742 minumum and maximum size of the resulting string, as well as its
1743 justification. If the ``-'' sign follows the percent, the string will
1744 be left-justified instead of right-justified. If there's a number
1745 immediately following that, it's the minimum amount of space the
1746 formatted string will occupy -- if it's naturally smaller than that, it
1747 will be padded out with spaces. If a decimal point and another number
1748 follow, that's the maximum space allowable -- the string will not be
1749 permitted to exceed that width, no matter its natural size. Each of
1750 these three elements is optional, so that all these are legal format
1752 <code class="literal">%-12s</code>
1753 <code class="literal">%4c</code>
1754 <code class="literal">%.15F</code>
1755 <code class="literal">%-12.15L</code>
1757 Mutt adds some other modifiers to format strings. If you use an equals
1758 symbol (<code class="literal">=</code>) as a numeric prefix (like the minus
1759 above), it will force the string to be centered within its minimum
1760 space range. For example, <code class="literal">%=14y</code> will reserve 14
1761 characters for the %y expansion -- that's the X-Label: header, in
1762 <code class="literal">$index_format</code>. If the expansion
1763 results in a string less than 14 characters, it will be centered in a
1764 14-character space. If the X-Label for a message were "test", that
1765 expansion would look like `` test ''.
1767 There are two very little-known modifiers that affect the way that an
1768 expando is replaced. If there is an underline (``_'') character
1769 between any format modifiers (as above) and the expando letter, it will
1770 expands in all lower case. And if you use a colon (``:''), it will
1771 replace all decimal points with underlines.
1772 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id458263"></a>29.2. Filters</h3></div></div></div><p>
1773 Any format string ending in a vertical bar (``|'') will be
1774 expanded and piped through the first word in the string, using spaces
1775 as separator. The string returned will be used for display.
1776 If the returned string ends in %, it will be passed through
1777 the formatter a second time. This allows the filter to generate a
1778 replacement format string including % expandos.
1780 All % expandos in a format string are expanded before the script
1782 </p><pre class="screen">
1783 set status_format="script.sh '%r %f (%L)'|"
1785 will make mutt expand <code class="literal">%r</code>,
1786 <code class="literal">%f</code> and <code class="literal">%L</code>
1787 before calling the script. The example also shows that arguments can be
1788 quoted: the script will receive the expanded string between the single quotes
1789 as the only argument.
1791 A practical example is the <code class="literal">mutt_xtitle</code>
1792 script installed in the <code class="literal">samples</code>
1793 subdirectory of the mutt documentation: it can be used as filter for
1794 <code class="literal">$status_format</code> to set the current
1795 terminal's title, if supported.
1796 </p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="advancedusage"></a>Chapter 4. Advanced Usage</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#regexp">1. Regular Expressions</a></span></dt><dt><span class="sect1"><a href="#patterns">2. Patterns: Searching, Limiting and Tagging</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id459463">2.1. Pattern Modifier</a></span></dt><dt><span class="sect2"><a href="#id459491">2.2. Simple Patterns</a></span></dt><dt><span class="sect2"><a href="#id459655">2.3. Complex Patterns</a></span></dt><dt><span class="sect2"><a href="#id459787">2.4. Searching by Date</a></span></dt></dl></dd><dt><span class="sect1"><a href="#tags">3. Using Tags</a></span></dt><dt><span class="sect1"><a href="#hooks">4. Using Hooks</a></span></dt><dd><dl><dt><span class="sect2"><a href="#pattern-hook">4.1. Message Matching in Hooks</a></span></dt></dl></dd><dt><span class="sect1"><a href="#query">5. External Address Queries</a></span></dt><dt><span class="sect1"><a href="#mailbox-formats">6. Mailbox Formats</a></span></dt><dt><span class="sect1"><a href="#shortcuts">7. Mailbox Shortcuts</a></span></dt><dt><span class="sect1"><a href="#using-lists">8. Handling Mailing Lists</a></span></dt><dt><span class="sect1"><a href="#editing-threads">9. Editing threads</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id460955">9.1. Linking threads</a></span></dt><dt><span class="sect2"><a href="#id460970">9.2. Breaking threads</a></span></dt></dl></dd><dt><span class="sect1"><a href="#dsn">10. Delivery Status Notification (DSN) Support</a></span></dt><dt><span class="sect1"><a href="#urlview">11. Start a WWW Browser on URLs (EXTERNAL)</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="regexp"></a>1. Regular Expressions</h2></div></div></div><p>
1797 All string patterns in Mutt including those in more complex
1798 <a href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> must be specified
1799 using regular expressions (regexp) in the ``POSIX extended'' syntax (which
1800 is more or less the syntax used by egrep and GNU awk). For your
1801 convenience, we have included below a brief description of this syntax.
1803 The search is case sensitive if the pattern contains at least one upper
1804 case letter, and case insensitive otherwise. Note that ``\''
1805 must be quoted if used for a regular expression in an initialization
1808 A regular expression is a pattern that describes a set of strings.
1809 Regular expressions are constructed analogously to arithmetic
1810 expressions, by using various operators to combine smaller expressions.
1812 Note that the regular expression can be enclosed/delimited by either "
1813 or ' which is useful if the regular expression includes a white-space
1814 character. See <a href="#muttrc-syntax">Syntax of Initialization Files</a>
1815 for more information on " and ' delimiter processing. To match a
1816 literal " or ' you must preface it with \ (backslash).
1818 The fundamental building blocks are the regular expressions that match
1819 a single character. Most characters, including all letters and digits,
1820 are regular expressions that match themselves. Any metacharacter with
1821 special meaning may be quoted by preceding it with a backslash.
1823 The period ``.'' matches any single character. The caret ``^'' and
1824 the dollar sign ``$'' are metacharacters that respectively match
1825 the empty string at the beginning and end of a line.
1827 A list of characters enclosed by ``['' and ``]'' matches any
1828 single character in that list; if the first character of the list
1829 is a caret ``^'' then it matches any character <span class="bold"><strong>not</strong></span> in the
1830 list. For example, the regular expression <span class="bold"><strong>[0123456789]</strong></span>
1831 matches any single digit. A range of ASCII characters may be specified
1832 by giving the first and last characters, separated by a hyphen
1833 ``-''. Most metacharacters lose their special meaning inside
1834 lists. To include a literal ``]'' place it first in the list.
1835 Similarly, to include a literal ``^'' place it anywhere but first.
1836 Finally, to include a literal hyphen ``-'' place it last.
1838 Certain named classes of characters are predefined. Character classes
1839 consist of ``[:'', a keyword denoting the class, and ``:]''.
1840 The following classes are defined by the POSIX standard:
1842 </p><div class="variablelist"><dl><dt><span class="term">[:alnum:]</span></dt><dd><p>
1843 Alphanumeric characters.
1844 </p></dd><dt><span class="term">[:alpha:]</span></dt><dd><p>
1845 Alphabetic characters.
1846 </p></dd><dt><span class="term">[:blank:]</span></dt><dd><p>
1847 Space or tab characters.
1848 </p></dd><dt><span class="term">[:cntrl:]</span></dt><dd><p>
1850 </p></dd><dt><span class="term">[:digit:]</span></dt><dd><p>
1852 </p></dd><dt><span class="term">[:graph:]</span></dt><dd><p>
1853 Characters that are both printable and visible. (A space is printable,
1854 but not visible, while an ``a'' is both.)
1855 </p></dd><dt><span class="term">[:lower:]</span></dt><dd><p>
1856 Lower-case alphabetic characters.
1857 </p></dd><dt><span class="term">[:print:]</span></dt><dd><p>
1858 Printable characters (characters that are not control characters.)
1859 </p></dd><dt><span class="term">[:punct:]</span></dt><dd><p>
1860 Punctuation characters (characters that are not letter, digits, control
1861 characters, or space characters).
1862 </p></dd><dt><span class="term">[:space:]</span></dt><dd><p>
1863 Space characters (such as space, tab and formfeed, to name a few).
1864 </p></dd><dt><span class="term">[:upper:]</span></dt><dd><p>
1865 Upper-case alphabetic characters.
1866 </p></dd><dt><span class="term">[:xdigit:]</span></dt><dd><p>
1867 Characters that are hexadecimal digits.
1868 </p></dd></dl></div><p>
1870 A character class is only valid in a regular expression inside the
1871 brackets of a character list. Note that the brackets in these
1872 class names are part of the symbolic names, and must be included
1873 in addition to the brackets delimiting the bracket list. For
1874 example, <span class="bold"><strong>[[:digit:]]</strong></span> is equivalent to
1875 <span class="bold"><strong>[0-9]</strong></span>.
1877 Two additional special sequences can appear in character lists. These
1878 apply to non-ASCII character sets, which can have single symbols (called
1879 collating elements) that are represented with more than one character,
1880 as well as several characters that are equivalent for collating or
1883 </p><div class="variablelist"><dl><dt><span class="term">Collating Symbols</span></dt><dd><p>
1884 A collating symbol is a multi-character collating element enclosed in
1885 ``[.'' and ``.]''. For example, if ``ch'' is a collating
1886 element, then <span class="bold"><strong>[[.ch.]]</strong></span> is a regexp that matches
1887 this collating element, while <span class="bold"><strong>[ch]</strong></span> is a regexp that
1888 matches either ``c'' or ``h''.
1889 </p></dd><dt><span class="term">Equivalence Classes</span></dt><dd><p>
1890 An equivalence class is a locale-specific name for a list of
1891 characters that are equivalent. The name is enclosed in ``[=''
1892 and ``=]''. For example, the name ``e'' might be used to
1893 represent all of ``è'' ``é'' and ``e''. In this case,
1894 <span class="bold"><strong>[[=e=]]</strong></span> is a regexp that matches any of
1895 ``è'', ``é'' and ``e''.
1896 </p></dd></dl></div><p>
1898 A regular expression matching a single character may be followed by one
1899 of several repetition operators:
1901 </p><div class="variablelist"><dl><dt><span class="term">?</span></dt><dd><p>
1902 The preceding item is optional and matched at most once.
1903 </p></dd><dt><span class="term">*</span></dt><dd><p>
1904 The preceding item will be matched zero or more times.
1905 </p></dd><dt><span class="term">+</span></dt><dd><p>
1906 The preceding item will be matched one or more times.
1907 </p></dd><dt><span class="term">{n}</span></dt><dd><p>
1908 The preceding item is matched exactly <span class="emphasis"><em>n</em></span> times.
1909 </p></dd><dt><span class="term">{n,}</span></dt><dd><p>
1910 The preceding item is matched <span class="emphasis"><em>n</em></span> or more times.
1911 </p></dd><dt><span class="term">{,m}</span></dt><dd><p>
1912 The preceding item is matched at most <span class="emphasis"><em>m</em></span> times.
1913 </p></dd><dt><span class="term">{n,m}</span></dt><dd><p>
1914 The preceding item is matched at least <span class="emphasis"><em>n</em></span> times, but no more than
1915 <span class="emphasis"><em>m</em></span> times.
1916 </p></dd></dl></div><p>
1918 Two regular expressions may be concatenated; the resulting regular
1919 expression matches any string formed by concatenating two substrings
1920 that respectively match the concatenated subexpressions.
1922 Two regular expressions may be joined by the infix operator ``|'';
1923 the resulting regular expression matches any string matching either
1926 Repetition takes precedence over concatenation, which in turn takes
1927 precedence over alternation. A whole subexpression may be enclosed in
1928 parentheses to override these precedence rules.
1930 <span class="bold"><strong>Note:</strong></span> If you compile Mutt with the GNU <span class="emphasis"><em>rx</em></span> package, the
1931 following operators may also be used in regular expressions:
1933 </p><div class="variablelist"><dl><dt><span class="term">\\y</span></dt><dd><p>
1934 Matches the empty string at either the beginning or the end of a word.
1935 </p></dd><dt><span class="term">\\B</span></dt><dd><p>
1936 Matches the empty string within a word.
1937 </p></dd><dt><span class="term">\\<</span></dt><dd><p>
1938 Matches the empty string at the beginning of a word.
1939 </p></dd><dt><span class="term">\\></span></dt><dd><p>
1940 Matches the empty string at the end of a word.
1941 </p></dd><dt><span class="term">\\w</span></dt><dd><p>
1942 Matches any word-constituent character (letter, digit, or underscore).
1943 </p></dd><dt><span class="term">\\W</span></dt><dd><p>
1944 Matches any character that is not word-constituent.
1945 </p></dd><dt><span class="term">\\`</span></dt><dd><p>
1946 Matches the empty string at the beginning of a buffer (string).
1947 </p></dd><dt><span class="term">\\'</span></dt><dd><p>
1948 Matches the empty string at the end of a buffer.
1949 </p></dd></dl></div><p>
1951 Please note however that these operators are not defined by POSIX, so
1952 they may or may not be available in stock libraries on various systems.
1953 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="patterns"></a>2. Patterns: Searching, Limiting and Tagging</h2></div></div></div><p>
1954 Many of Mutt's commands allow you to specify a pattern to match
1955 (limit, tag-pattern, delete-pattern, etc.). <a href="#tab-patterns" title="Table 4.1. Pattern modifiers">Table 4.1, “Pattern modifiers”</a>
1956 shows several ways to select messages.
1959 </p><div class="table"><a id="tab-patterns"></a><p class="title"><b>Table 4.1. Pattern modifiers</b></p><div class="table-contents"><table summary="Pattern modifiers" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Pattern modifier</th><th>Description</th></tr></thead><tbody><tr><td>~A</td><td>all messages</td></tr><tr><td>~b EXPR</td><td>messages which contain EXPR in the message body</td></tr><tr><td>=b STRING</td><td>messages which contain STRING in the message body. If IMAP is enabled, searches for STRING on the server, rather than downloading each message and searching it locally.</td></tr><tr><td>~B EXPR</td><td>messages which contain EXPR in the whole message</td></tr><tr><td>~c EXPR</td><td>messages carbon-copied to EXPR</td></tr><tr><td>%c GROUP</td><td>messages carbon-copied to any member of GROUP</td></tr><tr><td>~C EXPR</td><td>message is either to: or cc: EXPR</td></tr><tr><td>%C GROUP</td><td>message is either to: or cc: to any member of GROUP</td></tr><tr><td>~d [MIN]-[MAX]</td><td>messages with ``date-sent'' in a Date range</td></tr><tr><td>~D</td><td>deleted messages</td></tr><tr><td>~e EXPR</td><td>message which contains EXPR in the ``Sender'' field</td></tr><tr><td>%e GROUP</td><td>message which contain a member of GROUP in the ``Sender'' field</td></tr><tr><td>~E</td><td>expired messages</td></tr><tr><td>~F</td><td>flagged messages</td></tr><tr><td>~f EXPR</td><td>messages originating from EXPR</td></tr><tr><td>%f GROUP</td><td>messages originating from any member of GROUP</td></tr><tr><td>~g</td><td>cryptographically signed messages</td></tr><tr><td>~G</td><td>cryptographically encrypted messages</td></tr><tr><td>~h EXPR</td><td>messages which contain EXPR in the message header</td></tr><tr><td>~H EXPR</td><td>messages with a spam attribute matching EXPR</td></tr><tr><td>~i EXPR</td><td>message which match EXPR in the ``Message-ID'' field</td></tr><tr><td>~k</td><td>message contains PGP key material</td></tr><tr><td>~L EXPR</td><td>message is either originated or received by EXPR</td></tr><tr><td>%L GROUP</td><td>message is either originated or received by any member of GROUP</td></tr><tr><td>~l</td><td>message is addressed to a known mailing list</td></tr><tr><td>~m [MIN]-[MAX]</td><td>message in the range MIN to MAX *)</td></tr><tr><td>~n [MIN]-[MAX]</td><td>messages with a score in the range MIN to MAX *)</td></tr><tr><td>~N</td><td>new messages</td></tr><tr><td>~O</td><td>old messages</td></tr><tr><td>~p</td><td>message is addressed to you (consults alternates)</td></tr><tr><td>~P</td><td>message is from you (consults alternates)</td></tr><tr><td>~Q</td><td>messages which have been replied to</td></tr><tr><td>~r [MIN]-[MAX]</td><td>messages with ``date-received'' in a Date range</td></tr><tr><td>~R</td><td>read messages</td></tr><tr><td>~s EXPR</td><td>messages having EXPR in the ``Subject'' field.</td></tr><tr><td>~S</td><td>superseded messages</td></tr><tr><td>~t EXPR</td><td>messages addressed to EXPR</td></tr><tr><td>~T</td><td>tagged messages</td></tr><tr><td>~u</td><td>message is addressed to a subscribed mailing list</td></tr><tr><td>~U</td><td>unread messages</td></tr><tr><td>~v</td><td>message is part of a collapsed thread.</td></tr><tr><td>~V</td><td>cryptographically verified messages</td></tr><tr><td>~x EXPR</td><td>messages which contain EXPR in the `References' field</td></tr><tr><td>~X [MIN]-[MAX]</td><td>messages with MIN to MAX attachments *)</td></tr><tr><td>~y EXPR</td><td>messages which contain EXPR in the `X-Label' field</td></tr><tr><td>~z [MIN]-[MAX]</td><td>messages with a size in the range MIN to MAX *)</td></tr><tr><td>~=</td><td>duplicated messages (see $duplicate_threads)</td></tr><tr><td>~$</td><td>unreferenced messages (requires threaded view)</td></tr><tr><td>~(PATTERN)</td><td>messages in threads
1960 containing messages matching a certain pattern, e.g. all
1961 threads containing messages from you: ~(~P)</td></tr></tbody></table></div></div><p><br class="table-break" />
1965 <a href="#regexp" title="1. Regular Expressions">regular expression</a>. Special attention has to be
1966 made when using regular expressions inside of patterns. Specifically,
1967 Mutt's parser for these patterns will strip one level of backslash (\),
1968 which is normally used for quoting. If it is your intention to use a
1969 backslash in the regular expression, you will need to use two backslashes
1970 instead (\\). You can force mutt to treat EXPR as a simple string
1971 instead of a regular expression by using = instead of ˜ in the
1972 pattern name. For example, =b *.* will find all messages that contain
1973 the literal string '*.*'. Simple string matches are less powerful than
1974 regular expressions but can be considerably faster. This is especially
1975 true for IMAP folders, because string matches can be performed on the
1976 server instead of by fetching every message. IMAP treats =h specially:
1977 it must be of the form "header: substring" and will not partially
1978 match header names. The substring part may be omitted if you simply
1979 wish to find messages containing a particular header without regard to
1982 *) The forms <code class="literal"><[MAX]</code>, <code class="literal">>[MIN]</code>,
1983 <code class="literal">[MIN]-</code> and <code class="literal">-[MAX]</code>
1985 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id459463"></a>2.1. Pattern Modifier</h3></div></div></div><p>
1986 Note that patterns matching 'lists' of addresses (notably c,C,p,P and t)
1987 match if there is at least one match in the whole list. If you want to
1988 make sure that all elements of that list match, you need to prefix your
1990 This example matches all mails which only has recipients from Germany.
1993 </p><pre class="screen">
1997 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id459491"></a>2.2. Simple Patterns</h3></div></div></div><p>
1998 Mutt supports two versions of so called ``simple searches'' which are
1999 issued if the query entered for searching, limiting and similar
2000 operations does not seem to be a valid pattern (i.e. it does not contain
2001 one of these characters: ``~'', ``='' or ``%''). If the query is
2002 supposed to contain one of these special characters, they must be escaped
2003 by prepending a backslash (``\'').
2005 The first type is by checking whether the query string equals
2006 a keyword case-insensitively from <a href="#tab-simplesearch-keywords" title="Table 4.2. Simple search keywords">Table 4.2, “Simple search keywords”</a>:
2007 If that is the case, Mutt will use the shown pattern modifier instead.
2008 If a keyword would conflict with your search keyword, you need to turn
2009 it into a regular expression to avoid matching the keyword table. For
2010 example, if you want to find all messages matching ``<code class="literal">flag</code>''
2011 (using <a href="#simple-search" title="3.263. simple_search">$simple_search</a>,
2012 see below but not meaning flagged messages) simply search for
2013 ``<code class="literal">[f]lag</code>''.
2014 </p><div class="table"><a id="tab-simplesearch-keywords"></a><p class="title"><b>Table 4.2. Simple search keywords</b></p><div class="table-contents"><table summary="Simple search keywords" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Keyword</th><th>Pattern modifier</th></tr></thead><tbody><tr><td>all</td><td>~A</td></tr><tr><td>.</td><td>~A</td></tr><tr><td>^</td><td>~A</td></tr><tr><td>del</td><td>~D</td></tr><tr><td>flag</td><td>~F</td></tr><tr><td>new</td><td>~N</td></tr><tr><td>old</td><td>~O</td></tr><tr><td>repl</td><td>~Q</td></tr><tr><td>read</td><td>~R</td></tr><tr><td>tag</td><td>~T</td></tr><tr><td>unread</td><td>~U</td></tr></tbody></table></div></div><br class="table-break" /><p>
2015 The second type of simple search is to build a complex search
2016 pattern using <a href="#simple-search" title="3.263. simple_search">$simple_search</a>
2017 as a template. Mutt will insert your query properly quoted and search
2018 for the composed complex query.
2019 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id459655"></a>2.3. Complex Patterns</h3></div></div></div><p>
2020 Logical AND is performed by specifying more than one criterion. For
2024 </p><pre class="screen">
2029 would select messages which contain the word ``mutt'' in the list of
2030 recipients <span class="bold"><strong>and</strong></span> that have the word ``elkins'' in the ``From'' header
2033 Mutt also recognizes the following operators to create more complex search
2037 </p><div class="itemizedlist"><ul type="disc"><li><p>
2038 ! -- logical NOT operator
2040 | -- logical OR operator
2042 () -- logical grouping operator
2043 </p></li></ul></div><p>
2046 Here is an example illustrating a complex search pattern. This pattern will
2047 select all messages which do not contain ``mutt'' in the ``To'' or ``Cc''
2048 field and which are from ``elkins''.
2051 </p><pre class="screen">
2052 !(~t mutt|~c mutt) ~f elkins
2056 Here is an example using white space in the regular expression (note
2057 the ' and " delimiters). For this to match, the mail's subject must
2058 match the ``^Junk +From +Me$'' and it must be from either ``Jim +Somebody''
2059 or ``Ed +SomeoneElse'':
2062 </p><pre class="screen">
2063 '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")'
2067 Note that if a regular expression contains parenthesis, or a vertical bar
2068 ("|"), you <span class="bold"><strong>must</strong></span> enclose the expression in double or single quotes since
2069 those characters are also used to separate different parts of Mutt's
2070 pattern language. For example,
2073 </p><pre class="screen">
2074 ~f "me@(mutt\.org|cs\.hmc\.edu)"
2078 Without the quotes, the parenthesis wouldn't end.
2079 This would be seperated to two OR'd patterns: <span class="emphasis"><em>˜f me@(mutt\.org</em></span>
2080 and <span class="emphasis"><em>cs\.hmc\.edu)</em></span>. They are never what you want.
2081 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id459787"></a>2.4. Searching by Date</h3></div></div></div><p>
2082 Mutt supports two types of dates, <span class="emphasis"><em>absolute</em></span> and <span class="emphasis"><em>relative</em></span>.
2084 <span class="bold"><strong>Absolute</strong></span>. Dates <span class="bold"><strong>must</strong></span> be in DD/MM/YY format (month and year are
2085 optional, defaulting to the current month and year). An example of a valid
2089 </p><pre class="screen">
2090 Limit to messages matching: ~d 20/1/95-31/10
2094 If you omit the minimum (first) date, and just specify ``-DD/MM/YY'', all
2095 messages <span class="emphasis"><em>before</em></span> the given date will be selected. If you omit the maximum
2096 (second) date, and specify ``DD/MM/YY-'', all messages <span class="emphasis"><em>after</em></span> the given
2097 date will be selected. If you specify a single date with no dash (``-''),
2098 only messages sent on the given date will be selected.
2100 <span class="bold"><strong>Error Margins</strong></span>. You can add error margins to absolute dates.
2101 An error margin is a sign (+ or -), followed by a digit, followed by
2102 one of the units in <a href="#tab-date-units" title="Table 4.3. Date units">Table 4.3, “Date units”</a>. As a special case, you can replace the
2103 sign by a ``*'' character, which is equivalent to giving identical plus and minus error margins.
2104 </p><div class="table"><a id="tab-date-units"></a><p class="title"><b>Table 4.3. Date units</b></p><div class="table-contents"><table summary="Date units" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Unit</th><th>Description</th></tr></thead><tbody><tr><td>y</td><td>Years</td></tr><tr><td>m</td><td>Months</td></tr><tr><td>w</td><td>Weeks</td></tr><tr><td>d</td><td>Days</td></tr></tbody></table></div></div><br class="table-break" /><p>
2105 Example: To select any messages two weeks around January 15, 2001,
2106 you'd use the following pattern:
2108 </p><pre class="screen">
2110 Limit to messages matching: ~d 15/1/2001*2w
2114 <span class="bold"><strong>Relative</strong></span>. This type of date is relative to the current date, and may
2117 </p><div class="itemizedlist"><ul type="disc"><li><p>
2118 ><span class="emphasis"><em>offset</em></span> (messages older than <span class="emphasis"><em>offset</em></span> units)
2120 <<span class="emphasis"><em>offset</em></span> (messages newer than <span class="emphasis"><em>offset</em></span> units)
2122 =<span class="emphasis"><em>offset</em></span> (messages exactly <span class="emphasis"><em>offset</em></span> units old)
2123 </p></li></ul></div><p>
2126 <span class="emphasis"><em>offset</em></span> is specified as a positive number with one of the units from <a href="#tab-date-units" title="Table 4.3. Date units">Table 4.3, “Date units”</a>.
2128 Example: to select messages less than 1 month old, you would use
2130 </p><pre class="screen">
2131 Limit to messages matching: ~d <1m
2135 <span class="bold"><strong>Note:</strong></span> all dates used when searching are relative to the
2136 <span class="bold"><strong>local</strong></span> time zone, so unless you change the setting of your <a href="#index-format" title="3.100. index_format">$index_format</a> to include a
2137 <code class="literal">%[...]</code> format, these are <span class="bold"><strong>not</strong></span> the dates shown
2139 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tags"></a>3. Using Tags</h2></div></div></div><p>
2140 Sometimes it is desirable to perform an operation on a group of
2141 messages all at once rather than one at a time. An example might be
2142 to save messages to a mailing list to a separate folder, or to
2143 delete all messages with a given subject. To tag all messages
2144 matching a pattern, use the tag-pattern function, which is bound to
2145 ``shift-T'' by default. Or you can select individual messages by
2146 hand using the ``tag-message'' function, which is bound to ``t'' by
2147 default. See <a href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> for Mutt's pattern
2150 Once you have tagged the desired messages, you can use the
2151 ``tag-prefix'' operator, which is the ``;'' (semicolon) key by default.
2152 When the ``tag-prefix'' operator is used, the <span class="bold"><strong>next</strong></span> operation will
2153 be applied to all tagged messages if that operation can be used in that
2154 manner. If the <a href="#auto-tag" title="3.18. auto_tag">$auto_tag</a>
2155 variable is set, the next operation applies to the tagged messages
2156 automatically, without requiring the ``tag-prefix''.
2158 In <a href="#macro" title="7. Keyboard macros">macros</a> or <a href="#push" title="22. Adding key sequences to the keyboard buffer">push</a> commands,
2159 you can use the ``tag-prefix-cond'' operator. If there are no tagged
2160 messages, mutt will "eat" the rest of the macro to abort it's execution.
2161 Mutt will stop "eating" the macro when it encounters the ``end-cond''
2162 operator; after this operator the rest of the macro will be executed as
2164 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="hooks"></a>4. Using Hooks</h2></div></div></div><p>
2165 A <span class="emphasis"><em>hook</em></span> is a concept borrowed from the EMACS editor which allows you to
2166 execute arbitrary commands before performing some operation. For example,
2167 you may wish to tailor your configuration based upon which mailbox you are
2168 reading, or to whom you are sending mail. In the Mutt world, a <span class="emphasis"><em>hook</em></span>
2169 consists of a <a href="#regexp" title="1. Regular Expressions">regular expression</a> or
2170 <a href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">pattern</a> along with a
2171 configuration option/command. See
2173 </p><div class="itemizedlist"><ul type="disc"><li><p>
2174 <a href="#folder-hook" title="6. Setting variables based upon mailbox">folder-hook</a>
2176 <a href="#send-hook" title="19. Change settings based upon message recipients">send-hook</a>
2178 <a href="#message-hook" title="20. Change settings before formatting a message">message-hook</a>
2180 <a href="#save-hook" title="16. Specify default save mailbox">save-hook</a>
2182 <a href="#mbox-hook" title="12. Using Multiple spool mailboxes">mbox-hook</a>
2184 <a href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a>
2186 <a href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a>
2187 </p></li></ul></div><p>
2189 for specific details on each type of <span class="emphasis"><em>hook</em></span> available.
2191 <span class="bold"><strong>Note:</strong></span> if a hook changes configuration settings, these changes remain
2192 effective until the end of the current mutt session. As this is generally
2193 not desired, a default hook needs to be added before all other hooks to
2194 restore configuration defaults. Here is an example with send-hook and the
2198 </p><pre class="screen">
2199 send-hook . 'unmy_hdr From:'
2200 send-hook ~C'^b@b\.b$' my_hdr from: c@c.c
2203 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pattern-hook"></a>4.1. Message Matching in Hooks</h3></div></div></div><p>
2204 Hooks that act upon messages (<code class="literal">message-hook, reply-hook,
2205 send-hook, send2-hook, save-hook, fcc-hook</code>) are evaluated in a
2206 slightly different manner. For the other
2207 types of hooks, a <a href="#regexp" title="1. Regular Expressions">regular expression</a> is
2208 sufficient. But in dealing with messages a finer grain of control is
2209 needed for matching since for different purposes you want to match
2212 Mutt allows the use of the <a href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">search pattern</a>
2213 language for matching messages in hook commands. This works in
2214 exactly the same way as it would when <span class="emphasis"><em>limiting</em></span> or
2215 <span class="emphasis"><em>searching</em></span> the mailbox, except that you are restricted to those
2216 operators which match information mutt extracts from the header of
2217 the message (i.e., from, to, cc, date, subject, etc.).
2219 For example, if you wanted to set your return address based upon sending
2220 mail to a specific address, you could do something like:
2222 </p><pre class="screen">
2223 send-hook '~t ^me@cs\.hmc\.edu$' 'my_hdr From: Mutt User <user@host>'
2226 which would execute the given command when sending mail to
2227 <span class="emphasis"><em>me@cs.hmc.edu</em></span>.
2229 However, it is not required that you write the pattern to match using the
2230 full searching language. You can still specify a simple <span class="emphasis"><em>regular
2231 expression</em></span> like the other hooks, in which case Mutt will translate your
2232 pattern into the full language, using the translation specified by the
2233 <a href="#default-hook" title="3.41. default_hook">$default_hook</a> variable. The
2234 pattern is translated at the time the hook is declared, so the value of
2235 <a href="#default-hook" title="3.41. default_hook">$default_hook</a> that is in effect
2236 at that time will be used.
2237 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="query"></a>5. External Address Queries</h2></div></div></div><p>
2238 Mutt supports connecting to external directory databases such as LDAP,
2239 ph/qi, bbdb, or NIS through a wrapper script which connects to mutt
2240 using a simple interface. Using the <a href="#query-command" title="3.231. query_command">$query_command</a> variable, you specify the wrapper
2241 command to use. For example:
2244 </p><pre class="screen">
2245 set query_command = "mutt_ldap_query.pl '%s'"
2249 The wrapper script should accept the query on the command-line. It
2250 should return a one line message, then each matching response on a
2251 single line, each line containing a tab separated address then name then
2252 some other optional information. On error, or if there are no matching
2253 addresses, return a non-zero exit code and a one line error message.
2255 An example multiple response output:
2257 </p><pre class="screen">
2258 Searching database ... 20 entries ... 3 matching:
2259 me@cs.hmc.edu Michael Elkins mutt dude
2260 blong@fiction.net Brandon Long mutt and more
2261 roessler@does-not-exist.org Thomas Roessler mutt pgp
2265 There are two mechanisms for accessing the query function of mutt. One
2266 is to do a query from the index menu using the query function (default: Q).
2267 This will prompt for a query, then bring up the query menu which will
2268 list the matching responses. From the query menu, you can select
2269 addresses to create aliases, or to mail. You can tag multiple addresses
2270 to mail, start a new query, or have a new query appended to the current
2273 The other mechanism for accessing the query function is for address
2274 completion, similar to the alias completion. In any prompt for address
2275 entry, you can use the complete-query function (default: ^T) to run a
2276 query based on the current address you have typed. Like aliases, mutt
2277 will look for what you have typed back to the last space or comma. If
2278 there is a single response for that query, mutt will expand the address
2279 in place. If there are multiple responses, mutt will activate the query
2280 menu. At the query menu, you can select one or more addresses to be
2281 added to the prompt.
2282 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mailbox-formats"></a>6. Mailbox Formats</h2></div></div></div><p>
2283 Mutt supports reading and writing of four different mailbox formats:
2284 mbox, MMDF, MH and Maildir. The mailbox type is autodetected, so there
2285 is no need to use a flag for different mailbox types. When creating new
2286 mailboxes, Mutt uses the default specified with the <a href="#mbox-type" title="3.116. mbox_type">$mbox_type</a> variable.
2288 <span class="bold"><strong>mbox</strong></span>. This is the most widely used mailbox format for UNIX. All
2289 messages are stored in a single file. Each message has a line of the form:
2292 </p><pre class="screen">
2293 From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST
2297 to denote the start of a new message (this is often referred to as the
2300 <span class="bold"><strong>MMDF</strong></span>. This is a variant of the <span class="emphasis"><em>mbox</em></span> format. Each message is
2301 surrounded by lines containing ``^A^A^A^A'' (four control-A's).
2303 <span class="bold"><strong>MH</strong></span>. A radical departure from <span class="emphasis"><em>mbox</em></span> and <span class="emphasis"><em>MMDF</em></span>, a mailbox
2304 consists of a directory and each message is stored in a separate file.
2305 The filename indicates the message number (however, this is may not
2306 correspond to the message number Mutt displays). Deleted messages are
2307 renamed with a comma (,) prepended to the filename. <span class="bold"><strong>Note:</strong></span> Mutt
2308 detects this type of mailbox by looking for either <code class="literal">.mh_sequences</code>
2309 or <code class="literal">.xmhcache</code> (needed to distinguish normal directories from MH
2312 <span class="bold"><strong>Maildir</strong></span>. The newest of the mailbox formats, used by the Qmail MTA (a
2313 replacement for sendmail). Similar to <span class="emphasis"><em>MH</em></span>, except that it adds three
2314 subdirectories of the mailbox: <span class="emphasis"><em>tmp</em></span>, <span class="emphasis"><em>new</em></span> and <span class="emphasis"><em>cur</em></span>. Filenames
2315 for the messages are chosen in such a way they are unique, even when two
2316 programs are writing the mailbox over NFS, which means that no file locking
2318 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="shortcuts"></a>7. Mailbox Shortcuts</h2></div></div></div><p>
2319 There are a number of built in shortcuts which refer to specific mailboxes.
2320 These shortcuts can be used anywhere you are prompted for a file or mailbox
2324 </p><div class="itemizedlist"><ul type="disc"><li><p>
2325 ! -- refers to your <a href="#spoolfile" title="3.276. spoolfile">$spoolfile</a> (incoming) mailbox
2327 > -- refers to your <a href="#mbox" title="3.115. mbox">$mbox</a> file
2329 < -- refers to your <a href="#record" title="3.239. record">$record</a> file
2331 ^ -- refers to the current mailbox
2333 - or !! -- refers to the file you've last visited
2335 ˜ -- refers to your home directory
2337 = or + -- refers to your <a href="#folder" title="3.58. folder">$folder</a> directory
2339 @<span class="emphasis"><em>alias</em></span> -- refers to the <a href="#save-hook" title="16. Specify default save mailbox">default save folder</a> as determined by the address of the alias
2340 </p></li></ul></div><p>
2342 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="using-lists"></a>8. Handling Mailing Lists</h2></div></div></div><p>
2343 Mutt has a few configuration options that make dealing with large
2344 amounts of mail easier. The first thing you must do is to let Mutt
2345 know what addresses you consider to be mailing lists (technically
2346 this does not have to be a mailing list, but that is what it is most
2347 often used for), and what lists you are subscribed to. This is
2348 accomplished through the use of the <a href="#lists" title="11. Mailing lists">lists and subscribe</a> commands in your muttrc.
2350 Now that Mutt knows what your mailing lists are, it can do several
2351 things, the first of which is the ability to show the name of a list
2352 through which you received a message (i.e., of a subscribed list) in
2353 the <span class="emphasis"><em>index</em></span> menu display. This is useful to distinguish between
2354 personal and list mail in the same mailbox. In the <a href="#index-format" title="3.100. index_format">$index_format</a> variable, the escape ``%L''
2355 will return the string ``To <list>'' when ``list'' appears in the
2356 ``To'' field, and ``Cc <list>'' when it appears in the ``Cc''
2357 field (otherwise it returns the name of the author).
2359 Often times the ``To'' and ``Cc'' fields in mailing list messages
2360 tend to get quite large. Most people do not bother to remove the
2361 author of the message they are reply to from the list, resulting in
2362 two or more copies being sent to that person. The ``list-reply''
2363 function, which by default is bound to ``L'' in the <span class="emphasis"><em>index</em></span> menu
2364 and <span class="emphasis"><em>pager</em></span>, helps reduce the clutter by only replying to the
2365 known mailing list addresses instead of all recipients (except as
2366 specified by <code class="literal">Mail-Followup-To</code>, see below).
2368 Mutt also supports the <code class="literal">Mail-Followup-To</code> header. When you send
2369 a message to a list of recipients which includes one or several
2370 subscribed mailing lists, and if the <a href="#followup-to" title="3.60. followup_to">$followup_to</a> option is set, mutt will generate
2371 a Mail-Followup-To header which contains all the recipients to whom
2372 you send this message, but not your address. This indicates that
2373 group-replies or list-replies (also known as ``followups'') to this
2374 message should only be sent to the original recipients of the
2375 message, and not separately to you - you'll receive your copy through
2376 one of the mailing lists you are subscribed to.
2378 Conversely, when group-replying or list-replying to a message which
2379 has a <code class="literal">Mail-Followup-To</code> header, mutt will respect this header if
2380 the <a href="#honor-followup-to" title="3.79. honor_followup_to">$honor_followup_to</a> configuration
2381 variable is set. Using list-reply will in this case also make sure
2382 that the reply goes to the mailing list, even if it's not specified
2383 in the list of recipients in the <code class="literal">Mail-Followup-To</code>.
2385 Note that, when header editing is enabled, you can create a
2386 <code class="literal">Mail-Followup-To</code> header manually. Mutt will only auto-generate
2387 this header if it doesn't exist when you send the message.
2389 The other method some mailing list admins use is to generate a
2390 ``Reply-To'' field which points back to the mailing list address rather
2391 than the author of the message. This can create problems when trying
2392 to reply directly to the author in private, since most mail clients
2393 will automatically reply to the address given in the ``Reply-To''
2394 field. Mutt uses the <a href="#reply-to" title="3.242. reply_to">$reply_to</a>
2395 variable to help decide which address to use. If set to <span class="emphasis"><em>ask-yes</em></span> or
2396 <span class="emphasis"><em>ask-no</em></span>, you will be
2397 prompted as to whether or not you would like to use the address given in
2398 the ``Reply-To'' field, or reply directly to the address given in the
2399 ``From'' field. When set to <span class="emphasis"><em>yes</em></span>, the ``Reply-To'' field will be used when
2402 The ``X-Label:'' header field can be used to further identify mailing
2403 lists or list subject matter (or just to annotate messages
2404 individually). The <a href="#index-format" title="3.100. index_format">$index_format</a> variable's ``%y'' and
2405 ``%Y'' escapes can be used to expand ``X-Label:'' fields in the
2406 index, and Mutt's pattern-matcher can match regular expressions to
2407 ``X-Label:'' fields with the ``˜y'' selector. ``X-Label:'' is not a
2408 standard message header field, but it can easily be inserted by procmail
2409 and other mail filtering agents.
2411 Lastly, Mutt has the ability to <a href="#sort" title="3.270. sort">sort</a> the mailbox into
2412 <a href="#threads" title="3.3. Threaded Mode">threads</a>. A thread is a group of messages which all relate to the same
2413 subject. This is usually organized into a tree-like structure where a
2414 message and all of its replies are represented graphically. If you've ever
2415 used a threaded news client, this is the same concept. It makes dealing
2416 with large volume mailing lists easier because you can easily delete
2417 uninteresting threads and quickly find topics of value.
2418 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="editing-threads"></a>9. Editing threads</h2></div></div></div><p>
2419 Mutt has the ability to dynamically restructure threads that are broken
2420 either by misconfigured software or bad behavior from some
2421 correspondents. This allows to clean your mailboxes formats) from these
2422 annoyances which make it hard to follow a discussion.
2423 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id460955"></a>9.1. Linking threads</h3></div></div></div><p>
2424 Some mailers tend to "forget" to correctly set the "In-Reply-To:" and
2425 "References:" headers when replying to a message. This results in broken
2426 discussions because Mutt has not enough information to guess the correct
2428 You can fix this by tagging the reply, then moving to the parent message
2429 and using the ``link-threads'' function (bound to & by default). The
2430 reply will then be connected to this "parent" message.
2432 You can also connect multiple children at once, tagging them and using the
2433 tag-prefix command (';') or the auto_tag option.
2434 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id460970"></a>9.2. Breaking threads</h3></div></div></div><p>
2435 On mailing lists, some people are in the bad habit of starting a new
2436 discussion by hitting "reply" to any message from the list and changing
2437 the subject to a totally unrelated one.
2438 You can fix such threads by using the ``break-thread'' function (bound
2439 by default to #), which will turn the subthread starting from the
2440 current message into a whole different thread.
2441 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="dsn"></a>10. Delivery Status Notification (DSN) Support</h2></div></div></div><p>
2442 RFC1894 defines a set of MIME content types for relaying information
2443 about the status of electronic mail messages. These can be thought of as
2444 ``return receipts.''
2446 To support DSN, there are two variables. <a href="#dsn-notify" title="3.47. dsn_notify">$dsn_notify</a> is used to request receipts for
2447 different results (such as failed message, message delivered, etc.).
2448 <a href="#dsn-return" title="3.48. dsn_return">$dsn_return</a> requests how much
2449 of your message should be returned with the receipt (headers or full
2452 When using <a href="#sendmail" title="3.257. sendmail">$sendmail</a> for mail
2453 delivery, you need to use either Berkeley sendmail 8.8.x (or greater) a MTA
2454 supporting DSN command line options compatible to Sendmail: The -N and -R
2455 options can be used by the mail client to make requests as to what type of
2456 status messages should be returned. Please consider your MTA documentation
2457 whether DSN is supported.
2459 For SMTP delivery using <a href="#smtp-url" title="3.269. smtp_url">$smtp_url</a>, it depends on the
2460 capabilities announced by the server whether mutt will attempt to
2462 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="urlview"></a>11. Start a WWW Browser on URLs (EXTERNAL)</h2></div></div></div><p>
2463 If a message contains URLs (<span class="emphasis"><em>unified resource locator</em></span> = address in the
2464 WWW space like <span class="emphasis"><em>http://www.mutt.org/</em></span>), it is efficient to get
2465 a menu with all the URLs and start a WWW browser on one of them. This
2466 functionality is provided by the external urlview program which can be
2467 retrieved at <a href="ftp://ftp.mutt.org/mutt/contrib/" target="_top">ftp://ftp.mutt.org/mutt/contrib/</a> and the configuration commands:
2469 </p><pre class="screen">
2470 macro index \cb |urlview\n
2471 macro pager \cb |urlview\n
2474 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="mimesupport"></a>Chapter 5. Mutt's MIME Support</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#using-mime">1. Using MIME in Mutt</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id461145">1.1. Viewing MIME messages in the pager</a></span></dt><dt><span class="sect2"><a href="#attach-menu">1.2. The Attachment Menu</a></span></dt><dt><span class="sect2"><a href="#compose-menu">1.3. The Compose Menu</a></span></dt></dl></dd><dt><span class="sect1"><a href="#mime-types">2. MIME Type configuration with <code class="literal">mime.types</code></a></span></dt><dt><span class="sect1"><a href="#mime-viewers">3. MIME Viewer configuration with <code class="literal">mailcap</code></a></span></dt><dd><dl><dt><span class="sect2"><a href="#id461549">3.1. The Basics of the mailcap file</a></span></dt><dt><span class="sect2"><a href="#id461671">3.2. Secure use of mailcap</a></span></dt><dt><span class="sect2"><a href="#id461742">3.3. Advanced mailcap Usage</a></span></dt><dt><span class="sect2"><a href="#id462190">3.4. Example mailcap files</a></span></dt></dl></dd><dt><span class="sect1"><a href="#auto-view">4. MIME Autoview</a></span></dt><dt><span class="sect1"><a href="#alternative-order">5. MIME Multipart/Alternative</a></span></dt><dt><span class="sect1"><a href="#attachments">6. Attachment Searching and Counting</a></span></dt><dt><span class="sect1"><a href="#mime-lookup">7. MIME Lookup</a></span></dt></dl></div><p>
2475 Quite a bit of effort has been made to make Mutt the premier text-mode
2476 MIME MUA. Every effort has been made to provide the functionality that
2477 the discerning MIME user requires, and the conformance to the standards
2478 wherever possible. When configuring Mutt for MIME, there are two extra
2479 types of configuration files which Mutt uses. One is the
2480 <code class="literal">mime.types</code> file, which contains the mapping of file extensions to
2481 IANA MIME types. The other is the <code class="literal">mailcap</code> file, which specifies
2482 the external commands to use for handling specific MIME types.
2483 </p><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="using-mime"></a>1. Using MIME in Mutt</h2></div></div></div><p>
2484 There are three areas/menus in Mutt which deal with MIME, they are the
2485 pager (while viewing a message), the attachment menu and the compose
2487 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id461145"></a>1.1. Viewing MIME messages in the pager</h3></div></div></div><p>
2488 When you select a message from the index and view it in the pager, Mutt
2489 decodes the message to a text representation. Mutt internally supports
2490 a number of MIME types, including <code class="literal">text/plain, text/enriched,
2491 message/rfc822, and message/news</code>. In addition, the export
2492 controlled version of Mutt recognizes a variety of PGP MIME types,
2493 including PGP/MIME and application/pgp.
2495 Mutt will denote attachments with a couple lines describing them.
2496 These lines are of the form:
2498 </p><pre class="screen">
2499 [-- Attachment #1: Description --]
2500 [-- Type: text/plain, Encoding: 7bit, Size: 10000 --]
2503 Where the <code class="literal">Description</code> is the description or filename given for the
2504 attachment, and the <code class="literal">Encoding</code> is one of
2505 <code class="literal">7bit/8bit/quoted-printable/base64/binary</code>.
2507 If Mutt cannot deal with a MIME type, it will display a message like:
2509 </p><pre class="screen">
2510 [-- image/gif is unsupported (use 'v' to view this part) --]
2513 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-menu"></a>1.2. The Attachment Menu</h3></div></div></div><p>
2514 The default binding for <code class="literal">view-attachments</code> is `v', which displays the
2515 attachment menu for a message. The attachment menu displays a list of
2516 the attachments in a message. From the attachment menu, you can save,
2517 print, pipe, delete, and view attachments. You can apply these
2518 operations to a group of attachments at once, by tagging the attachments
2519 and by using the ``tag-prefix'' operator. You can also reply to the
2520 current message from this menu, and only the current attachment (or the
2521 attachments tagged) will be quoted in your reply. You can view
2522 attachments as text, or view them using the mailcap viewer definition.
2524 Finally, you can apply the usual message-related functions (like
2525 <a href="#resend-message">resend-message</a>, and the reply
2526 and forward functions) to attachments of type <code class="literal">message/rfc822</code>.
2528 See the help on the attachment menu for more information.
2529 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose-menu"></a>1.3. The Compose Menu</h3></div></div></div><p>
2530 The compose menu is the menu you see before you send a message. It
2531 allows you to edit the recipient list, the subject, and other aspects
2532 of your message. It also contains a list of the attachments of your
2533 message, including the main body. From this menu, you can print, copy,
2534 filter, pipe, edit, compose, review, and rename an attachment or a
2535 list of tagged attachments. You can also modifying the attachment
2536 information, notably the type, encoding and description.
2538 Attachments appear as follows:
2540 </p><pre class="screen">
2541 - 1 [text/plain, 7bit, 1K] /tmp/mutt-euler-8082-0 <no description>
2542 2 [applica/x-gunzip, base64, 422K] ~/src/mutt-0.85.tar.gz <no description>
2546 The '-' denotes that Mutt will delete the file after sending (or
2547 postponing, or canceling) the message. It can be toggled with the
2548 <code class="literal">toggle-unlink</code> command (default: u). The next field is the MIME
2549 content-type, and can be changed with the <code class="literal">edit-type</code> command
2550 (default: ^T). The next field is the encoding for the attachment,
2551 which allows a binary message to be encoded for transmission on 7bit
2552 links. It can be changed with the <code class="literal">edit-encoding</code> command
2553 (default: ^E). The next field is the size of the attachment,
2554 rounded to kilobytes or megabytes. The next field is the filename,
2555 which can be changed with the <code class="literal">rename-file</code> command (default: R).
2556 The final field is the description of the attachment, and can be
2557 changed with the <code class="literal">edit-description</code> command (default: d).
2558 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mime-types"></a>2. MIME Type configuration with <code class="literal">mime.types</code></h2></div></div></div><p>
2559 When you add an attachment to your mail message, Mutt searches your
2560 personal mime.types file at <code class="literal">${HOME}/.mime.types</code>, and then
2561 the system mime.types file at <code class="literal">/usr/local/share/mutt/mime.types</code> or
2562 <code class="literal">/etc/mime.types</code>
2564 The mime.types file consist of lines containing a MIME type and a space
2565 separated list of extensions. For example:
2567 </p><pre class="screen">
2568 application/postscript ps eps
2570 audio/x-aiff aif aifc aiff
2573 A sample <code class="literal">mime.types</code> file comes with the Mutt distribution, and
2574 should contain most of the MIME types you are likely to use.
2576 If Mutt can not determine the mime type by the extension of the file you
2577 attach, it will look at the file. If the file is free of binary
2578 information, Mutt will assume that the file is plain text, and mark it
2579 as <code class="literal">text/plain</code>. If the file contains binary information, then Mutt will
2580 mark it as <code class="literal">application/octet-stream</code>. You can change the MIME
2581 type that Mutt assigns to an attachment by using the <code class="literal">edit-type</code>
2582 command from the compose menu (default: ^T). The MIME type is actually a
2583 major mime type followed by the sub-type, separated by a '/'. 6 major
2584 types: application, text, image, video, audio, and model have been approved
2585 after various internet discussions. Mutt recognizes all of these if the
2586 appropriate entry is found in the mime.types file. It also recognizes other
2587 major mime types, such as the chemical type that is widely used in the
2588 molecular modeling community to pass molecular data in various forms to
2589 various molecular viewers. Non-recognized mime types should only be used
2590 if the recipient of the message is likely to be expecting such attachments.
2591 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mime-viewers"></a>3. MIME Viewer configuration with <code class="literal">mailcap</code></h2></div></div></div><p>
2592 Mutt supports RFC 1524 MIME Configuration, in particular the Unix
2593 specific format specified in Appendix A of RFC 1524. This file format
2594 is commonly referred to as the mailcap format. Many MIME compliant
2595 programs utilize the mailcap format, allowing you to specify handling
2596 for all MIME types in one place for all programs. Programs known to
2597 use this format include Netscape, XMosaic, lynx and metamail.
2599 In order to handle various MIME types that Mutt can not handle
2600 internally, Mutt parses a series of external configuration files to
2601 find an external handler. The default search string for these files
2602 is a colon delimited list containing the following files:
2604 </p><div class="orderedlist"><ol type="1"><li><p><code class="literal">$HOME/.mailcap</code></p></li><li><p><code class="literal">$PKGDATADIR/mailcap</code></p></li><li><p><code class="literal">$SYSCONFDIR/mailcap</code></p></li><li><p><code class="literal">/etc/mailcap</code></p></li><li><p><code class="literal">/usr/etc/mailcap</code></p></li><li><p><code class="literal">/usr/local/etc/mailcap</code></p></li></ol></div><p>
2606 where <code class="literal">$HOME</code> is your home directory. The
2607 <code class="literal">$PKGDATADIR</code> and the
2608 <code class="literal">$SYSCONFDIR</code> directories depend on where mutt
2609 is installed: the former is the default for shared data, the
2610 latter for system configuration files.
2612 The default search path can be obtained by running the following
2614 </p><pre class="screen">
2615 mutt -nF /dev/null -Q mailcap_path
2617 In particular, the metamail distribution will install a mailcap file,
2618 usually as <code class="literal">/usr/local/etc/mailcap</code>, which contains some baseline
2620 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id461549"></a>3.1. The Basics of the mailcap file</h3></div></div></div><p>
2621 A mailcap file consists of a series of lines which are comments, blank,
2624 A comment line consists of a # character followed by anything you want.
2626 A blank line is blank.
2628 A definition line consists of a content type, a view command, and any
2629 number of optional fields. Each field of a definition line is divided
2630 by a semicolon ';' character.
2632 The content type is specified in the MIME standard type/subtype method.
2634 <code class="literal">text/plain, text/html, image/gif, </code>
2635 etc. In addition, the mailcap format includes two formats for
2636 wildcards, one using the special '*' subtype, the other is the implicit
2637 wild, where you only include the major type. For example, <code class="literal">image/*</code>, or
2638 <code class="literal">video,</code> will match all image types and video types,
2641 The view command is a Unix command for viewing the type specified. There
2642 are two different types of commands supported. The default is to send
2643 the body of the MIME message to the command on stdin. You can change
2644 this behavior by using %s as a parameter to your view command.
2645 This will cause Mutt to save the body of the MIME message to a temporary
2646 file, and then call the view command with the %s replaced by
2647 the name of the temporary file. In both cases, Mutt will turn over the
2648 terminal to the view program until the program quits, at which time Mutt
2649 will remove the temporary file if it exists.
2651 So, in the simplest form, you can send a text/plain message to the
2652 external pager more on stdin:
2654 </p><pre class="screen">
2658 Or, you could send the message as a file:
2660 </p><pre class="screen">
2664 Perhaps you would like to use lynx to interactively view a text/html
2667 </p><pre class="screen">
2671 In this case, lynx does not support viewing a file from stdin, so you
2672 must use the %s syntax.
2673 <span class="bold"><strong>Note:</strong></span> <span class="emphasis"><em>Some older versions of lynx contain a bug where they
2674 will check the mailcap file for a viewer for text/html. They will find
2675 the line which calls lynx, and run it. This causes lynx to continuously
2676 spawn itself to view the object.</em></span>
2678 On the other hand, maybe you don't want to use lynx interactively, you
2679 just want to have it convert the text/html to text/plain, then you can
2682 </p><pre class="screen">
2683 text/html; lynx -dump %s | more
2687 Perhaps you wish to use lynx to view text/html files, and a pager on
2688 all other text formats, then you would use the following:
2690 </p><pre class="screen">
2695 This is the simplest form of a mailcap file.
2696 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id461671"></a>3.2. Secure use of mailcap</h3></div></div></div><p>
2697 The interpretation of shell meta-characters embedded in MIME parameters
2698 can lead to security problems in general. Mutt tries to quote parameters
2699 in expansion of %s syntaxes properly, and avoids risky characters by
2700 substituting them, see the <a href="#mailcap-sanitize" title="3.106. mailcap_sanitize">$mailcap_sanitize</a> variable.
2702 Although mutt's procedures to invoke programs with mailcap seem to be
2703 safe, there are other applications parsing mailcap, maybe taking less care
2704 of it. Therefore you should pay attention to the following rules:
2706 <span class="emphasis"><em>Keep the %-expandos away from shell quoting.</em></span>
2707 Don't quote them with single or double quotes. Mutt does this for
2708 you, the right way, as should any other program which interprets
2709 mailcap. Don't put them into backtick expansions. Be highly careful
2710 with eval statements, and avoid them if possible at all. Trying to fix
2711 broken behavior with quotes introduces new leaks - there is no
2712 alternative to correct quoting in the first place.
2714 If you have to use the %-expandos' values in context where you need
2715 quoting or backtick expansions, put that value into a shell variable
2716 and reference the shell variable where necessary, as in the following
2717 example (using <code class="literal">$charset</code> inside the backtick expansion is safe,
2718 since it is not itself subject to any further expansion):
2721 </p><pre class="screen">
2722 text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \
2723 && test "`echo $charset | tr '[A-Z]' '[a-z]'`" != iso-8859-1
2726 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id461742"></a>3.3. Advanced mailcap Usage</h3></div></div></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id461748"></a>3.3.1. Optional Fields</h4></div></div></div><p>
2727 In addition to the required content-type and view command fields, you
2728 can add semi-colon ';' separated fields to set flags and other options.
2729 Mutt recognizes the following optional fields:
2730 </p><div class="variablelist"><dl><dt><span class="term">copiousoutput</span></dt><dd><p>
2731 This flag tells Mutt that the command passes possibly large amounts of
2732 text on stdout. This causes Mutt to invoke a pager (either the internal
2733 pager or the external pager defined by the pager variable) on the output
2734 of the view command. Without this flag, Mutt assumes that the command
2735 is interactive. One could use this to replace the pipe to <code class="literal">more</code>
2736 in the <code class="literal">lynx -dump</code> example in the Basic section:
2738 </p><pre class="screen">
2739 text/html; lynx -dump %s ; copiousoutput
2742 This will cause lynx to format the text/html output as text/plain
2743 and Mutt will use your standard pager to display the results.
2744 </p></dd><dt><span class="term">needsterminal</span></dt><dd><p>
2745 Mutt uses this flag when viewing attachments with <a href="#auto-view" title="4. MIME Autoview">auto_view</a>, in order to decide whether it should honor the setting
2746 of the <a href="#wait-key" title="3.299. wait_key">$wait_key</a> variable or
2747 not. When an attachment is viewed using an interactive program, and the
2748 corresponding mailcap entry has a <span class="emphasis"><em>needsterminal</em></span> flag, Mutt will use
2749 <a href="#wait-key" title="3.299. wait_key">$wait_key</a> and the exit status
2750 of the program to decide if it will ask you to press a key after the
2751 external program has exited. In all other situations it will not prompt
2753 </p></dd><dt><span class="term">compose=<command></span></dt><dd><p>
2754 This flag specifies the command to use to create a new attachment of a
2755 specific MIME type. Mutt supports this from the compose menu.
2756 </p></dd><dt><span class="term">composetyped=<command></span></dt><dd><p>
2757 This flag specifies the command to use to create a new attachment of a
2758 specific MIME type. This command differs from the compose command in
2759 that mutt will expect standard MIME headers on the data. This can be
2760 used to specify parameters, filename, description, etc. for a new
2761 attachment. Mutt supports this from the compose menu.
2762 </p></dd><dt><span class="term">print=<command></span></dt><dd><p>
2763 This flag specifies the command to use to print a specific MIME type.
2764 Mutt supports this from the attachment and compose menus.
2765 </p></dd><dt><span class="term">edit=<command></span></dt><dd><p>
2766 This flag specifies the command to use to edit a specific MIME type.
2767 Mutt supports this from the compose menu, and also uses it to compose
2768 new attachments. Mutt will default to the defined editor for text
2770 </p></dd><dt><span class="term">nametemplate=<template></span></dt><dd><p>
2771 This field specifies the format for the file denoted by %s in the
2772 command fields. Certain programs will require a certain file extension,
2773 for instance, to correctly view a file. For instance, lynx will only
2774 interpret a file as <code class="literal">text/html</code> if the file ends in <code class="literal">.html</code>.
2775 So, you would specify lynx as a <code class="literal">text/html</code> viewer with a line in
2776 the mailcap file like:
2778 </p><pre class="screen">
2779 text/html; lynx %s; nametemplate=%s.html
2782 </p></dd><dt><span class="term">test=<command></span></dt><dd><p>
2783 This field specifies a command to run to test whether this mailcap
2784 entry should be used. The command is defined with the command expansion
2785 rules defined in the next section. If the command returns 0, then the
2786 test passed, and Mutt uses this entry. If the command returns non-zero,
2787 then the test failed, and Mutt continues searching for the right entry.
2788 <span class="bold"><strong>Note:</strong></span> <span class="emphasis"><em>the content-type must match before Mutt performs the test.</em></span>
2791 </p><pre class="screen">
2792 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
2796 In this example, Mutt will run the program RunningX which will return 0
2797 if the X Window manager is running, and non-zero if it isn't. If
2798 RunningX returns 0, then Mutt will call netscape to display the
2799 text/html object. If RunningX doesn't return 0, then Mutt will go on
2800 to the next entry and use lynx to display the text/html object.
2801 </p></dd></dl></div><p>
2802 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id461993"></a>3.3.2. Search Order</h4></div></div></div><p>
2803 When searching for an entry in the mailcap file, Mutt will search for
2804 the most useful entry for its purpose. For instance, if you are
2805 attempting to print an <code class="literal">image/gif</code>, and you have the following
2806 entries in your mailcap file, Mutt will search for an entry with the
2809 </p><pre class="screen">
2811 image/gif; ; print= anytopnm %s | pnmtops | lpr; \
2815 Mutt will skip the <code class="literal">image/*</code> entry and use the <code class="literal">image/gif</code>
2816 entry with the print command.
2818 In addition, you can use this with <a href="#auto-view" title="4. MIME Autoview">auto_view</a>
2819 to denote two commands for viewing an attachment, one to be viewed
2820 automatically, the other to be viewed interactively from the attachment
2821 menu. In addition, you can then use the test feature to determine which
2822 viewer to use interactively depending on your environment.
2824 </p><pre class="screen">
2825 text/html; netscape -remote 'openURL(%s)' ; test=RunningX
2826 text/html; lynx %s; nametemplate=%s.html
2827 text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput
2830 For <a href="#auto-view" title="4. MIME Autoview">auto_view</a>, Mutt will choose the third
2831 entry because of the copiousoutput tag. For interactive viewing, Mutt
2832 will run the program RunningX to determine if it should use the first
2833 entry. If the program returns non-zero, Mutt will use the second entry
2834 for interactive viewing.
2835 </p></div><div class="sect3" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="id462069"></a>3.3.3. Command Expansion</h4></div></div></div><p>
2836 The various commands defined in the mailcap files are passed to the
2837 <code class="literal">/bin/sh</code> shell using the system() function. Before the
2838 command is passed to <code class="literal">/bin/sh -c</code>, it is parsed to expand
2839 various special parameters with information from Mutt. The keywords
2841 </p><div class="variablelist"><dl><dt><span class="term">%s</span></dt><dd><p>
2842 As seen in the basic mailcap section, this variable is expanded
2843 to a filename specified by the calling program. This file contains
2844 the body of the message to view/print/edit or where the composing
2845 program should place the results of composition. In addition, the
2846 use of this keyword causes Mutt to not pass the body of the message
2847 to the view/print/edit program on stdin.
2848 </p></dd><dt><span class="term">%t</span></dt><dd><p>
2849 Mutt will expand %t to the text representation of the content
2850 type of the message in the same form as the first parameter of the
2851 mailcap definition line, ie <code class="literal">text/html</code> or
2852 <code class="literal">image/gif</code>.
2853 </p></dd><dt><span class="term">%{<parameter>}</span></dt><dd><p>
2854 Mutt will expand this to the value of the specified parameter
2855 from the Content-Type: line of the mail message. For instance, if
2856 Your mail message contains:
2858 </p><pre class="screen">
2859 Content-Type: text/plain; charset=iso-8859-1
2862 then Mutt will expand %{charset} to iso-8859-1. The default metamail
2863 mailcap file uses this feature to test the charset to spawn an xterm
2864 using the right charset to view the message.
2865 </p></dd><dt><span class="term">\%</span></dt><dd><p>
2866 This will be replaced by a %
2867 </p></dd></dl></div><p>
2868 Mutt does not currently support the %F and %n keywords
2869 specified in RFC 1524. The main purpose of these parameters is for
2870 multipart messages, which is handled internally by Mutt.
2871 </p></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id462190"></a>3.4. Example mailcap files</h3></div></div></div><p>
2872 This mailcap file is fairly simple and standard:
2874 </p><pre class="programlisting">
2875 # I'm always running X :)
2876 video/*; xanim %s > /dev/null
2877 image/*; xv %s > /dev/null
2879 # I'm always running netscape (if my computer had more memory, maybe)
2880 text/html; netscape -remote 'openURL(%s)'
2884 This mailcap file shows quite a number of examples:
2887 </p><pre class="programlisting">
2888 # Use xanim to view all videos Xanim produces a header on startup,
2889 # send that to /dev/null so I don't see it
2890 video/*; xanim %s > /dev/null
2892 # Send html to a running netscape by remote
2893 text/html; netscape -remote 'openURL(%s)'; test=RunningNetscape
2895 # If I'm not running netscape but I am running X, start netscape on the
2897 text/html; netscape %s; test=RunningX
2899 # Else use lynx to view it as text
2902 # This version would convert the text/html to text/plain
2903 text/html; lynx -dump %s; copiousoutput
2905 # I use enscript to print text in two columns to a page
2906 text/*; more %s; print=enscript -2Gr %s
2908 # Netscape adds a flag to tell itself to view jpegs internally
2909 image/jpeg;xv %s; x-mozilla-flags=internal
2911 # Use xv to view images if I'm running X
2912 # In addition, this uses the \ to extend the line and set my editor
2914 image/*;xv %s; test=RunningX; \
2917 # Convert images to text using the netpbm tools
2918 image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm |
2919 pbmtoascii -1x2 ) 2>&1 ; copiousoutput
2921 # Send excel spreadsheets to my NT box
2922 application/ms-excel; open.pl %s
2925 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="auto-view"></a>4. MIME Autoview</h2></div></div></div><p>
2926 In addition to explicitly telling Mutt to view an attachment with the
2927 MIME viewer defined in the mailcap file, Mutt has support for
2928 automatically viewing MIME attachments while in the pager.
2930 To work, you must define a viewer in the mailcap file which uses the
2931 <code class="literal">copiousoutput</code> option to denote that it is non-interactive.
2932 Usually, you also use the entry to convert the attachment to a text
2933 representation which you can view in the pager.
2935 You then use the <code class="literal">auto_view</code> muttrc command to list the
2936 content-types that you wish to view automatically.
2938 For instance, if you set auto_view to:
2940 </p><pre class="screen">
2941 auto_view text/html application/x-gunzip \
2942 application/postscript image/gif application/x-tar-gz
2946 Mutt could use the following mailcap entries to automatically view
2947 attachments of these types.
2949 </p><pre class="screen">
2950 text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html
2951 image/*; anytopnm %s | pnmscale -xsize 80 -ysize 50 | ppmtopgm | \
2952 pgmtopbm | pbmtoascii ; copiousoutput
2953 application/x-gunzip; gzcat; copiousoutput
2954 application/x-tar-gz; gunzip -c %s | tar -tf - ; copiousoutput
2955 application/postscript; ps2ascii %s; copiousoutput
2959 ``unauto_view'' can be used to remove previous entries from the autoview list.
2960 This can be used with message-hook to autoview messages based on size, etc.
2961 ``unauto_view *'' will remove all previous entries.
2962 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="alternative-order"></a>5. MIME Multipart/Alternative</h2></div></div></div><p>
2963 Mutt has some heuristics for determining which attachment of a
2964 multipart/alternative type to display. First, mutt will check the
2965 alternative_order list to determine if one of the available types
2966 is preferred. The alternative_order list consists of a number of
2967 mimetypes in order, including support for implicit and explicit
2968 wildcards, for example:
2970 </p><pre class="screen">
2971 alternative_order text/enriched text/plain text application/postscript image/*
2975 Next, mutt will check if any of the types have a defined
2976 <a href="#auto-view" title="4. MIME Autoview">auto_view</a>, and use that. Failing
2977 that, Mutt will look for any text type. As a last attempt, mutt will
2978 look for any type it knows how to handle.
2980 To remove a MIME type from the <code class="literal">alternative_order</code> list, use the
2981 <code class="literal">unalternative_order</code> command.
2982 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="attachments"></a>6. Attachment Searching and Counting</h2></div></div></div><p>
2983 If you ever lose track of attachments in your mailboxes, Mutt's
2984 attachment-counting and -searching support might be for you. You can
2985 make your message index display the number of qualifying attachments in
2986 each message, or search for messages by attachment count. You also can
2987 configure what kinds of attachments qualify for this feature with the
2988 attachments and unattachments commands.
2990 In order to provide this information, mutt needs to fully MIME-parse
2991 all messages affected first. This can slow down operation especially for
2992 remote mail folders such as IMAP because all messages have to be
2993 downloaded first regardless whether the user really wants to view them
2997 </p><pre class="screen">
2998 attachments {+|-}disposition mime-type
2999 unattachments {+|-}disposition mime-type
3002 Disposition is the attachment's Content-disposition type -- either
3003 "inline" or "attachment". You can abbreviate this to I or A.
3005 Disposition is prefixed by either a + symbolor a - symbol. If it's
3006 a +, you're saying that you want to allow this disposition and MIME
3007 type to qualify. If it's a -, you're saying that this disposition
3008 and MIME type is an exception to previous + rules. There are examples
3009 below of how this is useful.
3011 Mime-type is, unsurprisingly, the MIME type of the attachment you want
3012 to affect. A MIME type is always of the format "major/minor", where
3013 "major" describes the broad category of document you're looking at, and
3014 "minor" describes the specific type within that category. The major
3015 part of mim-type must be literal text (or the special token "*"), but
3016 the minor part may be a regular expression. (Therefore, "*/.*" matches
3019 The MIME types you give to the attachments directive are a kind of
3020 pattern. When you use the attachments directive, the patterns you
3021 specify are added to a list. When you use unattachments, the pattern
3022 is removed from the list. The patterns are not expanded and matched
3023 to specific MIME types at this time -- they're just text in a list.
3024 They're only matched when actually evaluating a message.
3026 Some examples might help to illustrate. The examples that are not
3027 commented out define the default configuration of the lists.
3028 </p><pre class="screen">
3029 ## Removing a pattern from a list removes that pattern literally. It
3030 ## does not remove any type matching the pattern.
3032 ## attachments +A */.*
3033 ## attachments +A image/jpeg
3034 ## unattachments +A */.*
3036 ## This leaves "attached" image/jpeg files on the allowed attachments
3037 ## list. It does not remove all items, as you might expect, because the
3038 ## second */.* is not a matching expression at this time.
3040 ## Remember: "unattachments" only undoes what "attachments" has done!
3041 ## It does not trigger any matching on actual messages.
3044 ## Qualify any MIME part with an "attachment" disposition, EXCEPT for
3045 ## text/x-vcard and application/pgp parts. (PGP parts are already known
3046 ## to mutt, and can be searched for with ~g, ~G, and ~k.)
3048 ## I've added x-pkcs7 to this, since it functions (for S/MIME)
3049 ## analogously to PGP signature attachments. S/MIME isn't supported
3050 ## in a stock mutt build, but we can still treat it specially here.
3053 attachments -A text/x-vcard application/pgp.*
3054 attachments -A application/x-pkcs7-.*
3056 ## Discount all MIME parts with an "inline" disposition, unless they're
3057 ## text/plain. (Why inline a text/plain part unless it's external to the
3060 attachments +I text/plain
3062 ## These two lines make Mutt qualify MIME containers. (So, for example,
3063 ## a message/rfc822 forward will count as an attachment.) The first
3064 ## line is unnecessary if you already have "attach-allow */.*", of
3065 ## course. These are off by default! The MIME elements contained
3066 ## within a message/* or multipart/* are still examined, even if the
3067 ## containers themseves don't qualify.
3069 #attachments +A message/.* multipart/.*
3070 #attachments +I message/.* multipart/.*
3072 ## You probably don't really care to know about deleted attachments.
3073 attachments -A message/external-body
3074 attachments -I message/external-body
3076 "attachments ?" will list your current settings in Muttrc format, so
3077 that it can be pasted elsewhere.
3078 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="mime-lookup"></a>7. MIME Lookup</h2></div></div></div><p>
3079 Mutt's mime_lookup list specifies a list of mime-types that should not
3080 be treated according to their mailcap entry. This option is designed to
3081 deal with binary types such as application/octet-stream. When an attachment's
3082 mime-type is listed in mime_lookup, then the extension of the filename will
3083 be compared to the list of extensions in the mime.types file. The mime-type
3084 associated with this extension will then be used to process the attachment
3085 according to the rules in the mailcap file and according to any other configuration
3086 options (such as auto_view) specified. Common usage would be:
3088 </p><pre class="screen">
3089 mime_lookup application/octet-stream application/X-Lotus-Manuscript
3093 In addition, the unmime_lookup command may be used to disable this feature
3094 for any particular mime-type if it had been set, for example, in a global
3096 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="optionalfeatures"></a>Chapter 6. Optional features</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#id462485">1. General notes</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id462491">1.1. Enabling/disabling features</a></span></dt><dt><span class="sect2"><a href="#url-syntax">1.2. URL syntax</a></span></dt></dl></dd><dt><span class="sect1"><a href="#ssl">2. SSL/TLS Support</a></span></dt><dt><span class="sect1"><a href="#pop">3. POP3 Support</a></span></dt><dt><span class="sect1"><a href="#imap">4. IMAP Support</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id462908">4.1. The Folder Browser</a></span></dt><dt><span class="sect2"><a href="#id463028">4.2. Authentication</a></span></dt></dl></dd><dt><span class="sect1"><a href="#smtp">5. SMTP Support</a></span></dt><dt><span class="sect1"><a href="#account-hook">6. Managing multiple accounts</a></span></dt><dt><span class="sect1"><a href="#caching">7. Local caching</a></span></dt><dd><dl><dt><span class="sect2"><a href="#header-caching">7.1. Header caching</a></span></dt><dt><span class="sect2"><a href="#body-caching">7.2. Body caching</a></span></dt><dt><span class="sect2"><a href="#maint-cache">7.3. Maintenance</a></span></dt></dl></dd><dt><span class="sect1"><a href="#exact-address">8. Exact address generation</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="id462485"></a>1. General notes</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id462491"></a>1.1. Enabling/disabling features</h3></div></div></div><p>
3097 Mutt supports several of optional features which can be enabled or
3098 disabled at compile-time by giving the <span class="emphasis"><em>configure</em></span> script
3099 certain arguments. These are listed in the ``Optional features'' section of
3100 the <span class="emphasis"><em>configure --help</em></span> output.
3102 Which features are enabled or disabled can later be determined from the
3103 output of <code class="literal">mutt -v</code>. If a compile option starts with
3104 ``+'' it is enabled and disabled if prefixed with ``-''. For example, if
3105 mutt was compiled using GnuTLS for encrypted communication instead of
3106 OpenSSL, <code class="literal">mutt -v</code> would contain:
3107 </p><pre class="screen">
3108 -USE_SSL_OPENSSL +USE_SSL_GNUTLS</pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="url-syntax"></a>1.2. URL syntax</h3></div></div></div><p>
3109 Mutt optionally supports the IMAP, POP3 and SMTP protocols which require
3110 to access servers using URLs. The canonical syntax for specifying URLs
3111 in mutt is (an item enclosed in <code class="literal">[]</code> means it is optional and
3113 </p><pre class="screen">
3114 proto[s]://[username[:password]@]server[:port]/[path]
3116 <code class="literal">proto</code> is the communication protocol:
3117 <code class="literal">imap</code> for IMAP, <code class="literal">pop</code> for POP3 and
3118 <code class="literal">smtp</code> for SMTP. If ``s'' for ``secure communication''
3119 is appended, mutt will attempt to establish an encrypted communication
3120 using SSL or TLS. If no explicit port is given, mutt will use the
3121 system's default for the given protocol.
3123 Since all protocols by mutt support authentication, the username may be
3124 given directly in the URL instead of using the <code class="literal">pop_user</code> or
3125 <code class="literal">imap_user</code> variables. A password can be given, too but
3126 is not recommended if the URL is specified in a configuration file on
3129 The optional path is only relevant for IMAP.
3131 For IMAP for example, you can select an alternative port by specifying it with the
3132 server: <code class="literal">imap://imapserver:port/INBOX</code>. You can also specify different
3133 username for each folder: <code class="literal">imap://username@imapserver[:port]/INBOX</code>
3134 or <code class="literal">imap://username2@imapserver[:port]/path/to/folder</code>.
3135 Replacing <code class="literal">imap://</code> by <code class="literal">imaps://</code>
3136 would make mutt attempt to conect using SSL or TLS on a different port
3137 to encrypt the communication.
3138 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="ssl"></a>2. SSL/TLS Support</h2></div></div></div><p>
3139 If mutt is compiled with IMAP, POP3 and/or SMTP support, it can also be
3140 compiled with support for SSL or TLS using either OpenSSL or GnuTLS (
3141 by running the <span class="emphasis"><em>configure</em></span> script with the
3142 <span class="emphasis"><em>--enable-ssl=...</em></span> option for OpenSSL or
3143 <span class="emphasis"><em>--enable-gnutls=...</em></span> for GnuTLS). Mutt can then
3144 attempt to encrypt communication with remote servers if these protocols
3145 are suffixed with ``s'' for ``secure communication''.
3146 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="pop"></a>3. POP3 Support</h2></div></div></div><p>
3147 If Mutt was compiled with POP3 support (by running the <span class="emphasis"><em>configure</em></span>
3148 script with the <span class="emphasis"><em>--enable-pop</em></span> flag), it has the ability to work
3149 with mailboxes located on a remote POP3 server and fetch mail for local
3152 Remote POP3 servers can be accessed using URLs with the <code class="literal">pop</code> protocol
3153 for unencrypted and <code class="literal">pops</code> for encrypted
3154 communication, see <a href="#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a> for details.
3156 Polling for new mail is more expensive over POP3 than locally. For this
3157 reason the frequency at which Mutt will check for mail remotely can be
3159 <a href="#pop-checkinterval" title="3.215. pop_checkinterval">$pop_checkinterval</a>
3160 variable, which defaults to every 60 seconds.
3162 Another way to access your POP3 mail is the <span class="emphasis"><em>fetch-mail</em></span> function
3163 (default: G). It allows to connect to <a href="#pop-host" title="3.217. pop_host">$pop_host</a>, fetch all your new mail and place it in the
3164 local <a href="#spoolfile" title="3.276. spoolfile">$spoolfile</a>. After this
3165 point, Mutt runs exactly as if the mail had always been local.
3167 <span class="bold"><strong>Note:</strong></span> If you only need to fetch all messages to a
3168 local mailbox you should consider using a specialized program, such as
3169 <code class="literal">fetchmail</code>, <code class="literal">getmail</code> or similar.
3170 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="imap"></a>4. IMAP Support</h2></div></div></div><p>
3171 If Mutt was compiled with IMAP support (by running the <span class="emphasis"><em>configure</em></span>
3172 script with the <span class="emphasis"><em>--enable-imap</em></span> flag), it has the ability to work
3173 with folders located on a remote IMAP server.
3175 You can access the remote inbox by selecting the folder by its URL
3176 (see <a href="#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a> for details) using the
3177 <code class="literal">imap</code> or <code class="literal">imaps</code> protocol.
3178 Alternatively, a pine-compatible notation is also supported, ie
3179 <code class="literal">{[username@]imapserver[:port][/ssl]}path/to/folder</code>
3181 Note that not all servers use ``/'' as the hierarchy separator. Mutt should
3182 correctly notice which separator is being used by the server and convert
3185 When browsing folders on an IMAP server, you can toggle whether to look
3186 at only the folders you are subscribed to, or all folders with the
3187 <span class="emphasis"><em>toggle-subscribed</em></span> command. See also the
3188 <a href="#imap-list-subscribed" title="3.89. imap_list_subscribed">$imap_list_subscribed</a> variable.
3190 Polling for new mail on an IMAP server can cause noticeable delays. So, you'll
3191 want to carefully tune the
3192 <a href="#mail-check" title="3.104. mail_check">$mail_check</a>
3194 <a href="#timeout" title="3.287. timeout">$timeout</a>
3195 variables. Personally I use
3197 </p><pre class="screen">
3202 with relatively good results over my slow modem line.
3204 Note that if you are using mbox as the mail store on UW servers prior to
3205 v12.250, the server has been reported to disconnect a client if another client
3206 selects the same folder.
3207 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id462908"></a>4.1. The Folder Browser</h3></div></div></div><p>
3208 As of version 1.2, mutt supports browsing mailboxes on an IMAP
3209 server. This is mostly the same as the local file browser, with the
3210 following differences:
3212 </p><div class="itemizedlist"><ul type="disc"><li><p>
3213 In lieu of file permissions, mutt displays the string "IMAP",
3214 possibly followed by the symbol "+", indicating
3215 that the entry contains both messages and subfolders. On
3216 Cyrus-like servers folders will often contain both messages and
3219 For the case where an entry can contain both messages and
3220 subfolders, the selection key (bound to <code class="literal">enter</code> by default)
3221 will choose to descend into the subfolder view. If you wish to view
3222 the messages in that folder, you must use <code class="literal">view-file</code> instead
3223 (bound to <code class="literal">space</code> by default).
3225 You can create, delete and rename mailboxes with the
3226 <code class="literal">create-mailbox</code>, <code class="literal">delete-mailbox</code>, and
3227 <code class="literal">rename-mailbox</code> commands (default bindings: <code class="literal">C</code>,
3228 <code class="literal">d</code> and <code class="literal">r</code>, respectively). You may also
3229 <code class="literal">subscribe</code> and <code class="literal">unsubscribe</code> to mailboxes (normally
3230 these are bound to <code class="literal">s</code> and <code class="literal">u</code>, respectively).
3231 </p></li></ul></div><p>
3233 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id463028"></a>4.2. Authentication</h3></div></div></div><p>
3234 Mutt supports four authentication methods with IMAP servers: SASL,
3235 GSSAPI, CRAM-MD5, and LOGIN (there is a patch by Grant Edwards to add
3236 NTLM authentication for you poor exchange users out there, but it has
3237 yet to be integrated into the main tree). There is also support for
3238 the pseudo-protocol ANONYMOUS, which allows you to log in to a public
3239 IMAP server without having an account. To use ANONYMOUS, simply make
3240 your username blank or "anonymous".
3242 SASL is a special super-authenticator, which selects among several protocols
3243 (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the most secure
3244 method available on your host and the server. Using some of these methods
3245 (including DIGEST-MD5 and possibly GSSAPI), your entire session will be
3246 encrypted and invisible to those teeming network snoops. It is the best
3247 option if you have it. To use it, you must have the Cyrus SASL library
3248 installed on your system and compile mutt with the <span class="emphasis"><em>--with-sasl</em></span> flag.
3250 Mutt will try whichever methods are compiled in and available on the server,
3251 in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN.
3253 There are a few variables which control authentication:
3255 </p><div class="itemizedlist"><ul type="disc"><li><p>
3256 <a href="#imap-user" title="3.95. imap_user">$imap_user</a> - controls
3257 the username under which you request authentication on the IMAP server,
3258 for all authenticators. This is overridden by an explicit username in
3259 the mailbox path (ie by using a mailbox name of the form
3260 <code class="literal">{user@host}</code>).
3262 <a href="#imap-pass" title="3.91. imap_pass">$imap_pass</a> - a
3263 password which you may preset, used by all authentication methods where
3264 a password is needed.
3266 <a href="#imap-authenticators" title="3.83. imap_authenticators">$imap_authenticators</a> - a colon-delimited list of IMAP
3267 authentication methods to try, in the order you wish to try them. If
3268 specified, this overrides mutt's default (attempt everything, in the order
3270 </p></li></ul></div><p>
3272 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="smtp"></a>5. SMTP Support</h2></div></div></div><p>
3273 Besides supporting traditional mail delivery through a
3274 sendmail-compatible program, mutt supports delivery through SMTP if it
3275 was configured and built with <code class="literal">--enable-smtp</code>.
3277 If the configuration variable
3278 <a href="#smtp-url" title="3.269. smtp_url">$smtp_url</a> is set, mutt
3279 will contact the given SMTP server to deliver messages; if it is unset,
3280 mutt will use the program specified by <a href="#sendmail" title="3.257. sendmail">$sendmail</a>.
3282 For details on the URL syntax, please see <a href="#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a>.
3284 The built-in SMTP support supports encryption (the <code class="literal">smtps</code> protocol
3285 using SSL or TLS) as well as SMTP authentication using SASL. The authentication mechanisms
3286 for SASL are specified in <a href="#smtp-authenticators" title="3.267. smtp_authenticators">$smtp_authenticators</a>
3287 defaulting to an empty list which makes mutt try all available methods
3288 from most-secure to least-secure.
3289 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="account-hook"></a>6. Managing multiple accounts</h2></div></div></div><p>
3290 If you happen to have accounts on multiple IMAP, POP and/or SMTP servers,
3291 you may find managing all the authentication settings inconvenient and
3292 error-prone. The account-hook command may help. This hook works like
3293 folder-hook but is invoked whenever you access a remote mailbox
3294 (including inside the folder browser), not just when you open the
3300 </p><pre class="screen">
3301 account-hook . 'unset imap_user; unset imap_pass; unset tunnel'
3302 account-hook imap://host1/ 'set imap_user=me1 imap_pass=foo'
3303 account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"'
3304 account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"'
3307 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="caching"></a>7. Local caching</h2></div></div></div><p>
3308 Mutt contains two types of local caching: <span class="emphasis"><em>(1)</em></span>
3309 the so-called ``header caching'' and <span class="emphasis"><em>(2)</em></span> the
3310 so-called ``body caching'' which are both described in this section.
3312 Header caching is optional as it depends on external libraries, body
3313 caching is always enabled if mutt is compiled with POP and/or IMAP
3314 support as these use it (body caching requires no external library).
3315 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-caching"></a>7.1. Header caching</h3></div></div></div><p>
3316 Mutt provides optional support for caching message headers for the
3317 following types of folders: IMAP, POP, Maildir and MH. Header caching
3318 greatly improves speed because for remote folders, headers
3319 usually only need to be downloaded once. For Maildir and MH, reading the
3320 headers from a single file is much faster than looking at possibly
3321 thousands of single files (since Maildir and MH use one file per message.)
3323 Header caching can be enabled via the configure script and the
3324 <span class="emphasis"><em>--enable-hcache</em></span> option. It's not turned on
3325 by default because external database libraries are required: one
3326 of qdbm, gdbm or bdb must be present.
3328 If enabled, <a href="#header-cache" title="3.107. header_cache">$header_cache</a> can be
3329 used to either point to a file or a directory. If set to point to
3330 a file, one database file for all folders will be used (which may
3331 result in lower performance), but one file per folder if it points
3334 For the one-file-per-folder case, database files for remote folders
3335 will be named according to their URL while database files for local
3336 folders will be named by the MD5 checksums of their path. These database
3337 files may be safely removed if a system is short on space. You
3338 can compute the name of the header cache file for a particular local folder
3339 through a command like the following:
3341 </p><pre class="screen">
3342 $ printf '%s' '/path/to/folder' | md5sum
3345 The <code class="literal">md5sum</code> command may also be
3346 named <code class="literal">md5</code>, depending on your operating system.
3347 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="body-caching"></a>7.2. Body caching</h3></div></div></div><p>
3348 Both cache methods can be combined using the same directory for storage
3349 (and for IMAP/POP even provide meaningful file names) which simplifies
3350 manual maintenance tasks.
3352 In addition to caching message headers only, mutt can also cache
3353 whole message bodies. This results in faster display of messages
3354 for POP and IMAP folders because messages usually have to be
3355 downloaded only once.
3357 For configuration, the variable <a href="#message-cachedir" title="3.132. message_cachedir">$message_cachedir</a> must point to a
3358 directory. There, mutt will create a hierarchy of subdirectories
3359 named like: <code class="literal">proto:user@hostname</code> where
3360 <code class="literal">proto</code> is either ``pop'' or ``imap.'' Within
3361 there for each folder, mutt stores messages in single files (just
3362 like Maildir) so that with manual symlink creation these cache
3363 directories can be examined with mutt as read-only Maildir folders.
3365 All files can be removed as needed if the consumed disk space
3366 becomes an issue as mutt will silently fetch missing items again.
3367 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maint-cache"></a>7.3. Maintenance</h3></div></div></div><p>
3368 Mutt does not (yet) support maintenance features for header cache
3369 database files so that files have to be removed in case they grow too
3370 big. It depends on the database library used for header caching whether
3371 disk space freed by removing messages is re-used.
3373 For body caches, mutt can keep the local cache in sync with the
3374 remote mailbox if the
3375 <a href="#message-cache-clean" title="3.133. message_cache_clean">$message_cache_clean</a>
3376 variable is set. Cleaning means to remove messages from the cache which
3377 are no longer present in the mailbox which only happens when other mail
3378 clients or instances of mutt using a different body cache location
3379 delete messages (Mutt itself removes deleted messages from the cache
3380 when syncing a mailbox). As cleaning can take a noticeable amount of time,
3381 it should not be set in general but only occasionally.
3382 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="exact-address"></a>8. Exact address generation</h2></div></div></div><p>
3383 Mutt supports the ``Name <user@host>'' address syntax for reading and
3384 writing messages, the older ``user@host (Name)'' syntax is only supported when
3385 reading messages. The <span class="emphasis"><em>--enable-exact-address</em></span>
3386 switch can be given to configure to build it with write-support
3387 for the latter syntax. <code class="literal">EXACT_ADDRESS</code> in the output of
3388 <code class="literal">mutt -v</code> indicates whether it's supported.
3389 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="tuning"></a>Chapter 7. Performance tuning</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#tuning-mailboxes">1. Reading and writing mailboxes</a></span></dt><dt><span class="sect1"><a href="#tuning-messages">2. Reading messages from remote folders</a></span></dt><dt><span class="sect1"><a href="#tuning-search">3. Searching and limiting</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-mailboxes"></a>1. Reading and writing mailboxes</h2></div></div></div><p>
3390 Mutt's performance when reading mailboxes can be improved in two ways:
3392 </p><div class="orderedlist"><ol type="1"><li><p>
3393 For remote folders (IMAP and POP) as well as folders using
3394 one-file-per message storage (Maildir and MH), mutt's
3395 performance can be greatly improved using
3396 <a href="#header-caching" title="7.1. Header caching">header caching</a>.
3397 Using a single database per folder may further increase
3400 Mutt provides the <a href="#read-inc" title="3.235. read_inc">$read_inc</a>
3401 and <a href="#write-inc" title="3.304. write_inc">$write_inc</a>
3402 variables to specify at which rate to update progress
3403 counters. If these values are too low, mutt may spend more
3404 time on updating the progress counter than it spends on
3405 actually reading/writing folders.
3407 For example, when opening a maildir folder with a few
3408 thousand messages, the default value for
3409 <a href="#read-inc" title="3.235. read_inc">$read_inc</a>
3410 may be too low. It can be tuned on on a folder-basis using
3411 <a href="#folder-hook" title="6. Setting variables based upon mailbox">folder-hooks</a>:
3413 </p><pre class="screen">
3414 # use very high $read_inc to speed up reading hcache'd maildirs
3415 folder-hook . 'set read_inc=1000'
3416 # use lower value for reading slower remote IMAP folders
3417 folder-hook ^imap 'set read_inc=100'
3418 # use even lower value for reading even slower remote POP folders
3419 folder-hook ^pop 'set read_inc=1'</pre><p>
3420 </p></li></ol></div><p>
3421 </p><p>These settings work on a per-message basis. However, as messages may
3422 greatly differ in size and certain operations are much faster than others,
3423 even per-folder settings of the increment variables may not be
3424 desirable as they produce either too few or too much progress updates.
3425 Thus, Mutt allows to limit the number of progress updates per second it'll
3426 actually send to the terminal using the
3427 <a href="#time-inc" title="3.286. time_inc">$time_inc</a> variable.</p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-messages"></a>2. Reading messages from remote folders</h2></div></div></div><p>
3428 Reading messages from remote folders such as IMAP an POP can be
3429 slow especially for large mailboxes since mutt only caches a very
3430 limited number of recently viewed messages (usually 10) per
3431 session (so that it will be gone for the next session.)
3433 To improve performance and permanently cache whole messages,
3434 please refer to mutt's so-called
3435 <a href="#body-caching" title="7.2. Body caching">body caching</a> for details.
3436 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="tuning-search"></a>3. Searching and limiting</h2></div></div></div><p>
3437 When searching mailboxes either via a search or a limit action, for
3438 some patterns mutt distinguishes between regular expression and string
3439 searches. For regular expressions, patterns are prefixed with
3440 ``˜'' and with ``='' for string searches.
3442 Even though a regular expression search is fast, it's several times
3443 slower than a pure string search which is noticable especially on large
3444 folders. As a consequence, a string search should be used instead of a
3445 regular expression search if the user already knows enough about the
3448 For example, when limiting a large folder to all messages sent to or by
3449 an author, it's much faster to search for the initial part of an e-mail
3450 address via <code class="literal">=Luser@</code> instead of
3451 <code class="literal">˜Luser@</code>. This is especially true for searching
3452 message bodies since a larger amount of input has to be searched.
3454 Please note that string search is an exact case-sensitive search
3455 while a regular expression search with only lower-case letters performs
3456 a case-insensitive search.
3457 </p></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="reference"></a>Chapter 8. Reference</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#commandline">1. Command line options</a></span></dt><dt><span class="sect1"><a href="#commands">2. Configuration Commands</a></span></dt><dt><span class="sect1"><a href="#variables">3. Configuration variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="#abort-nosubject">3.1. abort_nosubject</a></span></dt><dt><span class="sect2"><a href="#abort-unmodified">3.2. abort_unmodified</a></span></dt><dt><span class="sect2"><a href="#alias-file">3.3. alias_file</a></span></dt><dt><span class="sect2"><a href="#alias-format">3.4. alias_format</a></span></dt><dt><span class="sect2"><a href="#allow-8bit">3.5. allow_8bit</a></span></dt><dt><span class="sect2"><a href="#allow-ansi">3.6. allow_ansi</a></span></dt><dt><span class="sect2"><a href="#arrow-cursor">3.7. arrow_cursor</a></span></dt><dt><span class="sect2"><a href="#ascii-chars">3.8. ascii_chars</a></span></dt><dt><span class="sect2"><a href="#askbcc">3.9. askbcc</a></span></dt><dt><span class="sect2"><a href="#askcc">3.10. askcc</a></span></dt><dt><span class="sect2"><a href="#assumed-charset">3.11. assumed_charset</a></span></dt><dt><span class="sect2"><a href="#attach-charset">3.12. attach_charset</a></span></dt><dt><span class="sect2"><a href="#attach-format">3.13. attach_format</a></span></dt><dt><span class="sect2"><a href="#attach-sep">3.14. attach_sep</a></span></dt><dt><span class="sect2"><a href="#attach-split">3.15. attach_split</a></span></dt><dt><span class="sect2"><a href="#attribution">3.16. attribution</a></span></dt><dt><span class="sect2"><a href="#autoedit">3.17. autoedit</a></span></dt><dt><span class="sect2"><a href="#auto-tag">3.18. auto_tag</a></span></dt><dt><span class="sect2"><a href="#beep">3.19. beep</a></span></dt><dt><span class="sect2"><a href="#beep-new">3.20. beep_new</a></span></dt><dt><span class="sect2"><a href="#bounce">3.21. bounce</a></span></dt><dt><span class="sect2"><a href="#bounce-delivered">3.22. bounce_delivered</a></span></dt><dt><span class="sect2"><a href="#braille-friendly">3.23. braille_friendly</a></span></dt><dt><span class="sect2"><a href="#check-mbox-size">3.24. check_mbox_size</a></span></dt><dt><span class="sect2"><a href="#charset">3.25. charset</a></span></dt><dt><span class="sect2"><a href="#check-new">3.26. check_new</a></span></dt><dt><span class="sect2"><a href="#collapse-unread">3.27. collapse_unread</a></span></dt><dt><span class="sect2"><a href="#uncollapse-jump">3.28. uncollapse_jump</a></span></dt><dt><span class="sect2"><a href="#compose-format">3.29. compose_format</a></span></dt><dt><span class="sect2"><a href="#config-charset">3.30. config_charset</a></span></dt><dt><span class="sect2"><a href="#confirmappend">3.31. confirmappend</a></span></dt><dt><span class="sect2"><a href="#confirmcreate">3.32. confirmcreate</a></span></dt><dt><span class="sect2"><a href="#connect-timeout">3.33. connect_timeout</a></span></dt><dt><span class="sect2"><a href="#content-type">3.34. content_type</a></span></dt><dt><span class="sect2"><a href="#copy">3.35. copy</a></span></dt><dt><span class="sect2"><a href="#crypt-use-gpgme">3.36. crypt_use_gpgme</a></span></dt><dt><span class="sect2"><a href="#crypt-use-pka">3.37. crypt_use_pka</a></span></dt><dt><span class="sect2"><a href="#crypt-autopgp">3.38. crypt_autopgp</a></span></dt><dt><span class="sect2"><a href="#crypt-autosmime">3.39. crypt_autosmime</a></span></dt><dt><span class="sect2"><a href="#date-format">3.40. date_format</a></span></dt><dt><span class="sect2"><a href="#default-hook">3.41. default_hook</a></span></dt><dt><span class="sect2"><a href="#delete">3.42. delete</a></span></dt><dt><span class="sect2"><a href="#delete-untag">3.43. delete_untag</a></span></dt><dt><span class="sect2"><a href="#digest-collapse">3.44. digest_collapse</a></span></dt><dt><span class="sect2"><a href="#display-filter">3.45. display_filter</a></span></dt><dt><span class="sect2"><a href="#dotlock-program">3.46. dotlock_program</a></span></dt><dt><span class="sect2"><a href="#dsn-notify">3.47. dsn_notify</a></span></dt><dt><span class="sect2"><a href="#dsn-return">3.48. dsn_return</a></span></dt><dt><span class="sect2"><a href="#duplicate-threads">3.49. duplicate_threads</a></span></dt><dt><span class="sect2"><a href="#edit-headers">3.50. edit_headers</a></span></dt><dt><span class="sect2"><a href="#editor">3.51. editor</a></span></dt><dt><span class="sect2"><a href="#encode-from">3.52. encode_from</a></span></dt><dt><span class="sect2"><a href="#envelope-from-address">3.53. envelope_from_address</a></span></dt><dt><span class="sect2"><a href="#escape">3.54. escape</a></span></dt><dt><span class="sect2"><a href="#fast-reply">3.55. fast_reply</a></span></dt><dt><span class="sect2"><a href="#fcc-attach">3.56. fcc_attach</a></span></dt><dt><span class="sect2"><a href="#fcc-clear">3.57. fcc_clear</a></span></dt><dt><span class="sect2"><a href="#folder">3.58. folder</a></span></dt><dt><span class="sect2"><a href="#folder-format">3.59. folder_format</a></span></dt><dt><span class="sect2"><a href="#followup-to">3.60. followup_to</a></span></dt><dt><span class="sect2"><a href="#force-name">3.61. force_name</a></span></dt><dt><span class="sect2"><a href="#forward-decode">3.62. forward_decode</a></span></dt><dt><span class="sect2"><a href="#forward-edit">3.63. forward_edit</a></span></dt><dt><span class="sect2"><a href="#forward-format">3.64. forward_format</a></span></dt><dt><span class="sect2"><a href="#forward-quote">3.65. forward_quote</a></span></dt><dt><span class="sect2"><a href="#from">3.66. from</a></span></dt><dt><span class="sect2"><a href="#gecos-mask">3.67. gecos_mask</a></span></dt><dt><span class="sect2"><a href="#hdrs">3.68. hdrs</a></span></dt><dt><span class="sect2"><a href="#header">3.69. header</a></span></dt><dt><span class="sect2"><a href="#help">3.70. help</a></span></dt><dt><span class="sect2"><a href="#hidden-host">3.71. hidden_host</a></span></dt><dt><span class="sect2"><a href="#hide-limited">3.72. hide_limited</a></span></dt><dt><span class="sect2"><a href="#hide-missing">3.73. hide_missing</a></span></dt><dt><span class="sect2"><a href="#hide-thread-subject">3.74. hide_thread_subject</a></span></dt><dt><span class="sect2"><a href="#hide-top-limited">3.75. hide_top_limited</a></span></dt><dt><span class="sect2"><a href="#hide-top-missing">3.76. hide_top_missing</a></span></dt><dt><span class="sect2"><a href="#history">3.77. history</a></span></dt><dt><span class="sect2"><a href="#history-file">3.78. history_file</a></span></dt><dt><span class="sect2"><a href="#honor-followup-to">3.79. honor_followup_to</a></span></dt><dt><span class="sect2"><a href="#hostname">3.80. hostname</a></span></dt><dt><span class="sect2"><a href="#ignore-linear-white-space">3.81. ignore_linear_white_space</a></span></dt><dt><span class="sect2"><a href="#ignore-list-reply-to">3.82. ignore_list_reply_to</a></span></dt><dt><span class="sect2"><a href="#imap-authenticators">3.83. imap_authenticators</a></span></dt><dt><span class="sect2"><a href="#imap-check-subscribed">3.84. imap_check_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-delim-chars">3.85. imap_delim_chars</a></span></dt><dt><span class="sect2"><a href="#imap-headers">3.86. imap_headers</a></span></dt><dt><span class="sect2"><a href="#imap-idle">3.87. imap_idle</a></span></dt><dt><span class="sect2"><a href="#imap-keepalive">3.88. imap_keepalive</a></span></dt><dt><span class="sect2"><a href="#imap-list-subscribed">3.89. imap_list_subscribed</a></span></dt><dt><span class="sect2"><a href="#imap-login">3.90. imap_login</a></span></dt><dt><span class="sect2"><a href="#imap-pass">3.91. imap_pass</a></span></dt><dt><span class="sect2"><a href="#imap-passive">3.92. imap_passive</a></span></dt><dt><span class="sect2"><a href="#imap-peek">3.93. imap_peek</a></span></dt><dt><span class="sect2"><a href="#imap-servernoise">3.94. imap_servernoise</a></span></dt><dt><span class="sect2"><a href="#imap-user">3.95. imap_user</a></span></dt><dt><span class="sect2"><a href="#implicit-autoview">3.96. implicit_autoview</a></span></dt><dt><span class="sect2"><a href="#include">3.97. include</a></span></dt><dt><span class="sect2"><a href="#include-onlyfirst">3.98. include_onlyfirst</a></span></dt><dt><span class="sect2"><a href="#indent-string">3.99. indent_string</a></span></dt><dt><span class="sect2"><a href="#index-format">3.100. index_format</a></span></dt><dt><span class="sect2"><a href="#ispell">3.101. ispell</a></span></dt><dt><span class="sect2"><a href="#keep-flagged">3.102. keep_flagged</a></span></dt><dt><span class="sect2"><a href="#locale">3.103. locale</a></span></dt><dt><span class="sect2"><a href="#mail-check">3.104. mail_check</a></span></dt><dt><span class="sect2"><a href="#mailcap-path">3.105. mailcap_path</a></span></dt><dt><span class="sect2"><a href="#mailcap-sanitize">3.106. mailcap_sanitize</a></span></dt><dt><span class="sect2"><a href="#header-cache">3.107. header_cache</a></span></dt><dt><span class="sect2"><a href="#maildir-header-cache-verify">3.108. maildir_header_cache_verify</a></span></dt><dt><span class="sect2"><a href="#header-cache-pagesize">3.109. header_cache_pagesize</a></span></dt><dt><span class="sect2"><a href="#header-cache-compress">3.110. header_cache_compress</a></span></dt><dt><span class="sect2"><a href="#maildir-trash">3.111. maildir_trash</a></span></dt><dt><span class="sect2"><a href="#mark-old">3.112. mark_old</a></span></dt><dt><span class="sect2"><a href="#markers">3.113. markers</a></span></dt><dt><span class="sect2"><a href="#mask">3.114. mask</a></span></dt><dt><span class="sect2"><a href="#mbox">3.115. mbox</a></span></dt><dt><span class="sect2"><a href="#mbox-type">3.116. mbox_type</a></span></dt><dt><span class="sect2"><a href="#metoo">3.117. metoo</a></span></dt><dt><span class="sect2"><a href="#menu-context">3.118. menu_context</a></span></dt><dt><span class="sect2"><a href="#menu-move-off">3.119. menu_move_off</a></span></dt><dt><span class="sect2"><a href="#menu-scroll">3.120. menu_scroll</a></span></dt><dt><span class="sect2"><a href="#meta-key">3.121. meta_key</a></span></dt><dt><span class="sect2"><a href="#mh-purge">3.122. mh_purge</a></span></dt><dt><span class="sect2"><a href="#mh-seq-flagged">3.123. mh_seq_flagged</a></span></dt><dt><span class="sect2"><a href="#mh-seq-replied">3.124. mh_seq_replied</a></span></dt><dt><span class="sect2"><a href="#mh-seq-unseen">3.125. mh_seq_unseen</a></span></dt><dt><span class="sect2"><a href="#mime-forward">3.126. mime_forward</a></span></dt><dt><span class="sect2"><a href="#mime-forward-decode">3.127. mime_forward_decode</a></span></dt><dt><span class="sect2"><a href="#mime-forward-rest">3.128. mime_forward_rest</a></span></dt><dt><span class="sect2"><a href="#mix-entry-format">3.129. mix_entry_format</a></span></dt><dt><span class="sect2"><a href="#mixmaster">3.130. mixmaster</a></span></dt><dt><span class="sect2"><a href="#move">3.131. move</a></span></dt><dt><span class="sect2"><a href="#message-cachedir">3.132. message_cachedir</a></span></dt><dt><span class="sect2"><a href="#message-cache-clean">3.133. message_cache_clean</a></span></dt><dt><span class="sect2"><a href="#message-format">3.134. message_format</a></span></dt><dt><span class="sect2"><a href="#narrow-tree">3.135. narrow_tree</a></span></dt><dt><span class="sect2"><a href="#net-inc">3.136. net_inc</a></span></dt><dt><span class="sect2"><a href="#pager">3.137. pager</a></span></dt><dt><span class="sect2"><a href="#pager-context">3.138. pager_context</a></span></dt><dt><span class="sect2"><a href="#pager-format">3.139. pager_format</a></span></dt><dt><span class="sect2"><a href="#pager-index-lines">3.140. pager_index_lines</a></span></dt><dt><span class="sect2"><a href="#pager-stop">3.141. pager_stop</a></span></dt><dt><span class="sect2"><a href="#crypt-autosign">3.142. crypt_autosign</a></span></dt><dt><span class="sect2"><a href="#crypt-autoencrypt">3.143. crypt_autoencrypt</a></span></dt><dt><span class="sect2"><a href="#pgp-ignore-subkeys">3.144. pgp_ignore_subkeys</a></span></dt><dt><span class="sect2"><a href="#crypt-replyencrypt">3.145. crypt_replyencrypt</a></span></dt><dt><span class="sect2"><a href="#crypt-replysign">3.146. crypt_replysign</a></span></dt><dt><span class="sect2"><a href="#crypt-replysignencrypted">3.147. crypt_replysignencrypted</a></span></dt><dt><span class="sect2"><a href="#crypt-timestamp">3.148. crypt_timestamp</a></span></dt><dt><span class="sect2"><a href="#pgp-use-gpg-agent">3.149. pgp_use_gpg_agent</a></span></dt><dt><span class="sect2"><a href="#crypt-verify-sig">3.150. crypt_verify_sig</a></span></dt><dt><span class="sect2"><a href="#smime-is-default">3.151. smime_is_default</a></span></dt><dt><span class="sect2"><a href="#smime-ask-cert-label">3.152. smime_ask_cert_label</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-use-default-key">3.153. smime_decrypt_use_default_key</a></span></dt><dt><span class="sect2"><a href="#pgp-entry-format">3.154. pgp_entry_format</a></span></dt><dt><span class="sect2"><a href="#pgp-good-sign">3.155. pgp_good_sign</a></span></dt><dt><span class="sect2"><a href="#pgp-check-exit">3.156. pgp_check_exit</a></span></dt><dt><span class="sect2"><a href="#pgp-long-ids">3.157. pgp_long_ids</a></span></dt><dt><span class="sect2"><a href="#pgp-retainable-sigs">3.158. pgp_retainable_sigs</a></span></dt><dt><span class="sect2"><a href="#pgp-autoinline">3.159. pgp_autoinline</a></span></dt><dt><span class="sect2"><a href="#pgp-replyinline">3.160. pgp_replyinline</a></span></dt><dt><span class="sect2"><a href="#pgp-show-unusable">3.161. pgp_show_unusable</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-as">3.162. pgp_sign_as</a></span></dt><dt><span class="sect2"><a href="#pgp-strict-enc">3.163. pgp_strict_enc</a></span></dt><dt><span class="sect2"><a href="#pgp-timeout">3.164. pgp_timeout</a></span></dt><dt><span class="sect2"><a href="#pgp-sort-keys">3.165. pgp_sort_keys</a></span></dt><dt><span class="sect2"><a href="#pgp-mime-auto">3.166. pgp_mime_auto</a></span></dt><dt><span class="sect2"><a href="#pgp-auto-decode">3.167. pgp_auto_decode</a></span></dt><dt><span class="sect2"><a href="#pgp-decode-command">3.168. pgp_decode_command</a></span></dt><dt><span class="sect2"><a href="#pgp-getkeys-command">3.169. pgp_getkeys_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-command">3.170. pgp_verify_command</a></span></dt><dt><span class="sect2"><a href="#pgp-decrypt-command">3.171. pgp_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#pgp-clearsign-command">3.172. pgp_clearsign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-sign-command">3.173. pgp_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-sign-command">3.174. pgp_encrypt_sign_command</a></span></dt><dt><span class="sect2"><a href="#pgp-encrypt-only-command">3.175. pgp_encrypt_only_command</a></span></dt><dt><span class="sect2"><a href="#pgp-import-command">3.176. pgp_import_command</a></span></dt><dt><span class="sect2"><a href="#pgp-export-command">3.177. pgp_export_command</a></span></dt><dt><span class="sect2"><a href="#pgp-verify-key-command">3.178. pgp_verify_key_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-secring-command">3.179. pgp_list_secring_command</a></span></dt><dt><span class="sect2"><a href="#pgp-list-pubring-command">3.180. pgp_list_pubring_command</a></span></dt><dt><span class="sect2"><a href="#forward-decrypt">3.181. forward_decrypt</a></span></dt><dt><span class="sect2"><a href="#smime-timeout">3.182. smime_timeout</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-with">3.183. smime_encrypt_with</a></span></dt><dt><span class="sect2"><a href="#smime-keys">3.184. smime_keys</a></span></dt><dt><span class="sect2"><a href="#smime-ca-location">3.185. smime_ca_location</a></span></dt><dt><span class="sect2"><a href="#smime-certificates">3.186. smime_certificates</a></span></dt><dt><span class="sect2"><a href="#smime-decrypt-command">3.187. smime_decrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-command">3.188. smime_verify_command</a></span></dt><dt><span class="sect2"><a href="#smime-verify-opaque-command">3.189. smime_verify_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-command">3.190. smime_sign_command</a></span></dt><dt><span class="sect2"><a href="#smime-sign-opaque-command">3.191. smime_sign_opaque_command</a></span></dt><dt><span class="sect2"><a href="#smime-encrypt-command">3.192. smime_encrypt_command</a></span></dt><dt><span class="sect2"><a href="#smime-pk7out-command">3.193. smime_pk7out_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-command">3.194. smime_get_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-signer-cert-command">3.195. smime_get_signer_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-import-cert-command">3.196. smime_import_cert_command</a></span></dt><dt><span class="sect2"><a href="#smime-get-cert-email-command">3.197. smime_get_cert_email_command</a></span></dt><dt><span class="sect2"><a href="#smime-default-key">3.198. smime_default_key</a></span></dt><dt><span class="sect2"><a href="#ssl-client-cert">3.199. ssl_client_cert</a></span></dt><dt><span class="sect2"><a href="#ssl-force-tls">3.200. ssl_force_tls</a></span></dt><dt><span class="sect2"><a href="#ssl-starttls">3.201. ssl_starttls</a></span></dt><dt><span class="sect2"><a href="#certificate-file">3.202. certificate_file</a></span></dt><dt><span class="sect2"><a href="#ssl-usesystemcerts">3.203. ssl_usesystemcerts</a></span></dt><dt><span class="sect2"><a href="#entropy-file">3.204. entropy_file</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv2">3.205. ssl_use_sslv2</a></span></dt><dt><span class="sect2"><a href="#ssl-use-sslv3">3.206. ssl_use_sslv3</a></span></dt><dt><span class="sect2"><a href="#ssl-use-tlsv1">3.207. ssl_use_tlsv1</a></span></dt><dt><span class="sect2"><a href="#ssl-min-dh-prime-bits">3.208. ssl_min_dh_prime_bits</a></span></dt><dt><span class="sect2"><a href="#ssl-ca-certificates-file">3.209. ssl_ca_certificates_file</a></span></dt><dt><span class="sect2"><a href="#pipe-split">3.210. pipe_split</a></span></dt><dt><span class="sect2"><a href="#pipe-decode">3.211. pipe_decode</a></span></dt><dt><span class="sect2"><a href="#pipe-sep">3.212. pipe_sep</a></span></dt><dt><span class="sect2"><a href="#pop-authenticators">3.213. pop_authenticators</a></span></dt><dt><span class="sect2"><a href="#pop-auth-try-all">3.214. pop_auth_try_all</a></span></dt><dt><span class="sect2"><a href="#pop-checkinterval">3.215. pop_checkinterval</a></span></dt><dt><span class="sect2"><a href="#pop-delete">3.216. pop_delete</a></span></dt><dt><span class="sect2"><a href="#pop-host">3.217. pop_host</a></span></dt><dt><span class="sect2"><a href="#pop-last">3.218. pop_last</a></span></dt><dt><span class="sect2"><a href="#pop-reconnect">3.219. pop_reconnect</a></span></dt><dt><span class="sect2"><a href="#pop-user">3.220. pop_user</a></span></dt><dt><span class="sect2"><a href="#pop-pass">3.221. pop_pass</a></span></dt><dt><span class="sect2"><a href="#post-indent-string">3.222. post_indent_string</a></span></dt><dt><span class="sect2"><a href="#postpone">3.223. postpone</a></span></dt><dt><span class="sect2"><a href="#postponed">3.224. postponed</a></span></dt><dt><span class="sect2"><a href="#preconnect">3.225. preconnect</a></span></dt><dt><span class="sect2"><a href="#print">3.226. print</a></span></dt><dt><span class="sect2"><a href="#print-command">3.227. print_command</a></span></dt><dt><span class="sect2"><a href="#print-decode">3.228. print_decode</a></span></dt><dt><span class="sect2"><a href="#print-split">3.229. print_split</a></span></dt><dt><span class="sect2"><a href="#prompt-after">3.230. prompt_after</a></span></dt><dt><span class="sect2"><a href="#query-command">3.231. query_command</a></span></dt><dt><span class="sect2"><a href="#query-format">3.232. query_format</a></span></dt><dt><span class="sect2"><a href="#quit">3.233. quit</a></span></dt><dt><span class="sect2"><a href="#quote-regexp">3.234. quote_regexp</a></span></dt><dt><span class="sect2"><a href="#read-inc">3.235. read_inc</a></span></dt><dt><span class="sect2"><a href="#read-only">3.236. read_only</a></span></dt><dt><span class="sect2"><a href="#realname">3.237. realname</a></span></dt><dt><span class="sect2"><a href="#recall">3.238. recall</a></span></dt><dt><span class="sect2"><a href="#record">3.239. record</a></span></dt><dt><span class="sect2"><a href="#reply-regexp">3.240. reply_regexp</a></span></dt><dt><span class="sect2"><a href="#reply-self">3.241. reply_self</a></span></dt><dt><span class="sect2"><a href="#reply-to">3.242. reply_to</a></span></dt><dt><span class="sect2"><a href="#resolve">3.243. resolve</a></span></dt><dt><span class="sect2"><a href="#reverse-alias">3.244. reverse_alias</a></span></dt><dt><span class="sect2"><a href="#reverse-name">3.245. reverse_name</a></span></dt><dt><span class="sect2"><a href="#reverse-realname">3.246. reverse_realname</a></span></dt><dt><span class="sect2"><a href="#rfc2047-parameters">3.247. rfc2047_parameters</a></span></dt><dt><span class="sect2"><a href="#save-address">3.248. save_address</a></span></dt><dt><span class="sect2"><a href="#save-empty">3.249. save_empty</a></span></dt><dt><span class="sect2"><a href="#save-history">3.250. save_history</a></span></dt><dt><span class="sect2"><a href="#save-name">3.251. save_name</a></span></dt><dt><span class="sect2"><a href="#score">3.252. score</a></span></dt><dt><span class="sect2"><a href="#score-threshold-delete">3.253. score_threshold_delete</a></span></dt><dt><span class="sect2"><a href="#score-threshold-flag">3.254. score_threshold_flag</a></span></dt><dt><span class="sect2"><a href="#score-threshold-read">3.255. score_threshold_read</a></span></dt><dt><span class="sect2"><a href="#send-charset">3.256. send_charset</a></span></dt><dt><span class="sect2"><a href="#sendmail">3.257. sendmail</a></span></dt><dt><span class="sect2"><a href="#sendmail-wait">3.258. sendmail_wait</a></span></dt><dt><span class="sect2"><a href="#shell">3.259. shell</a></span></dt><dt><span class="sect2"><a href="#sig-dashes">3.260. sig_dashes</a></span></dt><dt><span class="sect2"><a href="#sig-on-top">3.261. sig_on_top</a></span></dt><dt><span class="sect2"><a href="#signature">3.262. signature</a></span></dt><dt><span class="sect2"><a href="#simple-search">3.263. simple_search</a></span></dt><dt><span class="sect2"><a href="#smart-wrap">3.264. smart_wrap</a></span></dt><dt><span class="sect2"><a href="#smileys">3.265. smileys</a></span></dt><dt><span class="sect2"><a href="#sleep-time">3.266. sleep_time</a></span></dt><dt><span class="sect2"><a href="#smtp-authenticators">3.267. smtp_authenticators</a></span></dt><dt><span class="sect2"><a href="#smtp-pass">3.268. smtp_pass</a></span></dt><dt><span class="sect2"><a href="#smtp-url">3.269. smtp_url</a></span></dt><dt><span class="sect2"><a href="#sort">3.270. sort</a></span></dt><dt><span class="sect2"><a href="#sort-alias">3.271. sort_alias</a></span></dt><dt><span class="sect2"><a href="#sort-aux">3.272. sort_aux</a></span></dt><dt><span class="sect2"><a href="#sort-browser">3.273. sort_browser</a></span></dt><dt><span class="sect2"><a href="#sort-re">3.274. sort_re</a></span></dt><dt><span class="sect2"><a href="#spam-separator">3.275. spam_separator</a></span></dt><dt><span class="sect2"><a href="#spoolfile">3.276. spoolfile</a></span></dt><dt><span class="sect2"><a href="#status-chars">3.277. status_chars</a></span></dt><dt><span class="sect2"><a href="#status-format">3.278. status_format</a></span></dt><dt><span class="sect2"><a href="#status-on-top">3.279. status_on_top</a></span></dt><dt><span class="sect2"><a href="#strict-threads">3.280. strict_threads</a></span></dt><dt><span class="sect2"><a href="#suspend">3.281. suspend</a></span></dt><dt><span class="sect2"><a href="#text-flowed">3.282. text_flowed</a></span></dt><dt><span class="sect2"><a href="#thread-received">3.283. thread_received</a></span></dt><dt><span class="sect2"><a href="#thorough-search">3.284. thorough_search</a></span></dt><dt><span class="sect2"><a href="#tilde">3.285. tilde</a></span></dt><dt><span class="sect2"><a href="#time-inc">3.286. time_inc</a></span></dt><dt><span class="sect2"><a href="#timeout">3.287. timeout</a></span></dt><dt><span class="sect2"><a href="#tmpdir">3.288. tmpdir</a></span></dt><dt><span class="sect2"><a href="#to-chars">3.289. to_chars</a></span></dt><dt><span class="sect2"><a href="#tunnel">3.290. tunnel</a></span></dt><dt><span class="sect2"><a href="#use-8bitmime">3.291. use_8bitmime</a></span></dt><dt><span class="sect2"><a href="#use-domain">3.292. use_domain</a></span></dt><dt><span class="sect2"><a href="#use-envelope-from">3.293. use_envelope_from</a></span></dt><dt><span class="sect2"><a href="#use-from">3.294. use_from</a></span></dt><dt><span class="sect2"><a href="#use-idn">3.295. use_idn</a></span></dt><dt><span class="sect2"><a href="#use-ipv6">3.296. use_ipv6</a></span></dt><dt><span class="sect2"><a href="#user-agent">3.297. user_agent</a></span></dt><dt><span class="sect2"><a href="#visual">3.298. visual</a></span></dt><dt><span class="sect2"><a href="#wait-key">3.299. wait_key</a></span></dt><dt><span class="sect2"><a href="#weed">3.300. weed</a></span></dt><dt><span class="sect2"><a href="#wrap">3.301. wrap</a></span></dt><dt><span class="sect2"><a href="#wrap-search">3.302. wrap_search</a></span></dt><dt><span class="sect2"><a href="#wrapmargin">3.303. wrapmargin</a></span></dt><dt><span class="sect2"><a href="#write-inc">3.304. write_inc</a></span></dt><dt><span class="sect2"><a href="#write-bcc">3.305. write_bcc</a></span></dt></dl></dd><dt><span class="sect1"><a href="#functions">4. Functions</a></span></dt><dd><dl><dt><span class="sect2"><a href="#generic_map">4.1. generic</a></span></dt><dt><span class="sect2"><a href="#index_map">4.2. index</a></span></dt><dt><span class="sect2"><a href="#pager_map">4.3. pager</a></span></dt><dt><span class="sect2"><a href="#alias_map">4.4. alias</a></span></dt><dt><span class="sect2"><a href="#query_map">4.5. query</a></span></dt><dt><span class="sect2"><a href="#attach_map">4.6. attach</a></span></dt><dt><span class="sect2"><a href="#compose_map">4.7. compose</a></span></dt><dt><span class="sect2"><a href="#postpone_map">4.8. postpone</a></span></dt><dt><span class="sect2"><a href="#browser_map">4.9. browser</a></span></dt><dt><span class="sect2"><a href="#pgp_map">4.10. pgp</a></span></dt><dt><span class="sect2"><a href="#smime_map">4.11. smime</a></span></dt><dt><span class="sect2"><a href="#mix_map">4.12. mix</a></span></dt><dt><span class="sect2"><a href="#editor_map">4.13. editor</a></span></dt></dl></dd></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="commandline"></a>1. Command line options</h2></div></div></div><p>
3458 Running <code class="literal">mutt</code> with no arguments will make Mutt attempt to read your spool
3459 mailbox. However, it is possible to read other mailboxes and
3460 to send messages from the command line as well.
3463 </p><div class="table"><a id="id463727"></a><p class="title"><b>Table 8.1. Command line options</b></p><div class="table-contents"><table summary="Command line options" border="1"><colgroup><col /><col /></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td>-A</td><td>expand an alias</td></tr><tr><td>-a</td><td>attach a file to a message</td></tr><tr><td>-b</td><td>specify a blind carbon-copy (BCC) address</td></tr><tr><td>-c</td><td>specify a carbon-copy (Cc) address</td></tr><tr><td>-D</td><td>print the value of all mutt variables to stdout</td></tr><tr><td>-e</td><td>specify a config command to be run after initialization files are read</td></tr><tr><td>-f</td><td>specify a mailbox to load</td></tr><tr><td>-F</td><td>specify an alternate file to read initialization commands</td></tr><tr><td>-h</td><td>print help on command line options</td></tr><tr><td>-H</td><td>specify a draft file from which to read a header and body</td></tr><tr><td>-i</td><td>specify a file to include in a message composition</td></tr><tr><td>-m</td><td>specify a default mailbox type</td></tr><tr><td>-n</td><td>do not read the system Muttrc</td></tr><tr><td>-p</td><td>recall a postponed message</td></tr><tr><td>-Q</td><td>query a configuration variable</td></tr><tr><td>-R</td><td>open mailbox in read-only mode</td></tr><tr><td>-s</td><td>specify a subject (enclose in quotes if it contains spaces)</td></tr><tr><td>-v</td><td>show version number and compile-time definitions</td></tr><tr><td>-x</td><td>simulate the mailx(1) compose mode</td></tr><tr><td>-y</td><td>show a menu containing the files specified by the mailboxes command</td></tr><tr><td>-z</td><td>exit immediately if there are no messages in the mailbox</td></tr><tr><td>-Z</td><td>open the first folder with new message,exit immediately if none</td></tr></tbody></table></div></div><p><br class="table-break" />
3466 To read messages in a mailbox
3468 <code class="literal">mutt</code> [ -nz ] [ -F <span class="emphasis"><em>muttrc</em></span> ] [ -m <span class="emphasis"><em>type</em></span> ] [ -f <span class="emphasis"><em>mailbox</em></span> ]
3470 To compose a new message
3472 <code class="literal">mutt</code> [ -n ] [ -F <span class="emphasis"><em>muttrc</em></span> ] [ -a <span class="emphasis"><em>file</em></span> ] [ -c <span class="emphasis"><em>address</em></span> ] [ -i <span class="emphasis"><em>filename</em></span> ] [ -s <span class="emphasis"><em>subject</em></span> ]
3473 [ [ <span class="emphasis"><em>file</em></span> ... ] -- ] <span class="emphasis"><em>address</em></span> [ <span class="emphasis"><em>address</em></span> ... ]
3475 Mutt also supports a ``batch'' mode to send prepared messages. Simply redirect
3476 input from the file you wish to send. For example,
3478 <code class="literal">mutt -s "data set for run #2" professor@bigschool.edu
3479 < ˜/run2.dat</code>
3481 This command will send a message to ``professor@bigschool.edu'' with a subject
3482 of ``data set for run #2''. In the body of the message will be the contents
3483 of the file ``˜/run2.dat''.
3485 All files passed with -a <span class="emphasis"><em>file</em></span> will be attached as a MIME
3486 part to the message. To attach several files, use ``--'' to separate files and
3487 recipient addresses: <code class="literal">mutt -a *.png -- some@one.org</code>
3488 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="commands"></a>2. Configuration Commands</h2></div></div></div><p>
3489 The following are the commands understood by mutt.
3492 </p><div class="itemizedlist"><ul type="disc"><li><p>
3493 <code class="literal"><a href="#account-hook" title="6. Managing multiple accounts">account-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span>
3495 <code class="literal"><a href="#alias" title="3. Defining/Using aliases">alias</a></code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] <span class="emphasis"><em>key</em></span> <span class="emphasis"><em>address</em></span> [ , <span class="emphasis"><em>address</em></span>, ... ]
3497 <code class="literal"><a href="#alias" title="3. Defining/Using aliases">unalias</a></code> [ * | <span class="emphasis"><em>key</em></span> ... ]
3499 <code class="literal"><a href="#alternates" title="10. Alternative addresses">alternates</a></code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] <span class="emphasis"><em>regexp</em></span> [ <span class="emphasis"><em>regexp</em></span> ... ]
3501 <code class="literal"><a href="#alternates" title="10. Alternative addresses">unalternates</a></code> [ * | <span class="emphasis"><em>regexp</em></span> ... ]
3503 <code class="literal"><a href="#alternative-order" title="5. MIME Multipart/Alternative">alternative-order</a></code> <span class="emphasis"><em>mimetype</em></span> [ <span class="emphasis"><em>mimetype</em></span> ... ]
3505 <code class="literal"><a href="#alternative-order" title="5. MIME Multipart/Alternative">unalternative-order</a></code> <span class="emphasis"><em>mimetype</em></span> [ <span class="emphasis"><em>mimetype</em></span> ... ]
3507 <code class="literal"><a href="#auto-view" title="4. MIME Autoview">auto_view</a></code> <span class="emphasis"><em>mimetype</em></span> [ <span class="emphasis"><em>mimetype</em></span> ... ]
3509 <code class="literal"><a href="#auto-view" title="4. MIME Autoview">unauto_view</a></code> <span class="emphasis"><em>mimetype</em></span> [ <span class="emphasis"><em>mimetype</em></span> ... ]
3511 <code class="literal"><a href="#bind" title="4. Changing the default key bindings">bind</a></code> <span class="emphasis"><em>map</em></span> <span class="emphasis"><em>key</em></span> <span class="emphasis"><em>function</em></span>
3513 <code class="literal"><a href="#charset-hook" title="5. Defining aliases for character sets">charset-hook</a></code> <span class="emphasis"><em>alias</em></span> <span class="emphasis"><em>charset</em></span>
3515 <code class="literal"><a href="#charset-hook" title="5. Defining aliases for character sets">iconv-hook</a></code> <span class="emphasis"><em>charset</em></span> <span class="emphasis"><em>local-charset</em></span>
3517 <code class="literal"><a href="#color" title="8. Using color and mono video attributes">color</a></code> <span class="emphasis"><em>object</em></span> <span class="emphasis"><em>foreground</em></span> <span class="emphasis"><em>background</em></span> [ <span class="emphasis"><em>regexp</em></span> ]
3519 <code class="literal"><a href="#color" title="8. Using color and mono video attributes">uncolor</a></code> <span class="emphasis"><em>index</em></span> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]
3521 <code class="literal"><a href="#exec" title="23. Executing functions">exec</a></code> <span class="emphasis"><em>function</em></span> [ <span class="emphasis"><em>function</em></span> ... ]
3523 <code class="literal"><a href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
3525 <code class="literal"><a href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
3527 <code class="literal"><a href="#folder-hook" title="6. Setting variables based upon mailbox">folder-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span>
3529 <code class="literal"><a href="#hdr-order" title="15. Defining the order of headers when viewing messages">hdr_order</a></code> <span class="emphasis"><em>header</em></span> [ <span class="emphasis"><em>header</em></span> ... ]
3531 <code class="literal"><a href="#hdr-order" title="15. Defining the order of headers when viewing messages">unhdr_order</a></code> <span class="emphasis"><em>header</em></span> [ <span class="emphasis"><em>header</em></span> ... ]
3533 <code class="literal"><a href="#ignore" title="9. Ignoring (weeding) unwanted message headers">ignore</a></code> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]
3535 <code class="literal"><a href="#ignore" title="9. Ignoring (weeding) unwanted message headers">unignore</a></code> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]
3537 <code class="literal"><a href="#lists" title="11. Mailing lists">lists</a></code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] <span class="emphasis"><em>regexp</em></span> [ <span class="emphasis"><em>regexp</em></span> ... ]
3539 <code class="literal"><a href="#lists" title="11. Mailing lists">unlists</a></code> <span class="emphasis"><em>regexp</em></span> [ <span class="emphasis"><em>regexp</em></span> ... ]
3541 <code class="literal"><a href="#macro" title="7. Keyboard macros">macro</a></code> <span class="emphasis"><em>menu</em></span> <span class="emphasis"><em>key</em></span> <span class="emphasis"><em>sequence</em></span> [ <span class="emphasis"><em>description</em></span> ]
3543 <code class="literal"><a href="#mailboxes" title="13. Monitoring incoming mail">mailboxes</a></code> <span class="emphasis"><em>filename</em></span> [ <span class="emphasis"><em>filename</em></span> ... ]
3545 <code class="literal"><a href="#mbox-hook" title="12. Using Multiple spool mailboxes">mbox-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
3547 <code class="literal"><a href="#message-hook" title="20. Change settings before formatting a message">message-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span>
3549 <code class="literal"><a href="#mime-lookup" title="7. MIME Lookup">mime_lookup</a></code> <span class="emphasis"><em>mimetype</em></span> [ <span class="emphasis"><em>mimetype</em></span> ... ]
3551 <code class="literal"><a href="#mime-lookup" title="7. MIME Lookup">unmime_lookup</a></code> <span class="emphasis"><em>mimetype</em></span> [ <span class="emphasis"><em>mimetype</em></span> ... ]
3553 <code class="literal"><a href="#color" title="8. Using color and mono video attributes">mono</a></code> <span class="emphasis"><em>object attribute</em></span> [ <span class="emphasis"><em>regexp</em></span> ]
3555 <code class="literal"><a href="#color" title="8. Using color and mono video attributes">unmono</a></code> <span class="emphasis"><em>index</em></span> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]
3557 <code class="literal"><a href="#my-hdr" title="14. User defined headers">my_hdr</a></code> <span class="emphasis"><em>string</em></span>
3559 <code class="literal"><a href="#my-hdr" title="14. User defined headers">unmy_hdr</a></code> <span class="emphasis"><em>field</em></span> [ <span class="emphasis"><em>field</em></span> ... ]
3561 <code class="literal"><a href="#crypt-hook" title="21. Choosing the cryptographic key of the recipient">crypt-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>key-id</em></span>
3563 <code class="literal"><a href="#push" title="22. Adding key sequences to the keyboard buffer">push</a></code> <span class="emphasis"><em>string</em></span>
3565 <code class="literal"><a href="#set" title="26. Setting and Querying Variables">reset</a></code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]
3567 <code class="literal"><a href="#save-hook" title="16. Specify default save mailbox">save-hook</a></code> <span class="emphasis"><em>regexp</em></span> <span class="emphasis"><em>filename</em></span>
3569 <code class="literal"><a href="#score-command" title="24. Message Scoring">score</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>value</em></span>
3571 <code class="literal"><a href="#score-command" title="24. Message Scoring">unscore</a></code> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]
3573 <code class="literal"><a href="#send-hook" title="19. Change settings based upon message recipients">reply-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span>
3575 <code class="literal"><a href="#send-hook" title="19. Change settings based upon message recipients">send-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span>
3577 <code class="literal"><a href="#send-hook" title="19. Change settings based upon message recipients">send2-hook</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span>
3579 <code class="literal"><a href="#set" title="26. Setting and Querying Variables">set</a></code> [no|inv]<span class="emphasis"><em>variable</em></span>[=<span class="emphasis"><em>value</em></span>] [ <span class="emphasis"><em>variable</em></span> ... ]
3581 <code class="literal"><a href="#set" title="26. Setting and Querying Variables">unset</a></code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]
3583 <code class="literal"><a href="#source" title="27. Reading initialization commands from another file">source</a></code> <span class="emphasis"><em>filename</em></span>
3585 <code class="literal"><a href="#spam" title="25. Spam detection">spam</a></code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>format</em></span>
3587 <code class="literal"><a href="#spam" title="25. Spam detection">nospam</a></code> <span class="emphasis"><em>pattern</em></span>
3589 <code class="literal"><a href="#lists" title="11. Mailing lists">subscribe</a></code> [ <code class="literal">-group</code> <span class="emphasis"><em>name</em></span> [ ... ] ] <span class="emphasis"><em>regexp</em></span> [ <span class="emphasis"><em>regexp</em></span> ... ]
3591 <code class="literal"><a href="#lists" title="11. Mailing lists">unsubscribe</a></code> <span class="emphasis"><em>regexp</em></span> [ <span class="emphasis"><em>regexp</em></span> ... ]
3593 <code class="literal"><a href="#set" title="26. Setting and Querying Variables">toggle</a></code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]
3595 <code class="literal"><a href="#unhook" title="28. Removing hooks">unhook</a></code> <span class="emphasis"><em>hook-type</em></span>
3596 </p></li></ul></div><p>
3598 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="variables"></a>3. Configuration variables</h2></div></div></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="abort-nosubject"></a>3.1. abort_nosubject</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3599 Default: ask-yes</p></div><p>
3600 If set to <span class="emphasis"><em>yes</em></span>, when composing messages and no subject is given
3601 at the subject prompt, composition will be aborted. If set to
3602 <span class="emphasis"><em>no</em></span>, composing messages with no subject given at the subject
3603 prompt will never be aborted.
3604 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="abort-unmodified"></a>3.2. abort_unmodified</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3605 Default: yes</p></div><p>
3606 If set to <span class="emphasis"><em>yes</em></span>, composition will automatically abort after
3607 editing the message body if no changes are made to the file (this
3608 check only happens after the <span class="emphasis"><em>first</em></span> edit of the file). When set
3609 to <span class="emphasis"><em>no</em></span>, composition will never be aborted.
3610 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias-file"></a>3.3. alias_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
3611 Default: "˜/.muttrc"</p></div><p>
3612 The default file in which to save aliases created by the
3613 ``<a href="#create-alias">create-alias</a>'' function.
3615 <span class="bold"><strong>Note:</strong></span> Mutt will not automatically source this file; you must
3616 explicitly use the ``<a href="#source" title="27. Reading initialization commands from another file">source</a>'' command for it to be executed.
3618 The default for this option is the currently used muttrc file, or
3619 ``˜/.muttrc'' if no user muttrc was found.
3620 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias-format"></a>3.4. alias_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3621 Default: "%4n %2f %t %-10a %r"</p></div><p>
3622 Specifies the format of the data displayed for the `alias' menu. The
3623 following printf(3)-style sequences are available:
3626 </p><div class="variablelist"><dl><dt><span class="term">%a </span></dt><dd><p>alias name
3627 </p></dd><dt><span class="term">%f </span></dt><dd><p>flags - currently, a "d" for an alias marked for deletion
3628 </p></dd><dt><span class="term">%n </span></dt><dd><p>index number
3629 </p></dd><dt><span class="term">%r </span></dt><dd><p>address which alias expands to
3630 </p></dd><dt><span class="term">%t </span></dt><dd><p>character which indicates if the alias is tagged for inclusion
3631 </p></dd></dl></div><p>
3632 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="allow-8bit"></a>3.5. allow_8bit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3633 Default: yes</p></div><p>
3634 Controls whether 8-bit data is converted to 7-bit using either Quoted-
3635 Printable or Base64 encoding when sending mail.
3636 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="allow-ansi"></a>3.6. allow_ansi</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3637 Default: no</p></div><p>
3638 Controls whether ANSI color codes in messages (and color tags in
3639 rich text messages) are to be interpreted.
3640 Messages containing these codes are rare, but if this option is set,
3641 their text will be colored accordingly. Note that this may override
3642 your color choices, and even present a security problem, since a
3643 message could include a line like "[-- PGP output follows ..." and
3644 give it the same color as your attachment color.
3645 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="arrow-cursor"></a>3.7. arrow_cursor</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3646 Default: no</p></div><p>
3647 When set, an arrow (``->'') will be used to indicate the current entry
3648 in menus instead of highlighting the whole line. On slow network or modem
3649 links this will make response faster because there is less that has to
3650 be redrawn on the screen when moving to the next or previous entries
3652 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ascii-chars"></a>3.8. ascii_chars</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3653 Default: no</p></div><p>
3654 If set, Mutt will use plain ASCII characters when displaying thread
3655 and attachment trees, instead of the default <span class="emphasis"><em>ACS</em></span> characters.
3656 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="askbcc"></a>3.9. askbcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3657 Default: no</p></div><p>
3658 If set, Mutt will prompt you for blind-carbon-copy (Bcc) recipients
3659 before editing an outgoing message.
3660 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="askcc"></a>3.10. askcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3661 Default: no</p></div><p>
3662 If set, Mutt will prompt you for carbon-copy (Cc) recipients before
3663 editing the body of an outgoing message.
3664 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="assumed-charset"></a>3.11. assumed_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3665 Default: ""</p></div><p>
3666 This variable is a colon-separated list of character encoding
3667 schemes for messages without character encoding indication.
3668 Header field values and message body content without character encoding
3669 indication would be assumed that they are written in one of this list.
3670 By default, all the header fields and message body without any charset
3671 indication are assumed to be in "us-ascii".
3673 For example, Japanese users might prefer this:
3675 set assumed_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
3677 However, only the first content is valid for the message body.
3678 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-charset"></a>3.12. attach_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3679 Default: ""</p></div><p>
3680 This variable is a colon-separated list of character encoding
3681 schemes for text file attachments.
3682 If unset, <a href="#charset" title="3.25. charset">$charset</a> value will be used instead.
3683 For example, the following configuration would work for Japanese
3686 set attach_charset="iso-2022-jp:euc-jp:shift_jis:utf-8"
3688 Note: "iso-2022-*" must be put at the head of the value as shown above
3690 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-format"></a>3.13. attach_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3691 Default: "%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] "</p></div><p>
3692 This variable describes the format of the `attachment' menu. The
3693 following printf-style sequences are understood:
3696 </p><div class="variablelist"><dl><dt><span class="term">%C </span></dt><dd><p>charset
3697 </p></dd><dt><span class="term">%c </span></dt><dd><p>requires charset conversion (n or c)
3698 </p></dd><dt><span class="term">%D </span></dt><dd><p>deleted flag
3699 </p></dd><dt><span class="term">%d </span></dt><dd><p>description
3700 </p></dd><dt><span class="term">%e </span></dt><dd><p>MIME content-transfer-encoding
3701 </p></dd><dt><span class="term">%f </span></dt><dd><p>filename
3702 </p></dd><dt><span class="term">%I </span></dt><dd><p>disposition (I=inline, A=attachment)
3703 </p></dd><dt><span class="term">%m </span></dt><dd><p>major MIME type
3704 </p></dd><dt><span class="term">%M </span></dt><dd><p>MIME subtype
3705 </p></dd><dt><span class="term">%n </span></dt><dd><p>attachment number
3706 </p></dd><dt><span class="term">%Q </span></dt><dd><p>"Q", if MIME part qualifies for attachment counting
3707 </p></dd><dt><span class="term">%s </span></dt><dd><p>size
3708 </p></dd><dt><span class="term">%t </span></dt><dd><p>tagged flag
3709 </p></dd><dt><span class="term">%T </span></dt><dd><p>graphic tree characters
3710 </p></dd><dt><span class="term">%u </span></dt><dd><p>unlink (=to delete) flag
3711 </p></dd><dt><span class="term">%X </span></dt><dd><p>number of qualifying MIME parts in this part and its children
3712 (please see the ``<a href="#attachments" title="6. Attachment Searching and Counting">attachments</a>'' section for possible speed effects)
3713 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with character "X"
3714 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with character "X"
3715 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character "X" as pad
3716 </p></dd></dl></div><p>
3719 For an explanation of `soft-fill', see the ``<a href="#index-format" title="3.100. index_format">$index_format</a>'' documentation.
3720 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-sep"></a>3.14. attach_sep</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3721 Default: "\n"</p></div><p>
3722 The separator to add between attachments when operating (saving,
3723 printing, piping, etc) on a list of tagged attachments.
3724 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach-split"></a>3.15. attach_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3725 Default: yes</p></div><p>
3726 If this variable is unset, when operating (saving, printing, piping,
3727 etc) on a list of tagged attachments, Mutt will concatenate the
3728 attachments and will operate on them as a single attachment. The
3729 ``<a href="#attach-sep" title="3.14. attach_sep">$attach_sep</a>'' separator is added after each attachment. When set,
3730 Mutt will operate on the attachments one by one.
3731 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attribution"></a>3.16. attribution</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3732 Default: "On %d, %n wrote:"</p></div><p>
3733 This is the string that will precede a message which has been included
3734 in a reply. For a full listing of defined printf()-like sequences see
3735 the section on ``<a href="#index-format" title="3.100. index_format">$index_format</a>''.
3736 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="autoedit"></a>3.17. autoedit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3737 Default: no</p></div><p>
3738 When set along with ``<a href="#edit-headers" title="3.50. edit_headers">$edit_headers</a>'', Mutt will skip the initial
3739 send-menu and allow you to immediately begin editing the body of your
3740 message. The send-menu may still be accessed once you have finished
3741 editing the body of your message.
3743 Also see ``<a href="#fast-reply" title="3.55. fast_reply">$fast_reply</a>''.
3744 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="auto-tag"></a>3.18. auto_tag</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3745 Default: no</p></div><p>
3746 When set, functions in the <span class="emphasis"><em>index</em></span> menu which affect a message
3747 will be applied to all tagged messages (if there are any). When
3748 unset, you must first use the tag-prefix function (default: ";") to
3749 make the next function apply to all tagged messages.
3750 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="beep"></a>3.19. beep</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3751 Default: yes</p></div><p>
3752 When this variable is set, mutt will beep when an error occurs.
3753 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="beep-new"></a>3.20. beep_new</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3754 Default: no</p></div><p>
3755 When this variable is set, mutt will beep whenever it prints a message
3756 notifying you of new mail. This is independent of the setting of the
3757 ``<a href="#beep" title="3.19. beep">$beep</a>'' variable.
3758 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="bounce"></a>3.21. bounce</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3759 Default: ask-yes</p></div><p>
3760 Controls whether you will be asked to confirm bouncing messages.
3761 If set to <span class="emphasis"><em>yes</em></span> you don't get asked if you want to bounce a
3762 message. Setting this variable to <span class="emphasis"><em>no</em></span> is not generally useful,
3763 and thus not recommended, because you are unable to bounce messages.
3764 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="bounce-delivered"></a>3.22. bounce_delivered</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3765 Default: yes</p></div><p>
3766 When this variable is set, mutt will include Delivered-To headers when
3767 bouncing messages. Postfix users may wish to unset this variable.
3768 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="braille-friendly"></a>3.23. braille_friendly</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3769 Default: no</p></div><p>
3770 When this variable is set, mutt will place the cursor at the beginning
3771 of the current line in menus, even when the arrow_cursor variable
3772 is unset, making it easier for blind persons using Braille displays to
3773 follow these menus. The option is disabled by default because many
3774 visual terminals don't permit making the cursor invisible.
3775 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="check-mbox-size"></a>3.24. check_mbox_size</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3776 Default: no</p></div><p>
3777 When this variable is set, mutt will use file size attribute instead of
3778 access time when checking for new mail.
3779 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="charset"></a>3.25. charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3780 Default: ""</p></div><p>
3781 Character set your terminal uses to display and enter textual data.
3782 It is also the fallback for <a href="#send-charset" title="3.256. send_charset">$send_charset</a>.
3783 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="check-new"></a>3.26. check_new</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3784 Default: yes</p></div><p>
3785 <span class="bold"><strong>Note:</strong></span> this option only affects <span class="emphasis"><em>maildir</em></span> and <span class="emphasis"><em>MH</em></span> style
3788 When <span class="emphasis"><em>set</em></span>, Mutt will check for new mail delivered while the
3789 mailbox is open. Especially with MH mailboxes, this operation can
3790 take quite some time since it involves scanning the directory and
3791 checking each file to see if it has already been looked at. If
3792 <span class="emphasis"><em>check_new</em></span> is <span class="emphasis"><em>unset</em></span>, no check for new mail is performed
3793 while the mailbox is open.
3794 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="collapse-unread"></a>3.27. collapse_unread</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3795 Default: yes</p></div><p>
3796 When <span class="emphasis"><em>unset</em></span>, Mutt will not collapse a thread if it contains any
3798 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="uncollapse-jump"></a>3.28. uncollapse_jump</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3799 Default: no</p></div><p>
3800 When <span class="emphasis"><em>set</em></span>, Mutt will jump to the next unread message, if any,
3801 when the current thread is <span class="emphasis"><em>un</em></span>collapsed.
3802 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose-format"></a>3.29. compose_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3803 Default: "-- Mutt: Compose [Approx. msg size: %l Atts: %a]%>-"</p></div><p>
3804 Controls the format of the status line displayed in the <span class="emphasis"><em>Compose</em></span>
3805 menu. This string is similar to ``<a href="#status-format" title="3.278. status_format">$status_format</a>'', but has its own
3806 set of printf()-like sequences:
3809 </p><div class="variablelist"><dl><dt><span class="term">%a </span></dt><dd><p>total number of attachments
3810 </p></dd><dt><span class="term">%h </span></dt><dd><p>local hostname
3811 </p></dd><dt><span class="term">%l </span></dt><dd><p>approximate size (in bytes) of the current message
3812 </p></dd><dt><span class="term">%v </span></dt><dd><p>Mutt version string
3813 </p></dd></dl></div><p>
3816 See the text describing the ``<a href="#status-format" title="3.278. status_format">$status_format</a>'' option for more
3817 information on how to set ``<a href="#compose-format" title="3.29. compose_format">$compose_format</a>''.
3818 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="config-charset"></a>3.30. config_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3819 Default: ""</p></div><p>
3820 When defined, Mutt will recode commands in rc files from this
3822 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="confirmappend"></a>3.31. confirmappend</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3823 Default: yes</p></div><p>
3824 When set, Mutt will prompt for confirmation when appending messages to
3825 an existing mailbox.
3826 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="confirmcreate"></a>3.32. confirmcreate</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3827 Default: yes</p></div><p>
3828 When set, Mutt will prompt for confirmation when saving messages to a
3829 mailbox which does not yet exist before creating it.
3830 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="connect-timeout"></a>3.33. connect_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
3831 Default: 30</p></div><p>
3832 Causes Mutt to timeout a network connection (for IMAP or POP) after this
3833 many seconds if the connection is not able to be established. A negative
3834 value causes Mutt to wait indefinitely for the connection to succeed.
3835 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="content-type"></a>3.34. content_type</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3836 Default: "text/plain"</p></div><p>
3837 Sets the default Content-Type for the body of newly composed messages.
3838 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="copy"></a>3.35. copy</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3839 Default: yes</p></div><p>
3840 This variable controls whether or not copies of your outgoing messages
3841 will be saved for later references. Also see ``<a href="#record" title="3.239. record">$record</a>'',
3842 ``<a href="#save-name" title="3.251. save_name">$save_name</a>'', ``<a href="#force-name" title="3.61. force_name">$force_name</a>'' and ``<a href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a>''.
3843 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-use-gpgme"></a>3.36. crypt_use_gpgme</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3844 Default: no</p></div><p>
3845 This variable controls the use of the GPGME-enabled crypto backends.
3846 If it is set and Mutt was built with gpgme support, the gpgme code for
3847 S/MIME and PGP will be used instead of the classic code. Note that
3848 you need to set this option in .muttrc; it won't have any effect when
3850 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-use-pka"></a>3.37. crypt_use_pka</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3851 Default: no</p></div><p>
3852 (http://www.g10code.de/docs/pka-intro.de.pdf) during signature
3853 verification (only supported by the GPGME backend).
3854 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autopgp"></a>3.38. crypt_autopgp</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3855 Default: yes</p></div><p>
3856 This variable controls whether or not mutt may automatically enable
3857 PGP encryption/signing for messages. See also ``<a href="#crypt-autoencrypt" title="3.143. crypt_autoencrypt">$crypt_autoencrypt</a>'',
3858 ``<a href="#crypt-replyencrypt" title="3.145. crypt_replyencrypt">$crypt_replyencrypt</a>'',
3859 ``<a href="#crypt-autosign" title="3.142. crypt_autosign">$crypt_autosign</a>'', ``<a href="#crypt-replysign" title="3.146. crypt_replysign">$crypt_replysign</a>'' and ``<a href="#smime-is-default" title="3.151. smime_is_default">$smime_is_default</a>''.
3860 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autosmime"></a>3.39. crypt_autosmime</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3861 Default: yes</p></div><p>
3862 This variable controls whether or not mutt may automatically enable
3863 S/MIME encryption/signing for messages. See also ``<a href="#crypt-autoencrypt" title="3.143. crypt_autoencrypt">$crypt_autoencrypt</a>'',
3864 ``<a href="#crypt-replyencrypt" title="3.145. crypt_replyencrypt">$crypt_replyencrypt</a>'',
3865 ``<a href="#crypt-autosign" title="3.142. crypt_autosign">$crypt_autosign</a>'', ``<a href="#crypt-replysign" title="3.146. crypt_replysign">$crypt_replysign</a>'' and ``<a href="#smime-is-default" title="3.151. smime_is_default">$smime_is_default</a>''.
3866 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="date-format"></a>3.40. date_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3867 Default: "!%a, %b %d, %Y at %I:%M:%S%p %Z"</p></div><p>
3868 This variable controls the format of the date printed by the ``%d''
3869 sequence in ``<a href="#index-format" title="3.100. index_format">$index_format</a>''. This is passed to the <span class="emphasis"><em>strftime</em></span>
3870 call to process the date. See the man page for <span class="emphasis"><em>strftime(3)</em></span> for
3873 Unless the first character in the string is a bang (``!''), the month
3874 and week day names are expanded according to the locale specified in
3875 the variable ``<a href="#locale" title="3.103. locale">$locale</a>''. If the first character in the string is a
3876 bang, the bang is discarded, and the month and week day names in the
3877 rest of the string are expanded in the <span class="emphasis"><em>C</em></span> locale (that is in US
3879 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="default-hook"></a>3.41. default_hook</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3880 Default: "˜f %s !˜P | (˜P ˜C %s)"</p></div><p>
3881 This variable controls how message-hooks, reply-hooks, send-hooks,
3882 send2-hooks, save-hooks, and fcc-hooks will
3883 be interpreted if they are specified with only a simple regexp,
3884 instead of a matching pattern. The hooks are expanded when they are
3885 declared, so a hook will be interpreted according to the value of this
3886 variable at the time the hook is declared. The default value matches
3887 if the message is either from a user matching the regular expression
3888 given, or if it is from you (if the from address matches
3889 ``alternates'') and is to or cc'ed to a user matching the given
3891 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="delete"></a>3.42. delete</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
3892 Default: ask-yes</p></div><p>
3893 Controls whether or not messages are really deleted when closing or
3894 synchronizing a mailbox. If set to <span class="emphasis"><em>yes</em></span>, messages marked for
3895 deleting will automatically be purged without prompting. If set to
3896 <span class="emphasis"><em>no</em></span>, messages marked for deletion will be kept in the mailbox.
3897 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="delete-untag"></a>3.43. delete_untag</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3898 Default: yes</p></div><p>
3899 If this option is <span class="emphasis"><em>set</em></span>, mutt will untag messages when marking them
3900 for deletion. This applies when you either explicitly delete a message,
3901 or when you save it to another folder.
3902 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="digest-collapse"></a>3.44. digest_collapse</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3903 Default: yes</p></div><p>
3904 If this option is <span class="emphasis"><em>set</em></span>, mutt's received-attachments menu will not show the subparts of
3905 individual messages in a multipart/digest. To see these subparts, press 'v' on that menu.
3906 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="display-filter"></a>3.45. display_filter</h3></div></div></div><div class="literallayout"><p>Type: path<br />
3907 Default: ""</p></div><p>
3908 When set, specifies a command used to filter messages. When a message
3909 is viewed it is passed as standard input to <a href="#display-filter" title="3.45. display_filter">$display_filter</a>, and the
3910 filtered message is read from the standard output.
3911 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="dotlock-program"></a>3.46. dotlock_program</h3></div></div></div><div class="literallayout"><p>Type: path<br />
3912 Default: "/usr/local/bin/mutt_dotlock"</p></div><p>
3913 Contains the path of the mutt_dotlock (8) binary to be used by
3915 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="dsn-notify"></a>3.47. dsn_notify</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3916 Default: ""</p></div><p>
3917 This variable sets the request for when notification is returned. The
3918 string consists of a comma separated list (no spaces!) of one or more
3919 of the following: <span class="emphasis"><em>never</em></span>, to never request notification,
3920 <span class="emphasis"><em>failure</em></span>, to request notification on transmission failure,
3921 <span class="emphasis"><em>delay</em></span>, to be notified of message delays, <span class="emphasis"><em>success</em></span>, to be
3922 notified of successful transmission.
3924 Example: set dsn_notify="failure,delay"
3926 <span class="bold"><strong>Note:</strong></span> when using <a href="#sendmail" title="3.257. sendmail">$sendmail</a> for delivery, you should not enable
3927 this unless you are either using Sendmail 8.8.x or greater or a MTA
3928 providing a sendmail(1)-compatible interface supporting the -N option
3929 for DSN. For SMTP delivery, it depends on the server whether DSN is
3931 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="dsn-return"></a>3.48. dsn_return</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3932 Default: ""</p></div><p>
3933 This variable controls how much of your message is returned in DSN
3934 messages. It may be set to either <span class="emphasis"><em>hdrs</em></span> to return just the
3935 message header, or <span class="emphasis"><em>full</em></span> to return the full message.
3937 Example: set dsn_return=hdrs
3939 <span class="bold"><strong>Note:</strong></span> when using <a href="#sendmail" title="3.257. sendmail">$sendmail</a> for delivery, you should not enable
3940 this unless you are either using Sendmail 8.8.x or greater or a MTA
3941 providing a sendmail(1)-compatible interface supporting the -R option
3942 for DSN. For SMTP delivery, it depends on the server whether DSN is
3944 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="duplicate-threads"></a>3.49. duplicate_threads</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3945 Default: yes</p></div><p>
3946 This variable controls whether mutt, when sorting by threads, threads
3947 messages with the same message-id together. If it is set, it will indicate
3948 that it thinks they are duplicates of each other with an equals sign
3949 in the thread diagram.
3950 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="edit-headers"></a>3.50. edit_headers</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3951 Default: no</p></div><p>
3952 This option allows you to edit the header of your outgoing messages
3953 along with the body of your message.
3955 <span class="bold"><strong>Note</strong></span> that changes made to the References: and Date: headers are
3956 ignored for interoperability reasons.
3957 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editor"></a>3.51. editor</h3></div></div></div><div class="literallayout"><p>Type: path<br />
3958 Default: ""</p></div><p>
3959 This variable specifies which editor is used by mutt.
3960 It defaults to the value of the VISUAL, or EDITOR, environment
3961 variable, or to the string "vi" if neither of those are set.
3962 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="encode-from"></a>3.52. encode_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3963 Default: no</p></div><p>
3964 When <span class="emphasis"><em>set</em></span>, mutt will quoted-printable encode messages when
3965 they contain the string "From " in the beginning of a line.
3966 Useful to avoid the tampering certain mail delivery and transport
3967 agents tend to do with messages.
3968 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="envelope-from-address"></a>3.53. envelope_from_address</h3></div></div></div><div class="literallayout"><p>Type: e-mail address<br />
3969 Default: ""</p></div><p>
3970 Manually sets the <span class="emphasis"><em>envelope</em></span> sender for outgoing messages.
3971 This value is ignored if ``<a href="#use-envelope-from" title="3.293. use_envelope_from">$use_envelope_from</a>'' is unset.
3972 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="escape"></a>3.54. escape</h3></div></div></div><div class="literallayout"><p>Type: string<br />
3973 Default: "˜"</p></div><p>
3974 Escape character to use for functions in the builtin editor.
3975 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="fast-reply"></a>3.55. fast_reply</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3976 Default: no</p></div><p>
3977 When set, the initial prompt for recipients and subject are skipped
3978 when replying to messages, and the initial prompt for subject is
3979 skipped when forwarding messages.
3981 <span class="bold"><strong>Note:</strong></span> this variable has no effect when the ``<a href="#autoedit" title="3.17. autoedit">$autoedit</a>''
3983 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="fcc-attach"></a>3.56. fcc_attach</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3984 Default: yes</p></div><p>
3985 This variable controls whether or not attachments on outgoing messages
3986 are saved along with the main body of your message.
3987 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="fcc-clear"></a>3.57. fcc_clear</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
3988 Default: no</p></div><p>
3989 When this variable is set, FCCs will be stored unencrypted and
3990 unsigned, even when the actual message is encrypted and/or
3993 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="folder"></a>3.58. folder</h3></div></div></div><div class="literallayout"><p>Type: path<br />
3994 Default: "˜/Mail"</p></div><p>
3995 Specifies the default location of your mailboxes. A `+' or `=' at the
3996 beginning of a pathname will be expanded to the value of this
3997 variable. Note that if you change this variable from the default
3998 value you need to make sure that the assignment occurs <span class="emphasis"><em>before</em></span>
3999 you use `+' or `=' for any other variables since expansion takes place
4000 during the `set' command.
4001 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="folder-format"></a>3.59. folder_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4002 Default: "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %f"</p></div><p>
4003 This variable allows you to customize the file browser display to your
4004 personal taste. This string is similar to ``<a href="#index-format" title="3.100. index_format">$index_format</a>'', but has
4005 its own set of printf()-like sequences:
4008 </p><div class="variablelist"><dl><dt><span class="term">%C </span></dt><dd><p>current file number
4009 </p></dd><dt><span class="term">%d </span></dt><dd><p>date/time folder was last modified
4010 </p></dd><dt><span class="term">%f </span></dt><dd><p>filename
4011 </p></dd><dt><span class="term">%F </span></dt><dd><p>file permissions
4012 </p></dd><dt><span class="term">%g </span></dt><dd><p>group name (or numeric gid, if missing)
4013 </p></dd><dt><span class="term">%l </span></dt><dd><p>number of hard links
4014 </p></dd><dt><span class="term">%N </span></dt><dd><p>N if folder has new mail, blank otherwise
4015 </p></dd><dt><span class="term">%s </span></dt><dd><p>size in bytes
4016 </p></dd><dt><span class="term">%t </span></dt><dd><p>* if the file is tagged, blank otherwise
4017 </p></dd><dt><span class="term">%u </span></dt><dd><p>owner name (or numeric uid, if missing)
4018 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with character "X"
4019 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with character "X"
4020 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character "X" as pad
4021 </p></dd></dl></div><p>
4024 For an explanation of `soft-fill', see the ``<a href="#index-format" title="3.100. index_format">$index_format</a>'' documentation.
4025 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="followup-to"></a>3.60. followup_to</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4026 Default: yes</p></div><p>
4027 Controls whether or not the <span class="emphasis"><em>Mail-Followup-To</em></span> header field is
4028 generated when sending mail. When <span class="emphasis"><em>set</em></span>, Mutt will generate this
4029 field when you are replying to a known mailing list, specified with
4030 the ``subscribe'' or ``<a href="#lists" title="11. Mailing lists">lists</a>'' commands.
4032 This field has two purposes. First, preventing you from
4033 receiving duplicate copies of replies to messages which you send
4034 to mailing lists, and second, ensuring that you do get a reply
4035 separately for any messages sent to known lists to which you are
4036 not subscribed. The header will contain only the list's address
4037 for subscribed lists, and both the list address and your own
4038 email address for unsubscribed lists. Without this header, a
4039 group reply to your message sent to a subscribed list will be
4040 sent to both the list and your address, resulting in two copies
4041 of the same email for you.
4042 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="force-name"></a>3.61. force_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4043 Default: no</p></div><p>
4044 This variable is similar to ``<a href="#save-name" title="3.251. save_name">$save_name</a>'', except that Mutt will
4045 store a copy of your outgoing message by the username of the address
4046 you are sending to even if that mailbox does not exist.
4048 Also see the ``<a href="#record" title="3.239. record">$record</a>'' variable.
4049 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-decode"></a>3.62. forward_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4050 Default: yes</p></div><p>
4051 Controls the decoding of complex MIME messages into text/plain when
4052 forwarding a message. The message header is also RFC2047 decoded.
4053 This variable is only used, if ``<a href="#mime-forward" title="3.126. mime_forward">$mime_forward</a>'' is <span class="emphasis"><em>unset</em></span>,
4054 otherwise ``<a href="#mime-forward-decode" title="3.127. mime_forward_decode">$mime_forward_decode</a>'' is used instead.
4055 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-edit"></a>3.63. forward_edit</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4056 Default: yes</p></div><p>
4057 This quadoption controls whether or not the user is automatically
4058 placed in the editor when forwarding messages. For those who always want
4059 to forward with no modification, use a setting of ``no''.
4060 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-format"></a>3.64. forward_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4061 Default: "[%a: %s]"</p></div><p>
4062 This variable controls the default subject when forwarding a message.
4063 It uses the same format sequences as the ``<a href="#index-format" title="3.100. index_format">$index_format</a>'' variable.
4064 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-quote"></a>3.65. forward_quote</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4065 Default: no</p></div><p>
4066 When <span class="emphasis"><em>set</em></span> forwarded messages included in the main body of the
4067 message (when ``<a href="#mime-forward" title="3.126. mime_forward">$mime_forward</a>'' is <span class="emphasis"><em>unset</em></span>) will be quoted using
4068 ``<a href="#indent-string" title="3.99. indent_string">$indent_string</a>''.
4069 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="from"></a>3.66. from</h3></div></div></div><div class="literallayout"><p>Type: e-mail address<br />
4070 Default: ""</p></div><p>
4071 When set, this variable contains a default from address. It
4072 can be overridden using my_hdr (including from send-hooks) and
4073 ``<a href="#reverse-name" title="3.245. reverse_name">$reverse_name</a>''. This variable is ignored if ``<a href="#use-from" title="3.294. use_from">$use_from</a>''
4076 Defaults to the contents of the environment variable EMAIL.
4077 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="gecos-mask"></a>3.67. gecos_mask</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
4078 Default: "^[^,]*"</p></div><p>
4079 A regular expression used by mutt to parse the GECOS field of a password
4080 entry when expanding the alias. By default the regular expression is set
4081 to "^[^,]*" which will return the string up to the first "," encountered.
4082 If the GECOS field contains a string like "lastname, firstname" then you
4083 should set the gecos_mask=".*".
4085 This can be useful if you see the following behavior: you address a e-mail
4086 to user ID stevef whose full name is Steve Franklin. If mutt expands
4087 stevef to "Franklin" stevef@foo.bar then you should set the gecos_mask to
4088 a regular expression that will match the whole name so mutt will expand
4089 "Franklin" to "Franklin, Steve".
4090 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hdrs"></a>3.68. hdrs</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4091 Default: yes</p></div><p>
4092 When unset, the header fields normally added by the ``<a href="#my-hdr" title="14. User defined headers">my_hdr</a>''
4093 command are not created. This variable <span class="emphasis"><em>must</em></span> be unset before
4094 composing a new message or replying in order to take effect. If set,
4095 the user defined header fields are added to every new message.
4096 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header"></a>3.69. header</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4097 Default: no</p></div><p>
4098 When set, this variable causes Mutt to include the header
4099 of the message you are replying to into the edit buffer.
4100 The ``<a href="#weed" title="3.300. weed">$weed</a>'' setting applies.
4101 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="help"></a>3.70. help</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4102 Default: yes</p></div><p>
4103 When set, help lines describing the bindings for the major functions
4104 provided by each menu are displayed on the first line of the screen.
4106 <span class="bold"><strong>Note:</strong></span> The binding will not be displayed correctly if the
4107 function is bound to a sequence rather than a single keystroke. Also,
4108 the help line may not be updated if a binding is changed while Mutt is
4109 running. Since this variable is primarily aimed at new users, neither
4110 of these should present a major problem.
4111 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hidden-host"></a>3.71. hidden_host</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4112 Default: no</p></div><p>
4113 When set, mutt will skip the host name part of ``<a href="#hostname" title="3.80. hostname">$hostname</a>'' variable
4114 when adding the domain part to addresses. This variable does not
4115 affect the generation of Message-IDs, and it will not lead to the
4116 cut-off of first-level domains.
4117 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-limited"></a>3.72. hide_limited</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4118 Default: no</p></div><p>
4119 When set, mutt will not show the presence of messages that are hidden
4120 by limiting, in the thread tree.
4121 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-missing"></a>3.73. hide_missing</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4122 Default: yes</p></div><p>
4123 When set, mutt will not show the presence of missing messages in the
4125 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-thread-subject"></a>3.74. hide_thread_subject</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4126 Default: yes</p></div><p>
4127 When set, mutt will not show the subject of messages in the thread
4128 tree that have the same subject as their parent or closest previously
4130 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-top-limited"></a>3.75. hide_top_limited</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4131 Default: no</p></div><p>
4132 When set, mutt will not show the presence of messages that are hidden
4133 by limiting, at the top of threads in the thread tree. Note that when
4134 <a href="#hide-limited" title="3.72. hide_limited">$hide_limited</a> is set, this option will have no effect.
4135 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hide-top-missing"></a>3.76. hide_top_missing</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4136 Default: yes</p></div><p>
4137 When set, mutt will not show the presence of missing messages at the
4138 top of threads in the thread tree. Note that when <a href="#hide-missing" title="3.73. hide_missing">$hide_missing</a> is
4139 set, this option will have no effect.
4140 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="history"></a>3.77. history</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4141 Default: 10</p></div><p>
4142 This variable controls the size (in number of strings remembered) of
4143 the string history buffer. The buffer is cleared each time the
4145 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="history-file"></a>3.78. history_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4146 Default: "˜/.mutthistory"</p></div><p>
4147 The file in which Mutt will save its history.
4148 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="honor-followup-to"></a>3.79. honor_followup_to</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4149 Default: yes</p></div><p>
4150 This variable controls whether or not a Mail-Followup-To header is
4151 honored when group-replying to a message.
4152 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="hostname"></a>3.80. hostname</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4153 Default: ""</p></div><p>
4154 Specifies the fully-qualified hostname of the system mutt is running on
4155 containing the host's name and the DNS domain it belongs to. It is used
4156 as the domain part (after ``@'') for local email addresses as well as
4159 Its value is determined at startup as follows: If the node's name
4160 as returned by the uname(3) function contains the hostname and the
4161 domain, these are used to construct <a href="#hostname" title="3.80. hostname">$hostname</a>. If there is no
4162 domain part returned, Mutt will look for a ``domain'' or ``search''
4163 line in /etc/resolv.conf to determine the domain. Optionally, Mutt
4164 can be compiled with a fixed domain name in which case a detected
4167 Also see ``<a href="#use-domain" title="3.292. use_domain">$use_domain</a>'' and ``<a href="#hidden-host" title="3.71. hidden_host">$hidden_host</a>''.
4168 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ignore-linear-white-space"></a>3.81. ignore_linear_white_space</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4169 Default: no</p></div><p>
4170 This option replaces linear-white-space between encoded-word
4171 and *text to a single space to prevent the display of MIME-encoded
4172 ``Subject'' field from being divided into multiple lines.
4173 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ignore-list-reply-to"></a>3.82. ignore_list_reply_to</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4174 Default: no</p></div><p>
4175 Affects the behaviour of the <span class="emphasis"><em>reply</em></span> function when replying to
4176 messages from mailing lists (as defined by the ``subscribe'' or
4177 ``<a href="#lists" title="11. Mailing lists">lists</a>'' commands). When set, if the ``Reply-To:'' field is
4178 set to the same value as the ``To:'' field, Mutt assumes that the
4179 ``Reply-To:'' field was set by the mailing list to automate responses
4180 to the list, and will ignore this field. To direct a response to the
4181 mailing list when this option is set, use the <span class="emphasis"><em>list-reply</em></span>
4182 function; <span class="emphasis"><em>group-reply</em></span> will reply to both the sender and the
4184 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-authenticators"></a>3.83. imap_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4185 Default: ""</p></div><p>
4186 This is a colon-delimited list of authentication methods mutt may
4187 attempt to use to log in to an IMAP server, in the order mutt should
4188 try them. Authentication methods are either 'login' or the right
4189 side of an IMAP 'AUTH=xxx' capability string, eg 'digest-md5', 'gssapi'
4190 or 'cram-md5'. This parameter is case-insensitive. If this
4191 parameter is <span class="emphasis"><em>unset</em></span> (the default) mutt will try all available methods,
4192 in order from most-secure to least-secure.
4194 Example: set imap_authenticators="gssapi:cram-md5:login"
4196 <span class="bold"><strong>Note:</strong></span> Mutt will only fall back to other authentication methods if
4197 the previous methods are unavailable. If a method is available but
4198 authentication fails, mutt will not connect to the IMAP server.
4199 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-check-subscribed"></a>3.84. imap_check_subscribed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4200 Default: no</p></div><p>
4201 When <span class="emphasis"><em>set</em></span>, mutt will fetch the set of subscribed folders from
4202 your server on connection, and add them to the set of mailboxes
4203 it polls for new mail. See also the ``<a href="#mailboxes" title="13. Monitoring incoming mail">mailboxes</a>'' command.
4204 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-delim-chars"></a>3.85. imap_delim_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4205 Default: "/."</p></div><p>
4206 This contains the list of characters which you would like to treat
4207 as folder separators for displaying IMAP paths. In particular it
4208 helps in using the '=' shortcut for your <span class="emphasis"><em>folder</em></span> variable.
4209 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-headers"></a>3.86. imap_headers</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4210 Default: ""</p></div><p>
4211 Mutt requests these header fields in addition to the default headers
4212 ("DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE
4213 CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL") from IMAP
4214 servers before displaying the index menu. You may want to add more
4215 headers for spam detection. <span class="bold"><strong>Note:</strong></span> This is a space separated list.
4216 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-idle"></a>3.87. imap_idle</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4217 Default: no</p></div><p>
4218 When <span class="emphasis"><em>set</em></span>, mutt will attempt to use the IMAP IDLE extension
4219 to check for new mail in the current mailbox. Some servers
4220 (dovecot was the inspiration for this option) react badly
4221 to mutt's implementation. If your connection seems to freeze
4222 up periodically, try unsetting this.
4223 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-keepalive"></a>3.88. imap_keepalive</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4224 Default: 900</p></div><p>
4225 This variable specifies the maximum amount of time in seconds that mutt
4226 will wait before polling open IMAP connections, to prevent the server
4227 from closing them before mutt has finished with them. The default is
4228 well within the RFC-specified minimum amount of time (30 minutes) before
4229 a server is allowed to do this, but in practice the RFC does get
4230 violated every now and then. Reduce this number if you find yourself
4231 getting disconnected from your IMAP server due to inactivity.
4232 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-list-subscribed"></a>3.89. imap_list_subscribed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4233 Default: no</p></div><p>
4234 This variable configures whether IMAP folder browsing will look for
4235 only subscribed folders or all folders. This can be toggled in the
4236 IMAP browser with the <span class="emphasis"><em>toggle-subscribed</em></span> function.
4237 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-login"></a>3.90. imap_login</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4238 Default: ""</p></div><p>
4239 Your login name on the IMAP server.
4241 This variable defaults to the value of <span class="emphasis"><em>imap_user</em></span>.
4242 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-pass"></a>3.91. imap_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4243 Default: ""</p></div><p>
4244 Specifies the password for your IMAP account. If <span class="emphasis"><em>unset</em></span>, Mutt will
4245 prompt you for your password when you invoke the fetch-mail function.
4246 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
4247 fairly secure machine, because the superuser can read your muttrc even
4248 if you are the only one who can read the file.
4249 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-passive"></a>3.92. imap_passive</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4250 Default: yes</p></div><p>
4251 When <span class="emphasis"><em>set</em></span>, mutt will not open new IMAP connections to check for new
4252 mail. Mutt will only check for new mail over existing IMAP
4253 connections. This is useful if you don't want to be prompted to
4254 user/password pairs on mutt invocation, or if opening the connection
4256 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-peek"></a>3.93. imap_peek</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4257 Default: yes</p></div><p>
4258 When <span class="emphasis"><em>set</em></span>, mutt will avoid implicitly marking your mail as read whenever
4259 you fetch a message from the server. This is generally a good thing,
4260 but can make closing an IMAP folder somewhat slower. This option
4261 exists to appease speed freaks.
4262 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-servernoise"></a>3.94. imap_servernoise</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4263 Default: yes</p></div><p>
4264 When <span class="emphasis"><em>set</em></span>, mutt will display warning messages from the IMAP
4265 server as error messages. Since these messages are often
4266 harmless, or generated due to configuration problems on the
4267 server which are out of the users' hands, you may wish to suppress
4269 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="imap-user"></a>3.95. imap_user</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4270 Default: ""</p></div><p>
4271 The name of the user whose mail you intend to access on the IMAP
4274 This variable defaults to your user name on the local machine.
4275 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="implicit-autoview"></a>3.96. implicit_autoview</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4276 Default: no</p></div><p>
4277 If set to ``yes'', mutt will look for a mailcap entry with the
4278 copiousoutput flag set for <span class="emphasis"><em>every</em></span> MIME attachment it doesn't have
4279 an internal viewer defined for. If such an entry is found, mutt will
4280 use the viewer defined in that entry to convert the body part to text
4282 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="include"></a>3.97. include</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4283 Default: ask-yes</p></div><p>
4284 Controls whether or not a copy of the message(s) you are replying to
4285 is included in your reply.
4286 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="include-onlyfirst"></a>3.98. include_onlyfirst</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4287 Default: no</p></div><p>
4288 Controls whether or not Mutt includes only the first attachment
4289 of the message you are replying.
4290 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="indent-string"></a>3.99. indent_string</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4291 Default: "> "</p></div><p>
4292 Specifies the string to prepend to each line of text quoted in a
4293 message to which you are replying. You are strongly encouraged not to
4294 change this value, as it tends to agitate the more fanatical netizens.
4296 This option is a format string, please see the description of
4297 ``<a href="#index-format" title="3.100. index_format">$index_format</a>'' for supported printf()-style sequences.
4298 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="index-format"></a>3.100. index_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4299 Default: "%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?) %s"</p></div><p>
4300 This variable allows you to customize the message index display to
4301 your personal taste.
4303 ``Format strings'' are similar to the strings used in the ``C''
4304 function printf to format output (see the man page for more detail).
4305 The following sequences are defined in Mutt:
4308 </p><div class="variablelist"><dl><dt><span class="term">%a </span></dt><dd><p>address of the author
4309 </p></dd><dt><span class="term">%A </span></dt><dd><p>reply-to address (if present; otherwise: address of author)
4310 </p></dd><dt><span class="term">%b </span></dt><dd><p>filename of the original message folder (think mailBox)
4311 </p></dd><dt><span class="term">%B </span></dt><dd><p>the list to which the letter was sent, or else the folder name (%b).
4312 </p></dd><dt><span class="term">%c </span></dt><dd><p>number of characters (bytes) in the message
4313 </p></dd><dt><span class="term">%C </span></dt><dd><p>current message number
4314 </p></dd><dt><span class="term">%d </span></dt><dd><p>date and time of the message in the format specified by
4315 ``date_format'' converted to sender's time zone
4316 </p></dd><dt><span class="term">%D </span></dt><dd><p>date and time of the message in the format specified by
4317 ``date_format'' converted to the local time zone
4318 </p></dd><dt><span class="term">%e </span></dt><dd><p>current message number in thread
4319 </p></dd><dt><span class="term">%E </span></dt><dd><p>number of messages in current thread
4320 </p></dd><dt><span class="term">%f </span></dt><dd><p>sender (address + real name), either From: or Return-Path:
4321 </p></dd><dt><span class="term">%F </span></dt><dd><p>author name, or recipient name if the message is from you
4322 </p></dd><dt><span class="term">%H </span></dt><dd><p>spam attribute(s) of this message
4323 </p></dd><dt><span class="term">%i </span></dt><dd><p>message-id of the current message
4324 </p></dd><dt><span class="term">%l </span></dt><dd><p>number of lines in the message (does not work with maildir,
4325 mh, and possibly IMAP folders)
4326 </p></dd><dt><span class="term">%L </span></dt><dd><p>If an address in the To or CC header field matches an address
4327 defined by the users ``subscribe'' command, this displays
4328 "To <list-name>", otherwise the same as %F.
4329 </p></dd><dt><span class="term">%m </span></dt><dd><p>total number of message in the mailbox
4330 </p></dd><dt><span class="term">%M </span></dt><dd><p>number of hidden messages if the thread is collapsed.
4331 </p></dd><dt><span class="term">%N </span></dt><dd><p>message score
4332 </p></dd><dt><span class="term">%n </span></dt><dd><p>author's real name (or address if missing)
4333 </p></dd><dt><span class="term">%O </span></dt><dd><p>(_O_riginal save folder) Where mutt would formerly have
4334 stashed the message: list name or recipient name if no list
4335 </p></dd><dt><span class="term">%P </span></dt><dd><p>progress indicator for the builtin pager (how much of the file has been displayed)
4336 </p></dd><dt><span class="term">%s </span></dt><dd><p>subject of the message
4337 </p></dd><dt><span class="term">%S </span></dt><dd><p>status of the message (N/D/d/!/r/*)
4338 </p></dd><dt><span class="term">%t </span></dt><dd><p>`to:' field (recipients)
4339 </p></dd><dt><span class="term">%T </span></dt><dd><p>the appropriate character from the <a href="#to-chars" title="3.289. to_chars">$to_chars</a> string
4340 </p></dd><dt><span class="term">%u </span></dt><dd><p>user (login) name of the author
4341 </p></dd><dt><span class="term">%v </span></dt><dd><p>first name of the author, or the recipient if the message is from you
4342 </p></dd><dt><span class="term">%X </span></dt><dd><p>number of attachments
4343 (please see the ``<a href="#attachments" title="6. Attachment Searching and Counting">attachments</a>'' section for possible speed effects)
4344 </p></dd><dt><span class="term">%y </span></dt><dd><p>`x-label:' field, if present
4345 </p></dd><dt><span class="term">%Y </span></dt><dd><p>`x-label' field, if present, and (1) not at part of a thread tree,
4346 (2) at the top of a thread, or (3) `x-label' is different from
4347 preceding message's `x-label'.
4348 </p></dd><dt><span class="term">%Z </span></dt><dd><p>message status flags
4349 </p></dd><dt><span class="term">%{fmt} </span></dt><dd><p>the date and time of the message is converted to sender's
4350 time zone, and ``fmt'' is expanded by the library function
4351 ``strftime''; a leading bang disables locales
4352 </p></dd><dt><span class="term">%[fmt] </span></dt><dd><p>the date and time of the message is converted to the local
4353 time zone, and ``fmt'' is expanded by the library function
4354 ``strftime''; a leading bang disables locales
4355 </p></dd><dt><span class="term">%(fmt) </span></dt><dd><p>the local date and time when the message was received.
4356 ``fmt'' is expanded by the library function ``strftime'';
4357 a leading bang disables locales
4358 </p></dd><dt><span class="term">%<fmt> </span></dt><dd><p>the current local time. ``fmt'' is expanded by the library
4359 function ``strftime''; a leading bang disables locales.
4360 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with character "X"
4361 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with character "X"
4362 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character "X" as pad
4363 </p></dd></dl></div><p>
4366 `Soft-fill' deserves some explanation. Normal right-justification
4367 will print everything to the left of the %>, displaying padding and
4368 the whatever lies to the right only if there's room. By contrast,
4369 soft-fill gives priority to the right-hand side, guaranteeing space
4370 to display it and showing padding only if there's still room. If
4371 necessary, soft-fill will eat text leftwards to make room for
4374 Note that these expandos are supported in
4375 ``<a href="#save-hook" title="16. Specify default save mailbox">save-hook</a>'', ``<a href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a>'' and ``<a href="#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a>'', too.
4377 See also: ``<a href="#to-chars" title="3.289. to_chars">$to_chars</a>''.
4378 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ispell"></a>3.101. ispell</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4379 Default: "ispell"</p></div><p>
4380 How to invoke ispell (GNU's spell-checking software).
4381 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="keep-flagged"></a>3.102. keep_flagged</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4382 Default: no</p></div><p>
4383 If set, read messages marked as flagged will not be moved
4384 from your spool mailbox to your ``<a href="#mbox" title="3.115. mbox">$mbox</a>'' mailbox, or as a result of
4385 a ``<a href="#mbox-hook" title="12. Using Multiple spool mailboxes">mbox-hook</a>'' command.
4386 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="locale"></a>3.103. locale</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4387 Default: "C"</p></div><p>
4388 The locale used by <span class="emphasis"><em>strftime(3)</em></span> to format dates. Legal values are
4389 the strings your system accepts for the locale variable <span class="emphasis"><em>LC_TIME</em></span>.
4390 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mail-check"></a>3.104. mail_check</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4391 Default: 5</p></div><p>
4392 This variable configures how often (in seconds) mutt should look for
4393 new mail. Also see the ``<a href="#timeout" title="3.287. timeout">$timeout</a>'' variable.
4394 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-path"></a>3.105. mailcap_path</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4395 Default: ""</p></div><p>
4396 This variable specifies which files to consult when attempting to
4397 display MIME bodies not directly supported by Mutt.
4398 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mailcap-sanitize"></a>3.106. mailcap_sanitize</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4399 Default: yes</p></div><p>
4400 If set, mutt will restrict possible characters in mailcap % expandos
4401 to a well-defined set of safe characters. This is the safe setting,
4402 but we are not sure it doesn't break some more advanced MIME stuff.
4404 <span class="bold"><strong>DON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
4405 DOING!</strong></span>
4406 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache"></a>3.107. header_cache</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4407 Default: ""</p></div><p>
4408 The header_cache variable points to the header cache database.
4409 If header_cache points to a directory it will contain a header cache
4410 database per folder. If header_cache points to a file that file will
4411 be a single global header cache. By default it is unset so no header
4412 caching will be used.
4413 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maildir-header-cache-verify"></a>3.108. maildir_header_cache_verify</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4414 Default: yes</p></div><p>
4415 Check for Maildir unaware programs other than mutt having modified maildir
4416 files when the header cache is in use. This incurs one stat(2) per
4417 message every time the folder is opened.
4418 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache-pagesize"></a>3.109. header_cache_pagesize</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4419 Default: "16384"</p></div><p>
4420 When mutt is compiled with either gdbm or bdb4 as the header cache backend,
4421 this option changes the database page size. Too large or too small
4422 values can waste space, memory, or CPU time. The default should be more
4423 or less optimal for most use cases.
4424 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="header-cache-compress"></a>3.110. header_cache_compress</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4425 Default: yes</p></div><p>
4426 When mutt is compiled with qdbm as header cache backend,
4427 this option determines whether the database will be compressed.
4428 Compression results in database files roughly being one fifth
4429 of the usual diskspace, but the uncompression can result in a
4430 slower opening of cached folder(s).
4431 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="maildir-trash"></a>3.111. maildir_trash</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4432 Default: no</p></div><p>
4433 If set, messages marked as deleted will be saved with the maildir
4434 (T)rashed flag instead of unlinked. <span class="bold"><strong>NOTE:</strong></span> this only applies
4435 to maildir-style mailboxes. Setting it will have no effect on other
4437 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mark-old"></a>3.112. mark_old</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4438 Default: yes</p></div><p>
4439 Controls whether or not mutt marks <span class="emphasis"><em>new</em></span> <span class="bold"><strong>unread</strong></span>
4440 messages as <span class="emphasis"><em>old</em></span> if you exit a mailbox without reading them.
4441 With this option set, the next time you start mutt, the messages
4442 will show up with an "O" next to them in the index menu,
4443 indicating that they are old.
4444 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="markers"></a>3.113. markers</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4445 Default: yes</p></div><p>
4446 Controls the display of wrapped lines in the internal pager. If set, a
4447 ``+'' marker is displayed at the beginning of wrapped lines. Also see
4448 the ``<a href="#smart-wrap" title="3.264. smart_wrap">$smart_wrap</a>'' variable.
4449 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mask"></a>3.114. mask</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
4450 Default: "!^\.[^.]"</p></div><p>
4451 A regular expression used in the file browser, optionally preceded by
4452 the <span class="emphasis"><em>not</em></span> operator ``!''. Only files whose names match this mask
4453 will be shown. The match is always case-sensitive.
4454 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mbox"></a>3.115. mbox</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4455 Default: "˜/mbox"</p></div><p>
4456 This specifies the folder into which read mail in your ``<a href="#spoolfile" title="3.276. spoolfile">$spoolfile</a>''
4457 folder will be appended.
4458 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mbox-type"></a>3.116. mbox_type</h3></div></div></div><div class="literallayout"><p>Type: folder magic<br />
4459 Default: mbox</p></div><p>
4460 The default mailbox type used when creating new folders. May be any of
4461 mbox, MMDF, MH and Maildir.
4462 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="metoo"></a>3.117. metoo</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4463 Default: no</p></div><p>
4464 If unset, Mutt will remove your address (see the ``alternates''
4465 command) from the list of recipients when replying to a message.
4466 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-context"></a>3.118. menu_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4467 Default: 0</p></div><p>
4468 This variable controls the number of lines of context that are given
4469 when scrolling through menus. (Similar to ``<a href="#pager-context" title="3.138. pager_context">$pager_context</a>''.)
4470 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-move-off"></a>3.119. menu_move_off</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4471 Default: yes</p></div><p>
4472 When <span class="emphasis"><em>unset</em></span>, the bottom entry of menus will never scroll up past
4473 the bottom of the screen, unless there are less entries than lines.
4474 When <span class="emphasis"><em>set</em></span>, the bottom entry may move off the bottom.
4475 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="menu-scroll"></a>3.120. menu_scroll</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4476 Default: no</p></div><p>
4477 When <span class="emphasis"><em>set</em></span>, menus will be scrolled up or down one line when you
4478 attempt to move across a screen boundary. If <span class="emphasis"><em>unset</em></span>, the screen
4479 is cleared and the next or previous page of the menu is displayed
4480 (useful for slow links to avoid many redraws).
4481 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="meta-key"></a>3.121. meta_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4482 Default: no</p></div><p>
4483 If set, forces Mutt to interpret keystrokes with the high bit (bit 8)
4484 set as if the user had pressed the ESC key and whatever key remains
4485 after having the high bit removed. For example, if the key pressed
4486 has an ASCII value of 0xf8, then this is treated as if the user had
4487 pressed ESC then ``x''. This is because the result of removing the
4488 high bit from ``0xf8'' is ``0x78'', which is the ASCII character
4490 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-purge"></a>3.122. mh_purge</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4491 Default: no</p></div><p>
4492 When unset, mutt will mimic mh's behaviour and rename deleted messages
4493 to <span class="emphasis"><em>,<old file name></em></span> in mh folders instead of really deleting
4494 them. If the variable is set, the message files will simply be
4496 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-flagged"></a>3.123. mh_seq_flagged</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4497 Default: "flagged"</p></div><p>
4498 The name of the MH sequence used for flagged messages.
4499 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-replied"></a>3.124. mh_seq_replied</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4500 Default: "replied"</p></div><p>
4501 The name of the MH sequence used to tag replied messages.
4502 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mh-seq-unseen"></a>3.125. mh_seq_unseen</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4503 Default: "unseen"</p></div><p>
4504 The name of the MH sequence used for unseen messages.
4505 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward"></a>3.126. mime_forward</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4506 Default: no</p></div><p>
4507 When set, the message you are forwarding will be attached as a
4508 separate MIME part instead of included in the main body of the
4509 message. This is useful for forwarding MIME messages so the receiver
4510 can properly view the message as it was delivered to you. If you like
4511 to switch between MIME and not MIME from mail to mail, set this
4512 variable to ask-no or ask-yes.
4514 Also see ``<a href="#forward-decode" title="3.62. forward_decode">$forward_decode</a>'' and ``<a href="#mime-forward-decode" title="3.127. mime_forward_decode">$mime_forward_decode</a>''.
4515 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward-decode"></a>3.127. mime_forward_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4516 Default: no</p></div><p>
4517 Controls the decoding of complex MIME messages into text/plain when
4518 forwarding a message while ``<a href="#mime-forward" title="3.126. mime_forward">$mime_forward</a>'' is <span class="emphasis"><em>set</em></span>. Otherwise
4519 ``<a href="#forward-decode" title="3.62. forward_decode">$forward_decode</a>'' is used instead.
4520 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mime-forward-rest"></a>3.128. mime_forward_rest</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4521 Default: yes</p></div><p>
4522 When forwarding multiple attachments of a MIME message from the recvattach
4523 menu, attachments which cannot be decoded in a reasonable manner will
4524 be attached to the newly composed message if this option is set.
4525 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mix-entry-format"></a>3.129. mix_entry_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4526 Default: "%4n %c %-16s %a"</p></div><p>
4527 This variable describes the format of a remailer line on the mixmaster
4528 chain selection screen. The following printf-like sequences are
4532 </p><div class="variablelist"><dl><dt><span class="term">%n </span></dt><dd><p>The running number on the menu.
4533 </p></dd><dt><span class="term">%c </span></dt><dd><p>Remailer capabilities.
4534 </p></dd><dt><span class="term">%s </span></dt><dd><p>The remailer's short name.
4535 </p></dd><dt><span class="term">%a </span></dt><dd><p>The remailer's e-mail address.
4536 </p></dd></dl></div><p>
4537 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mixmaster"></a>3.130. mixmaster</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4538 Default: "mixmaster"</p></div><p>
4539 This variable contains the path to the Mixmaster binary on your
4540 system. It is used with various sets of parameters to gather the
4541 list of known remailers, and to finally send a message through the
4543 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="move"></a>3.131. move</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4544 Default: ask-no</p></div><p>
4545 Controls whether or not Mutt will move read messages
4546 from your spool mailbox to your ``<a href="#mbox" title="3.115. mbox">$mbox</a>'' mailbox, or as a result of
4547 a ``<a href="#mbox-hook" title="12. Using Multiple spool mailboxes">mbox-hook</a>'' command.
4548 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-cachedir"></a>3.132. message_cachedir</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4549 Default: ""</p></div><p>
4550 Set this to a directory and mutt will cache copies of messages from
4551 your IMAP and POP servers here. You are free to remove entries at any
4552 time, for instance if stale entries accumulate because you have
4553 deleted messages with another mail client.
4554 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-cache-clean"></a>3.133. message_cache_clean</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4555 Default: no</p></div><p>
4556 If set, mutt will clean out obsolete entries from the cache when
4557 the mailbox is synchronized. You probably only want to set it
4558 every once in a while, since it can be a little slow.
4559 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="message-format"></a>3.134. message_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4560 Default: "%s"</p></div><p>
4561 This is the string displayed in the ``attachment'' menu for
4562 attachments of type message/rfc822. For a full listing of defined
4563 printf()-like sequences see the section on ``<a href="#index-format" title="3.100. index_format">$index_format</a>''.
4564 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="narrow-tree"></a>3.135. narrow_tree</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4565 Default: no</p></div><p>
4566 This variable, when set, makes the thread tree narrower, allowing
4567 deeper threads to fit on the screen.
4568 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="net-inc"></a>3.136. net_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4569 Default: 10</p></div><p>
4570 Operations that expect to transfer a large amount of data over the
4571 network will update their progress every <span class="emphasis"><em>net_inc</em></span> kilobytes.
4572 If set to 0, no progress messages will be displayed.
4574 See also ``<a href="#read-inc" title="3.235. read_inc">$read_inc</a>'' and ``<a href="#write-inc" title="3.304. write_inc">$write_inc</a>''.
4575 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager"></a>3.137. pager</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4576 Default: "builtin"</p></div><p>
4577 This variable specifies which pager you would like to use to view
4578 messages. builtin means to use the builtin pager, otherwise this
4579 variable should specify the pathname of the external pager you would
4582 Using an external pager may have some disadvantages: Additional
4583 keystrokes are necessary because you can't call mutt functions
4584 directly from the pager, and screen resizes cause lines longer than
4585 the screen width to be badly formatted in the help menu.
4586 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-context"></a>3.138. pager_context</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4587 Default: 0</p></div><p>
4588 This variable controls the number of lines of context that are given
4589 when displaying the next or previous page in the internal pager. By
4590 default, Mutt will display the line after the last one on the screen
4591 at the top of the next page (0 lines of context).
4592 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-format"></a>3.139. pager_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4593 Default: "-%Z- %C/%m: %-20.20n %s%* -- (%P)"</p></div><p>
4594 This variable controls the format of the one-line message ``status''
4595 displayed before each message in either the internal or an external
4596 pager. The valid sequences are listed in the ``<a href="#index-format" title="3.100. index_format">$index_format</a>''
4598 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-index-lines"></a>3.140. pager_index_lines</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4599 Default: 0</p></div><p>
4600 Determines the number of lines of a mini-index which is shown when in
4601 the pager. The current message, unless near the top or bottom of the
4602 folder, will be roughly one third of the way down this mini-index,
4603 giving the reader the context of a few messages before and after the
4604 message. This is useful, for example, to determine how many messages
4605 remain to be read in the current thread. One of the lines is reserved
4606 for the status bar from the index, so a <span class="emphasis"><em>pager_index_lines</em></span> of 6
4607 will only show 5 lines of the actual index. A value of 0 results in
4608 no index being shown. If the number of messages in the current folder
4609 is less than <span class="emphasis"><em>pager_index_lines</em></span>, then the index will only use as
4610 many lines as it needs.
4611 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager-stop"></a>3.141. pager_stop</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4612 Default: no</p></div><p>
4613 When set, the internal-pager will <span class="bold"><strong>not</strong></span> move to the next message
4614 when you are at the end of a message and invoke the <span class="emphasis"><em>next-page</em></span>
4616 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autosign"></a>3.142. crypt_autosign</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4617 Default: no</p></div><p>
4618 Setting this variable will cause Mutt to always attempt to
4619 cryptographically sign outgoing messages. This can be overridden
4620 by use of the <span class="emphasis"><em>pgp-menu</em></span>, when signing is not required or
4621 encryption is requested as well. If ``<a href="#smime-is-default" title="3.151. smime_is_default">$smime_is_default</a>'' is set,
4622 then OpenSSL is used instead to create S/MIME messages and settings can
4623 be overridden by use of the <span class="emphasis"><em>smime-menu</em></span>.
4625 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-autoencrypt"></a>3.143. crypt_autoencrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4626 Default: no</p></div><p>
4627 Setting this variable will cause Mutt to always attempt to PGP
4628 encrypt outgoing messages. This is probably only useful in
4629 connection to the <span class="emphasis"><em>send-hook</em></span> command. It can be overridden
4630 by use of the <span class="emphasis"><em>pgp-menu</em></span>, when encryption is not required or
4631 signing is requested as well. IF ``<a href="#smime-is-default" title="3.151. smime_is_default">$smime_is_default</a>'' is set,
4632 then OpenSSL is used instead to create S/MIME messages and
4633 settings can be overridden by use of the <span class="emphasis"><em>smime-menu</em></span>.
4635 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-ignore-subkeys"></a>3.144. pgp_ignore_subkeys</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4636 Default: yes</p></div><p>
4637 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
4638 the principal key will inherit the subkeys' capabilities. Unset this
4639 if you want to play interesting key selection games.
4641 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replyencrypt"></a>3.145. crypt_replyencrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4642 Default: yes</p></div><p>
4643 If set, automatically PGP or OpenSSL encrypt replies to messages which are
4646 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replysign"></a>3.146. crypt_replysign</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4647 Default: no</p></div><p>
4648 If set, automatically PGP or OpenSSL sign replies to messages which are
4651 <span class="bold"><strong>Note:</strong></span> this does not work on messages that are encrypted
4652 <span class="bold"><strong>and</strong></span> signed!
4654 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-replysignencrypted"></a>3.147. crypt_replysignencrypted</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4655 Default: no</p></div><p>
4656 If set, automatically PGP or OpenSSL sign replies to messages
4657 which are encrypted. This makes sense in combination with
4658 ``<a href="#crypt-replyencrypt" title="3.145. crypt_replyencrypt">$crypt_replyencrypt</a>'', because it allows you to sign all
4659 messages which are automatically encrypted. This works around
4660 the problem noted in ``<a href="#crypt-replysign" title="3.146. crypt_replysign">$crypt_replysign</a>'', that mutt is not able
4661 to find out whether an encrypted message is also signed.
4663 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-timestamp"></a>3.148. crypt_timestamp</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4664 Default: yes</p></div><p>
4665 If set, mutt will include a time stamp in the lines surrounding
4666 PGP or S/MIME output, so spoofing such lines is more difficult.
4667 If you are using colors to mark these lines, and rely on these,
4668 you may unset this setting.
4670 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-use-gpg-agent"></a>3.149. pgp_use_gpg_agent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4671 Default: no</p></div><p>
4672 If set, mutt will use a possibly-running gpg-agent process.
4674 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="crypt-verify-sig"></a>3.150. crypt_verify_sig</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4675 Default: yes</p></div><p>
4676 If ``yes'', always attempt to verify PGP or S/MIME signatures.
4677 If ``ask'', ask whether or not to verify the signature.
4678 If ``no'', never attempt to verify cryptographic signatures.
4680 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-is-default"></a>3.151. smime_is_default</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4681 Default: no</p></div><p>
4682 The default behaviour of mutt is to use PGP on all auto-sign/encryption
4683 operations. To override and to use OpenSSL instead this must be set.
4684 However, this has no effect while replying, since mutt will automatically
4685 select the same application that was used to sign/encrypt the original
4686 message. (Note that this variable can be overridden by unsetting <a href="#crypt-autosmime" title="3.39. crypt_autosmime">$crypt_autosmime</a>.)
4688 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-ask-cert-label"></a>3.152. smime_ask_cert_label</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4689 Default: yes</p></div><p>
4690 This flag controls whether you want to be asked to enter a label
4691 for a certificate about to be added to the database or not. It is
4694 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-decrypt-use-default-key"></a>3.153. smime_decrypt_use_default_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4695 Default: yes</p></div><p>
4696 If set (default) this tells mutt to use the default key for decryption. Otherwise,
4697 if manage multiple certificate-key-pairs, mutt will try to use the mailbox-address
4698 to determine the key to use. It will ask you to supply a key, if it can't find one.
4700 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-entry-format"></a>3.154. pgp_entry_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4701 Default: "%4n %t%f %4l/0x%k %-4a %2c %u"</p></div><p>
4702 This variable allows you to customize the PGP key selection menu to
4703 your personal taste. This string is similar to ``<a href="#index-format" title="3.100. index_format">$index_format</a>'', but
4704 has its own set of printf()-like sequences:
4707 </p><div class="variablelist"><dl><dt><span class="term">%n </span></dt><dd><p>number
4708 </p></dd><dt><span class="term">%k </span></dt><dd><p>key id
4709 </p></dd><dt><span class="term">%u </span></dt><dd><p>user id
4710 </p></dd><dt><span class="term">%a </span></dt><dd><p>algorithm
4711 </p></dd><dt><span class="term">%l </span></dt><dd><p>key length
4712 </p></dd><dt><span class="term">%f </span></dt><dd><p>flags
4713 </p></dd><dt><span class="term">%c </span></dt><dd><p>capabilities
4714 </p></dd><dt><span class="term">%t </span></dt><dd><p>trust/validity of the key-uid association
4715 </p></dd><dt><span class="term">%[<s>] </span></dt><dd><p>date of the key where <s> is an strftime(3) expression
4716 </p></dd></dl></div><p>
4720 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-good-sign"></a>3.155. pgp_good_sign</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
4721 Default: ""</p></div><p>
4722 If you assign a text to this variable, then a PGP signature is only
4723 considered verified if the output from <a href="#pgp-verify-command" title="3.170. pgp_verify_command">$pgp_verify_command</a> contains
4724 the text. Use this variable if the exit code from the command is 0
4725 even for bad signatures.
4727 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-check-exit"></a>3.156. pgp_check_exit</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4728 Default: yes</p></div><p>
4729 If set, mutt will check the exit code of the PGP subprocess when
4730 signing or encrypting. A non-zero exit code means that the
4733 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-long-ids"></a>3.157. pgp_long_ids</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4734 Default: no</p></div><p>
4735 If set, use 64 bit PGP key IDs. Unset uses the normal 32 bit Key IDs.
4737 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-retainable-sigs"></a>3.158. pgp_retainable_sigs</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4738 Default: no</p></div><p>
4739 If set, signed and encrypted messages will consist of nested
4740 multipart/signed and multipart/encrypted body parts.
4742 This is useful for applications like encrypted and signed mailing
4743 lists, where the outer layer (multipart/encrypted) can be easily
4744 removed, while the inner multipart/signed part is retained.
4746 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-autoinline"></a>3.159. pgp_autoinline</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4747 Default: no</p></div><p>
4748 This option controls whether Mutt generates old-style inline
4749 (traditional) PGP encrypted or signed messages under certain
4750 circumstances. This can be overridden by use of the <span class="emphasis"><em>pgp-menu</em></span>,
4751 when inline is not required.
4753 Note that Mutt might automatically use PGP/MIME for messages
4754 which consist of more than a single MIME part. Mutt can be
4755 configured to ask before sending PGP/MIME messages when inline
4756 (traditional) would not work.
4757 See also: ``<a href="#pgp-mime-auto" title="3.166. pgp_mime_auto">$pgp_mime_auto</a>''.
4759 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
4760 <span class="bold"><strong>deprecated</strong></span>.
4762 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-replyinline"></a>3.160. pgp_replyinline</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4763 Default: no</p></div><p>
4764 Setting this variable will cause Mutt to always attempt to
4765 create an inline (traditional) message when replying to a
4766 message which is PGP encrypted/signed inline. This can be
4767 overridden by use of the <span class="emphasis"><em>pgp-menu</em></span>, when inline is not
4768 required. This option does not automatically detect if the
4769 (replied-to) message is inline; instead it relies on Mutt
4770 internals for previously checked/flagged messages.
4772 Note that Mutt might automatically use PGP/MIME for messages
4773 which consist of more than a single MIME part. Mutt can be
4774 configured to ask before sending PGP/MIME messages when inline
4775 (traditional) would not work.
4776 See also: ``<a href="#pgp-mime-auto" title="3.166. pgp_mime_auto">$pgp_mime_auto</a>''.
4778 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
4779 <span class="bold"><strong>deprecated</strong></span>.
4781 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-show-unusable"></a>3.161. pgp_show_unusable</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4782 Default: yes</p></div><p>
4783 If set, mutt will display non-usable keys on the PGP key selection
4784 menu. This includes keys which have been revoked, have expired, or
4785 have been marked as ``disabled'' by the user.
4787 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sign-as"></a>3.162. pgp_sign_as</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4788 Default: ""</p></div><p>
4789 If you have more than one key pair, this option allows you to specify
4790 which of your private keys to use. It is recommended that you use the
4791 keyid form to specify your key (e.g., ``0x00112233'').
4793 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-strict-enc"></a>3.163. pgp_strict_enc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4794 Default: yes</p></div><p>
4795 If set, Mutt will automatically encode PGP/MIME signed messages as
4796 <span class="emphasis"><em>quoted-printable</em></span>. Please note that unsetting this variable may
4797 lead to problems with non-verifyable PGP signatures, so only change
4798 this if you know what you are doing.
4800 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-timeout"></a>3.164. pgp_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4801 Default: 300</p></div><p>
4802 The number of seconds after which a cached passphrase will expire if
4805 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sort-keys"></a>3.165. pgp_sort_keys</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
4806 Default: address</p></div><p>
4807 Specifies how the entries in the `pgp keys' menu are sorted. The
4808 following are legal values:
4811 </p><div class="variablelist"><dl><dt><span class="term">address </span></dt><dd><p>sort alphabetically by user id
4812 </p></dd><dt><span class="term">keyid </span></dt><dd><p>sort alphabetically by key id
4813 </p></dd><dt><span class="term">date </span></dt><dd><p>sort by key creation date
4814 </p></dd><dt><span class="term">trust </span></dt><dd><p>sort by the trust of the key
4815 </p></dd></dl></div><p>
4818 If you prefer reverse order of the above values, prefix it with
4821 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-mime-auto"></a>3.166. pgp_mime_auto</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
4822 Default: ask-yes</p></div><p>
4823 This option controls whether Mutt will prompt you for
4824 automatically sending a (signed/encrypted) message using
4825 PGP/MIME when inline (traditional) fails (for any reason).
4827 Also note that using the old-style PGP message format is <span class="bold"><strong>strongly</strong></span>
4828 <span class="bold"><strong>deprecated</strong></span>.
4830 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-auto-decode"></a>3.167. pgp_auto_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4831 Default: no</p></div><p>
4832 If set, mutt will automatically attempt to decrypt traditional PGP
4833 messages whenever the user performs an operation which ordinarily would
4834 result in the contents of the message being operated on. For example,
4835 if the user displays a pgp-traditional message which has not been manually
4836 checked with the check-traditional-pgp function, mutt will automatically
4837 check the message for traditional pgp.
4838 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-decode-command"></a>3.168. pgp_decode_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4839 Default: ""</p></div><p>
4840 This format strings specifies a command which is used to decode
4841 application/pgp attachments.
4843 The PGP command formats have their own set of printf-like sequences:
4846 </p><div class="variablelist"><dl><dt><span class="term">%p </span></dt><dd><p>Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
4847 string otherwise. Note: This may be used with a %? construct.
4848 </p></dd><dt><span class="term">%f </span></dt><dd><p>Expands to the name of a file containing a message.
4849 </p></dd><dt><span class="term">%s </span></dt><dd><p>Expands to the name of a file containing the signature part
4850 of a multipart/signed attachment when verifying it.
4851 </p></dd><dt><span class="term">%a </span></dt><dd><p>The value of <a href="#pgp-sign-as" title="3.162. pgp_sign_as">$pgp_sign_as</a>.
4852 </p></dd><dt><span class="term">%r </span></dt><dd><p>One or more key IDs.
4853 </p></dd></dl></div><p>
4856 For examples on how to configure these formats for the various versions
4857 of PGP which are floating around, see the pgp*.rc and gpg.rc files in
4858 the samples/ subdirectory which has been installed on your system
4859 alongside the documentation.
4861 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-getkeys-command"></a>3.169. pgp_getkeys_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4862 Default: ""</p></div><p>
4863 This command is invoked whenever mutt will need public key information.
4864 %r is the only printf-like sequence used with this format.
4866 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-verify-command"></a>3.170. pgp_verify_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4867 Default: ""</p></div><p>
4868 This command is used to verify PGP signatures.
4870 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-decrypt-command"></a>3.171. pgp_decrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4871 Default: ""</p></div><p>
4872 This command is used to decrypt a PGP encrypted message.
4874 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-clearsign-command"></a>3.172. pgp_clearsign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4875 Default: ""</p></div><p>
4876 This format is used to create a old-style "clearsigned" PGP
4877 message. Note that the use of this format is <span class="bold"><strong>strongly</strong></span>
4878 <span class="bold"><strong>deprecated</strong></span>.
4880 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-sign-command"></a>3.173. pgp_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4881 Default: ""</p></div><p>
4882 This command is used to create the detached PGP signature for a
4883 multipart/signed PGP/MIME body part.
4885 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-encrypt-sign-command"></a>3.174. pgp_encrypt_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4886 Default: ""</p></div><p>
4887 This command is used to both sign and encrypt a body part.
4889 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-encrypt-only-command"></a>3.175. pgp_encrypt_only_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4890 Default: ""</p></div><p>
4891 This command is used to encrypt a body part without signing it.
4893 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-import-command"></a>3.176. pgp_import_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4894 Default: ""</p></div><p>
4895 This command is used to import a key from a message into
4896 the user's public key ring.
4898 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-export-command"></a>3.177. pgp_export_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4899 Default: ""</p></div><p>
4900 This command is used to export a public key from the user's
4903 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-verify-key-command"></a>3.178. pgp_verify_key_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4904 Default: ""</p></div><p>
4905 This command is used to verify key information from the key selection
4908 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-list-secring-command"></a>3.179. pgp_list_secring_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4909 Default: ""</p></div><p>
4910 This command is used to list the secret key ring's contents. The
4911 output format must be analogous to the one used by
4912 gpg --list-keys --with-colons.
4914 This format is also generated by the pgpring utility which comes
4917 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp-list-pubring-command"></a>3.180. pgp_list_pubring_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4918 Default: ""</p></div><p>
4919 This command is used to list the public key ring's contents. The
4920 output format must be analogous to the one used by
4921 gpg --list-keys --with-colons.
4923 This format is also generated by the pgpring utility which comes
4926 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="forward-decrypt"></a>3.181. forward_decrypt</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
4927 Default: yes</p></div><p>
4928 Controls the handling of encrypted messages when forwarding a message.
4929 When set, the outer layer of encryption is stripped off. This
4930 variable is only used if ``<a href="#mime-forward" title="3.126. mime_forward">$mime_forward</a>'' is <span class="emphasis"><em>set</em></span> and
4931 ``<a href="#mime-forward-decode" title="3.127. mime_forward_decode">$mime_forward_decode</a>'' is <span class="emphasis"><em>unset</em></span>.
4933 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-timeout"></a>3.182. smime_timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
4934 Default: 300</p></div><p>
4935 The number of seconds after which a cached passphrase will expire if
4938 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-encrypt-with"></a>3.183. smime_encrypt_with</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4939 Default: ""</p></div><p>
4940 This sets the algorithm that should be used for encryption.
4941 Valid choices are "des", "des3", "rc2-40", "rc2-64", "rc2-128".
4942 If unset "3des" (TripleDES) is used.
4944 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-keys"></a>3.184. smime_keys</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4945 Default: ""</p></div><p>
4946 Since there is no pubring/secring as with PGP, mutt has to handle
4947 storage ad retrieval of keys/certs by itself. This is very basic right now,
4948 and stores keys and certificates in two different directories, both
4949 named as the hash-value retrieved from OpenSSL. There is an index file
4950 which contains mailbox-address keyid pair, and which can be manually
4951 edited. This one points to the location of the private keys.
4953 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-ca-location"></a>3.185. smime_ca_location</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4954 Default: ""</p></div><p>
4955 This variable contains the name of either a directory, or a file which
4956 contains trusted certificates for use with OpenSSL.
4958 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-certificates"></a>3.186. smime_certificates</h3></div></div></div><div class="literallayout"><p>Type: path<br />
4959 Default: ""</p></div><p>
4960 Since there is no pubring/secring as with PGP, mutt has to handle
4961 storage and retrieval of keys by itself. This is very basic right
4962 now, and keys and certificates are stored in two different
4963 directories, both named as the hash-value retrieved from
4964 OpenSSL. There is an index file which contains mailbox-address
4965 keyid pairs, and which can be manually edited. This one points to
4966 the location of the certificates.
4968 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-decrypt-command"></a>3.187. smime_decrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4969 Default: ""</p></div><p>
4970 This format string specifies a command which is used to decrypt
4971 application/x-pkcs7-mime attachments.
4973 The OpenSSL command formats have their own set of printf-like sequences
4977 </p><div class="variablelist"><dl><dt><span class="term">%f </span></dt><dd><p>Expands to the name of a file containing a message.
4978 </p></dd><dt><span class="term">%s </span></dt><dd><p>Expands to the name of a file containing the signature part
4979 of a multipart/signed attachment when verifying it.
4980 </p></dd><dt><span class="term">%k </span></dt><dd><p>The key-pair specified with <a href="#smime-default-key" title="3.198. smime_default_key">$smime_default_key</a>
4981 </p></dd><dt><span class="term">%c </span></dt><dd><p>One or more certificate IDs.
4982 </p></dd><dt><span class="term">%a </span></dt><dd><p>The algorithm used for encryption.
4983 </p></dd><dt><span class="term">%C </span></dt><dd><p>CA location: Depending on whether <a href="#smime-ca-location" title="3.185. smime_ca_location">$smime_ca_location</a>
4984 points to a directory or file, this expands to
4985 "-CApath <a href="#smime-ca-location" title="3.185. smime_ca_location">$smime_ca_location</a>" or "-CAfile <a href="#smime-ca-location" title="3.185. smime_ca_location">$smime_ca_location</a>".
4986 </p></dd></dl></div><p>
4989 For examples on how to configure these formats, see the smime.rc in
4990 the samples/ subdirectory which has been installed on your system
4991 alongside the documentation.
4993 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-verify-command"></a>3.188. smime_verify_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4994 Default: ""</p></div><p>
4995 This command is used to verify S/MIME signatures of type multipart/signed.
4997 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-verify-opaque-command"></a>3.189. smime_verify_opaque_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
4998 Default: ""</p></div><p>
4999 This command is used to verify S/MIME signatures of type
5000 application/x-pkcs7-mime.
5002 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-sign-command"></a>3.190. smime_sign_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5003 Default: ""</p></div><p>
5004 This command is used to created S/MIME signatures of type
5005 multipart/signed, which can be read by all mail clients.
5007 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-sign-opaque-command"></a>3.191. smime_sign_opaque_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5008 Default: ""</p></div><p>
5009 This command is used to created S/MIME signatures of type
5010 application/x-pkcs7-signature, which can only be handled by mail
5011 clients supporting the S/MIME extension.
5013 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-encrypt-command"></a>3.192. smime_encrypt_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5014 Default: ""</p></div><p>
5015 This command is used to create encrypted S/MIME messages.
5017 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-pk7out-command"></a>3.193. smime_pk7out_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5018 Default: ""</p></div><p>
5019 This command is used to extract PKCS7 structures of S/MIME signatures,
5020 in order to extract the public X509 certificate(s).
5022 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-cert-command"></a>3.194. smime_get_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5023 Default: ""</p></div><p>
5024 This command is used to extract X509 certificates from a PKCS7 structure.
5026 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-signer-cert-command"></a>3.195. smime_get_signer_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5027 Default: ""</p></div><p>
5028 This command is used to extract only the signers X509 certificate from a S/MIME
5029 signature, so that the certificate's owner may get compared to the
5030 email's 'From'-field.
5032 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-import-cert-command"></a>3.196. smime_import_cert_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5033 Default: ""</p></div><p>
5034 This command is used to import a certificate via smime_keys.
5036 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-get-cert-email-command"></a>3.197. smime_get_cert_email_command</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5037 Default: ""</p></div><p>
5038 This command is used to extract the mail address(es) used for storing
5039 X509 certificates, and for verification purposes (to check whether the
5040 certificate was issued for the sender's mailbox).
5042 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime-default-key"></a>3.198. smime_default_key</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5043 Default: ""</p></div><p>
5044 This is the default key-pair to use for signing. This must be set to the
5045 keyid (the hash-value that OpenSSL generates) to work properly
5047 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-client-cert"></a>3.199. ssl_client_cert</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5048 Default: ""</p></div><p>
5049 The file containing a client certificate and its associated private
5051 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-force-tls"></a>3.200. ssl_force_tls</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5052 Default: no</p></div><p>
5053 If this variable is set, Mutt will require that all connections
5054 to remote servers be encrypted. Furthermore it will attempt to
5055 negotiate TLS even if the server does not advertise the capability,
5056 since it would otherwise have to abort the connection anyway. This
5057 option supersedes ``<a href="#ssl-starttls" title="3.201. ssl_starttls">$ssl_starttls</a>''.
5058 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-starttls"></a>3.201. ssl_starttls</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5059 Default: yes</p></div><p>
5060 If set (the default), mutt will attempt to use STARTTLS on servers
5061 advertising the capability. When unset, mutt will not attempt to
5062 use STARTTLS regardless of the server's capabilities.
5063 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="certificate-file"></a>3.202. certificate_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5064 Default: "˜/.mutt_certificates"</p></div><p>
5065 This variable specifies the file where the certificates you trust
5066 are saved. When an unknown certificate is encountered, you are asked
5067 if you accept it or not. If you accept it, the certificate can also
5068 be saved in this file and further connections are automatically
5071 You can also manually add CA certificates in this file. Any server
5072 certificate that is signed with one of these CA certificates are
5073 also automatically accepted.
5075 Example: set certificate_file=˜/.mutt/certificates
5076 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-usesystemcerts"></a>3.203. ssl_usesystemcerts</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5077 Default: yes</p></div><p>
5078 If set to <span class="emphasis"><em>yes</em></span>, mutt will use CA certificates in the
5079 system-wide certificate store when checking if server certificate
5080 is signed by a trusted CA.
5081 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="entropy-file"></a>3.204. entropy_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5082 Default: ""</p></div><p>
5083 The file which includes random data that is used to initialize SSL
5085 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-sslv2"></a>3.205. ssl_use_sslv2</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5086 Default: yes</p></div><p>
5087 This variables specifies whether to attempt to use SSLv2 in the
5088 SSL authentication process.
5089 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-sslv3"></a>3.206. ssl_use_sslv3</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5090 Default: yes</p></div><p>
5091 This variables specifies whether to attempt to use SSLv3 in the
5092 SSL authentication process.
5093 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-use-tlsv1"></a>3.207. ssl_use_tlsv1</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5094 Default: yes</p></div><p>
5095 This variables specifies whether to attempt to use TLSv1 in the
5096 SSL authentication process.
5097 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-min-dh-prime-bits"></a>3.208. ssl_min_dh_prime_bits</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5098 Default: 0</p></div><p>
5099 This variable specifies the minimum acceptable prime size (in bits)
5100 for use in any Diffie-Hellman key exchange. A value of 0 will use
5101 the default from the GNUTLS library.
5102 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="ssl-ca-certificates-file"></a>3.209. ssl_ca_certificates_file</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5103 Default: ""</p></div><p>
5104 This variable specifies a file containing trusted CA certificates.
5105 Any server certificate that is signed with one of these CA
5106 certificates are also automatically accepted.
5108 Example: set ssl_ca_certificates_file=/etc/ssl/certs/ca-certificates.crt
5109 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-split"></a>3.210. pipe_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5110 Default: no</p></div><p>
5111 Used in connection with the <span class="emphasis"><em>pipe-message</em></span> command and the ``tag-
5112 prefix'' operator. If this variable is unset, when piping a list of
5113 tagged messages Mutt will concatenate the messages and will pipe them
5114 as a single folder. When set, Mutt will pipe the messages one by one.
5115 In both cases the messages are piped in the current sorted order,
5116 and the ``<a href="#pipe-sep" title="3.212. pipe_sep">$pipe_sep</a>'' separator is added after each message.
5117 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-decode"></a>3.211. pipe_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5118 Default: no</p></div><p>
5119 Used in connection with the <span class="emphasis"><em>pipe-message</em></span> command. When unset,
5120 Mutt will pipe the messages without any preprocessing. When set, Mutt
5121 will weed headers and will attempt to PGP/MIME decode the messages
5123 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pipe-sep"></a>3.212. pipe_sep</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5124 Default: "\n"</p></div><p>
5125 The separator to add between messages when piping a list of tagged
5126 messages to an external Unix command.
5127 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-authenticators"></a>3.213. pop_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5128 Default: ""</p></div><p>
5129 This is a colon-delimited list of authentication methods mutt may
5130 attempt to use to log in to an POP server, in the order mutt should
5131 try them. Authentication methods are either 'user', 'apop' or any
5132 SASL mechanism, eg 'digest-md5', 'gssapi' or 'cram-md5'.
5133 This parameter is case-insensitive. If this parameter is unset
5134 (the default) mutt will try all available methods, in order from
5135 most-secure to least-secure.
5137 Example: set pop_authenticators="digest-md5:apop:user"
5138 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-auth-try-all"></a>3.214. pop_auth_try_all</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5139 Default: yes</p></div><p>
5140 If set, Mutt will try all available methods. When unset, Mutt will
5141 only fall back to other authentication methods if the previous
5142 methods are unavailable. If a method is available but authentication
5143 fails, Mutt will not connect to the POP server.
5144 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-checkinterval"></a>3.215. pop_checkinterval</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5145 Default: 60</p></div><p>
5146 This variable configures how often (in seconds) mutt should look for
5147 new mail in the currently selected mailbox if it is a POP mailbox.
5148 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-delete"></a>3.216. pop_delete</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5149 Default: ask-no</p></div><p>
5150 If set, Mutt will delete successfully downloaded messages from the POP
5151 server when using the fetch-mail function. When unset, Mutt will
5152 download messages but also leave them on the POP server.
5153 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-host"></a>3.217. pop_host</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5154 Default: ""</p></div><p>
5155 The name of your POP server for the fetch-mail function. You
5156 can also specify an alternative port, username and password, ie:
5158 [pop[s]://][username[:password]@]popserver[:port]
5159 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-last"></a>3.218. pop_last</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5160 Default: no</p></div><p>
5161 If this variable is set, mutt will try to use the "LAST" POP command
5162 for retrieving only unread messages from the POP server when using
5163 the fetch-mail function.
5164 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-reconnect"></a>3.219. pop_reconnect</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5165 Default: ask-yes</p></div><p>
5166 Controls whether or not Mutt will try to reconnect to POP server if
5167 the connection is lost.
5168 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-user"></a>3.220. pop_user</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5169 Default: ""</p></div><p>
5170 Your login name on the POP server.
5172 This variable defaults to your user name on the local machine.
5173 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pop-pass"></a>3.221. pop_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5174 Default: ""</p></div><p>
5175 Specifies the password for your POP account. If unset, Mutt will
5176 prompt you for your password when you open POP mailbox.
5177 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
5178 fairly secure machine, because the superuser can read your muttrc
5179 even if you are the only one who can read the file.
5180 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="post-indent-string"></a>3.222. post_indent_string</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5181 Default: ""</p></div><p>
5182 Similar to the ``<a href="#attribution" title="3.16. attribution">$attribution</a>'' variable, Mutt will append this
5183 string after the inclusion of a message which is being replied to.
5184 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postpone"></a>3.223. postpone</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5185 Default: ask-yes</p></div><p>
5186 Controls whether or not messages are saved in the ``<a href="#postponed" title="3.224. postponed">$postponed</a>''
5187 mailbox when you elect not to send immediately. Also see the
5188 ``<a href="#recall" title="3.238. recall">$recall</a>'' variable.
5189 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postponed"></a>3.224. postponed</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5190 Default: "˜/postponed"</p></div><p>
5191 Mutt allows you to indefinitely ``<a href="#postpone" title="3.223. postpone">postpone</a> sending a message'' which
5192 you are editing. When you choose to postpone a message, Mutt saves it
5193 in the mailbox specified by this variable. Also see the ``<a href="#postpone" title="3.223. postpone">$postpone</a>''
5195 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="preconnect"></a>3.225. preconnect</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5196 Default: ""</p></div><p>
5197 If set, a shell command to be executed if mutt fails to establish
5198 a connection to the server. This is useful for setting up secure
5199 connections, e.g. with ssh(1). If the command returns a nonzero
5200 status, mutt gives up opening the server. Example:
5202 preconnect="ssh -f -q -L 1234:mailhost.net:143 mailhost.net
5203 sleep 20 < /dev/null > /dev/null"
5205 Mailbox 'foo' on mailhost.net can now be reached
5206 as '{localhost:1234}foo'.
5208 NOTE: For this example to work, you must be able to log in to the
5209 remote machine without having to enter a password.
5210 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print"></a>3.226. print</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5211 Default: ask-no</p></div><p>
5212 Controls whether or not Mutt really prints messages.
5213 This is set to <span class="emphasis"><em>ask-no</em></span> by default, because some people
5214 accidentally hit ``p'' often (like me).
5215 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-command"></a>3.227. print_command</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5216 Default: "lpr"</p></div><p>
5217 This specifies the command pipe that should be used to print messages.
5218 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-decode"></a>3.228. print_decode</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5219 Default: yes</p></div><p>
5220 Used in connection with the print-message command. If this
5221 option is set, the message is decoded before it is passed to the
5222 external command specified by <a href="#print-command" title="3.227. print_command">$print_command</a>. If this option
5223 is unset, no processing will be applied to the message when
5224 printing it. The latter setting may be useful if you are using
5225 some advanced printer filter which is able to properly format
5226 e-mail messages for printing.
5227 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="print-split"></a>3.229. print_split</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5228 Default: no</p></div><p>
5229 Used in connection with the print-message command. If this option
5230 is set, the command specified by <a href="#print-command" title="3.227. print_command">$print_command</a> is executed once for
5231 each message which is to be printed. If this option is unset,
5232 the command specified by <a href="#print-command" title="3.227. print_command">$print_command</a> is executed only once, and
5233 all the messages are concatenated, with a form feed as the message
5236 Those who use the <span class="bold"><strong>enscript</strong></span>(1) program's mail-printing mode will
5237 most likely want to set this option.
5238 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="prompt-after"></a>3.230. prompt_after</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5239 Default: yes</p></div><p>
5240 If you use an <span class="emphasis"><em>external</em></span> ``<a href="#pager" title="3.137. pager">$pager</a>'', setting this variable will
5241 cause Mutt to prompt you for a command when the pager exits rather
5242 than returning to the index menu. If unset, Mutt will return to the
5243 index menu when the external pager exits.
5244 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query-command"></a>3.231. query_command</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5245 Default: ""</p></div><p>
5246 This specifies the command that mutt will use to make external address
5247 queries. The string should contain a %s, which will be substituted
5248 with the query string the user types. See ``<a href="#query" title="5. External Address Queries">query</a>'' for more
5250 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query-format"></a>3.232. query_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5251 Default: "%4c %t %-25.25a %-25.25n %?e?(%e)?"</p></div><p>
5252 This variable describes the format of the `query' menu. The
5253 following printf-style sequences are understood:
5256 </p><div class="variablelist"><dl><dt><span class="term">%a </span></dt><dd><p>destination address
5257 </p></dd><dt><span class="term">%c </span></dt><dd><p>current entry number
5258 </p></dd><dt><span class="term">%e </span></dt><dd><p>extra information *
5259 </p></dd><dt><span class="term">%n </span></dt><dd><p>destination name
5260 </p></dd><dt><span class="term">%t </span></dt><dd><p>``*'' if current entry is tagged, a space otherwise
5261 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with "X"
5262 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with "X"
5263 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character "X" as pad
5264 </p></dd></dl></div><p>
5267 For an explanation of `soft-fill', see the ``<a href="#index-format" title="3.100. index_format">$index_format</a>'' documentation.
5269 * = can be optionally printed if nonzero, see the ``<a href="#status-format" title="3.278. status_format">$status_format</a>'' documentation.
5270 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="quit"></a>3.233. quit</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5271 Default: yes</p></div><p>
5272 This variable controls whether ``quit'' and ``exit'' actually quit
5273 from mutt. If it set to yes, they do quit, if it is set to no, they
5274 have no effect, and if it is set to ask-yes or ask-no, you are
5275 prompted for confirmation when you try to quit.
5276 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="quote-regexp"></a>3.234. quote_regexp</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5277 Default: "^([ \t]*[|>:}#])+"</p></div><p>
5278 A regular expression used in the internal-pager to determine quoted
5279 sections of text in the body of a message.
5281 <span class="bold"><strong>Note:</strong></span> In order to use the <span class="emphasis"><em>quoted</em></span><span class="bold"><strong>x</strong></span> patterns in the
5282 internal pager, you need to set this to a regular expression that
5283 matches <span class="emphasis"><em>exactly</em></span> the quote characters at the beginning of quoted
5285 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="read-inc"></a>3.235. read_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5286 Default: 10</p></div><p>
5287 If set to a value greater than 0, Mutt will display which message it
5288 is currently on when reading a mailbox or when performing search actions
5289 such as search and limit. The message is printed after
5290 <span class="emphasis"><em>read_inc</em></span> messages have been read or searched (e.g., if set to 25, Mutt will
5291 print a message when it is at message 25, and then again when it gets
5292 to message 50). This variable is meant to indicate progress when
5293 reading or searching large mailboxes which may take some time.
5294 When set to 0, only a single message will appear before the reading
5297 Also see the ``<a href="#write-inc" title="3.304. write_inc">$write_inc</a>'' variable and the ``Tuning'' section of the
5298 manual for performance considerations.
5299 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="read-only"></a>3.236. read_only</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5300 Default: no</p></div><p>
5301 If set, all folders are opened in read-only mode.
5302 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="realname"></a>3.237. realname</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5303 Default: ""</p></div><p>
5304 This variable specifies what "real" or "personal" name should be used
5305 when sending messages.
5307 By default, this is the GECOS field from /etc/passwd. Note that this
5308 variable will <span class="emphasis"><em>not</em></span> be used when the user has set a real name
5309 in the <a href="#from" title="3.66. from">$from</a> variable.
5310 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="recall"></a>3.238. recall</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5311 Default: ask-yes</p></div><p>
5312 Controls whether or not Mutt recalls postponed messages
5313 when composing a new message. Also see ``<a href="#postponed" title="3.224. postponed">$postponed</a>''.
5315 Setting this variable to ``yes'' is not generally useful, and thus not
5317 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="record"></a>3.239. record</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5318 Default: "˜/sent"</p></div><p>
5319 This specifies the file into which your outgoing messages should be
5320 appended. (This is meant as the primary method for saving a copy of
5321 your messages, but another way to do this is using the ``<a href="#my-hdr" title="14. User defined headers">my_hdr</a>''
5322 command to create a <span class="emphasis"><em>Bcc:</em></span> field with your email address in it.)
5324 The value of <span class="emphasis"><em><a href="#record" title="3.239. record">$record</a></em></span> is overridden by the ``<a href="#force-name" title="3.61. force_name">$force_name</a>'' and
5325 ``<a href="#save-name" title="3.251. save_name">$save_name</a>'' variables, and the ``<a href="#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a>'' command.
5326 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-regexp"></a>3.240. reply_regexp</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5327 Default: "^(re([\[0-9\]+])*|aw):[ \t]*"</p></div><p>
5328 A regular expression used to recognize reply messages when threading
5329 and replying. The default value corresponds to the English "Re:" and
5331 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-self"></a>3.241. reply_self</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5332 Default: no</p></div><p>
5333 If unset and you are replying to a message sent by you, Mutt will
5334 assume that you want to reply to the recipients of that message rather
5336 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reply-to"></a>3.242. reply_to</h3></div></div></div><div class="literallayout"><p>Type: quadoption<br />
5337 Default: ask-yes</p></div><p>
5338 If set, when replying to a message, Mutt will use the address listed
5339 in the Reply-to: header as the recipient of the reply. If unset,
5340 it will use the address in the From: header field instead. This
5341 option is useful for reading a mailing list that sets the Reply-To:
5342 header field to the list address and you want to send a private
5343 message to the author of a message.
5344 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="resolve"></a>3.243. resolve</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5345 Default: yes</p></div><p>
5346 When set, the cursor will be automatically advanced to the next
5347 (possibly undeleted) message whenever a command that modifies the
5348 current message is executed.
5349 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-alias"></a>3.244. reverse_alias</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5350 Default: no</p></div><p>
5351 This variable controls whether or not Mutt will display the "personal"
5352 name from your aliases in the index menu if it finds an alias that
5353 matches the message's sender. For example, if you have the following
5357 </p><pre class="screen">
5358 alias juser abd30425@somewhere.net (Joe User)
5361 and then you receive mail which contains the following header:
5364 </p><pre class="screen">
5365 From: abd30425@somewhere.net
5368 It would be displayed in the index menu as ``Joe User'' instead of
5369 ``abd30425@somewhere.net.'' This is useful when the person's e-mail
5370 address is not human friendly (like CompuServe addresses).
5371 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-name"></a>3.245. reverse_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5372 Default: no</p></div><p>
5373 It may sometimes arrive that you receive mail to a certain machine,
5374 move the messages to another machine, and reply to some the messages
5375 from there. If this variable is set, the default <span class="emphasis"><em>From:</em></span> line of
5376 the reply messages is built using the address where you received the
5377 messages you are replying to <span class="bold"><strong>if</strong></span> that address matches your
5378 alternates. If the variable is unset, or the address that would be
5379 used doesn't match your alternates, the <span class="emphasis"><em>From:</em></span> line will use
5380 your address on the current machine.
5381 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="reverse-realname"></a>3.246. reverse_realname</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5382 Default: yes</p></div><p>
5383 This variable fine-tunes the behaviour of the <a href="#reverse-name" title="3.245. reverse_name">reverse_name</a> feature.
5384 When it is set, mutt will use the address from incoming messages as-is,
5385 possibly including eventual real names. When it is unset, mutt will
5386 override any such real names with the setting of the <a href="#realname" title="3.237. realname">realname</a> variable.
5387 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="rfc2047-parameters"></a>3.247. rfc2047_parameters</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5388 Default: no</p></div><p>
5389 When this variable is set, Mutt will decode RFC-2047-encoded MIME
5390 parameters. You want to set this variable when mutt suggests you
5391 to save attachments to files named like this:
5392 =?iso-8859-1?Q?file=5F=E4=5F991116=2Ezip?=
5394 When this variable is set interactively, the change doesn't have
5395 the desired effect before you have changed folders.
5397 Note that this use of RFC 2047's encoding is explicitly,
5398 prohibited by the standard, but nevertheless encountered in the
5400 Also note that setting this parameter will <span class="emphasis"><em>not</em></span> have the effect
5401 that mutt <span class="emphasis"><em>generates</em></span> this kind of encoding. Instead, mutt will
5402 unconditionally use the encoding specified in RFC 2231.
5403 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-address"></a>3.248. save_address</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5404 Default: no</p></div><p>
5405 If set, mutt will take the sender's full address when choosing a
5406 default folder for saving a mail. If ``<a href="#save-name" title="3.251. save_name">$save_name</a>'' or ``<a href="#force-name" title="3.61. force_name">$force_name</a>''
5407 is set too, the selection of the fcc folder will be changed as well.
5408 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-empty"></a>3.249. save_empty</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5409 Default: yes</p></div><p>
5410 When unset, mailboxes which contain no saved messages will be removed
5411 when closed (the exception is ``<a href="#spoolfile" title="3.276. spoolfile">$spoolfile</a>'' which is never removed).
5412 If set, mailboxes are never removed.
5414 <span class="bold"><strong>Note:</strong></span> This only applies to mbox and MMDF folders, Mutt does not
5415 delete MH and Maildir directories.
5416 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-history"></a>3.250. save_history</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5417 Default: 0</p></div><p>
5418 This variable controls the size of the history saved in the
5419 ``<a href="#history-file" title="3.78. history_file">$history_file</a>'' file.
5420 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="save-name"></a>3.251. save_name</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5421 Default: no</p></div><p>
5422 This variable controls how copies of outgoing messages are saved.
5423 When set, a check is made to see if a mailbox specified by the
5424 recipient address exists (this is done by searching for a mailbox in
5425 the ``<a href="#folder" title="3.58. folder">$folder</a>'' directory with the <span class="emphasis"><em>username</em></span> part of the
5426 recipient address). If the mailbox exists, the outgoing message will
5427 be saved to that mailbox, otherwise the message is saved to the
5428 ``<a href="#record" title="3.239. record">$record</a>'' mailbox.
5430 Also see the ``<a href="#force-name" title="3.61. force_name">$force_name</a>'' variable.
5431 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score"></a>3.252. score</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5432 Default: yes</p></div><p>
5433 When this variable is <span class="emphasis"><em>unset</em></span>, scoring is turned off. This can
5434 be useful to selectively disable scoring for certain folders when the
5435 ``<a href="#score-threshold-delete" title="3.253. score_threshold_delete">$score_threshold_delete</a>'' variable and friends are used.
5436 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-delete"></a>3.253. score_threshold_delete</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5437 Default: -1</p></div><p>
5438 Messages which have been assigned a score equal to or lower than the value
5439 of this variable are automatically marked for deletion by mutt. Since
5440 mutt scores are always greater than or equal to zero, the default setting
5441 of this variable will never mark a message for deletion.
5442 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-flag"></a>3.254. score_threshold_flag</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5443 Default: 9999</p></div><p>
5444 Messages which have been assigned a score greater than or equal to this
5445 variable's value are automatically marked "flagged".
5446 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="score-threshold-read"></a>3.255. score_threshold_read</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5447 Default: -1</p></div><p>
5448 Messages which have been assigned a score equal to or lower than the value
5449 of this variable are automatically marked as read by mutt. Since
5450 mutt scores are always greater than or equal to zero, the default setting
5451 of this variable will never mark a message read.
5452 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="send-charset"></a>3.256. send_charset</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5453 Default: "us-ascii:iso-8859-1:utf-8"</p></div><p>
5454 A colon-delimited list of character sets for outgoing messages. Mutt will use the
5455 first character set into which the text can be converted exactly.
5456 If your ``<a href="#charset" title="3.25. charset">$charset</a>'' is not iso-8859-1 and recipients may not
5457 understand UTF-8, it is advisable to include in the list an
5458 appropriate widely used standard character set (such as
5459 iso-8859-2, koi8-r or iso-2022-jp) either instead of or after
5462 In case the text cannot be converted into one of these exactly,
5463 mutt uses ``<a href="#charset" title="3.25. charset">$charset</a>'' as a fallback.
5464 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sendmail"></a>3.257. sendmail</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5465 Default: "/usr/sbin/sendmail -oem -oi"</p></div><p>
5466 Specifies the program and arguments used to deliver mail sent by Mutt.
5467 Mutt expects that the specified program interprets additional
5468 arguments as recipient addresses.
5469 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sendmail-wait"></a>3.258. sendmail_wait</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5470 Default: 0</p></div><p>
5471 Specifies the number of seconds to wait for the ``<a href="#sendmail" title="3.257. sendmail">$sendmail</a>'' process
5472 to finish before giving up and putting delivery in the background.
5474 Mutt interprets the value of this variable as follows:
5476 </p><div class="variablelist"><dl><dt><span class="term">>0 </span></dt><dd><p>number of seconds to wait for sendmail to finish before continuing
5477 </p></dd><dt><span class="term">0 </span></dt><dd><p>wait forever for sendmail to finish
5478 </p></dd><dt><span class="term"><0 </span></dt><dd><p>always put sendmail in the background without waiting
5479 </p></dd></dl></div><p>
5482 Note that if you specify a value other than 0, the output of the child
5483 process will be put in a temporary file. If there is some error, you
5484 will be informed as to where to find the output.
5485 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="shell"></a>3.259. shell</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5486 Default: ""</p></div><p>
5487 Command to use when spawning a subshell. By default, the user's login
5488 shell from /etc/passwd is used.
5489 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sig-dashes"></a>3.260. sig_dashes</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5490 Default: yes</p></div><p>
5491 If set, a line containing ``-- '' will be inserted before your
5492 ``<a href="#signature" title="3.262. signature">$signature</a>''. It is <span class="bold"><strong>strongly</strong></span> recommended that you not unset
5493 this variable unless your ``signature'' contains just your name. The
5494 reason for this is because many software packages use ``-- \n'' to
5495 detect your signature. For example, Mutt has the ability to highlight
5496 the signature in a different color in the builtin pager.
5497 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sig-on-top"></a>3.261. sig_on_top</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5498 Default: no</p></div><p>
5499 If set, the signature will be included before any quoted or forwarded
5500 text. It is <span class="bold"><strong>strongly</strong></span> recommended that you do not set this variable
5501 unless you really know what you are doing, and are prepared to take
5502 some heat from netiquette guardians.
5503 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="signature"></a>3.262. signature</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5504 Default: "˜/.signature"</p></div><p>
5505 Specifies the filename of your signature, which is appended to all
5506 outgoing messages. If the filename ends with a pipe (``|''), it is
5507 assumed that filename is a shell command and input should be read from
5509 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="simple-search"></a>3.263. simple_search</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5510 Default: "˜f %s | ˜s %s"</p></div><p>
5511 Specifies how Mutt should expand a simple search into a real search
5512 pattern. A simple search is one that does not contain any of the ˜
5513 operators. See ``<a href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a>'' for more information on search patterns.
5515 For example, if you simply type joe at a search or limit prompt, Mutt
5516 will automatically expand it to the value specified by this variable.
5517 For the default value it would be:
5520 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smart-wrap"></a>3.264. smart_wrap</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5521 Default: yes</p></div><p>
5522 Controls the display of lines longer than the screen width in the
5523 internal pager. If set, long lines are wrapped at a word boundary. If
5524 unset, lines are simply wrapped at the screen edge. Also see the
5525 ``<a href="#markers" title="3.113. markers">$markers</a>'' variable.
5526 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smileys"></a>3.265. smileys</h3></div></div></div><div class="literallayout"><p>Type: regular expression<br />
5527 Default: "(>From )|(:[-^]?[][)(><}{|/DP])"</p></div><p>
5528 The <span class="emphasis"><em>pager</em></span> uses this variable to catch some common false
5529 positives of ``<a href="#quote-regexp" title="3.234. quote_regexp">$quote_regexp</a>'', most notably smileys in the beginning
5531 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sleep-time"></a>3.266. sleep_time</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5532 Default: 1</p></div><p>
5533 Specifies time, in seconds, to pause while displaying certain informational
5534 messages, while moving from folder to folder and after expunging
5535 messages from the current folder. The default is to pause one second, so
5536 a value of zero for this option suppresses the pause.
5537 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-authenticators"></a>3.267. smtp_authenticators</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5538 Default: ""</p></div><p>
5539 This is a colon-delimited list of authentication methods mutt may
5540 attempt to use to log in to an SMTP server, in the order mutt should
5541 try them. Authentication methods are any SASL mechanism, eg
5542 ``digest-md5'', ``gssapi'' or ``cram-md5''.
5543 This parameter is case-insensitive. If this parameter is unset
5544 (the default) mutt will try all available methods, in order from
5545 most-secure to least-secure.
5547 Example: set smtp_authenticators="digest-md5:cram-md5"
5548 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-pass"></a>3.268. smtp_pass</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5549 Default: ""</p></div><p>
5550 Specifies the password for your SMTP account. If <span class="emphasis"><em>unset</em></span>, Mutt will
5551 prompt you for your password when you first send mail via SMTP.
5552 See ``<a href="#smtp-url" title="3.269. smtp_url">smtp_url</a>'' to configure mutt to send mail via SMTP.
5553 <span class="bold"><strong>Warning</strong></span>: you should only use this option when you are on a
5554 fairly secure machine, because the superuser can read your muttrc even
5555 if you are the only one who can read the file.
5556 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smtp-url"></a>3.269. smtp_url</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5557 Default: ""</p></div><p>
5558 Defines the SMTP ``smart'' host where sent messages should relayed for
5559 delivery. This should take the form of an SMTP URL, eg:
5561 smtp[s]://[user[:pass]@]host[:port]/
5563 Setting this variable overrides the value of the ``<a href="#sendmail" title="3.257. sendmail">$sendmail</a>''
5565 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort"></a>3.270. sort</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5566 Default: date</p></div><p>
5567 Specifies how to sort messages in the <span class="emphasis"><em>index</em></span> menu. Valid values
5571 </p><pre class="screen">
5575 mailbox-order (unsorted)
5584 You may optionally use the reverse- prefix to specify reverse sorting
5585 order (example: set sort=reverse-date-sent).
5586 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-alias"></a>3.271. sort_alias</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5587 Default: alias</p></div><p>
5588 Specifies how the entries in the `alias' menu are sorted. The
5589 following are legal values:
5592 </p><pre class="screen">
5593 address (sort alphabetically by email address)
5594 alias (sort alphabetically by alias name)
5595 unsorted (leave in order specified in .muttrc)
5597 </pre></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-aux"></a>3.272. sort_aux</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5598 Default: date</p></div><p>
5599 When sorting by threads, this variable controls how threads are sorted
5600 in relation to other threads, and how the branches of the thread trees
5601 are sorted. This can be set to any value that ``<a href="#sort" title="3.270. sort">$sort</a>'' can, except
5602 threads (in that case, mutt will just use date-sent). You can also
5603 specify the last- prefix in addition to the reverse- prefix, but last-
5604 must come after reverse-. The last- prefix causes messages to be
5605 sorted against its siblings by which has the last descendant, using
5606 the rest of sort_aux as an ordering. For instance, set sort_aux=last-
5607 date-received would mean that if a new message is received in a
5608 thread, that thread becomes the last one displayed (or the first, if
5609 you have set sort=reverse-threads.) Note: For reversed ``<a href="#sort" title="3.270. sort">$sort</a>''
5610 order <a href="#sort-aux" title="3.272. sort_aux">$sort_aux</a> is reversed again (which is not the right thing to do,
5611 but kept to not break any existing configuration setting).
5612 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-browser"></a>3.273. sort_browser</h3></div></div></div><div class="literallayout"><p>Type: sort order<br />
5613 Default: alpha</p></div><p>
5614 Specifies how to sort entries in the file browser. By default, the
5615 entries are sorted alphabetically. Valid values:
5618 </p><pre class="screen">
5619 alpha (alphabetically)
5625 You may optionally use the reverse- prefix to specify reverse sorting
5626 order (example: set sort_browser=reverse-date).
5627 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="sort-re"></a>3.274. sort_re</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5628 Default: yes</p></div><p>
5629 This variable is only useful when sorting by threads with
5630 ``<a href="#strict-threads" title="3.280. strict_threads">$strict_threads</a>'' unset. In that case, it changes the heuristic
5631 mutt uses to thread messages by subject. With sort_re set, mutt will
5632 only attach a message as the child of another message by subject if
5633 the subject of the child message starts with a substring matching the
5634 setting of ``<a href="#reply-regexp" title="3.240. reply_regexp">$reply_regexp</a>''. With sort_re unset, mutt will attach
5635 the message whether or not this is the case, as long as the
5636 non-``<a href="#reply-regexp" title="3.240. reply_regexp">$reply_regexp</a>'' parts of both messages are identical.
5637 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="spam-separator"></a>3.275. spam_separator</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5638 Default: ","</p></div><p>
5639 ``<a href="#spam-separator" title="3.275. spam_separator">spam_separator</a>'' controls what happens when multiple spam headers
5640 are matched: if unset, each successive header will overwrite any
5641 previous matches value for the spam label. If set, each successive
5642 match will append to the previous, using ``<a href="#spam-separator" title="3.275. spam_separator">spam_separator</a>'' as a
5644 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="spoolfile"></a>3.276. spoolfile</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5645 Default: ""</p></div><p>
5646 If your spool mailbox is in a non-default place where Mutt cannot find
5647 it, you can specify its location with this variable. Mutt will
5648 automatically set this variable to the value of the environment
5649 variable $MAIL if it is not set.
5650 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-chars"></a>3.277. status_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5651 Default: "-*%A"</p></div><p>
5652 Controls the characters used by the "%r" indicator in
5653 ``<a href="#status-format" title="3.278. status_format">$status_format</a>''. The first character is used when the mailbox is
5654 unchanged. The second is used when the mailbox has been changed, and
5655 it needs to be resynchronized. The third is used if the mailbox is in
5656 read-only mode, or if the mailbox will not be written when exiting
5657 that mailbox (You can toggle whether to write changes to a mailbox
5658 with the toggle-write operation, bound by default to "%"). The fourth
5659 is used to indicate that the current folder has been opened in attach-
5660 message mode (Certain operations like composing a new mail, replying,
5661 forwarding, etc. are not permitted in this mode).
5662 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-format"></a>3.278. status_format</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5663 Default: "-%r-Mutt: %f [Msgs:%?M?%M/?%m%?n? New:%n?%?o? Old:%o?%?d? Del:%d?%?F? Flag:%F?%?t? Tag:%t?%?p? Post:%p?%?b? Inc:%b?%?l? %l?]---(%s/%S)-%>-(%P)---"</p></div><p>
5664 Controls the format of the status line displayed in the <span class="emphasis"><em>index</em></span>
5665 menu. This string is similar to ``<a href="#index-format" title="3.100. index_format">$index_format</a>'', but has its own
5666 set of printf()-like sequences:
5669 </p><div class="variablelist"><dl><dt><span class="term">%b </span></dt><dd><p>number of mailboxes with new mail *
5670 </p></dd><dt><span class="term">%d </span></dt><dd><p>number of deleted messages *
5671 </p></dd><dt><span class="term">%f </span></dt><dd><p>the full pathname of the current mailbox
5672 </p></dd><dt><span class="term">%F </span></dt><dd><p>number of flagged messages *
5673 </p></dd><dt><span class="term">%h </span></dt><dd><p>local hostname
5674 </p></dd><dt><span class="term">%l </span></dt><dd><p>size (in bytes) of the current mailbox *
5675 </p></dd><dt><span class="term">%L </span></dt><dd><p>size (in bytes) of the messages shown
5676 (i.e., which match the current limit) *
5677 </p></dd><dt><span class="term">%m </span></dt><dd><p>the number of messages in the mailbox *
5678 </p></dd><dt><span class="term">%M </span></dt><dd><p>the number of messages shown (i.e., which match the current limit) *
5679 </p></dd><dt><span class="term">%n </span></dt><dd><p>number of new messages in the mailbox *
5680 </p></dd><dt><span class="term">%o </span></dt><dd><p>number of old unread messages *
5681 </p></dd><dt><span class="term">%p </span></dt><dd><p>number of postponed messages *
5682 </p></dd><dt><span class="term">%P </span></dt><dd><p>percentage of the way through the index
5683 </p></dd><dt><span class="term">%r </span></dt><dd><p>modified/read-only/won't-write/attach-message indicator,
5684 according to <a href="#status-chars" title="3.277. status_chars">$status_chars</a>
5685 </p></dd><dt><span class="term">%s </span></dt><dd><p>current sorting mode (<a href="#sort" title="3.270. sort">$sort</a>)
5686 </p></dd><dt><span class="term">%S </span></dt><dd><p>current aux sorting method (<a href="#sort-aux" title="3.272. sort_aux">$sort_aux</a>)
5687 </p></dd><dt><span class="term">%t </span></dt><dd><p>number of tagged messages *
5688 </p></dd><dt><span class="term">%u </span></dt><dd><p>number of unread messages *
5689 </p></dd><dt><span class="term">%v </span></dt><dd><p>Mutt version string
5690 </p></dd><dt><span class="term">%V </span></dt><dd><p>currently active limit pattern, if any *
5691 </p></dd><dt><span class="term">%>X </span></dt><dd><p>right justify the rest of the string and pad with "X"
5692 </p></dd><dt><span class="term">%|X </span></dt><dd><p>pad to the end of the line with "X"
5693 </p></dd><dt><span class="term">%*X </span></dt><dd><p>soft-fill with character "X" as pad
5694 </p></dd></dl></div><p>
5697 For an explanation of `soft-fill', see the ``<a href="#index-format" title="3.100. index_format">$index_format</a>'' documentation.
5699 * = can be optionally printed if nonzero
5701 Some of the above sequences can be used to optionally print a string
5702 if their value is nonzero. For example, you may only want to see the
5703 number of flagged messages if such messages exist, since zero is not
5704 particularly meaningful. To optionally print a string based upon one
5705 of the above sequences, the following construct is used:
5707 %?<sequence_char>?<optional_string>?
5709 where <span class="emphasis"><em>sequence_char</em></span> is a character from the table above, and
5710 <span class="emphasis"><em>optional_string</em></span> is the string you would like printed if
5711 <span class="emphasis"><em>sequence_char</em></span> is nonzero. <span class="emphasis"><em>optional_string</em></span> <span class="bold"><strong>may</strong></span> contain
5712 other sequences as well as normal text, but you may <span class="bold"><strong>not</strong></span> nest
5715 Here is an example illustrating how to optionally print the number of
5716 new messages in a mailbox:
5717 %?n?%n new messages.?
5719 You can also switch between two strings using the following construct:
5721 %?<sequence_char>?<if_string>&<else_string>?
5723 If the value of <span class="emphasis"><em>sequence_char</em></span> is non-zero, <span class="emphasis"><em>if_string</em></span> will
5724 be expanded, otherwise <span class="emphasis"><em>else_string</em></span> will be expanded.
5726 You can force the result of any printf-like sequence to be lowercase
5727 by prefixing the sequence character with an underscore (_) sign.
5728 For example, if you want to display the local hostname in lowercase,
5732 If you prefix the sequence character with a colon (:) character, mutt
5733 will replace any dots in the expansion by underscores. This might be helpful
5734 with IMAP folders that don't like dots in folder names.
5735 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="status-on-top"></a>3.279. status_on_top</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5736 Default: no</p></div><p>
5737 Setting this variable causes the ``status bar'' to be displayed on
5738 the first line of the screen rather than near the bottom.
5739 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="strict-threads"></a>3.280. strict_threads</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5740 Default: no</p></div><p>
5741 If set, threading will only make use of the ``In-Reply-To'' and
5742 ``References'' fields when you ``<a href="#sort" title="3.270. sort">$sort</a>'' by message threads. By
5743 default, messages with the same subject are grouped together in
5744 ``pseudo threads.''. This may not always be desirable, such as in a
5745 personal mailbox where you might have several unrelated messages with
5746 the subject ``hi'' which will get grouped together. See also
5747 ``<a href="#sort-re" title="3.274. sort_re">$sort_re</a>'' for a less drastic way of controlling this
5749 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="suspend"></a>3.281. suspend</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5750 Default: yes</p></div><p>
5751 When <span class="emphasis"><em>unset</em></span>, mutt won't stop when the user presses the terminal's
5752 <span class="emphasis"><em>susp</em></span> key, usually ``control-Z''. This is useful if you run mutt
5753 inside an xterm using a command like xterm -e mutt.
5754 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="text-flowed"></a>3.282. text_flowed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5755 Default: no</p></div><p>
5756 When set, mutt will generate text/plain; format=flowed attachments.
5757 This format is easier to handle for some mailing software, and generally
5758 just looks like ordinary text. To actually make use of this format's
5759 features, you'll need support in your editor.
5761 Note that <a href="#indent-string" title="3.99. indent_string">$indent_string</a> is ignored when this option is set.
5762 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="thread-received"></a>3.283. thread_received</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5763 Default: no</p></div><p>
5764 When set, mutt uses the date received rather than the date sent
5765 to thread messages by subject.
5766 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="thorough-search"></a>3.284. thorough_search</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5767 Default: no</p></div><p>
5768 Affects the <span class="emphasis"><em>˜b</em></span> and <span class="emphasis"><em>˜h</em></span> search operations described in
5769 section ``<a href="#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a>'' above. If set, the headers and attachments of
5770 messages to be searched are decoded before searching. If unset,
5771 messages are searched as they appear in the folder.
5772 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tilde"></a>3.285. tilde</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5773 Default: no</p></div><p>
5774 When set, the internal-pager will pad blank lines to the bottom of the
5775 screen with a tilde (˜).
5776 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="time-inc"></a>3.286. time_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5777 Default: 0</p></div><p>
5778 Along with ``<a href="#read-inc" title="3.235. read_inc">read_inc</a>'', ``<a href="#write-inc" title="3.304. write_inc">write_inc</a>'', and ``<a href="#net-inc" title="3.136. net_inc">net_inc</a>'', this
5779 variable controls the frequency with which progress updates are
5780 displayed. It suppresses updates less than ``<a href="#time-inc" title="3.286. time_inc">time_inc</a>'' milliseconds
5781 apart. This can improve throughput on systems with slow terminals,
5782 or when running mutt on a remote system.
5783 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="timeout"></a>3.287. timeout</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5784 Default: 600</p></div><p>
5785 When Mutt is waiting for user input either idleing in menus or
5786 in an interactive prompt, Mutt would block until input is
5787 present. Depending on the context, this would prevent certain
5788 operations from working, like checking for new mail or keeping
5789 an IMAP connection alive.
5791 This variable controls how many seconds Mutt will at most wait
5792 until it aborts waiting for input, performs these operations and
5793 continues to wait for input.
5795 A value of zero or less will cause Mutt to never time out.
5796 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tmpdir"></a>3.288. tmpdir</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5797 Default: ""</p></div><p>
5798 This variable allows you to specify where Mutt will place its
5799 temporary files needed for displaying and composing messages. If
5800 this variable is not set, the environment variable TMPDIR is
5801 used. If TMPDIR is not set then "/tmp" is used.
5802 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="to-chars"></a>3.289. to_chars</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5803 Default: " +TCFL"</p></div><p>
5804 Controls the character used to indicate mail addressed to you. The
5805 first character is the one used when the mail is NOT addressed to your
5806 address (default: space). The second is used when you are the only
5807 recipient of the message (default: +). The third is when your address
5808 appears in the TO header field, but you are not the only recipient of
5809 the message (default: T). The fourth character is used when your
5810 address is specified in the CC header field, but you are not the only
5811 recipient. The fifth character is used to indicate mail that was sent
5812 by <span class="emphasis"><em>you</em></span>. The sixth character is used to indicate when a mail
5813 was sent to a mailing-list you subscribe to (default: L).
5814 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="tunnel"></a>3.290. tunnel</h3></div></div></div><div class="literallayout"><p>Type: string<br />
5815 Default: ""</p></div><p>
5816 Setting this variable will cause mutt to open a pipe to a command
5817 instead of a raw socket. You may be able to use this to set up
5818 preauthenticated connections to your IMAP/POP3 server. Example:
5820 tunnel="ssh -q mailhost.net /usr/local/libexec/imapd"
5822 NOTE: For this example to work you must be able to log in to the remote
5823 machine without having to enter a password.
5824 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-8bitmime"></a>3.291. use_8bitmime</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5825 Default: no</p></div><p>
5826 <span class="bold"><strong>Warning:</strong></span> do not set this variable unless you are using a version
5827 of sendmail which supports the -B8BITMIME flag (such as sendmail
5828 8.8.x) or you may not be able to send mail.
5830 When <span class="emphasis"><em>set</em></span>, Mutt will invoke ``<a href="#sendmail" title="3.257. sendmail">$sendmail</a>'' with the -B8BITMIME
5831 flag when sending 8-bit messages to enable ESMTP negotiation.
5832 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-domain"></a>3.292. use_domain</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5833 Default: yes</p></div><p>
5834 When set, Mutt will qualify all local addresses (ones without the
5835 @host portion) with the value of ``<a href="#hostname" title="3.80. hostname">$hostname</a>''. If <span class="emphasis"><em>unset</em></span>, no
5836 addresses will be qualified.
5837 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-envelope-from"></a>3.293. use_envelope_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5838 Default: no</p></div><p>
5839 When <span class="emphasis"><em>set</em></span>, mutt will set the <span class="emphasis"><em>envelope</em></span> sender of the message.
5840 If ``<a href="#envelope-from-address" title="3.53. envelope_from_address">$envelope_from_address</a>'' is set, it will be used as the sender
5841 address. If not, mutt will attempt to derive the sender from the
5844 Note that this information is passed to sendmail command using the
5845 "-f" command line switch. Therefore setting this option is not useful
5846 if the ``<a href="#sendmail" title="3.257. sendmail">$sendmail</a>'' variable already contains "-f" or if the
5847 executable pointed to by <a href="#sendmail" title="3.257. sendmail">$sendmail</a> doesn't support the "-f" switch.
5848 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-from"></a>3.294. use_from</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5849 Default: yes</p></div><p>
5850 When <span class="emphasis"><em>set</em></span>, Mutt will generate the `From:' header field when
5851 sending messages. If <span class="emphasis"><em>unset</em></span>, no `From:' header field will be
5852 generated unless the user explicitly sets one using the ``<a href="#my-hdr" title="14. User defined headers">my_hdr</a>''
5854 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-idn"></a>3.295. use_idn</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5855 Default: yes</p></div><p>
5856 When <span class="emphasis"><em>set</em></span>, Mutt will show you international domain names decoded.
5857 Note: You can use IDNs for addresses even if this is <span class="emphasis"><em>unset</em></span>.
5858 This variable only affects decoding.
5859 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="use-ipv6"></a>3.296. use_ipv6</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5860 Default: yes</p></div><p>
5861 When <span class="emphasis"><em>set</em></span>, Mutt will look for IPv6 addresses of hosts it tries to
5862 contact. If this option is unset, Mutt will restrict itself to IPv4 addresses.
5863 Normally, the default should work.
5864 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="user-agent"></a>3.297. user_agent</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5865 Default: yes</p></div><p>
5866 When <span class="emphasis"><em>set</em></span>, mutt will add a "User-Agent" header to outgoing
5867 messages, indicating which version of mutt was used for composing
5869 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="visual"></a>3.298. visual</h3></div></div></div><div class="literallayout"><p>Type: path<br />
5870 Default: ""</p></div><p>
5871 Specifies the visual editor to invoke when the <span class="emphasis"><em>˜v</em></span> command is
5872 given in the builtin editor.
5873 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wait-key"></a>3.299. wait_key</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5874 Default: yes</p></div><p>
5875 Controls whether Mutt will ask you to press a key after <span class="emphasis"><em>shell-
5876 escape</em></span>, <span class="emphasis"><em>pipe-message</em></span>, <span class="emphasis"><em>pipe-entry</em></span>, <span class="emphasis"><em>print-message</em></span>,
5877 and <span class="emphasis"><em>print-entry</em></span> commands.
5879 It is also used when viewing attachments with ``<a href="#auto-view" title="4. MIME Autoview">auto_view</a>'', provided
5880 that the corresponding mailcap entry has a <span class="emphasis"><em>needsterminal</em></span> flag,
5881 and the external program is interactive.
5883 When set, Mutt will always ask for a key. When unset, Mutt will wait
5884 for a key only if the external command returned a non-zero status.
5885 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="weed"></a>3.300. weed</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5886 Default: yes</p></div><p>
5887 When set, mutt will weed headers when displaying, forwarding,
5888 printing, or replying to messages.
5889 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrap"></a>3.301. wrap</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5890 Default: 0</p></div><p>
5891 When set to a positive value, mutt will wrap text at <a href="#wrap" title="3.301. wrap">$wrap</a> characters.
5892 When set to a negative value, mutt will wrap text so that there are <a href="#wrap" title="3.301. wrap">$wrap</a>
5893 characters of empty space on the right side of the terminal.
5894 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrap-search"></a>3.302. wrap_search</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5895 Default: yes</p></div><p>
5896 Controls whether searches wrap around the end of the mailbox.
5898 When set, searches will wrap around the first (or last) message. When
5899 unset, searches will not wrap.
5900 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="wrapmargin"></a>3.303. wrapmargin</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5901 Default: 0</p></div><p>
5902 (DEPRECATED) Equivalent to setting <a href="#wrap" title="3.301. wrap">wrap</a> with a negative value.
5903 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="write-inc"></a>3.304. write_inc</h3></div></div></div><div class="literallayout"><p>Type: number<br />
5904 Default: 10</p></div><p>
5905 When writing a mailbox, a message will be printed every
5906 <span class="emphasis"><em>write_inc</em></span> messages to indicate progress. If set to 0, only a
5907 single message will be displayed before writing a mailbox.
5909 Also see the ``<a href="#read-inc" title="3.235. read_inc">$read_inc</a>'' variable.
5910 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="write-bcc"></a>3.305. write_bcc</h3></div></div></div><div class="literallayout"><p>Type: boolean<br />
5911 Default: yes</p></div><p>
5912 Controls whether mutt writes out the Bcc header when preparing
5913 messages to be sent. Exim users may wish to unset this. If mutt
5914 is set to deliver directly via SMTP (see ``<a href="#smtp-url" title="3.269. smtp_url">$smtp_url</a>''), this
5915 option does nothing: mutt will never write out the BCC header
5917 </p></div></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="functions"></a>4. Functions</h2></div></div></div><p>
5918 The following is the list of available functions listed by the mapping
5919 in which they are available. The default key setting is given, and an
5920 explanation of what the function does. The key bindings of these
5921 functions can be changed with the <a href="#bind" title="4. Changing the default key bindings">bind</a>
5923 </p><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="generic_map"></a>4.1. generic</h3></div></div></div><p>
5924 The <span class="emphasis"><em>generic</em></span> menu is not a real menu, but specifies common functions
5925 (such as movement) available in all menus except for <span class="emphasis"><em>pager</em></span> and
5926 <span class="emphasis"><em>editor</em></span>. Changing settings for this menu will affect the default
5927 bindings for all menus (except as noted).
5930 </p><div class="table"><a id="generic_table"></a><p class="title"><b>Table 8.2. Default generic function bindings</b></p><div class="table-contents"><table summary="Default generic function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>top-page</td><td>H</td><td>move to the top of the page</td></tr><tr><td>next-entry</td><td>j</td><td>move to the next entry</td></tr><tr><td>previous-entry</td><td>k</td><td>move to the previous entry</td></tr><tr><td>bottom-page</td><td>L</td><td>move to the bottom of the page</td></tr><tr><td>refresh</td><td>^L</td><td>clear and redraw the screen</td></tr><tr><td>middle-page</td><td>M</td><td>move to the middle of the page</td></tr><tr><td>search-next</td><td>n</td><td>search for next match</td></tr><tr><td>exit</td><td>q</td><td>exit this menu</td></tr><tr><td>tag-entry</td><td>t</td><td>tag the current entry</td></tr><tr><td>next-page</td><td>z</td><td>move to the next page</td></tr><tr><td>previous-page</td><td>Z</td><td>move to the previous page</td></tr><tr><td>last-entry</td><td>*</td><td>move to the last entry</td></tr><tr><td>first-entry</td><td>=</td><td>move to the first entry</td></tr><tr><td>enter-command</td><td>:</td><td>enter a muttrc command</td></tr><tr><td>next-line</td><td>></td><td>scroll down one line</td></tr><tr><td>previous-line</td><td><</td><td>scroll up one line</td></tr><tr><td>half-up</td><td>[</td><td>scroll up 1/2 page</td></tr><tr><td>half-down</td><td>]</td><td>scroll down 1/2 page</td></tr><tr><td>help</td><td>?</td><td>this screen</td></tr><tr><td>tag-prefix</td><td>;</td><td>apply next function to tagged messages</td></tr><tr><td>tag-prefix-cond</td><td>not bound</td><td>apply next function ONLY to tagged messages</td></tr><tr><td>end-cond</td><td>not bound</td><td>end of conditional execution (noop)</td></tr><tr><td>shell-escape</td><td>!</td><td>invoke a command in a subshell</td></tr><tr><td>select-entry</td><td>RET</td><td>select the current entry</td></tr><tr><td>search</td><td>/</td><td>search for a regular expression</td></tr><tr><td>search-reverse</td><td>ESC /</td><td>search backwards for a regular expression</td></tr><tr><td>search-opposite</td><td>not bound</td><td>search for next match in opposite direction</td></tr><tr><td>jump</td><td>not bound</td><td>jump to an index number</td></tr><tr><td>current-top</td><td>not bound</td><td>move entry to top of screen</td></tr><tr><td>current-middle</td><td>not bound</td><td>move entry to middle of screen</td></tr><tr><td>current-bottom</td><td>not bound</td><td>move entry to bottom of screen</td></tr><tr><td>what-key</td><td>not bound</td><td>display the keycode for a key press</td></tr></tbody></table></div></div><p><br class="table-break" />
5932 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="index_map"></a>4.2. index</h3></div></div></div><p>
5934 </p><div class="table"><a id="index_table"></a><p class="title"><b>Table 8.3. Default index function bindings</b></p><div class="table-contents"><table summary="Default index function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>create-alias</td><td>a</td><td>create an alias from a message sender</td></tr><tr><td>bounce-message</td><td>b</td><td>remail a message to another user</td></tr><tr><td>break-thread</td><td>#</td><td>break the thread in two</td></tr><tr><td>change-folder</td><td>c</td><td>open a different folder</td></tr><tr><td>change-folder-readonly</td><td>ESC c</td><td>open a different folder in read only mode</td></tr><tr><td>next-unread-mailbox</td><td>not bound</td><td>open next mailbox with new mail</td></tr><tr><td>collapse-thread</td><td>ESC v</td><td>collapse/uncollapse current thread</td></tr><tr><td>collapse-all</td><td>ESC V</td><td>collapse/uncollapse all threads</td></tr><tr><td>copy-message</td><td>C</td><td>copy a message to a file/mailbox</td></tr><tr><td>decode-copy</td><td>ESC C</td><td>make decoded (text/plain) copy</td></tr><tr><td>decode-save</td><td>ESC s</td><td>make decoded copy (text/plain) and delete</td></tr><tr><td>delete-message</td><td>d</td><td>delete the current entry</td></tr><tr><td>delete-pattern</td><td>D</td><td>delete messages matching a pattern</td></tr><tr><td>delete-thread</td><td>^D</td><td>delete all messages in thread</td></tr><tr><td>delete-subthread</td><td>ESC d</td><td>delete all messages in subthread</td></tr><tr><td>edit</td><td>e</td><td>edit the raw message</td></tr><tr><td>edit-type</td><td>^E</td><td>edit attachment content type</td></tr><tr><td>forward-message</td><td>f</td><td>forward a message with comments</td></tr><tr><td>flag-message</td><td>F</td><td>toggle a message's 'important' flag</td></tr><tr><td>group-reply</td><td>g</td><td>reply to all recipients</td></tr><tr><td>fetch-mail</td><td>G</td><td>retrieve mail from POP server</td></tr><tr><td>imap-fetch-mail</td><td>not bound</td><td>force retrieval of mail from IMAP server</td></tr><tr><td>display-toggle-weed</td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td>next-undeleted</td><td>j</td><td>move to the next undeleted message</td></tr><tr><td>previous-undeleted</td><td>k</td><td>move to the previous undeleted message</td></tr><tr><td>limit</td><td>l</td><td>show only messages matching a pattern</td></tr><tr><td>link-threads</td><td>&</td><td>link tagged message to the current one</td></tr><tr><td>list-reply</td><td>L</td><td>reply to specified mailing list</td></tr><tr><td>mail</td><td>m</td><td>compose a new mail message</td></tr><tr><td>toggle-new</td><td>N</td><td>toggle a message's 'new' flag</td></tr><tr><td>toggle-write</td><td>%</td><td>toggle whether the mailbox will be rewritten</td></tr><tr><td>next-thread</td><td>^N</td><td>jump to the next thread</td></tr><tr><td>next-subthread</td><td>ESC n</td><td>jump to the next subthread</td></tr><tr><td>query</td><td>Q</td><td>query external program for addresses</td></tr><tr><td>quit</td><td>q</td><td>save changes to mailbox and quit</td></tr><tr><td>reply</td><td>r</td><td>reply to a message</td></tr><tr><td>show-limit</td><td>ESC l</td><td>show currently active limit pattern</td></tr><tr><td>sort-mailbox</td><td>o</td><td>sort messages</td></tr><tr><td>sort-reverse</td><td>O</td><td>sort messages in reverse order</td></tr><tr><td>print-message</td><td>p</td><td>print the current entry</td></tr><tr><td>previous-thread</td><td>^P</td><td>jump to previous thread</td></tr><tr><td>previous-subthread</td><td>ESC p</td><td>jump to previous subthread</td></tr><tr><td>recall-message</td><td>R</td><td>recall a postponed message</td></tr><tr><td>read-thread</td><td>^R</td><td>mark the current thread as read</td></tr><tr><td>read-subthread</td><td>ESC r</td><td>mark the current subthread as read</td></tr><tr><td>resend-message</td><td>ESC e</td><td>use the current message as a template for a new one</td></tr><tr><td>save-message</td><td>s</td><td>save message/attachment to a file</td></tr><tr><td>tag-pattern</td><td>T</td><td>tag messages matching a pattern</td></tr><tr><td>tag-subthread</td><td>not bound</td><td>tag the current subthread</td></tr><tr><td>tag-thread</td><td>ESC t</td><td>tag the current thread</td></tr><tr><td>untag-pattern</td><td>^T</td><td>untag messages matching a pattern</td></tr><tr><td>undelete-message</td><td>u</td><td>undelete the current entry</td></tr><tr><td>undelete-pattern</td><td>U</td><td>undelete messages matching a pattern</td></tr><tr><td>undelete-subthread</td><td>ESC u</td><td>undelete all messages in subthread</td></tr><tr><td>undelete-thread</td><td>^U</td><td>undelete all messages in thread</td></tr><tr><td>view-attachments</td><td>v</td><td>show MIME attachments</td></tr><tr><td>show-version</td><td>V</td><td>show the Mutt version number and date</td></tr><tr><td>set-flag</td><td>w</td><td>set a status flag on a message</td></tr><tr><td>clear-flag</td><td>W</td><td>clear a status flag from a message</td></tr><tr><td>display-message</td><td>RET</td><td>display a message</td></tr><tr><td>buffy-list</td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td>sync-mailbox</td><td>$</td><td>save changes to mailbox</td></tr><tr><td>display-address</td><td>@</td><td>display full address of sender</td></tr><tr><td>pipe-message</td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td>next-new</td><td>not bound</td><td>jump to the next new message</td></tr><tr><td>next-new-then-unread</td><td>TAB</td><td>jump to the next new or unread message</td></tr><tr><td>previous-new</td><td>not bound</td><td>jump to the previous new message</td></tr><tr><td>previous-new-then-unread</td><td>ESC TAB</td><td>jump to the previous new or unread message</td></tr><tr><td>next-unread</td><td>not bound</td><td>jump to the next unread message</td></tr><tr><td>previous-unread</td><td>not bound</td><td>jump to the previous unread message</td></tr><tr><td>parent-message</td><td>P</td><td>jump to parent message in thread</td></tr><tr><td>extract-keys</td><td>^K</td><td>extract supported public keys</td></tr><tr><td>forget-passphrase</td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td>check-traditional-pgp</td><td>ESC P</td><td>check for classic PGP</td></tr><tr><td>mail-key</td><td>ESC k</td><td>mail a PGP public key</td></tr><tr><td>decrypt-copy</td><td>not bound</td><td>make decrypted copy</td></tr><tr><td>decrypt-save</td><td>not bound</td><td>make decrypted copy and delete</td></tr></tbody></table></div></div><p><br class="table-break" />
5936 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pager_map"></a>4.3. pager</h3></div></div></div><p>
5938 </p><div class="table"><a id="pager_table"></a><p class="title"><b>Table 8.4. Default pager function bindings</b></p><div class="table-contents"><table summary="Default pager function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>break-thread</td><td>#</td><td>break the thread in two</td></tr><tr><td>create-alias</td><td>a</td><td>create an alias from a message sender</td></tr><tr><td>bounce-message</td><td>b</td><td>remail a message to another user</td></tr><tr><td>change-folder</td><td>c</td><td>open a different folder</td></tr><tr><td>change-folder-readonly</td><td>ESC c</td><td>open a different folder in read only mode</td></tr><tr><td>next-unread-mailbox</td><td>not bound</td><td>open next mailbox with new mail</td></tr><tr><td>copy-message</td><td>C</td><td>copy a message to a file/mailbox</td></tr><tr><td>decode-copy</td><td>ESC C</td><td>make decoded (text/plain) copy</td></tr><tr><td>delete-message</td><td>d</td><td>delete the current entry</td></tr><tr><td>delete-thread</td><td>^D</td><td>delete all messages in thread</td></tr><tr><td>delete-subthread</td><td>ESC d</td><td>delete all messages in subthread</td></tr><tr><td>edit</td><td>e</td><td>edit the raw message</td></tr><tr><td>edit-type</td><td>^E</td><td>edit attachment content type</td></tr><tr><td>forward-message</td><td>f</td><td>forward a message with comments</td></tr><tr><td>flag-message</td><td>F</td><td>toggle a message's 'important' flag</td></tr><tr><td>group-reply</td><td>g</td><td>reply to all recipients</td></tr><tr><td>imap-fetch-mail</td><td>not bound</td><td>force retrieval of mail from IMAP server</td></tr><tr><td>display-toggle-weed</td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td>next-undeleted</td><td>j</td><td>move to the next undeleted message</td></tr><tr><td>next-entry</td><td>J</td><td>move to the next entry</td></tr><tr><td>previous-undeleted</td><td>k</td><td>move to the previous undeleted message</td></tr><tr><td>previous-entry</td><td>K</td><td>move to the previous entry</td></tr><tr><td>link-threads</td><td>&</td><td>link tagged message to the current one</td></tr><tr><td>list-reply</td><td>L</td><td>reply to specified mailing list</td></tr><tr><td>redraw-screen</td><td>^L</td><td>clear and redraw the screen</td></tr><tr><td>mail</td><td>m</td><td>compose a new mail message</td></tr><tr><td>mark-as-new</td><td>N</td><td>toggle a message's 'new' flag</td></tr><tr><td>search-next</td><td>n</td><td>search for next match</td></tr><tr><td>next-thread</td><td>^N</td><td>jump to the next thread</td></tr><tr><td>next-subthread</td><td>ESC n</td><td>jump to the next subthread</td></tr><tr><td>print-message</td><td>p</td><td>print the current entry</td></tr><tr><td>previous-thread</td><td>^P</td><td>jump to previous thread</td></tr><tr><td>previous-subthread</td><td>ESC p</td><td>jump to previous subthread</td></tr><tr><td>quit</td><td>Q</td><td>save changes to mailbox and quit</td></tr><tr><td>exit</td><td>q</td><td>exit this menu</td></tr><tr><td>reply</td><td>r</td><td>reply to a message</td></tr><tr><td>recall-message</td><td>R</td><td>recall a postponed message</td></tr><tr><td>read-thread</td><td>^R</td><td>mark the current thread as read</td></tr><tr><td>read-subthread</td><td>ESC r</td><td>mark the current subthread as read</td></tr><tr><td>resend-message</td><td>ESC e</td><td>use the current message as a template for a new one</td></tr><tr><td>save-message</td><td>s</td><td>save message/attachment to a file</td></tr><tr><td>skip-quoted</td><td>S</td><td>skip beyond quoted text</td></tr><tr><td>decode-save</td><td>ESC s</td><td>make decoded copy (text/plain) and delete</td></tr><tr><td>tag-message</td><td>t</td><td>tag the current entry</td></tr><tr><td>toggle-quoted</td><td>T</td><td>toggle display of quoted text</td></tr><tr><td>undelete-message</td><td>u</td><td>undelete the current entry</td></tr><tr><td>undelete-subthread</td><td>ESC u</td><td>undelete all messages in subthread</td></tr><tr><td>undelete-thread</td><td>^U</td><td>undelete all messages in thread</td></tr><tr><td>view-attachments</td><td>v</td><td>show MIME attachments</td></tr><tr><td>show-version</td><td>V</td><td>show the Mutt version number and date</td></tr><tr><td>search-toggle</td><td>\\</td><td>toggle search pattern coloring</td></tr><tr><td>display-address</td><td>@</td><td>display full address of sender</td></tr><tr><td>next-new</td><td>not bound</td><td>jump to the next new message</td></tr><tr><td>pipe-message</td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td>help</td><td>?</td><td>this screen</td></tr><tr><td>next-page</td><td>Space</td><td>move to the next page</td></tr><tr><td>previous-page</td><td>-</td><td>move to the previous page</td></tr><tr><td>top</td><td>^</td><td>jump to the top of the message</td></tr><tr><td>sync-mailbox</td><td>$</td><td>save changes to mailbox</td></tr><tr><td>shell-escape</td><td>!</td><td>invoke a command in a subshell</td></tr><tr><td>enter-command</td><td>:</td><td>enter a muttrc command</td></tr><tr><td>buffy-list</td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td>search</td><td>/</td><td>search for a regular expression</td></tr><tr><td>search-reverse</td><td>ESC /</td><td>search backwards for a regular expression</td></tr><tr><td>search-opposite</td><td>not bound</td><td>search for next match in opposite direction</td></tr><tr><td>next-line</td><td>RET</td><td>scroll down one line</td></tr><tr><td>jump</td><td>not bound</td><td>jump to an index number</td></tr><tr><td>next-unread</td><td>not bound</td><td>jump to the next unread message</td></tr><tr><td>previous-new</td><td>not bound</td><td>jump to the previous new message</td></tr><tr><td>previous-unread</td><td>not bound</td><td>jump to the previous unread message</td></tr><tr><td>half-up</td><td>not bound</td><td>scroll up 1/2 page</td></tr><tr><td>half-down</td><td>not bound</td><td>scroll down 1/2 page</td></tr><tr><td>previous-line</td><td>not bound</td><td>scroll up one line</td></tr><tr><td>bottom</td><td>not bound</td><td>jump to the bottom of the message</td></tr><tr><td>parent-message</td><td>P</td><td>jump to parent message in thread</td></tr><tr><td>check-traditional-pgp</td><td>ESC P</td><td>check for classic PGP</td></tr><tr><td>mail-key</td><td>ESC k</td><td>mail a PGP public key</td></tr><tr><td>extract-keys</td><td>^K</td><td>extract supported public keys</td></tr><tr><td>forget-passphrase</td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td>decrypt-copy</td><td>not bound</td><td>make decrypted copy</td></tr><tr><td>decrypt-save</td><td>not bound</td><td>make decrypted copy and delete</td></tr></tbody></table></div></div><p><br class="table-break" />
5940 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="alias_map"></a>4.4. alias</h3></div></div></div><p>
5942 </p><div class="table"><a id="alias_table"></a><p class="title"><b>Table 8.5. Default alias function bindings</b></p><div class="table-contents"><table summary="Default alias function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>delete-entry</td><td>d</td><td>delete the current entry</td></tr><tr><td>undelete-entry</td><td>u</td><td>undelete the current entry</td></tr></tbody></table></div></div><p><br class="table-break" />
5944 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="query_map"></a>4.5. query</h3></div></div></div><p>
5946 </p><div class="table"><a id="query_table"></a><p class="title"><b>Table 8.6. Default query function bindings</b></p><div class="table-contents"><table summary="Default query function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>create-alias</td><td>a</td><td>create an alias from a message sender</td></tr><tr><td>mail</td><td>m</td><td>compose a new mail message</td></tr><tr><td>query</td><td>Q</td><td>query external program for addresses</td></tr><tr><td>query-append</td><td>A</td><td>append new query results to current results</td></tr></tbody></table></div></div><p><br class="table-break" />
5948 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="attach_map"></a>4.6. attach</h3></div></div></div><p>
5950 </p><div class="table"><a id="attach_table"></a><p class="title"><b>Table 8.7. Default attach function bindings</b></p><div class="table-contents"><table summary="Default attach function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>bounce-message</td><td>b</td><td>remail a message to another user</td></tr><tr><td>display-toggle-weed</td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td>edit-type</td><td>^E</td><td>edit attachment content type</td></tr><tr><td>print-entry</td><td>p</td><td>print the current entry</td></tr><tr><td>save-entry</td><td>s</td><td>save message/attachment to a file</td></tr><tr><td>pipe-entry</td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td>view-mailcap</td><td>m</td><td>force viewing of attachment using mailcap</td></tr><tr><td>reply</td><td>r</td><td>reply to a message</td></tr><tr><td>resend-message</td><td>ESC e</td><td>use the current message as a template for a new one</td></tr><tr><td>group-reply</td><td>g</td><td>reply to all recipients</td></tr><tr><td>list-reply</td><td>L</td><td>reply to specified mailing list</td></tr><tr><td>forward-message</td><td>f</td><td>forward a message with comments</td></tr><tr><td>view-text</td><td>T</td><td>view attachment as text</td></tr><tr><td>view-attach</td><td>RET</td><td>view attachment using mailcap entry if necessary</td></tr><tr><td>delete-entry</td><td>d</td><td>delete the current entry</td></tr><tr><td>undelete-entry</td><td>u</td><td>undelete the current entry</td></tr><tr><td>collapse-parts</td><td>v</td><td>Toggle display of subparts</td></tr><tr><td>check-traditional-pgp</td><td>ESC P</td><td>check for classic PGP</td></tr><tr><td>extract-keys</td><td>^K</td><td>extract supported public keys</td></tr><tr><td>forget-passphrase</td><td>^F</td><td>wipe passphrase(s) from memory</td></tr></tbody></table></div></div><p><br class="table-break" />
5952 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="compose_map"></a>4.7. compose</h3></div></div></div><p>
5954 </p><div class="table"><a id="compose_table"></a><p class="title"><b>Table 8.8. Default compose function bindings</b></p><div class="table-contents"><table summary="Default compose function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>attach-file</td><td>a</td><td>attach file(s) to this message</td></tr><tr><td>attach-message</td><td>A</td><td>attach message(s) to this message</td></tr><tr><td>edit-bcc</td><td>b</td><td>edit the BCC list</td></tr><tr><td>edit-cc</td><td>c</td><td>edit the CC list</td></tr><tr><td>copy-file</td><td>C</td><td>save message/attachment to a file</td></tr><tr><td>detach-file</td><td>D</td><td>delete the current entry</td></tr><tr><td>toggle-disposition</td><td>^D</td><td>toggle disposition between inline/attachment</td></tr><tr><td>edit-description</td><td>d</td><td>edit attachment description</td></tr><tr><td>edit-message</td><td>e</td><td>edit the message</td></tr><tr><td>edit-headers</td><td>E</td><td>edit the message with headers</td></tr><tr><td>edit-file</td><td>^X e</td><td>edit the file to be attached</td></tr><tr><td>edit-encoding</td><td>^E</td><td>edit attachment transfer-encoding</td></tr><tr><td>edit-from</td><td>ESC f</td><td>edit the from field</td></tr><tr><td>edit-fcc</td><td>f</td><td>enter a file to save a copy of this message in</td></tr><tr><td>filter-entry</td><td>F</td><td>filter attachment through a shell command</td></tr><tr><td>get-attachment</td><td>G</td><td>get a temporary copy of an attachment</td></tr><tr><td>display-toggle-weed</td><td>h</td><td>display message and toggle header weeding</td></tr><tr><td>ispell</td><td>i</td><td>run ispell on the message</td></tr><tr><td>print-entry</td><td>l</td><td>print the current entry</td></tr><tr><td>edit-mime</td><td>m</td><td>edit attachment using mailcap entry</td></tr><tr><td>new-mime</td><td>n</td><td>compose new attachment using mailcap entry</td></tr><tr><td>postpone-message</td><td>P</td><td>save this message to send later</td></tr><tr><td>edit-reply-to</td><td>r</td><td>edit the Reply-To field</td></tr><tr><td>rename-file</td><td>R</td><td>rename/move an attached file</td></tr><tr><td>edit-subject</td><td>s</td><td>edit the subject of this message</td></tr><tr><td>edit-to</td><td>t</td><td>edit the TO list</td></tr><tr><td>edit-type</td><td>^T</td><td>edit attachment content type</td></tr><tr><td>write-fcc</td><td>w</td><td>write the message to a folder</td></tr><tr><td>toggle-unlink</td><td>u</td><td>toggle whether to delete file after sending it</td></tr><tr><td>toggle-recode</td><td>not bound</td><td>toggle recoding of this attachment</td></tr><tr><td>update-encoding</td><td>U</td><td>update an attachment's encoding info</td></tr><tr><td>view-attach</td><td>RET</td><td>view attachment using mailcap entry if necessary</td></tr><tr><td>send-message</td><td>y</td><td>send the message</td></tr><tr><td>pipe-entry</td><td>|</td><td>pipe message/attachment to a shell command</td></tr><tr><td>attach-key</td><td>ESC k</td><td>attach a PGP public key</td></tr><tr><td>pgp-menu</td><td>p</td><td>show PGP options</td></tr><tr><td>forget-passphrase</td><td>^F</td><td>wipe passphrase(s) from memory</td></tr><tr><td>smime-menu</td><td>S</td><td>show S/MIME options</td></tr><tr><td>mix</td><td>M</td><td>send the message through a mixmaster remailer chain</td></tr></tbody></table></div></div><p><br class="table-break" />
5956 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="postpone_map"></a>4.8. postpone</h3></div></div></div><p>
5958 </p><div class="table"><a id="postpone_table"></a><p class="title"><b>Table 8.9. Default postpone function bindings</b></p><div class="table-contents"><table summary="Default postpone function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>delete-entry</td><td>d</td><td>delete the current entry</td></tr><tr><td>undelete-entry</td><td>u</td><td>undelete the current entry</td></tr></tbody></table></div></div><p><br class="table-break" />
5960 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="browser_map"></a>4.9. browser</h3></div></div></div><p>
5962 </p><div class="table"><a id="browser_table"></a><p class="title"><b>Table 8.10. Default browser function bindings</b></p><div class="table-contents"><table summary="Default browser function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>change-dir</td><td>c</td><td>change directories</td></tr><tr><td>display-filename</td><td>@</td><td>display the currently selected file's name</td></tr><tr><td>enter-mask</td><td>m</td><td>enter a file mask</td></tr><tr><td>sort</td><td>o</td><td>sort messages</td></tr><tr><td>sort-reverse</td><td>O</td><td>sort messages in reverse order</td></tr><tr><td>select-new</td><td>N</td><td>select a new file in this directory</td></tr><tr><td>check-new</td><td>not bound</td><td>check mailboxes for new mail</td></tr><tr><td>toggle-mailboxes</td><td>TAB</td><td>toggle whether to browse mailboxes or all files</td></tr><tr><td>view-file</td><td>Space</td><td>view file</td></tr><tr><td>buffy-list</td><td>.</td><td>list mailboxes with new mail</td></tr><tr><td>create-mailbox</td><td>C</td><td>create a new mailbox (IMAP only)</td></tr><tr><td>delete-mailbox</td><td>d</td><td>delete the current mailbox (IMAP only)</td></tr><tr><td>rename-mailbox</td><td>r</td><td>rename the current mailbox (IMAP only)</td></tr><tr><td>subscribe</td><td>s</td><td>subscribe to current mailbox (IMAP only)</td></tr><tr><td>unsubscribe</td><td>u</td><td>unsubscribe from current mailbox (IMAP only)</td></tr><tr><td>toggle-subscribed</td><td>T</td><td>toggle view all/subscribed mailboxes (IMAP only)</td></tr></tbody></table></div></div><p><br class="table-break" />
5964 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="pgp_map"></a>4.10. pgp</h3></div></div></div><p>
5966 </p><div class="table"><a id="pgp_table"></a><p class="title"><b>Table 8.11. Default pgp function bindings</b></p><div class="table-contents"><table summary="Default pgp function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>verify-key</td><td>c</td><td>verify a PGP public key</td></tr><tr><td>view-name</td><td>%</td><td>view the key's user id</td></tr></tbody></table></div></div><p><br class="table-break" />
5968 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="smime_map"></a>4.11. smime</h3></div></div></div><p>
5970 </p><div class="table"><a id="smime_table"></a><p class="title"><b>Table 8.12. Default smime function bindings</b></p><div class="table-contents"><table summary="Default smime function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>verify-key</td><td>c</td><td>verify a PGP public key</td></tr><tr><td>view-name</td><td>%</td><td>view the key's user id</td></tr></tbody></table></div></div><p><br class="table-break" />
5972 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="mix_map"></a>4.12. mix</h3></div></div></div><p>
5974 </p><div class="table"><a id="mix_table"></a><p class="title"><b>Table 8.13. Default mix function bindings</b></p><div class="table-contents"><table summary="Default mix function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>accept</td><td>RET</td><td>Accept the chain constructed</td></tr><tr><td>append</td><td>a</td><td>Append a remailer to the chain</td></tr><tr><td>insert</td><td>i</td><td>Insert a remailer into the chain</td></tr><tr><td>delete</td><td>d</td><td>Delete a remailer from the chain</td></tr><tr><td>chain-prev</td><td>left</td><td>Select the previous element of the chain</td></tr><tr><td>chain-next</td><td>right</td><td>Select the next element of the chain</td></tr></tbody></table></div></div><p><br class="table-break" />
5976 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="editor_map"></a>4.13. editor</h3></div></div></div><p>
5978 </p><div class="table"><a id="editor_table"></a><p class="title"><b>Table 8.14. Default editor function bindings</b></p><div class="table-contents"><table summary="Default editor function bindings" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Function</th><th>Default key</th><th>Description</th></tr></thead><tbody><tr><td>bol</td><td>^A</td><td>jump to the beginning of the line</td></tr><tr><td>backward-char</td><td>^B</td><td>move the cursor one character to the left</td></tr><tr><td>backward-word</td><td>ESC b</td><td>move the cursor to the beginning of the word</td></tr><tr><td>capitalize-word</td><td>ESC c</td><td>capitalize the word</td></tr><tr><td>downcase-word</td><td>ESC l</td><td>convert the word to lower case</td></tr><tr><td>upcase-word</td><td>ESC u</td><td>convert the word to upper case</td></tr><tr><td>delete-char</td><td>^D</td><td>delete the char under the cursor</td></tr><tr><td>eol</td><td>^E</td><td>jump to the end of the line</td></tr><tr><td>forward-char</td><td>^F</td><td>move the cursor one character to the right</td></tr><tr><td>forward-word</td><td>ESC f</td><td>move the cursor to the end of the word</td></tr><tr><td>backspace</td><td>Backspace</td><td>delete the char in front of the cursor</td></tr><tr><td>kill-eol</td><td>^K</td><td>delete chars from cursor to end of line</td></tr><tr><td>kill-eow</td><td>ESC d</td><td>delete chars from the cursor to the end of the word</td></tr><tr><td>kill-line</td><td>^U</td><td>delete all chars on the line</td></tr><tr><td>quote-char</td><td>^V</td><td>quote the next typed key</td></tr><tr><td>kill-word</td><td>^W</td><td>delete the word in front of the cursor</td></tr><tr><td>complete</td><td>TAB</td><td>complete filename or alias</td></tr><tr><td>complete-query</td><td>^T</td><td>complete address with query</td></tr><tr><td>buffy-cycle</td><td>Space</td><td>cycle among incoming mailboxes</td></tr><tr><td>history-up</td><td>not bound</td><td>scroll up through the history list</td></tr><tr><td>history-down</td><td>not bound</td><td>scroll down through the history list</td></tr><tr><td>transpose-chars</td><td>not bound</td><td>transpose character under cursor with previous</td></tr></tbody></table></div></div><p><br class="table-break" />
5980 </p></div></div></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="miscellany"></a>Chapter 9. Miscellany</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#acknowledgements">1. Acknowledgements</a></span></dt><dt><span class="sect1"><a href="#about">2. About this document</a></span></dt></dl></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="acknowledgements"></a>1. Acknowledgements</h2></div></div></div><p>
5981 Kari Hurtta <code class="email"><<a href="mailto:kari.hurtta@fmi.fi">kari.hurtta@fmi.fi</a>></code>
5982 co-developed the original MIME parsing code back in the ELM-ME days.
5984 The following people have been very helpful to the development of Mutt:
5986 </p><table class="simplelist" border="0" summary="Simple list"><tr><td>Vikas Agnihotri <code class="email"><<a href="mailto:vikasa@writeme.com">vikasa@writeme.com</a>></code>,</td></tr><tr><td>Francois Berjon <code class="email"><<a href="mailto:Francois.Berjon@aar.alcatel-alsthom.fr">Francois.Berjon@aar.alcatel-alsthom.fr</a>></code>,</td></tr><tr><td>Aric Blumer <code class="email"><<a href="mailto:aric@fore.com">aric@fore.com</a>></code>,</td></tr><tr><td>John Capo <code class="email"><<a href="mailto:jc@irbs.com">jc@irbs.com</a>></code>,</td></tr><tr><td>David Champion <code class="email"><<a href="mailto:dgc@uchicago.edu">dgc@uchicago.edu</a>></code>,</td></tr><tr><td>Brendan Cully <code class="email"><<a href="mailto:brendan@kublai.com">brendan@kublai.com</a>></code>,</td></tr><tr><td>Liviu Daia <code class="email"><<a href="mailto:daia@stoilow.imar.ro">daia@stoilow.imar.ro</a>></code>,</td></tr><tr><td>Thomas E. Dickey <code class="email"><<a href="mailto:dickey@herndon4.his.com">dickey@herndon4.his.com</a>></code>,</td></tr><tr><td>David DeSimone <code class="email"><<a href="mailto:fox@convex.hp.com">fox@convex.hp.com</a>></code>,</td></tr><tr><td>Nickolay N. Dudorov <code class="email"><<a href="mailto:nnd@wint.itfs.nsk.su">nnd@wint.itfs.nsk.su</a>></code>,</td></tr><tr><td>Ruslan Ermilov <code class="email"><<a href="mailto:ru@freebsd.org">ru@freebsd.org</a>></code>,</td></tr><tr><td>Edmund Grimley Evans <code class="email"><<a href="mailto:edmundo@rano.org">edmundo@rano.org</a>></code>,</td></tr><tr><td>Michael Finken <code class="email"><<a href="mailto:finken@conware.de">finken@conware.de</a>></code>,</td></tr><tr><td>Sven Guckes <code class="email"><<a href="mailto:guckes@math.fu-berlin.de">guckes@math.fu-berlin.de</a>></code>,</td></tr><tr><td>Lars Hecking <code class="email"><<a href="mailto:lhecking@nmrc.ie">lhecking@nmrc.ie</a>></code>,</td></tr><tr><td>Mark Holloman <code class="email"><<a href="mailto:holloman@nando.net">holloman@nando.net</a>></code>,</td></tr><tr><td>Andreas Holzmann <code class="email"><<a href="mailto:holzmann@fmi.uni-passau.de">holzmann@fmi.uni-passau.de</a>></code>,</td></tr><tr><td>Marco d'Itri <code class="email"><<a href="mailto:md@linux.it">md@linux.it</a>></code>,</td></tr><tr><td>Björn Jacke <code class="email"><<a href="mailto:bjacke@suse.com">bjacke@suse.com</a>></code>,</td></tr><tr><td>Byrial Jensen <code class="email"><<a href="mailto:byrial@image.dk">byrial@image.dk</a>></code>,</td></tr><tr><td>David Jeske <code class="email"><<a href="mailto:jeske@igcom.net">jeske@igcom.net</a>></code>,</td></tr><tr><td>Christophe Kalt <code class="email"><<a href="mailto:kalt@hugo.int-evry.fr">kalt@hugo.int-evry.fr</a>></code>,</td></tr><tr><td>Tommi Komulainen <code class="email"><<a href="mailto:Tommi.Komulainen@iki.fi">Tommi.Komulainen@iki.fi</a>></code>,</td></tr><tr><td>Felix von Leitner (a.k.a ``Fefe'') <code class="email"><<a href="mailto:leitner@math.fu-berlin.de">leitner@math.fu-berlin.de</a>></code>,</td></tr><tr><td>Brandon Long <code class="email"><<a href="mailto:blong@fiction.net">blong@fiction.net</a>></code>,</td></tr><tr><td>Jimmy Mäkelä <code class="email"><<a href="mailto:jmy@flashback.net">jmy@flashback.net</a>></code>,</td></tr><tr><td>Lars Marowsky-Bree <code class="email"><<a href="mailto:lmb@pointer.in-minden.de">lmb@pointer.in-minden.de</a>></code>,</td></tr><tr><td>Thomas ``Mike'' Michlmayr <code class="email"><<a href="mailto:mike@cosy.sbg.ac.at">mike@cosy.sbg.ac.at</a>></code>,</td></tr><tr><td>Andrew W. Nosenko <code class="email"><<a href="mailto:awn@bcs.zp.ua">awn@bcs.zp.ua</a>></code>,</td></tr><tr><td>David O'Brien <code class="email"><<a href="mailto:obrien@Nuxi.cs.ucdavis.edu">obrien@Nuxi.cs.ucdavis.edu</a>></code>,</td></tr><tr><td>Clint Olsen <code class="email"><<a href="mailto:olsenc@ichips.intel.com">olsenc@ichips.intel.com</a>></code>,</td></tr><tr><td>Park Myeong Seok <code class="email"><<a href="mailto:pms@romance.kaist.ac.kr">pms@romance.kaist.ac.kr</a>></code>,</td></tr><tr><td>Thomas Parmelan <code class="email"><<a href="mailto:tom@ankh.fr.eu.org">tom@ankh.fr.eu.org</a>></code>,</td></tr><tr><td>Ollivier Robert <code class="email"><<a href="mailto:roberto@keltia.freenix.fr">roberto@keltia.freenix.fr</a>></code>,</td></tr><tr><td>Thomas Roessler <code class="email"><<a href="mailto:roessler@does-not-exist.org">roessler@does-not-exist.org</a>></code>,</td></tr><tr><td>Roland Rosenfeld <code class="email"><<a href="mailto:roland@spinnaker.de">roland@spinnaker.de</a>></code>,</td></tr><tr><td>TAKIZAWA Takashi <code class="email"><<a href="mailto:taki@luna.email.ne.jp">taki@luna.email.ne.jp</a>></code>,</td></tr><tr><td>Allain Thivillon <code class="email"><<a href="mailto:Allain.Thivillon@alma.fr">Allain.Thivillon@alma.fr</a>></code>,</td></tr><tr><td>Gero Treuner <code class="email"><<a href="mailto:gero@70t.de">gero@70t.de</a>></code>,</td></tr><tr><td>Vsevolod Volkov <code class="email"><<a href="mailto:vvv@lucky.net">vvv@lucky.net</a>></code>,</td></tr><tr><td>Ken Weinert <code class="email"><<a href="mailto:kenw@ihs.com">kenw@ihs.com</a>></code></td></tr></table><p>
5987 </p></div><div class="sect1" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="about"></a>2. About this document</h2></div></div></div><p>
5988 This document was written in <a href="http://docbook.sourceforge.net" target="_top">DocBook</a>,
5989 and then rendered using the <a href="http://xmlsoft.org/XSLT/" target="_top">Gnome XSLT toolkit</a>.
5990 </p></div></div></div></body></html>