1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
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>Chapter 3. Configuration</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1" /><link rel="start" href="index.html" title="The Mutt E-Mail Client" /><link rel="up" href="index.html" title="The Mutt E-Mail Client" /><link rel="prev" href="gettingstarted.html" title="Chapter 2. Getting Started" /><link rel="next" href="advancedusage.html" title="Chapter 4. Advanced Usage" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Configuration</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gettingstarted.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="advancedusage.html">Next</a></td></tr></table><hr /></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="configuration.html#muttrc-syntax">1. Syntax of Initialization Files</a></span></dt><dt><span class="sect1"><a href="configuration.html#addrgroup">2. Address groups</a></span></dt><dt><span class="sect1"><a href="configuration.html#alias">3. Defining/Using aliases</a></span></dt><dt><span class="sect1"><a href="configuration.html#bind">4. Changing the default key bindings</a></span></dt><dt><span class="sect1"><a href="configuration.html#charset-hook">5. Defining aliases for character sets </a></span></dt><dt><span class="sect1"><a href="configuration.html#folder-hook">6. Setting variables based upon mailbox</a></span></dt><dt><span class="sect1"><a href="configuration.html#macro">7. Keyboard macros</a></span></dt><dt><span class="sect1"><a href="configuration.html#color">8. Using color and mono video attributes</a></span></dt><dt><span class="sect1"><a href="configuration.html#ignore">9. Ignoring (weeding) unwanted message headers</a></span></dt><dt><span class="sect1"><a href="configuration.html#alternates">10. Alternative addresses</a></span></dt><dt><span class="sect1"><a href="configuration.html#lists">11. Mailing lists</a></span></dt><dt><span class="sect1"><a href="configuration.html#mbox-hook">12. Using Multiple spool mailboxes</a></span></dt><dt><span class="sect1"><a href="configuration.html#mailboxes">13. Monitoring incoming mail</a></span></dt><dt><span class="sect1"><a href="configuration.html#my-hdr">14. User defined headers</a></span></dt><dt><span class="sect1"><a href="configuration.html#hdr-order">15. Defining the order of headers when viewing messages</a></span></dt><dt><span class="sect1"><a href="configuration.html#save-hook">16. Specify default save mailbox</a></span></dt><dt><span class="sect1"><a href="configuration.html#fcc-hook">17. Specify default Fcc: mailbox when composing</a></span></dt><dt><span class="sect1"><a href="configuration.html#fcc-save-hook">18. Specify default save filename and default Fcc: mailbox at once</a></span></dt><dt><span class="sect1"><a href="configuration.html#send-hook">19. Change settings based upon message recipients</a></span></dt><dt><span class="sect1"><a href="configuration.html#message-hook">20. Change settings before formatting a message</a></span></dt><dt><span class="sect1"><a href="configuration.html#crypt-hook">21. Choosing the cryptographic key of the recipient</a></span></dt><dt><span class="sect1"><a href="configuration.html#push">22. Adding key sequences to the keyboard buffer</a></span></dt><dt><span class="sect1"><a href="configuration.html#exec">23. Executing functions</a></span></dt><dt><span class="sect1"><a href="configuration.html#score-command">24. Message Scoring</a></span></dt><dt><span class="sect1"><a href="configuration.html#spam">25. Spam detection</a></span></dt><dt><span class="sect1"><a href="configuration.html#set">26. Setting and Querying Variables</a></span></dt><dd><dl><dt><span class="sect2"><a href="configuration.html#set-commands">26.1. Commands</a></span></dt><dt><span class="sect2"><a href="configuration.html#set-myvar">26.2. User-defined variables</a></span></dt></dl></dd><dt><span class="sect1"><a href="configuration.html#source">27. Reading initialization commands from another file</a></span></dt><dt><span class="sect1"><a href="configuration.html#unhook">28. Removing hooks</a></span></dt><dt><span class="sect1"><a href="configuration.html#formatstrings">29. Format Strings</a></span></dt><dd><dl><dt><span class="sect2"><a href="configuration.html#id470510">29.1. Basic usage</a></span></dt><dt><span class="sect2"><a href="configuration.html#id470640">29.2. Filters</a></span></dt></dl></dd></dl></div><p>
4 While the default configuration (or ``preferences'') make Mutt
5 usable right out of the box, it is often desirable to tailor Mutt to
6 suit your own tastes. When Mutt is first invoked, it will attempt to
7 read the ``system'' configuration file (defaults set by your local
8 system administrator), unless the ``-n'' <a href="reference.html#commandline" title="1. Command line options">command line</a> option is specified. This file is typically
9 <code class="literal">/usr/local/share/mutt/Muttrc</code> or <code class="literal">/etc/Muttrc</code>. Mutt
10 will next look for a file named <code class="literal">.muttrc</code> in your home
11 directory. If this file does not exist and your home directory has
12 a subdirectory named <code class="literal">.mutt</code>, mutt try to load a file named
13 <code class="literal">.mutt/muttrc</code>.
15 <code class="literal">.muttrc</code> is the file where you will usually place your <a href="reference.html#commands" title="2. Configuration Commands">commands</a> to configure Mutt.
17 In addition, mutt supports version specific configuration files that are
18 parsed instead of the default files as explained above. For instance, if
19 your system has a <code class="literal">Muttrc-0.88</code> file in the system configuration
20 directory, and you are running version 0.88 of mutt, this file will be
21 sourced instead of the <code class="literal">Muttrc</code> file. The same is true of the user
22 configuration file, if you have a file <code class="literal">.muttrc-0.88.6</code> in your home
23 directory, when you run mutt version 0.88.6, it will source this file
24 instead of the default <code class="literal">.muttrc</code> file. The version number is the
25 same which is visible using the ``-v'' <a href="reference.html#commandline" title="1. Command line options">command line</a> switch or using the <code class="literal">show-version</code> key (default:
26 V) from the index menu.
27 </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>
28 An initialization file consists of a series of <a href="reference.html#commands" title="2. Configuration Commands">commands</a>. Each line of the file may contain one or more commands.
29 When multiple commands are used, they must be separated by a semicolon (;).
31 </p><pre class="screen">
32 set realname='Mutt user' ; ignore x-
35 The hash mark, or pound sign
36 (``#''), is used as a ``comment'' character. You can use it to
37 annotate your initialization file. All text after the comment character
38 to the end of the line is ignored. For example,
41 </p><pre class="screen">
42 my_hdr X-Disclaimer: Why are you listening to me? # This is a comment
46 Single quotes (') and double quotes (") can be used to quote strings
47 which contain spaces or other special characters. The difference between
48 the two types of quotes is similar to that of many popular shell programs,
49 namely that a single quote is used to specify a literal string (one that is
50 not interpreted for shell variables or quoting with a backslash [see
51 next paragraph]), while double quotes indicate a string for which
52 should be evaluated. For example, backtics are evaluated inside of double
53 quotes, but <span class="bold"><strong>not</strong></span> for single quotes.
55 \ quotes the next character, just as in shells such as bash and zsh.
56 For example, if want to put quotes ``"'' inside of a string, you can use
57 ``\'' to force the next character to be a literal instead of interpreted
60 </p><pre class="screen">
61 set realname="Michael \"MuttDude\" Elkins"
65 ``\\'' means to insert a literal ``\'' into the line.
66 ``\n'' and ``\r'' have their usual C meanings of linefeed and
67 carriage-return, respectively.
69 A \ at the end of a line can be used to split commands over
70 multiple lines, provided that the split points don't appear in the
71 middle of command names.
73 It is also possible to substitute the output of a Unix command in an
74 initialization file. This is accomplished by enclosing the command in
75 backquotes (``). For example,
77 </p><pre class="screen">
78 my_hdr X-Operating-System: `uname -a`
81 The output of the Unix command ``uname -a'' will be substituted before the
82 line is parsed. Note that since initialization files are line oriented, only
83 the first line of output from the Unix command will be substituted.
85 Both environment variables and mutt variables can be accessed by
86 prepending ``$'' to the name of the variable. For example,
87 </p><pre class="screen">
88 set record=+sent_on_$HOSTNAME
90 will cause mutt to save outgoing messages to a folder named
91 ``sent_on_kremvax'' if the environment variable HOSTNAME is set to
92 ``kremvax.'' (See <a href="reference.html#record" title="3.239. record">$record</a> for
95 Mutt expands the variable when it is assigned, not when it is used. If
96 the value of a variable on the right-hand side of an assignment
97 changes after the assignment, the variable on the left-hand side will
100 The commands understood by mutt are explained in the next paragraphs.
101 For a complete list, see the <a href="reference.html#commands" title="2. Configuration Commands">command reference</a>.
102 </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>
103 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> [ ... ] ]
105 <code class="literal">group</code> is used to directly add either addresses or
106 regular expressions to the specified group or groups. The different
107 categories of arguments to the <code class="literal">group</code> command can be
108 in any order. The flags <code class="literal">-rx</code> and
109 <code class="literal">-addr</code> specify what the following strings (that cannot
110 begin with a hyphen) should be interpreted as: either a regular
111 expression or an email address, respectively.
113 These address groups can also be created implicitely by the
114 <a href="configuration.html#alias" title="3. Defining/Using aliases">alias</a>, <a href="configuration.html#lists" title="11. Mailing lists">lists</a>,
115 <a href="configuration.html#lists" title="11. Mailing lists">subscribe</a> and
116 <a href="configuration.html#alternates" title="10. Alternative addresses">alternates</a> commands by specifying the
117 optional <code class="literal">-group</code> option.
119 Once defined, these address groups can be used in
120 <a href="advancedusage.html#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> to search for and limit the
121 display to messages matching a group.
123 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> [ ... ] ] ]
125 <code class="literal">ungroup</code> is used to remove addresses or regular
126 expressions from the specified group or groups. The syntax is similar to
127 the <code class="literal">group</code> command, however the special character
128 <code class="literal">*</code> can be used to empty a group of all of its
130 </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>
131 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>, ... ]
133 It's usually very cumbersome to remember or type out the address of someone
134 you are communicating with. Mutt allows you to create ``aliases'' which map
135 a short string to a full address.
137 <span class="bold"><strong>Note:</strong></span> if you want to create an alias for more than
138 one address, you <span class="bold"><strong>must</strong></span> separate the addresses with a comma (``,'').
140 The optional <code class="literal">-group</code> argument to
141 <code class="literal">alias</code> causes the aliased address(es) to be added to
142 the named <span class="emphasis"><em>group</em></span>.
144 To remove an alias or aliases (``*'' means all aliases):
146 <code class="literal">unalias</code> [ * | <span class="emphasis"><em>key</em></span> <span class="emphasis"><em>...</em></span> ]
149 </p><pre class="screen">
150 alias muttdude me@cs.hmc.edu (Michael Elkins)
151 alias theguys manny, moe, jack
155 Unlike other mailers, Mutt doesn't require aliases to be defined
156 in a special file. The <code class="literal">alias</code> command can appear anywhere in
157 a configuration file, as long as this file is <a href="configuration.html#source" title="27. Reading initialization commands from another file">sourced</a>. Consequently, you can have multiple alias files, or
158 you can have all aliases defined in your muttrc.
160 On the other hand, the <a href="gettingstarted.html#create-alias">create-alias</a>
161 function can use only one file, the one pointed to by the <a href="reference.html#alias-file" title="3.3. alias_file">$alias_file</a> variable (which is
162 <code class="literal">˜/.muttrc</code> by default). This file is not special either,
163 in the sense that Mutt will happily append aliases to any file, but in
164 order for the new aliases to take effect you need to explicitly <a href="configuration.html#source" title="27. Reading initialization commands from another file">source</a> this file too.
169 </p><pre class="screen">
170 source /usr/local/share/Mutt.aliases
171 source ~/.mail_aliases
172 set alias_file=~/.mail_aliases
176 To use aliases, you merely use the alias at any place in mutt where mutt
177 prompts for addresses, such as the <span class="emphasis"><em>To:</em></span> or <span class="emphasis"><em>Cc:</em></span> prompt. You can
178 also enter aliases in your editor at the appropriate headers if you have the
179 <a href="reference.html#edit-headers" title="3.50. edit_headers">$edit_headers</a> variable set.
181 In addition, at the various address prompts, you can use the tab character
182 to expand a partial alias to the full alias. If there are multiple matches,
183 mutt will bring up a menu with the matching aliases. In order to be
184 presented with the full list of aliases, you must hit tab with out a partial
185 alias, such as at the beginning of the prompt or after a comma denoting
188 In the alias menu, you can select as many aliases as you want with the
189 <span class="emphasis"><em>select-entry</em></span> key (default: RET), and use the <span class="emphasis"><em>exit</em></span> key
190 (default: q) to return to the address prompt.
191 </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>
192 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>
194 This command allows you to change the default key bindings (operation
195 invoked when pressing a key).
197 <span class="emphasis"><em>map</em></span> specifies in which menu the binding belongs. Multiple maps may
198 be specified by separating them with commas (no additional whitespace is
199 allowed). The currently defined maps are:
202 </p><div class="variablelist"><dl><dt><span class="term">generic</span></dt><dd><p>
203 This is not a real menu, but is used as a fallback for all of the other
204 menus except for the pager and editor modes. If a key is not defined in
205 another menu, Mutt will look for a binding to use in this menu. This allows
206 you to bind a key to a certain function in multiple menus instead of having
207 multiple bind statements to accomplish the same task.
208 </p></dd><dt><span class="term">alias</span></dt><dd><p>
209 The alias menu is the list of your personal aliases as defined in your
210 muttrc. It is the mapping from a short alias name to the full email
211 address(es) of the recipient(s).
212 </p></dd><dt><span class="term">attach</span></dt><dd><p>
213 The attachment menu is used to access the attachments on received messages.
214 </p></dd><dt><span class="term">browser</span></dt><dd><p>
215 The browser is used for both browsing the local directory structure, and for
216 listing all of your incoming mailboxes.
217 </p></dd><dt><span class="term">editor</span></dt><dd><p>
218 The editor is the line-based editor the user enters text data.
219 </p></dd><dt><span class="term">index</span></dt><dd><p>
220 The index is the list of messages contained in a mailbox.
221 </p></dd><dt><span class="term">compose</span></dt><dd><p>
222 The compose menu is the screen used when sending a new message.
223 </p></dd><dt><span class="term">pager</span></dt><dd><p>
224 The pager is the mode used to display message/attachment data, and help
226 </p></dd><dt><span class="term">pgp</span></dt><dd><p>
227 The pgp menu is used to select the OpenPGP keys used for encrypting outgoing
229 </p></dd><dt><span class="term">postpone</span></dt><dd><p>
230 The postpone menu is similar to the index menu, except is used when
231 recalling a message the user was composing, but saved until later.
232 </p></dd></dl></div><p>
234 <span class="emphasis"><em>key</em></span> is the key (or key sequence) you wish to bind. To specify a
235 control character, use the sequence <span class="emphasis"><em>\Cx</em></span>, where <span class="emphasis"><em>x</em></span> is the
236 letter of the control character (for example, to specify control-A use
237 ``\Ca''). Note that the case of <span class="emphasis"><em>x</em></span> as well as <span class="emphasis"><em>\C</em></span> is
238 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
239 equivalent. An alternative form is to specify the key as a three digit
240 octal number prefixed with a ``\'' (for example <span class="emphasis"><em>\177</em></span> is
241 equivalent to <span class="emphasis"><em>\c?</em></span>). In addition, <span class="emphasis"><em>key</em></span> may
242 be a symbolic name as shown in <a href="configuration.html#tab-key-names" title="Table 3.1. Symbolic key names">Table 3.1, “Symbolic key names”</a>.
245 </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" />
248 <span class="emphasis"><em>key</em></span> does not need to be enclosed in quotes unless it contains a
251 <span class="emphasis"><em>function</em></span> specifies which action to take when <span class="emphasis"><em>key</em></span> is pressed.
252 For a complete list of functions, see the <a href="reference.html#functions" title="4. Functions">reference</a>. The special function <code class="literal">noop</code> unbinds the specified key
254 </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>
255 </p><div class="literallayout"><p><br />
256 Usage: <code class="literal">charset-hook</code> <span class="emphasis"><em>alias</em></span> <span class="emphasis"><em>charset</em></span><br />
257 Usage: <code class="literal">iconv-hook</code> <span class="emphasis"><em>charset</em></span> <span class="emphasis"><em>local-charset</em></span><br />
260 The <code class="literal">charset-hook</code> command defines an alias for a character set.
261 This is useful to properly display messages which are tagged with a
262 character set name not known to mutt.
264 The <code class="literal">iconv-hook</code> command defines a system-specific name for a
265 character set. This is helpful when your systems character
266 conversion library insists on using strange, system-specific names
268 </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>
269 Usage: <code class="literal">folder-hook</code> [!]<span class="emphasis"><em>regexp</em></span> <span class="emphasis"><em>command</em></span>
271 It is often desirable to change settings based on which mailbox you are
272 reading. The folder-hook command provides a method by which you can execute
273 any configuration command. <span class="emphasis"><em>regexp</em></span> is a regular expression specifying
274 in which mailboxes to execute <span class="emphasis"><em>command</em></span> before loading. If a mailbox
275 matches multiple folder-hook's, they are executed in the order given in the
278 <span class="bold"><strong>Note:</strong></span> if you use the ``!'' shortcut for <a href="reference.html#spoolfile" title="3.276. spoolfile">$spoolfile</a> at the beginning of the pattern, you must place it
279 inside of double or single quotes in order to distinguish it from the
280 logical <span class="emphasis"><em>not</em></span> operator for the expression.
282 Note that the settings are <span class="emphasis"><em>not</em></span> restored when you leave the mailbox.
283 For example, a command action to perform is to change the sorting method
284 based upon the mailbox being read:
287 </p><pre class="screen">
288 folder-hook mutt set sort=threads
292 However, the sorting method is not restored to its previous value when
293 reading a different mailbox. To specify a <span class="emphasis"><em>default</em></span> command, use the
297 </p><pre class="screen">
298 folder-hook . set sort=date-sent
301 </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>
302 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> ]
304 Macros are useful when you would like a single key to perform a series of
305 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
306 you had typed <span class="emphasis"><em>sequence</em></span>. So if you have a common sequence of commands
307 you type, you can create a macro to execute those commands with a single
310 <span class="emphasis"><em>menu</em></span> is the <a href="configuration.html#maps">map</a> which the macro will be bound.
311 Multiple maps may be specified by separating multiple menu arguments by
312 commas. Whitespace may not be used in between the menu arguments and the
313 commas separating them.
315 <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="configuration.html#bind" title="4. Changing the default key bindings">key bindings</a>. There are some additions however. The
316 first is that control characters in <span class="emphasis"><em>sequence</em></span> can also be specified
317 as <span class="emphasis"><em>^x</em></span>. In order to get a caret (`^'') you need to use
318 <span class="emphasis"><em>^^</em></span>. Secondly, to specify a certain key such as <span class="emphasis"><em>up</em></span>
319 or to invoke a function directly, you can use the format
320 <span class="emphasis"><em><key name></em></span> and <span class="emphasis"><em><function name></em></span>. For a listing of key
321 names see the section on <a href="configuration.html#bind" title="4. Changing the default key bindings">key bindings</a>. Functions
322 are listed in the <a href="reference.html#functions" title="4. Functions">reference</a>.
324 The advantage with using function names directly is that the macros will
325 work regardless of the current key bindings, so they are not dependent on
326 the user having particular key definitions. This makes them more robust
327 and portable, and also facilitates defining of macros in files used by more
328 than one user (e.g., the system Muttrc).
330 Optionally you can specify a descriptive text after <span class="emphasis"><em>sequence</em></span>,
331 which is shown in the help screens.
333 <span class="bold"><strong>Note:</strong></span> Macro definitions (if any) listed in the help screen(s), are
334 silently truncated at the screen width, and are not wrapped.
335 </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>
336 </p><div class="literallayout"><p><br />
337 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 />
338 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 />
339 Usage: <code class="literal">uncolor</code> index <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]<br />
342 If your terminal supports color, you can spice up Mutt by creating your own
343 color scheme. To define the color of an object (type of information), you
344 must specify both a foreground color <span class="bold"><strong>and</strong></span> a background color (it is not
345 possible to only specify one or the other).
347 <span class="emphasis"><em>object</em></span> can be one of:
350 </p><div class="itemizedlist"><ul type="disc"><li><p>
353 body (match <span class="emphasis"><em>regexp</em></span> in the body of messages)
355 bold (hiliting bold patterns in the body of messages)
357 error (error messages printed by Mutt)
359 header (match <span class="emphasis"><em>regexp</em></span> in the message header)
361 hdrdefault (default color of the message header in the pager)
363 index (match <span class="emphasis"><em>pattern</em></span> in the message index)
365 indicator (arrow or bar used to indicate the current item in a menu)
367 markers (the ``+'' markers at the beginning of wrapped lines in the pager)
369 message (informational messages)
373 quoted (text matching <a href="reference.html#quote-regexp" title="3.234. quote_regexp">$quote_regexp</a> in the body of a message)
375 quoted1, quoted2, ..., quoted<span class="bold"><strong>N</strong></span> (higher levels of quoting)
377 search (hiliting of words in the pager)
381 status (mode lines used to display info about the mailbox or message)
383 tilde (the ``˜'' used to pad blank lines in the pager)
385 tree (thread tree drawn in the message index and attachment menu)
387 underline (hiliting underlined patterns in the body of messages)
388 </p></li></ul></div><p>
391 <span class="emphasis"><em>foreground</em></span> and <span class="emphasis"><em>background</em></span> can be one of the following:
394 </p><div class="itemizedlist"><ul type="disc"><li><p>
413 color<span class="emphasis"><em>x</em></span>
414 </p></li></ul></div><p>
417 <span class="emphasis"><em>foreground</em></span> can optionally be prefixed with the keyword <code class="literal">bright</code> to make
418 the foreground color boldfaced (e.g., <code class="literal">brightred</code>).
420 If your terminal supports it, the special keyword <span class="emphasis"><em>default</em></span> can be
421 used as a transparent color. The value <span class="emphasis"><em>brightdefault</em></span> is also valid.
422 If Mutt is linked against the <span class="emphasis"><em>S-Lang</em></span> library, you also need to set
423 the <span class="emphasis"><em>COLORFGBG</em></span> environment variable to the default colors of your
424 terminal for this to work; for example (for Bourne-like shells):
427 </p><pre class="screen">
428 set COLORFGBG="green;black"
433 <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>
434 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
435 setting this variable.
437 <span class="bold"><strong>Note:</strong></span> The uncolor command can be applied to the index object only. It
438 removes entries from the list. You <span class="bold"><strong>must</strong></span> specify the same pattern
439 specified in the color command for it to be removed. The pattern ``*'' is
440 a special token which means to clear the color index list of all entries.
442 Mutt also recognizes the keywords <span class="emphasis"><em>color0</em></span>, <span class="emphasis"><em>color1</em></span>, …,
443 <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
444 by your terminal). This is useful when you remap the colors for your
445 display (for example by changing the color associated with <span class="emphasis"><em>color2</em></span>
446 for your xterm), since color names may then lose their normal meaning.
448 If your terminal does not support color, it is still possible change the video
449 attributes through the use of the ``mono'' command:
451 </p><div class="literallayout"><p><br />
452 Usage: <code class="literal">mono</code> <span class="emphasis"><em><object> <attribute></em></span> [ <span class="emphasis"><em>regexp</em></span> ]<br />
453 Usage: <code class="literal">mono</code> index <span class="emphasis"><em>attribute</em></span> <span class="emphasis"><em>pattern</em></span><br />
454 Usage: <code class="literal">unmono</code> index <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]<br />
457 where <span class="emphasis"><em>attribute</em></span> is one of the following:
460 </p><div class="itemizedlist"><ul type="disc"><li><p>
470 </p></li></ul></div><p>
472 </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>
473 Usage: <code class="literal">[un]ignore</code> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]
475 Messages often have many header fields added by automatic processing systems,
476 or which may not seem useful to display on the screen. This command allows
477 you to specify header fields which you don't normally want to see.
479 You do not need to specify the full header field name. For example,
480 ``ignore content-'' will ignore all header fields that begin with the pattern
481 ``content-''. ``ignore *'' will ignore all headers.
483 To remove a previously added token from the list, use the ``unignore'' command.
484 The ``unignore'' command will make Mutt display headers with the given pattern.
485 For example, if you do ``ignore x-'' it is possible to ``unignore x-mailer''.
487 ``unignore *'' will remove all tokens from the ignore list.
491 </p><pre class="screen">
492 # Sven's draconian header weeding
494 unignore from date subject to cc
495 unignore organization organisation x-mailer: x-newsreader: x-mailing-list:
499 </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>
500 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> ... ]
503 With various functions, mutt will treat messages differently,
504 depending on whether you sent them or whether you received them from
505 someone else. For instance, when replying to a message that you
506 sent to a different party, mutt will automatically suggest to send
507 the response to the original message's recipients -- responding to
508 yourself won't make much sense in many cases. (See <a href="reference.html#reply-to" title="3.242. reply_to">$reply_to</a>.)
510 Many users receive e-mail under a number of different addresses. To
511 fully use mutt's features here, the program must be able to
512 recognize what e-mail addresses you receive mail under. That's the
513 purpose of the <code class="literal">alternates</code> command: It takes a list of regular
514 expressions, each of which can identify an address under which you
517 As addresses are matched using regular expressions and not exact strict
518 comparisons, you should make sure you specify your addresses as precise
519 as possible to avoid mismatches. For example, if you specify:
520 </p><pre class="screen">
521 alternates user@example
523 mutt will consider ``<code class="literal">some-user@example</code>'' as
524 being your address, too which may not be desired. As a solution, in such
525 cases addresses should be specified as:
526 </p><pre class="screen">
527 alternates '^user@example$'
529 The <code class="literal">-group</code> flag causes all of the subsequent regular expressions
530 to be added to the named group.
532 The <code class="literal">unalternates</code> command can be used to write exceptions to
533 <code class="literal">alternates</code> patterns. If an address matches something in an
534 <code class="literal">alternates</code> command, but you nonetheless do not think it is
535 from you, you can list a more precise pattern under an <code class="literal">unalternates</code>
538 To remove a regular expression from the <code class="literal">alternates</code> list, use the
539 <code class="literal">unalternates</code> command with exactly the same <span class="emphasis"><em>regexp</em></span>.
540 Likewise, if the <span class="emphasis"><em>regexp</em></span> for an <code class="literal">alternates</code> command matches
541 an entry on the <code class="literal">unalternates</code> list, that <code class="literal">unalternates</code>
542 entry will be removed. If the <span class="emphasis"><em>regexp</em></span> for <code class="literal">unalternates</code>
543 is ``*'', <span class="emphasis"><em>all entries</em></span> on <code class="literal">alternates</code> will be removed.
544 </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>
545 </p><div class="literallayout"><p><br />
546 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 />
547 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 />
550 Mutt has a few nice features for <a href="advancedusage.html#using-lists" title="8. Handling Mailing Lists">handling mailing lists</a>. In order to take advantage of them, you must
551 specify which addresses belong to mailing lists, and which mailing
552 lists you are subscribed to. Once you have done this, the <a href="gettingstarted.html#list-reply">list-reply</a> function will work for all known lists.
553 Additionally, when you send a message to a subscribed list, mutt will
554 add a Mail-Followup-To header to tell other users' mail user agents
555 not to send copies of replies to your personal address. Note that
556 the Mail-Followup-To header is a non-standard extension which is not
557 supported by all mail user agents. Adding it is not bullet-proof against
558 receiving personal CCs of list messages. Also note that the generation
559 of the Mail-Followup-To header is controlled by the <a href="reference.html#followup-to" title="3.60. followup_to">$followup_to</a> configuration variable.
561 More precisely, Mutt maintains lists of patterns for the addresses
562 of known and subscribed mailing lists. Every subscribed mailing
563 list is known. To mark a mailing list as known, use the ``lists''
564 command. To mark it as subscribed, use ``subscribe''.
566 You can use regular expressions with both commands. To mark all
567 messages sent to a specific bug report's address on mutt's bug
568 tracking system as list mail, for instance, you could say
569 ``subscribe [0-9]*@bugs.guug.de''. Often, it's sufficient to just
570 give a portion of the list's e-mail address.
572 Specify as much of the address as you need to to remove ambiguity. For
573 example, if you've subscribed to the Mutt mailing list, you will receive mail
574 addressed to <span class="emphasis"><em>mutt-users@mutt.org</em></span>. So, to tell Mutt
575 that this is a mailing list, you could add ``lists mutt-users@'' to your
576 initialization file. To tell mutt that you are subscribed to it,
577 add ``subscribe mutt-users'' to your initialization file instead.
578 If you also happen to get mail from someone whose address is
579 <span class="emphasis"><em>mutt-users@example.com</em></span>, you could use
580 ``lists ^mutt-users@mutt\\.org$''
581 or ``subscribe ^mutt-users@mutt\\.org$'' to
582 match only mail from the actual list.
584 The <code class="literal">-group</code> flag adds all of the subsequent regular expressions
587 The ``unlists'' command is used to remove a token from the list of
588 known and subscribed mailing-lists. Use ``unlists *'' to remove all
591 To remove a mailing list from the list of subscribed mailing lists,
592 but keep it on the list of known mailing lists, use ``unsubscribe''.
593 </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>
594 Usage: <code class="literal">mbox-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
596 This command is used to move read messages from a specified mailbox to a
597 different mailbox automatically when you quit or change folders.
598 <span class="emphasis"><em>pattern</em></span> is a regular expression specifying the mailbox to treat as a
599 ``spool'' mailbox and <span class="emphasis"><em>mailbox</em></span> specifies where mail should be saved when
602 Unlike some of the other <span class="emphasis"><em>hook</em></span> commands, only the <span class="emphasis"><em>first</em></span> matching
603 pattern is used (it is not possible to save read mail in more than a single
605 </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>
606 Usage: <code class="literal">[un]mailboxes</code> <span class="emphasis"><em>folder</em></span> [ <span class="emphasis"><em>folder</em></span> ... ]
608 This command specifies folders which can receive mail and
609 which will be checked for new messages. By default, the
610 main menu status bar displays how many of these folders have
613 <code class="literal">folder</code> can either be a local file or directory
614 (Mbox/Mmdf or Maildir/Mh). If Mutt was built with POP and/or IMAP
615 support, <code class="literal">folder</code> can also be a POP/IMAP folder
616 URL. The URL syntax is described in <a href="optionalfeatures.html#url-syntax" title="1.2. URL syntax">Section 1.2, “URL syntax”</a>,
617 POP and IMAP are described in <a href="optionalfeatures.html#pop" title="3. POP3 Support">Section 3, “POP3 Support”</a> and <a href="optionalfeatures.html#imap" title="4. IMAP Support">Section 4, “IMAP Support”</a>
620 When changing folders, pressing <span class="emphasis"><em>space</em></span> will cycle
621 through folders with new mail.
623 Pressing TAB in the directory browser will bring up a menu showing the files
624 specified by the <code class="literal">mailboxes</code> command, and indicate which contain new
625 messages. Mutt will automatically enter this mode when invoked from the
626 command line with the <code class="literal">-y</code> option.
628 The ``unmailboxes'' command is used to remove a token from the list
629 of folders which receive mail. Use ``unmailboxes *'' to remove all
632 <span class="bold"><strong>Note:</strong></span> the folders in the <code class="literal">mailboxes</code> command are resolved when
633 the command is executed, so if these names contain <a href="advancedusage.html#shortcuts" title="7. Mailbox Shortcuts">shortcut characters</a> (such as ``='' and ``!''), any variable
634 definition that affect these characters (like <a href="reference.html#folder" title="3.58. folder">$folder</a> and <a href="reference.html#spoolfile" title="3.276. spoolfile">$spoolfile</a>)
635 should be executed before the <code class="literal">mailboxes</code> command. If
636 none of these shorcuts are used, a local path should be absolute as
637 otherwise mutt tries to find it within the current working directory
638 from where mutt was started which may not always be desired.
640 For local folders, new mail is detected by comparing access and/or
641 modification times of files and folders. The interval in which Mutt
642 checks for new mail is defined by
643 <a href="reference.html#mail-check" title="3.104. mail_check">$mail_check</a>.
645 Special care is required with Mbox and Mmdf
646 folders as Mutt assumes such a folder has new mail if it wasn't
647 accessed after it was last modified. Utilities like <code class="literal">biff</code> or
648 <code class="literal">frm</code> or any other program which accesses the mailbox might cause
649 Mutt to never detect new mail for that mailbox if they do not properly reset the
650 access time. Backup tools are another common reason for updated access times.
651 </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>
654 <code class="literal">my_hdr</code> <span class="emphasis"><em>string</em></span>
656 <code class="literal">unmy_hdr</code> <span class="emphasis"><em>field</em></span> [ <span class="emphasis"><em>field</em></span> ... ]
658 The ``my_hdr'' command allows you to create your own header
659 fields which will be added to every message you send.
661 For example, if you would like to add an ``Organization:'' header field to
662 all of your outgoing messages, you can put the command
664 “<span class="quote">my_hdr Organization: A Really Big Company, Anytown, USA</span>”
666 in your <code class="literal">.muttrc</code>.
668 <span class="bold"><strong>Note:</strong></span> space characters are <span class="emphasis"><em>not</em></span> allowed between the keyword and
669 the colon (``:''). The standard for electronic mail (RFC822) says that
670 space is illegal there, so Mutt enforces the rule.
672 If you would like to add a header field to a single message, you should
673 either set the <a href="reference.html#edit-headers" title="3.50. edit_headers">$edit_headers</a> variable,
674 or use the <span class="emphasis"><em>edit-headers</em></span> function (default: ``E'') in the send-menu so
675 that you can edit the header of your message along with the body.
677 To remove user defined header fields, use the ``unmy_hdr''
678 command. You may specify an asterisk (``*'') to remove all header
679 fields, or the fields to remove. For example, to remove all ``To'' and
680 ``Cc'' header fields, you could use:
682 “<span class="quote">unmy_hdr to cc</span>”
683 </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>
684 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>
686 With this command, you can specify an order in which mutt will attempt
687 to present headers to you when viewing messages.
689 ``unhdr_order *'' will clear all previous headers from the order list,
690 thus removing the header order effects set by the system-wide startup
694 </p><pre class="screen">
695 hdr_order From Date: From: To: Cc: Subject:
698 </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>
699 Usage: <code class="literal">save-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
701 This command is used to override the default mailbox used when saving
702 messages. <span class="emphasis"><em>mailbox</em></span> will be used as the default if the message
703 matches <span class="emphasis"><em>pattern</em></span>, see <a href="advancedusage.html#pattern-hook">Message Matching in Hooks</a> for information
706 To provide more flexibility and good defaults, Mutt applies the
707 expandos of <a href="reference.html#index-format" title="3.100. index_format">$index_format</a> to
708 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
713 </p><pre class="screen">
714 # default: save all to ~/Mail/<author name>
715 save-hook . ~/Mail/%F
716 # save from me@turing.cs.hmc.edu/me@cs.hmc.edu to $folder/elinks
717 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
718 # save from aol.com to $folder/spam
719 save-hook aol\\.com$ +spam
723 Also see the <a href="configuration.html#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a> command.
724 </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>
725 Usage: <code class="literal">fcc-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
727 This command is used to save outgoing mail in a mailbox other than
728 <a href="reference.html#record" title="3.239. record">$record</a>. Mutt searches the initial list of
729 message recipients for the first matching <span class="emphasis"><em>regexp</em></span> and uses <span class="emphasis"><em>mailbox</em></span>
730 as the default Fcc: mailbox. If no match is found the message will be saved
731 to <a href="reference.html#record" title="3.239. record">$record</a> mailbox.
733 To provide more flexibility and good defaults, Mutt applies the
734 expandos of <a href="reference.html#index-format" title="3.100. index_format">$index_format</a> to
735 <span class="emphasis"><em>mailbox</em></span> after it was expanded.
737 See <a href="advancedusage.html#pattern-hook">Message Matching in Hooks</a> for information on the exact format of <span class="emphasis"><em>pattern</em></span>.
739 Example: <code class="literal">fcc-hook [@.]aol\\.com$ +spammers</code>
741 The above will save a copy of all messages going to the aol.com domain to
742 the `+spammers' mailbox by default. Also see the <a href="configuration.html#fcc-save-hook" title="18. Specify default save filename and default Fcc: mailbox at once">fcc-save-hook</a> command.
743 </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>
744 Usage: <code class="literal">fcc-save-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>mailbox</em></span>
746 This command is a shortcut, equivalent to doing both a <a href="configuration.html#fcc-hook" title="17. Specify default Fcc: mailbox when composing">fcc-hook</a>
747 and a <a href="configuration.html#save-hook" title="16. Specify default save mailbox">save-hook</a> with its arguments,
748 including %-expansion on <span class="emphasis"><em>mailbox</em></span> according
749 to <a href="reference.html#index-format" title="3.100. index_format">$index_format</a>.
750 </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>
751 </p><div class="literallayout"><p><br />
752 Usage: <code class="literal">reply-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span><br />
753 Usage: <code class="literal">send-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span><br />
754 Usage: <code class="literal">send2-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span><br />
757 These commands can be used to execute arbitrary configuration commands based
758 upon recipients of the message. <span class="emphasis"><em>pattern</em></span> is a regular expression
759 matching the desired address. <span class="emphasis"><em>command</em></span> is executed when <span class="emphasis"><em>regexp</em></span>
760 matches recipients of the message.
762 <code class="literal">reply-hook</code> is matched against the message you are <span class="emphasis"><em>replying</em></span>
763 <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
764 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>
765 <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>
766 of the order specified in the user's configuration file.
768 <code class="literal">send2-hook</code> is matched every time a message is changed, either
769 by editing it, or by using the compose menu to change its recipients
770 or subject. <code class="literal">send2-hook</code> is executed after <code class="literal">send-hook</code>, and
771 can, e.g., be used to set parameters such as the <a href="reference.html#sendmail" title="3.257. sendmail">$sendmail</a> variable depending on the message's sender
774 For each type of <code class="literal">send-hook</code> or <code class="literal">reply-hook</code>, when multiple matches
775 occur, commands are executed in the order they are specified in the muttrc
776 (for that type of hook).
778 See <a href="advancedusage.html#pattern-hook">Message Matching in Hooks</a> for information on the exact format of <span class="emphasis"><em>pattern</em></span>.
780 Example: <code class="literal">send-hook mutt "set mime_forward signature=''"</code>
782 Another typical use for this command is to change the values of the
783 <a href="reference.html#attribution" title="3.16. attribution">$attribution</a>, <a href="reference.html#signature" title="3.262. signature">$signature</a> and <a href="reference.html#locale" title="3.103. locale">$locale</a>
784 variables in order to change the language of the attributions and
785 signatures based upon the recipients.
787 <span class="bold"><strong>Note:</strong></span> the send-hook's are only executed ONCE after getting the initial
788 list of recipients. Adding a recipient after replying or editing the
789 message will NOT cause any send-hook to be executed. Also note that
790 my_hdr commands which modify recipient headers, or the message's
791 subject, don't have any effect on the current message when executed
793 </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>
794 Usage: <code class="literal">message-hook</code> [!]<span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>command</em></span>
796 This command can be used to execute arbitrary configuration commands
797 before viewing or formatting a message based upon information about the message.
798 <span class="emphasis"><em>command</em></span> is executed if the <span class="emphasis"><em>pattern</em></span> matches the message to be
799 displayed. When multiple matches occur, commands are executed in the order
800 they are specified in the muttrc.
802 See <a href="advancedusage.html#pattern-hook">Message Matching in Hooks</a> for
803 information on the exact format of <span class="emphasis"><em>pattern</em></span>.
807 </p><pre class="screen">
808 message-hook ~A 'set pager=builtin'
809 message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""'
812 </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>
813 Usage: <code class="literal">crypt-hook</code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>keyid</em></span>
815 When encrypting messages with PGP or OpenSSL, you may want to associate a certain
816 key with a given e-mail address automatically, either because the
817 recipient's public key can't be deduced from the destination address,
818 or because, for some reasons, you need to override the key Mutt would
819 normally use. The crypt-hook command provides a method by which you can
820 specify the ID of the public key to be used when encrypting messages to
823 The meaning of "key id" is to be taken broadly in this context: You
824 can either put a numerical key ID here, an e-mail address, or even
826 </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>
827 Usage: <code class="literal">push</code> <span class="emphasis"><em>string</em></span>
829 This command adds the named string to the keyboard buffer. The string may
830 contain control characters, key names and function names like the sequence
831 string in the <a href="configuration.html#macro" title="7. Keyboard macros">macro</a> command. You may use it to
832 automatically run a sequence of commands at startup, or when entering
833 certain folders. For example, the following command will automatically
834 collapse all threads when entering a folder:
836 </p><pre class="screen">
837 folder-hook . 'push <collapse-all>'
839 </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>
840 Usage: <code class="literal">exec</code> <span class="emphasis"><em>function</em></span> [ <span class="emphasis"><em>function</em></span> ... ]
842 This command can be used to execute any function. Functions are
843 listed in the <a href="reference.html#functions" title="4. Functions">function reference</a>.
844 ``exec function'' is equivalent to ``push <function>''.
845 </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>
846 </p><div class="literallayout"><p><br />
847 Usage: <code class="literal">score</code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>value</em></span><br />
848 Usage: <code class="literal">unscore</code> <span class="emphasis"><em>pattern</em></span> [ <span class="emphasis"><em>pattern</em></span> ... ]<br />
851 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>
852 matches it. <span class="emphasis"><em>pattern</em></span> is a string in the format described in the <a href="advancedusage.html#patterns" title="2. Patterns: Searching, Limiting and Tagging">patterns</a> section (note: For efficiency reasons, patterns
853 which scan information not available in the index, such as <code class="literal">˜b</code>,
854 <code class="literal">˜B</code> or <code class="literal">˜h</code>, may not be used). <span class="emphasis"><em>value</em></span> is a
855 positive or negative integer. A message's final score is the sum total of all
856 matching <code class="literal">score</code> entries. However, you may optionally prefix <span class="emphasis"><em>value</em></span> with
857 an equal sign (=) to cause evaluation to stop at a particular entry if there is
858 a match. Negative final scores are rounded up to 0.
860 The <code class="literal">unscore</code> command removes score entries from the list. You <span class="bold"><strong>must</strong></span>
861 specify the same pattern specified in the <code class="literal">score</code> command for it to be
862 removed. The pattern ``*'' is a special token which means to clear the list
863 of all score entries.
864 </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>
865 </p><div class="literallayout"><p><br />
866 Usage: <code class="literal">spam</code> <span class="emphasis"><em>pattern</em></span> <span class="emphasis"><em>format</em></span><br />
867 Usage: <code class="literal">nospam</code> <span class="emphasis"><em>pattern</em></span><br />
870 Mutt has generalized support for external spam-scoring filters.
871 By defining your spam patterns with the <code class="literal">spam</code> and <code class="literal">nospam</code>
872 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
873 mail based on its spam attributes, as determined by the external
874 filter. You also can display the spam attributes in your index
875 display using the <code class="literal">%H</code> selector in the <a href="reference.html#index-format" title="3.100. index_format">$index_format</a> variable. (Tip: try <code class="literal">%?H?[%H] ?</code>
876 to display spam tags only when they are defined for a given message.)
878 Your first step is to define your external filter's spam patterns using
879 the <code class="literal">spam</code> command. <span class="emphasis"><em>pattern</em></span> should be a regular expression
880 that matches a header in a mail message. If any message in the mailbox
881 matches this regular expression, it will receive a ``spam tag'' or
882 ``spam attribute'' (unless it also matches a <code class="literal">nospam</code> pattern -- see
883 below.) The appearance of this attribute is entirely up to you, and is
884 governed by the <span class="emphasis"><em>format</em></span> parameter. <span class="emphasis"><em>format</em></span> can be any static
885 text, but it also can include back-references from the <span class="emphasis"><em>pattern</em></span>
886 expression. (A regular expression ``back-reference'' refers to a
887 sub-expression contained within parentheses.) <code class="literal">%1</code> is replaced with
888 the first back-reference in the regex, <code class="literal">%2</code> with the second, etc.
890 If you're using multiple spam filters, a message can have more than
891 one spam-related header. You can define <code class="literal">spam</code> patterns for each
892 filter you use. If a message matches two or more of these patterns, and
893 the $spam_separator variable is set to a string, then the
894 message's spam tag will consist of all the <span class="emphasis"><em>format</em></span> strings joined
895 together, with the value of $spam_separator separating
898 For example, suppose I use DCC, SpamAssassin, and PureMessage. I might
899 define these spam settings:
901 </p><pre class="screen">
902 spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1"
903 spam "X-Spam-Status: Yes" "90+/SA"
904 spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM"
905 set spam_separator=", "
909 If I then received a message that DCC registered with ``many'' hits
910 under the ``Fuz2'' checksum, and that PureMessage registered with a
911 97% probability of being spam, that message's spam tag would read
912 <code class="literal">90+/DCC-Fuz2, 97/PM</code>. (The four characters before ``=many'' in a
913 DCC report indicate the checksum used -- in this case, ``Fuz2''.)
915 If the $spam_separator variable is unset, then each
916 spam pattern match supersedes the previous one. Instead of getting
917 joined <span class="emphasis"><em>format</em></span> strings, you'll get only the last one to match.
919 The spam tag is what will be displayed in the index when you use
920 <code class="literal">%H</code> in the <code class="literal">$index_format</code> variable. It's also the
921 string that the <code class="literal">˜H</code> pattern-matching expression matches against for
922 <span class="emphasis"><em>search</em></span> and <span class="emphasis"><em>limit</em></span> functions. And it's what sorting by spam
923 attribute will use as a sort key.
925 That's a pretty complicated example, and most people's actual
926 environments will have only one spam filter. The simpler your
927 configuration, the more effective mutt can be, especially when it comes
930 Generally, when you sort by spam tag, mutt will sort <span class="emphasis"><em>lexically</em></span> --
931 that is, by ordering strings alphanumerically. However, if a spam tag
932 begins with a number, mutt will sort numerically first, and lexically
933 only when two numbers are equal in value. (This is like UNIX's
934 <code class="literal">sort -n</code>.) A message with no spam attributes at all -- that is, one
935 that didn't match <span class="emphasis"><em>any</em></span> of your <code class="literal">spam</code> patterns -- is sorted at
936 lowest priority. Numbers are sorted next, beginning with 0 and ranging
937 upward. Finally, non-numeric strings are sorted, with ``a'' taking lower
938 priority than ``z''. Clearly, in general, sorting by spam tags is most
939 effective when you can coerce your filter to give you a raw number. But
940 in case you can't, mutt can still do something useful.
942 The <code class="literal">nospam</code> command can be used to write exceptions to <code class="literal">spam</code>
943 patterns. If a header pattern matches something in a <code class="literal">spam</code> command,
944 but you nonetheless do not want it to receive a spam tag, you can list a
945 more precise pattern under a <code class="literal">nospam</code> command.
947 If the <span class="emphasis"><em>pattern</em></span> given to <code class="literal">nospam</code> is exactly the same as the
948 <span class="emphasis"><em>pattern</em></span> on an existing <code class="literal">spam</code> list entry, the effect will be to
949 remove the entry from the spam list, instead of adding an exception.
950 Likewise, if the <span class="emphasis"><em>pattern</em></span> for a <code class="literal">spam</code> command matches an entry
951 on the <code class="literal">nospam</code> list, that <code class="literal">nospam</code> entry will be removed. If the
952 <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>
953 will be removed. This might be the default action if you use <code class="literal">spam</code>
954 and <code class="literal">nospam</code> in conjunction with a <code class="literal">folder-hook</code>.
956 You can have as many <code class="literal">spam</code> or <code class="literal">nospam</code> commands as you like.
957 You can even do your own primitive spam detection within mutt -- for
958 example, if you consider all mail from <code class="literal">MAILER-DAEMON</code> to be spam,
959 you can use a <code class="literal">spam</code> command like this:
962 </p><pre class="screen">
963 spam "^From: .*MAILER-DAEMON" "999"
966 </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>
967 The following commands are available to manipulate and query variables:
969 </p><div class="literallayout"><p><br />
970 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 />
971 Usage: <code class="literal">toggle</code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]<br />
972 Usage: <code class="literal">unset</code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]<br />
973 Usage: <code class="literal">reset</code> <span class="emphasis"><em>variable</em></span> [<span class="emphasis"><em>variable</em></span> ... ]<br />
976 This command is used to set (and unset) <a href="reference.html#variables" title="3. Configuration variables">configuration variables</a>. There are four basic types of variables:
977 boolean, number, string and quadoption. <span class="emphasis"><em>boolean</em></span> variables can be
978 <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
979 assigned a positive integer value.
981 <span class="emphasis"><em>string</em></span> variables consist of any number of printable characters.
982 <span class="emphasis"><em>strings</em></span> must be enclosed in quotes if they contain spaces or tabs. You
983 may also use the ``C'' escape sequences <span class="bold"><strong>\n</strong></span> and <span class="bold"><strong>\t</strong></span> for
984 newline and tab, respectively.
986 <span class="emphasis"><em>quadoption</em></span> variables are used to control whether or not to be prompted
987 for certain actions, or to specify a default action. A value of <span class="emphasis"><em>yes</em></span>
988 will cause the action to be carried out automatically as if you had answered
989 yes to the question. Similarly, a value of <span class="emphasis"><em>no</em></span> will cause the
990 action to be carried out as if you had answered ``no.'' A value of
991 <span class="emphasis"><em>ask-yes</em></span> will cause a prompt with a default answer of ``yes'' and
992 <span class="emphasis"><em>ask-no</em></span> will provide a default answer of ``no.''
994 Prefixing a variable with ``no'' will unset it. Example: <code class="literal">set noaskbcc</code>.
996 For <span class="emphasis"><em>boolean</em></span> variables, you may optionally prefix the variable name with
997 <code class="literal">inv</code> to toggle the value (on or off). This is useful when writing
998 macros. Example: <code class="literal">set invsmart_wrap</code>.
1000 The <code class="literal">toggle</code> command automatically prepends the <code class="literal">inv</code> prefix to all
1001 specified variables.
1003 The <code class="literal">unset</code> command automatically prepends the <code class="literal">no</code> prefix to all
1004 specified variables.
1006 Using the enter-command function in the <span class="emphasis"><em>index</em></span> menu, you can query the
1007 value of a variable by prefixing the name of the variable with a question
1011 </p><pre class="screen">
1016 The question mark is actually only required for boolean and quadoption
1019 The <code class="literal">reset</code> command resets all given variables to the compile time
1020 defaults (hopefully mentioned in this manual). If you use the command
1021 <code class="literal">set</code> and prefix the variable with ``&'' this has the same
1022 behavior as the reset command.
1024 With the <code class="literal">reset</code> command there exists the special variable ``all'',
1025 which allows you to reset all variables to their system defaults.
1026 </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>
1027 Along with the variables listed in the
1028 <a href="reference.html#variables" title="3. Configuration variables">Configuration variables</a> section, mutt
1029 supports user-defined variables with names starting
1030 with <code class="literal">my_</code> as in, for
1031 example, <code class="literal">my_cfgdir</code>.
1033 The <code class="literal">set</code> command creates a
1034 custom <code class="literal">$my_</code> variable and changes its
1035 value. The <code class="literal">unset</code> and <code class="literal">reset</code>
1036 commands remove the variable entirely.
1038 Since user-defined variables are expanded in the same way that
1039 environment variables are (except for
1040 the <a href="gettingstarted.html#shell-escape">shell-escape</a> command), this
1041 feature can be used to make configuration files more readable.
1042 </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>
1043 The following example defines and uses the variable <code class="literal">my_cfgdir</code>
1044 to abbreviate the calls of the <a href="configuration.html#source" title="27. Reading initialization commands from another file">source</a> command:
1046 </p><pre class="screen">
1047 set my_cfgdir = $HOME/mutt/config
1049 source $my_cfgdir/hooks
1050 source $my_cfgdir/macros
1051 # more source commands...
1054 A custom variable can also be used in macros to backup the current value
1055 of another variable. In the following example, the value of the
1056 <a href="reference.html#delete" title="3.42. delete">$delete</a> is changed temporarily
1057 while its original value is saved as <code class="literal">my_delete</code>.
1058 After the macro has executed all commands, the original value of <a href="reference.html#delete" title="3.42. delete">$delete</a> is restored.
1060 </p><pre class="screen">
1062 <enter-command>set my_delete=$delete<enter>\
1063 <enter-command>set delete=yes<enter>\
1065 <enter-command>set delete=$my_delete<enter>'
1068 Since mutt expands such values already when parsing the configuration
1069 file(s), the value of <code class="literal">$my_delete</code> in the
1070 last example would be the value of <code class="literal">$delete</code> exactly
1071 as it was at that point during parsing the configuration file. If
1072 another statement would change the value for <code class="literal">$delete</code>
1073 later in the same or another file, it would have no effect on
1074 <code class="literal">$my_delete</code>. However, the expansion can
1075 be deferred to runtime, as shown in the next example, when escaping the
1078 </p><pre class="screen">
1079 macro pager <PageDown> "\
1080 <enter-command> set my_old_pager_stop=\$pager_stop pager_stop<Enter>\
1082 <enter-command> set pager_stop=\$my_old_pager_stop<Enter>\
1083 <enter-command> unset my_old_pager_stop<Enter>"
1086 Note that there is a space
1087 between <code class="literal"><enter-command></code> and
1088 the <code class="literal">set</code> configuration command, preventing mutt from
1089 recording the macro's commands into its history.
1090 </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>
1091 Usage: <code class="literal">source</code> <span class="emphasis"><em>filename</em></span>
1093 This command allows the inclusion of initialization commands
1094 from other files. For example, I place all of my aliases in
1095 <code class="literal">˜/.mail_aliases</code> so that I can make my
1096 <code class="literal">˜/.muttrc</code> readable and keep my aliases private.
1098 If the filename begins with a tilde (``˜''), it will be expanded to the
1099 path of your home directory.
1101 If the filename ends with a vertical bar (|), then <span class="emphasis"><em>filename</em></span> is
1102 considered to be an executable program from which to read input (eg.
1103 <code class="literal">source ˜/bin/myscript|</code>).
1104 </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>
1105 Usage: <code class="literal">unhook</code> [ * | <span class="emphasis"><em>hook-type</em></span> ]
1107 This command permits you to flush hooks you have previously defined.
1108 You can either remove all hooks by giving the ``*'' character as an
1109 argument, or you can remove all hooks of a specific type by saying
1110 something like <code class="literal">unhook send-hook</code>.
1111 </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="id470510"></a>29.1. Basic usage</h3></div></div></div><p>
1112 Format strings are a general concept you'll find in several locations
1113 through the mutt configuration, especially in the
1114 <a href="reference.html#index-format" title="3.100. index_format">$index_format"</a>,
1115 <a href="reference.html#pager-format" title="3.139. pager_format">$pager_format"</a>,
1116 <a href="reference.html#status-format" title="3.278. status_format">$status_format"</a>,
1117 and other ``*_format'' variables. These can be very straightforward,
1118 and it's quite possible you already know how to use them.
1120 The most basic format string element is a percent symbol followed
1121 by another character. For example, <code class="literal">%s</code>
1122 represents a message's Subject: header in the <a href="reference.html#index-format" title="3.100. index_format">$index_format"</a> variable. The
1123 ``expandos'' available are documented with each format variable, but
1124 there are general modifiers available with all formatting expandos,
1125 too. Those are our concern here.
1127 Some of the modifers are borrowed right out of C (though you might
1128 know them from Perl, Python, shell, or another langugage). These are
1129 the [-]m.n modifiers, as in <code class="literal">%-12.12s</code>. As with
1130 such programming languages, these modifiers allow you to specify the
1131 minumum and maximum size of the resulting string, as well as its
1132 justification. If the ``-'' sign follows the percent, the string will
1133 be left-justified instead of right-justified. If there's a number
1134 immediately following that, it's the minimum amount of space the
1135 formatted string will occupy -- if it's naturally smaller than that, it
1136 will be padded out with spaces. If a decimal point and another number
1137 follow, that's the maximum space allowable -- the string will not be
1138 permitted to exceed that width, no matter its natural size. Each of
1139 these three elements is optional, so that all these are legal format
1141 <code class="literal">%-12s</code>
1142 <code class="literal">%4c</code>
1143 <code class="literal">%.15F</code>
1144 <code class="literal">%-12.15L</code>
1146 Mutt adds some other modifiers to format strings. If you use an equals
1147 symbol (<code class="literal">=</code>) as a numeric prefix (like the minus
1148 above), it will force the string to be centered within its minimum
1149 space range. For example, <code class="literal">%=14y</code> will reserve 14
1150 characters for the %y expansion -- that's the X-Label: header, in
1151 <code class="literal">$index_format</code>. If the expansion
1152 results in a string less than 14 characters, it will be centered in a
1153 14-character space. If the X-Label for a message were "test", that
1154 expansion would look like `` test ''.
1156 There are two very little-known modifiers that affect the way that an
1157 expando is replaced. If there is an underline (``_'') character
1158 between any format modifiers (as above) and the expando letter, it will
1159 expands in all lower case. And if you use a colon (``:''), it will
1160 replace all decimal points with underlines.
1161 </p></div><div class="sect2" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="id470640"></a>29.2. Filters</h3></div></div></div><p>
1162 Any format string ending in a vertical bar (``|'') will be
1163 expanded and piped through the first word in the string, using spaces
1164 as separator. The string returned will be used for display.
1165 If the returned string ends in %, it will be passed through
1166 the formatter a second time. This allows the filter to generate a
1167 replacement format string including % expandos.
1169 All % expandos in a format string are expanded before the script
1171 </p><pre class="screen">
1172 set status_format="script.sh '%r %f (%L)'|"
1174 will make mutt expand <code class="literal">%r</code>,
1175 <code class="literal">%f</code> and <code class="literal">%L</code>
1176 before calling the script. The example also shows that arguments can be
1177 quoted: the script will receive the expanded string between the single quotes
1178 as the only argument.
1180 A practical example is the <code class="literal">mutt_xtitle</code>
1181 script installed in the <code class="literal">samples</code>
1182 subdirectory of the mutt documentation: it can be used as filter for
1183 <code class="literal">$status_format</code> to set the current
1184 terminal's title, if supported.
1185 </p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gettingstarted.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="advancedusage.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. Getting Started </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 4. Advanced Usage</td></tr></table></div></body></html>
projects / software / mutt-debian.git / blob