]> git.llucax.com Git - software/mutt-debian.git/blob - obj-i486-linux-gnu/doc/muttrc.man
noted all fixed bugs
[software/mutt-debian.git] / obj-i486-linux-gnu / doc / muttrc.man
1 '\" t
2 .\" -*-nroff-*-
3 .\"
4 .\"     Copyright (C) 1996-2000 Michael R. Elkins <me@cs.hmc.edu>
5 .\"     Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
6 .\" 
7 .\"     This program is free software; you can redistribute it and/or modify
8 .\"     it under the terms of the GNU General Public License as published by
9 .\"     the Free Software Foundation; either version 2 of the License, or
10 .\"     (at your option) any later version.
11 .\" 
12 .\"     This program is distributed in the hope that it will be useful,
13 .\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
14 .\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 .\"     GNU General Public License for more details.
16 .\" 
17 .\"     You should have received a copy of the GNU General Public License
18 .\"     along with this program; if not, write to the Free Software
19 .\"     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
20 .\"
21 .TH muttrc 5 "September 2002" Unix "User Manuals"
22 .SH NAME
23 muttrc \- Configuration file for the Mutt Mail User Agent
24 .SH DESCRIPTION
25 .PP
26 A mutt configuration file consists of a series of \(lqcommands\(rq.
27 Each line of the file may contain one or more commands.  When
28 multiple commands are used, they must be separated by a semicolon
29 (\(lq\fB;\fP\(rq).
30 .PP
31 The hash mark, or pound sign (\(lq\fB#\fP\(rq), is used as a
32 \(lqcomment\(rq character. You can use it to annotate your
33 initialization file. All text after the comment character to the end
34 of the line is ignored.
35 .PP
36 Single quotes (\(lq\fB'\fP\(rq) and double quotes (\(lq\fB"\fP\(rq)
37 can be used to quote strings which contain spaces or other special
38 characters.  The difference between the two types of quotes is
39 similar to that of many popular shell programs, namely that a single
40 quote is used to specify a literal string (one that is not
41 interpreted for shell variables or quoting with a backslash [see
42 next paragraph]), while double quotes indicate a string which
43 should be evaluated.  For example, backticks are evaluated inside of
44 double quotes, but not single quotes.
45 .PP
46 \fB\(rs\fP quotes the next character, just as in shells such as bash and zsh.
47 For example, if want to put quotes (\(lq\fB"\fP\(rq) inside of a
48 string, you can use \(lq\fB\(rs\fP\(rq to force the next character
49 to be a literal instead of interpreted character.
50 .PP
51 \(lq\fB\(rs\(rs\fP\(rq means to insert a literal \(lq\fB\(rs\fP\(rq into the
52 line.  \(lq\fB\(rsn\fP\(rq and \(lq\fB\(rsr\fP\(rq have their usual
53 C meanings of linefeed and carriage-return, respectively.
54 .PP
55 A \(lq\fB\(rs\fP\(rq at the end of a line can be used to split commands over
56 multiple lines, provided that the split points don't appear in the
57 middle of command names.
58 .PP
59 It is also possible to substitute the output of a Unix command in an
60 initialization file.  This is accomplished by enclosing the command
61 in backticks (\fB`\fP\fIcommand\fP\fB`\fP).
62 .PP
63 UNIX environment variables can be accessed like the way it is done in shells
64 like sh and bash: Prepend the name of the variable by a dollar
65 (\(lq\fB\(Do\fP\(rq) sign.
66 .PP
67 .SH COMMANDS
68 .PP
69 .nf
70 \fBalias\fP [\fB-group\fP \fIname\fP [...]] \fIkey\fP \fIaddress\fP [\fB,\fP \fIaddress\fP [ ... ]]
71 \fBunalias\fP [\fB * \fP | \fIkey\fP ]
72 .fi
73 .IP
74 \fBalias\fP defines an alias \fIkey\fP for the given addresses. Each
75 \fIaddress\fP will be resolved into either an email address (user@example.com)
76 or a named email address (User Name <user@example.com>). The address may be specified in either format, or in the format \(lquser@example.com (User
77 Name)\(rq.
78 \fBunalias\fP removes the alias corresponding to the given \fIkey\fP or
79 all aliases when \(lq\fB*\fP\(rq is used as an argument. The optional
80 \fB-group\fP argument to \fBalias\fP causes the aliased address(es) to be
81 added to the named \fIgroup\fP.
82 .PP
83 .nf
84 \fBgroup\fP [\fB-group\fP \fIname\fP] [\fB-rx\fP \fIEXPR\fP [ \fI...\fP ]] [\fB-addr\fP \fIaddress\fP [ \fI...\fP ]]
85 \fBungroup\fP [\fB-group\fP \fIname\fP ] [ \fB*\fP | [[\fB-rx\fP \fIEXPR\fP [ \fI...\fP ]] [\fB-addr\fP \fIaddress\fP [ \fI...\fP ]]]
86 .fi
87 .IP
88 \fBgroup\fP is used to directly add either addresses or regular expressions to
89 the specified group or groups. The different categories of arguments to the
90 \fBgroup\fP command can be in any order. The flags \fI-rx\fP and \fI-addr\fP
91 specify what the following strings (that cannot begin with a hyphen) should be
92 interpreted as: either a regular expression or an email address, respectively.
93 \fBungroup\fP is used to remove addresses or regular expressions from the
94 specified group or groups. The syntax is similar to the \fBgroup\fP command,
95 however the special character \fB*\fP can be used to empty a group of all of
96 its contents.
97 .IP
98 These address groups can also be created implicitly by the \fBalias\fP, \fBlists\fP,
99 \fBsubscribe\fP and \fBalternates\fP commands by specifying the optional \fI-group\fP
100 option.
101 .IP
102 Once defined, these address groups can be used in patterns to search for and limit the
103 display to messages matching a group.
104 .PP
105 .nf
106 \fBalternates\fP [\fB-group\fP \fIname\fP] \fIregexp\fP [ \fB,\fP \fIregexp\fP [ ... ]]
107 \fBunalternates\fP [\fB * \fP | \fIregexp\fP [ \fB,\fP \fIregexp\fP [ ... ]] ]
108 .fi
109 .IP
110 \fBalternates\fP is used to inform mutt about alternate addresses
111 where you receive mail; you can use regular expressions to specify
112 alternate addresses.  This affects mutt's idea about messages
113 from you, and messages addressed to you.  \fBunalternates\fP removes
114 a regular expression from the list of known alternates. The \fB-group\fP flag
115 causes all of the subsequent regular expressions to be added to the named group.
116 .PP
117 .nf
118 \fBalternative_order\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
119 \fBunalternative_order\fP [\fB * \fP | \fItype\fP/\fIsubtype\fP] [...]
120 .fi
121 .IP
122 \fBalternative_order\fP command permits you to define an order of preference which is
123 used by mutt to determine which part of a
124 \fBmultipart/alternative\fP body to display.
125 A subtype of \(lq\fB*\fP\(rq matches any subtype, as does an empty
126 subtype.   \fBunalternative_order\fP removes entries from the
127 ordered list or deletes the entire list when \(lq\fB*\fP\(rq is used
128 as an argument.
129 .PP
130 .nf
131 \fBauto_view\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
132 \fBunauto_view\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
133 .fi
134 .IP
135 This commands permits you to specify that mutt should automatically
136 convert the given MIME types to text/plain when displaying messages.
137 For this to work, there must be a 
138 .BR mailcap (5)
139 entry for the given MIME type with the 
140 .B copiousoutput
141 flag set.  A subtype of \(lq\fB*\fP\(rq 
142 matches any subtype, as does an empty subtype.
143 .PP
144 .nf
145 \fBmime_lookup\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
146 \fBunmime_lookup\fP \fItype\fP[\fB/\fP\fIsubtype\fP] [ ... ]
147 .fi
148 .IP
149 This command permits you to define a list of "data" MIME content
150 types for which mutt will try to determine the actual file type from
151 the file name, and not use a 
152 .BR mailcap (5)
153 entry given for the original MIME type.  For instance, you may add
154 the \fBapplication/octet-stream\fP MIME type to this list.
155 .TP
156 \fBbind\fP \fImap1,map2,...\fP \fIkey\fP \fIfunction\fP
157 This command binds the given \fIkey\fP for the given \fImap\fP or maps
158 to the given \fIfunction\fP. Multiple maps may be specified by
159 separating them with commas (no whitespace is allowed).
160 .IP
161 Valid maps are:
162 .BR generic ", " alias ", " attach ", " 
163 .BR browser ", " editor ", "
164 .BR index ", " compose ", " 
165 .BR pager ", " pgp ", " postpone ", "
166 .BR mix .
167 .IP
168 For more information on keys and functions, please consult the Mutt
169 Manual.
170 .TP
171 \fBaccount-hook\fP [\fB!\fP]\fIregexp\fP \fIcommand\fP
172 This hook is executed whenever you access a remote mailbox. Useful
173 to adjust configuration settings to different IMAP or POP servers.
174 .TP
175 \fBcharset-hook\fP \fIalias\fP \fIcharset\fP
176 This command defines an alias for a character set.  This is useful
177 to properly display messages which are tagged with a character set
178 name not known to mutt.
179 .TP
180 \fBiconv-hook\fP \fIcharset\fP \fIlocal-charset\fP
181 This command defines a system-specific name for a character set.
182 This is useful when your system's 
183 .BR iconv (3)
184 implementation does not understand MIME character set names (such as 
185 .BR iso-8859-1 ),
186 but instead insists on being fed with implementation-specific
187 character set names (such as
188 .BR 8859-1 ).
189 In this specific case, you'd put this into your configuration file:
190 .IP
191 .B "iconv-hook iso-8859-1 8859-1"
192 .TP
193 \fBmessage-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
194 Before mutt displays (or formats for replying or forwarding) a
195 message which matches the given \fIpattern\fP (or, when it is
196 preceded by an exclamation mark, does not match the \fIpattern\fP),
197 the given \fIcommand\fP is executed.  When multiple
198 \fBmessage-hook\fPs match, they are  executed  in  the order in
199 which they occur in the configuration file.
200 .TP
201 \fBfolder-hook\fP [\fB!\fP]\fIregexp\fP \fIcommand\fP
202 When mutt enters a folder which matches \fIregexp\fP (or, when
203 \fIregexp\fP is preceded by an exclamation mark, does not match
204 \fIregexp\fP), the given \fIcommand\fP is executed.
205 .IP
206 When several \fBfolder-hook\fPs match a given mail folder, they are
207 executed in the order given in the configuration file.
208 .TP
209 \fBmacro\fP \fImap\fP \fIkey\fP \fIsequence\fP [ \fIdescription\fP ]
210 This command binds the given \fIsequence\fP of keys to the given
211 \fIkey\fP in the given \fImap\fP or maps.  For valid maps, see \fBbind\fP. To
212 specify multiple maps, put only a comma between the maps.
213 .PP
214 .nf
215 \fBcolor\fP \fIobject\fP \fIforeground\fP \fIbackground\fP [ \fI regexp\fP ]
216 \fBcolor\fP index \fIforeground\fP \fIbackground\fP [ \fI pattern\fP ]
217 \fBuncolor\fP index \fIpattern\fP [ \fIpattern\fP ... ]
218 .fi
219 .IP
220 If your terminal supports color, these commands can be used to
221 assign \fIforeground\fP/\fIbackground\fP combinations to certain
222 objects.  Valid objects are:
223 .BR attachment ", " body ", " bold ", " header ", "
224 .BR hdrdefault ", " index ", " indicator ", " markers ", "
225 .BR message ", " normal ", " quoted ", " quoted\fIN\fP ", "
226 .BR search ", " signature ", " status ", " tilde ", " tree ", "
227 .BR underline .
228 The
229 .BR body " and " header
230 objects allow you to restrict the colorization to a regular
231 expression.  The \fBindex\fP object permits you to select colored
232 messages by pattern.
233 .IP
234 Valid colors include:
235 .BR white ", " black ", " green ", " magenta ", " blue ", "
236 .BR cyan ", " yellow ", " red ", " default ", " color\fIN\fP .
237 .PP
238 .nf
239 \fBmono\fP \fIobject\fP \fIattribute\fP [ \fIregexp\fP ]
240 \fBmono\fP index \fIattribute\fP [ \fIpattern\fP ]
241 .fi
242 .IP
243 For terminals which don't support color, you can still assign
244 attributes to objects.  Valid attributes include:
245 .BR none ", " bold ", " underline ", " 
246 .BR reverse ", and " standout .
247 .TP
248 [\fBun\fP]\fBignore\fP \fIpattern\fP [ \fIpattern\fP ... ]
249 The \fBignore\fP command permits you to specify header fields which
250 you usually don't wish to see.  Any header field whose tag
251 \fIbegins\fP with an \(lqignored\(rq pattern will be ignored.
252 .IP
253 The \fBunignore\fP command permits you to define exceptions from
254 the above mentioned list of ignored headers.
255 .PP
256 .nf
257 \fBlists\fP [\fB-group\fP \fIname\fP] \fIregexp\fP [ \fIregexp\fP ... ]
258 \fBunlists\fP \fIregexp\fP [ \fIregexp\fP ... ]
259 \fBsubscribe\fP [\fB-group\fP \fIname\fP] \fIregexp\fP [ \fIregexp\fP ... ]
260 \fBunsubscribe\fP \fIregexp\fP [ \fIregexp\fP ... ]
261 .fi
262 .IP
263 Mutt maintains two lists of mailing list address patterns, a list of
264 subscribed mailing lists, and a list of known mailing lists.  All
265 subscribed mailing lists are known.  Patterns use regular expressions.
266 .IP
267 The \fBlists\fP command adds a mailing list address to the list of
268 known mailing lists.  The \fBunlists\fP command removes a mailing
269 list from the lists of known and subscribed mailing lists.  The
270 \fBsubscribe\fP command adds a mailing list to the lists of known
271 and subscribed mailing lists.  The \fBunsubscribe\fP command removes
272 it from the list of subscribed mailing lists. The \fb-group\fP flag
273 adds all of the subsequent regular expressions to the named group.
274 .TP
275 \fBmbox-hook\fP [\fB!\fP]\fIpattern\fP \fImailbox\fP
276 When mutt changes to a mail folder which matches \fIpattern\fP,
277 \fImailbox\fP will be used as the \(lqmbox\(rq folder, i.e., read
278 messages will be moved to that folder when the mail folder is left.
279 .IP
280 The first matching \fBmbox-hook\fP applies.
281 .PP
282 .nf
283 \fBmailboxes\fP \fIfilename\fP [ \fIfilename\fP ... ]
284 \fBunmailboxes\fP [ \fB*\fP | \fIfilename\fP ... ]
285 .fi
286 .IP
287 The \fBmailboxes\fP specifies folders which can receive mail and which will
288 be checked for new messages.  When changing folders, pressing space
289 will cycle through folders with new mail.  The \fBunmailboxes\fP
290 command is used to remove a file name from the list of folders which
291 can receive mail.  If "\fB*\fP" is specified as the file name, the
292 list is emptied.
293 .PP
294 .nf
295 \fBmy_hdr\fP \fIstring\fP
296 \fBunmy_hdr\fP \fIfield\fP
297 .fi
298 .IP
299 Using \fBmy_hdr\fP, you can define headers which will be added to
300 the messages you compose.  \fBunmy_hdr\fP will remove the given
301 user-defined headers.
302 .TP
303 \fBhdr_order\fP \fIheader1\fP \fIheader2\fP [ ... ]
304 With this command, you can specify an order in which mutt will
305 attempt to present headers to you when viewing messages.
306 .TP
307 \fBsave-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP
308 When a message matches \fIpattern\fP, the default file name when
309 saving it will be the given \fIfilename\fP.
310 .TP
311 \fBfcc-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP
312 When an outgoing message matches \fIpattern\fP, the default file
313 name for storing a copy (fcc) will be the given \fIfilename\fP.
314 .TP
315 \fBfcc-save-hook\fP [\fB!\fP]\fIpattern\fP \fIfilename\fP
316 This command is an abbreviation for identical \fBfcc-hook\fP and
317 \fBsave-hook\fP commands.
318 .TP
319 \fBsend-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
320 When composing a message matching \fIpattern\fP, \fIcommand\fP is
321 executed.  When multiple \fBsend-hook\fPs match, they are executed
322 in the order in which they occur in the configuration file.
323 .TP
324 \fBsend2-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
325 Whenever a message matching \fIpattern\fP is changed (either by
326 editing it or by using the compose menu), \fIcommand\fP
327 is executed. When multiple \fBsend2-hook\fPs match, they are
328 executed in the order in which they occur in the configuration file.
329 Possible applications include setting the $sendmail variable when a
330 message's from header is changed.
331 .IP
332 \fBsend2-hook\fP execution is not triggered by use of
333 \fBenter-command\fP from the compose menu.
334 .TP
335 \fBreply-hook\fP [\fB!\fP]\fIpattern\fP \fIcommand\fP
336 When replying to a message matching \fIpattern\fP, \fIcommand\fP is
337 executed.  When multiple \fBreply-hook\fPs match, they are executed
338 in the order in which they occur in the configuration file, but all
339 \fBreply-hook\fPs are matched and executed before \fBsend-hook\fPs,
340 regardless of their order in the configuration file.
341 .TP
342 \fBcrypt-hook\fP \fIpattern\fP \fIkey-id\fP
343 The crypt-hook command provides a method by which you can
344 specify the ID of the public key to be used when encrypting messages
345 to a certain recipient.  The meaning of "key ID" is to be taken
346 broadly: This can be a different e-mail address, a numerical key ID,
347 or even just an arbitrary search string.
348 .PP
349 .nf
350 \fBopen-hook\fP \fIregexp\fP "\fIcommand\fP"
351 \fBclose-hook\fP \fIregexp\fP "\fIcommand\fP"
352 \fBappend-hook\fP \fIregexp\fP "\fIcommand\fP"
353 .fi
354 .IP
355 These commands provide a way to handle compressed folders. The given
356 \fBregexp\fP specifies which folders are taken as compressed (e.g.
357 "\fI\\\\.gz$\fP"). The commands tell Mutt how to uncompress a folder
358 (\fBopen-hook\fP), compress a folder (\fBclose-hook\fP) or append a
359 compressed mail to a compressed folder (\fBappend-hook\fP). The
360 \fIcommand\fP string is the 
361 .BR printf (3)
362 like format string, and it should accept two parameters: \fB%f\fP,
363 which is replaced with the (compressed) folder name, and \fB%t\fP
364 which is replaced with the name of the temporary folder to which to
365 write.
366 .TP
367 \fBpush\fP \fIstring\fP
368 This command adds the named \fIstring\fP to the keyboard buffer.
369 .PP
370 .nf
371 \fBset\fP [\fBno\fP|\fBinv\fP|\fB&\fP|\fB?\fP]\fIvariable\fP[=\fIvalue\fP] [ ... ]
372 \fBtoggle\fP \fIvariable\fP [ ... ]
373 \fBunset\fP \fIvariable\fP [ ... ]
374 \fBreset\fP \fIvariable\fP [ ... ]
375 .fi
376 .IP
377 These commands are used to set and manipulate configuration
378 variables.
379 .IP
380 Mutt knows four basic types of variables: boolean, number, string
381 and quadoption.  Boolean variables can be \fBset\fP (true),
382 \fBunset\fP (false), or \fBtoggle\fPd. Number variables can be assigned
383 a positive integer value.
384 .IP
385 String variables consist of any number of printable characters.
386 Strings must be enclosed in quotes if they contain spaces or tabs.
387 You may also use the \(lqC\(rq escape sequences \fB\\n\fP and
388 \fB\\t\fP for newline and tab, respectively.
389 .IP
390 Quadoption variables are used to control whether or not to be
391 prompted for certain actions, or to specify a default action.  A
392 value of \fByes\fP will cause the action to be carried out automatically
393 as if you had answered yes to the question.  Similarly, a value of
394 \fBno\fP will cause the the action to be carried out as if you had
395 answered \(lqno.\(rq A value of \fBask-yes\fP will cause a prompt
396 with a default answer of \(lqyes\(rq and \fBask-no\fP will provide a
397 default answer of \(lqno.\(rq
398 .IP
399 The \fBreset\fP command resets all given variables to the compile
400 time defaults.  If you reset the special variable \fBall\fP, all
401 variables will reset to their compile time defaults.
402 .TP
403 \fBsource\fP \fIfilename\fP
404 The given file will be evaluated as a configuration file.
405 .TP
406 .nf
407 \fBspam\fP \fIpattern\fP \fIformat\fP
408 \fBnospam\fP \fIpattern\fP
409 .fi
410 These commands define spam-detection patterns from external spam
411 filters, so that mutt can sort, limit, and search on
412 ``spam tags'' or ``spam attributes'', or display them
413 in the index. See the Mutt manual for details.
414 .TP
415 \fBunhook\fP [\fB * \fP | \fIhook-type\fP ]
416 This command will remove all hooks of a given type, or all hooks
417 when \(lq\fB*\fP\(rq is used as an argument.  \fIhook-type\fP
418 can be any of the \fB-hook\fP commands documented above.
419 .SH PATTERNS
420 .PP
421 In various places with mutt, including some of the abovementioned
422 \fBhook\fP commands, you can specify patterns to match messages.
423 .SS Constructing Patterns
424 .PP
425 A simple pattern consists of an operator of the form
426 \(lq\fB~\fP\fIcharacter\fP\(rq, possibly followed by a parameter
427 against which mutt is supposed to match the object specified by
428 this operator.  For some \fIcharacter\fPs, the \fB~\fP may be
429 replaced by another character to alter the behavior of the match.
430 These are described in the list of operators, below.
431 .PP
432 With some of these operators, the object to be matched consists of
433 several e-mail addresses.  In these cases, the object is matched if
434 at least one of these e-mail addresses matches. You can prepend a
435 hat (\(lq\fB^\fP\(rq) character to such a pattern to indicate that
436 \fIall\fP addresses must match in order to match the object.
437 .PP
438 You can construct complex patterns by combining simple patterns with
439 logical operators.  Logical AND is specified by simply concatenating
440 two simple patterns, for instance \(lq~C mutt-dev ~s bug\(rq.
441 Logical OR is specified by inserting a vertical bar (\(lq\fB|\fP\(rq)
442 between two patterns, for instance \(lq~C mutt-dev | ~s bug\(rq.
443 Additionally, you can negate a pattern by prepending a bang
444 (\(lq\fB!\fP\(rq) character.  For logical grouping, use braces
445 (\(lq()\(rq). Example: \(lq!(~t mutt|~c mutt) ~f elkins\(rq.
446 .SS Simple Patterns
447 .PP
448 Mutt understands the following simple patterns:
449 .P
450 .PD 0
451 .TP 12
452 ~A
453 all messages
454 .TP
455 ~b \fIEXPR\fP
456 messages which contain \fIEXPR\fP in the message body.
457 .TP
458 =b \fISTRING\fP
459 messages which contain \fISTRING\fP in the message body. If IMAP is enabled, searches for \fISTRING\fP on the server, rather than downloading each message and searching it locally.
460 .TP
461 ~B \fIEXPR\fP
462 messages which contain \fIEXPR\fP in the whole message.
463 .TP
464 ~c \fIEXPR\fP
465 messages carbon-copied to \fIEXPR\fP
466 .TP
467 %c \fIGROUP\fP
468 messages carbon-copied to any member of \fIGROUP\fP
469 .TP
470 ~C \fIEXPR\fP
471 messages either to: or cc: \fIEXPR\fP
472 .TP
473 %C \fIGROUP\fP
474 messages either to: or cc: to any member of \fIGROUP\fP
475 .TP
476 ~d \fIMIN\fP-\fIMAX\fP
477 messages with \(lqdate-sent\(rq in a Date range
478 .TP
479 ~D
480 deleted messages
481 .TP
482 ~e \fIEXPR\fP
483 messages which contain \fIEXPR\fP in the \(lqSender\(rq field
484 .TP
485 %e \fIGROUP\fP
486 messages which contain a member of \fIGROUP\fP in the \(lqSender\(rq field
487 .TP
488 ~E
489 expired messages
490 .TP
491 ~f \fIEXPR\fP
492 messages originating from \fIEXPR\fP
493 .TP
494 %f \fIGROUP\fP
495 messages originating form any member of \fIGROUP\fP
496 .TP
497 ~F
498 flagged messages
499 .TP
500 ~g
501 PGP signed messages
502 .TP
503 ~G
504 PGP encrypted messages
505 .TP
506 ~h \fIEXPR\fP
507 messages which contain \fIEXPR\fP in the message header
508 .TP
509 ~H \fIEXPR\fP
510 messages with spam tags matching \fIEXPR\fP
511 .TP
512 ~i \fIEXPR\fP
513 messages which match \fIEXPR\fP in the \(lqMessage-ID\(rq field
514 .TP
515 ~k
516 messages containing PGP key material
517 .TP
518 ~l
519 messages addressed to a known mailing list (defined by either \fBsubscribe\fP or \fBlist\fP)
520 .TP
521 ~L \fIEXPR\fP
522 messages either originated or received by \fIEXPR\fP
523 .TP
524 %L \fIGROUP\fP
525 messages either originated or received by any member of \fIGROUP\fP
526 .TP
527 ~m \fIMIN\fP-\fIMAX\fP
528 message in the range \fIMIN\fP to \fIMAX\fP
529 .TP
530 ~n \fIMIN\fP-\fIMAX\fP
531 messages with a score in the range \fIMIN\fP to \fIMAX\fP
532 .TP
533 ~N
534 new messages
535 .TP
536 ~O
537 old messages
538 .TP
539 ~p
540 messages addressed to you (as defined by \fBalternates\fP)
541 .TP
542 ~P
543 messages from you (as defined by \fBalternates\fP)
544 .TP
545 ~Q
546 messages which have been replied to
547 .TP
548 ~r \fIMIN\fP-\fIMAX\fP
549 messages with \(lqdate-received\(rq in a Date range
550 .TP
551 ~R
552 read messages
553 .TP
554 ~s \fIEXPR\fP
555 messages having \fIEXPR\fP in the \(lqSubject\(rq field.
556 .TP
557 ~S
558 superseded messages
559 .TP
560 ~t \fIEXPR\fP
561 messages addressed to \fIEXPR\fP
562 .TP
563 ~T
564 tagged messages
565 .TP
566 ~u
567 messages addressed to a subscribed mailing list (defined by \fBsubscribe\fP commands)
568 .TP
569 ~U
570 unread messages
571 .TP
572 ~v
573 message is part of a collapsed thread.
574 .TP
575 ~V
576 cryptographically verified messages
577 .TP
578 ~x \fIEXPR\fP
579 messages which contain \fIEXPR\fP in the \(lqReferences\(rq field
580 .TP
581 ~X \fIMIN\fP-\fIMAX\fP
582 messages with MIN - MAX attachments
583 .TP
584 ~y \fIEXPR\fP
585 messages which contain \fIEXPR\fP in the \(lqX-Label\(rq field
586 .TP
587 ~z \fIMIN\fP-\fIMAX\fP
588 messages with a size in the range \fIMIN\fP to \fIMAX\fP
589 .TP
590 ~=
591 duplicated messages (see $duplicate_threads)
592 .TP
593 ~$
594 unreferenced message (requires threaded view)
595 .TP
596 ~(PATTERN)
597 messages in threads containing messages matching a certain pattern, e.g. all threads containing messages from you: ~(~P)
598 .PD 1
599 .DT
600 .PP
601 In the above, \fIEXPR\fP is a regular expression.
602 .PP
603 With the \fB~m\fP, \fB~n\fP, \fB~X\fP, and \fB~z\fP operators, you can also
604 specify ranges in the forms \fB<\fP\fIMAX\fP, \fB>\fP\fIMIN\fP,
605 \fIMIN\fP\fB-\fP, and \fB-\fP\fIMAX\fP.
606 .SS Matching dates
607 .PP
608 The \fB~d\fP and \fB~r\fP operators are used to match date ranges,
609 which are interpreted to be given in your local time zone.
610 .PP
611 A date is of the form
612 \fIDD\fP[\fB/\fP\fIMM\fP[\fB/\fP[\fIcc\fP]\fIYY\fP]], that is, a
613 two-digit date, optionally followed by a two-digit month, optionally
614 followed by a year specifications.  Omitted fields default to the
615 current month and year.
616 .PP
617 Mutt understands either two or four digit year specifications.  When
618 given a two-digit year, mutt will interpret values less than 70 as
619 lying in the 21st century (i.e., \(lq38\(rq means 2038 and not 1938,
620 and \(lq00\(rq is interpreted as 2000), and values
621 greater than or equal to 70 as lying in the 20th century.
622 .PP
623 Note that this behaviour \fIis\fP Y2K compliant, but that mutt
624 \fIdoes\fP have a Y2.07K problem.
625 .PP
626 If a date range consists of a single date, the operator in question
627 will match that precise date.  If the date range consists of a dash
628 (\(lq\fB-\fP\(rq), followed by a date, this range will match any
629 date before and up to the date given.  Similarly, a date followed by
630 a dash matches the date given and any later point of time.  Two
631 dates, separated by a dash, match any date which lies in the given
632 range of time.
633 .PP
634 You can also modify any absolute date by giving an error range.  An
635 error range consists of one of the characters
636 .BR + ,
637 .BR - ,
638 .BR * ,
639 followed by a positive number, followed by one of the unit
640 characters
641 .BR y ,
642 .BR m ,
643 .BR w ", or"
644 .BR d ,
645 specifying a unit of years, months, weeks, or days.  
646 .B +
647 increases the maximum date matched by the given interval of time,
648 .B - 
649 decreases the minimum date matched by the given interval of time, and
650 .B *
651 increases the maximum date and decreases the minimum date matched by
652 the given interval of time.  It is possible to give multiple error
653 margins, which cumulate.  Example:
654 .B "1/1/2001-1w+2w*3d"
655 .PP
656 You can also specify offsets relative to the current date.  An
657 offset is specified as one of the characters
658 .BR < ,
659 .BR > ,
660 .BR = ,
661 followed by a positive number, followed by one of the unit
662 characters
663 .BR y ,
664 .BR m ,
665 .BR w ", or"
666 .BR d .
667 .B >
668 matches dates which are older than the specified amount of time, an
669 offset which begins with the character
670 .B < 
671 matches dates which are more recent than the specified amount of time,
672 and an offset which begins with the character
673 .B =
674 matches points of time which are precisely the given amount of time
675 ago.
676 .SH CONFIGURATION VARIABLES
677
678 .TP
679 .B abort_nosubject
680 .nf
681 Type: quadoption
682 Default: ask\-yes
683 .fi
684 .IP
685 If set to \fIyes\fP, when composing messages and no subject is given
686 at the subject prompt, composition will be aborted.  If set to
687 \fIno\fP, composing messages with no subject given at the subject
688 prompt will never be aborted.
689
690
691 .TP
692 .B abort_unmodified
693 .nf
694 Type: quadoption
695 Default: yes
696 .fi
697 .IP
698 If set to \fIyes\fP, composition will automatically abort after
699 editing the message body if no changes are made to the file (this
700 check only happens after the \fIfirst\fP edit of the file).  When set
701 to \fIno\fP, composition will never be aborted.
702
703
704 .TP
705 .B alias_file
706 .nf
707 Type: path
708 Default: \(lq~/.muttrc\(rq
709 .fi
710 .IP
711 The default file in which to save aliases created by the
712 \fC<create-alias>\fP function. Entries added to this file are
713 encoded in the character set specified by $config_charset if it
714 is \fIset\fP or the current character set otherwise.
715 .IP
716 \fBNote:\fP Mutt will not automatically source this file; you must
717 explicitly use the \(lqsource\(rq command for it to be executed in case
718 this option points to a dedicated alias file.
719 .IP
720 The default for this option is the currently used muttrc file, or
721 \(lq~/.muttrc\(rq if no user muttrc was found.
722
723
724 .TP
725 .B alias_format
726 .nf
727 Type: string
728 Default: \(lq%4n %2f %t %\-10a   %r\(rq
729 .fi
730 .IP
731 Specifies the format of the data displayed for the \(lqalias\(rq menu.  The
732 following \fCprintf(3)\fP\-style sequences are available:
733 .RS
734 .PD 0
735 .TP
736 %a 
737 alias name
738 .TP
739 %f 
740 flags \- currently, a \(lqd\(rq for an alias marked for deletion
741 .TP
742 %n 
743 index number
744 .TP
745 %r 
746 address which alias expands to
747 .TP
748 %t 
749 character which indicates if the alias is tagged for inclusion
750 .RE
751 .PD 1
752
753 .TP
754 .B allow_8bit
755 .nf
756 Type: boolean
757 Default: yes
758 .fi
759 .IP
760 Controls whether 8\-bit data is converted to 7\-bit using either Quoted\-
761 Printable or Base64 encoding when sending mail.
762
763
764 .TP
765 .B allow_ansi
766 .nf
767 Type: boolean
768 Default: no
769 .fi
770 .IP
771 Controls whether ANSI color codes in messages (and color tags in
772 rich text messages) are to be interpreted.
773 Messages containing these codes are rare, but if this option is \fIset\fP,
774 their text will be colored accordingly. Note that this may override
775 your color choices, and even present a security problem, since a
776 message could include a line like
777
778 .IP
779 .DS
780 .sp
781 .ft CR
782 .nf
783 [\-\- PGP output follows ...
784
785 .fi
786 .ec
787 .ft P
788 .sp
789 .IP
790 and give it the same color as your attachment color (see also
791 $crypt_timestamp).
792
793
794 .TP
795 .B arrow_cursor
796 .nf
797 Type: boolean
798 Default: no
799 .fi
800 .IP
801 When \fIset\fP, an arrow (\(lq\->\(rq) will be used to indicate the current entry
802 in menus instead of highlighting the whole line.  On slow network or modem
803 links this will make response faster because there is less that has to
804 be redrawn on the screen when moving to the next or previous entries
805 in the menu.
806
807
808 .TP
809 .B ascii_chars
810 .nf
811 Type: boolean
812 Default: no
813 .fi
814 .IP
815 If \fIset\fP, Mutt will use plain ASCII characters when displaying thread
816 and attachment trees, instead of the default \fIACS\fP characters.
817
818
819 .TP
820 .B askbcc
821 .nf
822 Type: boolean
823 Default: no
824 .fi
825 .IP
826 If \fIset\fP, Mutt will prompt you for blind\-carbon\-copy (Bcc) recipients
827 before editing an outgoing message.
828
829
830 .TP
831 .B askcc
832 .nf
833 Type: boolean
834 Default: no
835 .fi
836 .IP
837 If \fIset\fP, Mutt will prompt you for carbon\-copy (Cc) recipients before
838 editing the body of an outgoing message.
839
840
841 .TP
842 .B assumed_charset
843 .nf
844 Type: string
845 Default: \(lq\(rq
846 .fi
847 .IP
848 This variable is a colon\-separated list of character encoding
849 schemes for messages without character encoding indication.
850 Header field values and message body content without character encoding
851 indication would be assumed that they are written in one of this list.
852 By default, all the header fields and message body without any charset
853 indication are assumed to be in \(lqus\-ascii\(rq.
854 .IP
855 For example, Japanese users might prefer this:
856
857 .IP
858 .DS
859 .sp
860 .ft CR
861 .nf
862 set assumed_charset=\(rqiso\-2022\-jp:euc\-jp:shift_jis:utf\-8\(rq
863
864 .fi
865 .ec
866 .ft P
867 .sp
868 .IP
869 However, only the first content is valid for the message body.
870
871
872 .TP
873 .B attach_charset
874 .nf
875 Type: string
876 Default: \(lq\(rq
877 .fi
878 .IP
879 This variable is a colon\-separated list of character encoding
880 schemes for text file attachments. Mutt uses this setting to guess
881 which encoding files being attached are encoded in to convert them to
882 a proper character set given in $send_charset.
883 .IP
884 If \fIunset\fP, the value of $charset will be used instead.
885 For example, the following configuration would work for Japanese
886 text handling:
887
888 .IP
889 .DS
890 .sp
891 .ft CR
892 .nf
893 set attach_charset=\(rqiso\-2022\-jp:euc\-jp:shift_jis:utf\-8\(rq
894
895 .fi
896 .ec
897 .ft P
898 .sp
899 .IP
900 Note: for Japanese users, \(lqiso\-2022\-*\(rq must be put at the head
901 of the value as shown above if included.
902
903
904 .TP
905 .B attach_format
906 .nf
907 Type: string
908 Default: \(lq%u%D%I %t%4n %T%.40d%> [%.7m/%.10M, %.6e%?C?, %C?, %s] \(rq
909 .fi
910 .IP
911 This variable describes the format of the \(lqattachment\(rq menu.  The
912 following \fCprintf(3)\fP\-style sequences are understood:
913 .RS
914 .PD 0
915 .TP
916 %C  
917 charset
918 .TP
919 %c  
920 requires charset conversion (\(lqn\(rq or \(lqc\(rq)
921 .TP
922 %D  
923 deleted flag
924 .TP
925 %d  
926 description
927 .TP
928 %e  
929 MIME content\-transfer\-encoding
930 .TP
931 %f  
932 filename
933 .TP
934 %I  
935 disposition (\(lqI\(rq for inline, \(lqA\(rq for attachment)
936 .TP
937 %m  
938 major MIME type
939 .TP
940 %M  
941 MIME subtype
942 .TP
943 %n  
944 attachment number
945 .TP
946 %Q  
947 \(lqQ\(rq, if MIME part qualifies for attachment counting
948 .TP
949 %s  
950 size
951 .TP
952 %t  
953 tagged flag
954 .TP
955 %T  
956 graphic tree characters
957 .TP
958 %u  
959 unlink (=to delete) flag
960 .TP
961 %X  
962 number of qualifying MIME parts in this part and its children
963 (please see the \(lqattachments\(rq section for possible speed effects)
964 .TP
965 %>X 
966 right justify the rest of the string and pad with character \(lqX\(rq
967 .TP
968 %|X 
969 pad to the end of the line with character \(lqX\(rq
970 .TP
971 %*X 
972 soft\-fill with character \(lqX\(rq as pad
973 .RE
974 .PD 1
975 .IP
976 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
977
978
979 .TP
980 .B attach_sep
981 .nf
982 Type: string
983 Default: \(lq\\n\(rq
984 .fi
985 .IP
986 The separator to add between attachments when operating (saving,
987 printing, piping, etc) on a list of tagged attachments.
988
989
990 .TP
991 .B attach_split
992 .nf
993 Type: boolean
994 Default: yes
995 .fi
996 .IP
997 If this variable is \fIunset\fP, when operating (saving, printing, piping,
998 etc) on a list of tagged attachments, Mutt will concatenate the
999 attachments and will operate on them as a single attachment. The
1000 $attach_sep separator is added after each attachment. When \fIset\fP,
1001 Mutt will operate on the attachments one by one.
1002
1003
1004 .TP
1005 .B attribution
1006 .nf
1007 Type: string
1008 Default: \(lqOn %d, %n wrote:\(rq
1009 .fi
1010 .IP
1011 This is the string that will precede a message which has been included
1012 in a reply.  For a full listing of defined \fCprintf(3)\fP\-like sequences see
1013 the section on $index_format.
1014
1015
1016 .TP
1017 .B autoedit
1018 .nf
1019 Type: boolean
1020 Default: no
1021 .fi
1022 .IP
1023 When \fIset\fP along with $edit_headers, Mutt will skip the initial
1024 send\-menu (prompting for subject and recipients) and allow you to
1025 immediately begin editing the body of your
1026 message.  The send\-menu may still be accessed once you have finished
1027 editing the body of your message.
1028 .IP
1029 Also see $fast_reply.
1030
1031
1032 .TP
1033 .B auto_tag
1034 .nf
1035 Type: boolean
1036 Default: no
1037 .fi
1038 .IP
1039 When \fIset\fP, functions in the \fIindex\fP menu which affect a message
1040 will be applied to all tagged messages (if there are any).  When
1041 unset, you must first use the \fC<tag\-prefix>\fP function (bound to \(lq;\(rq
1042 by default) to make the next function apply to all tagged messages.
1043
1044
1045 .TP
1046 .B beep
1047 .nf
1048 Type: boolean
1049 Default: yes
1050 .fi
1051 .IP
1052 When this variable is \fIset\fP, mutt will beep when an error occurs.
1053
1054
1055 .TP
1056 .B beep_new
1057 .nf
1058 Type: boolean
1059 Default: no
1060 .fi
1061 .IP
1062 When this variable is \fIset\fP, mutt will beep whenever it prints a message
1063 notifying you of new mail.  This is independent of the setting of the
1064 $beep variable.
1065
1066
1067 .TP
1068 .B bounce
1069 .nf
1070 Type: quadoption
1071 Default: ask\-yes
1072 .fi
1073 .IP
1074 Controls whether you will be asked to confirm bouncing messages.
1075 If set to \fIyes\fP you don't get asked if you want to bounce a
1076 message. Setting this variable to \fIno\fP is not generally useful,
1077 and thus not recommended, because you are unable to bounce messages.
1078
1079
1080 .TP
1081 .B bounce_delivered
1082 .nf
1083 Type: boolean
1084 Default: yes
1085 .fi
1086 .IP
1087 When this variable is \fIset\fP, mutt will include Delivered\-To headers when
1088 bouncing messages.  Postfix users may wish to \fIunset\fP this variable.
1089 .IP
1090 \fBNote:\fP On Debian systems, this option is unset by default in
1091 /etc/Muttrc.
1092
1093
1094 .TP
1095 .B braille_friendly
1096 .nf
1097 Type: boolean
1098 Default: no
1099 .fi
1100 .IP
1101 When this variable is \fIset\fP, mutt will place the cursor at the beginning
1102 of the current line in menus, even when the $arrow_cursor variable
1103 is \fIunset\fP, making it easier for blind persons using Braille displays to
1104 follow these menus.  The option is \fIunset\fP by default because many
1105 visual terminals don't permit making the cursor invisible.
1106
1107
1108 .TP
1109 .B check_mbox_size
1110 .nf
1111 Type: boolean
1112 Default: no
1113 .fi
1114 .IP
1115 When this variable is \fIset\fP, mutt will use file size attribute instead of
1116 access time when checking for new mail in mbox and mmdf folders.
1117 .IP
1118 This variable is \fIunset\fP by default and should only be enabled when
1119 new mail detection for these folder types is unreliable or doesn't work.
1120 .IP
1121 Note that enabling this variable should happen before any \(lqmailboxes\(rq
1122 directives occur in configuration files regarding mbox or mmdf folders
1123 because mutt needs to determine the initial new mail status of such a
1124 mailbox by performing a fast mailbox scan when it is defined.
1125 Afterwards the new mail status is tracked by file size changes.
1126
1127
1128 .TP
1129 .B charset
1130 .nf
1131 Type: string
1132 Default: \(lq\(rq
1133 .fi
1134 .IP
1135 Character set your terminal uses to display and enter textual data.
1136 It is also the fallback for $send_charset.
1137 .IP
1138 Upon startup Mutt tries to derive this value from environment variables
1139 such as \fC$LC_CTYPE\fP or \fC$LANG\fP.
1140 .IP
1141 \fBNote:\fP It should only be set in case Mutt isn't abled to determine the
1142 character set used correctly.
1143
1144
1145 .TP
1146 .B check_new
1147 .nf
1148 Type: boolean
1149 Default: yes
1150 .fi
1151 .IP
1152 \fBNote:\fP this option only affects \fImaildir\fP and \fIMH\fP style
1153 mailboxes.
1154 .IP
1155 When \fIset\fP, Mutt will check for new mail delivered while the
1156 mailbox is open.  Especially with MH mailboxes, this operation can
1157 take quite some time since it involves scanning the directory and
1158 checking each file to see if it has already been looked at.  If
1159 this variable is \fIunset\fP, no check for new mail is performed
1160 while the mailbox is open.
1161
1162
1163 .TP
1164 .B collapse_unread
1165 .nf
1166 Type: boolean
1167 Default: yes
1168 .fi
1169 .IP
1170 When \fIunset\fP, Mutt will not collapse a thread if it contains any
1171 unread messages.
1172
1173
1174 .TP
1175 .B uncollapse_jump
1176 .nf
1177 Type: boolean
1178 Default: no
1179 .fi
1180 .IP
1181 When \fIset\fP, Mutt will jump to the next unread message, if any,
1182 when the current thread is \fIun\fPcollapsed.
1183
1184
1185 .TP
1186 .B compose_format
1187 .nf
1188 Type: string
1189 Default: \(lq\-\- Mutt: Compose  [Approx. msg size: %l   Atts: %a]%>\-\(rq
1190 .fi
1191 .IP
1192 Controls the format of the status line displayed in the \(lqcompose\(rq
1193 menu.  This string is similar to $status_format, but has its own
1194 set of \fCprintf(3)\fP\-like sequences:
1195 .RS
1196 .PD 0
1197 .TP
1198 %a 
1199 total number of attachments
1200 .TP
1201 %h 
1202 local hostname
1203 .TP
1204 %l 
1205 approximate size (in bytes) of the current message
1206 .TP
1207 %v 
1208 Mutt version string
1209 .RE
1210 .PD 1
1211 .IP
1212 See the text describing the $status_format option for more
1213 information on how to set $compose_format.
1214
1215
1216 .TP
1217 .B config_charset
1218 .nf
1219 Type: string
1220 Default: \(lq\(rq
1221 .fi
1222 .IP
1223 When defined, Mutt will recode commands in rc files from this
1224 encoding to the current character set as specified by $charset
1225 and aliases written to $alias_file from the current character set.
1226 .IP
1227 Please note that if setting $charset it must be done before
1228 setting $config_charset.
1229 .IP
1230 Recoding should be avoided as it may render unconvertable
1231 characters as question marks which can lead to undesired
1232 side effects (for example in regular expressions).
1233
1234
1235 .TP
1236 .B confirmappend
1237 .nf
1238 Type: boolean
1239 Default: yes
1240 .fi
1241 .IP
1242 When \fIset\fP, Mutt will prompt for confirmation when appending messages to
1243 an existing mailbox.
1244
1245
1246 .TP
1247 .B confirmcreate
1248 .nf
1249 Type: boolean
1250 Default: yes
1251 .fi
1252 .IP
1253 When \fIset\fP, Mutt will prompt for confirmation when saving messages to a
1254 mailbox which does not yet exist before creating it.
1255
1256
1257 .TP
1258 .B connect_timeout
1259 .nf
1260 Type: number
1261 Default: 30
1262 .fi
1263 .IP
1264 Causes Mutt to timeout a network connection (for IMAP, POP or SMTP) after this
1265 many seconds if the connection is not able to be established.  A negative
1266 value causes Mutt to wait indefinitely for the connection attempt to succeed.
1267
1268
1269 .TP
1270 .B content_type
1271 .nf
1272 Type: string
1273 Default: \(lqtext/plain\(rq
1274 .fi
1275 .IP
1276 Sets the default Content\-Type for the body of newly composed messages.
1277
1278
1279 .TP
1280 .B copy
1281 .nf
1282 Type: quadoption
1283 Default: yes
1284 .fi
1285 .IP
1286 This variable controls whether or not copies of your outgoing messages
1287 will be saved for later references.  Also see $record,
1288 $save_name, $force_name and \(lqfcc-hook\(rq.
1289
1290
1291 .TP
1292 .B crypt_use_gpgme
1293 .nf
1294 Type: boolean
1295 Default: no
1296 .fi
1297 .IP
1298 This variable controls the use of the GPGME\-enabled crypto backends.
1299 If it is \fIset\fP and Mutt was built with gpgme support, the gpgme code for
1300 S/MIME and PGP will be used instead of the classic code.  Note that
1301 you need to set this option in .muttrc; it won't have any effect when
1302 used interactively.
1303
1304
1305 .TP
1306 .B crypt_use_pka
1307 .nf
1308 Type: boolean
1309 Default: no
1310 .fi
1311 .IP
1312 Controls whether mutt uses PKA
1313 (see http://www.g10code.de/docs/pka\-intro.de.pdf) during signature
1314 verification (only supported by the GPGME backend).
1315
1316
1317 .TP
1318 .B crypt_autopgp
1319 .nf
1320 Type: boolean
1321 Default: yes
1322 .fi
1323 .IP
1324 This variable controls whether or not mutt may automatically enable
1325 PGP encryption/signing for messages.  See also $crypt_autoencrypt,
1326 $crypt_replyencrypt,
1327 $crypt_autosign, $crypt_replysign and $smime_is_default.
1328
1329
1330 .TP
1331 .B crypt_autosmime
1332 .nf
1333 Type: boolean
1334 Default: yes
1335 .fi
1336 .IP
1337 This variable controls whether or not mutt may automatically enable
1338 S/MIME encryption/signing for messages. See also $crypt_autoencrypt,
1339 $crypt_replyencrypt,
1340 $crypt_autosign, $crypt_replysign and $smime_is_default.
1341
1342
1343 .TP
1344 .B date_format
1345 .nf
1346 Type: string
1347 Default: \(lq!%a, %b %d, %Y at %I:%M:%S%p %Z\(rq
1348 .fi
1349 .IP
1350 This variable controls the format of the date printed by the \(lq%d\(rq
1351 sequence in $index_format.  This is passed to the \fCstrftime(3)\fP
1352 function to process the date, see the man page for the proper syntax.
1353 .IP
1354 Unless the first character in the string is a bang (\(lq!\(rq), the month
1355 and week day names are expanded according to the locale specified in
1356 the variable $locale. If the first character in the string is a
1357 bang, the bang is discarded, and the month and week day names in the
1358 rest of the string are expanded in the \fIC\fP locale (that is in US
1359 English).
1360
1361
1362 .TP
1363 .B default_hook
1364 .nf
1365 Type: string
1366 Default: \(lq~f %s !~P | (~P ~C %s)\(rq
1367 .fi
1368 .IP
1369 This variable controls how \(lqmessage-hook\(rq, \(lqreply-hook\(rq, \(lqsend-hook\(rq,
1370 \(lqsend2-hook\(rq, \(lqsave-hook\(rq, and \(lqfcc-hook\(rq will
1371 be interpreted if they are specified with only a simple regexp,
1372 instead of a matching pattern.  The hooks are expanded when they are
1373 declared, so a hook will be interpreted according to the value of this
1374 variable at the time the hook is declared.
1375 .IP
1376 The default value matches
1377 if the message is either from a user matching the regular expression
1378 given, or if it is from you (if the from address matches
1379 \(lqalternates\(rq) and is to or cc'ed to a user matching the given
1380 regular expression.
1381
1382
1383 .TP
1384 .B delete
1385 .nf
1386 Type: quadoption
1387 Default: ask\-yes
1388 .fi
1389 .IP
1390 Controls whether or not messages are really deleted when closing or
1391 synchronizing a mailbox.  If set to \fIyes\fP, messages marked for
1392 deleting will automatically be purged without prompting.  If set to
1393 \fIno\fP, messages marked for deletion will be kept in the mailbox.
1394
1395
1396 .TP
1397 .B delete_untag
1398 .nf
1399 Type: boolean
1400 Default: yes
1401 .fi
1402 .IP
1403 If this option is \fIset\fP, mutt will untag messages when marking them
1404 for deletion.  This applies when you either explicitly delete a message,
1405 or when you save it to another folder.
1406
1407
1408 .TP
1409 .B digest_collapse
1410 .nf
1411 Type: boolean
1412 Default: yes
1413 .fi
1414 .IP
1415 If this option is \fIset\fP, mutt's received\-attachments menu will not show the subparts of
1416 individual messages in a multipart/digest.  To see these subparts, press \(lqv\(rq on that menu.
1417
1418
1419 .TP
1420 .B display_filter
1421 .nf
1422 Type: path
1423 Default: \(lq\(rq
1424 .fi
1425 .IP
1426 When set, specifies a command used to filter messages.  When a message
1427 is viewed it is passed as standard input to $display_filter, and the
1428 filtered message is read from the standard output.
1429
1430
1431 .TP
1432 .B dotlock_program
1433 .nf
1434 Type: path
1435 Default: \(lq/usr/bin/mutt_dotlock\(rq
1436 .fi
1437 .IP
1438 Contains the path of the \fCmutt_dotlock(8)\fP binary to be used by
1439 mutt.
1440
1441
1442 .TP
1443 .B dsn_notify
1444 .nf
1445 Type: string
1446 Default: \(lq\(rq
1447 .fi
1448 .IP
1449 This variable sets the request for when notification is returned.  The
1450 string consists of a comma separated list (no spaces!) of one or more
1451 of the following: \fInever\fP, to never request notification,
1452 \fIfailure\fP, to request notification on transmission failure,
1453 \fIdelay\fP, to be notified of message delays, \fIsuccess\fP, to be
1454 notified of successful transmission.
1455 .IP
1456 Example:
1457
1458 .IP
1459 .DS
1460 .sp
1461 .ft CR
1462 .nf
1463 set dsn_notify=\(rqfailure,delay\(rq
1464
1465 .fi
1466 .ec
1467 .ft P
1468 .sp
1469 .IP
1470 \fBNote:\fP when using $sendmail for delivery, you should not enable
1471 this unless you are either using Sendmail 8.8.x or greater or a MTA
1472 providing a \fCsendmail(1)\fP\-compatible interface supporting the \fC\-N\fP option
1473 for DSN. For SMTP delivery, DSN support is autodetected so that it
1474 depends on the server whether DSN will be used or not.
1475
1476
1477 .TP
1478 .B dsn_return
1479 .nf
1480 Type: string
1481 Default: \(lq\(rq
1482 .fi
1483 .IP
1484 This variable controls how much of your message is returned in DSN
1485 messages.  It may be set to either \fIhdrs\fP to return just the
1486 message header, or \fIfull\fP to return the full message.
1487 .IP
1488 Example:
1489
1490 .IP
1491 .DS
1492 .sp
1493 .ft CR
1494 .nf
1495 set dsn_return=hdrs
1496
1497 .fi
1498 .ec
1499 .ft P
1500 .sp
1501 .IP
1502 \fBNote:\fP when using $sendmail for delivery, you should not enable
1503 this unless you are either using Sendmail 8.8.x or greater or a MTA
1504 providing a \fCsendmail(1)\fP\-compatible interface supporting the \fC\-R\fP option
1505 for DSN. For SMTP delivery, DSN support is autodetected so that it
1506 depends on the server whether DSN will be used or not.
1507
1508
1509 .TP
1510 .B duplicate_threads
1511 .nf
1512 Type: boolean
1513 Default: yes
1514 .fi
1515 .IP
1516 This variable controls whether mutt, when $sort is set to \fIthreads\fP, threads
1517 messages with the same Message\-Id together.  If it is \fIset\fP, it will indicate
1518 that it thinks they are duplicates of each other with an equals sign
1519 in the thread tree.
1520
1521
1522 .TP
1523 .B edit_headers
1524 .nf
1525 Type: boolean
1526 Default: no
1527 .fi
1528 .IP
1529 This option allows you to edit the header of your outgoing messages
1530 along with the body of your message.
1531 .IP
1532 \fBNote\fP that changes made to the References: and Date: headers are
1533 ignored for interoperability reasons.
1534
1535
1536 .TP
1537 .B editor
1538 .nf
1539 Type: path
1540 Default: \(lq\(rq
1541 .fi
1542 .IP
1543 This variable specifies which editor is used by mutt.
1544 It defaults to the value of the \fC$VISUAL\fP, or \fC$EDITOR\fP, environment
1545 variable, or to the string \(lq/usr/bin/editor\(rq if neither of those are set.
1546
1547
1548 .TP
1549 .B encode_from
1550 .nf
1551 Type: boolean
1552 Default: no
1553 .fi
1554 .IP
1555 When \fIset\fP, mutt will quoted\-printable encode messages when
1556 they contain the string \(lqFrom \(rq (note the trailing space) in the beginning of a line.
1557 This is useful to avoid the tampering certain mail delivery and transport
1558 agents tend to do with messages (in order to prevent tools from
1559 misinterpreting the line as a mbox message separator).
1560
1561
1562 .TP
1563 .B envelope_from_address
1564 .nf
1565 Type: e-mail address
1566 Default: \(lq\(rq
1567 .fi
1568 .IP
1569 Manually sets the \fIenvelope\fP sender for outgoing messages.
1570 This value is ignored if $use_envelope_from is \fIunset\fP.
1571
1572
1573 .TP
1574 .B escape
1575 .nf
1576 Type: string
1577 Default: \(lq~\(rq
1578 .fi
1579 .IP
1580 Escape character to use for functions in the builtin editor.
1581
1582
1583 .TP
1584 .B fast_reply
1585 .nf
1586 Type: boolean
1587 Default: no
1588 .fi
1589 .IP
1590 When \fIset\fP, the initial prompt for recipients and subject are skipped
1591 when replying to messages, and the initial prompt for subject is
1592 skipped when forwarding messages.
1593 .IP
1594 \fBNote:\fP this variable has no effect when the $autoedit
1595 variable is \fIset\fP.
1596
1597
1598 .TP
1599 .B fcc_attach
1600 .nf
1601 Type: boolean
1602 Default: yes
1603 .fi
1604 .IP
1605 This variable controls whether or not attachments on outgoing messages
1606 are saved along with the main body of your message.
1607
1608
1609 .TP
1610 .B fcc_clear
1611 .nf
1612 Type: boolean
1613 Default: no
1614 .fi
1615 .IP
1616 When this variable is \fIset\fP, FCCs will be stored unencrypted and
1617 unsigned, even when the actual message is encrypted and/or
1618 signed.
1619 (PGP only)
1620
1621
1622 .TP
1623 .B folder
1624 .nf
1625 Type: path
1626 Default: \(lq~/Mail\(rq
1627 .fi
1628 .IP
1629 Specifies the default location of your mailboxes.  A \(lq+\(rq or \(lq=\(rq at the
1630 beginning of a pathname will be expanded to the value of this
1631 variable.  Note that if you change this variable (from the default)
1632 value you need to make sure that the assignment occurs \fIbefore\fP
1633 you use \(lq+\(rq or \(lq=\(rq for any other variables since expansion takes place
1634 when handling the \(lqmailboxes\(rq command.
1635
1636
1637 .TP
1638 .B folder_format
1639 .nf
1640 Type: string
1641 Default: \(lq%2C %t %N %F %2l %\-8.8u %\-8.8g %8s %d %f\(rq
1642 .fi
1643 .IP
1644 This variable allows you to customize the file browser display to your
1645 personal taste.  This string is similar to $index_format, but has
1646 its own set of \fCprintf(3)\fP\-like sequences:
1647 .RS
1648 .PD 0
1649 .TP
1650 %C  
1651 current file number
1652 .TP
1653 %d  
1654 date/time folder was last modified
1655 .TP
1656 %f  
1657 filename
1658 .TP
1659 %F  
1660 file permissions
1661 .TP
1662 %g  
1663 group name (or numeric gid, if missing)
1664 .TP
1665 %l  
1666 number of hard links
1667 .TP
1668 %N  
1669 N if folder has new mail, blank otherwise
1670 .TP
1671 %s  
1672 size in bytes
1673 .TP
1674 %t  
1675 \(lq*\(rq if the file is tagged, blank otherwise
1676 .TP
1677 %u  
1678 owner name (or numeric uid, if missing)
1679 .TP
1680 %>X 
1681 right justify the rest of the string and pad with character \(lqX\(rq
1682 .TP
1683 %|X 
1684 pad to the end of the line with character \(lqX\(rq
1685 .TP
1686 %*X 
1687 soft\-fill with character \(lqX\(rq as pad
1688 .RE
1689 .PD 1
1690 .IP
1691 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
1692
1693
1694 .TP
1695 .B followup_to
1696 .nf
1697 Type: boolean
1698 Default: yes
1699 .fi
1700 .IP
1701 Controls whether or not the \(lqMail\-Followup\-To:\(rq header field is
1702 generated when sending mail.  When \fIset\fP, Mutt will generate this
1703 field when you are replying to a known mailing list, specified with
1704 the \(lqsubscribe\(rq or \(lqlists\(rq commands.
1705 .IP
1706 This field has two purposes.  First, preventing you from
1707 receiving duplicate copies of replies to messages which you send
1708 to mailing lists, and second, ensuring that you do get a reply
1709 separately for any messages sent to known lists to which you are
1710 not subscribed.
1711 .IP
1712 The header will contain only the list's address
1713 for subscribed lists, and both the list address and your own
1714 email address for unsubscribed lists.  Without this header, a
1715 group reply to your message sent to a subscribed list will be
1716 sent to both the list and your address, resulting in two copies
1717 of the same email for you.
1718
1719
1720 .TP
1721 .B force_name
1722 .nf
1723 Type: boolean
1724 Default: no
1725 .fi
1726 .IP
1727 This variable is similar to $save_name, except that Mutt will
1728 store a copy of your outgoing message by the username of the address
1729 you are sending to even if that mailbox does not exist.
1730 .IP
1731 Also see the $record variable.
1732
1733
1734 .TP
1735 .B forward_decode
1736 .nf
1737 Type: boolean
1738 Default: yes
1739 .fi
1740 .IP
1741 Controls the decoding of complex MIME messages into \fCtext/plain\fP when
1742 forwarding a message.  The message header is also RFC2047 decoded.
1743 This variable is only used, if $mime_forward is \fIunset\fP,
1744 otherwise $mime_forward_decode is used instead.
1745
1746
1747 .TP
1748 .B forward_edit
1749 .nf
1750 Type: quadoption
1751 Default: yes
1752 .fi
1753 .IP
1754 This quadoption controls whether or not the user is automatically
1755 placed in the editor when forwarding messages.  For those who always want
1756 to forward with no modification, use a setting of \(lqno\(rq.
1757
1758
1759 .TP
1760 .B forward_format
1761 .nf
1762 Type: string
1763 Default: \(lq[%a: %s]\(rq
1764 .fi
1765 .IP
1766 This variable controls the default subject when forwarding a message.
1767 It uses the same format sequences as the $index_format variable.
1768
1769
1770 .TP
1771 .B forward_quote
1772 .nf
1773 Type: boolean
1774 Default: no
1775 .fi
1776 .IP
1777 When \fIset\fP, forwarded messages included in the main body of the
1778 message (when $mime_forward is \fIunset\fP) will be quoted using
1779 $indent_string.
1780
1781
1782 .TP
1783 .B from
1784 .nf
1785 Type: e-mail address
1786 Default: \(lq\(rq
1787 .fi
1788 .IP
1789 When \fIset\fP, this variable contains a default from address.  It
1790 can be overridden using \(lqmy_hdr\(rq (including from a \(lqsend-hook\(rq) and
1791 $reverse_name.  This variable is ignored if $use_from is \fIunset\fP.
1792 .IP
1793 This setting defaults to the contents of the environment variable \fC$EMAIL\fP.
1794
1795
1796 .TP
1797 .B gecos_mask
1798 .nf
1799 Type: regular expression
1800 Default: \(lq^[^,]*\(rq
1801 .fi
1802 .IP
1803 A regular expression used by mutt to parse the GECOS field of a password
1804 entry when expanding the alias.  The default value
1805 will return the string up to the first \(lq,\(rq encountered.
1806 If the GECOS field contains a string like \(lqlastname, firstname\(rq then you
1807 should set it to \(lq\fC.*\fP\(rq.
1808 .IP
1809 This can be useful if you see the following behavior: you address an e\-mail
1810 to user ID \(lqstevef\(rq whose full name is \(lqSteve Franklin\(rq.  If mutt expands
1811 \(lqstevef\(rq to \(lq\(rqFranklin\(rq stevef@foo.bar\(rq then you should set the $gecos_mask to
1812 a regular expression that will match the whole name so mutt will expand
1813 \(lqFranklin\(rq to \(lqFranklin, Steve\(rq.
1814
1815
1816 .TP
1817 .B hdrs
1818 .nf
1819 Type: boolean
1820 Default: yes
1821 .fi
1822 .IP
1823 When \fIunset\fP, the header fields normally added by the \(lqmy_hdr\(rq
1824 command are not created.  This variable \fImust\fP be unset before
1825 composing a new message or replying in order to take effect.  If \fIset\fP,
1826 the user defined header fields are added to every new message.
1827
1828
1829 .TP
1830 .B header
1831 .nf
1832 Type: boolean
1833 Default: no
1834 .fi
1835 .IP
1836 When \fIset\fP, this variable causes Mutt to include the header
1837 of the message you are replying to into the edit buffer.
1838 The $weed setting applies.
1839
1840
1841 .TP
1842 .B help
1843 .nf
1844 Type: boolean
1845 Default: yes
1846 .fi
1847 .IP
1848 When \fIset\fP, help lines describing the bindings for the major functions
1849 provided by each menu are displayed on the first line of the screen.
1850 .IP
1851 \fBNote:\fP The binding will not be displayed correctly if the
1852 function is bound to a sequence rather than a single keystroke.  Also,
1853 the help line may not be updated if a binding is changed while Mutt is
1854 running.  Since this variable is primarily aimed at new users, neither
1855 of these should present a major problem.
1856
1857
1858 .TP
1859 .B hidden_host
1860 .nf
1861 Type: boolean
1862 Default: no
1863 .fi
1864 .IP
1865 When \fIset\fP, mutt will skip the host name part of $hostname variable
1866 when adding the domain part to addresses.  This variable does not
1867 affect the generation of Message\-IDs, and it will not lead to the
1868 cut\-off of first\-level domains.
1869
1870
1871 .TP
1872 .B hide_limited
1873 .nf
1874 Type: boolean
1875 Default: no
1876 .fi
1877 .IP
1878 When \fIset\fP, mutt will not show the presence of messages that are hidden
1879 by limiting, in the thread tree.
1880
1881
1882 .TP
1883 .B hide_missing
1884 .nf
1885 Type: boolean
1886 Default: yes
1887 .fi
1888 .IP
1889 When \fIset\fP, mutt will not show the presence of missing messages in the
1890 thread tree.
1891
1892
1893 .TP
1894 .B hide_thread_subject
1895 .nf
1896 Type: boolean
1897 Default: yes
1898 .fi
1899 .IP
1900 When \fIset\fP, mutt will not show the subject of messages in the thread
1901 tree that have the same subject as their parent or closest previously
1902 displayed sibling.
1903
1904
1905 .TP
1906 .B hide_top_limited
1907 .nf
1908 Type: boolean
1909 Default: no
1910 .fi
1911 .IP
1912 When \fIset\fP, mutt will not show the presence of messages that are hidden
1913 by limiting, at the top of threads in the thread tree.  Note that when
1914 $hide_limited is \fIset\fP, this option will have no effect.
1915
1916
1917 .TP
1918 .B hide_top_missing
1919 .nf
1920 Type: boolean
1921 Default: yes
1922 .fi
1923 .IP
1924 When \fIset\fP, mutt will not show the presence of missing messages at the
1925 top of threads in the thread tree.  Note that when $hide_missing is
1926 \fIset\fP, this option will have no effect.
1927
1928
1929 .TP
1930 .B history
1931 .nf
1932 Type: number
1933 Default: 10
1934 .fi
1935 .IP
1936 This variable controls the size (in number of strings remembered) of
1937 the string history buffer per category. The buffer is cleared each time the
1938 variable is set.
1939
1940
1941 .TP
1942 .B history_file
1943 .nf
1944 Type: path
1945 Default: \(lq~/.mutthistory\(rq
1946 .fi
1947 .IP
1948 The file in which Mutt will save its history.
1949
1950
1951 .TP
1952 .B honor_followup_to
1953 .nf
1954 Type: quadoption
1955 Default: yes
1956 .fi
1957 .IP
1958 This variable controls whether or not a Mail\-Followup\-To header is
1959 honored when group\-replying to a message.
1960
1961
1962 .TP
1963 .B hostname
1964 .nf
1965 Type: string
1966 Default: \(lq\(rq
1967 .fi
1968 .IP
1969 Specifies the fully\-qualified hostname of the system mutt is running on
1970 containing the host's name and the DNS domain it belongs to. It is used
1971 as the domain part (after \(lq@\(rq) for local email addresses as well as
1972 Message\-Id headers.
1973 .IP
1974 Its value is determined at startup as follows: If the node's name
1975 as returned by the \fCuname(3)\fP function contains the hostname and the
1976 domain, these are used to construct $hostname. If there is no
1977 domain part returned, Mutt will look for a \(lqdomain\(rq or \(lqsearch\(rq
1978 line in \fC/etc/resolv.conf\fP to determine the domain. Optionally, Mutt
1979 can be compiled with a fixed domain name in which case a detected
1980 one is not used.
1981 .IP
1982 Also see $use_domain and $hidden_host.
1983 .IP
1984 \fBNote:\fP On Debian systems, the default for this variable is obtained
1985 from /etc/mailname when Mutt starts.
1986
1987
1988 .TP
1989 .B ignore_linear_white_space
1990 .nf
1991 Type: boolean
1992 Default: no
1993 .fi
1994 .IP
1995 This option replaces linear\-white\-space between encoded\-word
1996 and text to a single space to prevent the display of MIME\-encoded
1997 \(lqSubject:\(rq field from being divided into multiple lines.
1998
1999
2000 .TP
2001 .B ignore_list_reply_to
2002 .nf
2003 Type: boolean
2004 Default: no
2005 .fi
2006 .IP
2007 Affects the behaviour of the \fC<reply>\fP function when replying to
2008 messages from mailing lists (as defined by the \(lqsubscribe\(rq or
2009 \(lqlists\(rq commands).  When \fIset\fP, if the \(lqReply\-To:\(rq field is
2010 set to the same value as the \(lqTo:\(rq field, Mutt assumes that the
2011 \(lqReply\-To:\(rq field was set by the mailing list to automate responses
2012 to the list, and will ignore this field.  To direct a response to the
2013 mailing list when this option is \fIset\fP, use the \fC<list-reply>\fP
2014 function; \fC<group\-reply>\fP will reply to both the sender and the
2015 list.
2016
2017
2018 .TP
2019 .B imap_authenticators
2020 .nf
2021 Type: string
2022 Default: \(lq\(rq
2023 .fi
2024 .IP
2025 This is a colon\-delimited list of authentication methods mutt may
2026 attempt to use to log in to an IMAP server, in the order mutt should
2027 try them.  Authentication methods are either \(lqlogin\(rq or the right
2028 side of an IMAP \(lqAUTH=xxx\(rq capability string, eg \(lqdigest\-md5\(rq, \(lqgssapi\(rq
2029 or \(lqcram\-md5\(rq. This option is case\-insensitive. If it's
2030 \fIunset\fP (the default) mutt will try all available methods,
2031 in order from most\-secure to least\-secure.
2032 .IP
2033 Example:
2034
2035 .IP
2036 .DS
2037 .sp
2038 .ft CR
2039 .nf
2040 set imap_authenticators=\(rqgssapi:cram\-md5:login\(rq
2041
2042 .fi
2043 .ec
2044 .ft P
2045 .sp
2046 .IP
2047 \fBNote:\fP Mutt will only fall back to other authentication methods if
2048 the previous methods are unavailable. If a method is available but
2049 authentication fails, mutt will not connect to the IMAP server.
2050
2051
2052 .TP
2053 .B imap_check_subscribed
2054 .nf
2055 Type: boolean
2056 Default: no
2057 .fi
2058 .IP
2059 When \fIset\fP, mutt will fetch the set of subscribed folders from
2060 your server on connection, and add them to the set of mailboxes
2061 it polls for new mail just as if you had issued individual \(lqmailboxes\(rq
2062 commands.
2063
2064
2065 .TP
2066 .B imap_delim_chars
2067 .nf
2068 Type: string
2069 Default: \(lq/.\(rq
2070 .fi
2071 .IP
2072 This contains the list of characters which you would like to treat
2073 as folder separators for displaying IMAP paths. In particular it
2074 helps in using the \(lq=\(rq shortcut for your \fIfolder\fP variable.
2075
2076
2077 .TP
2078 .B imap_headers
2079 .nf
2080 Type: string
2081 Default: \(lq\(rq
2082 .fi
2083 .IP
2084 Mutt requests these header fields in addition to the default headers
2085 (\(lqDate:\(rq, \(lqFrom:\(rq, \(lqSubject:\(rq, \(lqTo:\(rq, \(lqCc:\(rq, \(lqMessage\-Id:\(rq,
2086 \(lqReferences:\(rq, \(lqContent\-Type:\(rq, \(lqContent\-Description:\(rq, \(lqIn\-Reply\-To:\(rq,
2087 \(lqReply\-To:\(rq, \(lqLines:\(rq, \(lqList\-Post:\(rq, \(lqX\-Label:\(rq) from IMAP
2088 servers before displaying the index menu. You may want to add more
2089 headers for spam detection.
2090 .IP
2091 \fBNote:\fP This is a space separated list, items should be uppercase
2092 and not contain the colon, e.g. \(lqX\-BOGOSITY X\-SPAM\-STATUS\(rq for the
2093 \(lqX\-Bogosity:\(rq and \(lqX\-Spam\-Status:\(rq header fields.
2094
2095
2096 .TP
2097 .B imap_idle
2098 .nf
2099 Type: boolean
2100 Default: no
2101 .fi
2102 .IP
2103 When \fIset\fP, mutt will attempt to use the IMAP IDLE extension
2104 to check for new mail in the current mailbox. Some servers
2105 (dovecot was the inspiration for this option) react badly
2106 to mutt's implementation. If your connection seems to freeze
2107 up periodically, try unsetting this.
2108
2109
2110 .TP
2111 .B imap_keepalive
2112 .nf
2113 Type: number
2114 Default: 900
2115 .fi
2116 .IP
2117 This variable specifies the maximum amount of time in seconds that mutt
2118 will wait before polling open IMAP connections, to prevent the server
2119 from closing them before mutt has finished with them. The default is
2120 well within the RFC\-specified minimum amount of time (30 minutes) before
2121 a server is allowed to do this, but in practice the RFC does get
2122 violated every now and then. Reduce this number if you find yourself
2123 getting disconnected from your IMAP server due to inactivity.
2124
2125
2126 .TP
2127 .B imap_list_subscribed
2128 .nf
2129 Type: boolean
2130 Default: no
2131 .fi
2132 .IP
2133 This variable configures whether IMAP folder browsing will look for
2134 only subscribed folders or all folders.  This can be toggled in the
2135 IMAP browser with the \fC<toggle\-subscribed>\fP function.
2136
2137
2138 .TP
2139 .B imap_login
2140 .nf
2141 Type: string
2142 Default: \(lq\(rq
2143 .fi
2144 .IP
2145 Your login name on the IMAP server.
2146 .IP
2147 This variable defaults to the value of $imap_user.
2148
2149
2150 .TP
2151 .B imap_pass
2152 .nf
2153 Type: string
2154 Default: \(lq\(rq
2155 .fi
2156 .IP
2157 Specifies the password for your IMAP account.  If \fIunset\fP, Mutt will
2158 prompt you for your password when you invoke the \fC<fetch-mail>\fP function
2159 or try to open an IMAP folder.
2160 .IP
2161 \fBWarning\fP: you should only use this option when you are on a
2162 fairly secure machine, because the superuser can read your muttrc even
2163 if you are the only one who can read the file.
2164
2165
2166 .TP
2167 .B imap_passive
2168 .nf
2169 Type: boolean
2170 Default: yes
2171 .fi
2172 .IP
2173 When \fIset\fP, mutt will not open new IMAP connections to check for new
2174 mail.  Mutt will only check for new mail over existing IMAP
2175 connections.  This is useful if you don't want to be prompted to
2176 user/password pairs on mutt invocation, or if opening the connection
2177 is slow.
2178
2179
2180 .TP
2181 .B imap_peek
2182 .nf
2183 Type: boolean
2184 Default: yes
2185 .fi
2186 .IP
2187 When \fIset\fP, mutt will avoid implicitly marking your mail as read whenever
2188 you fetch a message from the server. This is generally a good thing,
2189 but can make closing an IMAP folder somewhat slower. This option
2190 exists to appease speed freaks.
2191
2192
2193 .TP
2194 .B imap_pipeline_depth
2195 .nf
2196 Type: number
2197 Default: 15
2198 .fi
2199 .IP
2200 Controls the number of IMAP commands that may be queued up before they
2201 are sent to the server. A deeper pipeline reduces the amount of time
2202 mutt must wait for the server, and can make IMAP servers feel much
2203 more responsive. But not all servers correctly handle pipelined commands,
2204 so if you have problems you might want to try setting this variable to 0.
2205 .IP
2206 \fBNote:\fP Changes to this variable have no effect on open connections.
2207
2208
2209 .TP
2210 .B imap_servernoise
2211 .nf
2212 Type: boolean
2213 Default: yes
2214 .fi
2215 .IP
2216 When \fIset\fP, mutt will display warning messages from the IMAP
2217 server as error messages. Since these messages are often
2218 harmless, or generated due to configuration problems on the
2219 server which are out of the users' hands, you may wish to suppress
2220 them at some point.
2221
2222
2223 .TP
2224 .B imap_user
2225 .nf
2226 Type: string
2227 Default: \(lq\(rq
2228 .fi
2229 .IP
2230 The name of the user whose mail you intend to access on the IMAP
2231 server.
2232 .IP
2233 This variable defaults to your user name on the local machine.
2234
2235
2236 .TP
2237 .B implicit_autoview
2238 .nf
2239 Type: boolean
2240 Default: no
2241 .fi
2242 .IP
2243 If set to \(lqyes\(rq, mutt will look for a mailcap entry with the
2244 \(lq\fCcopiousoutput\fP\(rq flag set for \fIevery\fP MIME attachment it doesn't have
2245 an internal viewer defined for.  If such an entry is found, mutt will
2246 use the viewer defined in that entry to convert the body part to text
2247 form.
2248
2249
2250 .TP
2251 .B include
2252 .nf
2253 Type: quadoption
2254 Default: ask\-yes
2255 .fi
2256 .IP
2257 Controls whether or not a copy of the message(s) you are replying to
2258 is included in your reply.
2259
2260
2261 .TP
2262 .B include_onlyfirst
2263 .nf
2264 Type: boolean
2265 Default: no
2266 .fi
2267 .IP
2268 Controls whether or not Mutt includes only the first attachment
2269 of the message you are replying.
2270
2271
2272 .TP
2273 .B indent_string
2274 .nf
2275 Type: string
2276 Default: \(lq> \(rq
2277 .fi
2278 .IP
2279 Specifies the string to prepend to each line of text quoted in a
2280 message to which you are replying.  You are strongly encouraged not to
2281 change this value, as it tends to agitate the more fanatical netizens.
2282 .IP
2283 This option is a format string, please see the description of
2284 $index_format for supported \fCprintf(3)\fP\-style sequences.
2285 .IP
2286 Because for \fCformat=lowed\fP style messages the quoting mechanism
2287 is strictly defined, this setting is ignored if $text_flowed is
2288 \fIset\fP.
2289
2290
2291 .TP
2292 .B index_format
2293 .nf
2294 Type: string
2295 Default: \(lq%4C %Z %{%b %d} %\-15.15L (%?l?%4l&%4c?) %s\(rq
2296 .fi
2297 .IP
2298 This variable allows you to customize the message index display to
2299 your personal taste.
2300 .IP
2301 \(lqFormat strings\(rq are similar to the strings used in the C
2302 function \fCprintf(3)\fP to format output (see the man page for more details).
2303 The following sequences are defined in Mutt:
2304 .RS
2305 .PD 0
2306 .TP
2307 %a 
2308 address of the author
2309 .TP
2310 %A 
2311 reply\-to address (if present; otherwise: address of author)
2312 .TP
2313 %b 
2314 filename of the original message folder (think mailbox)
2315 .TP
2316 %B 
2317 the list to which the letter was sent, or else the folder name (%b).
2318 .TP
2319 %c 
2320 number of characters (bytes) in the message
2321 .TP
2322 %C 
2323 current message number
2324 .TP
2325 %d 
2326 date and time of the message in the format specified by
2327 $date_format converted to sender's time zone
2328 .TP
2329 %D 
2330 date and time of the message in the format specified by
2331 $date_format converted to the local time zone
2332 .TP
2333 %e 
2334 current message number in thread
2335 .TP
2336 %E 
2337 number of messages in current thread
2338 .TP
2339 %f 
2340 sender (address + real name), either From: or Return\-Path:
2341 .TP
2342 %F 
2343 author name, or recipient name if the message is from you
2344 .TP
2345 %H 
2346 spam attribute(s) of this message
2347 .TP
2348 %i 
2349 message\-id of the current message
2350 .TP
2351 %l 
2352 number of lines in the message (does not work with maildir,
2353 mh, and possibly IMAP folders)
2354 .TP
2355 %L 
2356 If an address in the \(lqTo:\(rq or \(lqCc:\(rq header field matches an address
2357 defined by the users \(lqsubscribe\(rq command, this displays
2358 \(rqTo <list\-name>\(rq, otherwise the same as %F.
2359 .TP
2360 %m 
2361 total number of message in the mailbox
2362 .TP
2363 %M 
2364 number of hidden messages if the thread is collapsed.
2365 .TP
2366 %N 
2367 message score
2368 .TP
2369 %n 
2370 author's real name (or address if missing)
2371 .TP
2372 %O 
2373 original save folder where mutt would formerly have
2374 stashed the message: list name or recipient name
2375 if not sent to a list
2376 .TP
2377 %P 
2378 progress indicator for the builtin pager (how much of the file has been displayed)
2379 .TP
2380 %s 
2381 subject of the message
2382 .TP
2383 %S 
2384 status of the message (\(lqN\(rq/\(lqD\(rq/\(lqd\(rq/\(lq!\(rq/\(lqr\(rq/*)
2385 .TP
2386 %t 
2387 \(lqTo:\(rq field (recipients)
2388 .TP
2389 %T 
2390 the appropriate character from the $to_chars string
2391 .TP
2392 %u 
2393 user (login) name of the author
2394 .TP
2395 %v 
2396 first name of the author, or the recipient if the message is from you
2397 .TP
2398 %X 
2399 number of attachments
2400 (please see the \(lqattachments\(rq section for possible speed effects)
2401 .TP
2402 %y 
2403 \(lqX\-Label:\(rq field, if present
2404 .TP
2405 %Y 
2406 \(lqX\-Label:\(rq field, if present, and \fI(1)\fP not at part of a thread tree,
2407 \fI(2)\fP at the top of a thread, or \fI(3)\fP \(lqX\-Label:\(rq is different from
2408 preceding message's \(lqX\-Label:\(rq.
2409 .TP
2410 %Z 
2411 message status flags
2412 .TP
2413 %{fmt} 
2414 the date and time of the message is converted to sender's
2415 time zone, and \(lqfmt\(rq is expanded by the library function
2416 \fCstrftime(3)\fP; a leading bang disables locales
2417 .TP
2418 %[fmt] 
2419 the date and time of the message is converted to the local
2420 time zone, and \(lqfmt\(rq is expanded by the library function
2421 \fCstrftime(3)\fP; a leading bang disables locales
2422 .TP
2423 %(fmt) 
2424 the local date and time when the message was received.
2425 \(lqfmt\(rq is expanded by the library function \fCstrftime(3)\fP;
2426 a leading bang disables locales
2427 .TP
2428 %<fmt> 
2429 the current local time. \(lqfmt\(rq is expanded by the library
2430 function \fCstrftime(3)\fP; a leading bang disables locales.
2431 .TP
2432 %>X    
2433 right justify the rest of the string and pad with character \(lqX\(rq
2434 .TP
2435 %|X    
2436 pad to the end of the line with character \(lqX\(rq
2437 .TP
2438 %*X    
2439 soft\-fill with character \(lqX\(rq as pad
2440 .RE
2441 .PD 1
2442 .IP
2443 \(lqSoft\-fill\(rq deserves some explanation: Normal right\-justification
2444 will print everything to the left of the \(lq%>\(rq, displaying padding and
2445 whatever lies to the right only if there's room. By contrast,
2446 soft\-fill gives priority to the right\-hand side, guaranteeing space
2447 to display it and showing padding only if there's still room. If
2448 necessary, soft\-fill will eat text leftwards to make room for
2449 rightward text.
2450 .IP
2451 Note that these expandos are supported in
2452 \(lqsave-hook\(rq, \(lqfcc-hook\(rq and \(lqfcc-save-hook\(rq, too.
2453
2454
2455 .TP
2456 .B ispell
2457 .nf
2458 Type: path
2459 Default: \(lqispell\(rq
2460 .fi
2461 .IP
2462 How to invoke ispell (GNU's spell\-checking software).
2463
2464
2465 .TP
2466 .B keep_flagged
2467 .nf
2468 Type: boolean
2469 Default: no
2470 .fi
2471 .IP
2472 If \fIset\fP, read messages marked as flagged will not be moved
2473 from your spool mailbox to your $mbox mailbox, or as a result of
2474 a \(lqmbox-hook\(rq command.
2475
2476
2477 .TP
2478 .B locale
2479 .nf
2480 Type: string
2481 Default: \(lqC\(rq
2482 .fi
2483 .IP
2484 The locale used by \fCstrftime(3)\fP to format dates. Legal values are
2485 the strings your system accepts for the locale environment variable \fC$LC_TIME\fP.
2486
2487
2488 .TP
2489 .B mail_check
2490 .nf
2491 Type: number
2492 Default: 5
2493 .fi
2494 .IP
2495 This variable configures how often (in seconds) mutt should look for
2496 new mail. Also see the $timeout variable.
2497
2498
2499 .TP
2500 .B mailcap_path
2501 .nf
2502 Type: string
2503 Default: \(lq\(rq
2504 .fi
2505 .IP
2506 This variable specifies which files to consult when attempting to
2507 display MIME bodies not directly supported by Mutt.
2508
2509
2510 .TP
2511 .B mailcap_sanitize
2512 .nf
2513 Type: boolean
2514 Default: yes
2515 .fi
2516 .IP
2517 If \fIset\fP, mutt will restrict possible characters in mailcap % expandos
2518 to a well\-defined set of safe characters.  This is the safe setting,
2519 but we are not sure it doesn't break some more advanced MIME stuff.
2520 .IP
2521 \fBDON'T CHANGE THIS SETTING UNLESS YOU ARE REALLY SURE WHAT YOU ARE
2522 DOING!\fP
2523
2524
2525 .TP
2526 .B maildir_mtime
2527 .nf
2528 Type: boolean
2529 Default: no
2530 .fi
2531 .IP
2532 If set, the sort\-by\-date option in the browser will sort maildirs
2533 smartly, not using the mtime of the maildir itself but that of the
2534 newest message in the new subdirectory, making the sorting by
2535 reverse date much more useful. People with maildirs over NFS may
2536 wish to leave this option unset.
2537
2538
2539 .TP
2540 .B header_cache
2541 .nf
2542 Type: path
2543 Default: \(lq\(rq
2544 .fi
2545 .IP
2546 This variable points to the header cache database.
2547 If pointing to a directory Mutt will contain a header cache
2548 database file per folder, if pointing to a file that file will
2549 be a single global header cache. By default it is \fIunset\fP so no header
2550 caching will be used.
2551 .IP
2552 Header caching can greatly improve speed when opening POP, IMAP
2553 MH or Maildir folders, see \(lqcaching\(rq for details.
2554
2555
2556 .TP
2557 .B maildir_header_cache_verify
2558 .nf
2559 Type: boolean
2560 Default: yes
2561 .fi
2562 .IP
2563 Check for Maildir unaware programs other than mutt having modified maildir
2564 files when the header cache is in use.  This incurs one \fCstat(2)\fP per
2565 message every time the folder is opened (which can be very slow for NFS
2566 folders).
2567
2568
2569 .TP
2570 .B header_cache_pagesize
2571 .nf
2572 Type: string
2573 Default: \(lq16384\(rq
2574 .fi
2575 .IP
2576 When mutt is compiled with either gdbm or bdb4 as the header cache backend,
2577 this option changes the database page size.  Too large or too small
2578 values can waste space, memory, or CPU time. The default should be more
2579 or less optimal for most use cases.
2580
2581
2582 .TP
2583 .B maildir_trash
2584 .nf
2585 Type: boolean
2586 Default: no
2587 .fi
2588 .IP
2589 If \fIset\fP, messages marked as deleted will be saved with the maildir
2590 trashed flag instead of unlinked.  \fBNote:\fP this only applies
2591 to maildir\-style mailboxes.  Setting it will have no effect on other
2592 mailbox types.
2593
2594
2595 .TP
2596 .B mark_old
2597 .nf
2598 Type: boolean
2599 Default: yes
2600 .fi
2601 .IP
2602 Controls whether or not mutt marks \fInew\fP \fBunread\fP
2603 messages as \fIold\fP if you exit a mailbox without reading them.
2604 With this option \fIset\fP, the next time you start mutt, the messages
2605 will show up with an \(lqO\(rq next to them in the index menu,
2606 indicating that they are old.
2607
2608
2609 .TP
2610 .B markers
2611 .nf
2612 Type: boolean
2613 Default: yes
2614 .fi
2615 .IP
2616 Controls the display of wrapped lines in the internal pager. If set, a
2617 \(lq+\(rq marker is displayed at the beginning of wrapped lines.
2618 .IP
2619 Also see the $smart_wrap variable.
2620
2621
2622 .TP
2623 .B mask
2624 .nf
2625 Type: regular expression
2626 Default: \(lq!^\\.[^.]\(rq
2627 .fi
2628 .IP
2629 A regular expression used in the file browser, optionally preceded by
2630 the \fInot\fP operator \(lq!\(rq.  Only files whose names match this mask
2631 will be shown. The match is always case\-sensitive.
2632
2633
2634 .TP
2635 .B mbox
2636 .nf
2637 Type: path
2638 Default: \(lq~/mbox\(rq
2639 .fi
2640 .IP
2641 This specifies the folder into which read mail in your $spoolfile
2642 folder will be appended.
2643 .IP
2644 Also see the $move variable.
2645
2646
2647 .TP
2648 .B mbox_type
2649 .nf
2650 Type: folder magic
2651 Default: mbox
2652 .fi
2653 .IP
2654 The default mailbox type used when creating new folders. May be any of
2655 \(lqmbox\(rq, \(lqMMDF\(rq, \(lqMH\(rq and \(lqMaildir\(rq.
2656
2657
2658 .TP
2659 .B metoo
2660 .nf
2661 Type: boolean
2662 Default: no
2663 .fi
2664 .IP
2665 If \fIunset\fP, Mutt will remove your address (see the \(lqalternates\(rq
2666 command) from the list of recipients when replying to a message.
2667
2668
2669 .TP
2670 .B menu_context
2671 .nf
2672 Type: number
2673 Default: 0
2674 .fi
2675 .IP
2676 This variable controls the number of lines of context that are given
2677 when scrolling through menus. (Similar to $pager_context.)
2678
2679
2680 .TP
2681 .B menu_move_off
2682 .nf
2683 Type: boolean
2684 Default: yes
2685 .fi
2686 .IP
2687 When \fIunset\fP, the bottom entry of menus will never scroll up past
2688 the bottom of the screen, unless there are less entries than lines.
2689 When \fIset\fP, the bottom entry may move off the bottom.
2690
2691
2692 .TP
2693 .B menu_scroll
2694 .nf
2695 Type: boolean
2696 Default: no
2697 .fi
2698 .IP
2699 When \fIset\fP, menus will be scrolled up or down one line when you
2700 attempt to move across a screen boundary.  If \fIunset\fP, the screen
2701 is cleared and the next or previous page of the menu is displayed
2702 (useful for slow links to avoid many redraws).
2703
2704
2705 .TP
2706 .B meta_key
2707 .nf
2708 Type: boolean
2709 Default: no
2710 .fi
2711 .IP
2712 If \fIset\fP, forces Mutt to interpret keystrokes with the high bit (bit 8)
2713 set as if the user had pressed the Esc key and whatever key remains
2714 after having the high bit removed.  For example, if the key pressed
2715 has an ASCII value of \fC0xf8\fP, then this is treated as if the user had
2716 pressed Esc then \(lqx\(rq.  This is because the result of removing the
2717 high bit from \fC0xf8\fP is \fC0x78\fP, which is the ASCII character
2718 \(lqx\(rq.
2719
2720
2721 .TP
2722 .B mh_purge
2723 .nf
2724 Type: boolean
2725 Default: no
2726 .fi
2727 .IP
2728 When \fIunset\fP, mutt will mimic mh's behaviour and rename deleted messages
2729 to \fI,<old file name>\fP in mh folders instead of really deleting
2730 them. This leaves the message on disk but makes programs reading the folder
2731 ignore it. If the variable is \fIset\fP, the message files will simply be
2732 deleted.
2733 .IP
2734 This option is similar to $maildir_trash for Maildir folders.
2735
2736
2737 .TP
2738 .B mh_seq_flagged
2739 .nf
2740 Type: string
2741 Default: \(lqflagged\(rq
2742 .fi
2743 .IP
2744 The name of the MH sequence used for flagged messages.
2745
2746
2747 .TP
2748 .B mh_seq_replied
2749 .nf
2750 Type: string
2751 Default: \(lqreplied\(rq
2752 .fi
2753 .IP
2754 The name of the MH sequence used to tag replied messages.
2755
2756
2757 .TP
2758 .B mh_seq_unseen
2759 .nf
2760 Type: string
2761 Default: \(lqunseen\(rq
2762 .fi
2763 .IP
2764 The name of the MH sequence used for unseen messages.
2765
2766
2767 .TP
2768 .B mime_forward
2769 .nf
2770 Type: quadoption
2771 Default: no
2772 .fi
2773 .IP
2774 When \fIset\fP, the message you are forwarding will be attached as a
2775 separate \fCmessage/rfc822\fP MIME part instead of included in the main body of the
2776 message.  This is useful for forwarding MIME messages so the receiver
2777 can properly view the message as it was delivered to you. If you like
2778 to switch between MIME and not MIME from mail to mail, set this
2779 variable to \(lqask\-no\(rq or \(lqask\-yes\(rq.
2780 .IP
2781 Also see $forward_decode and $mime_forward_decode.
2782
2783
2784 .TP
2785 .B mime_forward_decode
2786 .nf
2787 Type: boolean
2788 Default: no
2789 .fi
2790 .IP
2791 Controls the decoding of complex MIME messages into \fCtext/plain\fP when
2792 forwarding a message while $mime_forward is \fIset\fP. Otherwise
2793 $forward_decode is used instead.
2794
2795
2796 .TP
2797 .B mime_forward_rest
2798 .nf
2799 Type: quadoption
2800 Default: yes
2801 .fi
2802 .IP
2803 When forwarding multiple attachments of a MIME message from the attachment
2804 menu, attachments which cannot be decoded in a reasonable manner will
2805 be attached to the newly composed message if this option is \fIset\fP.
2806
2807
2808 .TP
2809 .B mix_entry_format
2810 .nf
2811 Type: string
2812 Default: \(lq%4n %c %\-16s %a\(rq
2813 .fi
2814 .IP
2815 This variable describes the format of a remailer line on the mixmaster
2816 chain selection screen.  The following \fCprintf(3)\fP\-like sequences are
2817 supported:
2818 .RS
2819 .PD 0
2820 .TP
2821 %n 
2822 The running number on the menu.
2823 .TP
2824 %c 
2825 Remailer capabilities.
2826 .TP
2827 %s 
2828 The remailer's short name.
2829 .TP
2830 %a 
2831 The remailer's e\-mail address.
2832 .RE
2833 .PD 1
2834
2835 .TP
2836 .B mixmaster
2837 .nf
2838 Type: path
2839 Default: \(lqmixmaster\(rq
2840 .fi
2841 .IP
2842 This variable contains the path to the Mixmaster binary on your
2843 system.  It is used with various sets of parameters to gather the
2844 list of known remailers, and to finally send a message through the
2845 mixmaster chain.
2846 .IP
2847 \fBNote:\fP On Debian systems, this option is set by default to
2848 \(lqmixmaster\-filter\(rq in /etc/Muttrc.
2849
2850
2851 .TP
2852 .B move
2853 .nf
2854 Type: quadoption
2855 Default: no
2856 .fi
2857 .IP
2858 Controls whether or not Mutt will move read messages
2859 from your spool mailbox to your $mbox mailbox, or as a result of
2860 a \(lqmbox-hook\(rq command.
2861
2862
2863 .TP
2864 .B message_cachedir
2865 .nf
2866 Type: path
2867 Default: \(lq\(rq
2868 .fi
2869 .IP
2870 Set this to a directory and mutt will cache copies of messages from
2871 your IMAP and POP servers here. You are free to remove entries at any
2872 time.
2873 .IP
2874 When setting this variable to a directory, mutt needs to fetch every
2875 remote message only once and can perform regular expression searches
2876 as fast as for local folders.
2877 .IP
2878 Also see the $message_cache_clean variable.
2879
2880
2881 .TP
2882 .B message_cache_clean
2883 .nf
2884 Type: boolean
2885 Default: no
2886 .fi
2887 .IP
2888 If \fIset\fP, mutt will clean out obsolete entries from the message cache when
2889 the mailbox is synchronized. You probably only want to set it
2890 every once in a while, since it can be a little slow
2891 (especially for large folders).
2892
2893
2894 .TP
2895 .B message_format
2896 .nf
2897 Type: string
2898 Default: \(lq%s\(rq
2899 .fi
2900 .IP
2901 This is the string displayed in the \(lqattachment\(rq menu for
2902 attachments of type \fCmessage/rfc822\fP.  For a full listing of defined
2903 \fCprintf(3)\fP\-like sequences see the section on $index_format.
2904
2905
2906 .TP
2907 .B narrow_tree
2908 .nf
2909 Type: boolean
2910 Default: no
2911 .fi
2912 .IP
2913 This variable, when \fIset\fP, makes the thread tree narrower, allowing
2914 deeper threads to fit on the screen.
2915
2916
2917 .TP
2918 .B net_inc
2919 .nf
2920 Type: number
2921 Default: 10
2922 .fi
2923 .IP
2924 Operations that expect to transfer a large amount of data over the
2925 network will update their progress every $net_inc kilobytes.
2926 If set to 0, no progress messages will be displayed.
2927 .IP
2928 See also $read_inc, $write_inc and $net_inc.
2929
2930
2931 .TP
2932 .B pager
2933 .nf
2934 Type: path
2935 Default: \(lqbuiltin\(rq
2936 .fi
2937 .IP
2938 This variable specifies which pager you would like to use to view
2939 messages. The value \(lqbuiltin\(rq means to use the builtin pager, otherwise this
2940 variable should specify the pathname of the external pager you would
2941 like to use.
2942 .IP
2943 Using an external pager may have some disadvantages: Additional
2944 keystrokes are necessary because you can't call mutt functions
2945 directly from the pager, and screen resizes cause lines longer than
2946 the screen width to be badly formatted in the help menu.
2947
2948
2949 .TP
2950 .B pager_context
2951 .nf
2952 Type: number
2953 Default: 0
2954 .fi
2955 .IP
2956 This variable controls the number of lines of context that are given
2957 when displaying the next or previous page in the internal pager.  By
2958 default, Mutt will display the line after the last one on the screen
2959 at the top of the next page (0 lines of context).
2960
2961
2962 .TP
2963 .B pager_format
2964 .nf
2965 Type: string
2966 Default: \(lq\-%Z\- %C/%m: %\-20.20n   %s%*  \-\- (%P)\(rq
2967 .fi
2968 .IP
2969 This variable controls the format of the one\-line message \(lqstatus\(rq
2970 displayed before each message in either the internal or an external
2971 pager.  The valid sequences are listed in the $index_format
2972 section.
2973
2974
2975 .TP
2976 .B pager_index_lines
2977 .nf
2978 Type: number
2979 Default: 0
2980 .fi
2981 .IP
2982 Determines the number of lines of a mini\-index which is shown when in
2983 the pager.  The current message, unless near the top or bottom of the
2984 folder, will be roughly one third of the way down this mini\-index,
2985 giving the reader the context of a few messages before and after the
2986 message.  This is useful, for example, to determine how many messages
2987 remain to be read in the current thread.  One of the lines is reserved
2988 for the status bar from the index, so a setting of 6
2989 will only show 5 lines of the actual index.  A value of 0 results in
2990 no index being shown.  If the number of messages in the current folder
2991 is less than $pager_index_lines, then the index will only use as
2992 many lines as it needs.
2993
2994
2995 .TP
2996 .B pager_stop
2997 .nf
2998 Type: boolean
2999 Default: no
3000 .fi
3001 .IP
3002 When \fIset\fP, the internal\-pager will \fBnot\fP move to the next message
3003 when you are at the end of a message and invoke the \fC<next\-page>\fP
3004 function.
3005
3006
3007 .TP
3008 .B crypt_autosign
3009 .nf
3010 Type: boolean
3011 Default: no
3012 .fi
3013 .IP
3014 Setting this variable will cause Mutt to always attempt to
3015 cryptographically sign outgoing messages.  This can be overridden
3016 by use of the pgp menu, when signing is not required or
3017 encryption is requested as well. If $smime_is_default is \fIset\fP,
3018 then OpenSSL is used instead to create S/MIME messages and settings can
3019 be overridden by use of the smime menu instead of the pgp menu.
3020 (Crypto only)
3021
3022
3023 .TP
3024 .B crypt_autoencrypt
3025 .nf
3026 Type: boolean
3027 Default: no
3028 .fi
3029 .IP
3030 Setting this variable will cause Mutt to always attempt to PGP
3031 encrypt outgoing messages.  This is probably only useful in
3032 connection to the \(lqsend-hook\(rq command.  It can be overridden
3033 by use of the pgp menu, when encryption is not required or
3034 signing is requested as well.  If $smime_is_default is \fIset\fP,
3035 then OpenSSL is used instead to create S/MIME messages and
3036 settings can be overridden by use of the smime menu instead.
3037 (Crypto only)
3038
3039
3040 .TP
3041 .B pgp_ignore_subkeys
3042 .nf
3043 Type: boolean
3044 Default: yes
3045 .fi
3046 .IP
3047 Setting this variable will cause Mutt to ignore OpenPGP subkeys. Instead,
3048 the principal key will inherit the subkeys' capabilities.  \fIUnset\fP this
3049 if you want to play interesting key selection games.
3050 (PGP only)
3051
3052
3053 .TP
3054 .B crypt_replyencrypt
3055 .nf
3056 Type: boolean
3057 Default: yes
3058 .fi
3059 .IP
3060 If \fIset\fP, automatically PGP or OpenSSL encrypt replies to messages which are
3061 encrypted.
3062 (Crypto only)
3063
3064
3065 .TP
3066 .B crypt_replysign
3067 .nf
3068 Type: boolean
3069 Default: no
3070 .fi
3071 .IP
3072 If \fIset\fP, automatically PGP or OpenSSL sign replies to messages which are
3073 signed.
3074 .IP
3075 \fBNote:\fP this does not work on messages that are encrypted
3076 \fIand\fP signed!
3077 (Crypto only)
3078
3079
3080 .TP
3081 .B crypt_replysignencrypted
3082 .nf
3083 Type: boolean
3084 Default: no
3085 .fi
3086 .IP
3087 If \fIset\fP, automatically PGP or OpenSSL sign replies to messages
3088 which are encrypted. This makes sense in combination with
3089 $crypt_replyencrypt, because it allows you to sign all
3090 messages which are automatically encrypted.  This works around
3091 the problem noted in $crypt_replysign, that mutt is not able
3092 to find out whether an encrypted message is also signed.
3093 (Crypto only)
3094
3095
3096 .TP
3097 .B crypt_timestamp
3098 .nf
3099 Type: boolean
3100 Default: yes
3101 .fi
3102 .IP
3103 If \fIset\fP, mutt will include a time stamp in the lines surrounding
3104 PGP or S/MIME output, so spoofing such lines is more difficult.
3105 If you are using colors to mark these lines, and rely on these,
3106 you may \fIunset\fP this setting.
3107 (Crypto only)
3108
3109
3110 .TP
3111 .B pgp_use_gpg_agent
3112 .nf
3113 Type: boolean
3114 Default: no
3115 .fi
3116 .IP
3117 If \fIset\fP, mutt will use a possibly\-running \fCgpg\-agent(1)\fP process.
3118 (PGP only)
3119
3120
3121 .TP
3122 .B crypt_verify_sig
3123 .nf
3124 Type: quadoption
3125 Default: yes
3126 .fi
3127 .IP
3128 If \fI\(lqyes\(rq\fP, always attempt to verify PGP or S/MIME signatures.
3129 If \fI\(lqask\-*\(rq\fP, ask whether or not to verify the signature.
3130 If \\Fi\(lqno\(rq\fP, never attempt to verify cryptographic signatures.
3131 (Crypto only)
3132
3133
3134 .TP
3135 .B smime_is_default
3136 .nf
3137 Type: boolean
3138 Default: no
3139 .fi
3140 .IP
3141 The default behaviour of mutt is to use PGP on all auto\-sign/encryption
3142 operations. To override and to use OpenSSL instead this must be \fIset\fP.
3143 However, this has no effect while replying, since mutt will automatically
3144 select the same application that was used to sign/encrypt the original
3145 message.  (Note that this variable can be overridden by unsetting $crypt_autosmime.)
3146 (S/MIME only)
3147
3148
3149 .TP
3150 .B smime_ask_cert_label
3151 .nf
3152 Type: boolean
3153 Default: yes
3154 .fi
3155 .IP
3156 This flag controls whether you want to be asked to enter a label
3157 for a certificate about to be added to the database or not. It is
3158 \fIset\fP by default.
3159 (S/MIME only)
3160
3161
3162 .TP
3163 .B smime_decrypt_use_default_key
3164 .nf
3165 Type: boolean
3166 Default: yes
3167 .fi
3168 .IP
3169 If \fIset\fP (default) this tells mutt to use the default key for decryption. Otherwise,
3170 if managing multiple certificate\-key\-pairs, mutt will try to use the mailbox\-address
3171 to determine the key to use. It will ask you to supply a key, if it can't find one.
3172 (S/MIME only)
3173
3174
3175 .TP
3176 .B pgp_entry_format
3177 .nf
3178 Type: string
3179 Default: \(lq%4n %t%f %4l/0x%k %\-4a %2c %u\(rq
3180 .fi
3181 .IP
3182 This variable allows you to customize the PGP key selection menu to
3183 your personal taste. This string is similar to $index_format, but
3184 has its own set of \fCprintf(3)\fP\-like sequences:
3185 .RS
3186 .PD 0
3187 .TP
3188 %n     
3189 number
3190 .TP
3191 %k     
3192 key id
3193 .TP
3194 %u     
3195 user id
3196 .TP
3197 %a     
3198 algorithm
3199 .TP
3200 %l     
3201 key length
3202 .TP
3203 %f     
3204 flags
3205 .TP
3206 %c     
3207 capabilities
3208 .TP
3209 %t     
3210 trust/validity of the key\-uid association
3211 .TP
3212 %[<s>] 
3213 date of the key where <s> is an \fCstrftime(3)\fP expression
3214 .RE
3215 .PD 1
3216 .IP
3217 (PGP only)
3218
3219
3220 .TP
3221 .B pgp_good_sign
3222 .nf
3223 Type: regular expression
3224 Default: \(lq\(rq
3225 .fi
3226 .IP
3227 If you assign a text to this variable, then a PGP signature is only
3228 considered verified if the output from $pgp_verify_command contains
3229 the text. Use this variable if the exit code from the command is 0
3230 even for bad signatures.
3231 (PGP only)
3232
3233
3234 .TP
3235 .B pgp_check_exit
3236 .nf
3237 Type: boolean
3238 Default: yes
3239 .fi
3240 .IP
3241 If \fIset\fP, mutt will check the exit code of the PGP subprocess when
3242 signing or encrypting.  A non\-zero exit code means that the
3243 subprocess failed.
3244 (PGP only)
3245
3246
3247 .TP
3248 .B pgp_long_ids
3249 .nf
3250 Type: boolean
3251 Default: no
3252 .fi
3253 .IP
3254 If \fIset\fP, use 64 bit PGP key IDs, if \fIunset\fP use the normal 32 bit key IDs.
3255 (PGP only)
3256
3257
3258 .TP
3259 .B pgp_retainable_sigs
3260 .nf
3261 Type: boolean
3262 Default: no
3263 .fi
3264 .IP
3265 If \fIset\fP, signed and encrypted messages will consist of nested
3266 \fCmultipart/signed\fP and \fCmultipart/encrypted\fP body parts.
3267 .IP
3268 This is useful for applications like encrypted and signed mailing
3269 lists, where the outer layer (\fCmultipart/encrypted\fP) can be easily
3270 removed, while the inner \fCmultipart/signed\fP part is retained.
3271 (PGP only)
3272
3273
3274 .TP
3275 .B pgp_autoinline
3276 .nf
3277 Type: boolean
3278 Default: no
3279 .fi
3280 .IP
3281 This option controls whether Mutt generates old\-style inline
3282 (traditional) PGP encrypted or signed messages under certain
3283 circumstances.  This can be overridden by use of the pgp menu,
3284 when inline is not required.
3285 .IP
3286 Note that Mutt might automatically use PGP/MIME for messages
3287 which consist of more than a single MIME part.  Mutt can be
3288 configured to ask before sending PGP/MIME messages when inline
3289 (traditional) would not work.
3290 .IP
3291 Also see the $pgp_mime_auto variable.
3292 .IP
3293 Also note that using the old\-style PGP message format is \fBstrongly\fP
3294 \fBdeprecated\fP.
3295 (PGP only)
3296
3297
3298 .TP
3299 .B pgp_replyinline
3300 .nf
3301 Type: boolean
3302 Default: no
3303 .fi
3304 .IP
3305 Setting this variable will cause Mutt to always attempt to
3306 create an inline (traditional) message when replying to a
3307 message which is PGP encrypted/signed inline.  This can be
3308 overridden by use of the pgp menu, when inline is not
3309 required.  This option does not automatically detect if the
3310 (replied\-to) message is inline; instead it relies on Mutt
3311 internals for previously checked/flagged messages.
3312 .IP
3313 Note that Mutt might automatically use PGP/MIME for messages
3314 which consist of more than a single MIME part.  Mutt can be
3315 configured to ask before sending PGP/MIME messages when inline
3316 (traditional) would not work.
3317 .IP
3318 Also see the $pgp_mime_auto variable.
3319 .IP
3320 Also note that using the old\-style PGP message format is \fBstrongly\fP
3321 \fBdeprecated\fP.
3322 (PGP only)
3323
3324
3325 .TP
3326 .B pgp_show_unusable
3327 .nf
3328 Type: boolean
3329 Default: yes
3330 .fi
3331 .IP
3332 If \fIset\fP, mutt will display non\-usable keys on the PGP key selection
3333 menu.  This includes keys which have been revoked, have expired, or
3334 have been marked as \(lqdisabled\(rq by the user.
3335 (PGP only)
3336
3337
3338 .TP
3339 .B pgp_sign_as
3340 .nf
3341 Type: string
3342 Default: \(lq\(rq
3343 .fi
3344 .IP
3345 If you have more than one key pair, this option allows you to specify
3346 which of your private keys to use.  It is recommended that you use the
3347 keyid form to specify your key (e.g. \fC0x00112233\fP).
3348 (PGP only)
3349
3350
3351 .TP
3352 .B pgp_strict_enc
3353 .nf
3354 Type: boolean
3355 Default: yes
3356 .fi
3357 .IP
3358 If \fIset\fP, Mutt will automatically encode PGP/MIME signed messages as
3359 quoted\-printable.  Please note that unsetting this variable may
3360 lead to problems with non\-verifyable PGP signatures, so only change
3361 this if you know what you are doing.
3362 (PGP only)
3363
3364
3365 .TP
3366 .B pgp_timeout
3367 .nf
3368 Type: number
3369 Default: 300
3370 .fi
3371 .IP
3372 The number of seconds after which a cached passphrase will expire if
3373 not used.
3374 (PGP only)
3375
3376
3377 .TP
3378 .B pgp_sort_keys
3379 .nf
3380 Type: sort order
3381 Default: address
3382 .fi
3383 .IP
3384 Specifies how the entries in the pgp menu are sorted. The
3385 following are legal values:
3386 .RS
3387 .PD 0
3388 .TP
3389 address 
3390 sort alphabetically by user id
3391 .TP
3392 keyid   
3393 sort alphabetically by key id
3394 .TP
3395 date    
3396 sort by key creation date
3397 .TP
3398 trust   
3399 sort by the trust of the key
3400 .RE
3401 .PD 1
3402 .IP
3403 If you prefer reverse order of the above values, prefix it with
3404 \(lqreverse\-\(rq.
3405 (PGP only)
3406
3407
3408 .TP
3409 .B pgp_mime_auto
3410 .nf
3411 Type: quadoption
3412 Default: ask\-yes
3413 .fi
3414 .IP
3415 This option controls whether Mutt will prompt you for
3416 automatically sending a (signed/encrypted) message using
3417 PGP/MIME when inline (traditional) fails (for any reason).
3418 .IP
3419 Also note that using the old\-style PGP message format is \fBstrongly\fP
3420 \fBdeprecated\fP.
3421 (PGP only)
3422
3423
3424 .TP
3425 .B pgp_auto_decode
3426 .nf
3427 Type: boolean
3428 Default: no
3429 .fi
3430 .IP
3431 If \fIset\fP, mutt will automatically attempt to decrypt traditional PGP
3432 messages whenever the user performs an operation which ordinarily would
3433 result in the contents of the message being operated on.  For example,
3434 if the user displays a pgp\-traditional message which has not been manually
3435 checked with the \fC<check-traditional-pgp>\fP function, mutt will automatically
3436 check the message for traditional pgp.
3437
3438
3439 .TP
3440 .B pgp_mime_signature_filename
3441 .nf
3442 Type: string
3443 Default: \(lqsignature.asc\(rq
3444 .fi
3445 .IP
3446 This option sets the filename used for signature parts in PGP/MIME
3447 signed messages.
3448
3449
3450 .TP
3451 .B pgp_mime_signature_description
3452 .nf
3453 Type: string
3454 Default: \(lqDigital signature\(rq
3455 .fi
3456 .IP
3457 This option sets the Content\-Description used for signature parts in
3458 PGP/MIME signed messages.
3459
3460
3461 .TP
3462 .B pgp_decode_command
3463 .nf
3464 Type: string
3465 Default: \(lq\(rq
3466 .fi
3467 .IP
3468 This format strings specifies a command which is used to decode
3469 application/pgp attachments.
3470 .IP
3471 The PGP command formats have their own set of \fCprintf(3)\fP\-like sequences:
3472 .RS
3473 .PD 0
3474 .TP
3475 %p 
3476 Expands to PGPPASSFD=0 when a pass phrase is needed, to an empty
3477 string otherwise. Note: This may be used with a %? construct.
3478 .TP
3479 %f 
3480 Expands to the name of a file containing a message.
3481 .TP
3482 %s 
3483 Expands to the name of a file containing the signature part
3484            of a \fCmultipart/signed\fP attachment when verifying it.
3485 .TP
3486 %a 
3487 The value of $pgp_sign_as.
3488 .TP
3489 %r 
3490 One or more key IDs.
3491 .RE
3492 .PD 1
3493 .IP
3494 For examples on how to configure these formats for the various versions
3495 of PGP which are floating around, see the pgp and gpg sample configuration files in
3496 the \fCsamples/\fP subdirectory which has been installed on your system
3497 alongside the documentation.
3498 (PGP only)
3499
3500
3501 .TP
3502 .B pgp_getkeys_command
3503 .nf
3504 Type: string
3505 Default: \(lq\(rq
3506 .fi
3507 .IP
3508 This command is invoked whenever mutt will need public key information.
3509 Of the sequences supported by $pgp_decode_command, %r is the only
3510 \fCprintf(3)\fP\-like sequence used with this format.
3511 (PGP only)
3512
3513
3514 .TP
3515 .B pgp_verify_command
3516 .nf
3517 Type: string
3518 Default: \(lq\(rq
3519 .fi
3520 .IP
3521 This command is used to verify PGP signatures.
3522 .IP
3523 This is a format string, see the $pgp_decode_command command for
3524 possible \fCprintf(3)\fP\-like sequences.
3525 (PGP only)
3526
3527
3528 .TP
3529 .B pgp_decrypt_command
3530 .nf
3531 Type: string
3532 Default: \(lq\(rq
3533 .fi
3534 .IP
3535 This command is used to decrypt a PGP encrypted message.
3536 .IP
3537 This is a format string, see the $pgp_decode_command command for
3538 possible \fCprintf(3)\fP\-like sequences.
3539 (PGP only)
3540
3541
3542 .TP
3543 .B pgp_clearsign_command
3544 .nf
3545 Type: string
3546 Default: \(lq\(rq
3547 .fi
3548 .IP
3549 This format is used to create an old\-style \(lqclearsigned\(rq PGP
3550 message.  Note that the use of this format is \fBstrongly\fP
3551 \fBdeprecated\fP.
3552 .IP
3553 This is a format string, see the $pgp_decode_command command for
3554 possible \fCprintf(3)\fP\-like sequences.
3555 (PGP only)
3556
3557
3558 .TP
3559 .B pgp_sign_command
3560 .nf
3561 Type: string
3562 Default: \(lq\(rq
3563 .fi
3564 .IP
3565 This command is used to create the detached PGP signature for a
3566 \fCmultipart/signed\fP PGP/MIME body part.
3567 .IP
3568 This is a format string, see the $pgp_decode_command command for
3569 possible \fCprintf(3)\fP\-like sequences.
3570 (PGP only)
3571
3572
3573 .TP
3574 .B pgp_encrypt_sign_command
3575 .nf
3576 Type: string
3577 Default: \(lq\(rq
3578 .fi
3579 .IP
3580 This command is used to both sign and encrypt a body part.
3581 .IP
3582 This is a format string, see the $pgp_decode_command command for
3583 possible \fCprintf(3)\fP\-like sequences.
3584 (PGP only)
3585
3586
3587 .TP
3588 .B pgp_encrypt_only_command
3589 .nf
3590 Type: string
3591 Default: \(lq\(rq
3592 .fi
3593 .IP
3594 This command is used to encrypt a body part without signing it.
3595 .IP
3596 This is a format string, see the $pgp_decode_command command for
3597 possible \fCprintf(3)\fP\-like sequences.
3598 (PGP only)
3599
3600
3601 .TP
3602 .B pgp_import_command
3603 .nf
3604 Type: string
3605 Default: \(lq\(rq
3606 .fi
3607 .IP
3608 This command is used to import a key from a message into
3609 the user's public key ring.
3610 .IP
3611 This is a format string, see the $pgp_decode_command command for
3612 possible \fCprintf(3)\fP\-like sequences.
3613 (PGP only)
3614
3615
3616 .TP
3617 .B pgp_export_command
3618 .nf
3619 Type: string
3620 Default: \(lq\(rq
3621 .fi
3622 .IP
3623 This command is used to export a public key from the user's
3624 key ring.
3625 .IP
3626 This is a format string, see the $pgp_decode_command command for
3627 possible \fCprintf(3)\fP\-like sequences.
3628 (PGP only)
3629
3630
3631 .TP
3632 .B pgp_verify_key_command
3633 .nf
3634 Type: string
3635 Default: \(lq\(rq
3636 .fi
3637 .IP
3638 This command is used to verify key information from the key selection
3639 menu.
3640 .IP
3641 This is a format string, see the $pgp_decode_command command for
3642 possible \fCprintf(3)\fP\-like sequences.
3643 (PGP only)
3644
3645
3646 .TP
3647 .B pgp_list_secring_command
3648 .nf
3649 Type: string
3650 Default: \(lq\(rq
3651 .fi
3652 .IP
3653 This command is used to list the secret key ring's contents.  The
3654 output format must be analogous to the one used by:
3655
3656 .IP
3657 .DS
3658 .sp
3659 .ft CR
3660 .nf
3661 gpg \-\-list\-keys \-\-with\-colons.
3662
3663 .fi
3664 .ec
3665 .ft P
3666 .sp
3667 .IP
3668 This format is also generated by the \fCpgpring\fP utility which comes
3669 with mutt.
3670 .IP
3671 This is a format string, see the $pgp_decode_command command for
3672 possible \fCprintf(3)\fP\-like sequences.
3673 (PGP only)
3674
3675
3676 .TP
3677 .B pgp_list_pubring_command
3678 .nf
3679 Type: string
3680 Default: \(lq\(rq
3681 .fi
3682 .IP
3683 This command is used to list the public key ring's contents.  The
3684 output format must be analogous to the one used by
3685
3686 .IP
3687 .DS
3688 .sp
3689 .ft CR
3690 .nf
3691 gpg \-\-list\-keys \-\-with\-colons.
3692
3693 .fi
3694 .ec
3695 .ft P
3696 .sp
3697 .IP
3698 This format is also generated by the \fCpgpring\fP utility which comes
3699 with mutt.
3700 .IP
3701 This is a format string, see the $pgp_decode_command command for
3702 possible \fCprintf(3)\fP\-like sequences.
3703 (PGP only)
3704
3705
3706 .TP
3707 .B forward_decrypt
3708 .nf
3709 Type: boolean
3710 Default: yes
3711 .fi
3712 .IP
3713 Controls the handling of encrypted messages when forwarding a message.
3714 When \fIset\fP, the outer layer of encryption is stripped off.  This
3715 variable is only used if $mime_forward is \fIset\fP and
3716 $mime_forward_decode is \fIunset\fP.
3717 (PGP only)
3718
3719
3720 .TP
3721 .B smime_timeout
3722 .nf
3723 Type: number
3724 Default: 300
3725 .fi
3726 .IP
3727 The number of seconds after which a cached passphrase will expire if
3728 not used.
3729 (S/MIME only)
3730
3731
3732 .TP
3733 .B smime_encrypt_with
3734 .nf
3735 Type: string
3736 Default: \(lq\(rq
3737 .fi
3738 .IP
3739 This sets the algorithm that should be used for encryption.
3740 Valid choices are \(lqdes\(rq, \(lqdes3\(rq, \(lqrc2\-40\(rq, \(lqrc2\-64\(rq, \(lqrc2\-128\(rq.
3741 If \fIunset\fP, \(lq3des\(rq (TripleDES) is used.
3742 (S/MIME only)
3743
3744
3745 .TP
3746 .B smime_keys
3747 .nf
3748 Type: path
3749 Default: \(lq\(rq
3750 .fi
3751 .IP
3752 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
3753 storage and retrieval of keys/certs by itself. This is very basic right now,
3754 and stores keys and certificates in two different directories, both
3755 named as the hash\-value retrieved from OpenSSL. There is an index file
3756 which contains mailbox\-address keyid pair, and which can be manually
3757 edited. This option points to the location of the private keys.
3758 (S/MIME only)
3759
3760
3761 .TP
3762 .B smime_ca_location
3763 .nf
3764 Type: path
3765 Default: \(lq\(rq
3766 .fi
3767 .IP
3768 This variable contains the name of either a directory, or a file which
3769 contains trusted certificates for use with OpenSSL.
3770 (S/MIME only)
3771 .IP
3772 \fBNote:\fP On Debian systems, this defaults to the first existing file in
3773 the following list: ~/.smime/ca\-certificates.crt ~/.smime/ca\-bundle.crt
3774 /etc/ssl/certs/ca\-certificates.crt.
3775
3776
3777 .TP
3778 .B smime_certificates
3779 .nf
3780 Type: path
3781 Default: \(lq\(rq
3782 .fi
3783 .IP
3784 Since for S/MIME there is no pubring/secring as with PGP, mutt has to handle
3785 storage and retrieval of keys by itself. This is very basic right
3786 now, and keys and certificates are stored in two different
3787 directories, both named as the hash\-value retrieved from
3788 OpenSSL. There is an index file which contains mailbox\-address
3789 keyid pairs, and which can be manually edited. This option points to
3790 the location of the certificates.
3791 (S/MIME only)
3792
3793
3794 .TP
3795 .B smime_decrypt_command
3796 .nf
3797 Type: string
3798 Default: \(lq\(rq
3799 .fi
3800 .IP
3801 This format string specifies a command which is used to decrypt
3802 \fCapplication/x\-pkcs7\-mime\fP attachments.
3803 .IP
3804 The OpenSSL command formats have their own set of \fCprintf(3)\fP\-like sequences
3805 similar to PGP's:
3806 .RS
3807 .PD 0
3808 .TP
3809 %f 
3810 Expands to the name of a file containing a message.
3811 .TP
3812 %s 
3813 Expands to the name of a file containing the signature part
3814            of a \fCmultipart/signed\fP attachment when verifying it.
3815 .TP
3816 %k 
3817 The key\-pair specified with $smime_default_key
3818 .TP
3819 %c 
3820 One or more certificate IDs.
3821 .TP
3822 %a 
3823 The algorithm used for encryption.
3824 .TP
3825 %C 
3826 CA location:  Depending on whether $smime_ca_location
3827            points to a directory or file, this expands to
3828            \(lq\-CApath $smime_ca_location\(rq or \(lq\-CAfile $smime_ca_location\(rq.
3829 .RE
3830 .PD 1
3831 .IP
3832 For examples on how to configure these formats, see the \fCsmime.rc\fP in
3833 the \fCsamples/\fP subdirectory which has been installed on your system
3834 alongside the documentation.
3835 (S/MIME only)
3836
3837
3838 .TP
3839 .B smime_verify_command
3840 .nf
3841 Type: string
3842 Default: \(lq\(rq
3843 .fi
3844 .IP
3845 This command is used to verify S/MIME signatures of type \fCmultipart/signed\fP.
3846 .IP
3847 This is a format string, see the $smime_decrypt_command command for
3848 possible \fCprintf(3)\fP\-like sequences.
3849 (S/MIME only)
3850
3851
3852 .TP
3853 .B smime_verify_opaque_command
3854 .nf
3855 Type: string
3856 Default: \(lq\(rq
3857 .fi
3858 .IP
3859 This command is used to verify S/MIME signatures of type
3860 \fCapplication/x\-pkcs7\-mime\fP.
3861 .IP
3862 This is a format string, see the $smime_decrypt_command command for
3863 possible \fCprintf(3)\fP\-like sequences.
3864 (S/MIME only)
3865
3866
3867 .TP
3868 .B smime_sign_command
3869 .nf
3870 Type: string
3871 Default: \(lq\(rq
3872 .fi
3873 .IP
3874 This command is used to created S/MIME signatures of type
3875 \fCmultipart/signed\fP, which can be read by all mail clients.
3876 .IP
3877 This is a format string, see the $smime_decrypt_command command for
3878 possible \fCprintf(3)\fP\-like sequences.
3879 (S/MIME only)
3880
3881
3882 .TP
3883 .B smime_sign_opaque_command
3884 .nf
3885 Type: string
3886 Default: \(lq\(rq
3887 .fi
3888 .IP
3889 This command is used to created S/MIME signatures of type
3890 \fCapplication/x\-pkcs7\-signature\fP, which can only be handled by mail
3891 clients supporting the S/MIME extension.
3892 .IP
3893 This is a format string, see the $smime_decrypt_command command for
3894 possible \fCprintf(3)\fP\-like sequences.
3895 (S/MIME only)
3896
3897
3898 .TP
3899 .B smime_encrypt_command
3900 .nf
3901 Type: string
3902 Default: \(lq\(rq
3903 .fi
3904 .IP
3905 This command is used to create encrypted S/MIME messages.
3906 .IP
3907 This is a format string, see the $smime_decrypt_command command for
3908 possible \fCprintf(3)\fP\-like sequences.
3909 (S/MIME only)
3910
3911
3912 .TP
3913 .B smime_pk7out_command
3914 .nf
3915 Type: string
3916 Default: \(lq\(rq
3917 .fi
3918 .IP
3919 This command is used to extract PKCS7 structures of S/MIME signatures,
3920 in order to extract the public X509 certificate(s).
3921 .IP
3922 This is a format string, see the $smime_decrypt_command command for
3923 possible \fCprintf(3)\fP\-like sequences.
3924 (S/MIME only)
3925
3926
3927 .TP
3928 .B smime_get_cert_command
3929 .nf
3930 Type: string
3931 Default: \(lq\(rq
3932 .fi
3933 .IP
3934 This command is used to extract X509 certificates from a PKCS7 structure.
3935 .IP
3936 This is a format string, see the $smime_decrypt_command command for
3937 possible \fCprintf(3)\fP\-like sequences.
3938 (S/MIME only)
3939
3940
3941 .TP
3942 .B smime_get_signer_cert_command
3943 .nf
3944 Type: string
3945 Default: \(lq\(rq
3946 .fi
3947 .IP
3948 This command is used to extract only the signers X509 certificate from a S/MIME
3949 signature, so that the certificate's owner may get compared to the
3950 email's \(lqFrom:\(rq field.
3951 .IP
3952 This is a format string, see the $smime_decrypt_command command for
3953 possible \fCprintf(3)\fP\-like sequences.
3954 (S/MIME only)
3955
3956
3957 .TP
3958 .B smime_import_cert_command
3959 .nf
3960 Type: string
3961 Default: \(lq\(rq
3962 .fi
3963 .IP
3964 This command is used to import a certificate via smime_keys.
3965 .IP
3966 This is a format string, see the $smime_decrypt_command command for
3967 possible \fCprintf(3)\fP\-like sequences.
3968 (S/MIME only)
3969
3970
3971 .TP
3972 .B smime_get_cert_email_command
3973 .nf
3974 Type: string
3975 Default: \(lq\(rq
3976 .fi
3977 .IP
3978 This command is used to extract the mail address(es) used for storing
3979 X509 certificates, and for verification purposes (to check whether the
3980 certificate was issued for the sender's mailbox).
3981 .IP
3982 This is a format string, see the $smime_decrypt_command command for
3983 possible \fCprintf(3)\fP\-like sequences.
3984 (S/MIME only)
3985
3986
3987 .TP
3988 .B smime_default_key
3989 .nf
3990 Type: string
3991 Default: \(lq\(rq
3992 .fi
3993 .IP
3994 This is the default key\-pair to use for signing. This must be set to the
3995 keyid (the hash\-value that OpenSSL generates) to work properly
3996 (S/MIME only)
3997
3998
3999 .TP
4000 .B ssl_client_cert
4001 .nf
4002 Type: path
4003 Default: \(lq\(rq
4004 .fi
4005 .IP
4006 The file containing a client certificate and its associated private
4007 key.
4008
4009
4010 .TP
4011 .B ssl_force_tls
4012 .nf
4013 Type: boolean
4014 Default: no
4015 .fi
4016 .IP
4017 If this variable is \fIset\fP, Mutt will require that all connections
4018 to remote servers be encrypted. Furthermore it will attempt to
4019 negotiate TLS even if the server does not advertise the capability,
4020 since it would otherwise have to abort the connection anyway. This
4021 option supersedes $ssl_starttls.
4022
4023
4024 .TP
4025 .B ssl_starttls
4026 .nf
4027 Type: quadoption
4028 Default: yes
4029 .fi
4030 .IP
4031 If \fIset\fP (the default), mutt will attempt to use \fCSTARTTLS\fP on servers
4032 advertising the capability. When \fIunset\fP, mutt will not attempt to
4033 use \fCSTARTTLS\fP regardless of the server's capabilities.
4034
4035
4036 .TP
4037 .B certificate_file
4038 .nf
4039 Type: path
4040 Default: \(lq~/.mutt_certificates\(rq
4041 .fi
4042 .IP
4043 This variable specifies the file where the certificates you trust
4044 are saved. When an unknown certificate is encountered, you are asked
4045 if you accept it or not. If you accept it, the certificate can also
4046 be saved in this file and further connections are automatically
4047 accepted.
4048 .IP
4049 You can also manually add CA certificates in this file. Any server
4050 certificate that is signed with one of these CA certificates is
4051 also automatically accepted.
4052 .IP
4053 Example:
4054
4055 .IP
4056 .DS
4057 .sp
4058 .ft CR
4059 .nf
4060 set certificate_file=~/.mutt/certificates
4061
4062 .fi
4063 .ec
4064 .ft P
4065 .sp
4066
4067
4068 .TP
4069 .B ssl_use_sslv3
4070 .nf
4071 Type: boolean
4072 Default: yes
4073 .fi
4074 .IP
4075 This variable specifies whether to attempt to use SSLv3 in the
4076 SSL authentication process.
4077
4078
4079 .TP
4080 .B ssl_use_tlsv1
4081 .nf
4082 Type: boolean
4083 Default: yes
4084 .fi
4085 .IP
4086 This variable specifies whether to attempt to use TLSv1 in the
4087 SSL authentication process.
4088
4089
4090 .TP
4091 .B ssl_min_dh_prime_bits
4092 .nf
4093 Type: number
4094 Default: 0
4095 .fi
4096 .IP
4097 This variable specifies the minimum acceptable prime size (in bits)
4098 for use in any Diffie\-Hellman key exchange. A value of 0 will use
4099 the default from the GNUTLS library.
4100
4101
4102 .TP
4103 .B ssl_ca_certificates_file
4104 .nf
4105 Type: path
4106 Default: \(lq\(rq
4107 .fi
4108 .IP
4109 This variable specifies a file containing trusted CA certificates.
4110 Any server certificate that is signed with one of these CA
4111 certificates is also automatically accepted.
4112 .IP
4113 Example:
4114
4115 .IP
4116 .DS
4117 .sp
4118 .ft CR
4119 .nf
4120 set ssl_ca_certificates_file=/etc/ssl/certs/ca\-certificates.crt
4121
4122 .fi
4123 .ec
4124 .ft P
4125 .sp
4126 .IP
4127 \fBNote:\fP On Debian systems, this variable defaults to the example
4128 mentioned. This file is managed by the \(lqca\-certificates\(rq package.
4129
4130
4131 .TP
4132 .B pipe_split
4133 .nf
4134 Type: boolean
4135 Default: no
4136 .fi
4137 .IP
4138 Used in connection with the \fC<pipe\-message>\fP function following
4139 \fC<tag\-prefix>\fP.  If this variable is \fIunset\fP, when piping a list of
4140 tagged messages Mutt will concatenate the messages and will pipe them
4141 all concatenated.  When \fIset\fP, Mutt will pipe the messages one by one.
4142 In both cases the messages are piped in the current sorted order,
4143 and the $pipe_sep separator is added after each message.
4144
4145
4146 .TP
4147 .B pipe_decode
4148 .nf
4149 Type: boolean
4150 Default: no
4151 .fi
4152 .IP
4153 Used in connection with the \fC<pipe\-message>\fP command.  When \fIunset\fP,
4154 Mutt will pipe the messages without any preprocessing. When \fIset\fP, Mutt
4155 will weed headers and will attempt to decode the messages
4156 first.
4157
4158
4159 .TP
4160 .B pipe_sep
4161 .nf
4162 Type: string
4163 Default: \(lq\\n\(rq
4164 .fi
4165 .IP
4166 The separator to add between messages when piping a list of tagged
4167 messages to an external Unix command.
4168
4169
4170 .TP
4171 .B pop_authenticators
4172 .nf
4173 Type: string
4174 Default: \(lq\(rq
4175 .fi
4176 .IP
4177 This is a colon\-delimited list of authentication methods mutt may
4178 attempt to use to log in to an POP server, in the order mutt should
4179 try them.  Authentication methods are either \(lquser\(rq, \(lqapop\(rq or any
4180 SASL mechanism, eg \(lqdigest\-md5\(rq, \(lqgssapi\(rq or \(lqcram\-md5\(rq.
4181 This option is case\-insensitive. If this option is \fIunset\fP
4182 (the default) mutt will try all available methods, in order from
4183 most\-secure to least\-secure.
4184 .IP
4185 Example:
4186
4187 .IP
4188 .DS
4189 .sp
4190 .ft CR
4191 .nf
4192 set pop_authenticators=\(rqdigest\-md5:apop:user\(rq
4193
4194 .fi
4195 .ec
4196 .ft P
4197 .sp
4198
4199
4200 .TP
4201 .B pop_auth_try_all
4202 .nf
4203 Type: boolean
4204 Default: yes
4205 .fi
4206 .IP
4207 If \fIset\fP, Mutt will try all available authentication methods.
4208 When \fIunset\fP, Mutt will only fall back to other authentication
4209 methods if the previous methods are unavailable. If a method is
4210 available but authentication fails, Mutt will not connect to the POP server.
4211
4212
4213 .TP
4214 .B pop_checkinterval
4215 .nf
4216 Type: number
4217 Default: 60
4218 .fi
4219 .IP
4220 This variable configures how often (in seconds) mutt should look for
4221 new mail in the currently selected mailbox if it is a POP mailbox.
4222
4223
4224 .TP
4225 .B pop_delete
4226 .nf
4227 Type: quadoption
4228 Default: ask\-no
4229 .fi
4230 .IP
4231 If \fIset\fP, Mutt will delete successfully downloaded messages from the POP
4232 server when using the \fC<fetch-mail>\fP function.  When \fIunset\fP, Mutt will
4233 download messages but also leave them on the POP server.
4234
4235
4236 .TP
4237 .B pop_host
4238 .nf
4239 Type: string
4240 Default: \(lq\(rq
4241 .fi
4242 .IP
4243 The name of your POP server for the \fC<fetch-mail>\fP function.  You
4244 can also specify an alternative port, username and password, ie:
4245
4246 .IP
4247 .DS
4248 .sp
4249 .ft CR
4250 .nf
4251 [pop[s]://][username[:password]@]popserver[:port]
4252
4253 .fi
4254 .ec
4255 .ft P
4256 .sp
4257 .IP
4258 where \(lq[...]\(rq denotes an optional part.
4259
4260
4261 .TP
4262 .B pop_last
4263 .nf
4264 Type: boolean
4265 Default: no
4266 .fi
4267 .IP
4268 If this variable is \fIset\fP, mutt will try to use the \(lq\fCLAST\fP\(rq POP command
4269 for retrieving only unread messages from the POP server when using
4270 the \fC<fetch-mail>\fP function.
4271
4272
4273 .TP
4274 .B pop_reconnect
4275 .nf
4276 Type: quadoption
4277 Default: ask\-yes
4278 .fi
4279 .IP
4280 Controls whether or not Mutt will try to reconnect to the POP server if
4281 the connection is lost.
4282
4283
4284 .TP
4285 .B pop_user
4286 .nf
4287 Type: string
4288 Default: \(lq\(rq
4289 .fi
4290 .IP
4291 Your login name on the POP server.
4292 .IP
4293 This variable defaults to your user name on the local machine.
4294
4295
4296 .TP
4297 .B pop_pass
4298 .nf
4299 Type: string
4300 Default: \(lq\(rq
4301 .fi
4302 .IP
4303 Specifies the password for your POP account.  If \fIunset\fP, Mutt will
4304 prompt you for your password when you open a POP mailbox.
4305 .IP
4306 \fBWarning\fP: you should only use this option when you are on a
4307 fairly secure machine, because the superuser can read your muttrc
4308 even if you are the only one who can read the file.
4309
4310
4311 .TP
4312 .B post_indent_string
4313 .nf
4314 Type: string
4315 Default: \(lq\(rq
4316 .fi
4317 .IP
4318 Similar to the $attribution variable, Mutt will append this
4319 string after the inclusion of a message which is being replied to.
4320
4321
4322 .TP
4323 .B postpone
4324 .nf
4325 Type: quadoption
4326 Default: ask\-yes
4327 .fi
4328 .IP
4329 Controls whether or not messages are saved in the $postponed
4330 mailbox when you elect not to send immediately.
4331 .IP
4332 Also see the $recall variable.
4333
4334
4335 .TP
4336 .B postponed
4337 .nf
4338 Type: path
4339 Default: \(lq~/postponed\(rq
4340 .fi
4341 .IP
4342 Mutt allows you to indefinitely \(lqpostpone sending a message\(rq which
4343 you are editing.  When you choose to postpone a message, Mutt saves it
4344 in the mailbox specified by this variable.
4345 .IP
4346 Also see the $postpone variable.
4347
4348
4349 .TP
4350 .B preconnect
4351 .nf
4352 Type: string
4353 Default: \(lq\(rq
4354 .fi
4355 .IP
4356 If \fIset\fP, a shell command to be executed if mutt fails to establish
4357 a connection to the server. This is useful for setting up secure
4358 connections, e.g. with \fCssh(1)\fP. If the command returns a  nonzero
4359 status, mutt gives up opening the server. Example:
4360
4361 .IP
4362 .DS
4363 .sp
4364 .ft CR
4365 .nf
4366 set preconnect=\(rqssh \-f \-q \-L 1234:mailhost.net:143 mailhost.net \\
4367 sleep 20 < /dev/null > /dev/null\(rq
4368
4369 .fi
4370 .ec
4371 .ft P
4372 .sp
4373 .IP
4374 Mailbox \(lqfoo\(rq on \(lqmailhost.net\(rq can now be reached
4375 as \(lq{localhost:1234}foo\(rq.
4376 .IP
4377 Note: For this example to work, you must be able to log in to the
4378 remote machine without having to enter a password.
4379 .IP
4380 When set, Mutt uses the tunnel for all remote connections.
4381 Please see \(lqaccount-hook\(rq in the manual for how to use different
4382 tunnel commands per connection.
4383
4384
4385 .TP
4386 .B print
4387 .nf
4388 Type: quadoption
4389 Default: ask\-no
4390 .fi
4391 .IP
4392 Controls whether or not Mutt really prints messages.
4393 This is set to \(lqask\-no\(rq by default, because some people
4394 accidentally hit \(lqp\(rq often.
4395
4396
4397 .TP
4398 .B print_command
4399 .nf
4400 Type: path
4401 Default: \(lqlpr\(rq
4402 .fi
4403 .IP
4404 This specifies the command pipe that should be used to print messages.
4405
4406
4407 .TP
4408 .B print_decode
4409 .nf
4410 Type: boolean
4411 Default: yes
4412 .fi
4413 .IP
4414 Used in connection with the \fC<print\-message>\fP command.  If this
4415 option is \fIset\fP, the message is decoded before it is passed to the
4416 external command specified by $print_command.  If this option
4417 is \fIunset\fP, no processing will be applied to the message when
4418 printing it.  The latter setting may be useful if you are using
4419 some advanced printer filter which is able to properly format
4420 e\-mail messages for printing.
4421
4422
4423 .TP
4424 .B print_split
4425 .nf
4426 Type: boolean
4427 Default: no
4428 .fi
4429 .IP
4430 Used in connection with the \fC<print\-message>\fP command.  If this option
4431 is \fIset\fP, the command specified by $print_command is executed once for
4432 each message which is to be printed.  If this option is \fIunset\fP,
4433 the command specified by $print_command is executed only once, and
4434 all the messages are concatenated, with a form feed as the message
4435 separator.
4436 .IP
4437 Those who use the \fCenscript\fP(1) program's mail\-printing mode will
4438 most likely want to \fIset\fP this option.
4439
4440
4441 .TP
4442 .B prompt_after
4443 .nf
4444 Type: boolean
4445 Default: yes
4446 .fi
4447 .IP
4448 If you use an \fIexternal\fP $pager, setting this variable will
4449 cause Mutt to prompt you for a command when the pager exits rather
4450 than returning to the index menu.  If \fIunset\fP, Mutt will return to the
4451 index menu when the external pager exits.
4452
4453
4454 .TP
4455 .B query_command
4456 .nf
4457 Type: path
4458 Default: \(lq\(rq
4459 .fi
4460 .IP
4461 This specifies the command that mutt will use to make external address
4462 queries.  The string should contain a \(lq%s\(rq, which will be substituted
4463 with the query string the user types.  See \(lqquery\(rq for more
4464 information.
4465
4466
4467 .TP
4468 .B query_format
4469 .nf
4470 Type: string
4471 Default: \(lq%4c %t %\-25.25a %\-25.25n %?e?(%e)?\(rq
4472 .fi
4473 .IP
4474 This variable describes the format of the \(lqquery\(rq menu. The
4475 following \fCprintf(3)\fP\-style sequences are understood:
4476 .RS
4477 .PD 0
4478 .TP
4479 %a  
4480 destination address
4481 .TP
4482 %c  
4483 current entry number
4484 .TP
4485 %e  
4486 extra information *
4487 .TP
4488 %n  
4489 destination name
4490 .TP
4491 %t  
4492 \(lq*\(rq if current entry is tagged, a space otherwise
4493 .TP
4494 %>X 
4495 right justify the rest of the string and pad with \(lqX\(rq
4496 .TP
4497 %|X 
4498 pad to the end of the line with \(lqX\(rq
4499 .TP
4500 %*X 
4501 soft\-fill with character \(lqX\(rq as pad
4502 .RE
4503 .PD 1
4504 .IP
4505 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
4506 .IP
4507 * = can be optionally printed if nonzero, see the $status_format documentation.
4508
4509
4510 .TP
4511 .B quit
4512 .nf
4513 Type: quadoption
4514 Default: yes
4515 .fi
4516 .IP
4517 This variable controls whether \(lqquit\(rq and \(lqexit\(rq actually quit
4518 from mutt.  If this option is \fIset\fP, they do quit, if it is \fIunset\fP, they
4519 have no effect, and if it is set to \fIask\-yes\fP or \fIask\-no\fP, you are
4520 prompted for confirmation when you try to quit.
4521
4522
4523 .TP
4524 .B quote_regexp
4525 .nf
4526 Type: regular expression
4527 Default: \(lq^([ \\t]*[|>:}#])+\(rq
4528 .fi
4529 .IP
4530 A regular expression used in the internal pager to determine quoted
4531 sections of text in the body of a message. Quoted text may be filtered
4532 out using the \fC<toggle\-quoted>\fP command, or colored according to the
4533 \(lqcolor quoted\(rq family of directives.
4534 .IP
4535 Higher levels of quoting may be colored differently (\(lqcolor quoted1\(rq,
4536 \(lqcolor quoted2\(rq, etc.). The quoting level is determined by removing
4537 the last character from the matched text and recursively reapplying
4538 the regular expression until it fails to produce a match.
4539 .IP
4540 Match detection may be overridden by the $smileys regular expression.
4541
4542
4543 .TP
4544 .B read_inc
4545 .nf
4546 Type: number
4547 Default: 10
4548 .fi
4549 .IP
4550 If set to a value greater than 0, Mutt will display which message it
4551 is currently on when reading a mailbox or when performing search actions
4552 such as search and limit. The message is printed after
4553 this many messages have been read or searched (e.g., if set to 25, Mutt will
4554 print a message when it is at message 25, and then again when it gets
4555 to message 50).  This variable is meant to indicate progress when
4556 reading or searching large mailboxes which may take some time.
4557 When set to 0, only a single message will appear before the reading
4558 the mailbox.
4559 .IP
4560 Also see the $write_inc, $net_inc and $time_inc variables and the
4561 \(lqtuning\(rq section of the manual for performance considerations.
4562
4563
4564 .TP
4565 .B read_only
4566 .nf
4567 Type: boolean
4568 Default: no
4569 .fi
4570 .IP
4571 If \fIset\fP, all folders are opened in read\-only mode.
4572
4573
4574 .TP
4575 .B realname
4576 .nf
4577 Type: string
4578 Default: \(lq\(rq
4579 .fi
4580 .IP
4581 This variable specifies what \(lqreal\(rq or \(lqpersonal\(rq name should be used
4582 when sending messages.
4583 .IP
4584 By default, this is the GECOS field from \fC/etc/passwd\fP.  Note that this
4585 variable will \fInot\fP be used when the user has set a real name
4586 in the $from variable.
4587
4588
4589 .TP
4590 .B recall
4591 .nf
4592 Type: quadoption
4593 Default: ask\-yes
4594 .fi
4595 .IP
4596 Controls whether or not Mutt recalls postponed messages
4597 when composing a new message.
4598 .IP
4599 \fISetting\fP this variable to is not generally useful, and thus not
4600 recommended.
4601 .IP
4602 Also see $postponed variable.
4603
4604
4605 .TP
4606 .B record
4607 .nf
4608 Type: path
4609 Default: \(lq~/sent\(rq
4610 .fi
4611 .IP
4612 This specifies the file into which your outgoing messages should be
4613 appended.  (This is meant as the primary method for saving a copy of
4614 your messages, but another way to do this is using the \(lqmy_hdr\(rq
4615 command to create a \(lqBcc:\(rq field with your email address in it.)
4616 .IP
4617 The value of \fI$record\fP is overridden by the $force_name and
4618 $save_name variables, and the \(lqfcc-hook\(rq command.
4619
4620
4621 .TP
4622 .B reply_regexp
4623 .nf
4624 Type: regular expression
4625 Default: \(lq^(re([\\[0\-9\\]+])*|aw):[ \\t]*\(rq
4626 .fi
4627 .IP
4628 A regular expression used to recognize reply messages when threading
4629 and replying. The default value corresponds to the English \(rqRe:\(rq and
4630 the German \(rqAw:\(rq.
4631
4632
4633 .TP
4634 .B reply_self
4635 .nf
4636 Type: boolean
4637 Default: no
4638 .fi
4639 .IP
4640 If \fIunset\fP and you are replying to a message sent by you, Mutt will
4641 assume that you want to reply to the recipients of that message rather
4642 than to yourself.
4643 .IP
4644 Also see the \(lqalternates\(rq command.
4645
4646
4647 .TP
4648 .B reply_to
4649 .nf
4650 Type: quadoption
4651 Default: ask\-yes
4652 .fi
4653 .IP
4654 If \fIset\fP, when replying to a message, Mutt will use the address listed
4655 in the Reply\-to: header as the recipient of the reply.  If \fIunset\fP,
4656 it will use the address in the From: header field instead.  This
4657 option is useful for reading a mailing list that sets the Reply\-To:
4658 header field to the list address and you want to send a private
4659 message to the author of a message.
4660
4661
4662 .TP
4663 .B resolve
4664 .nf
4665 Type: boolean
4666 Default: yes
4667 .fi
4668 .IP
4669 When \fIset\fP, the cursor will be automatically advanced to the next
4670 (possibly undeleted) message whenever a command that modifies the
4671 current message is executed.
4672
4673
4674 .TP
4675 .B reverse_alias
4676 .nf
4677 Type: boolean
4678 Default: no
4679 .fi
4680 .IP
4681 This variable controls whether or not Mutt will display the \(lqpersonal\(rq
4682 name from your aliases in the index menu if it finds an alias that
4683 matches the message's sender.  For example, if you have the following
4684 alias:
4685
4686 .IP
4687 .DS
4688 .sp
4689 .ft CR
4690 .nf
4691 alias juser abd30425@somewhere.net (Joe User)
4692
4693 .fi
4694 .ec
4695 .ft P
4696 .sp
4697 .IP
4698 and then you receive mail which contains the following header:
4699
4700 .IP
4701 .DS
4702 .sp
4703 .ft CR
4704 .nf
4705 From: abd30425@somewhere.net
4706
4707 .fi
4708 .ec
4709 .ft P
4710 .sp
4711 .IP
4712 It would be displayed in the index menu as \(lqJoe User\(rq instead of
4713 \(lqabd30425@somewhere.net.\(rq  This is useful when the person's e\-mail
4714 address is not human friendly.
4715
4716
4717 .TP
4718 .B reverse_name
4719 .nf
4720 Type: boolean
4721 Default: no
4722 .fi
4723 .IP
4724 It may sometimes arrive that you receive mail to a certain machine,
4725 move the messages to another machine, and reply to some the messages
4726 from there.  If this variable is \fIset\fP, the default \fIFrom:\fP line of
4727 the reply messages is built using the address where you received the
4728 messages you are replying to \fBif\fP that address matches your
4729 \(lqalternates\(rq.  If the variable is \fIunset\fP, or the address that would be
4730 used doesn't match your \(lqalternates\(rq, the \fIFrom:\fP line will use
4731 your address on the current machine.
4732 .IP
4733 Also see the \(lqalternates\(rq command.
4734
4735
4736 .TP
4737 .B reverse_realname
4738 .nf
4739 Type: boolean
4740 Default: yes
4741 .fi
4742 .IP
4743 This variable fine\-tunes the behaviour of the $reverse_name feature.
4744 When it is \fIset\fP, mutt will use the address from incoming messages as\-is,
4745 possibly including eventual real names.  When it is \fIunset\fP, mutt will
4746 override any such real names with the setting of the $realname variable.
4747
4748
4749 .TP
4750 .B rfc2047_parameters
4751 .nf
4752 Type: boolean
4753 Default: no
4754 .fi
4755 .IP
4756 When this variable is \fIset\fP, Mutt will decode RFC2047\-encoded MIME
4757 parameters. You want to set this variable when mutt suggests you
4758 to save attachments to files named like:
4759
4760 .IP
4761 .DS
4762 .sp
4763 .ft CR
4764 .nf
4765 =?iso\-8859\-1?Q?file=5F=E4=5F991116=2Ezip?=
4766
4767 .fi
4768 .ec
4769 .ft P
4770 .sp
4771 .IP
4772 When this variable is \fIset\fP interactively, the change won't be
4773 active until you change folders.
4774 .IP
4775 Note that this use of RFC2047's encoding is explicitly
4776 prohibited by the standard, but nevertheless encountered in the
4777 wild.
4778 .IP
4779 Also note that setting this parameter will \fInot\fP have the effect
4780 that mutt \fIgenerates\fP this kind of encoding.  Instead, mutt will
4781 unconditionally use the encoding specified in RFC2231.
4782
4783
4784 .TP
4785 .B save_address
4786 .nf
4787 Type: boolean
4788 Default: no
4789 .fi
4790 .IP
4791 If \fIset\fP, mutt will take the sender's full address when choosing a
4792 default folder for saving a mail. If $save_name or $force_name
4793 is \fIset\fP too, the selection of the Fcc folder will be changed as well.
4794
4795
4796 .TP
4797 .B save_empty
4798 .nf
4799 Type: boolean
4800 Default: yes
4801 .fi
4802 .IP
4803 When \fIunset\fP, mailboxes which contain no saved messages will be removed
4804 when closed (the exception is $spoolfile which is never removed).
4805 If \fIset\fP, mailboxes are never removed.
4806 .IP
4807 \fBNote:\fP This only applies to mbox and MMDF folders, Mutt does not
4808 delete MH and Maildir directories.
4809
4810
4811 .TP
4812 .B save_history
4813 .nf
4814 Type: number
4815 Default: 0
4816 .fi
4817 .IP
4818 This variable controls the size of the history (per category) saved in the
4819 $history_file file.
4820
4821
4822 .TP
4823 .B save_name
4824 .nf
4825 Type: boolean
4826 Default: no
4827 .fi
4828 .IP
4829 This variable controls how copies of outgoing messages are saved.
4830 When \fIset\fP, a check is made to see if a mailbox specified by the
4831 recipient address exists (this is done by searching for a mailbox in
4832 the $folder directory with the \fIusername\fP part of the
4833 recipient address).  If the mailbox exists, the outgoing message will
4834 be saved to that mailbox, otherwise the message is saved to the
4835 $record mailbox.
4836 .IP
4837 Also see the $force_name variable.
4838
4839
4840 .TP
4841 .B score
4842 .nf
4843 Type: boolean
4844 Default: yes
4845 .fi
4846 .IP
4847 When this variable is \fIunset\fP, scoring is turned off.  This can
4848 be useful to selectively disable scoring for certain folders when the
4849 $score_threshold_delete variable and related are used.
4850
4851
4852 .TP
4853 .B score_threshold_delete
4854 .nf
4855 Type: number
4856 Default: \-1
4857 .fi
4858 .IP
4859 Messages which have been assigned a score equal to or lower than the value
4860 of this variable are automatically marked for deletion by mutt.  Since
4861 mutt scores are always greater than or equal to zero, the default setting
4862 of this variable will never mark a message for deletion.
4863
4864
4865 .TP
4866 .B score_threshold_flag
4867 .nf
4868 Type: number
4869 Default: 9999
4870 .fi
4871 .IP
4872 Messages which have been assigned a score greater than or equal to this
4873 variable's value are automatically marked \(rqflagged\(rq.
4874
4875
4876 .TP
4877 .B score_threshold_read
4878 .nf
4879 Type: number
4880 Default: \-1
4881 .fi
4882 .IP
4883 Messages which have been assigned a score equal to or lower than the value
4884 of this variable are automatically marked as read by mutt.  Since
4885 mutt scores are always greater than or equal to zero, the default setting
4886 of this variable will never mark a message read.
4887
4888
4889 .TP
4890 .B send_charset
4891 .nf
4892 Type: string
4893 Default: \(lqus\-ascii:iso\-8859\-1:utf\-8\(rq
4894 .fi
4895 .IP
4896 A colon\-delimited list of character sets for outgoing messages. Mutt will use the
4897 first character set into which the text can be converted exactly.
4898 If your $charset is not \(lqiso\-8859\-1\(rq and recipients may not
4899 understand \(lqUTF\-8\(rq, it is advisable to include in the list an
4900 appropriate widely used standard character set (such as
4901 \(lqiso\-8859\-2\(rq, \(lqkoi8\-r\(rq or \(lqiso\-2022\-jp\(rq) either instead of or after
4902 \(lqiso\-8859\-1\(rq.
4903 .IP
4904 In case the text cannot be converted into one of these exactly,
4905 mutt uses $charset as a fallback.
4906
4907
4908 .TP
4909 .B sendmail
4910 .nf
4911 Type: path
4912 Default: \(lq/usr/sbin/sendmail \-oem \-oi\(rq
4913 .fi
4914 .IP
4915 Specifies the program and arguments used to deliver mail sent by Mutt.
4916 Mutt expects that the specified program interprets additional
4917 arguments as recipient addresses.
4918
4919
4920 .TP
4921 .B sendmail_wait
4922 .nf
4923 Type: number
4924 Default: 0
4925 .fi
4926 .IP
4927 Specifies the number of seconds to wait for the $sendmail process
4928 to finish before giving up and putting delivery in the background.
4929 .IP
4930 Mutt interprets the value of this variable as follows:
4931 .RS
4932 .PD 0
4933 .TP
4934 >0 
4935 number of seconds to wait for sendmail to finish before continuing
4936 .TP
4937 0  
4938 wait forever for sendmail to finish
4939 .TP
4940 <0 
4941 always put sendmail in the background without waiting
4942 .RE
4943 .PD 1
4944 .IP
4945 Note that if you specify a value other than 0, the output of the child
4946 process will be put in a temporary file.  If there is some error, you
4947 will be informed as to where to find the output.
4948
4949
4950 .TP
4951 .B shell
4952 .nf
4953 Type: path
4954 Default: \(lq\(rq
4955 .fi
4956 .IP
4957 Command to use when spawning a subshell.  By default, the user's login
4958 shell from \fC/etc/passwd\fP is used.
4959
4960
4961 .TP
4962 .B sig_dashes
4963 .nf
4964 Type: boolean
4965 Default: yes
4966 .fi
4967 .IP
4968 If \fIset\fP, a line containing \(lq\-\- \(rq (note the trailing space) will be inserted before your
4969 $signature.  It is \fBstrongly\fP recommended that you not \fIunset\fP
4970 this variable unless your signature contains just your name.  The
4971 reason for this is because many software packages use \(lq\-\- \\n\(rq to
4972 detect your signature.  For example, Mutt has the ability to highlight
4973 the signature in a different color in the builtin pager.
4974
4975
4976 .TP
4977 .B sig_on_top
4978 .nf
4979 Type: boolean
4980 Default: no
4981 .fi
4982 .IP
4983 If \fIset\fP, the signature will be included before any quoted or forwarded
4984 text.  It is \fBstrongly\fP recommended that you do not set this variable
4985 unless you really know what you are doing, and are prepared to take
4986 some heat from netiquette guardians.
4987
4988
4989 .TP
4990 .B signature
4991 .nf
4992 Type: path
4993 Default: \(lq~/.signature\(rq
4994 .fi
4995 .IP
4996 Specifies the filename of your signature, which is appended to all
4997 outgoing messages.   If the filename ends with a pipe (\(lq|\(rq), it is
4998 assumed that filename is a shell command and input should be read from
4999 its standard output.
5000
5001
5002 .TP
5003 .B simple_search
5004 .nf
5005 Type: string
5006 Default: \(lq~f %s | ~s %s\(rq
5007 .fi
5008 .IP
5009 Specifies how Mutt should expand a simple search into a real search
5010 pattern.  A simple search is one that does not contain any of the \(lq~\(rq pattern
5011 operators.  See \(lqpatterns\(rq for more information on search patterns.
5012 .IP
5013 For example, if you simply type \(lqjoe\(rq at a search or limit prompt, Mutt
5014 will automatically expand it to the value specified by this variable by
5015 replacing \(lq%s\(rq with the supplied string.
5016 For the default value, \(lqjoe\(rq would be expanded to: \(lq~f joe | ~s joe\(rq.
5017
5018
5019 .TP
5020 .B smart_wrap
5021 .nf
5022 Type: boolean
5023 Default: yes
5024 .fi
5025 .IP
5026 Controls the display of lines longer than the screen width in the
5027 internal pager. If \fIset\fP, long lines are wrapped at a word boundary.  If
5028 \fIunset\fP, lines are simply wrapped at the screen edge. Also see the
5029 $markers variable.
5030
5031
5032 .TP
5033 .B smileys
5034 .nf
5035 Type: regular expression
5036 Default: \(lq(>From )|(:[\-^]?[][)(><}{|/DP])\(rq
5037 .fi
5038 .IP
5039 The \fIpager\fP uses this variable to catch some common false
5040 positives of $quote_regexp, most notably smileys and not consider
5041 a line quoted text if it also matches $smileys. This mostly
5042 happens at the beginning of a line.
5043
5044
5045 .TP
5046 .B sleep_time
5047 .nf
5048 Type: number
5049 Default: 1
5050 .fi
5051 .IP
5052 Specifies time, in seconds, to pause while displaying certain informational
5053 messages, while moving from folder to folder and after expunging
5054 messages from the current folder.  The default is to pause one second, so
5055 a value of zero for this option suppresses the pause.
5056
5057
5058 .TP
5059 .B smtp_authenticators
5060 .nf
5061 Type: string
5062 Default: \(lq\(rq
5063 .fi
5064 .IP
5065 This is a colon\-delimited list of authentication methods mutt may
5066 attempt to use to log in to an SMTP server, in the order mutt should
5067 try them.  Authentication methods are any SASL mechanism, eg
5068 \(lqdigest\-md5\(rq, \(lqgssapi\(rq or \(lqcram\-md5\(rq.
5069 This option is case\-insensitive. If it is \(lqunset\(rq
5070 (the default) mutt will try all available methods, in order from
5071 most\-secure to least\-secure.
5072 .IP
5073 Example:
5074
5075 .IP
5076 .DS
5077 .sp
5078 .ft CR
5079 .nf
5080 set smtp_authenticators=\(rqdigest\-md5:cram\-md5\(rq
5081
5082 .fi
5083 .ec
5084 .ft P
5085 .sp
5086
5087
5088 .TP
5089 .B smtp_pass
5090 .nf
5091 Type: string
5092 Default: \(lq\(rq
5093 .fi
5094 .IP
5095 Specifies the password for your SMTP account.  If \fIunset\fP, Mutt will
5096 prompt you for your password when you first send mail via SMTP.
5097 See $smtp_url to configure mutt to send mail via SMTP.
5098 .IP
5099 \fBWarning\fP: you should only use this option when you are on a
5100 fairly secure machine, because the superuser can read your muttrc even
5101 if you are the only one who can read the file.
5102
5103
5104 .TP
5105 .B smtp_url
5106 .nf
5107 Type: string
5108 Default: \(lq\(rq
5109 .fi
5110 .IP
5111 Defines the SMTP smarthost where sent messages should relayed for
5112 delivery. This should take the form of an SMTP URL, eg:
5113
5114 .IP
5115 .DS
5116 .sp
5117 .ft CR
5118 .nf
5119 smtp[s]://[user[:pass]@]host[:port]/
5120
5121 .fi
5122 .ec
5123 .ft P
5124 .sp
5125 .IP
5126 \\.\\.\\. where \(lq[...]\(rq denotes an optional part.
5127 Setting this variable overrides the value of the $sendmail
5128 variable.
5129
5130
5131 .TP
5132 .B sort
5133 .nf
5134 Type: sort order
5135 Default: date
5136 .fi
5137 .IP
5138 Specifies how to sort messages in the \(lqindex\(rq menu.  Valid values
5139 are:
5140 .RS
5141 .PD 0
5142 .TP
5143 \(hy date or date\-sent
5144 .TP
5145 \(hy date\-received
5146 .TP
5147 \(hy from
5148 .TP
5149 \(hy mailbox\-order (unsorted)
5150 .TP
5151 \(hy score
5152 .TP
5153 \(hy size
5154 .TP
5155 \(hy spam
5156 .TP
5157 \(hy subject
5158 .TP
5159 \(hy threads
5160 .TP
5161 \(hy to
5162 .RE
5163 .PD 1
5164 .IP
5165 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
5166 order (example: \(lq\fCset sort=reverse\-date\-sent\fP\(rq).
5167 .IP
5168 \fBNote:\fP On Debian systems, this option is set by default to
5169 \(lqthreads\(rq in /etc/Muttrc.
5170
5171
5172 .TP
5173 .B sort_alias
5174 .nf
5175 Type: sort order
5176 Default: alias
5177 .fi
5178 .IP
5179 Specifies how the entries in the \(lqalias\(rq menu are sorted.  The
5180 following are legal values:
5181 .RS
5182 .PD 0
5183 .TP
5184 \(hy address (sort alphabetically by email address)
5185 .TP
5186 \(hy alias (sort alphabetically by alias name)
5187 .TP
5188 \(hy unsorted (leave in order specified in .muttrc)
5189 .RE
5190 .PD 1
5191
5192 .TP
5193 .B sort_aux
5194 .nf
5195 Type: sort order
5196 Default: date
5197 .fi
5198 .IP
5199 When sorting by threads, this variable controls how threads are sorted
5200 in relation to other threads, and how the branches of the thread trees
5201 are sorted.  This can be set to any value that $sort can, except
5202 \(lqthreads\(rq (in that case, mutt will just use \(lqdate\-sent\(rq).  You can also
5203 specify the \(lqlast\-\(rq prefix in addition to the \(lqreverse\-\(rq prefix, but \(lqlast\-\(rq
5204 must come after \(lqreverse\-\(rq.  The \(lqlast\-\(rq prefix causes messages to be
5205 sorted against its siblings by which has the last descendant, using
5206 the rest of $sort_aux as an ordering.  For instance,
5207
5208 .IP
5209 .DS
5210 .sp
5211 .ft CR
5212 .nf
5213 set sort_aux=last\-date\-received
5214
5215 .fi
5216 .ec
5217 .ft P
5218 .sp
5219 .IP
5220 would mean that if a new message is received in a
5221 thread, that thread becomes the last one displayed (or the first, if
5222 you have \(lq\fCset sort=reverse\-threads\fP\(rq.)
5223 .IP
5224 Note: For reversed $sort
5225 order $sort_aux is reversed again (which is not the right thing to do,
5226 but kept to not break any existing configuration setting).
5227
5228
5229 .TP
5230 .B sort_browser
5231 .nf
5232 Type: sort order
5233 Default: alpha
5234 .fi
5235 .IP
5236 Specifies how to sort entries in the file browser.  By default, the
5237 entries are sorted alphabetically.  Valid values:
5238 .RS
5239 .PD 0
5240 .TP
5241 \(hy alpha (alphabetically)
5242 .TP
5243 \(hy date
5244 .TP
5245 \(hy size
5246 .TP
5247 \(hy unsorted
5248 .RE
5249 .PD 1
5250 .IP
5251 You may optionally use the \(lqreverse\-\(rq prefix to specify reverse sorting
5252 order (example: \(lq\fCset sort_browser=reverse\-date\fP\(rq).
5253
5254
5255 .TP
5256 .B sort_re
5257 .nf
5258 Type: boolean
5259 Default: yes
5260 .fi
5261 .IP
5262 This variable is only useful when sorting by threads with
5263 $strict_threads \fIunset\fP.  In that case, it changes the heuristic
5264 mutt uses to thread messages by subject.  With $sort_re \fIset\fP, mutt will
5265 only attach a message as the child of another message by subject if
5266 the subject of the child message starts with a substring matching the
5267 setting of $reply_regexp.  With $sort_re \fIunset\fP, mutt will attach
5268 the message whether or not this is the case, as long as the
5269 non\-$reply_regexp parts of both messages are identical.
5270
5271
5272 .TP
5273 .B spam_separator
5274 .nf
5275 Type: string
5276 Default: \(lq,\(rq
5277 .fi
5278 .IP
5279 This variable controls what happens when multiple spam headers
5280 are matched: if \fIunset\fP, each successive header will overwrite any
5281 previous matches value for the spam label. If \fIset\fP, each successive
5282 match will append to the previous, using this variable's value as a
5283 separator.
5284
5285
5286 .TP
5287 .B spoolfile
5288 .nf
5289 Type: path
5290 Default: \(lq\(rq
5291 .fi
5292 .IP
5293 If your spool mailbox is in a non\-default place where Mutt cannot find
5294 it, you can specify its location with this variable.  Mutt will
5295 automatically set this variable to the value of the environment
5296 variable \fC$MAIL\fP if it is not set.
5297
5298
5299 .TP
5300 .B status_chars
5301 .nf
5302 Type: string
5303 Default: \(lq\-*%A\(rq
5304 .fi
5305 .IP
5306 Controls the characters used by the \(lq%r\(rq indicator in
5307 $status_format. The first character is used when the mailbox is
5308 unchanged. The second is used when the mailbox has been changed, and
5309 it needs to be resynchronized. The third is used if the mailbox is in
5310 read\-only mode, or if the mailbox will not be written when exiting
5311 that mailbox (You can toggle whether to write changes to a mailbox
5312 with the \fC<toggle\-write>\fP operation, bound by default to \(lq%\(rq). The fourth
5313 is used to indicate that the current folder has been opened in attach\-
5314 message mode (Certain operations like composing a new mail, replying,
5315 forwarding, etc. are not permitted in this mode).
5316
5317
5318 .TP
5319 .B status_format
5320 .nf
5321 Type: string
5322 Default: \(lq\-%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)\-\-\-\(rq
5323 .fi
5324 .IP
5325 Controls the format of the status line displayed in the \(lqindex\(rq
5326 menu.  This string is similar to $index_format, but has its own
5327 set of \fCprintf(3)\fP\-like sequences:
5328 .RS
5329 .PD 0
5330 .TP
5331 %b  
5332 number of mailboxes with new mail *
5333 .TP
5334 %d  
5335 number of deleted messages *
5336 .TP
5337 %f  
5338 the full pathname of the current mailbox
5339 .TP
5340 %F  
5341 number of flagged messages *
5342 .TP
5343 %h  
5344 local hostname
5345 .TP
5346 %l  
5347 size (in bytes) of the current mailbox *
5348 .TP
5349 %L  
5350 size (in bytes) of the messages shown
5351 (i.e., which match the current limit) *
5352 .TP
5353 %m  
5354 the number of messages in the mailbox *
5355 .TP
5356 %M  
5357 the number of messages shown (i.e., which match the current limit) *
5358 .TP
5359 %n  
5360 number of new messages in the mailbox *
5361 .TP
5362 %o  
5363 number of old unread messages *
5364 .TP
5365 %p  
5366 number of postponed messages *
5367 .TP
5368 %P  
5369 percentage of the way through the index
5370 .TP
5371 %r  
5372 modified/read\-only/won't\-write/attach\-message indicator,
5373 according to $status_chars
5374 .TP
5375 %s  
5376 current sorting mode ($sort)
5377 .TP
5378 %S  
5379 current aux sorting method ($sort_aux)
5380 .TP
5381 %t  
5382 number of tagged messages *
5383 .TP
5384 %u  
5385 number of unread messages *
5386 .TP
5387 %v  
5388 Mutt version string
5389 .TP
5390 %V  
5391 currently active limit pattern, if any *
5392 .TP
5393 %>X 
5394 right justify the rest of the string and pad with \(lqX\(rq
5395 .TP
5396 %|X 
5397 pad to the end of the line with \(lqX\(rq
5398 .TP
5399 %*X 
5400 soft\-fill with character \(lqX\(rq as pad
5401 .RE
5402 .PD 1
5403 .IP
5404 For an explanation of \(lqsoft\-fill\(rq, see the $index_format documentation.
5405 .IP
5406 * = can be optionally printed if nonzero
5407 .IP
5408 Some of the above sequences can be used to optionally print a string
5409 if their value is nonzero.  For example, you may only want to see the
5410 number of flagged messages if such messages exist, since zero is not
5411 particularly meaningful.  To optionally print a string based upon one
5412 of the above sequences, the following construct is used:
5413 .IP
5414 \fC%?<sequence_char>?<optional_string>?\fP
5415 .IP
5416 where \fIsequence_char\fP is a character from the table above, and
5417 \fIoptional_string\fP is the string you would like printed if
5418 \fIsequence_char\fP is nonzero.  \fIoptional_string\fP \fBmay\fP contain
5419 other sequences as well as normal text, but you may \fBnot\fP nest
5420 optional strings.
5421 .IP
5422 Here is an example illustrating how to optionally print the number of
5423 new messages in a mailbox:
5424 .IP
5425 \fC%?n?%n new messages.?\fP
5426 .IP
5427 You can also switch between two strings using the following construct:
5428 .IP
5429 \fC%?<sequence_char>?<if_string>&<else_string>?\fP
5430 .IP
5431 If the value of \fIsequence_char\fP is non\-zero, \fIif_string\fP will
5432 be expanded, otherwise \fIelse_string\fP will be expanded.
5433 .IP
5434 You can force the result of any \fCprintf(3)\fP\-like sequence to be lowercase
5435 by prefixing the sequence character with an underscore (\(lq_\(rq) sign.
5436 For example, if you want to display the local hostname in lowercase,
5437 you would use: \(lq\fC%_h\fP\(rq.
5438 .IP
5439 If you prefix the sequence character with a colon (\(lq:\(rq) character, mutt
5440 will replace any dots in the expansion by underscores. This might be helpful
5441 with IMAP folders that don't like dots in folder names.
5442
5443
5444 .TP
5445 .B status_on_top
5446 .nf
5447 Type: boolean
5448 Default: no
5449 .fi
5450 .IP
5451 Setting this variable causes the \(lqstatus bar\(rq to be displayed on
5452 the first line of the screen rather than near the bottom. If $help
5453 is \fIset\fP, too it'll be placed at the bottom.
5454
5455
5456 .TP
5457 .B strict_threads
5458 .nf
5459 Type: boolean
5460 Default: no
5461 .fi
5462 .IP
5463 If \fIset\fP, threading will only make use of the \(lqIn\-Reply\-To\(rq and
5464 \(lqReferences:\(rq fields when you $sort by message threads.  By
5465 default, messages with the same subject are grouped together in
5466 \(lqpseudo threads.\(rq. This may not always be desirable, such as in a
5467 personal mailbox where you might have several unrelated messages with
5468 the subjects like \(lqhi\(rq which will get grouped together. See also
5469 $sort_re for a less drastic way of controlling this
5470 behaviour.
5471
5472
5473 .TP
5474 .B suspend
5475 .nf
5476 Type: boolean
5477 Default: yes
5478 .fi
5479 .IP
5480 When \fIunset\fP, mutt won't stop when the user presses the terminal's
5481 \fIsusp\fP key, usually \(lq^Z\(rq. This is useful if you run mutt
5482 inside an xterm using a command like \(lq\fCxterm \-e mutt\fP\(rq.
5483
5484
5485 .TP
5486 .B text_flowed
5487 .nf
5488 Type: boolean
5489 Default: no
5490 .fi
5491 .IP
5492 When \fIset\fP, mutt will generate \(lqformat=flowed\(rq bodies with a content type
5493 of \(lq\fCtext/plain; format=flowed\fP\(rq.
5494 This format is easier to handle for some mailing software, and generally
5495 just looks like ordinary text.  To actually make use of this format's
5496 features, you'll need support in your editor.
5497 .IP
5498 Note that $indent_string is ignored when this option is \fIset\fP.
5499
5500
5501 .TP
5502 .B thread_received
5503 .nf
5504 Type: boolean
5505 Default: no
5506 .fi
5507 .IP
5508 When \fIset\fP, mutt uses the date received rather than the date sent
5509 to thread messages by subject.
5510
5511
5512 .TP
5513 .B thorough_search
5514 .nf
5515 Type: boolean
5516 Default: no
5517 .fi
5518 .IP
5519 Affects the \fC~b\fP and \fC~h\fP search operations described in
5520 section \(lqpatterns\(rq.  If \fIset\fP, the headers and body/attachments of
5521 messages to be searched are decoded before searching. If \fIunset\fP,
5522 messages are searched as they appear in the folder.
5523 .IP
5524 Users searching attachments or for non\-ASCII characters should \fIset\fP
5525 this value because decoding also includes MIME parsing/decoding and possible
5526 character set conversions. Otherwise mutt will attempt to match against the
5527 raw message received (for example quoted\-printable encoded or with encoded
5528 headers) which may lead to incorrect search results.
5529
5530
5531 .TP
5532 .B tilde
5533 .nf
5534 Type: boolean
5535 Default: no
5536 .fi
5537 .IP
5538 When \fIset\fP, the internal\-pager will pad blank lines to the bottom of the
5539 screen with a tilde (\(lq~\(rq).
5540
5541
5542 .TP
5543 .B time_inc
5544 .nf
5545 Type: number
5546 Default: 0
5547 .fi
5548 .IP
5549 Along with $read_inc, $write_inc, and $net_inc, this
5550 variable controls the frequency with which progress updates are
5551 displayed. It suppresses updates less than $time_inc milliseconds
5552 apart. This can improve throughput on systems with slow terminals,
5553 or when running mutt on a remote system.
5554 .IP
5555 Also see the \(lqtuning\(rq section of the manual for performance considerations.
5556
5557
5558 .TP
5559 .B timeout
5560 .nf
5561 Type: number
5562 Default: 600
5563 .fi
5564 .IP
5565 When Mutt is waiting for user input either idleing in menus or
5566 in an interactive prompt, Mutt would block until input is
5567 present. Depending on the context, this would prevent certain
5568 operations from working, like checking for new mail or keeping
5569 an IMAP connection alive.
5570 .IP
5571 This variable controls how many seconds Mutt will at most wait
5572 until it aborts waiting for input, performs these operations and
5573 continues to wait for input.
5574 .IP
5575 A value of zero or less will cause Mutt to never time out.
5576
5577
5578 .TP
5579 .B tmpdir
5580 .nf
5581 Type: path
5582 Default: \(lq\(rq
5583 .fi
5584 .IP
5585 This variable allows you to specify where Mutt will place its
5586 temporary files needed for displaying and composing messages.  If
5587 this variable is not set, the environment variable \fC$TMPDIR\fP is
5588 used.  If \fC$TMPDIR\fP is not set then \(lq\fC/tmp\fP\(rq is used.
5589
5590
5591 .TP
5592 .B to_chars
5593 .nf
5594 Type: string
5595 Default: \(lq +TCFL\(rq
5596 .fi
5597 .IP
5598 Controls the character used to indicate mail addressed to you.  The
5599 first character is the one used when the mail is \fInot\fP addressed to your
5600 address.  The second is used when you are the only
5601 recipient of the message.  The third is when your address
5602 appears in the \(lqTo:\(rq header field, but you are not the only recipient of
5603 the message.  The fourth character is used when your
5604 address is specified in the \(lqCc:\(rq header field, but you are not the only
5605 recipient.  The fifth character is used to indicate mail that was sent
5606 by \fIyou\fP.  The sixth character is used to indicate when a mail
5607 was sent to a mailing\-list you subscribe to.
5608
5609
5610 .TP
5611 .B trash
5612 .nf
5613 Type: path
5614 Default: \(lq\(rq
5615 .fi
5616 .IP
5617 If set, this variable specifies the path of the trash folder where the
5618 mails marked for deletion will be moved, instead of being irremediably
5619 purged.
5620 .IP
5621 NOTE: When you delete a message in the trash folder, it is really
5622 deleted, so that you have a way to clean the trash.
5623
5624
5625 .TP
5626 .B tunnel
5627 .nf
5628 Type: string
5629 Default: \(lq\(rq
5630 .fi
5631 .IP
5632 Setting this variable will cause mutt to open a pipe to a command
5633 instead of a raw socket. You may be able to use this to set up
5634 preauthenticated connections to your IMAP/POP3/SMTP server. Example:
5635
5636 .IP
5637 .DS
5638 .sp
5639 .ft CR
5640 .nf
5641 set tunnel=\(rqssh \-q mailhost.net /usr/local/libexec/imapd\(rq
5642
5643 .fi
5644 .ec
5645 .ft P
5646 .sp
5647 .IP
5648 Note: For this example to work you must be able to log in to the remote
5649 machine without having to enter a password.
5650
5651
5652 .TP
5653 .B use_8bitmime
5654 .nf
5655 Type: boolean
5656 Default: no
5657 .fi
5658 .IP
5659 \fBWarning:\fP do not set this variable unless you are using a version
5660 of sendmail which supports the \fC\-B8BITMIME\fP flag (such as sendmail
5661 8.8.x) or you may not be able to send mail.
5662 .IP
5663 When \fIset\fP, Mutt will invoke $sendmail with the \fC\-B8BITMIME\fP
5664 flag when sending 8\-bit messages to enable ESMTP negotiation.
5665
5666
5667 .TP
5668 .B use_domain
5669 .nf
5670 Type: boolean
5671 Default: yes
5672 .fi
5673 .IP
5674 When \fIset\fP, Mutt will qualify all local addresses (ones without the
5675 \(lq@host\(rq portion) with the value of $hostname.  If \fIunset\fP, no
5676 addresses will be qualified.
5677
5678
5679 .TP
5680 .B use_envelope_from
5681 .nf
5682 Type: boolean
5683 Default: no
5684 .fi
5685 .IP
5686 When \fIset\fP, mutt will set the \fIenvelope\fP sender of the message.
5687 If $envelope_from_address is \fIset\fP, it will be used as the sender
5688 address. If \fIunset\fP, mutt will attempt to derive the sender from the
5689 \(lqFrom:\(rq header.
5690 .IP
5691 Note that this information is passed to sendmail command using the
5692 \fC\-f\fP command line switch. Therefore setting this option is not useful
5693 if the $sendmail variable already contains \fC\-f\fP or if the
5694 executable pointed to by $sendmail doesn't support the \fC\-f\fP switch.
5695
5696
5697 .TP
5698 .B use_from
5699 .nf
5700 Type: boolean
5701 Default: yes
5702 .fi
5703 .IP
5704 When \fIset\fP, Mutt will generate the \(lqFrom:\(rq header field when
5705 sending messages.  If \fIunset\fP, no \(lqFrom:\(rq header field will be
5706 generated unless the user explicitly sets one using the \(lqmy_hdr\(rq
5707 command.
5708
5709
5710 .TP
5711 .B use_idn
5712 .nf
5713 Type: boolean
5714 Default: yes
5715 .fi
5716 .IP
5717 When \fIset\fP, Mutt will show you international domain names decoded.
5718 Note: You can use IDNs for addresses even if this is \fIunset\fP.
5719 This variable only affects decoding.
5720
5721
5722 .TP
5723 .B use_ipv6
5724 .nf
5725 Type: boolean
5726 Default: yes
5727 .fi
5728 .IP
5729 When \fIset\fP, Mutt will look for IPv6 addresses of hosts it tries to
5730 contact.  If this option is \fIunset\fP, Mutt will restrict itself to IPv4 addresses.
5731 Normally, the default should work.
5732
5733
5734 .TP
5735 .B user_agent
5736 .nf
5737 Type: boolean
5738 Default: yes
5739 .fi
5740 .IP
5741 When \fIset\fP, mutt will add a \(lqUser\-Agent:\(rq header to outgoing
5742 messages, indicating which version of mutt was used for composing
5743 them.
5744
5745
5746 .TP
5747 .B visual
5748 .nf
5749 Type: path
5750 Default: \(lq\(rq
5751 .fi
5752 .IP
5753 Specifies the visual editor to invoke when the \(lq\fC~v\fP\(rq command is
5754 given in the builtin editor.
5755
5756
5757 .TP
5758 .B wait_key
5759 .nf
5760 Type: boolean
5761 Default: yes
5762 .fi
5763 .IP
5764 Controls whether Mutt will ask you to press a key after an external command
5765 has been invoked by these functions: \fC<shell\-escape>\fP,
5766 \fC<pipe\-message>\fP, \fC<pipe\-entry>\fP, \fC<print\-message>\fP,
5767 and \fC<print\-entry>\fP commands.
5768 .IP
5769 It is also used when viewing attachments with \(lqauto_view\(rq, provided
5770 that the corresponding mailcap entry has a \fIneedsterminal\fP flag,
5771 and the external program is interactive.
5772 .IP
5773 When \fIset\fP, Mutt will always ask for a key. When \fIunset\fP, Mutt will wait
5774 for a key only if the external command returned a non\-zero status.
5775
5776
5777 .TP
5778 .B weed
5779 .nf
5780 Type: boolean
5781 Default: yes
5782 .fi
5783 .IP
5784 When \fIset\fP, mutt will weed headers when displaying, forwarding,
5785 printing, or replying to messages.
5786
5787
5788 .TP
5789 .B wrap
5790 .nf
5791 Type: number
5792 Default: 0
5793 .fi
5794 .IP
5795 When set to a positive value, mutt will wrap text at $wrap characters.
5796 When set to a negative value, mutt will wrap text so that there are $wrap
5797 characters of empty space on the right side of the terminal.
5798
5799
5800 .TP
5801 .B wrap_search
5802 .nf
5803 Type: boolean
5804 Default: yes
5805 .fi
5806 .IP
5807 Controls whether searches wrap around the end.
5808 .IP
5809 When \fIset\fP, searches will wrap around the first (or last) item. When
5810 \fIunset\fP, incremental searches will not wrap.
5811
5812
5813 .TP
5814 .B wrapmargin
5815 .nf
5816 Type: number
5817 Default: 0
5818 .fi
5819 .IP
5820 (DEPRECATED) Equivalent to setting $wrap with a negative value.
5821
5822
5823 .TP
5824 .B write_inc
5825 .nf
5826 Type: number
5827 Default: 10
5828 .fi
5829 .IP
5830 When writing a mailbox, a message will be printed every
5831 $write_inc messages to indicate progress.  If set to 0, only a
5832 single message will be displayed before writing a mailbox.
5833 .IP
5834 Also see the $read_inc, $net_inc and $time_inc variables and the
5835 \(lqtuning\(rq section of the manual for performance considerations.
5836
5837
5838 .TP
5839 .B write_bcc
5840 .nf
5841 Type: boolean
5842 Default: yes
5843 .fi
5844 .IP
5845 Controls whether mutt writes out the \(lqBcc:\(rq header when preparing
5846 messages to be sent.  Exim users may wish to unset this. If mutt
5847 is set to deliver directly via SMTP (see $smtp_url), this
5848 option does nothing: mutt will never write out the \(lqBcc:\(rq header
5849 in this case.
5850 .IP
5851 \fBNote:\fP On Debian systems, exim4 and postfix strip BCC headers by
5852 default. The above warning applies to exim3 users, see /etc/Muttrc.
5853
5854
5855 .TP
5856 .B xterm_icon
5857 .nf
5858 Type: string
5859 Default: \(lqM%?n?AIL&ail?\(rq
5860 .fi
5861 .IP
5862 Controls the format of the icon title, as long as xterm_set_titles
5863 is enabled. This string is identical in formatting to the one used by
5864 \(lq$status_format\(rq.
5865
5866
5867 .TP
5868 .B xterm_set_titles
5869 .nf
5870 Type: boolean
5871 Default: no
5872 .fi
5873 .IP
5874 Controls whether mutt sets the xterm title bar and icon name
5875 (as long as you are in an appropriate terminal).
5876
5877
5878 .TP
5879 .B xterm_title
5880 .nf
5881 Type: string
5882 Default: \(lqMutt with %?m?%m messages&no messages?%?n? [%n NEW]?\(rq
5883 .fi
5884 .IP
5885 Controls the format of the title bar of the xterm provided that
5886 xterm_set_titles has been set. This string is identical in formatting
5887 to the one used by \(lq$status_format\(rq.
5888
5889
5890 .\" -*-nroff-*-
5891 .SH SEE ALSO
5892 .PP
5893 .BR iconv (1),
5894 .BR iconv (3),
5895 .BR mailcap (5),
5896 .BR maildir (5),
5897 .BR mbox (5),
5898 .BR mutt (1),
5899 .BR printf (3),
5900 .BR regex (7),
5901 .BR strftime (3)
5902 .PP
5903 The Mutt Manual
5904 .PP
5905 The Mutt home page: http://www.mutt.org/
5906 .SH AUTHOR
5907 .PP
5908 Michael Elkins, and others.  Use <mutt-dev@mutt.org> to contact
5909 the developers.